diff --git a/docs/en/md/Airtable/Comment-management/Create-comment.md b/docs/en/md/Airtable/Comment-management/Create-comment.md deleted file mode 100644 index 67e4f44c19..0000000000 --- a/docs/en/md/Airtable/Comment-management/Create-comment.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create comment - Creates a comment for a record in the table - - - -`Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Record | --record | String | Record identifier in the table | - | Text | --text | String | Comment text | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Record = "recHqUT4ruWn8KnYi"; - Text = "TestComment"; - - Result = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); -``` - - - - -```json title="Result" -{ - "id": "comwNg41PXtfEa4kj", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "TestComment", - "createdTime": "2024-10-09T06:15:49.133Z", - "lastUpdatedTime": null -} -``` diff --git a/docs/en/md/Airtable/Comment-management/Create-comment.mdx b/docs/en/md/Airtable/Comment-management/Create-comment.mdx new file mode 100644 index 0000000000..b42a1afa57 --- /dev/null +++ b/docs/en/md/Airtable/Comment-management/Create-comment.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create comment + Creates a comment for a record in the table + + + +`Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Record | --record | String | Record identifier in the table | + | Text | --text | String | Comment text | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Record = "recHqUT4ruWn8KnYi"; + Text = "TestComment"; + + Result = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); +``` + + + + +```json title="Result" +{ + "id": "comwNg41PXtfEa4kj", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "TestComment", + "createdTime": "2024-10-09T06:15:49.133Z", + "lastUpdatedTime": null +} +``` diff --git a/docs/en/md/Airtable/Comment-management/Delete-comment.md b/docs/en/md/Airtable/Comment-management/Delete-comment.md deleted file mode 100644 index 6be57e9180..0000000000 --- a/docs/en/md/Airtable/Comment-management/Delete-comment.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete comment - Deletes a comment for a table record - - - -`Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Record | --record | String | Record identifier in the table | - | Comment | --comment | String | Comment identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Record = "recHqUT4ruWn8KnYi"; - Comment = "comc3oQtvx4mn0pdu"; - - Result = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); -``` - - - - -```json title="Result" -{ - "id": "comwNg41PXtfEa4kj", - "deleted": true -} -``` diff --git a/docs/en/md/Airtable/Comment-management/Delete-comment.mdx b/docs/en/md/Airtable/Comment-management/Delete-comment.mdx new file mode 100644 index 0000000000..047236c4b0 --- /dev/null +++ b/docs/en/md/Airtable/Comment-management/Delete-comment.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete comment + Deletes a comment for a table record + + + +`Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Record | --record | String | Record identifier in the table | + | Comment | --comment | String | Comment identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Record = "recHqUT4ruWn8KnYi"; + Comment = "comc3oQtvx4mn0pdu"; + + Result = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); +``` + + + + +```json title="Result" +{ + "id": "comwNg41PXtfEa4kj", + "deleted": true +} +``` diff --git a/docs/en/md/Airtable/Comment-management/Edit-comment.md b/docs/en/md/Airtable/Comment-management/Edit-comment.md deleted file mode 100644 index fdc6fd5948..0000000000 --- a/docs/en/md/Airtable/Comment-management/Edit-comment.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Modify comment - Changes the text of an existing comment - - - -`Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Record | --record | String | Record identifier in the table | - | Comment | --comment | String | Comment identifier | - | Text | --text | String | New comment text | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Record = "recHqUT4ruWn8KnYi"; - Comment = "comc3oQtvx4mn0pdu"; - - Text = "Test comment (change.)"; - Result = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); - - OPI_TestDataRetrieval.Check_ATText(Result, Text); -``` - - - - -```json title="Result" -{ - "id": "comwNg41PXtfEa4kj", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Test comment (change.)", - "createdTime": "2024-10-09T06:15:49Z", - "lastUpdatedTime": "2024-10-09T06:15:49.55Z" -} -``` diff --git a/docs/en/md/Airtable/Comment-management/Edit-comment.mdx b/docs/en/md/Airtable/Comment-management/Edit-comment.mdx new file mode 100644 index 0000000000..2cebd5bfb6 --- /dev/null +++ b/docs/en/md/Airtable/Comment-management/Edit-comment.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Modify comment + Changes the text of an existing comment + + + +`Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Record | --record | String | Record identifier in the table | + | Comment | --comment | String | Comment identifier | + | Text | --text | String | New comment text | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Record = "recHqUT4ruWn8KnYi"; + Comment = "comc3oQtvx4mn0pdu"; + + Text = "Test comment (change.)"; + Result = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); + + OPI_TestDataRetrieval.Check_ATText(Result, Text); +``` + + + + +```json title="Result" +{ + "id": "comwNg41PXtfEa4kj", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Test comment (change.)", + "createdTime": "2024-10-09T06:15:49Z", + "lastUpdatedTime": "2024-10-09T06:15:49.55Z" +} +``` diff --git a/docs/en/md/Airtable/Comment-management/Get-comments.md b/docs/en/md/Airtable/Comment-management/Get-comments.md deleted file mode 100644 index 47958f274c..0000000000 --- a/docs/en/md/Airtable/Comment-management/Get-comments.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get comments - Gets the list of comments for a record in the table - - - -`Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Record | --record | String | Record identifier in the table | - | Indent | --offset | String | Next page identifier of data from the previous request | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Record = "recHqUT4ruWn8KnYi"; - - Result = OPI_Airtable.GetComments(Token, Base, Table, Record); -``` - - - - -```json title="Result" -{ - "comments": [ - { - "id": "comwNg41PXtfEa4kj", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Test comment (change.)", - "createdTime": "2024-10-09T06:15:49Z", - "lastUpdatedTime": "2024-10-09T06:15:50Z" - } - ], - "offset": null -} -``` diff --git a/docs/en/md/Airtable/Comment-management/Get-comments.mdx b/docs/en/md/Airtable/Comment-management/Get-comments.mdx new file mode 100644 index 0000000000..3bd5f5c115 --- /dev/null +++ b/docs/en/md/Airtable/Comment-management/Get-comments.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get comments + Gets the list of comments for a record in the table + + + +`Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Record | --record | String | Record identifier in the table | + | Indent | --offset | String | Next page identifier of data from the previous request | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Record = "recHqUT4ruWn8KnYi"; + + Result = OPI_Airtable.GetComments(Token, Base, Table, Record); +``` + + + + +```json title="Result" +{ + "comments": [ + { + "id": "comwNg41PXtfEa4kj", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Test comment (change.)", + "createdTime": "2024-10-09T06:15:49Z", + "lastUpdatedTime": "2024-10-09T06:15:50Z" + } + ], + "offset": null +} +``` diff --git a/docs/en/md/Airtable/Record-management/Create-posts.md b/docs/en/md/Airtable/Record-management/Create-posts.md deleted file mode 100644 index ef0826f556..0000000000 --- a/docs/en/md/Airtable/Record-management/Create-posts.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create records - Creates one or an array of records by description or an array of field value descriptions - - - -`Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Data | --data | Structure, Array of Structure | Set or array of sets of pairs Key : Value > Field : FieldValue | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - - Number = 10; - String = "Hello"; - - RowDescription1 = New Structure("Number,String", Number, String); - RowDescription2 = New Structure("Number,String", Number, String); - - ArrayOfDescriptions = New Array; - ArrayOfDescriptions.Add(RowDescription1); - ArrayOfDescriptions.Add(RowDescription2); - - Result = OPI_Airtable.CreatePosts(Token, Base, Table, ArrayOfDescriptions); -``` - - - - -```json title="Result" -{ - "records": [ - { - "id": "recVZd6lgdfEkIH0o", - "createdTime": "2024-10-09T06:15:48Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - }, - { - "id": "recenScnS1yuI8Dsk", - "createdTime": "2024-10-09T06:15:48Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - } - ] -} -``` diff --git a/docs/en/md/Airtable/Record-management/Create-posts.mdx b/docs/en/md/Airtable/Record-management/Create-posts.mdx new file mode 100644 index 0000000000..da8f90033f --- /dev/null +++ b/docs/en/md/Airtable/Record-management/Create-posts.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create records + Creates one or an array of records by description or an array of field value descriptions + + + +`Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Data | --data | Structure, Array of Structure | Set or array of sets of pairs Key : Value > Field : FieldValue | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + + Number = 10; + String = "Hello"; + + RowDescription1 = New Structure("Number,String", Number, String); + RowDescription2 = New Structure("Number,String", Number, String); + + ArrayOfDescriptions = New Array; + ArrayOfDescriptions.Add(RowDescription1); + ArrayOfDescriptions.Add(RowDescription2); + + Result = OPI_Airtable.CreatePosts(Token, Base, Table, ArrayOfDescriptions); +``` + + + + +```json title="Result" +{ + "records": [ + { + "id": "recVZd6lgdfEkIH0o", + "createdTime": "2024-10-09T06:15:48Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + }, + { + "id": "recenScnS1yuI8Dsk", + "createdTime": "2024-10-09T06:15:48Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + } + ] +} +``` diff --git a/docs/en/md/Airtable/Record-management/Delete-posts.md b/docs/en/md/Airtable/Record-management/Delete-posts.md deleted file mode 100644 index 92e5c8e98f..0000000000 --- a/docs/en/md/Airtable/Record-management/Delete-posts.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete records - Deletes one or an array of records by identifiers - - - -`Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Records | --records | String, Array of String | Identifier or array of record identifiers | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Record = "recHqUT4ruWn8KnYi"; - - Result = OPI_Airtable.DeletePosts(Token, Base, Table, Record); -``` - - - - -```json title="Result" -{ - "records": [ - { - "deleted": true, - "id": "recMPMkPT6RzcSyqt" - } - ] -} -``` diff --git a/docs/en/md/Airtable/Record-management/Delete-posts.mdx b/docs/en/md/Airtable/Record-management/Delete-posts.mdx new file mode 100644 index 0000000000..1c962302df --- /dev/null +++ b/docs/en/md/Airtable/Record-management/Delete-posts.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete records + Deletes one or an array of records by identifiers + + + +`Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Records | --records | String, Array of String | Identifier or array of record identifiers | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Record = "recHqUT4ruWn8KnYi"; + + Result = OPI_Airtable.DeletePosts(Token, Base, Table, Record); +``` + + + + +```json title="Result" +{ + "records": [ + { + "deleted": true, + "id": "recMPMkPT6RzcSyqt" + } + ] +} +``` diff --git a/docs/en/md/Airtable/Record-management/Get-list-of-records.md b/docs/en/md/Airtable/Record-management/Get-list-of-records.md deleted file mode 100644 index 6b01bd585e..0000000000 --- a/docs/en/md/Airtable/Record-management/Get-list-of-records.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of records - Gets the list of records of the selected table - - - -`Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Indent | --offset | String | Next page identifier of data from the previous request | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - - Result = OPI_Airtable.GetListOfRecords(Token, Base, Table); -``` - - - - -```json title="Result" -{ - "records": [ - { - "id": "recMPMkPT6RzcSyqt", - "createdTime": "2024-10-09T06:15:49Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - } - ] -} -``` diff --git a/docs/en/md/Airtable/Record-management/Get-list-of-records.mdx b/docs/en/md/Airtable/Record-management/Get-list-of-records.mdx new file mode 100644 index 0000000000..335a75abe2 --- /dev/null +++ b/docs/en/md/Airtable/Record-management/Get-list-of-records.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of records + Gets the list of records of the selected table + + + +`Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Indent | --offset | String | Next page identifier of data from the previous request | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + + Result = OPI_Airtable.GetListOfRecords(Token, Base, Table); +``` + + + + +```json title="Result" +{ + "records": [ + { + "id": "recMPMkPT6RzcSyqt", + "createdTime": "2024-10-09T06:15:49Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + } + ] +} +``` diff --git a/docs/en/md/Airtable/Record-management/Get-record.md b/docs/en/md/Airtable/Record-management/Get-record.md deleted file mode 100644 index 090fb1ebd0..0000000000 --- a/docs/en/md/Airtable/Record-management/Get-record.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get record - Gets row data of the table by identifier - - - -`Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Record | --record | String | Record identifier in the table | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Record = "recHqUT4ruWn8KnYi"; - - Result = OPI_Airtable.GetRecord(Token, Base, Table, Record); -``` - - - - -```json title="Result" -{ - "id": "recMPMkPT6RzcSyqt", - "createdTime": "2024-10-09T06:15:49Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } -} -``` diff --git a/docs/en/md/Airtable/Record-management/Get-record.mdx b/docs/en/md/Airtable/Record-management/Get-record.mdx new file mode 100644 index 0000000000..7bd3ade8fb --- /dev/null +++ b/docs/en/md/Airtable/Record-management/Get-record.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get record + Gets row data of the table by identifier + + + +`Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Record | --record | String | Record identifier in the table | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Record = "recHqUT4ruWn8KnYi"; + + Result = OPI_Airtable.GetRecord(Token, Base, Table, Record); +``` + + + + +```json title="Result" +{ + "id": "recMPMkPT6RzcSyqt", + "createdTime": "2024-10-09T06:15:49Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } +} +``` diff --git a/docs/en/md/Airtable/Table-management/Create-table.md b/docs/en/md/Airtable/Table-management/Create-table.md deleted file mode 100644 index 4389f35125..0000000000 --- a/docs/en/md/Airtable/Table-management/Create-table.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create table - Creates a new table in the base - - - -`Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier | - | Name | --title | String | New table name | - | FieldArray | --fieldsdata | Array of Structure | Array of field descriptions | - | Description | --description | String | Table description | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - - FieldArray = New Array; - FieldArray.Add(OPI_Airtable.GetNumberField("Number")); - FieldArray.Add(OPI_Airtable.GetStringField("String")); - FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment")); - FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox")); - FieldArray.Add(OPI_Airtable.GetDateField("Date")); - FieldArray.Add(OPI_Airtable.GetPhoneField("Phone")); - FieldArray.Add(OPI_Airtable.GetEmailField("Email")); - FieldArray.Add(OPI_Airtable.GetLinkField("Link")); - - Name = "TestTable2"; - Description = "NewTable"; - - Result = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); -``` - - - - -```json title="Result" -{ - "id": "tbl1ECxOLd4V6OM9T", - "name": "TestTable2", - "description": "NewTable", - "primaryFieldId": "fldhWwOjg9UhvJ6A2", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldhWwOjg9UhvJ6A2", - "name": "Number" - }, - { - "type": "richText", - "id": "fld8KaCe62SjwSYAk", - "name": "String" - }, - { - "type": "multipleAttachments", - "options": { - "isReversed": false - }, - "id": "fldSWB4hUUyP5Hx30", - "name": "Attachment" - }, - { - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - }, - "id": "fld7UipYF2w9FsoRm", - "name": "Checkbox" - }, - { - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - }, - "id": "fldHVbDsv6ndNp2XZ", - "name": "Date" - }, - { - "type": "phoneNumber", - "id": "fldYL0IFRMVQCO7gW", - "name": "Phone" - }, - { - "type": "email", - "id": "fldzsmOGCGjThDsUp", - "name": "Email" - }, - { - "type": "url", - "id": "fldMWVcVuR9CmKBcD", - "name": "Link" - } - ], - "views": [ - { - "id": "viwMlZ7T3KyjEufmW", - "name": "Grid view", - "type": "grid" - } - ] -} -``` diff --git a/docs/en/md/Airtable/Table-management/Create-table.mdx b/docs/en/md/Airtable/Table-management/Create-table.mdx new file mode 100644 index 0000000000..4891698da4 --- /dev/null +++ b/docs/en/md/Airtable/Table-management/Create-table.mdx @@ -0,0 +1,126 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create table + Creates a new table in the base + + + +`Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier | + | Name | --title | String | New table name | + | FieldArray | --fieldsdata | Array of Structure | Array of field descriptions | + | Description | --description | String | Table description | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + + FieldArray = New Array; + FieldArray.Add(OPI_Airtable.GetNumberField("Number")); + FieldArray.Add(OPI_Airtable.GetStringField("String")); + FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment")); + FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox")); + FieldArray.Add(OPI_Airtable.GetDateField("Date")); + FieldArray.Add(OPI_Airtable.GetPhoneField("Phone")); + FieldArray.Add(OPI_Airtable.GetEmailField("Email")); + FieldArray.Add(OPI_Airtable.GetLinkField("Link")); + + Name = "TestTable2"; + Description = "NewTable"; + + Result = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); +``` + + + + +```json title="Result" +{ + "id": "tbl1ECxOLd4V6OM9T", + "name": "TestTable2", + "description": "NewTable", + "primaryFieldId": "fldhWwOjg9UhvJ6A2", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldhWwOjg9UhvJ6A2", + "name": "Number" + }, + { + "type": "richText", + "id": "fld8KaCe62SjwSYAk", + "name": "String" + }, + { + "type": "multipleAttachments", + "options": { + "isReversed": false + }, + "id": "fldSWB4hUUyP5Hx30", + "name": "Attachment" + }, + { + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + }, + "id": "fld7UipYF2w9FsoRm", + "name": "Checkbox" + }, + { + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + }, + "id": "fldHVbDsv6ndNp2XZ", + "name": "Date" + }, + { + "type": "phoneNumber", + "id": "fldYL0IFRMVQCO7gW", + "name": "Phone" + }, + { + "type": "email", + "id": "fldzsmOGCGjThDsUp", + "name": "Email" + }, + { + "type": "url", + "id": "fldMWVcVuR9CmKBcD", + "name": "Link" + } + ], + "views": [ + { + "id": "viwMlZ7T3KyjEufmW", + "name": "Grid view", + "type": "grid" + } + ] +} +``` diff --git a/docs/en/md/Airtable/Table-management/Modify-table.md b/docs/en/md/Airtable/Table-management/Modify-table.md deleted file mode 100644 index b65dac5bc3..0000000000 --- a/docs/en/md/Airtable/Table-management/Modify-table.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Modify table - Changes the name and/or description of the base - - - -`Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier | - | Table | --table | String | Table identifier | - | Name | --title | String | New name | - | Description | --description | String | New description | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Name = "Test table 2 (change.)"; - Description = "New table (change.)"; - - Result = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); -``` - - - - -```json title="Result" -{ - "id": "tbl1ECxOLd4V6OM9T", - "name": "Test table 2 (change.)", - "description": "New table (change.)", - "primaryFieldId": "fldhWwOjg9UhvJ6A2", - "fields": [ - { - "id": "fldhWwOjg9UhvJ6A2", - "name": "Number", - "type": "number", - "options": { - "precision": 0 - } - }, - { - "id": "fld8KaCe62SjwSYAk", - "name": "String", - "type": "richText" - }, - { - "id": "fldSWB4hUUyP5Hx30", - "name": "Attachment", - "type": "multipleAttachments", - "options": { - "isReversed": false - } - }, - { - "id": "fld7UipYF2w9FsoRm", - "name": "Checkbox", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } - }, - { - "id": "fldHVbDsv6ndNp2XZ", - "name": "Date", - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - } - }, - { - "id": "fldYL0IFRMVQCO7gW", - "name": "Phone", - "type": "phoneNumber" - }, - { - "id": "fldzsmOGCGjThDsUp", - "name": "Email", - "type": "email" - }, - { - "id": "fldMWVcVuR9CmKBcD", - "name": "Link", - "type": "url" - } - ], - "views": [ - { - "id": "viwMlZ7T3KyjEufmW", - "name": "Grid view", - "type": "grid" - } - ] -} -``` diff --git a/docs/en/md/Airtable/Table-management/Modify-table.mdx b/docs/en/md/Airtable/Table-management/Modify-table.mdx new file mode 100644 index 0000000000..495d13a97e --- /dev/null +++ b/docs/en/md/Airtable/Table-management/Modify-table.mdx @@ -0,0 +1,116 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Modify table + Changes the name and/or description of the base + + + +`Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier | + | Table | --table | String | Table identifier | + | Name | --title | String | New name | + | Description | --description | String | New description | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Name = "Test table 2 (change.)"; + Description = "New table (change.)"; + + Result = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); +``` + + + + +```json title="Result" +{ + "id": "tbl1ECxOLd4V6OM9T", + "name": "Test table 2 (change.)", + "description": "New table (change.)", + "primaryFieldId": "fldhWwOjg9UhvJ6A2", + "fields": [ + { + "id": "fldhWwOjg9UhvJ6A2", + "name": "Number", + "type": "number", + "options": { + "precision": 0 + } + }, + { + "id": "fld8KaCe62SjwSYAk", + "name": "String", + "type": "richText" + }, + { + "id": "fldSWB4hUUyP5Hx30", + "name": "Attachment", + "type": "multipleAttachments", + "options": { + "isReversed": false + } + }, + { + "id": "fld7UipYF2w9FsoRm", + "name": "Checkbox", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } + }, + { + "id": "fldHVbDsv6ndNp2XZ", + "name": "Date", + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + } + }, + { + "id": "fldYL0IFRMVQCO7gW", + "name": "Phone", + "type": "phoneNumber" + }, + { + "id": "fldzsmOGCGjThDsUp", + "name": "Email", + "type": "email" + }, + { + "id": "fldMWVcVuR9CmKBcD", + "name": "Link", + "type": "url" + } + ], + "views": [ + { + "id": "viwMlZ7T3KyjEufmW", + "name": "Grid view", + "type": "grid" + } + ] +} +``` diff --git a/docs/en/md/Airtable/Working-with-databases/Create-database.md b/docs/en/md/Airtable/Working-with-databases/Create-database.md deleted file mode 100644 index e0be900ed9..0000000000 --- a/docs/en/md/Airtable/Working-with-databases/Create-database.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create base - Creates a new database - - - -`Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Workspace | --ws | String | Workspace identifier | - | Name | --title | String | New base name | - | TableCollection | --tablesdata | Map Of KeyAndValue | Table description: Key > name, Value > array of fields | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Region = "wspdf8yl1yZz3PmWZ"; - Name = "TestDatabase"; - - FieldArray = New Array; - FieldArray.Add(OPI_Airtable.GetNumberField("Number")); - FieldArray.Add(OPI_Airtable.GetStringField("String")); - - TableName = "TestTable"; - - TableMapping = New Map; - TableMapping.Insert(TableName, FieldArray); - - Result = OPI_Airtable.CreateDatabase(Token, Region, Name, TableMapping); -``` - - - - -```json title="Result" -{ - "id": "appD2vawGftoNUTKW", - "tables": [ - { - "id": "tblbhqzh3PL3cS6Ch", - "name": "TestTable", - "primaryFieldId": "fld9JrMjoVLwSPy3C", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld9JrMjoVLwSPy3C", - "name": "Number" - }, - { - "type": "richText", - "id": "fld044xLas7uBdddr", - "name": "String" - } - ], - "views": [ - { - "id": "viwfJdwEI0dtqJMl6", - "name": "Grid view", - "type": "grid" - } - ] - } - ] -} -``` diff --git a/docs/en/md/Airtable/Working-with-databases/Create-database.mdx b/docs/en/md/Airtable/Working-with-databases/Create-database.mdx new file mode 100644 index 0000000000..885a4a6beb --- /dev/null +++ b/docs/en/md/Airtable/Working-with-databases/Create-database.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create base + Creates a new database + + + +`Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Workspace | --ws | String | Workspace identifier | + | Name | --title | String | New base name | + | TableCollection | --tablesdata | Map Of KeyAndValue | Table description: Key > name, Value > array of fields | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Region = "wspdf8yl1yZz3PmWZ"; + Name = "TestDatabase"; + + FieldArray = New Array; + FieldArray.Add(OPI_Airtable.GetNumberField("Number")); + FieldArray.Add(OPI_Airtable.GetStringField("String")); + + TableName = "TestTable"; + + TableMapping = New Map; + TableMapping.Insert(TableName, FieldArray); + + Result = OPI_Airtable.CreateDatabase(Token, Region, Name, TableMapping); +``` + + + + +```json title="Result" +{ + "id": "appD2vawGftoNUTKW", + "tables": [ + { + "id": "tblbhqzh3PL3cS6Ch", + "name": "TestTable", + "primaryFieldId": "fld9JrMjoVLwSPy3C", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld9JrMjoVLwSPy3C", + "name": "Number" + }, + { + "type": "richText", + "id": "fld044xLas7uBdddr", + "name": "String" + } + ], + "views": [ + { + "id": "viwfJdwEI0dtqJMl6", + "name": "Grid view", + "type": "grid" + } + ] + } + ] +} +``` diff --git a/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md b/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md deleted file mode 100644 index c18cced62d..0000000000 --- a/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get base tables - Gets the schema of base tables - - - -`Function GetDatabaseTables(Val Token, Val Base) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - - Result = OPI_Airtable.GetDatabaseTables(Token, Base); -``` - - - - -```json title="Result" -{ - "tables": [ - { - "id": "tblbhqzh3PL3cS6Ch", - "name": "TestTable", - "primaryFieldId": "fld9JrMjoVLwSPy3C", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld9JrMjoVLwSPy3C", - "name": "Number" - }, - { - "type": "richText", - "id": "fld044xLas7uBdddr", - "name": "String" - } - ], - "views": [ - { - "id": "viwfJdwEI0dtqJMl6", - "name": "Grid view", - "type": "grid" - } - ] - } - ] -} -``` diff --git a/docs/en/md/Airtable/Working-with-databases/Get-database-tables.mdx b/docs/en/md/Airtable/Working-with-databases/Get-database-tables.mdx new file mode 100644 index 0000000000..52e9847e7c --- /dev/null +++ b/docs/en/md/Airtable/Working-with-databases/Get-database-tables.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get base tables + Gets the schema of base tables + + + +`Function GetDatabaseTables(Val Token, Val Base) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + + Result = OPI_Airtable.GetDatabaseTables(Token, Base); +``` + + + + +```json title="Result" +{ + "tables": [ + { + "id": "tblbhqzh3PL3cS6Ch", + "name": "TestTable", + "primaryFieldId": "fld9JrMjoVLwSPy3C", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld9JrMjoVLwSPy3C", + "name": "Number" + }, + { + "type": "richText", + "id": "fld044xLas7uBdddr", + "name": "String" + } + ], + "views": [ + { + "id": "viwfJdwEI0dtqJMl6", + "name": "Grid view", + "type": "grid" + } + ] + } + ] +} +``` diff --git a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md deleted file mode 100644 index 80e252ed08..0000000000 --- a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of bases - Gets the list of available bases - - - -`Function GetListOfBases(Val Token, Val Indent = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Indent | --offset | String | Next page identifier of the base list from the previous request | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - - Result = OPI_Airtable.GetListOfBases(Token); -``` - - - - -```json title="Result" -{ - "bases": [ - { - "id": "appGarzKZ0lu3gzoa", - "name": "Test", - "permissionLevel": "create" - }, - { - "id": "app9WRfJirwn3yXuG", - "name": "Product catalog", - "permissionLevel": "create" - }, - { - "id": "app6gigUYTzlDEq4X", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "app5hJGyK8asYYe1Q", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appRQ6VxxOZb40Uwi", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appM6FaGofV2XSfFA", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "apptm8Xqo7TwMaipQ", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appsyQyGrF8aVN2Wm", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "applEsyJmBRm12AuN", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appbh1wYGbZlmn3pN", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "apppkKYsw7O1Gqhxl", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appIHzEhKAimg9S2p", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "app5Zyj15QZisbqvA", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "app05ybJZ2aiF7jiV", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appKbK1rnu08kOueO", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appBTTgSQtzCkrp4V", - "name": "База из Оинт", - "permissionLevel": "create" - }, - { - "id": "appDtM9dK5yzXduUB", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appqyGu9Cdx9xWvEs", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appczCGkB55A13rQ2", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appxClK6G6i2DREOB", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appsYySkvo8kafUdd", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appw2EFeyyNgwmhP6", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appqEloLDyI7p6uzS", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appdTFa0GMiOdaxVp", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appuREJLUMSxU9Tww", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appQwerTglYZLYkLl", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "apptPCnUGDn0M76to", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appgg50vNZwX1aZmu", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appHB3hm34ZkAjflT", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "appuHDfwXADAD5QDj", - "name": "TestDatabase", -... -``` diff --git a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.mdx b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.mdx new file mode 100644 index 0000000000..014da976e1 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.mdx @@ -0,0 +1,189 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of bases + Gets the list of available bases + + + +`Function GetListOfBases(Val Token, Val Indent = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Indent | --offset | String | Next page identifier of the base list from the previous request | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + + Result = OPI_Airtable.GetListOfBases(Token); +``` + + + + +```json title="Result" +{ + "bases": [ + { + "id": "appGarzKZ0lu3gzoa", + "name": "Test", + "permissionLevel": "create" + }, + { + "id": "app9WRfJirwn3yXuG", + "name": "Product catalog", + "permissionLevel": "create" + }, + { + "id": "app6gigUYTzlDEq4X", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "app5hJGyK8asYYe1Q", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appRQ6VxxOZb40Uwi", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appM6FaGofV2XSfFA", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "apptm8Xqo7TwMaipQ", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appsyQyGrF8aVN2Wm", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "applEsyJmBRm12AuN", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appbh1wYGbZlmn3pN", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "apppkKYsw7O1Gqhxl", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appIHzEhKAimg9S2p", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "app5Zyj15QZisbqvA", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "app05ybJZ2aiF7jiV", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appKbK1rnu08kOueO", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appBTTgSQtzCkrp4V", + "name": "База из Оинт", + "permissionLevel": "create" + }, + { + "id": "appDtM9dK5yzXduUB", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appqyGu9Cdx9xWvEs", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appczCGkB55A13rQ2", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appxClK6G6i2DREOB", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appsYySkvo8kafUdd", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appw2EFeyyNgwmhP6", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appqEloLDyI7p6uzS", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appdTFa0GMiOdaxVp", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appuREJLUMSxU9Tww", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appQwerTglYZLYkLl", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "apptPCnUGDn0M76to", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appgg50vNZwX1aZmu", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appHB3hm34ZkAjflT", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "appuHDfwXADAD5QDj", + "name": "TestDatabase", +... +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Create-field.md b/docs/en/md/Airtable/Working-with-fields/Create-field.md deleted file mode 100644 index c47322068a..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Create-field.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create field - Creates a new field in the table - - - -`Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier | - | Table | --table | String | Table identifier | - | FieldStructure | --fielddata | Structure of KeyAndValue | Description of the new field | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Name = String(New UUID); - - Field = OPI_Airtable.GetNumberField(Name); - Result = OPI_Airtable.CreateField(Token, Base, Table, Field); -``` - - - - -```json title="Result" -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldDqI1OXajeQw5Gg", - "name": "b3fd1280-83b2-4145-838d-3437b14adee3" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Create-field.mdx b/docs/en/md/Airtable/Working-with-fields/Create-field.mdx new file mode 100644 index 0000000000..1c5d1b03df --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Create-field.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create field + Creates a new field in the table + + + +`Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier | + | Table | --table | String | Table identifier | + | FieldStructure | --fielddata | Structure of KeyAndValue | Description of the new field | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Name = String(New UUID); + + Field = OPI_Airtable.GetNumberField(Name); + Result = OPI_Airtable.CreateField(Token, Base, Table, Field); +``` + + + + +```json title="Result" +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldDqI1OXajeQw5Gg", + "name": "b3fd1280-83b2-4145-838d-3437b14adee3" +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md b/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md deleted file mode 100644 index 4e9c19961e..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get field (file) - Gets the description of a file field - - - -`Function GetAttachmentField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetAttachmentField("Attachment"); -``` - - - - -```json title="Result" -{ - "name": "Attachment", - "type": "multipleAttachments" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.mdx new file mode 100644 index 0000000000..9f928a4b32 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.mdx @@ -0,0 +1,39 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get field (file) + Gets the description of a file field + + + +`Function GetAttachmentField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetAttachmentField("Attachment"); +``` + + + + +```json title="Result" +{ + "name": "Attachment", + "type": "multipleAttachments" +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md b/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md deleted file mode 100644 index a16be4d106..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get field (checkbox) - Gets the description of a boolean field - - - -`Function GetCheckboxField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetCheckboxField("Checkbox"); -``` - - - - -```json title="Result" -{ - "name": "Checkbox", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.mdx new file mode 100644 index 0000000000..122b0b9cd8 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get field (checkbox) + Gets the description of a boolean field + + + +`Function GetCheckboxField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetCheckboxField("Checkbox"); +``` + + + + +```json title="Result" +{ + "name": "Checkbox", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-date-field.md b/docs/en/md/Airtable/Working-with-fields/Get-date-field.md deleted file mode 100644 index aa416dc985..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-date-field.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get field (date) - Gets the description of a date field - - - -`Function GetDateField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetDateField("Date"); -``` - - - - -```json title="Result" -{ - "name": "Date", - "type": "date", - "options": { - "dateFormat": { - "format": "YYYY-MM-DD", - "name": "iso" - } - } -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-date-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-date-field.mdx new file mode 100644 index 0000000000..fc055053d4 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-date-field.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get field (date) + Gets the description of a date field + + + +`Function GetDateField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetDateField("Date"); +``` + + + + +```json title="Result" +{ + "name": "Date", + "type": "date", + "options": { + "dateFormat": { + "format": "YYYY-MM-DD", + "name": "iso" + } + } +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-email-field.md b/docs/en/md/Airtable/Working-with-fields/Get-email-field.md deleted file mode 100644 index 4508c2aa64..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-email-field.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get field (email) - Gets the description of an email field - - - -`Function GetEmailField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetEmailField("Email"); -``` - - - - -```json title="Result" -{ - "name": "Email", - "type": "email" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-email-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-email-field.mdx new file mode 100644 index 0000000000..4245f3db9b --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-email-field.mdx @@ -0,0 +1,39 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get field (email) + Gets the description of an email field + + + +`Function GetEmailField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetEmailField("Email"); +``` + + + + +```json title="Result" +{ + "name": "Email", + "type": "email" +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-link-field.md b/docs/en/md/Airtable/Working-with-fields/Get-link-field.md deleted file mode 100644 index ace7203f05..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-link-field.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Get field (url) - Gets the description of a URL field - - - -`Function GetLinkField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetLinkField("Link"); -``` - - - - -```json title="Result" -{ - "name": "Link", - "type": "url" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-link-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-link-field.mdx new file mode 100644 index 0000000000..b2b2845816 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-link-field.mdx @@ -0,0 +1,39 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Get field (url) + Gets the description of a URL field + + + +`Function GetLinkField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetLinkField("Link"); +``` + + + + +```json title="Result" +{ + "name": "Link", + "type": "url" +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-number-field.md b/docs/en/md/Airtable/Working-with-fields/Get-number-field.md deleted file mode 100644 index bf8726250b..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-number-field.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get field (numeric) - Gets the description of a numeric field - - - -`Function GetNumberField(Val Name, Val Precision = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | New field name | - | Precision | --precision | Number, String | Number of decimal places | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetNumberField("Number"); -``` - - - - -```json title="Result" -{ - "name": "Number", - "type": "number", - "options": { - "precision": 0 - } -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-number-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-number-field.mdx new file mode 100644 index 0000000000..4b0815e412 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-number-field.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get field (numeric) + Gets the description of a numeric field + + + +`Function GetNumberField(Val Name, Val Precision = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | New field name | + | Precision | --precision | Number, String | Number of decimal places | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetNumberField("Number"); +``` + + + + +```json title="Result" +{ + "name": "Number", + "type": "number", + "options": { + "precision": 0 + } +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md b/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md deleted file mode 100644 index 7762cbb7a9..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Get field (phone) - Gets the description of a phone number field - - - -`Function GetPhoneField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetPhoneField("Phone"); -``` - - - - -```json title="Result" -{ - "name": "Phone", - "type": "phoneNumber" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-phone-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-phone-field.mdx new file mode 100644 index 0000000000..1d31337120 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-phone-field.mdx @@ -0,0 +1,39 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Get field (phone) + Gets the description of a phone number field + + + +`Function GetPhoneField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetPhoneField("Phone"); +``` + + + + +```json title="Result" +{ + "name": "Phone", + "type": "phoneNumber" +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-string-field.md b/docs/en/md/Airtable/Working-with-fields/Get-string-field.md deleted file mode 100644 index 47843a1a5c..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Get-string-field.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get field (string) - Gets the description of a string field - - - -`Function GetStringField(Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | New field name | - - - Returns: Structure - Field description - -
- - - - -```bsl title="Code example" - Result = OPI_Airtable.GetStringField("String"); -``` - - - - -```json title="Result" -{ - "name": "String", - "type": "richText" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-string-field.mdx b/docs/en/md/Airtable/Working-with-fields/Get-string-field.mdx new file mode 100644 index 0000000000..4bf666377e --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Get-string-field.mdx @@ -0,0 +1,39 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get field (string) + Gets the description of a string field + + + +`Function GetStringField(Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | New field name | + + + Returns: Structure - Field description + +
+ + + + +```bsl title="Code example" + Result = OPI_Airtable.GetStringField("String"); +``` + + + + +```json title="Result" +{ + "name": "String", + "type": "richText" +} +``` diff --git a/docs/en/md/Airtable/Working-with-fields/Modify-field.md b/docs/en/md/Airtable/Working-with-fields/Modify-field.md deleted file mode 100644 index 1d299a6e70..0000000000 --- a/docs/en/md/Airtable/Working-with-fields/Modify-field.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Modify 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` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier Base | - | Table | --table | String | Table identifier | - | Field | --field | String | Field identifier | - | Name | --title | String | New name | - | Description | --description | String | New description | - - - Returns: Map Of KeyAndValue - serialized JSON response from Airtable - -
- - - - -```bsl title="Code example" - Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Base = "appESy99HYCLbuWlV"; - Table = "tbl5gZLQ8i5xKuVTy"; - Field = "fldzPMAQ2obgGcvxG"; - - Name = String(New UUID) + "(change.)"; - Description = "New description"; - - Result = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); -``` - - - - -```json title="Result" -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldDqI1OXajeQw5Gg", - "name": "2cf91139-d111-4599-87bf-e3510ea23584(change.)", - "description": "New description" -} -``` diff --git a/docs/en/md/Airtable/Working-with-fields/Modify-field.mdx b/docs/en/md/Airtable/Working-with-fields/Modify-field.mdx new file mode 100644 index 0000000000..c852d8c5e0 --- /dev/null +++ b/docs/en/md/Airtable/Working-with-fields/Modify-field.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Modify 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` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier Base | + | Table | --table | String | Table identifier | + | Field | --field | String | Field identifier | + | Name | --title | String | New name | + | Description | --description | String | New description | + + + Returns: Map Of KeyAndValue - serialized JSON response from Airtable + +
+ + + + +```bsl title="Code example" + Token = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Base = "appESy99HYCLbuWlV"; + Table = "tbl5gZLQ8i5xKuVTy"; + Field = "fldzPMAQ2obgGcvxG"; + + Name = String(New UUID) + "(change.)"; + Description = "New description"; + + Result = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); +``` + + + + +```json title="Result" +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldDqI1OXajeQw5Gg", + "name": "2cf91139-d111-4599-87bf-e3510ea23584(change.)", + "description": "New description" +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md deleted file mode 100644 index 747747a8eb..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create new subfolder - Create new folder inside another folder - - - -`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Parent folder identifier | - | Name | --title | String | Name of new folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) -::: -
- - -```bsl title="Code example" - FolderID = "12882"; - Name = "New subfolder"; - Filename2 = "New subfolder 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12586, - "NAME": "New subfolder", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 12586, - "PARENT_ID": "12582", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-10-09T09:20:24+03:00", - "UPDATE_TIME": "2024-10-09T09:20:24+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" - }, - "time": { - "start": 1728454824.78198, - "finish": 1728454824.8632, - "duration": 0.0812170505523682, - "processing": 0.0518698692321777, - "date_start": "2024-10-09T09:20:24+03:00", - "date_finish": "2024-10-09T09:20:24+03:00", - "operating_reset_at": 1728455424, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx new file mode 100644 index 0000000000..27bec61aeb --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create new subfolder + Create new folder inside another folder + + + +`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Parent folder identifier | + | Name | --title | String | Name of new folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) +::: +
+ + +```bsl title="Code example" + FolderID = "12882"; + Name = "New subfolder"; + Filename2 = "New subfolder 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12586, + "NAME": "New subfolder", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 12586, + "PARENT_ID": "12582", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-10-09T09:20:24+03:00", + "UPDATE_TIME": "2024-10-09T09:20:24+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" + }, + "time": { + "start": 1728454824.78198, + "finish": 1728454824.8632, + "duration": 0.0812170505523682, + "processing": 0.0518698692321777, + "date_start": "2024-10-09T09:20:24+03:00", + "date_finish": "2024-10-09T09:20:24+03:00", + "operating_reset_at": 1728455424, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md deleted file mode 100644 index 0706763d23..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete folder - Remove folder with subfolders - - - -`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | ID of folder to be deleted | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FolderID = "12880"; - - Result = OPI_Bitrix24.DeleteFolder(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - FolderID = "12882"; - - Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454830.52802, - "finish": 1728454830.60905, - "duration": 0.0810229778289795, - "processing": 0.0520169734954834, - "date_start": "2024-10-09T09:20:30+03:00", - "date_finish": "2024-10-09T09:20:30+03:00", - "operating_reset_at": 1728455430, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.mdx new file mode 100644 index 0000000000..ed1fb1effe --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete folder + Remove folder with subfolders + + + +`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | ID of folder to be deleted | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FolderID = "12880"; + + Result = OPI_Bitrix24.DeleteFolder(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + FolderID = "12882"; + + Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454830.52802, + "finish": 1728454830.60905, + "duration": 0.0810229778289795, + "processing": 0.0520169734954834, + "date_start": "2024-10-09T09:20:30+03:00", + "date_finish": "2024-10-09T09:20:30+03:00", + "operating_reset_at": 1728455430, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md deleted file mode 100644 index 788e556857..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get external link for folder - Get external link to folder - - - -`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FolderID = "12882"; - - Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token); -``` - - - - -```json title="Result" -{ - "result": "https://b24-ar17wx.bitrix24.by/~arC9o", - "time": { - "start": 1728454824.46489, - "finish": 1728454824.50162, - "duration": 0.0367348194122314, - "processing": 0.00669717788696289, - "date_start": "2024-10-09T09:20:24+03:00", - "date_finish": "2024-10-09T09:20:24+03:00", - "operating_reset_at": 1728455424, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.mdx new file mode 100644 index 0000000000..48374d7b78 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get external link for folder + Get external link to folder + + + +`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FolderID = "12882"; + + Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token); +``` + + + + +```json title="Result" +{ + "result": "https://b24-ar17wx.bitrix24.by/~arC9o", + "time": { + "start": 1728454824.46489, + "finish": 1728454824.50162, + "duration": 0.0367348194122314, + "processing": 0.00669717788696289, + "date_start": "2024-10-09T09:20:24+03:00", + "date_finish": "2024-10-09T09:20:24+03:00", + "operating_reset_at": 1728455424, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md deleted file mode 100644 index aeb8b8a4d1..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Get fields structure for folder items filter - Returns filter structure for child folder items - - - -`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Structure of KeyAndValue - Fields structure - -
- -:::tip -Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetFolderFilterStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token); -``` - - - - -```json title="Result" -{ - "ID": "", - "NAME": "", - "TYPE": "", - "CODE": "", - "STORAGE_ID": "", - "PARENT_ID": "", - "CREATE_TIME": "", - "UPDATE_TIME": "", - "DELETE_TIME": "", - "DELETED_TYPE": "" -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.mdx new file mode 100644 index 0000000000..0397da1420 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Get fields structure for folder items filter + Returns filter structure for child folder items + + + +`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ +:::tip +Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetFolderFilterStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token); +``` + + + + +```json title="Result" +{ + "ID": "", + "NAME": "", + "TYPE": "", + "CODE": "", + "STORAGE_ID": "", + "PARENT_ID": "", + "CREATE_TIME": "", + "UPDATE_TIME": "", + "DELETE_TIME": "", + "DELETED_TYPE": "" +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md deleted file mode 100644 index 888a865497..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get information about folder - Get folder information - - - -`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FolderID = "12882"; - - Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12582", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12582", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-09T09:20:23+03:00", - "UPDATE_TIME": "2024-10-09T09:20:23+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1728454824.27792, - "finish": 1728454824.31056, - "duration": 0.0326480865478516, - "processing": 0.00559186935424805, - "date_start": "2024-10-09T09:20:24+03:00", - "date_finish": "2024-10-09T09:20:24+03:00", - "operating_reset_at": 1728455424, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.mdx new file mode 100644 index 0000000000..727e4cb3ad --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get information about folder + Get folder information + + + +`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FolderID = "12882"; + + Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12582", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12582", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-09T09:20:23+03:00", + "UPDATE_TIME": "2024-10-09T09:20:23+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1728454824.27792, + "finish": 1728454824.31056, + "duration": 0.0326480865478516, + "processing": 0.00559186935424805, + "date_start": "2024-10-09T09:20:24+03:00", + "date_finish": "2024-10-09T09:20:24+03:00", + "operating_reset_at": 1728455424, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md deleted file mode 100644 index 2efbfaba13..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get folder child elements - Get folder child elements - - - -`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FolderID = "12882"; - - Result = OPI_Bitrix24.GetFolderItems(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderItems(URL, FolderID, , Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "12584", - "NAME": "New subfolder 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12584", - "PARENT_ID": "12582", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-09T09:20:24+03:00", - "UPDATE_TIME": "2024-10-09T09:20:25+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2" - }, - { - "ID": "12586", - "NAME": "New subfolder", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12586", - "PARENT_ID": "12582", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-09T09:20:24+03:00", - "UPDATE_TIME": "2024-10-09T09:20:25+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" - }, - { - "ID": "12604", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "12582", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8678", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:28+03:00", - "UPDATE_TIME": "2024-10-09T09:20:28+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDQmXz03bHFpaTl0bjV6aFk1SnFVY0szYU5RMVNSRHlWb2ZwcA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNRFFtWHowM2JIRnBhVGwwYmpWNmFGazFTbkZWWTBzellVNVJNVk5TUkhsV2IyWndjQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.SL6HjOaIdsjTX1Tik1rou9x26mZ6E8LBmyKI4jcVsps%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg" - } - ], - "total": 3, - "time": { - "start": 1728454829.29148, - "finish": 1728454829.32633, - "duration": 0.0348570346832275, - "processing": 0.00847411155700684, - "date_start": "2024-10-09T09:20:29+03:00", - "date_finish": "2024-10-09T09:20:29+03:00", - "operating_reset_at": 1728455429, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx new file mode 100644 index 0000000000..dd3903a918 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx @@ -0,0 +1,118 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get folder child elements + Get folder child elements + + + +`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FolderID = "12882"; + + Result = OPI_Bitrix24.GetFolderItems(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderItems(URL, FolderID, , Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "12584", + "NAME": "New subfolder 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12584", + "PARENT_ID": "12582", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-09T09:20:24+03:00", + "UPDATE_TIME": "2024-10-09T09:20:25+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2" + }, + { + "ID": "12586", + "NAME": "New subfolder", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12586", + "PARENT_ID": "12582", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-09T09:20:24+03:00", + "UPDATE_TIME": "2024-10-09T09:20:25+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" + }, + { + "ID": "12604", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "12582", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8678", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:28+03:00", + "UPDATE_TIME": "2024-10-09T09:20:28+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDQmXz03bHFpaTl0bjV6aFk1SnFVY0szYU5RMVNSRHlWb2ZwcA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNRFFtWHowM2JIRnBhVGwwYmpWNmFGazFTbkZWWTBzellVNVJNVk5TUkhsV2IyWndjQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.SL6HjOaIdsjTX1Tik1rou9x26mZ6E8LBmyKI4jcVsps%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg" + } + ], + "total": 3, + "time": { + "start": 1728454829.29148, + "finish": 1728454829.32633, + "duration": 0.0348570346832275, + "processing": 0.00847411155700684, + "date_start": "2024-10-09T09:20:29+03:00", + "date_finish": "2024-10-09T09:20:29+03:00", + "operating_reset_at": 1728455429, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md deleted file mode 100644 index a493bc5fe4..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Copy folder - Copy one folder to another - - - -`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | DestinationID | --tagetid | String, Number | ID of target folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) -::: -
- - -```bsl title="Code example" - DestinationID = "12884"; - FolderID = "12886"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID); - - DestinationID = "12886"; - FolderID = "12884"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token); - - OPI_TestDataRetrieval.Check_BitrixObject(Result); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12592, - "NAME": "New subfolder 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 12592, - "PARENT_ID": "12586", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-10-09T09:20:25+03:00", - "UPDATE_TIME": "2024-10-09T09:20:25+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2" - }, - "time": { - "start": 1728454825.37565, - "finish": 1728454825.50996, - "duration": 0.134312868118286, - "processing": 0.109131097793579, - "date_start": "2024-10-09T09:20:25+03:00", - "date_finish": "2024-10-09T09:20:25+03:00", - "operating_reset_at": 1728455425, - "operating": 0.109107971191406 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx new file mode 100644 index 0000000000..df2312157e --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Copy folder + Copy one folder to another + + + +`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | DestinationID | --tagetid | String, Number | ID of target folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) +::: +
+ + +```bsl title="Code example" + DestinationID = "12884"; + FolderID = "12886"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID); + + DestinationID = "12886"; + FolderID = "12884"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token); + + OPI_TestDataRetrieval.Check_BitrixObject(Result); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12592, + "NAME": "New subfolder 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 12592, + "PARENT_ID": "12586", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-10-09T09:20:25+03:00", + "UPDATE_TIME": "2024-10-09T09:20:25+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2" + }, + "time": { + "start": 1728454825.37565, + "finish": 1728454825.50996, + "duration": 0.134312868118286, + "processing": 0.109131097793579, + "date_start": "2024-10-09T09:20:25+03:00", + "date_finish": "2024-10-09T09:20:25+03:00", + "operating_reset_at": 1728455425, + "operating": 0.109107971191406 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md deleted file mode 100644 index 3e4d9d5e7d..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Mark folder as deleted - Move folder to recycle bin - - - -`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FolderID = "12882"; - - Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12582", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12582", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "CREATE_TIME": "2024-10-09T09:20:23+03:00", - "UPDATE_TIME": "2024-10-09T09:20:28+03:00", - "DELETE_TIME": "2024-10-09T09:20:29+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1728454829.76518, - "finish": 1728454829.80079, - "duration": 0.0356080532073975, - "processing": 0.00615215301513672, - "date_start": "2024-10-09T09:20:29+03:00", - "date_finish": "2024-10-09T09:20:29+03:00", - "operating_reset_at": 1728455429, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.mdx new file mode 100644 index 0000000000..91be869e5b --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Mark folder as deleted + Move folder to recycle bin + + + +`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FolderID = "12882"; + + Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12582", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12582", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "CREATE_TIME": "2024-10-09T09:20:23+03:00", + "UPDATE_TIME": "2024-10-09T09:20:28+03:00", + "DELETE_TIME": "2024-10-09T09:20:29+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1728454829.76518, + "finish": 1728454829.80079, + "duration": 0.0356080532073975, + "processing": 0.00615215301513672, + "date_start": "2024-10-09T09:20:29+03:00", + "date_finish": "2024-10-09T09:20:29+03:00", + "operating_reset_at": 1728455429, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md deleted file mode 100644 index df538a73df..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Move folder - Moves one folder inside another - - - -`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | DestinationID | --tagetid | String, Number | ID of target folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) -::: -
- - -```bsl title="Code example" - DestinationID = "12880"; - FolderID = "12886"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID); - - FolderID = "12884"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token); - - OPI_TestDataRetrieval.Check_BitrixObject(Result); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12584", - "NAME": "New subfolder 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12584", - "PARENT_ID": 12580, - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-09T09:20:24+03:00", - "UPDATE_TIME": "2024-10-09T09:20:25+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2" - }, - "time": { - "start": 1728454829.50812, - "finish": 1728454829.56734, - "duration": 0.0592169761657715, - "processing": 0.0330197811126709, - "date_start": "2024-10-09T09:20:29+03:00", - "date_finish": "2024-10-09T09:20:29+03:00", - "operating_reset_at": 1728455429, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.mdx new file mode 100644 index 0000000000..4f719ecd88 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Move folder + Moves one folder inside another + + + +`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | DestinationID | --tagetid | String, Number | ID of target folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) +::: +
+ + +```bsl title="Code example" + DestinationID = "12880"; + FolderID = "12886"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID); + + FolderID = "12884"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token); + + OPI_TestDataRetrieval.Check_BitrixObject(Result); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12584", + "NAME": "New subfolder 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12584", + "PARENT_ID": 12580, + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-09T09:20:24+03:00", + "UPDATE_TIME": "2024-10-09T09:20:25+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2" + }, + "time": { + "start": 1728454829.50812, + "finish": 1728454829.56734, + "duration": 0.0592169761657715, + "processing": 0.0330197811126709, + "date_start": "2024-10-09T09:20:29+03:00", + "date_finish": "2024-10-09T09:20:29+03:00", + "operating_reset_at": 1728455429, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md deleted file mode 100644 index ef20cc6a82..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Rename folder - Change folder name - - - -`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Name | --title | String | New folders name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) -::: -
- - -```bsl title="Code example" - Name = "New catalog"; - Filename2 = "New folder 2"; - - FolderID2 = "12880"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2); - - FolderID = "12882"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12582", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12582", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-09T09:20:23+03:00", - "UPDATE_TIME": "2024-10-09T09:20:23+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1728454824.0992, - "finish": 1728454824.13256, - "duration": 0.0333640575408936, - "processing": 0.00759291648864746, - "date_start": "2024-10-09T09:20:24+03:00", - "date_finish": "2024-10-09T09:20:24+03:00", - "operating_reset_at": 1728455424, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.mdx new file mode 100644 index 0000000000..e2c561d791 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Rename folder + Change folder name + + + +`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Name | --title | String | New folders name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New catalog"; + Filename2 = "New folder 2"; + + FolderID2 = "12880"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2); + + FolderID = "12882"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12582", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12582", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-09T09:20:23+03:00", + "UPDATE_TIME": "2024-10-09T09:20:23+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1728454824.0992, + "finish": 1728454824.13256, + "duration": 0.0333640575408936, + "processing": 0.00759291648864746, + "date_start": "2024-10-09T09:20:24+03:00", + "date_finish": "2024-10-09T09:20:24+03:00", + "operating_reset_at": 1728455424, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md deleted file mode 100644 index 3bc32deeeb..0000000000 --- a/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Restore folder - Resotre folder form recycle bin - - - -`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FolderID = "12882"; - - Result = OPI_Bitrix24.RestoreFolder(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12582", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12582", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-09T09:20:23+03:00", - "UPDATE_TIME": "2024-10-09T09:20:29+03:00", - "DELETE_TIME": "2024-10-09T09:20:29+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1728454829.99146, - "finish": 1728454830.02273, - "duration": 0.031264066696167, - "processing": 0.0063779354095459, - "date_start": "2024-10-09T09:20:29+03:00", - "date_finish": "2024-10-09T09:20:30+03:00", - "operating_reset_at": 1728455430, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.mdx b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.mdx new file mode 100644 index 0000000000..0c24da8647 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Restore folder + Resotre folder form recycle bin + + + +`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FolderID = "12882"; + + Result = OPI_Bitrix24.RestoreFolder(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12582", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12582", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-09T09:20:23+03:00", + "UPDATE_TIME": "2024-10-09T09:20:29+03:00", + "DELETE_TIME": "2024-10-09T09:20:29+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1728454829.99146, + "finish": 1728454830.02273, + "duration": 0.031264066696167, + "processing": 0.0063779354095459, + "date_start": "2024-10-09T09:20:29+03:00", + "date_finish": "2024-10-09T09:20:30+03:00", + "operating_reset_at": 1728455430, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md deleted file mode 100644 index 95bbc42e25..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Add users to chat - Adds users to the chat by ID array - - - -`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | UserIDs | --users | Array of string, number | New members IDs | - | HideHistory | --hide | Boolean | Hide old messages from new members | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - UserIDs = New Array; - UserIDs.Add(10); - UserIDs.Add(12); - - Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - UserID = 10; - - Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454873.26338, - "finish": 1728454873.34975, - "duration": 0.0863678455352783, - "processing": 0.0585901737213135, - "date_start": "2024-10-09T09:21:13+03:00", - "date_finish": "2024-10-09T09:21:13+03:00", - "operating_reset_at": 1728455473, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.mdx new file mode 100644 index 0000000000..10ef613cea --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Add users to chat + Adds users to the chat by ID array + + + +`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserIDs | --users | Array of string, number | New members IDs | + | HideHistory | --hide | Boolean | Hide old messages from new members | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + UserIDs = New Array; + UserIDs.Add(10); + UserIDs.Add(12); + + Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + UserID = 10; + + Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454873.26338, + "finish": 1728454873.34975, + "duration": 0.0863678455352783, + "processing": 0.0585901737213135, + "date_start": "2024-10-09T09:21:13+03:00", + "date_finish": "2024-10-09T09:21:13+03:00", + "operating_reset_at": 1728455473, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md deleted file mode 100644 index 49a1ae0d68..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Change chat color - Chat chat color for mobile app - - - -`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Color | --color | String | New chat color | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) - - Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Color = "AZURE"; - - Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Color = "PURPLE"; - - Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454888.85994, - "finish": 1728454888.95268, - "duration": 0.0927419662475586, - "processing": 0.064525842666626, - "date_start": "2024-10-09T09:21:28+03:00", - "date_finish": "2024-10-09T09:21:28+03:00", - "operating_reset_at": 1728455488, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.mdx new file mode 100644 index 0000000000..067740e076 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Change chat color + Chat chat color for mobile app + + + +`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Color | --color | String | New chat color | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) + + Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Color = "AZURE"; + + Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Color = "PURPLE"; + + Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454888.85994, + "finish": 1728454888.95268, + "duration": 0.0927419662475586, + "processing": 0.064525842666626, + "date_start": "2024-10-09T09:21:28+03:00", + "date_finish": "2024-10-09T09:21:28+03:00", + "operating_reset_at": 1728455488, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md deleted file mode 100644 index 121cd693e0..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Change chat owner - Change chat owner - - - -`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | UserID | --user | String, Number | User ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - UserID = 10; - - Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454918.87876, - "finish": 1728454918.91642, - "duration": 0.0376641750335693, - "processing": 0.0113739967346191, - "date_start": "2024-10-09T09:21:58+03:00", - "date_finish": "2024-10-09T09:21:58+03:00", - "operating_reset_at": 1728455518, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.mdx new file mode 100644 index 0000000000..799dcaba35 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Change chat owner + Change chat owner + + + +`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserID | --user | String, Number | User ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + UserID = 10; + + Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454918.87876, + "finish": 1728454918.91642, + "duration": 0.0376641750335693, + "processing": 0.0113739967346191, + "date_start": "2024-10-09T09:21:58+03:00", + "date_finish": "2024-10-09T09:21:58+03:00", + "operating_reset_at": 1728455518, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md deleted file mode 100644 index 2e5e0a3bc2..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Change chat picture - Setup new chat picture - - - -`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Image | --picture | String, BinaryData | Picture data | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Image = "https://api.athenaeum.digital/test_data/picture2.jpg"; - - Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454891.85277, - "finish": 1728454893.18775, - "duration": 1.33497500419617, - "processing": 1.30738711357117, - "date_start": "2024-10-09T09:21:31+03:00", - "date_finish": "2024-10-09T09:21:33+03:00", - "operating_reset_at": 1728455491, - "operating": 1.30736899375916 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.mdx new file mode 100644 index 0000000000..06800654e4 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Change chat picture + Setup new chat picture + + + +`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Image | --picture | String, BinaryData | Picture data | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Image = "https://api.athenaeum.digital/test_data/picture2.jpg"; + + Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454891.85277, + "finish": 1728454893.18775, + "duration": 1.33497500419617, + "processing": 1.30738711357117, + "date_start": "2024-10-09T09:21:31+03:00", + "date_finish": "2024-10-09T09:21:33+03:00", + "operating_reset_at": 1728455491, + "operating": 1.30736899375916 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md deleted file mode 100644 index 61334f49f0..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Change chat title - Change text of chat title - - - -`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Title | --title | String | New title | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Title = "New chat title"; - - Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Title = "Another title"; - - Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454873.54688, - "finish": 1728454873.62997, - "duration": 0.0830919742584228, - "processing": 0.0585200786590576, - "date_start": "2024-10-09T09:21:13+03:00", - "date_finish": "2024-10-09T09:21:13+03:00", - "operating_reset_at": 1728455473, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.mdx new file mode 100644 index 0000000000..002516a86a --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Change chat title + Change text of chat title + + + +`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Title | --title | String | New title | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Title = "New chat title"; + + Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Title = "Another title"; + + Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454873.54688, + "finish": 1728454873.62997, + "duration": 0.0830919742584228, + "processing": 0.0585200786590576, + "date_start": "2024-10-09T09:21:13+03:00", + "date_finish": "2024-10-09T09:21:13+03:00", + "operating_reset_at": 1728455473, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md deleted file mode 100644 index 577cb0199e..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create chat - Creates a new chat based on the field structure - - - -`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) -::: -
- - -```bsl title="Code example" - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - OPI_TypeConversion.GetBinaryData(Image); - - B64Image = GetBase64StringFromBinaryData(Image); - - MembersArray = New Array; - MembersArray.Add(10); - MembersArray.Add(1); - - ChatStructure = New Structure; - ChatStructure.Insert("TYPE" , "OPEN"); - ChatStructure.Insert("TITLE" , "New chat"); - ChatStructure.Insert("DESCRIPTION", "This is a new chat"); - ChatStructure.Insert("COLOR" , "GREEN"); - ChatStructure.Insert("MESSAGE" , "Welcome to new chat"); - ChatStructure.Insert("USERS" , MembersArray); - ChatStructure.Insert("AVATAR" , B64Image); - ChatStructure.Insert("OWNER_ID" , 1); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateChat(URL, ChatStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - ChatStructure = New Structure; - ChatStructure.Insert("TYPE" , "CHAT"); - ChatStructure.Insert("TITLE" , "Private chat"); - ChatStructure.Insert("USERS" , MembersArray); - - Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token); -``` - - - - -```json title="Result" -{ - "result": 988, - "time": { - "start": 1728454867.18514, - "finish": 1728454867.47953, - "duration": 0.294389009475708, - "processing": 0.258857011795044, - "date_start": "2024-10-09T09:21:07+03:00", - "date_finish": "2024-10-09T09:21:07+03:00", - "operating_reset_at": 1728455467, - "operating": 0.258837938308716 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.mdx new file mode 100644 index 0000000000..594300e259 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create chat + Creates a new chat based on the field structure + + + +`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) +::: +
+ + +```bsl title="Code example" + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + OPI_TypeConversion.GetBinaryData(Image); + + B64Image = GetBase64StringFromBinaryData(Image); + + MembersArray = New Array; + MembersArray.Add(10); + MembersArray.Add(1); + + ChatStructure = New Structure; + ChatStructure.Insert("TYPE" , "OPEN"); + ChatStructure.Insert("TITLE" , "New chat"); + ChatStructure.Insert("DESCRIPTION", "This is a new chat"); + ChatStructure.Insert("COLOR" , "GREEN"); + ChatStructure.Insert("MESSAGE" , "Welcome to new chat"); + ChatStructure.Insert("USERS" , MembersArray); + ChatStructure.Insert("AVATAR" , B64Image); + ChatStructure.Insert("OWNER_ID" , 1); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateChat(URL, ChatStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + ChatStructure = New Structure; + ChatStructure.Insert("TYPE" , "CHAT"); + ChatStructure.Insert("TITLE" , "Private chat"); + ChatStructure.Insert("USERS" , MembersArray); + + Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token); +``` + + + + +```json title="Result" +{ + "result": 988, + "time": { + "start": 1728454867.18514, + "finish": 1728454867.47953, + "duration": 0.294389009475708, + "processing": 0.258857011795044, + "date_start": "2024-10-09T09:21:07+03:00", + "date_finish": "2024-10-09T09:21:07+03:00", + "operating_reset_at": 1728455467, + "operating": 0.258837938308716 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md deleted file mode 100644 index 0ea5e7565b..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Delete user from chat - Deletes user from chat - - - -`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | UserID | --user | String, Number | User ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - UserID = 10; - - Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454872.91198, - "finish": 1728454873.00982, - "duration": 0.0978438854217529, - "processing": 0.0658779144287109, - "date_start": "2024-10-09T09:21:12+03:00", - "date_finish": "2024-10-09T09:21:13+03:00", - "operating_reset_at": 1728455472, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.mdx new file mode 100644 index 0000000000..881ed736e9 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Delete user from chat + Deletes user from chat + + + +`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserID | --user | String, Number | User ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + UserID = 10; + + Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454872.91198, + "finish": 1728454873.00982, + "duration": 0.0978438854217529, + "processing": 0.0658779144287109, + "date_start": "2024-10-09T09:21:12+03:00", + "date_finish": "2024-10-09T09:21:13+03:00", + "operating_reset_at": 1728455472, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md deleted file mode 100644 index bbc2264924..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Disable chat notifications - Disable chat notifications - - - -`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454893.38864, - "finish": 1728454893.44139, - "duration": 0.0527479648590088, - "processing": 0.0204250812530518, - "date_start": "2024-10-09T09:21:33+03:00", - "date_finish": "2024-10-09T09:21:33+03:00", - "operating_reset_at": 1728455493, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.mdx new file mode 100644 index 0000000000..dfd1a239bb --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Disable chat notifications + Disable chat notifications + + + +`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454893.38864, + "finish": 1728454893.44139, + "duration": 0.0527479648590088, + "processing": 0.0204250812530518, + "date_start": "2024-10-09T09:21:33+03:00", + "date_finish": "2024-10-09T09:21:33+03:00", + "operating_reset_at": 1728455493, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md deleted file mode 100644 index b4dffd3b7d..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Enable chat notifications - Enable chat notifications - - - -`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454893.58046, - "finish": 1728454893.62361, - "duration": 0.0431530475616455, - "processing": 0.0164411067962646, - "date_start": "2024-10-09T09:21:33+03:00", - "date_finish": "2024-10-09T09:21:33+03:00", - "operating_reset_at": 1728455493, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.mdx new file mode 100644 index 0000000000..c93951e4dc --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Enable chat notifications + Enable chat notifications + + + +`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454893.58046, + "finish": 1728454893.62361, + "duration": 0.0431530475616455, + "processing": 0.0164411067962646, + "date_start": "2024-10-09T09:21:33+03:00", + "date_finish": "2024-10-09T09:21:33+03:00", + "operating_reset_at": 1728455493, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md deleted file mode 100644 index 2397f9f660..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Get chat files folder - Get information about folder for chat files - - - -`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12610 - }, - "time": { - "start": 1728454911.13738, - "finish": 1728454911.19324, - "duration": 0.0558590888977051, - "processing": 0.0317718982696533, - "date_start": "2024-10-09T09:21:51+03:00", - "date_finish": "2024-10-09T09:21:51+03:00", - "operating_reset_at": 1728455511, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.mdx new file mode 100644 index 0000000000..9ca418ae6d --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 20 +--- + +# Get chat files folder + Get information about folder for chat files + + + +`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12610 + }, + "time": { + "start": 1728454911.13738, + "finish": 1728454911.19324, + "duration": 0.0558590888977051, + "processing": 0.0317718982696533, + "date_start": "2024-10-09T09:21:51+03:00", + "date_finish": "2024-10-09T09:21:51+03:00", + "operating_reset_at": 1728455511, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md deleted file mode 100644 index 496799dbb6..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -sidebar_position: 15 ---- - -# Get chat members list - Get chat members list - - - -`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat" + "1006"; - - Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T21:36:23+03:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1, - 264 - ], - "phones": false, - "bot_data": null - }, - { - "id": 1, - "active": true, - "name": "Антон Титовец", - "first_name": "Антон", - "last_name": "Титовец", - "work_position": null, - "color": "#df532d", - "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-09-17T21:21:49+03:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1, - 264 - ], - "phones": false, - "bot_data": null - } - ], - "total": 2, - "time": { - "start": 1728454904.75088, - "finish": 1728454904.78679, - "duration": 0.0359148979187012, - "processing": 0.00780296325683594, - "date_start": "2024-10-09T09:21:44+03:00", - "date_finish": "2024-10-09T09:21:44+03:00", - "operating_reset_at": 1728455504, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.mdx new file mode 100644 index 0000000000..91c24a87a8 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.mdx @@ -0,0 +1,120 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 15 +--- + +# Get chat members list + Get chat members list + + + +`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat" + "1006"; + + Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T21:36:23+03:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1, + 264 + ], + "phones": false, + "bot_data": null + }, + { + "id": 1, + "active": true, + "name": "Антон Титовец", + "first_name": "Антон", + "last_name": "Титовец", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-09-17T21:21:49+03:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1, + 264 + ], + "phones": false, + "bot_data": null + } + ], + "total": 2, + "time": { + "start": 1728454904.75088, + "finish": 1728454904.78679, + "duration": 0.0359148979187012, + "processing": 0.00780296325683594, + "date_start": "2024-10-09T09:21:44+03:00", + "date_finish": "2024-10-09T09:21:44+03:00", + "operating_reset_at": 1728455504, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md deleted file mode 100644 index be509e8696..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Get chat messages list - Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified - - - -`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | LastID | --last | String, Number | Id of last message | - | FirstID | --first | String, Number | ID of first message | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat4"; - - Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID, , 0, Token); -``` - - - - -```json title="Result" -{ - "result": { - "chat_id": 10, - "messages": [ - { - "id": 16, - "chat_id": 10, - "author_id": 0, - "date": "2024-06-15T19:48:49+03:00", - "text": "Я с вами в команде!", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "CODE": [ - "USER_JOIN" - ] - }, - "disappearing_date": null - }, - { - "id": 3808, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T17:45:29+03:00", - "text": "Сообщение для теста", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 3810, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T17:46:31+03:00", - "text": "Понял", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 3852, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T17:54:42+03:00", - "text": "Принял", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 3854, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T17:54:43+03:00", - "text": "Записал", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4286, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T19:06:51+03:00", - "text": "Текст сообщения", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4366, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T19:40:58+03:00", - "text": "Message text", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4406, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T22:57:33+03:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4446, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T23:21:27+03:00", - "text": "Текст сообщения", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4486, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T23:22:30+03:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4526, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T23:41:21+03:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4668, - "chat_id": 10, - "author_id": 1, -... -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.mdx new file mode 100644 index 0000000000..bf2ff43d64 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.mdx @@ -0,0 +1,202 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Get chat messages list + Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified + + + +`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | LastID | --last | String, Number | Id of last message | + | FirstID | --first | String, Number | ID of first message | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat4"; + + Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID, , 0, Token); +``` + + + + +```json title="Result" +{ + "result": { + "chat_id": 10, + "messages": [ + { + "id": 16, + "chat_id": 10, + "author_id": 0, + "date": "2024-06-15T19:48:49+03:00", + "text": "Я с вами в команде!", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "CODE": [ + "USER_JOIN" + ] + }, + "disappearing_date": null + }, + { + "id": 3808, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T17:45:29+03:00", + "text": "Сообщение для теста", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 3810, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T17:46:31+03:00", + "text": "Понял", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 3852, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T17:54:42+03:00", + "text": "Принял", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 3854, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T17:54:43+03:00", + "text": "Записал", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4286, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:06:51+03:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4366, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:40:58+03:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4406, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T22:57:33+03:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4446, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T23:21:27+03:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4486, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T23:22:30+03:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4526, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T23:41:21+03:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4668, + "chat_id": 10, + "author_id": 1, +... +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md deleted file mode 100644 index b448f24f57..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 21 ---- - -# Get chats structure - Get chat fields structure - - - -`Function GetChatStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Bitrix24.GetChatStructure(); -``` - - - - -```json title="Result" -{ - "TYPE": "", - "TITLE": "", - "DESCRIPTION": "", - "COLOR": "", - "MESSAGE": "", - "USERS": "", - "AVATAR": "", - "OWNER_ID": "" -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.mdx new file mode 100644 index 0000000000..e6692581c9 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 21 +--- + +# Get chats structure + Get chat fields structure + + + +`Function GetChatStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Bitrix24.GetChatStructure(); +``` + + + + +```json title="Result" +{ + "TYPE": "", + "TITLE": "", + "DESCRIPTION": "", + "COLOR": "", + "MESSAGE": "", + "USERS": "", + "AVATAR": "", + "OWNER_ID": "" +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md deleted file mode 100644 index 9543abb64b..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get chats users - Gets the list of chat users by ID - - - -`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Result = OPI_Bitrix24.GetChatUsers(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - 1, - 10 - ], - "time": { - "start": 1728454872.6475, - "finish": 1728454872.68151, - "duration": 0.0340070724487305, - "processing": 0.00371289253234863, - "date_start": "2024-10-09T09:21:12+03:00", - "date_finish": "2024-10-09T09:21:12+03:00", - "operating_reset_at": 1728455472, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.mdx new file mode 100644 index 0000000000..7ffbe48f19 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get chats users + Gets the list of chat users by ID + + + +`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Result = OPI_Bitrix24.GetChatUsers(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + 1, + 10 + ], + "time": { + "start": 1728454872.6475, + "finish": 1728454872.68151, + "duration": 0.0340070724487305, + "processing": 0.00371289253234863, + "date_start": "2024-10-09T09:21:12+03:00", + "date_finish": "2024-10-09T09:21:12+03:00", + "operating_reset_at": 1728455472, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md deleted file mode 100644 index faf0c8f93c..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Get dialog - Get chat data by ID - - - -`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat" + "1006"; - - Result = OPI_Bitrix24.GetDialog(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.GetDialog(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "id": 10, - "parent_chat_id": 0, - "parent_message_id": 0, - "name": "", - "description": "", - "owner": 10, - "extranet": false, - "avatar": "", - "color": "#ab7761", - "type": "private", - "counter": 4, - "user_counter": 0, - "message_count": 187, - "unread_id": 16, - "restrictions": { - "avatar": true, - "rename": true, - "extend": true, - "call": true, - "mute": true, - "leave": true, - "leave_owner": true, - "send": true, - "user_list": true - }, - "last_message_id": 17682, - "last_id": 0, - "marked_id": 0, - "disk_folder_id": 0, - "entity_type": "", - "entity_id": "", - "entity_data_1": "", - "entity_data_2": "", - "entity_data_3": "", - "mute_list": [], - "date_create": "2024-06-15T19:48:49+03:00", - "message_type": "P", - "disappearing_time": 0, - "public": "", - "role": "member", - "entity_link": { - "type": "", - "url": "" - }, - "permissions": { - "manage_users_add": "member", - "manage_users_delete": "manager", - "manage_ui": "member", - "manage_settings": "owner", - "manage_messages": "member", - "can_post": "member" - }, - "is_new": false, - "readed_list": [ - { - "user_id": 10, - "user_name": "Techno Pizza", - "message_id": 3854, - "date": null - } - ], - "manager_list": [], - "last_message_views": { - "message_id": 17682, - "first_viewers": [], - "count_of_viewers": 0 - }, - "dialog_id": "10" - }, - "time": { - "start": 1728454899.5196, - "finish": 1728454899.56299, - "duration": 0.0433859825134277, - "processing": 0.0178430080413818, - "date_start": "2024-10-09T09:21:39+03:00", - "date_finish": "2024-10-09T09:21:39+03:00", - "operating_reset_at": 1728455499, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx new file mode 100644 index 0000000000..cf1933a465 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx @@ -0,0 +1,131 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Get dialog + Get chat data by ID + + + +`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat" + "1006"; + + Result = OPI_Bitrix24.GetDialog(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.GetDialog(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "id": 10, + "parent_chat_id": 0, + "parent_message_id": 0, + "name": "", + "description": "", + "owner": 10, + "extranet": false, + "avatar": "", + "color": "#ab7761", + "type": "private", + "counter": 4, + "user_counter": 0, + "message_count": 187, + "unread_id": 16, + "restrictions": { + "avatar": true, + "rename": true, + "extend": true, + "call": true, + "mute": true, + "leave": true, + "leave_owner": true, + "send": true, + "user_list": true + }, + "last_message_id": 17682, + "last_id": 0, + "marked_id": 0, + "disk_folder_id": 0, + "entity_type": "", + "entity_id": "", + "entity_data_1": "", + "entity_data_2": "", + "entity_data_3": "", + "mute_list": [], + "date_create": "2024-06-15T19:48:49+03:00", + "message_type": "P", + "disappearing_time": 0, + "public": "", + "role": "member", + "entity_link": { + "type": "", + "url": "" + }, + "permissions": { + "manage_users_add": "member", + "manage_users_delete": "manager", + "manage_ui": "member", + "manage_settings": "owner", + "manage_messages": "member", + "can_post": "member" + }, + "is_new": false, + "readed_list": [ + { + "user_id": 10, + "user_name": "Techno Pizza", + "message_id": 3854, + "date": null + } + ], + "manager_list": [], + "last_message_views": { + "message_id": 17682, + "first_viewers": [], + "count_of_viewers": 0 + }, + "dialog_id": "10" + }, + "time": { + "start": 1728454899.5196, + "finish": 1728454899.56299, + "duration": 0.0433859825134277, + "processing": 0.0178430080413818, + "date_start": "2024-10-09T09:21:39+03:00", + "date_finish": "2024-10-09T09:21:39+03:00", + "operating_reset_at": 1728455499, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md deleted file mode 100644 index b164a375e5..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 17 ---- - -# Get user status - Gets the status (online) of the current user - - - -`Function GetUserStatus(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetUserStatus(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetUserStatus(URL, Token); -``` - - - - -```json title="Result" -{ - "result": "away", - "time": { - "start": 1728454841.43872, - "finish": 1728454841.46354, - "duration": 0.0248241424560547, - "processing": 0.000161886215209961, - "date_start": "2024-10-09T09:20:41+03:00", - "date_finish": "2024-10-09T09:20:41+03:00", - "operating_reset_at": 1728455441, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.mdx new file mode 100644 index 0000000000..bdc992eede --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 17 +--- + +# Get user status + Gets the status (online) of the current user + + + +`Function GetUserStatus(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetUserStatus(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetUserStatus(URL, Token); +``` + + + + +```json title="Result" +{ + "result": "away", + "time": { + "start": 1728454841.43872, + "finish": 1728454841.46354, + "duration": 0.0248241424560547, + "processing": 0.000161886215209961, + "date_start": "2024-10-09T09:20:41+03:00", + "date_finish": "2024-10-09T09:20:41+03:00", + "operating_reset_at": 1728455441, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md deleted file mode 100644 index 057a957e16..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get users - Get users information for dialog - - - -`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ArrayOfUsers = New Array; - - ArrayOfUsers.Add(1); - ArrayOfUsers.Add(10); - - Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserIDs = 10; - - Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token); -``` - - - - -```json title="Result" -{ - "result": { - "10": { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T21:36:23+03:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1, - 264 - ], - "phones": false - } - }, - "time": { - "start": 1728454841.79577, - "finish": 1728454841.82182, - "duration": 0.0260539054870605, - "processing": 0.00196313858032227, - "date_start": "2024-10-09T09:20:41+03:00", - "date_finish": "2024-10-09T09:20:41+03:00", - "operating_reset_at": 1728455441, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.mdx new file mode 100644 index 0000000000..f13ddab741 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.mdx @@ -0,0 +1,93 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get users + Get users information for dialog + + + +`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ArrayOfUsers = New Array; + + ArrayOfUsers.Add(1); + ArrayOfUsers.Add(10); + + Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserIDs = 10; + + Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token); +``` + + + + +```json title="Result" +{ + "result": { + "10": { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T21:36:23+03:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1, + 264 + ], + "phones": false + } + }, + "time": { + "start": 1728454841.79577, + "finish": 1728454841.82182, + "duration": 0.0260539054870605, + "processing": 0.00196313858032227, + "date_start": "2024-10-09T09:20:41+03:00", + "date_finish": "2024-10-09T09:20:41+03:00", + "operating_reset_at": 1728455441, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md deleted file mode 100644 index ecef26e385..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Leave chat - Removes the current user from the chat room - - - -`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - - Result = OPI_Bitrix24.LeaveChat(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454919.09087, - "finish": 1728454919.16456, - "duration": 0.0736868381500244, - "processing": 0.0471811294555664, - "date_start": "2024-10-09T09:21:59+03:00", - "date_finish": "2024-10-09T09:21:59+03:00", - "operating_reset_at": 1728455519, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.mdx new file mode 100644 index 0000000000..dfd3c4485d --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Leave chat + Removes the current user from the chat room + + + +`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + + Result = OPI_Bitrix24.LeaveChat(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454919.09087, + "finish": 1728454919.16456, + "duration": 0.0736868381500244, + "processing": 0.0471811294555664, + "date_start": "2024-10-09T09:21:59+03:00", + "date_finish": "2024-10-09T09:21:59+03:00", + "operating_reset_at": 1728455519, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md deleted file mode 100644 index a060f6c6be..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 19 ---- - -# Read all - Mark all message as readed - - - -`Function ReadAll(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.ReadAll(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.ReadAll(URL, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454918.70314, - "finish": 1728454918.75025, - "duration": 0.0471072196960449, - "processing": 0.0178661346435547, - "date_start": "2024-10-09T09:21:58+03:00", - "date_finish": "2024-10-09T09:21:58+03:00", - "operating_reset_at": 1728455518, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.mdx new file mode 100644 index 0000000000..6ed201489d --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 19 +--- + +# Read all + Mark all message as readed + + + +`Function ReadAll(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.ReadAll(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.ReadAll(URL, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454918.70314, + "finish": 1728454918.75025, + "duration": 0.0471072196960449, + "processing": 0.0178661346435547, + "date_start": "2024-10-09T09:21:58+03:00", + "date_finish": "2024-10-09T09:21:58+03:00", + "operating_reset_at": 1728455518, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md deleted file mode 100644 index 9e20e11d44..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 16 ---- - -# Send write notification - Send Writing... status to dialog... - - - -`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat" + "1006"; - - Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454904.9218, - "finish": 1728454904.95162, - "duration": 0.0298209190368652, - "processing": 0.00108098983764648, - "date_start": "2024-10-09T09:21:44+03:00", - "date_finish": "2024-10-09T09:21:44+03:00", - "operating_reset_at": 1728455504, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.mdx new file mode 100644 index 0000000000..a9951f6ff0 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 16 +--- + +# Send write notification + Send Writing... status to dialog... + + + +`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat" + "1006"; + + Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454904.9218, + "finish": 1728454904.95162, + "duration": 0.0298209190368652, + "processing": 0.00108098983764648, + "date_start": "2024-10-09T09:21:44+03:00", + "date_finish": "2024-10-09T09:21:44+03:00", + "operating_reset_at": 1728455504, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md deleted file mode 100644 index 88f63fddfe..0000000000 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 18 ---- - -# Set user status - Sets the status (online) of the current user - - - -`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Status | --status | String, Number | Status value: online, dnd, away | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Status = "dnd"; - - Result = OPI_Bitrix24.SetUserStatus(URL, Status); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - Status = "away"; - - Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454841.60883, - "finish": 1728454841.64357, - "duration": 0.0347371101379394, - "processing": 0.00739097595214844, - "date_start": "2024-10-09T09:20:41+03:00", - "date_finish": "2024-10-09T09:20:41+03:00", - "operating_reset_at": 1728455441, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.mdx b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.mdx new file mode 100644 index 0000000000..e8c27b837d --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 18 +--- + +# Set user status + Sets the status (online) of the current user + + + +`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Status | --status | String, Number | Status value: online, dnd, away | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Status = "dnd"; + + Result = OPI_Bitrix24.SetUserStatus(URL, Status); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + Status = "away"; + + Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454841.60883, + "finish": 1728454841.64357, + "duration": 0.0347371101379394, + "processing": 0.00739097595214844, + "date_start": "2024-10-09T09:20:41+03:00", + "date_finish": "2024-10-09T09:20:41+03:00", + "operating_reset_at": 1728455441, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md deleted file mode 100644 index 028ea751dd..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Add comment to task - Create new comment to the task - - - -`Function AddTaskComment(Val URL, Val TaskID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Text | --text | String | Comment text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2450"; - - Text = "Task impossible, let's split up"; - - Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Text = "Task uninpossible, don't split up"; - - Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text, Token); -``` - - - - -```json title="Result" -{ - "result": 5946, - "time": { - "start": 1728454794.0873, - "finish": 1728454794.25203, - "duration": 0.164731025695801, - "processing": 0.141225099563599, - "date_start": "2024-10-09T09:19:54+03:00", - "date_finish": "2024-10-09T09:19:54+03:00", - "operating_reset_at": 1728455394, - "operating": 0.141186952590942 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.mdx new file mode 100644 index 0000000000..98d041ae2c --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Add comment to task + Create new comment to the task + + + +`Function AddTaskComment(Val URL, Val TaskID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Text | --text | String | Comment text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2450"; + + Text = "Task impossible, let's split up"; + + Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Text = "Task uninpossible, don't split up"; + + Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text, Token); +``` + + + + +```json title="Result" +{ + "result": 5946, + "time": { + "start": 1728454794.0873, + "finish": 1728454794.25203, + "duration": 0.164731025695801, + "processing": 0.141225099563599, + "date_start": "2024-10-09T09:19:54+03:00", + "date_finish": "2024-10-09T09:19:54+03:00", + "operating_reset_at": 1728455394, + "operating": 0.141186952590942 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md deleted file mode 100644 index bedd0841bf..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Create result from comment - Create task result from comment - - - -`Function CreateResultFromComment(Val URL, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | CommentID | --comment | Number, String | CommentID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - CommentID = "6054"; - - Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - CommentID = "6056"; - - Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "id": 870, - "taskId": 2400, - "commentId": 5946, - "createdBy": 1, - "createdAt": "2024-10-09T09:19:54+03:00", - "updatedAt": "2024-10-09T09:19:54+03:00", - "status": 0, - "text": "The task has been changed, let's split up", - "formattedText": "The task has been changed, let's split up", - "files": null - }, - "time": { - "start": 1728454794.79609, - "finish": 1728454794.85645, - "duration": 0.0603640079498291, - "processing": 0.0350399017333984, - "date_start": "2024-10-09T09:19:54+03:00", - "date_finish": "2024-10-09T09:19:54+03:00", - "operating_reset_at": 1728455394, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.mdx new file mode 100644 index 0000000000..399056a529 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Create result from comment + Create task result from comment + + + +`Function CreateResultFromComment(Val URL, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | CommentID | --comment | Number, String | CommentID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + CommentID = "6054"; + + Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + CommentID = "6056"; + + Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "id": 870, + "taskId": 2400, + "commentId": 5946, + "createdBy": 1, + "createdAt": "2024-10-09T09:19:54+03:00", + "updatedAt": "2024-10-09T09:19:54+03:00", + "status": 0, + "text": "The task has been changed, let's split up", + "formattedText": "The task has been changed, let's split up", + "files": null + }, + "time": { + "start": 1728454794.79609, + "finish": 1728454794.85645, + "duration": 0.0603640079498291, + "processing": 0.0350399017333984, + "date_start": "2024-10-09T09:19:54+03:00", + "date_finish": "2024-10-09T09:19:54+03:00", + "operating_reset_at": 1728455394, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md deleted file mode 100644 index 4069537896..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Delete result from comment - Deletes task result, created from a comment - - - -`Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | CommentID | --comment | Number, String | CommentID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - CommentID = "6054"; - - Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - CommentID = "6056"; - - Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token); -``` - - - - -```json title="Result" -{ - "result": null, - "time": { - "start": 1728454795.33004, - "finish": 1728454795.38756, - "duration": 0.0575249195098877, - "processing": 0.0249888896942139, - "date_start": "2024-10-09T09:19:55+03:00", - "date_finish": "2024-10-09T09:19:55+03:00", - "operating_reset_at": 1728455395, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.mdx new file mode 100644 index 0000000000..fdb704ed30 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Delete result from comment + Deletes task result, created from a comment + + + +`Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | CommentID | --comment | Number, String | CommentID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + CommentID = "6054"; + + Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + CommentID = "6056"; + + Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token); +``` + + + + +```json title="Result" +{ + "result": null, + "time": { + "start": 1728454795.33004, + "finish": 1728454795.38756, + "duration": 0.0575249195098877, + "processing": 0.0249888896942139, + "date_start": "2024-10-09T09:19:55+03:00", + "date_finish": "2024-10-09T09:19:55+03:00", + "operating_reset_at": 1728455395, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md deleted file mode 100644 index dce257d7be..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete comment - Delete task comment by ID - - - -`Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | CommentID | --comment | Number, String | ID of comment to remove | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2450"; - CommentID = "6054"; - - Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - CommentID = "6056"; - - Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454796.03849, - "finish": 1728454796.17589, - "duration": 0.137403964996338, - "processing": 0.113073110580444, - "date_start": "2024-10-09T09:19:56+03:00", - "date_finish": "2024-10-09T09:19:56+03:00", - "operating_reset_at": 1728455396, - "operating": 0.113054990768433 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.mdx new file mode 100644 index 0000000000..bd8c79ed50 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete comment + Delete task comment by ID + + + +`Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | CommentID | --comment | Number, String | ID of comment to remove | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2450"; + CommentID = "6054"; + + Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + CommentID = "6056"; + + Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454796.03849, + "finish": 1728454796.17589, + "duration": 0.137403964996338, + "processing": 0.113073110580444, + "date_start": "2024-10-09T09:19:56+03:00", + "date_finish": "2024-10-09T09:19:56+03:00", + "operating_reset_at": 1728455396, + "operating": 0.113054990768433 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md deleted file mode 100644 index 65da3ce97c..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Get comment structure - Get comment fields structure - - - -`Function GetCommentStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Bitrix24.GetCommentStructure(); -``` - - - - -```json title="Result" -{ - "AUTHOR_ID": "", - "AUTHOR_NAME": "", - "AUTHOR_EMAIL": "", - "USE_SMILES": "<(Y|N) - parse comments for emoticons or not>", - "POST_MESSAGE": "", - "UF_FORUM_MESSAGE_DOC": "" -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.mdx new file mode 100644 index 0000000000..67103b0cac --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Get comment structure + Get comment fields structure + + + +`Function GetCommentStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Bitrix24.GetCommentStructure(); +``` + + + + +```json title="Result" +{ + "AUTHOR_ID": "", + "AUTHOR_NAME": "", + "AUTHOR_EMAIL": "", + "USE_SMILES": "<(Y|N) - parse comments for emoticons or not>", + "POST_MESSAGE": "", + "UF_FORUM_MESSAGE_DOC": "" +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md deleted file mode 100644 index 37c885b27d..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get results list - Gets results list for task - - - -`Function GetResultsList(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2450"; - - Result = OPI_Bitrix24.GetResultsList(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetResultsList(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "id": 870, - "taskId": 2400, - "commentId": 5946, - "createdBy": 1, - "createdAt": "2024-10-09T09:19:54+03:00", - "updatedAt": "2024-10-09T09:19:54+03:00", - "status": 0, - "text": "The task has been changed, let's split up", - "formattedText": "The task has been changed, let's split up", - "files": [] - }, - { - "id": 868, - "taskId": 2400, - "commentId": 5944, - "createdBy": 1, - "createdAt": "2024-10-09T09:19:53+03:00", - "updatedAt": "2024-10-09T09:19:53+03:00", - "status": 0, - "text": "The task has been changed, do not split up", - "formattedText": "The task has been changed, do not split up", - "files": [] - } - ], - "time": { - "start": 1728454795.04247, - "finish": 1728454795.07889, - "duration": 0.0364160537719727, - "processing": 0.00944018363952637, - "date_start": "2024-10-09T09:19:55+03:00", - "date_finish": "2024-10-09T09:19:55+03:00", - "operating_reset_at": 1728455395, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.mdx new file mode 100644 index 0000000000..a28a5b175b --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get results list + Gets results list for task + + + +`Function GetResultsList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2450"; + + Result = OPI_Bitrix24.GetResultsList(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetResultsList(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "id": 870, + "taskId": 2400, + "commentId": 5946, + "createdBy": 1, + "createdAt": "2024-10-09T09:19:54+03:00", + "updatedAt": "2024-10-09T09:19:54+03:00", + "status": 0, + "text": "The task has been changed, let's split up", + "formattedText": "The task has been changed, let's split up", + "files": [] + }, + { + "id": 868, + "taskId": 2400, + "commentId": 5944, + "createdBy": 1, + "createdAt": "2024-10-09T09:19:53+03:00", + "updatedAt": "2024-10-09T09:19:53+03:00", + "status": 0, + "text": "The task has been changed, do not split up", + "formattedText": "The task has been changed, do not split up", + "files": [] + } + ], + "time": { + "start": 1728454795.04247, + "finish": 1728454795.07889, + "duration": 0.0364160537719727, + "processing": 0.00944018363952637, + "date_start": "2024-10-09T09:19:55+03:00", + "date_finish": "2024-10-09T09:19:55+03:00", + "operating_reset_at": 1728455395, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md deleted file mode 100644 index 98c0d8a268..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get task comment - Gets task comment data by ID - - - -`Function GetTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | CommentID | --comment | Number, String | CommentID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - CommentID = "6054"; - TaskID = "2450"; - - Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - CommentID = "6056"; - - Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "POST_MESSAGE_HTML": null, - "ID": "5946", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-10-09T09:19:54+03:00", - "POST_MESSAGE": "The task has been changed, let's split up" - }, - "time": { - "start": 1728454795.75017, - "finish": 1728454795.79802, - "duration": 0.0478498935699463, - "processing": 0.02128005027771, - "date_start": "2024-10-09T09:19:55+03:00", - "date_finish": "2024-10-09T09:19:55+03:00", - "operating_reset_at": 1728455395, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.mdx new file mode 100644 index 0000000000..6381525b6a --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get task comment + Gets task comment data by ID + + + +`Function GetTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | CommentID | --comment | Number, String | CommentID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + CommentID = "6054"; + TaskID = "2450"; + + Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + CommentID = "6056"; + + Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "POST_MESSAGE_HTML": null, + "ID": "5946", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-10-09T09:19:54+03:00", + "POST_MESSAGE": "The task has been changed, let's split up" + }, + "time": { + "start": 1728454795.75017, + "finish": 1728454795.79802, + "duration": 0.0478498935699463, + "processing": 0.02128005027771, + "date_start": "2024-10-09T09:19:55+03:00", + "date_finish": "2024-10-09T09:19:55+03:00", + "operating_reset_at": 1728455395, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md deleted file mode 100644 index 8a51e99511..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get comments list for a task - Get user comments list for a task - - - -`Function GetTaskCommentsList(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2450"; - - Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "POST_MESSAGE_HTML": null, - "ID": "5944", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-10-09T09:19:53+03:00", - "POST_MESSAGE": "The task has been changed, do not split up" - }, - { - "POST_MESSAGE_HTML": null, - "ID": "5946", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-10-09T09:19:54+03:00", - "POST_MESSAGE": "The task has been changed, let's split up" - } - ], - "time": { - "start": 1728454795.54926, - "finish": 1728454795.59482, - "duration": 0.0455570220947266, - "processing": 0.0219829082489014, - "date_start": "2024-10-09T09:19:55+03:00", - "date_finish": "2024-10-09T09:19:55+03:00", - "operating_reset_at": 1728455395, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.mdx new file mode 100644 index 0000000000..4868b2cd76 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get comments list for a task + Get user comments list for a task + + + +`Function GetTaskCommentsList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2450"; + + Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "POST_MESSAGE_HTML": null, + "ID": "5944", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-10-09T09:19:53+03:00", + "POST_MESSAGE": "The task has been changed, do not split up" + }, + { + "POST_MESSAGE_HTML": null, + "ID": "5946", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-10-09T09:19:54+03:00", + "POST_MESSAGE": "The task has been changed, let's split up" + } + ], + "time": { + "start": 1728454795.54926, + "finish": 1728454795.59482, + "duration": 0.0455570220947266, + "processing": 0.0219829082489014, + "date_start": "2024-10-09T09:19:55+03:00", + "date_finish": "2024-10-09T09:19:55+03:00", + "operating_reset_at": 1728455395, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md deleted file mode 100644 index 815d392bf7..0000000000 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Update task comment - Changes task comment text - - - -`Function UpdateTaskComment(Val URL, Val TaskID, Val CommentID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | CommentID | --comment | Number, String | CommentID | - | Text | --text | String | Comment text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2450"; - CommentID = "6054"; - - Text = "The task has been changed, do not split up"; - - Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - CommentID = "6056"; - - Text = "The task has been changed, let's split up"; - - Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454794.49079, - "finish": 1728454794.59796, - "duration": 0.107167959213257, - "processing": 0.0828990936279297, - "date_start": "2024-10-09T09:19:54+03:00", - "date_finish": "2024-10-09T09:19:54+03:00", - "operating_reset_at": 1728455394, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.mdx b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.mdx new file mode 100644 index 0000000000..93cb815110 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Update task comment + Changes task comment text + + + +`Function UpdateTaskComment(Val URL, Val TaskID, Val CommentID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | CommentID | --comment | Number, String | CommentID | + | Text | --text | String | Comment text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2450"; + CommentID = "6054"; + + Text = "The task has been changed, do not split up"; + + Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + CommentID = "6056"; + + Text = "The task has been changed, let's split up"; + + Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454794.49079, + "finish": 1728454794.59796, + "duration": 0.107167959213257, + "processing": 0.0828990936279297, + "date_start": "2024-10-09T09:19:54+03:00", + "date_finish": "2024-10-09T09:19:54+03:00", + "operating_reset_at": 1728455394, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md deleted file mode 100644 index 5d2108289d..0000000000 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Add custom task field - Adds a new custom field to be added to the task - - - -`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Type | --type | String | Field type: string, double, date, boolean | - | Name | --fieldname | String | Text identifier (name) of the field | - | ExternalID | --externalid | String | Text identifier for external integration | - | Title | --title | String | Field title | - | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Type = "date"; - Name = "BIRTHDAY_FIELD"; - - Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Type = "string"; - Name = "TEXT_FIELD"; - ExternalID = "BITRIX_TEXT_FIELD"; - Title = "Text field"; - Signature = New Structure("en,ru", "Some field", "Nekotoroe pole"); - - Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token); -``` - - - - -```json title="Result" -{ - "result": 261, - "time": { - "start": 1722114794.52732, - "finish": 1722114794.59725, - "duration": 0.0699310302734375, - "processing": 0.0470340251922607, - "date_start": "2024-07-27T21:13:14+00:00", - "date_finish": "2024-07-27T21:13:14+00:00", - "operating_reset_at": 1722115394, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.mdx b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.mdx new file mode 100644 index 0000000000..5334057a99 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Add custom task field + Adds a new custom field to be added to the task + + + +`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Type | --type | String | Field type: string, double, date, boolean | + | Name | --fieldname | String | Text identifier (name) of the field | + | ExternalID | --externalid | String | Text identifier for external integration | + | Title | --title | String | Field title | + | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Type = "date"; + Name = "BIRTHDAY_FIELD"; + + Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Type = "string"; + Name = "TEXT_FIELD"; + ExternalID = "BITRIX_TEXT_FIELD"; + Title = "Text field"; + Signature = New Structure("en,ru", "Some field", "Nekotoroe pole"); + + Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token); +``` + + + + +```json title="Result" +{ + "result": 261, + "time": { + "start": 1722114794.52732, + "finish": 1722114794.59725, + "duration": 0.0699310302734375, + "processing": 0.0470340251922607, + "date_start": "2024-07-27T21:13:14+00:00", + "date_finish": "2024-07-27T21:13:14+00:00", + "operating_reset_at": 1722115394, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md deleted file mode 100644 index d683abc3f7..0000000000 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete custom task field - Deletes a custom task field - - - -`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldID | --fieldid | String, Number | Field ID for deletion | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FieldID = "255"; - - Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - FieldID = "257"; - - Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722114801.22925, - "finish": 1722114801.26696, - "duration": 0.0377130508422852, - "processing": 0.0185980796813965, - "date_start": "2024-07-27T21:13:21+00:00", - "date_finish": "2024-07-27T21:13:21+00:00", - "operating_reset_at": 1722115401, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.mdx b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.mdx new file mode 100644 index 0000000000..b4267e9f27 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete custom task field + Deletes a custom task field + + + +`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldID | --fieldid | String, Number | Field ID for deletion | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FieldID = "255"; + + Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + FieldID = "257"; + + Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722114801.22925, + "finish": 1722114801.26696, + "duration": 0.0377130508422852, + "processing": 0.0185980796813965, + "date_start": "2024-07-27T21:13:21+00:00", + "date_finish": "2024-07-27T21:13:21+00:00", + "operating_reset_at": 1722115401, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md deleted file mode 100644 index a0710db0ee..0000000000 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Gets a custom task field - Get custom task field data - - - -`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldID | --fieldid | String, Number | Field ID for retrieval | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FieldID = "255"; - - Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - FieldID = "257"; - - Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - }, - "EDIT_FORM_LABEL": { - "ar": "", - "br": "", - "de": "", - "en": "Updated field", - "fr": "", - "id": "", - "it": "", - "ja": "", - "la": "", - "ms": "", - "pl": "", - "ru": "Izmenennoe pole", - "sc": "", - "tc": "", - "th": "", - "tr": "", - "ua": "", - "vn": "" - }, - "LIST_COLUMN_LABEL": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - }, - "LIST_FILTER_LABEL": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - }, - "ERROR_MESSAGE": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - }, - "HELP_MESSAGE": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - } - }, - "total": 0, - "time": { - "start": 1722114797.9059, - "finish": 1722114797.92375, - "duration": 0.0178542137145996, - "processing": 0.000695943832397461, - "date_start": "2024-07-27T21:13:17+00:00", - "date_finish": "2024-07-27T21:13:17+00:00", - "operating_reset_at": 1722115397, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.mdx b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.mdx new file mode 100644 index 0000000000..94272a8363 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.mdx @@ -0,0 +1,184 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Gets a custom task field + Get custom task field data + + + +`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldID | --fieldid | String, Number | Field ID for retrieval | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FieldID = "255"; + + Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + FieldID = "257"; + + Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + }, + "EDIT_FORM_LABEL": { + "ar": "", + "br": "", + "de": "", + "en": "Updated field", + "fr": "", + "id": "", + "it": "", + "ja": "", + "la": "", + "ms": "", + "pl": "", + "ru": "Izmenennoe pole", + "sc": "", + "tc": "", + "th": "", + "tr": "", + "ua": "", + "vn": "" + }, + "LIST_COLUMN_LABEL": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + }, + "LIST_FILTER_LABEL": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + }, + "ERROR_MESSAGE": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + }, + "HELP_MESSAGE": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + } + }, + "total": 0, + "time": { + "start": 1722114797.9059, + "finish": 1722114797.92375, + "duration": 0.0178542137145996, + "processing": 0.000695943832397461, + "date_start": "2024-07-27T21:13:17+00:00", + "date_finish": "2024-07-27T21:13:17+00:00", + "operating_reset_at": 1722115397, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md deleted file mode 100644 index 21037e7cbf..0000000000 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of custom task fields - Gets list of custom task fields - - - -`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "11", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_CRM_TASK", - "USER_TYPE_ID": "crm", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "LEAD": "Y", - "CONTACT": "Y", - "COMPANY": "Y", - "DEAL": "Y", - "ORDER": "Y", - "SMART_INVOICE": "Y" - } - }, - { - "ID": "101", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TASK_WEBDAV_FILES", - "USER_TYPE_ID": "disk_file", - "XML_ID": "TASK_WEBDAV_FILES", - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": [] - }, - { - "ID": "117", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_MAIL_MESSAGE", - "USER_TYPE_ID": "mail_message", - "XML_ID": "", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "N", - "IS_SEARCHABLE": "N", - "SETTINGS": [] - }, - { - "ID": "259", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_BIRTHDAY_FIELD", - "USER_TYPE_ID": "date", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "DEFAULT_VALUE": { - "TYPE": "NONE", - "VALUE": "" - } - } - }, - { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - } - } - ], - "total": 0, - "time": { - "start": 1722114799.57, - "finish": 1722114799.58769, - "duration": 0.0176839828491211, - "processing": 0.000379085540771484, - "date_start": "2024-07-27T21:13:19+00:00", - "date_finish": "2024-07-27T21:13:19+00:00", - "operating_reset_at": 1722115399, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.mdx b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.mdx new file mode 100644 index 0000000000..65c6a1c96a --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.mdx @@ -0,0 +1,155 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of custom task fields + Gets list of custom task fields + + + +`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "11", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_CRM_TASK", + "USER_TYPE_ID": "crm", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "LEAD": "Y", + "CONTACT": "Y", + "COMPANY": "Y", + "DEAL": "Y", + "ORDER": "Y", + "SMART_INVOICE": "Y" + } + }, + { + "ID": "101", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TASK_WEBDAV_FILES", + "USER_TYPE_ID": "disk_file", + "XML_ID": "TASK_WEBDAV_FILES", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [] + }, + { + "ID": "117", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_MAIL_MESSAGE", + "USER_TYPE_ID": "mail_message", + "XML_ID": "", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "N", + "IS_SEARCHABLE": "N", + "SETTINGS": [] + }, + { + "ID": "259", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_BIRTHDAY_FIELD", + "USER_TYPE_ID": "date", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "DEFAULT_VALUE": { + "TYPE": "NONE", + "VALUE": "" + } + } + }, + { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + } + } + ], + "total": 0, + "time": { + "start": 1722114799.57, + "finish": 1722114799.58769, + "duration": 0.0176839828491211, + "processing": 0.000379085540771484, + "date_start": "2024-07-27T21:13:19+00:00", + "date_finish": "2024-07-27T21:13:19+00:00", + "operating_reset_at": 1722115399, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md deleted file mode 100644 index 750a339469..0000000000 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Update custom task field - Updates a custom task field data - - - -`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldID | --fieldid | String, Number | Field ID for updating | - | ExternalID | --externalid | String | Text identifier for external integration | - | Title | --title | String | Field title | - | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - FieldID = "255"; - Title = "New title"; - - Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, , Title); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - FieldID = "257"; - ExternalID = "NEW_TEXT_FIELD"; - Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole"); - - Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID, , Signature, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722114796.23423, - "finish": 1722114796.26623, - "duration": 0.0319931507110596, - "processing": 0.0126721858978271, - "date_start": "2024-07-27T21:13:16+00:00", - "date_finish": "2024-07-27T21:13:16+00:00", - "operating_reset_at": 1722115396, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.mdx b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.mdx new file mode 100644 index 0000000000..183d7728c9 --- /dev/null +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Update custom task field + Updates a custom task field data + + + +`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldID | --fieldid | String, Number | Field ID for updating | + | ExternalID | --externalid | String | Text identifier for external integration | + | Title | --title | String | Field title | + | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + FieldID = "255"; + Title = "New title"; + + Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, , Title); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + FieldID = "257"; + ExternalID = "NEW_TEXT_FIELD"; + Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole"); + + Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID, , Signature, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722114796.23423, + "finish": 1722114796.26623, + "duration": 0.0319931507110596, + "processing": 0.0126721858978271, + "date_start": "2024-07-27T21:13:16+00:00", + "date_finish": "2024-07-27T21:13:16+00:00", + "operating_reset_at": 1722115396, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Create-deal.md b/docs/en/md/Bitrix24/Deals-managment/Create-deal.md deleted file mode 100644 index 17c4d39c05..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Create-deal.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create deal - Creates a new deal by field structure (see. GetDealStructure) - - - -`Function CreateDeal(Val URL, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldsStructure | --fields | Structure of KeyAndValue | Deal fields structure (see. GetDealStructure) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.deal.add](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_add.php) -::: -
- - -```bsl title="Code example" - FieldsStructure = New Structure; - FieldsStructure.Insert("TITLE" , "Planned sale"); - FieldsStructure.Insert("TYPE_ID" , "GOODS"); - FieldsStructure.Insert("STAGE_ID" , "NEW"); - FieldsStructure.Insert("COMPANY_ID" , 1); - FieldsStructure.Insert("CONTACT_ID" , 3); - FieldsStructure.Insert("OPENED" , "Y"); - FieldsStructure.Insert("ASSIGNED_BY_ID", 1); - FieldsStructure.Insert("PROBABILITY" , 30); - FieldsStructure.Insert("CURRENCY_ID" , "USD"); - FieldsStructure.Insert("OPPORTUNITY" , 5000); - FieldsStructure.Insert("CATEGORY_ID" , 5); - FieldsStructure.Insert("BEGINDATE" , "2024-01-01"); - FieldsStructure.Insert("CLOSEDATE" , "2030-01-01"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateDeal(URL, FieldsStructure); - - FieldsStructure.Insert("TITLE" , "Another deal"); - FieldsStructure.Insert("CLOSEDATE", "2031-01-01"); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateDeal(URL, FieldsStructure, Token); -``` - - - - -```json title="Result" -{ - "result": 774, - "time": { - "start": 1728454946.42456, - "finish": 1728454946.95557, - "duration": 0.531003952026367, - "processing": 0.498440027236938, - "date_start": "2024-10-09T09:22:26+03:00", - "date_finish": "2024-10-09T09:22:26+03:00", - "operating_reset_at": 1728455546, - "operating": 0.498416900634766 - } -} -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Create-deal.mdx b/docs/en/md/Bitrix24/Deals-managment/Create-deal.mdx new file mode 100644 index 0000000000..917ce0921f --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Create-deal.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create deal + Creates a new deal by field structure (see. GetDealStructure) + + + +`Function CreateDeal(Val URL, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldsStructure | --fields | Structure of KeyAndValue | Deal fields structure (see. GetDealStructure) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.deal.add](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_add.php) +::: +
+ + +```bsl title="Code example" + FieldsStructure = New Structure; + FieldsStructure.Insert("TITLE" , "Planned sale"); + FieldsStructure.Insert("TYPE_ID" , "GOODS"); + FieldsStructure.Insert("STAGE_ID" , "NEW"); + FieldsStructure.Insert("COMPANY_ID" , 1); + FieldsStructure.Insert("CONTACT_ID" , 3); + FieldsStructure.Insert("OPENED" , "Y"); + FieldsStructure.Insert("ASSIGNED_BY_ID", 1); + FieldsStructure.Insert("PROBABILITY" , 30); + FieldsStructure.Insert("CURRENCY_ID" , "USD"); + FieldsStructure.Insert("OPPORTUNITY" , 5000); + FieldsStructure.Insert("CATEGORY_ID" , 5); + FieldsStructure.Insert("BEGINDATE" , "2024-01-01"); + FieldsStructure.Insert("CLOSEDATE" , "2030-01-01"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateDeal(URL, FieldsStructure); + + FieldsStructure.Insert("TITLE" , "Another deal"); + FieldsStructure.Insert("CLOSEDATE", "2031-01-01"); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateDeal(URL, FieldsStructure, Token); +``` + + + + +```json title="Result" +{ + "result": 774, + "time": { + "start": 1728454946.42456, + "finish": 1728454946.95557, + "duration": 0.531003952026367, + "processing": 0.498440027236938, + "date_start": "2024-10-09T09:22:26+03:00", + "date_finish": "2024-10-09T09:22:26+03:00", + "operating_reset_at": 1728455546, + "operating": 0.498416900634766 + } +} +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Delete-deal.md b/docs/en/md/Bitrix24/Deals-managment/Delete-deal.md deleted file mode 100644 index 5f511366f5..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Delete-deal.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Delete deal - Deletes deal by ID - - - -`Function DeleteDeal(Val URL, Val DealID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DealID | --deal | Number, String | Deal ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.deal.delete](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - DealID = "812"; - - Result = OPI_Bitrix24.DeleteDeal(URL, DealID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - DealID = "814"; - - Result = OPI_Bitrix24.DeleteDeal(URL, DealID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454947.97132, - "finish": 1728454948.11192, - "duration": 0.14059591293335, - "processing": 0.103829860687256, - "date_start": "2024-10-09T09:22:27+03:00", - "date_finish": "2024-10-09T09:22:28+03:00", - "operating_reset_at": 1728455548, - "operating": 0.103808164596558 - } -} -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Delete-deal.mdx b/docs/en/md/Bitrix24/Deals-managment/Delete-deal.mdx new file mode 100644 index 0000000000..af2eb9df86 --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Delete-deal.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Delete deal + Deletes deal by ID + + + +`Function DeleteDeal(Val URL, Val DealID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DealID | --deal | Number, String | Deal ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.deal.delete](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + DealID = "812"; + + Result = OPI_Bitrix24.DeleteDeal(URL, DealID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + DealID = "814"; + + Result = OPI_Bitrix24.DeleteDeal(URL, DealID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454947.97132, + "finish": 1728454948.11192, + "duration": 0.14059591293335, + "processing": 0.103829860687256, + "date_start": "2024-10-09T09:22:27+03:00", + "date_finish": "2024-10-09T09:22:28+03:00", + "operating_reset_at": 1728455548, + "operating": 0.103808164596558 + } +} +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.md b/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.md deleted file mode 100644 index 8e155a76d1..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get deal structure - Gets a structure with field descriptions for creating a deal - - - -`Function GetDealStructure(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.deal.fields](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_fields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetDealStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetDealStructure(URL, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": { - "type": "integer", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "ID" - }, - "TITLE": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Название" - }, - "TYPE_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "DEAL_TYPE", - "title": "Тип" - }, - "CATEGORY_ID": { - "type": "crm_category", - "isRequired": false, - "isReadOnly": false, - "isImmutable": true, - "isMultiple": false, - "isDynamic": false, - "title": "Воронка" - }, - "STAGE_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "DEAL_STAGE", - "title": "Стадия сделки" - }, - "STAGE_SEMANTIC_ID": { - "type": "string", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Группа стадии" - }, - "IS_NEW": { - "type": "char", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Новая сделка" - }, - "IS_RECURRING": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Регулярная сделка" - }, - "IS_RETURN_CUSTOMER": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Повторная сделка" - }, - "IS_REPEATED_APPROACH": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Повторное обращение" - }, - "PROBABILITY": { - "type": "integer", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Вероятность" - }, - "CURRENCY_ID": { - "type": "crm_currency", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Валюта" - }, - "OPPORTUNITY": { - "type": "double", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Сумма" - }, - "IS_MANUAL_OPPORTUNITY": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "IS_MANUAL_OPPORTUNITY" - }, - "TAX_VALUE": { - "type": "double", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Ставка налога" - }, - "COMPANY_ID": { - "type": "crm_company", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Компания", - "settings": { - "parentEntityTypeId": 4 - } -... -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.mdx b/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.mdx new file mode 100644 index 0000000000..69fd4f9cc1 --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Get-deal-structure.mdx @@ -0,0 +1,197 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get deal structure + Gets a structure with field descriptions for creating a deal + + + +`Function GetDealStructure(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.deal.fields](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_fields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetDealStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetDealStructure(URL, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": { + "type": "integer", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "ID" + }, + "TITLE": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Название" + }, + "TYPE_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "DEAL_TYPE", + "title": "Тип" + }, + "CATEGORY_ID": { + "type": "crm_category", + "isRequired": false, + "isReadOnly": false, + "isImmutable": true, + "isMultiple": false, + "isDynamic": false, + "title": "Воронка" + }, + "STAGE_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "DEAL_STAGE", + "title": "Стадия сделки" + }, + "STAGE_SEMANTIC_ID": { + "type": "string", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Группа стадии" + }, + "IS_NEW": { + "type": "char", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Новая сделка" + }, + "IS_RECURRING": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Регулярная сделка" + }, + "IS_RETURN_CUSTOMER": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Повторная сделка" + }, + "IS_REPEATED_APPROACH": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Повторное обращение" + }, + "PROBABILITY": { + "type": "integer", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Вероятность" + }, + "CURRENCY_ID": { + "type": "crm_currency", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Валюта" + }, + "OPPORTUNITY": { + "type": "double", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Сумма" + }, + "IS_MANUAL_OPPORTUNITY": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "IS_MANUAL_OPPORTUNITY" + }, + "TAX_VALUE": { + "type": "double", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Ставка налога" + }, + "COMPANY_ID": { + "type": "crm_company", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Компания", + "settings": { + "parentEntityTypeId": 4 + } +... +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deal.md b/docs/en/md/Bitrix24/Deals-managment/Get-deal.md deleted file mode 100644 index 532a99f5bb..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Get-deal.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get deal - Gets deal by ID - - - -`Function GetDeal(Val URL, Val DealID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DealID | --deal | Number, String | Deal ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.deal.get](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - DealID = "812"; - - Result = OPI_Bitrix24.GetDeal(URL, DealID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - DealID = "812"; - - Result = OPI_Bitrix24.GetDeal(URL, DealID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "772", - "TITLE": "Planned sale", - "TYPE_ID": "GOODS", - "STAGE_ID": "NEW", - "PROBABILITY": "30", - "CURRENCY_ID": "USD", - "OPPORTUNITY": "5000.00", - "IS_MANUAL_OPPORTUNITY": "N", - "TAX_VALUE": null, - "LEAD_ID": null, - "COMPANY_ID": "1", - "CONTACT_ID": "3", - "QUOTE_ID": null, - "BEGINDATE": "2024-01-01T03:00:00+03:00", - "CLOSEDATE": "2030-01-01T03:00:00+03:00", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-10-09T09:22:26+03:00", - "DATE_MODIFY": "2024-10-09T09:22:26+03:00", - "OPENED": "Y", - "CLOSED": "N", - "COMMENTS": null, - "ADDITIONAL_INFO": null, - "LOCATION_ID": null, - "CATEGORY_ID": "0", - "STAGE_SEMANTIC_ID": "P", - "IS_NEW": "Y", - "IS_RECURRING": "N", - "IS_RETURN_CUSTOMER": "N", - "IS_REPEATED_APPROACH": "N", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-10-09T09:22:26+03:00", - "LAST_ACTIVITY_TIME": "2024-10-09T09:22:26+03:00", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1" - }, - "time": { - "start": 1728454947.12395, - "finish": 1728454947.17279, - "duration": 0.0488379001617432, - "processing": 0.0184519290924072, - "date_start": "2024-10-09T09:22:27+03:00", - "date_finish": "2024-10-09T09:22:27+03:00", - "operating_reset_at": 1728455547, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deal.mdx b/docs/en/md/Bitrix24/Deals-managment/Get-deal.mdx new file mode 100644 index 0000000000..99be598e74 --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Get-deal.mdx @@ -0,0 +1,107 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get deal + Gets deal by ID + + + +`Function GetDeal(Val URL, Val DealID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DealID | --deal | Number, String | Deal ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.deal.get](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + DealID = "812"; + + Result = OPI_Bitrix24.GetDeal(URL, DealID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + DealID = "812"; + + Result = OPI_Bitrix24.GetDeal(URL, DealID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "772", + "TITLE": "Planned sale", + "TYPE_ID": "GOODS", + "STAGE_ID": "NEW", + "PROBABILITY": "30", + "CURRENCY_ID": "USD", + "OPPORTUNITY": "5000.00", + "IS_MANUAL_OPPORTUNITY": "N", + "TAX_VALUE": null, + "LEAD_ID": null, + "COMPANY_ID": "1", + "CONTACT_ID": "3", + "QUOTE_ID": null, + "BEGINDATE": "2024-01-01T03:00:00+03:00", + "CLOSEDATE": "2030-01-01T03:00:00+03:00", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-10-09T09:22:26+03:00", + "DATE_MODIFY": "2024-10-09T09:22:26+03:00", + "OPENED": "Y", + "CLOSED": "N", + "COMMENTS": null, + "ADDITIONAL_INFO": null, + "LOCATION_ID": null, + "CATEGORY_ID": "0", + "STAGE_SEMANTIC_ID": "P", + "IS_NEW": "Y", + "IS_RECURRING": "N", + "IS_RETURN_CUSTOMER": "N", + "IS_REPEATED_APPROACH": "N", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-10-09T09:22:26+03:00", + "LAST_ACTIVITY_TIME": "2024-10-09T09:22:26+03:00", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1" + }, + "time": { + "start": 1728454947.12395, + "finish": 1728454947.17279, + "duration": 0.0488379001617432, + "processing": 0.0184519290924072, + "date_start": "2024-10-09T09:22:27+03:00", + "date_finish": "2024-10-09T09:22:27+03:00", + "operating_reset_at": 1728455547, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deals-filter-structure.md b/docs/en/md/Bitrix24/Deals-managment/Get-deals-filter-structure.md deleted file mode 100644 index 1e191dc21b..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Get-deals-filter-structure.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get deals filter structure - Returns the field structure for filtering deals in the GetDealsList method - - - -`Function GetDealsFilterStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Bitrix24.GetDealsFilterStructure(); -``` - - - - -```json title="Result" -{ - "ID": "", - "ASSIGNED_BY_ID": "", - "BEGINDATE": "", - "CATEGORY_ID": "", - "CLOSEDATE": "", - "COMPANY_ID": "", - "CONTACT_ID": "", - "CREATED_BY_ID": "", - "CURRENCY_ID": "", - "DATE_CREATE": "", - "DATE_MODIFY": "", - "IS_NEW": "", - "IS_RECURRING": "", - "IS_RETURN_CUSTOMER": "", - "LEAD_ID": "", - "MODIFY_BY_ID": "", - "MOVED_BY_ID": "", - "MOVED_TIME": "", - "OPENED": "", - "OPPORTUNITY": "", - "PROBABILITY": "", - "REQUISITE_ID": "", - "STAGE_ID": "", - "TITLE": "", - "TYPE_ID": "" -} -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deals-filter-structure.mdx b/docs/en/md/Bitrix24/Deals-managment/Get-deals-filter-structure.mdx new file mode 100644 index 0000000000..63063118d3 --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Get-deals-filter-structure.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get deals filter structure + Returns the field structure for filtering deals in the GetDealsList method + + + +`Function GetDealsFilterStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Bitrix24.GetDealsFilterStructure(); +``` + + + + +```json title="Result" +{ + "ID": "", + "ASSIGNED_BY_ID": "", + "BEGINDATE": "", + "CATEGORY_ID": "", + "CLOSEDATE": "", + "COMPANY_ID": "", + "CONTACT_ID": "", + "CREATED_BY_ID": "", + "CURRENCY_ID": "", + "DATE_CREATE": "", + "DATE_MODIFY": "", + "IS_NEW": "", + "IS_RECURRING": "", + "IS_RETURN_CUSTOMER": "", + "LEAD_ID": "", + "MODIFY_BY_ID": "", + "MOVED_BY_ID": "", + "MOVED_TIME": "", + "OPENED": "", + "OPPORTUNITY": "", + "PROBABILITY": "", + "REQUISITE_ID": "", + "STAGE_ID": "", + "TITLE": "", + "TYPE_ID": "" +} +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deals-list.md b/docs/en/md/Bitrix24/Deals-managment/Get-deals-list.md deleted file mode 100644 index 673f447b35..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Get-deals-list.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get deals list - Gets the list of deals (50 pcs per query max) with or without filtering (see. GetDealsFilterStructure) - - - -`Function GetDealsList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Filter | --filter | Structure of KeyAndValue | Deals filter structure (see. GetDealsFilterStructure) | - | Indent | --offset | Number, String | Offset from the beginning of the list to retrieve deals > 50 pcs recursively | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.deal.list](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_list.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetDealsList(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Filter = New Structure; - Filter.Insert("TITLE" , "Sale in RUB"); - Filter.Insert("CURRENCY_ID", "RUB"); - - Result = OPI_Bitrix24.GetDealsList(URL, Filter, , Token); -``` - - - - -```json title="Result" -{ - "result": [], - "total": 0, - "time": { - "start": 1728454948.8758, - "finish": 1728454948.92784, - "duration": 0.0520431995391846, - "processing": 0.0178999900817871, - "date_start": "2024-10-09T09:22:28+03:00", - "date_finish": "2024-10-09T09:22:28+03:00", - "operating_reset_at": 1728455548, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Get-deals-list.mdx b/docs/en/md/Bitrix24/Deals-managment/Get-deals-list.mdx new file mode 100644 index 0000000000..f5f9ba6a82 --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Get-deals-list.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get deals list + Gets the list of deals (50 pcs per query max) with or without filtering (see. GetDealsFilterStructure) + + + +`Function GetDealsList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Filter | --filter | Structure of KeyAndValue | Deals filter structure (see. GetDealsFilterStructure) | + | Indent | --offset | Number, String | Offset from the beginning of the list to retrieve deals > 50 pcs recursively | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.deal.list](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_list.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetDealsList(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Filter = New Structure; + Filter.Insert("TITLE" , "Sale in RUB"); + Filter.Insert("CURRENCY_ID", "RUB"); + + Result = OPI_Bitrix24.GetDealsList(URL, Filter, , Token); +``` + + + + +```json title="Result" +{ + "result": [], + "total": 0, + "time": { + "start": 1728454948.8758, + "finish": 1728454948.92784, + "duration": 0.0520431995391846, + "processing": 0.0178999900817871, + "date_start": "2024-10-09T09:22:28+03:00", + "date_finish": "2024-10-09T09:22:28+03:00", + "operating_reset_at": 1728455548, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Update-deal.md b/docs/en/md/Bitrix24/Deals-managment/Update-deal.md deleted file mode 100644 index 22307e4fd7..0000000000 --- a/docs/en/md/Bitrix24/Deals-managment/Update-deal.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Update deal - Modifies an existing deal - - - -`Function UpdateDeal(Val URL, Val DealID, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DealID | --deal | Number, String | Deal ID | - | FieldsStructure | --fields | Structure of KeyAndValue | Deal fields structure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.deal.update](https://https: -dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_update.php) -::: -
- - -```bsl title="Code example" - FieldsStructure = New Structure; - FieldsStructure.Insert("TITLE" , "Sale in RUB"); - FieldsStructure.Insert("CURRENCY_ID" , "RUB"); - FieldsStructure.Insert("OPPORTUNITY" , 50000); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - DealID = "812"; - - Result = OPI_Bitrix24.UpdateDeal(URL, DealID, FieldsStructure); - - FieldsStructure.Insert("TITLE" , "Future deal in RUB"); - FieldsStructure.Insert("BEGINDATE", "2025-01-01"); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - DealID = "814"; - - Result = OPI_Bitrix24.UpdateDeal(URL, DealID, FieldsStructure, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454947.49523, - "finish": 1728454947.66518, - "duration": 0.169941902160645, - "processing": 0.142473936080933, - "date_start": "2024-10-09T09:22:27+03:00", - "date_finish": "2024-10-09T09:22:27+03:00", - "operating_reset_at": 1728455547, - "operating": 0.142450094223022 - } -} -``` diff --git a/docs/en/md/Bitrix24/Deals-managment/Update-deal.mdx b/docs/en/md/Bitrix24/Deals-managment/Update-deal.mdx new file mode 100644 index 0000000000..6b67af8eeb --- /dev/null +++ b/docs/en/md/Bitrix24/Deals-managment/Update-deal.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Update deal + Modifies an existing deal + + + +`Function UpdateDeal(Val URL, Val DealID, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DealID | --deal | Number, String | Deal ID | + | FieldsStructure | --fields | Structure of KeyAndValue | Deal fields structure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.deal.update](https://https: +dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_update.php) +::: +
+ + +```bsl title="Code example" + FieldsStructure = New Structure; + FieldsStructure.Insert("TITLE" , "Sale in RUB"); + FieldsStructure.Insert("CURRENCY_ID" , "RUB"); + FieldsStructure.Insert("OPPORTUNITY" , 50000); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + DealID = "812"; + + Result = OPI_Bitrix24.UpdateDeal(URL, DealID, FieldsStructure); + + FieldsStructure.Insert("TITLE" , "Future deal in RUB"); + FieldsStructure.Insert("BEGINDATE", "2025-01-01"); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + DealID = "814"; + + Result = OPI_Bitrix24.UpdateDeal(URL, DealID, FieldsStructure, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454947.49523, + "finish": 1728454947.66518, + "duration": 0.169941902160645, + "processing": 0.142473936080933, + "date_start": "2024-10-09T09:22:27+03:00", + "date_finish": "2024-10-09T09:22:27+03:00", + "operating_reset_at": 1728455547, + "operating": 0.142450094223022 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Create-department.md b/docs/en/md/Bitrix24/Departments-managment/Create-department.md deleted file mode 100644 index 124ae2315e..0000000000 --- a/docs/en/md/Bitrix24/Departments-managment/Create-department.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create department - Creates a new department - - - -`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | Department name | - | ParentID | --parentid | String, Number | ID of parent department | - | HeadID | --headid | String, Number | ID of department manager | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Name = "Main department"; - ParentID = 1; - - Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Name = "Subordinate department"; - ParentID = "612"; - HeadID = 1; - - Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token); -``` - - - - -```json title="Result" -{ - "result": 594, - "time": { - "start": 1728454927.08955, - "finish": 1728454927.30747, - "duration": 0.217915773391724, - "processing": 0.186015844345093, - "date_start": "2024-10-09T09:22:07+03:00", - "date_finish": "2024-10-09T09:22:07+03:00", - "operating_reset_at": 1728455527, - "operating": 0.18598484992981 - } -} -``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Create-department.mdx b/docs/en/md/Bitrix24/Departments-managment/Create-department.mdx new file mode 100644 index 0000000000..59c7cd3c3a --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Create-department.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create department + Creates a new department + + + +`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | Department name | + | ParentID | --parentid | String, Number | ID of parent department | + | HeadID | --headid | String, Number | ID of department manager | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Name = "Main department"; + ParentID = 1; + + Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Name = "Subordinate department"; + ParentID = "612"; + HeadID = 1; + + Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token); +``` + + + + +```json title="Result" +{ + "result": 594, + "time": { + "start": 1728454927.08955, + "finish": 1728454927.30747, + "duration": 0.217915773391724, + "processing": 0.186015844345093, + "date_start": "2024-10-09T09:22:07+03:00", + "date_finish": "2024-10-09T09:22:07+03:00", + "operating_reset_at": 1728455527, + "operating": 0.18598484992981 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Delete-department.md b/docs/en/md/Bitrix24/Departments-managment/Delete-department.md deleted file mode 100644 index e7e907c1c9..0000000000 --- a/docs/en/md/Bitrix24/Departments-managment/Delete-department.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete department - Delets department by ID - - - -`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DepartmentID | --depid | String, Number | Department ID for deletion | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - DepartmentID = "614"; - - Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - DepartmentID = "612"; - - Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454928.30262, - "finish": 1728454928.41098, - "duration": 0.108357906341553, - "processing": 0.0806529521942139, - "date_start": "2024-10-09T09:22:08+03:00", - "date_finish": "2024-10-09T09:22:08+03:00", - "operating_reset_at": 1728455528, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Delete-department.mdx b/docs/en/md/Bitrix24/Departments-managment/Delete-department.mdx new file mode 100644 index 0000000000..44fe620beb --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Delete-department.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete department + Delets department by ID + + + +`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DepartmentID | --depid | String, Number | Department ID for deletion | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + DepartmentID = "614"; + + Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + DepartmentID = "612"; + + Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454928.30262, + "finish": 1728454928.41098, + "duration": 0.108357906341553, + "processing": 0.0806529521942139, + "date_start": "2024-10-09T09:22:08+03:00", + "date_finish": "2024-10-09T09:22:08+03:00", + "operating_reset_at": 1728455528, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Get-departments.md b/docs/en/md/Bitrix24/Departments-managment/Get-departments.md deleted file mode 100644 index b69b53d913..0000000000 --- a/docs/en/md/Bitrix24/Departments-managment/Get-departments.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get departments - Gets a list of departments by ID or filter - - - -`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DepartmentID | --depid | String, Number | Selection by department ID | - | Name | --title | String | Filter by name | - | ParentID | --parentid | String, Number | Filter by parent ID | - | HeadID | --headid | String, Number | Filter by manager ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - DepartmentID = "614"; - - Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - HeadID = 1; - - Result = OPI_Bitrix24.GetDepartments(URL, , , , HeadID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "594", - "NAME": "Subordinate department", - "SORT": 500, - "PARENT": "592", - "UF_HEAD": "1" - } - ], - "total": 1, - "time": { - "start": 1728454927.4735, - "finish": 1728454927.50699, - "duration": 0.0334928035736084, - "processing": 0.00784516334533691, - "date_start": "2024-10-09T09:22:07+03:00", - "date_finish": "2024-10-09T09:22:07+03:00", - "operating_reset_at": 1728455527, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Get-departments.mdx b/docs/en/md/Bitrix24/Departments-managment/Get-departments.mdx new file mode 100644 index 0000000000..a0dca1ccbd --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Get-departments.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get departments + Gets a list of departments by ID or filter + + + +`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DepartmentID | --depid | String, Number | Selection by department ID | + | Name | --title | String | Filter by name | + | ParentID | --parentid | String, Number | Filter by parent ID | + | HeadID | --headid | String, Number | Filter by manager ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + DepartmentID = "614"; + + Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + HeadID = 1; + + Result = OPI_Bitrix24.GetDepartments(URL, , , , HeadID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "594", + "NAME": "Subordinate department", + "SORT": 500, + "PARENT": "592", + "UF_HEAD": "1" + } + ], + "total": 1, + "time": { + "start": 1728454927.4735, + "finish": 1728454927.50699, + "duration": 0.0334928035736084, + "processing": 0.00784516334533691, + "date_start": "2024-10-09T09:22:07+03:00", + "date_finish": "2024-10-09T09:22:07+03:00", + "operating_reset_at": 1728455527, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Update-department.md b/docs/en/md/Bitrix24/Departments-managment/Update-department.md deleted file mode 100644 index 32263a6a29..0000000000 --- a/docs/en/md/Bitrix24/Departments-managment/Update-department.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Update department - Update an existing department - - - -`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DepartmentID | --depid | String, Number | Department ID | - | Name | --title | String | Department name | - | ParentID | --parentid | String, Number | ID of parent department | - | HeadID | --headid | String, Number | ID of department manager | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - DepartmentID = "612"; - ParentID = 7; - - Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID, , ParentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - DepartmentID = "614"; - Name = "New department"; - ParentID = 1; - HeadID = 10; - - Result = OPI_Bitrix24.UpdateDepartment(URL - , DepartmentID - , Name - , ParentID - , HeadID - , Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454927.77891, - "finish": 1728454928.01456, - "duration": 0.235645055770874, - "processing": 0.204494953155518, - "date_start": "2024-10-09T09:22:07+03:00", - "date_finish": "2024-10-09T09:22:08+03:00", - "operating_reset_at": 1728455527, - "operating": 0.20447301864624 - } -} -``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Update-department.mdx b/docs/en/md/Bitrix24/Departments-managment/Update-department.mdx new file mode 100644 index 0000000000..a5a1cb27ac --- /dev/null +++ b/docs/en/md/Bitrix24/Departments-managment/Update-department.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Update department + Update an existing department + + + +`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DepartmentID | --depid | String, Number | Department ID | + | Name | --title | String | Department name | + | ParentID | --parentid | String, Number | ID of parent department | + | HeadID | --headid | String, Number | ID of department manager | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + DepartmentID = "612"; + ParentID = 7; + + Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID, , ParentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + DepartmentID = "614"; + Name = "New department"; + ParentID = 1; + HeadID = 10; + + Result = OPI_Bitrix24.UpdateDepartment(URL + , DepartmentID + , Name + , ParentID + , HeadID + , Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454927.77891, + "finish": 1728454928.01456, + "duration": 0.235645055770874, + "processing": 0.204494953155518, + "date_start": "2024-10-09T09:22:07+03:00", + "date_finish": "2024-10-09T09:22:08+03:00", + "operating_reset_at": 1728455527, + "operating": 0.20447301864624 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md deleted file mode 100644 index e5a4a1f0d2..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Add comment to post - Adds a comment to the post - - - -`Function AddPostComment(Val URL, Val PostID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Post ID | - | Text | --text | String | Comment text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) -::: -
- - -```bsl title="Code example" - Text = "Comment for post"; - PostID = "970"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text); - - Text = "Another comment"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text, Token); -``` - - - - -```json title="Result" -{ - "result": 876, - "time": { - "start": 1728454764.93192, - "finish": 1728454765.05443, - "duration": 0.122506141662598, - "processing": 0.0952260494232178, - "date_start": "2024-10-09T09:19:24+03:00", - "date_finish": "2024-10-09T09:19:25+03:00", - "operating_reset_at": 1728455364, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.mdx new file mode 100644 index 0000000000..9de6746743 --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Add comment to post + Adds a comment to the post + + + +`Function AddPostComment(Val URL, Val PostID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Post ID | + | Text | --text | String | Comment text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) +::: +
+ + +```bsl title="Code example" + Text = "Comment for post"; + PostID = "970"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text); + + Text = "Another comment"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text, Token); +``` + + + + +```json title="Result" +{ + "result": 876, + "time": { + "start": 1728454764.93192, + "finish": 1728454765.05443, + "duration": 0.122506141662598, + "processing": 0.0952260494232178, + "date_start": "2024-10-09T09:19:24+03:00", + "date_finish": "2024-10-09T09:19:25+03:00", + "operating_reset_at": 1728455364, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md deleted file mode 100644 index 4ed11cad3a..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Add new recipients to a post - Adds new groups or users to the recipients - - - -`Function AddPostRecipients(Val URL, Val PostID, Val Visibility, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Post ID | - | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogpost.share](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_share.php) -::: -
- - -```bsl title="Code example" - Visibility = "UA"; - PostID = "970"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454765.18756, - "finish": 1728454765.2209, - "duration": 0.033344030380249, - "processing": 0.00590705871582031, - "date_start": "2024-10-09T09:19:25+03:00", - "date_finish": "2024-10-09T09:19:25+03:00", - "operating_reset_at": 1728455365, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.mdx new file mode 100644 index 0000000000..890387e016 --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Add new recipients to a post + Adds new groups or users to the recipients + + + +`Function AddPostRecipients(Val URL, Val PostID, Val Visibility, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Post ID | + | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogpost.share](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_share.php) +::: +
+ + +```bsl title="Code example" + Visibility = "UA"; + PostID = "970"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454765.18756, + "finish": 1728454765.2209, + "duration": 0.033344030380249, + "processing": 0.00590705871582031, + "date_start": "2024-10-09T09:19:25+03:00", + "date_finish": "2024-10-09T09:19:25+03:00", + "operating_reset_at": 1728455365, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md deleted file mode 100644 index d399aa980e..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create post - Create a new post at news feed - - - -`Function CreatePost(Val URL, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Important = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Text | --text | String | Text of post | - | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | - | Files | --files | Map Of KeyAndValue | Key > file name, value > path or binary data | - | Title | --title | String | Post title | - | Important | --important | Boolean | Mark post as important | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) -::: -
- - -```bsl title="Code example" - Text = "Text of post"; - Title = "Post title"; - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Path or Binary Data - - Files = New Map; - Files.Insert("1.png", Image1); - Files.Insert("2.png", Image2); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreatePost(URL, Text, , Files, Title, True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreatePost(URL, Text, , Files, Title, , Token); -``` - - - - -```json title="Result" -{ - "result": 950, - "time": { - "start": 1728454758.49744, - "finish": 1728454760.56604, - "duration": 2.068598985672, - "processing": 2.04061388969421, - "date_start": "2024-10-09T09:19:18+03:00", - "date_finish": "2024-10-09T09:19:20+03:00", - "operating_reset_at": 1728455358, - "operating": 2.04057788848877 - } -} -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.mdx new file mode 100644 index 0000000000..0189ab1dc1 --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create post + Create a new post at news feed + + + +`Function CreatePost(Val URL, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Important = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Text | --text | String | Text of post | + | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | + | Files | --files | Map Of KeyAndValue | Key > file name, value > path or binary data | + | Title | --title | String | Post title | + | Important | --important | Boolean | Mark post as important | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) +::: +
+ + +```bsl title="Code example" + Text = "Text of post"; + Title = "Post title"; + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Path or Binary Data + + Files = New Map; + Files.Insert("1.png", Image1); + Files.Insert("2.png", Image2); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreatePost(URL, Text, , Files, Title, True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreatePost(URL, Text, , Files, Title, , Token); +``` + + + + +```json title="Result" +{ + "result": 950, + "time": { + "start": 1728454758.49744, + "finish": 1728454760.56604, + "duration": 2.068598985672, + "processing": 2.04061388969421, + "date_start": "2024-10-09T09:19:18+03:00", + "date_finish": "2024-10-09T09:19:20+03:00", + "operating_reset_at": 1728455358, + "operating": 2.04057788848877 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md deleted file mode 100644 index 3e05bc99b2..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete post - Remove post from a news feed - - - -`Function DeletePost(Val URL, Val PostID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Id of post to remove | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogpost.delete](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_delete.php) -::: -
- - -```bsl title="Code example" - PostID = "968"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.DeletePost(URL, PostID); - - PostID = "970"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.DeletePost(URL, PostID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454765.65176, - "finish": 1728454765.95776, - "duration": 0.305999994277954, - "processing": 0.267876863479614, - "date_start": "2024-10-09T09:19:25+03:00", - "date_finish": "2024-10-09T09:19:25+03:00", - "operating_reset_at": 1728455365, - "operating": 0.267848968505859 - } -} -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.mdx new file mode 100644 index 0000000000..d5e364890c --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete post + Remove post from a news feed + + + +`Function DeletePost(Val URL, Val PostID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Id of post to remove | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogpost.delete](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_delete.php) +::: +
+ + +```bsl title="Code example" + PostID = "968"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.DeletePost(URL, PostID); + + PostID = "970"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.DeletePost(URL, PostID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454765.65176, + "finish": 1728454765.95776, + "duration": 0.305999994277954, + "processing": 0.267876863479614, + "date_start": "2024-10-09T09:19:25+03:00", + "date_finish": "2024-10-09T09:19:25+03:00", + "operating_reset_at": 1728455365, + "operating": 0.267848968505859 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md b/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md deleted file mode 100644 index d90a6a1731..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get list of important post viewers - Return list of important post viewers ids - - - -`Function GetImportantPostViewers(Val URL, Val PostID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Id of important post | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogpost.getusers.important](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_getusers_important.php) -::: -
- - -```bsl title="Code example" - PostID = "968"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - "1" - ], - "time": { - "start": 1728454764.35244, - "finish": 1728454764.38658, - "duration": 0.0341410636901856, - "processing": 0.000212907791137695, - "date_start": "2024-10-09T09:19:24+03:00", - "date_finish": "2024-10-09T09:19:24+03:00", - "operating_reset_at": 1728455364, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.mdx new file mode 100644 index 0000000000..05d7cdc391 --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get list of important post viewers + Return list of important post viewers ids + + + +`Function GetImportantPostViewers(Val URL, Val PostID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Id of important post | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogpost.getusers.important](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_getusers_important.php) +::: +
+ + +```bsl title="Code example" + PostID = "968"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + "1" + ], + "time": { + "start": 1728454764.35244, + "finish": 1728454764.38658, + "duration": 0.0341410636901856, + "processing": 0.000212907791137695, + "date_start": "2024-10-09T09:19:24+03:00", + "date_finish": "2024-10-09T09:19:24+03:00", + "operating_reset_at": 1728455364, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md b/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md deleted file mode 100644 index 1d10829d05..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get posts - Gen post or array of post with ID or rights selection - - - -`Function GetPosts(Val URL, Val PostID = "", Val Filter = "UA", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Id of important post | - | Filter | --sel | String | Post selection by rights: UA all, SGn work group, Un user, DRn depart, Gn group | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogpost.get](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_get.php) -::: -
- - -```bsl title="Code example" - PostID = "970"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetPosts(URL, PostID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetPosts(URL, PostID, , Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "950", - "BLOG_ID": "1", - "PUBLISH_STATUS": "P", - "TITLE": "New post title", - "AUTHOR_ID": "1", - "ENABLE_COMMENTS": "Y", - "NUM_COMMENTS": "0", - "CODE": null, - "MICRO": "N", - "DETAIL_TEXT": "New post text", - "DATE_PUBLISH": "2024-10-09T09:19:18+03:00", - "CATEGORY_ID": null, - "HAS_SOCNET_ALL": "N", - "HAS_TAGS": "N", - "HAS_IMAGES": "N", - "HAS_PROPS": "Y", - "HAS_COMMENT_IMAGES": null, - "UF_BLOG_POST_DOC": { - "ID": "1", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_BLOG_POST_DOC", - "USER_TYPE_ID": "file", - "XML_ID": "UF_BLOG_POST_DOC", - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": { - "SIZE": 20, - "LIST_WIDTH": 0, - "LIST_HEIGHT": 0, - "MAX_SHOW_SIZE": 0, - "MAX_ALLOWED_SIZE": 0, - "EXTENSIONS": [], - "TARGET_BLANK": "Y" - }, - "EDIT_FORM_LABEL": null, - "LIST_COLUMN_LABEL": null, - "LIST_FILTER_LABEL": null, - "ERROR_MESSAGE": null, - "HELP_MESSAGE": null, - "USER_TYPE": { - "USER_TYPE_ID": "file", - "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType", - "EDIT_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\FileType", - "renderEdit" - ], - "VIEW_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\FileType", - "renderView" - ], - "USE_FIELD_COMPONENT": true, - "DESCRIPTION": "Файл", - "BASE_TYPE": "file" - }, - "VALUE": false, - "ENTITY_VALUE_ID": 950, - "VALUE_EXISTS": true, - "VALUE_RAW": null, - "CUSTOM_DATA": [] - }, - "UF_BLOG_POST_URL_PRV": { - "ID": "5", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_BLOG_POST_URL_PRV", - "USER_TYPE_ID": "url_preview", - "XML_ID": "UF_BLOG_POST_URL_PRV", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": [], - "EDIT_FORM_LABEL": null, - "LIST_COLUMN_LABEL": null, - "LIST_FILTER_LABEL": null, - "ERROR_MESSAGE": null, - "HELP_MESSAGE": null, - "USER_TYPE": { - "USER_TYPE_ID": "url_preview", - "CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType", - "DESCRIPTION": "Содержимое ссылки", - "BASE_TYPE": "int" - }, - "VALUE": null, - "ENTITY_VALUE_ID": 950, - "VALUE_EXISTS": true, - "VALUE_RAW": null, - "CUSTOM_DATA": [] - }, - "UF_GRATITUDE": { - "ID": "9", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_GRATITUDE", - "USER_TYPE_ID": "integer", - "XML_ID": "UF_GRATITUDE", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "MIN_VALUE": 0, - "MAX_VALUE": 0, - "DEFAULT_VALUE": null - }, - "EDIT_FORM_LABEL": null, - "LIST_COLUMN_LABEL": null, - "LIST_FILTER_LABEL": null, - "ERROR_MESSAGE": null, - "HELP_MESSAGE": null, - "USER_TYPE": { - "USER_TYPE_ID": "integer", - "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType", - "EDIT_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\IntegerType", - "renderEdit" - ], - "VIEW_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\IntegerType", - "renderView" - ], - "USE_FIELD_COMPONENT": true, - "DESCRIPTION": "Целое число", - "BASE_TYPE": "int" - }, - "VALUE": null, - "ENTITY_VALUE_ID": 950, - "VALUE_EXISTS": true, - "VALUE_RAW": null, - "CUSTOM_DATA": [] - }, - "UF_BLOG_POST_FILE": { - "ID": "19", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_BLOG_POST_FILE", - "USER_TYPE_ID": "disk_file", - "XML_ID": "UF_BLOG_POST_FILE", -... -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.mdx new file mode 100644 index 0000000000..322b70ecbf --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get posts + Gen post or array of post with ID or rights selection + + + +`Function GetPosts(Val URL, Val PostID = "", Val Filter = "UA", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Id of important post | + | Filter | --sel | String | Post selection by rights: UA all, SGn work group, Un user, DRn depart, Gn group | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogpost.get](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_get.php) +::: +
+ + +```bsl title="Code example" + PostID = "970"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetPosts(URL, PostID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetPosts(URL, PostID, , Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "950", + "BLOG_ID": "1", + "PUBLISH_STATUS": "P", + "TITLE": "New post title", + "AUTHOR_ID": "1", + "ENABLE_COMMENTS": "Y", + "NUM_COMMENTS": "0", + "CODE": null, + "MICRO": "N", + "DETAIL_TEXT": "New post text", + "DATE_PUBLISH": "2024-10-09T09:19:18+03:00", + "CATEGORY_ID": null, + "HAS_SOCNET_ALL": "N", + "HAS_TAGS": "N", + "HAS_IMAGES": "N", + "HAS_PROPS": "Y", + "HAS_COMMENT_IMAGES": null, + "UF_BLOG_POST_DOC": { + "ID": "1", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_DOC", + "USER_TYPE_ID": "file", + "XML_ID": "UF_BLOG_POST_DOC", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": { + "SIZE": 20, + "LIST_WIDTH": 0, + "LIST_HEIGHT": 0, + "MAX_SHOW_SIZE": 0, + "MAX_ALLOWED_SIZE": 0, + "EXTENSIONS": [], + "TARGET_BLANK": "Y" + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "file", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\FileType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\FileType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Файл", + "BASE_TYPE": "file" + }, + "VALUE": false, + "ENTITY_VALUE_ID": 950, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_URL_PRV": { + "ID": "5", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_URL_PRV", + "USER_TYPE_ID": "url_preview", + "XML_ID": "UF_BLOG_POST_URL_PRV", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [], + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "url_preview", + "CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType", + "DESCRIPTION": "Содержимое ссылки", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 950, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_GRATITUDE": { + "ID": "9", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_GRATITUDE", + "USER_TYPE_ID": "integer", + "XML_ID": "UF_GRATITUDE", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "MIN_VALUE": 0, + "MAX_VALUE": 0, + "DEFAULT_VALUE": null + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "integer", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Целое число", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 950, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_FILE": { + "ID": "19", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_FILE", + "USER_TYPE_ID": "disk_file", + "XML_ID": "UF_BLOG_POST_FILE", +... +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md deleted file mode 100644 index 599b052b76..0000000000 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Update post - Change post data - - - -`Function UpdatePost(Val URL, Val PostID, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Post ID | - | Text | --text | String | Text of post | - | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | - | Files | --files | Map Of KeyAndValue | Key > file name, value > path or binary data | - | Title | --title | String | Post title | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php) -::: -
- - -```bsl title="Code example" - Text = "New post text"; - Title = "New post title"; - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data - PostID = "970"; - - Files = New Map; - Files.Insert("1.png", Image1); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text, , Files, Title); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - PostID = "968"; - - Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text, , Files, Title, Token); -``` - - - - -```json title="Result" -{ - "result": 948, - "time": { - "start": 1728454763.57528, - "finish": 1728454764.20608, - "duration": 0.630802154541016, - "processing": 0.599277019500732, - "date_start": "2024-10-09T09:19:23+03:00", - "date_finish": "2024-10-09T09:19:24+03:00", - "operating_reset_at": 1728455363, - "operating": 0.599257946014404 - } -} -``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.mdx b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.mdx new file mode 100644 index 0000000000..87ce57a585 --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Update post + Change post data + + + +`Function UpdatePost(Val URL, Val PostID, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Post ID | + | Text | --text | String | Text of post | + | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | + | Files | --files | Map Of KeyAndValue | Key > file name, value > path or binary data | + | Title | --title | String | Post title | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php) +::: +
+ + +```bsl title="Code example" + Text = "New post text"; + Title = "New post title"; + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data + PostID = "970"; + + Files = New Map; + Files.Insert("1.png", Image1); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text, , Files, Title); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + PostID = "968"; + + Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text, , Files, Title, Token); +``` + + + + +```json title="Result" +{ + "result": 948, + "time": { + "start": 1728454763.57528, + "finish": 1728454764.20608, + "duration": 0.630802154541016, + "processing": 0.599277019500732, + "date_start": "2024-10-09T09:19:23+03:00", + "date_finish": "2024-10-09T09:19:24+03:00", + "operating_reset_at": 1728455363, + "operating": 0.599257946014404 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Delete-file.md b/docs/en/md/Bitrix24/File-managment/Delete-file.md deleted file mode 100644 index a339297afe..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Delete-file.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete file - Delete file by ID - - - -`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | ID of removing file | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FileID = "12874"; - - Result = OPI_Bitrix24.DeleteFile(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - FileID = "12876"; - - Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454828.81245, - "finish": 1728454828.89366, - "duration": 0.0812110900878906, - "processing": 0.0537998676300049, - "date_start": "2024-10-09T09:20:28+03:00", - "date_finish": "2024-10-09T09:20:28+03:00", - "operating_reset_at": 1728455428, - "operating": 0.125946998596191 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Delete-file.mdx b/docs/en/md/Bitrix24/File-managment/Delete-file.mdx new file mode 100644 index 0000000000..0bb09bf848 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Delete-file.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete file + Delete file by ID + + + +`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | ID of removing file | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FileID = "12874"; + + Result = OPI_Bitrix24.DeleteFile(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + FileID = "12876"; + + Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454828.81245, + "finish": 1728454828.89366, + "duration": 0.0812110900878906, + "processing": 0.0537998676300049, + "date_start": "2024-10-09T09:20:28+03:00", + "date_finish": "2024-10-09T09:20:28+03:00", + "operating_reset_at": 1728455428, + "operating": 0.125946998596191 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md deleted file mode 100644 index 4878a42b55..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get external link for a file - Get external link to file - - - -`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -The method has suddenly disappeared from the API on the cloud Bitrix24 where it was being tested (09/24). It might still work on other versions, but it's not guaranteed - - Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FileID = "12876"; - - Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token); -``` - - - - -```json title="Result" -{ - "error": "ERROR_METHOD_NOT_FOUND", - "error_description": "Method not found!" -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-external-link.mdx b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.mdx new file mode 100644 index 0000000000..c34d97065d --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get external link for a file + Get external link to file + + + +`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +The method has suddenly disappeared from the API on the cloud Bitrix24 where it was being tested (09/24). It might still work on other versions, but it's not guaranteed + + Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FileID = "12876"; + + Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token); +``` + + + + +```json title="Result" +{ + "error": "ERROR_METHOD_NOT_FOUND", + "error_description": "Method not found!" +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-information.md b/docs/en/md/Bitrix24/File-managment/Get-file-information.md deleted file mode 100644 index 9315bd51eb..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Get-file-information.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get information about file - Get information about file by ID - - - -`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FileID = "12876"; - - Result = OPI_Bitrix24.GetFileInformation(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFileInformation(URL, FileID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12576", - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8666", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:02+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1pYVJOa0d1NVA0SHFuSkQ1Zk5UTHRWQWt0dVFwZVA1Vw%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxcFlWSk9hMGQxTlZBMFNIRnVTa1ExWms1VVRIUldRV3QwZFZGd1pWQTFWdz09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.XDEIYMKm%2F%2FrLXO07LMD9Hc7Dt5uMEeGyr7nlHv3LKFg%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" - }, - "time": { - "start": 1728454802.83722, - "finish": 1728454802.87402, - "duration": 0.036797046661377, - "processing": 0.00736904144287109, - "date_start": "2024-10-09T09:20:02+03:00", - "date_finish": "2024-10-09T09:20:02+03:00", - "operating_reset_at": 1728455402, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-information.mdx b/docs/en/md/Bitrix24/File-managment/Get-file-information.mdx new file mode 100644 index 0000000000..64b7081f53 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Get-file-information.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get information about file + Get information about file by ID + + + +`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FileID = "12876"; + + Result = OPI_Bitrix24.GetFileInformation(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFileInformation(URL, FileID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12576", + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8666", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:02+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1pYVJOa0d1NVA0SHFuSkQ1Zk5UTHRWQWt0dVFwZVA1Vw%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxcFlWSk9hMGQxTlZBMFNIRnVTa1ExWms1VVRIUldRV3QwZFZGd1pWQTFWdz09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.XDEIYMKm%2F%2FrLXO07LMD9Hc7Dt5uMEeGyr7nlHv3LKFg%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" + }, + "time": { + "start": 1728454802.83722, + "finish": 1728454802.87402, + "duration": 0.036797046661377, + "processing": 0.00736904144287109, + "date_start": "2024-10-09T09:20:02+03:00", + "date_finish": "2024-10-09T09:20:02+03:00", + "operating_reset_at": 1728455402, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Make-copy-file.md b/docs/en/md/Bitrix24/File-managment/Make-copy-file.md deleted file mode 100644 index 48dbb1d51a..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Make-copy-file.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Copy file - Copy file from one destination to another - - - -`Function MakeCopyFile(Val URL, Val FileID, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | Original file ID | - | FolderID | --folderid | String, Number | ID of copy destination folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) -::: -
- - -```bsl title="Code example" - FolderID = "12880"; - FileID = "12876"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.MakeCopyFile(URL, FileID, FolderID); - - FolderID = "12882"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MakeCopyFile(URL, FileID, FolderID, Token); - - OPI_TestDataRetrieval.Check_BitrixObject(Result); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12604, - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "12582", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 8678, - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:28+03:00", - "UPDATE_TIME": "2024-10-09T09:20:28+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDQmXz1ka3Jhc2tOdTFzMTNFR2lWMkxlRXhVaGhpRXNZNHJIeg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNRFFtWHoxa2EzSmhjMnRPZFRGek1UTkZSMmxXTWt4bFJYaFZhR2hwUlhOWk5ISkllZz09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.N%2FF9rbooZHbXWXkg%2FNRXmmAOWkTJnKmwua3QXnjg12Y%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg" - }, - "time": { - "start": 1728454828.44084, - "finish": 1728454828.53669, - "duration": 0.0958428382873535, - "processing": 0.0711829662322998, - "date_start": "2024-10-09T09:20:28+03:00", - "date_finish": "2024-10-09T09:20:28+03:00", - "operating_reset_at": 1728455428, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Make-copy-file.mdx b/docs/en/md/Bitrix24/File-managment/Make-copy-file.mdx new file mode 100644 index 0000000000..f35b7a5f68 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Make-copy-file.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Copy file + Copy file from one destination to another + + + +`Function MakeCopyFile(Val URL, Val FileID, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | Original file ID | + | FolderID | --folderid | String, Number | ID of copy destination folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) +::: +
+ + +```bsl title="Code example" + FolderID = "12880"; + FileID = "12876"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.MakeCopyFile(URL, FileID, FolderID); + + FolderID = "12882"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MakeCopyFile(URL, FileID, FolderID, Token); + + OPI_TestDataRetrieval.Check_BitrixObject(Result); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12604, + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "12582", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 8678, + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:28+03:00", + "UPDATE_TIME": "2024-10-09T09:20:28+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDQmXz1ka3Jhc2tOdTFzMTNFR2lWMkxlRXhVaGhpRXNZNHJIeg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNRFFtWHoxa2EzSmhjMnRPZFRGek1UTkZSMmxXTWt4bFJYaFZhR2hwUlhOWk5ISkllZz09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.N%2FF9rbooZHbXWXkg%2FNRXmmAOWkTJnKmwua3QXnjg12Y%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg" + }, + "time": { + "start": 1728454828.44084, + "finish": 1728454828.53669, + "duration": 0.0958428382873535, + "processing": 0.0711829662322998, + "date_start": "2024-10-09T09:20:28+03:00", + "date_finish": "2024-10-09T09:20:28+03:00", + "operating_reset_at": 1728455428, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md deleted file mode 100644 index 2c2208cf78..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Mark file as deleted - Move file to recycle bin - - - -`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FileID = "12876"; - - Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12576", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8666", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:02+03:00", - "DELETE_TIME": "2024-10-09T09:20:23+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz05TGFTcEdGYnRrcE0wUmJiSFNUeFo2TGpKZzVTNXk5VQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHowNVRHRlRjRWRHWW5ScmNFMHdVbUppU0ZOVWVGbzJUR3BLWnpWVE5YazVWUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.kT%2BI3LsHkE%2BEL0PS7LTYUu8cbjsz8YpXhAiDww9Uey8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpgi17284548233529i" - }, - "time": { - "start": 1728454823.44531, - "finish": 1728454823.47456, - "duration": 0.0292489528656006, - "processing": 0.00551199913024902, - "date_start": "2024-10-09T09:20:23+03:00", - "date_finish": "2024-10-09T09:20:23+03:00", - "operating_reset_at": 1728455423, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.mdx b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.mdx new file mode 100644 index 0000000000..1565499d88 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Mark file as deleted + Move file to recycle bin + + + +`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FileID = "12876"; + + Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12576", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8666", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:02+03:00", + "DELETE_TIME": "2024-10-09T09:20:23+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz05TGFTcEdGYnRrcE0wUmJiSFNUeFo2TGpKZzVTNXk5VQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHowNVRHRlRjRWRHWW5ScmNFMHdVbUppU0ZOVWVGbzJUR3BLWnpWVE5YazVWUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.kT%2BI3LsHkE%2BEL0PS7LTYUu8cbjsz8YpXhAiDww9Uey8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpgi17284548233529i" + }, + "time": { + "start": 1728454823.44531, + "finish": 1728454823.47456, + "duration": 0.0292489528656006, + "processing": 0.00551199913024902, + "date_start": "2024-10-09T09:20:23+03:00", + "date_finish": "2024-10-09T09:20:23+03:00", + "operating_reset_at": 1728455423, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md deleted file mode 100644 index ec19ece276..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Move file - Move file from one destination to another - - - -`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File ID | - | FolderID | --folderid | String, Number | ID of new destination folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) -::: -
- - -```bsl title="Code example" - FolderID = "12884"; - FileID = "12876"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID); - - FolderID = "12886"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token); - - OPI_TestDataRetrieval.Check_BitrixObject(Result); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12576", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": 12586, - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8666", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:23+03:00", - "DELETE_TIME": "2024-10-09T09:20:23+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz14Y3dRbXoySnl4NlI2MHJJY09SNG1KbE9URTVENlF3aA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxNFkzZFJiWG95U25sNE5sSTJNSEpKWTA5U05HMUtiRTlVUlRWRU5sRjNhQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.i2CHa05fN9FhHCvhCTGArYmKJ24LaHa7VxRKyrHfs10%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New subfolder/New file name.jpg" - }, - "time": { - "start": 1728454825.05896, - "finish": 1728454825.12211, - "duration": 0.06315016746521, - "processing": 0.0357410907745361, - "date_start": "2024-10-09T09:20:25+03:00", - "date_finish": "2024-10-09T09:20:25+03:00", - "operating_reset_at": 1728455425, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.mdx b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.mdx new file mode 100644 index 0000000000..b0871974f0 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Move file + Move file from one destination to another + + + +`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File ID | + | FolderID | --folderid | String, Number | ID of new destination folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) +::: +
+ + +```bsl title="Code example" + FolderID = "12884"; + FileID = "12876"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID); + + FolderID = "12886"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token); + + OPI_TestDataRetrieval.Check_BitrixObject(Result); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12576", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": 12586, + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8666", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:23+03:00", + "DELETE_TIME": "2024-10-09T09:20:23+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz14Y3dRbXoySnl4NlI2MHJJY09SNG1KbE9URTVENlF3aA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxNFkzZFJiWG95U25sNE5sSTJNSEpKWTA5U05HMUtiRTlVUlRWRU5sRjNhQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.i2CHa05fN9FhHCvhCTGArYmKJ24LaHa7VxRKyrHfs10%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New subfolder/New file name.jpg" + }, + "time": { + "start": 1728454825.05896, + "finish": 1728454825.12211, + "duration": 0.06315016746521, + "processing": 0.0357410907745361, + "date_start": "2024-10-09T09:20:25+03:00", + "date_finish": "2024-10-09T09:20:25+03:00", + "operating_reset_at": 1728455425, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Rename-file.md b/docs/en/md/Bitrix24/File-managment/Rename-file.md deleted file mode 100644 index aa73f14490..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Rename-file.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Rename file - Changes the name of an existing file - - - -`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Name | --title | String | New folders name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) -::: -
- - -```bsl title="Code example" - Name = "New file name.jpg"; - Filename2 = "New file name 2.jpg"; - - FileID2 = "12874"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2); - - FileID = "12876"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12576", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8666", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:02+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz0wWFJ4WFEzM0FGTTdMWlZ5WmdqRU90ZG15QVd3MlJqeQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHowd1dGSjRXRkV6TTBGR1RUZE1XbFo1V21kcVJVOTBaRzE1UVZkM01sSnFlUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.QkRL4GgBhO%2FJVenu5%2Fn%2BxllOXMyOOL1HhrapYtzpnY4%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" - }, - "time": { - "start": 1728454823.17663, - "finish": 1728454823.22042, - "duration": 0.043795108795166, - "processing": 0.0184369087219238, - "date_start": "2024-10-09T09:20:23+03:00", - "date_finish": "2024-10-09T09:20:23+03:00", - "operating_reset_at": 1728455423, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Rename-file.mdx b/docs/en/md/Bitrix24/File-managment/Rename-file.mdx new file mode 100644 index 0000000000..a9052f9f5a --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Rename-file.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Rename file + Changes the name of an existing file + + + +`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Name | --title | String | New folders name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New file name.jpg"; + Filename2 = "New file name 2.jpg"; + + FileID2 = "12874"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2); + + FileID = "12876"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12576", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8666", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:02+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz0wWFJ4WFEzM0FGTTdMWlZ5WmdqRU90ZG15QVd3MlJqeQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHowd1dGSjRXRkV6TTBGR1RUZE1XbFo1V21kcVJVOTBaRzE1UVZkM01sSnFlUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.QkRL4GgBhO%2FJVenu5%2Fn%2BxllOXMyOOL1HhrapYtzpnY4%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" + }, + "time": { + "start": 1728454823.17663, + "finish": 1728454823.22042, + "duration": 0.043795108795166, + "processing": 0.0184369087219238, + "date_start": "2024-10-09T09:20:23+03:00", + "date_finish": "2024-10-09T09:20:23+03:00", + "operating_reset_at": 1728455423, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Restore-file.md b/docs/en/md/Bitrix24/File-managment/Restore-file.md deleted file mode 100644 index 1abe7ccc71..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Restore-file.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Restore file - Restore file from recycle bin - - - -`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - FileID = "12876"; - - Result = OPI_Bitrix24.RestoreFile(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RestoreFile(URL, FileID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "12576", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8666", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:23+03:00", - "DELETE_TIME": "2024-10-09T09:20:23+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1yWnRTblhQQTRVWEFHbko5NDloNHpXSUk2WExSeTZxZQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxeVduUlRibGhRUVRSVldFRkhia281TkRsb05IcFhTVWsyV0V4U2VUWnhaUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.RFgAb1sHFNiEdYew1tNUyncR079Ttc4fGwyIy9Zn3fo%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" - }, - "time": { - "start": 1728454823.67364, - "finish": 1728454823.71091, - "duration": 0.037261962890625, - "processing": 0.00603103637695312, - "date_start": "2024-10-09T09:20:23+03:00", - "date_finish": "2024-10-09T09:20:23+03:00", - "operating_reset_at": 1728455423, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Restore-file.mdx b/docs/en/md/Bitrix24/File-managment/Restore-file.mdx new file mode 100644 index 0000000000..db0dd41a24 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Restore-file.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Restore file + Restore file from recycle bin + + + +`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + FileID = "12876"; + + Result = OPI_Bitrix24.RestoreFile(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RestoreFile(URL, FileID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "12576", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8666", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:23+03:00", + "DELETE_TIME": "2024-10-09T09:20:23+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1yWnRTblhQQTRVWEFHbko5NDloNHpXSUk2WExSeTZxZQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxeVduUlRibGhRUVRSVldFRkhia281TkRsb05IcFhTVWsyV0V4U2VUWnhaUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.RFgAb1sHFNiEdYew1tNUyncR079Ttc4fGwyIy9Zn3fo%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" + }, + "time": { + "start": 1728454823.67364, + "finish": 1728454823.71091, + "duration": 0.037261962890625, + "processing": 0.00603103637695312, + "date_start": "2024-10-09T09:20:23+03:00", + "date_finish": "2024-10-09T09:20:23+03:00", + "operating_reset_at": 1728455423, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md deleted file mode 100644 index 3d40e670f6..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Upload file to the folder - Upload local file to the folder - - - -`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | File name with extension | - | File | --file | String, BinaryData | File for upload | - | FolderID | --folderid | String | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) -::: -
- - -```bsl title="Code example" - Filename2 = "Picture2.jpg"; - Name = "Picture1.jpg"; - - Image2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Local path, URL or Binary Data - Image = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Local path, URL or Binary Data - - DestinationID = "12882"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.UploadFileToFolder(URL, Name, Image, DestinationID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12600, - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "12582", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 8674, - "SIZE": "805191", - "CREATE_TIME": "2024-10-09T09:20:27+03:00", - "UPDATE_TIME": "2024-10-09T09:20:28+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDAmXz13R0UzRTVSSkd0QjdkRG50RUlNRXFPTW9YOXY4ZDJSdQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNREFtWHoxM1IwVXpSVFZTU2tkMFFqZGtSRzUwUlVsTlJYRlBUVzlZT1hZNFpESlNkUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.Cqt7v%2BQbuicLFUvKMHOeSmN9P5txXsdUHdLBs9FfHOU%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/Picture1.jpg" - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.mdx b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.mdx new file mode 100644 index 0000000000..8603efd0ef --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Upload file to the folder + Upload local file to the folder + + + +`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | File name with extension | + | File | --file | String, BinaryData | File for upload | + | FolderID | --folderid | String | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) +::: +
+ + +```bsl title="Code example" + Filename2 = "Picture2.jpg"; + Name = "Picture1.jpg"; + + Image2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Local path, URL or Binary Data + Image = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Local path, URL or Binary Data + + DestinationID = "12882"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UploadFileToFolder(URL, Name, Image, DestinationID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12600, + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "12582", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 8674, + "SIZE": "805191", + "CREATE_TIME": "2024-10-09T09:20:27+03:00", + "UPDATE_TIME": "2024-10-09T09:20:28+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI2MDAmXz13R0UzRTVSSkd0QjdkRG50RUlNRXFPTW9YOXY4ZDJSdQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTJNREFtWHoxM1IwVXpSVFZTU2tkMFFqZGtSRzUwUlVsTlJYRlBUVzlZT1hZNFpESlNkUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.Cqt7v%2BQbuicLFUvKMHOeSmN9P5txXsdUHdLBs9FfHOU%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/Picture1.jpg" + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md deleted file mode 100644 index cc76c545e1..0000000000 --- a/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Upload file to a storage - Upload file to storage root - - - -`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | File name with extension | - | File | --file | String, BinaryData | File for upload | - | StorageID | --storageid | String | Storage id | - | Rights | --rights | String | Rights array if required | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) -::: -
- - -```bsl title="Code example" - Filename2 = "Picture2.jpg"; - Name = "Picture1.jpg"; - - Image2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Local path, URL or Binary Data - Image = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Local path, URL or Binary Data - - DestinationID = 3; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID, , Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12576, - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 8666, - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:02+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1GeUhrZmNUTWgzVEJ1b3lGVEEyUzYxbTFseTA4VjY3NA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxR2VVaHJabU5VVFdnelZFSjFiM2xHVkVFeVV6WXhiVEZzZVRBNFZqWTNOQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.HHUiQCyRcVQY8Bx6BmVGPzdZf7DZCj3Fi5m%2BCP1rcX8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" - }, - "time": { - "start": 1728454802.17105, - "finish": 1728454802.48288, - "duration": 0.311824083328247, - "processing": 0.277850151062012, - "date_start": "2024-10-09T09:20:02+03:00", - "date_finish": "2024-10-09T09:20:02+03:00", - "operating_reset_at": 1728455402, - "operating": 0.27782416343689 - } -} -``` diff --git a/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.mdx b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.mdx new file mode 100644 index 0000000000..c6f415c675 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.mdx @@ -0,0 +1,90 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Upload file to a storage + Upload file to storage root + + + +`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | File name with extension | + | File | --file | String, BinaryData | File for upload | + | StorageID | --storageid | String | Storage id | + | Rights | --rights | String | Rights array if required | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) +::: +
+ + +```bsl title="Code example" + Filename2 = "Picture2.jpg"; + Name = "Picture1.jpg"; + + Image2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Local path, URL or Binary Data + Image = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Local path, URL or Binary Data + + DestinationID = 3; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID, , Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12576, + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 8666, + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:02+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1GeUhrZmNUTWgzVEJ1b3lGVEEyUzYxbTFseTA4VjY3NA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxR2VVaHJabU5VVFdnelZFSjFiM2xHVkVFeVV6WXhiVEZzZVRBNFZqWTNOQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.HHUiQCyRcVQY8Bx6BmVGPzdZf7DZCj3Fi5m%2BCP1rcX8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" + }, + "time": { + "start": 1728454802.17105, + "finish": 1728454802.48288, + "duration": 0.311824083328247, + "processing": 0.277850151062012, + "date_start": "2024-10-09T09:20:02+03:00", + "date_finish": "2024-10-09T09:20:02+03:00", + "operating_reset_at": 1728455402, + "operating": 0.27782416343689 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md deleted file mode 100644 index 6f960d5d4e..0000000000 --- a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Add kanban stage - Add new stage of kanban or My Plan - - - -`Function AddKanbanStage(Val URL, Val Name, Val Color = "FFD800", Val PrevStageID = 0, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | New stage name | - | Color | --color | String | HEX of new stage color | - | PrevStageID | --prevstage | String, Number | ID of the stage after which a new stage should be inserted (at the beginning by default.) | - | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | - | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) -::: -
- - -```bsl title="Code example" - Name = "New stage"; - Color = "0026FF"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6); - - PrevStageID = Result["result"]; - - Name = "New stage 2"; - Color = "0026FF"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, PrevStageID, , True, Token); -``` - - - - -```json title="Result" -{ - "result": 846, - "time": { - "start": 1728454833.37133, - "finish": 1728454833.4508, - "duration": 0.0794661045074463, - "processing": 0.0516431331634522, - "date_start": "2024-10-09T09:20:33+03:00", - "date_finish": "2024-10-09T09:20:33+03:00", - "operating_reset_at": 1728455433, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.mdx b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.mdx new file mode 100644 index 0000000000..4ee6c865fb --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Add kanban stage + Add new stage of kanban or My Plan + + + +`Function AddKanbanStage(Val URL, Val Name, Val Color = "FFD800", Val PrevStageID = 0, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | New stage name | + | Color | --color | String | HEX of new stage color | + | PrevStageID | --prevstage | String, Number | ID of the stage after which a new stage should be inserted (at the beginning by default.) | + | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) +::: +
+ + +```bsl title="Code example" + Name = "New stage"; + Color = "0026FF"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6); + + PrevStageID = Result["result"]; + + Name = "New stage 2"; + Color = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, PrevStageID, , True, Token); +``` + + + + +```json title="Result" +{ + "result": 846, + "time": { + "start": 1728454833.37133, + "finish": 1728454833.4508, + "duration": 0.0794661045074463, + "processing": 0.0516431331634522, + "date_start": "2024-10-09T09:20:33+03:00", + "date_finish": "2024-10-09T09:20:33+03:00", + "operating_reset_at": 1728455433, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md deleted file mode 100644 index e77c88cb9f..0000000000 --- a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 3 ---- - -# ID of the stage to be deleted - Removes a kanban (My Plan) stage, provided there are no tasks in it - - - -`Function DeleteKanbanStage(Val URL, Val StageID, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StageID | --stage | String, Number | ID of stage to dele | - | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) -::: -
- - -```bsl title="Code example" - StageID = "864"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True); - - StageID = "866"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, , Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454834.86052, - "finish": 1728454834.90096, - "duration": 0.0404388904571533, - "processing": 0.00777482986450195, - "date_start": "2024-10-09T09:20:34+03:00", - "date_finish": "2024-10-09T09:20:34+03:00", - "operating_reset_at": 1728455434, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.mdx b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.mdx new file mode 100644 index 0000000000..bcddf3431c --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# ID of the stage to be deleted + Removes a kanban (My Plan) stage, provided there are no tasks in it + + + +`Function DeleteKanbanStage(Val URL, Val StageID, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StageID | --stage | String, Number | ID of stage to dele | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) +::: +
+ + +```bsl title="Code example" + StageID = "864"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True); + + StageID = "866"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, , Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454834.86052, + "finish": 1728454834.90096, + "duration": 0.0404388904571533, + "processing": 0.00777482986450195, + "date_start": "2024-10-09T09:20:34+03:00", + "date_finish": "2024-10-09T09:20:34+03:00", + "operating_reset_at": 1728455434, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md deleted file mode 100644 index b8fa605d72..0000000000 --- a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get kanban stages - Get kanban (My Plan) stages info - - - -`Function GetKanbanStages(Val URL, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | - | AsAdmin | --admin | Boolean | Allows you to get stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetKanbanStages(URL, , True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetKanbanStages(URL, , , Token); -``` - - - - -```json title="Result" -{ - "result": { - "142": { - "ID": "142", - "TITLE": "Новое имя стадии стадии", - "SORT": "100", - "COLOR": "000000", - "SYSTEM_TYPE": "NEW", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "20": { - "ID": "20", - "TITLE": "Новая стадия", - "SORT": "200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "24": { - "ID": "24", - "TITLE": "Название", - "SORT": "300", - "COLOR": "75d900", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "16": { - "ID": "16", - "TITLE": "Новая стадия", - "SORT": "400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "18": { - "ID": "18", - "TITLE": "Новая стадия 2", - "SORT": "500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "12": { - "ID": "12", - "TITLE": "Новая стадия", - "SORT": "600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "14": { - "ID": "14", - "TITLE": "Новая стадия 2", - "SORT": "700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "8": { - "ID": "8", - "TITLE": "Новая стадия", - "SORT": "800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "10": { - "ID": "10", - "TITLE": "Новая стадия 2", - "SORT": "900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "6": { - "ID": "6", - "TITLE": "Новая стадия", - "SORT": "1000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "844": { - "ID": "844", - "TITLE": "New stage", - "SORT": "1100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "846": { - "ID": "846", - "TITLE": "New stage 2", - "SORT": "1200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "720": { - "ID": "720", - "TITLE": "Новая стадия", - "SORT": "1300", -... -``` diff --git a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.mdx b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.mdx new file mode 100644 index 0000000000..5733b0de80 --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.mdx @@ -0,0 +1,199 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get kanban stages + Get kanban (My Plan) stages info + + + +`Function GetKanbanStages(Val URL, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | + | AsAdmin | --admin | Boolean | Allows you to get stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetKanbanStages(URL, , True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetKanbanStages(URL, , , Token); +``` + + + + +```json title="Result" +{ + "result": { + "142": { + "ID": "142", + "TITLE": "Новое имя стадии стадии", + "SORT": "100", + "COLOR": "000000", + "SYSTEM_TYPE": "NEW", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "20": { + "ID": "20", + "TITLE": "Новая стадия", + "SORT": "200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "24": { + "ID": "24", + "TITLE": "Название", + "SORT": "300", + "COLOR": "75d900", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "16": { + "ID": "16", + "TITLE": "Новая стадия", + "SORT": "400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "18": { + "ID": "18", + "TITLE": "Новая стадия 2", + "SORT": "500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "12": { + "ID": "12", + "TITLE": "Новая стадия", + "SORT": "600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "14": { + "ID": "14", + "TITLE": "Новая стадия 2", + "SORT": "700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "8": { + "ID": "8", + "TITLE": "Новая стадия", + "SORT": "800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "10": { + "ID": "10", + "TITLE": "Новая стадия 2", + "SORT": "900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "6": { + "ID": "6", + "TITLE": "Новая стадия", + "SORT": "1000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "844": { + "ID": "844", + "TITLE": "New stage", + "SORT": "1100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "846": { + "ID": "846", + "TITLE": "New stage 2", + "SORT": "1200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "720": { + "ID": "720", + "TITLE": "Новая стадия", + "SORT": "1300", +... +``` diff --git a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md deleted file mode 100644 index aa2a711200..0000000000 --- a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Move task to kanban stage - Move task to another kanban stage - - - -`Function MoveTaskToKanbanStage(Val URL, Val TaskID, Val StageID, Val Prev = 0, Val After = 0, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | ID of task to move | - | StageID | --stage | String, Number | Stage ID | - | Prev | --before | String, Number | ID of the task to put the selected one in front of (if After not filled) | - | After | --after | String, Number | ID of the task to be followed by the selected (if Prev not filled) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) -::: -
- - -```bsl title="Code example" - TaskID = "2452"; - StageID = "864"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID); - - StageID = "866"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID, , , Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454833.97698, - "finish": 1728454834.02471, - "duration": 0.047731876373291, - "processing": 0.0173599720001221, - "date_start": "2024-10-09T09:20:33+03:00", - "date_finish": "2024-10-09T09:20:34+03:00", - "operating_reset_at": 1728455434, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.mdx b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.mdx new file mode 100644 index 0000000000..2bf21f58cd --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Move task to kanban stage + Move task to another kanban stage + + + +`Function MoveTaskToKanbanStage(Val URL, Val TaskID, Val StageID, Val Prev = 0, Val After = 0, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task to move | + | StageID | --stage | String, Number | Stage ID | + | Prev | --before | String, Number | ID of the task to put the selected one in front of (if After not filled) | + | After | --after | String, Number | ID of the task to be followed by the selected (if Prev not filled) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) +::: +
+ + +```bsl title="Code example" + TaskID = "2452"; + StageID = "864"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID); + + StageID = "866"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID, , , Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454833.97698, + "finish": 1728454834.02471, + "duration": 0.047731876373291, + "processing": 0.0173599720001221, + "date_start": "2024-10-09T09:20:33+03:00", + "date_finish": "2024-10-09T09:20:34+03:00", + "operating_reset_at": 1728455434, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md deleted file mode 100644 index 332e8f925a..0000000000 --- a/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Change kanban stage - Changes the properties of the existing kanban or My plan stage - - - -`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | New stages name | - | StageID | --stage | String, Number | Stage ID for change | - | Color | --color | String | HEX of new stage color | - | PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted | - | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) -::: -
- - -```bsl title="Code example" - Name = "New stage name"; - Color = "000000"; - StageID = "864"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color); - - Name = "New stage name 2"; - Color = "000000"; - StageID = "866"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454834.3617, - "finish": 1728454834.44785, - "duration": 0.0861501693725586, - "processing": 0.0561039447784424, - "date_start": "2024-10-09T09:20:34+03:00", - "date_finish": "2024-10-09T09:20:34+03:00", - "operating_reset_at": 1728455434, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.mdx b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.mdx new file mode 100644 index 0000000000..d64bac0740 --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Change kanban stage + Changes the properties of the existing kanban or My plan stage + + + +`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | New stages name | + | StageID | --stage | String, Number | Stage ID for change | + | Color | --color | String | HEX of new stage color | + | PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) +::: +
+ + +```bsl title="Code example" + Name = "New stage name"; + Color = "000000"; + StageID = "864"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color); + + Name = "New stage name 2"; + Color = "000000"; + StageID = "866"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454834.3617, + "finish": 1728454834.44785, + "duration": 0.0861501693725586, + "processing": 0.0561039447784424, + "date_start": "2024-10-09T09:20:34+03:00", + "date_finish": "2024-10-09T09:20:34+03:00", + "operating_reset_at": 1728455434, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Create-lead.md b/docs/en/md/Bitrix24/Leads-managment/Create-lead.md deleted file mode 100644 index bcdeeb6705..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Create-lead.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create lead - Creates a new lead by fields structure (see GetLeadStructure) - - - -`Function CreateLead(Val URL, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldsStructure | --fields | Structure of KeyAndValue | Lead fields structure (see GetLeadStructure) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.lead.add](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_add.php) -::: -
- - -```bsl title="Code example" - EmailsArray = New Array; - EmailsArray.Add(New Structure("VALUE,VALUE_TYPE", "yo@example.com", "HOME")); - EmailsArray.Add(New Structure("VALUE,VALUE_TYPE", "hi@example.com", "WORK")); - - PhonesArray = New Array; - PhonesArray.Add(New Structure("VALUE,VALUE_TYPE", "88005553535", "WORK")); - - FieldsStructure = New Structure; - FieldsStructure.Insert("ADDRESS" , "Pushkin st., b. 10"); - FieldsStructure.Insert("ADDRESS_COUNTRY", "Russia"); - FieldsStructure.Insert("EMAIL" , EmailsArray); - FieldsStructure.Insert("NAME" , "John"); - FieldsStructure.Insert("LAST_NAME" , "Doe"); - FieldsStructure.Insert("PHONE" , PhonesArray); - FieldsStructure.Insert("TITLE" , "MegaClient"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateLead(URL, FieldsStructure); - - FieldsStructure.Insert("NAME" , "Ivan"); - FieldsStructure.Insert("LAST_NAME" , "Ivanov"); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateLead(URL, FieldsStructure, Token); -``` - - - - -```json title="Result" -{ - "result": 394, - "time": { - "start": 1728454941.45396, - "finish": 1728454942.16614, - "duration": 0.712172985076904, - "processing": 0.685149908065796, - "date_start": "2024-10-09T09:22:21+03:00", - "date_finish": "2024-10-09T09:22:22+03:00", - "operating_reset_at": 1728455541, - "operating": 0.685086011886597 - } -} -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Create-lead.mdx b/docs/en/md/Bitrix24/Leads-managment/Create-lead.mdx new file mode 100644 index 0000000000..85630a19eb --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Create-lead.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create lead + Creates a new lead by fields structure (see GetLeadStructure) + + + +`Function CreateLead(Val URL, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldsStructure | --fields | Structure of KeyAndValue | Lead fields structure (see GetLeadStructure) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.lead.add](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_add.php) +::: +
+ + +```bsl title="Code example" + EmailsArray = New Array; + EmailsArray.Add(New Structure("VALUE,VALUE_TYPE", "yo@example.com", "HOME")); + EmailsArray.Add(New Structure("VALUE,VALUE_TYPE", "hi@example.com", "WORK")); + + PhonesArray = New Array; + PhonesArray.Add(New Structure("VALUE,VALUE_TYPE", "88005553535", "WORK")); + + FieldsStructure = New Structure; + FieldsStructure.Insert("ADDRESS" , "Pushkin st., b. 10"); + FieldsStructure.Insert("ADDRESS_COUNTRY", "Russia"); + FieldsStructure.Insert("EMAIL" , EmailsArray); + FieldsStructure.Insert("NAME" , "John"); + FieldsStructure.Insert("LAST_NAME" , "Doe"); + FieldsStructure.Insert("PHONE" , PhonesArray); + FieldsStructure.Insert("TITLE" , "MegaClient"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateLead(URL, FieldsStructure); + + FieldsStructure.Insert("NAME" , "Ivan"); + FieldsStructure.Insert("LAST_NAME" , "Ivanov"); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateLead(URL, FieldsStructure, Token); +``` + + + + +```json title="Result" +{ + "result": 394, + "time": { + "start": 1728454941.45396, + "finish": 1728454942.16614, + "duration": 0.712172985076904, + "processing": 0.685149908065796, + "date_start": "2024-10-09T09:22:21+03:00", + "date_finish": "2024-10-09T09:22:22+03:00", + "operating_reset_at": 1728455541, + "operating": 0.685086011886597 + } +} +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Delete-lead.md b/docs/en/md/Bitrix24/Leads-managment/Delete-lead.md deleted file mode 100644 index 3e630bc585..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Delete-lead.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Delete lead - Deletes a lead by ID - - - -`Function DeleteLead(Val URL, Val LeadID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | LeadID | --lead | Number, String | Lead ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.lead.delete](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - LeadID = "412"; - - Result = OPI_Bitrix24.DeleteLead(URL, LeadID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - LeadID = "414"; - - Result = OPI_Bitrix24.DeleteLead(URL, LeadID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454943.26955, - "finish": 1728454943.58409, - "duration": 0.314532041549683, - "processing": 0.281855821609497, - "date_start": "2024-10-09T09:22:23+03:00", - "date_finish": "2024-10-09T09:22:23+03:00", - "operating_reset_at": 1728455543, - "operating": 0.281836032867432 - } -} -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Delete-lead.mdx b/docs/en/md/Bitrix24/Leads-managment/Delete-lead.mdx new file mode 100644 index 0000000000..8af2dc2fc1 --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Delete-lead.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Delete lead + Deletes a lead by ID + + + +`Function DeleteLead(Val URL, Val LeadID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | LeadID | --lead | Number, String | Lead ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.lead.delete](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + LeadID = "412"; + + Result = OPI_Bitrix24.DeleteLead(URL, LeadID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + LeadID = "414"; + + Result = OPI_Bitrix24.DeleteLead(URL, LeadID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454943.26955, + "finish": 1728454943.58409, + "duration": 0.314532041549683, + "processing": 0.281855821609497, + "date_start": "2024-10-09T09:22:23+03:00", + "date_finish": "2024-10-09T09:22:23+03:00", + "operating_reset_at": 1728455543, + "operating": 0.281836032867432 + } +} +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-lead-filter-structure.md b/docs/en/md/Bitrix24/Leads-managment/Get-lead-filter-structure.md deleted file mode 100644 index 7d6d85d67c..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Get-lead-filter-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get lead filter structure - Returns the field structure for filtering leads in the GetLeadsList method - - - -`Function GetLeadFilterStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Bitrix24.GetLeadFilterStructure(); -``` - - - - -```json title="Result" -{ - "ID": "", - "ASSIGNED_BY_ID": "", - "COMPANY_ID": "", - "COMPANY_TITLE": "", - "CONTACT_ID": "", - "CREATED_BY_ID": "", - "CURRENCY_ID": "", - "DATE_CLOSED": "", - "DATE_CREATE": "", - "DATE_MODIFY": "", - "EMAIL": "", - "HAS_EMAIL": "", - "HAS_PHONE": "", - "IS_RETURN_CUSTOMER": "", - "MODIFY_BY_ID": "", - "MOVED_BY_ID": "", - "MOVED_TIME": "", - "OPENED": "", - "OPPORTUNITY": "", - "STATUS_ID": "", - "TITLE": "" -} -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-lead-filter-structure.mdx b/docs/en/md/Bitrix24/Leads-managment/Get-lead-filter-structure.mdx new file mode 100644 index 0000000000..4755f3d39d --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Get-lead-filter-structure.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get lead filter structure + Returns the field structure for filtering leads in the GetLeadsList method + + + +`Function GetLeadFilterStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Bitrix24.GetLeadFilterStructure(); +``` + + + + +```json title="Result" +{ + "ID": "", + "ASSIGNED_BY_ID": "", + "COMPANY_ID": "", + "COMPANY_TITLE": "", + "CONTACT_ID": "", + "CREATED_BY_ID": "", + "CURRENCY_ID": "", + "DATE_CLOSED": "", + "DATE_CREATE": "", + "DATE_MODIFY": "", + "EMAIL": "", + "HAS_EMAIL": "", + "HAS_PHONE": "", + "IS_RETURN_CUSTOMER": "", + "MODIFY_BY_ID": "", + "MOVED_BY_ID": "", + "MOVED_TIME": "", + "OPENED": "", + "OPPORTUNITY": "", + "STATUS_ID": "", + "TITLE": "" +} +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.md b/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.md deleted file mode 100644 index 22464ee59b..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get lead structure - Gets a structure with field descriptions for creating a lead - - - -`Function GetLeadStructure(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.lead.fields](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_fields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetLeadStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetLeadStructure(URL, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": { - "type": "integer", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "ID" - }, - "TITLE": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Название лида" - }, - "HONORIFIC": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "HONORIFIC", - "title": "Обращение" - }, - "NAME": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Имя" - }, - "SECOND_NAME": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Отчество" - }, - "LAST_NAME": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Фамилия" - }, - "BIRTHDATE": { - "type": "date", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Дата рождения" - }, - "COMPANY_TITLE": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Название компании" - }, - "SOURCE_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "SOURCE", - "title": "Источник" - }, - "SOURCE_DESCRIPTION": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Дополнительно об источнике" - }, - "STATUS_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "STATUS", - "title": "Стадия" - }, - "STATUS_DESCRIPTION": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Дополнительно о стадии" - }, - "STATUS_SEMANTIC_ID": { - "type": "string", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Состояние статуса" - }, - "POST": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Должность" - }, - "ADDRESS": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Адрес" - }, - "ADDRESS_2": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Адрес (стр. 2)" - }, - "ADDRESS_CITY": { -... -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.mdx b/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.mdx new file mode 100644 index 0000000000..95e5450c39 --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Get-lead-structure.mdx @@ -0,0 +1,197 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get lead structure + Gets a structure with field descriptions for creating a lead + + + +`Function GetLeadStructure(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.lead.fields](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_fields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetLeadStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetLeadStructure(URL, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": { + "type": "integer", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "ID" + }, + "TITLE": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Название лида" + }, + "HONORIFIC": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "HONORIFIC", + "title": "Обращение" + }, + "NAME": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Имя" + }, + "SECOND_NAME": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Отчество" + }, + "LAST_NAME": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Фамилия" + }, + "BIRTHDATE": { + "type": "date", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Дата рождения" + }, + "COMPANY_TITLE": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Название компании" + }, + "SOURCE_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "SOURCE", + "title": "Источник" + }, + "SOURCE_DESCRIPTION": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Дополнительно об источнике" + }, + "STATUS_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "STATUS", + "title": "Стадия" + }, + "STATUS_DESCRIPTION": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Дополнительно о стадии" + }, + "STATUS_SEMANTIC_ID": { + "type": "string", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Состояние статуса" + }, + "POST": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Должность" + }, + "ADDRESS": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Адрес" + }, + "ADDRESS_2": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Адрес (стр. 2)" + }, + "ADDRESS_CITY": { +... +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-lead.md b/docs/en/md/Bitrix24/Leads-managment/Get-lead.md deleted file mode 100644 index 70f3cf21df..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Get-lead.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get lead - Gets a lead by ID - - - -`Function GetLead(Val URL, Val LeadID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | LeadID | --lead | Number, String | Lead ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.lead.get](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - LeadID = "412"; - - Result = OPI_Bitrix24.GetLead(URL, LeadID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - LeadID = "414"; - - Result = OPI_Bitrix24.GetLead(URL, LeadID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "394", - "TITLE": "MegaClient", - "HONORIFIC": null, - "NAME": "Ivan", - "SECOND_NAME": null, - "LAST_NAME": "Ivanov", - "COMPANY_TITLE": null, - "COMPANY_ID": null, - "CONTACT_ID": "394", - "IS_RETURN_CUSTOMER": "N", - "BIRTHDATE": "", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "STATUS_ID": "CONVERTED", - "STATUS_DESCRIPTION": null, - "POST": null, - "COMMENTS": null, - "CURRENCY_ID": "BYN", - "OPPORTUNITY": "0.00", - "IS_MANUAL_OPPORTUNITY": "N", - "HAS_PHONE": "Y", - "HAS_EMAIL": "Y", - "HAS_IMOL": "N", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-10-09T09:22:21+03:00", - "DATE_MODIFY": "2024-10-09T09:22:22+03:00", - "DATE_CLOSED": "2024-10-09T09:22:22+03:00", - "STATUS_SEMANTIC_ID": "S", - "OPENED": "N", - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-10-09T09:22:22+03:00", - "ADDRESS": "Pushkin st., b. 10", - "ADDRESS_2": null, - "ADDRESS_CITY": null, - "ADDRESS_POSTAL_CODE": null, - "ADDRESS_REGION": null, - "ADDRESS_PROVINCE": null, - "ADDRESS_COUNTRY": "Russia", - "ADDRESS_COUNTRY_CODE": null, - "ADDRESS_LOC_ADDR_ID": "790", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1", - "LAST_ACTIVITY_TIME": "2024-10-09T09:22:21+03:00", - "EMAIL": [ - { - "ID": "2338", - "VALUE_TYPE": "HOME", - "VALUE": "yo@example.com", - "TYPE_ID": "EMAIL" - }, - { - "ID": "2340", - "VALUE_TYPE": "WORK", - "VALUE": "hi@example.com", - "TYPE_ID": "EMAIL" - } - ], - "PHONE": [ - { - "ID": "2342", - "VALUE_TYPE": "WORK", - "VALUE": "88005553535", - "TYPE_ID": "PHONE" - } - ] - }, - "time": { - "start": 1728454942.34032, - "finish": 1728454942.39366, - "duration": 0.0533421039581299, - "processing": 0.0224511623382568, - "date_start": "2024-10-09T09:22:22+03:00", - "date_finish": "2024-10-09T09:22:22+03:00", - "operating_reset_at": 1728455542, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-lead.mdx b/docs/en/md/Bitrix24/Leads-managment/Get-lead.mdx new file mode 100644 index 0000000000..1481018a07 --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Get-lead.mdx @@ -0,0 +1,136 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get lead + Gets a lead by ID + + + +`Function GetLead(Val URL, Val LeadID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | LeadID | --lead | Number, String | Lead ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.lead.get](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + LeadID = "412"; + + Result = OPI_Bitrix24.GetLead(URL, LeadID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + LeadID = "414"; + + Result = OPI_Bitrix24.GetLead(URL, LeadID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "394", + "TITLE": "MegaClient", + "HONORIFIC": null, + "NAME": "Ivan", + "SECOND_NAME": null, + "LAST_NAME": "Ivanov", + "COMPANY_TITLE": null, + "COMPANY_ID": null, + "CONTACT_ID": "394", + "IS_RETURN_CUSTOMER": "N", + "BIRTHDATE": "", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "STATUS_ID": "CONVERTED", + "STATUS_DESCRIPTION": null, + "POST": null, + "COMMENTS": null, + "CURRENCY_ID": "BYN", + "OPPORTUNITY": "0.00", + "IS_MANUAL_OPPORTUNITY": "N", + "HAS_PHONE": "Y", + "HAS_EMAIL": "Y", + "HAS_IMOL": "N", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-10-09T09:22:21+03:00", + "DATE_MODIFY": "2024-10-09T09:22:22+03:00", + "DATE_CLOSED": "2024-10-09T09:22:22+03:00", + "STATUS_SEMANTIC_ID": "S", + "OPENED": "N", + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-10-09T09:22:22+03:00", + "ADDRESS": "Pushkin st., b. 10", + "ADDRESS_2": null, + "ADDRESS_CITY": null, + "ADDRESS_POSTAL_CODE": null, + "ADDRESS_REGION": null, + "ADDRESS_PROVINCE": null, + "ADDRESS_COUNTRY": "Russia", + "ADDRESS_COUNTRY_CODE": null, + "ADDRESS_LOC_ADDR_ID": "790", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1", + "LAST_ACTIVITY_TIME": "2024-10-09T09:22:21+03:00", + "EMAIL": [ + { + "ID": "2338", + "VALUE_TYPE": "HOME", + "VALUE": "yo@example.com", + "TYPE_ID": "EMAIL" + }, + { + "ID": "2340", + "VALUE_TYPE": "WORK", + "VALUE": "hi@example.com", + "TYPE_ID": "EMAIL" + } + ], + "PHONE": [ + { + "ID": "2342", + "VALUE_TYPE": "WORK", + "VALUE": "88005553535", + "TYPE_ID": "PHONE" + } + ] + }, + "time": { + "start": 1728454942.34032, + "finish": 1728454942.39366, + "duration": 0.0533421039581299, + "processing": 0.0224511623382568, + "date_start": "2024-10-09T09:22:22+03:00", + "date_finish": "2024-10-09T09:22:22+03:00", + "operating_reset_at": 1728455542, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-leads-list.md b/docs/en/md/Bitrix24/Leads-managment/Get-leads-list.md deleted file mode 100644 index 4e2345af75..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Get-leads-list.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get leads list - Gets a list of leads (50 per request max) with or without filtering (see GetLeadFilterStructure) - - - -`Function GetLeadsList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Filter | --filter | Structure of KeyAndValue | Lead filter structure (see GetLeadFilterStructure) | - | Indent | --offset | Number, String | Offset from the beginning of the list to get leads > 50 recursively | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.lead.list](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_list.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetLeadsList(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Filter = New Structure; - Filter.Insert("TITLE" , "MegaClient"); - Filter.Insert("HAS_EMAIL", "Y"); - - Result = OPI_Bitrix24.GetLeadsList(URL, Filter, , Token); -``` - - - - -```json title="Result" -{ - "result": [], - "total": 0, - "time": { - "start": 1728454939.89873, - "finish": 1728454939.94382, - "duration": 0.0450830459594727, - "processing": 0.0179238319396973, - "date_start": "2024-10-09T09:22:19+03:00", - "date_finish": "2024-10-09T09:22:19+03:00", - "operating_reset_at": 1728455539, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Get-leads-list.mdx b/docs/en/md/Bitrix24/Leads-managment/Get-leads-list.mdx new file mode 100644 index 0000000000..c196b1efac --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Get-leads-list.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get leads list + Gets a list of leads (50 per request max) with or without filtering (see GetLeadFilterStructure) + + + +`Function GetLeadsList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Filter | --filter | Structure of KeyAndValue | Lead filter structure (see GetLeadFilterStructure) | + | Indent | --offset | Number, String | Offset from the beginning of the list to get leads > 50 recursively | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.lead.list](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_list.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetLeadsList(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Filter = New Structure; + Filter.Insert("TITLE" , "MegaClient"); + Filter.Insert("HAS_EMAIL", "Y"); + + Result = OPI_Bitrix24.GetLeadsList(URL, Filter, , Token); +``` + + + + +```json title="Result" +{ + "result": [], + "total": 0, + "time": { + "start": 1728454939.89873, + "finish": 1728454939.94382, + "duration": 0.0450830459594727, + "processing": 0.0179238319396973, + "date_start": "2024-10-09T09:22:19+03:00", + "date_finish": "2024-10-09T09:22:19+03:00", + "operating_reset_at": 1728455539, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Update-lead.md b/docs/en/md/Bitrix24/Leads-managment/Update-lead.md deleted file mode 100644 index ac6b5c3ffe..0000000000 --- a/docs/en/md/Bitrix24/Leads-managment/Update-lead.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Update lead - Modifies an existing lead - - - -`Function UpdateLead(Val URL, Val LeadID, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | LeadID | --lead | Number, String | Lead ID | - | FieldsStructure | --fields | Structure of KeyAndValue | Structure of lead fields | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [crm.lead.update](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_update.php) -::: -
- - -```bsl title="Code example" - FieldsStructure = New Structure; - FieldsStructure.Insert("ADDRESS" , "Lermontov st., b. 20"); - FieldsStructure.Insert("ADDRESS_COUNTRY", "Belarus"); - FieldsStructure.Insert("TITLE" , "SuperClient"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - LeadID = "412"; - - Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure); - - FieldsStructure.Insert("NAME" , "Evgeniy"); - FieldsStructure.Insert("LAST_NAME" , "Evgeniev"); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - LeadID = "414"; - - Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454942.70493, - "finish": 1728454942.90789, - "duration": 0.202960014343262, - "processing": 0.174932956695557, - "date_start": "2024-10-09T09:22:22+03:00", - "date_finish": "2024-10-09T09:22:22+03:00", - "operating_reset_at": 1728455542, - "operating": 0.17490816116333 - } -} -``` diff --git a/docs/en/md/Bitrix24/Leads-managment/Update-lead.mdx b/docs/en/md/Bitrix24/Leads-managment/Update-lead.mdx new file mode 100644 index 0000000000..e158e53441 --- /dev/null +++ b/docs/en/md/Bitrix24/Leads-managment/Update-lead.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Update lead + Modifies an existing lead + + + +`Function UpdateLead(Val URL, Val LeadID, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | LeadID | --lead | Number, String | Lead ID | + | FieldsStructure | --fields | Structure of KeyAndValue | Structure of lead fields | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [crm.lead.update](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_update.php) +::: +
+ + +```bsl title="Code example" + FieldsStructure = New Structure; + FieldsStructure.Insert("ADDRESS" , "Lermontov st., b. 20"); + FieldsStructure.Insert("ADDRESS_COUNTRY", "Belarus"); + FieldsStructure.Insert("TITLE" , "SuperClient"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + LeadID = "412"; + + Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure); + + FieldsStructure.Insert("NAME" , "Evgeniy"); + FieldsStructure.Insert("LAST_NAME" , "Evgeniev"); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + LeadID = "414"; + + Result = OPI_Bitrix24.UpdateLead(URL, LeadID, FieldsStructure, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454942.70493, + "finish": 1728454942.90789, + "duration": 0.202960014343262, + "processing": 0.174932956695557, + "date_start": "2024-10-09T09:22:22+03:00", + "date_finish": "2024-10-09T09:22:22+03:00", + "operating_reset_at": 1728455542, + "operating": 0.17490816116333 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Delete-message.md b/docs/en/md/Bitrix24/Message-management/Delete-message.md deleted file mode 100644 index 3cf87c03d7..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Delete-message.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete message - Deletes a dialog message - - - -`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | MessageID | --message | String, Number | ID of the message to be deleted | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - MessageID = "18126"; - - Result = OPI_Bitrix24.DeleteMessage(URL, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - MessageID = "18128"; - - Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454910.86292, - "finish": 1728454910.9161, - "duration": 0.0531799793243408, - "processing": 0.0238890647888184, - "date_start": "2024-10-09T09:21:50+03:00", - "date_finish": "2024-10-09T09:21:50+03:00", - "operating_reset_at": 1728455510, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Delete-message.mdx b/docs/en/md/Bitrix24/Message-management/Delete-message.mdx new file mode 100644 index 0000000000..0497ce3f4f --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Delete-message.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete message + Deletes a dialog message + + + +`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | ID of the message to be deleted | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + MessageID = "18126"; + + Result = OPI_Bitrix24.DeleteMessage(URL, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + MessageID = "18128"; + + Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454910.86292, + "finish": 1728454910.9161, + "duration": 0.0531799793243408, + "processing": 0.0238890647888184, + "date_start": "2024-10-09T09:21:50+03:00", + "date_finish": "2024-10-09T09:21:50+03:00", + "operating_reset_at": 1728455510, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Edit-message.md b/docs/en/md/Bitrix24/Message-management/Edit-message.md deleted file mode 100644 index b45e0b22f3..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Edit-message.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Edit message - Edit dialog message content - - - -`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | MessageID | --message | String, Number | ID of the message to be edited | - | Text | --text | String | New message text | - | Attachments | --blocks | Array of Structure | New blocks array | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - MessageID = "18126"; - - Text = "New message text"; - - Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - MessageID = "18128"; - - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); - - Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454905.42381, - "finish": 1728454905.4791, - "duration": 0.0552828311920166, - "processing": 0.0245981216430664, - "date_start": "2024-10-09T09:21:45+03:00", - "date_finish": "2024-10-09T09:21:45+03:00", - "operating_reset_at": 1728455505, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Edit-message.mdx b/docs/en/md/Bitrix24/Message-management/Edit-message.mdx new file mode 100644 index 0000000000..7b7fd6ffca --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Edit-message.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Edit message + Edit dialog message content + + + +`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | ID of the message to be edited | + | Text | --text | String | New message text | + | Attachments | --blocks | Array of Structure | New blocks array | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + MessageID = "18126"; + + Text = "New message text"; + + Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + MessageID = "18128"; + + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); + + Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454905.42381, + "finish": 1728454905.4791, + "duration": 0.0552828311920166, + "processing": 0.0245981216430664, + "date_start": "2024-10-09T09:21:45+03:00", + "date_finish": "2024-10-09T09:21:45+03:00", + "operating_reset_at": 1728455505, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Get-file-block.md b/docs/en/md/Bitrix24/Message-management/Get-file-block.md deleted file mode 100644 index f28a00bfac..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Get-file-block.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Get file block - Make file block for SendMessage method - - - -`Function GetFileBlock(Val Name, Val URL) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Picture name | - | URL | --url | String | File URL | - - - Returns: Structure - FileBlock - -
- -:::tip -Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - -```bsl title="Code example" - Name = "Image"; - URL = "https://api.athenaeum.digital/test_data/document.docx"; - - Result = OPI_Bitrix24.GetFileBlock(Name, URL); -``` - - - - -```json title="Result" -{ - "FILE": { - "NAME": "Image", - "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Get-file-block.mdx b/docs/en/md/Bitrix24/Message-management/Get-file-block.mdx new file mode 100644 index 0000000000..3a54d3ad42 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Get-file-block.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Get file block + Make file block for SendMessage method + + + +`Function GetFileBlock(Val Name, Val URL) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Picture name | + | URL | --url | String | File URL | + + + Returns: Structure - FileBlock + +
+ +:::tip +Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + +```bsl title="Code example" + Name = "Image"; + URL = "https://api.athenaeum.digital/test_data/document.docx"; + + Result = OPI_Bitrix24.GetFileBlock(Name, URL); +``` + + + + +```json title="Result" +{ + "FILE": { + "NAME": "Image", + "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Get-picture-block.md b/docs/en/md/Bitrix24/Message-management/Get-picture-block.md deleted file mode 100644 index 84d81a5535..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Get-picture-block.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get picture block - Make picture block for SendMessage method - - - -`Function GetPictureBlock(Val Name, Val URL) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Picture name | - | URL | --url | String | URL of sending picture | - - - Returns: Structure - PictureBlock - -
- -:::tip -Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - -```bsl title="Code example" - Name = "Image"; - URL = "https://api.athenaeum.digital/test_data/picture.jpg"; - - Result = OPI_Bitrix24.GetPictureBlock(Name, URL); -``` - - - - -```json title="Result" -{ - "IMAGE": { - "NAME": "Image", - "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Get-picture-block.mdx b/docs/en/md/Bitrix24/Message-management/Get-picture-block.mdx new file mode 100644 index 0000000000..55ea0c7933 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Get-picture-block.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get picture block + Make picture block for SendMessage method + + + +`Function GetPictureBlock(Val Name, Val URL) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Picture name | + | URL | --url | String | URL of sending picture | + + + Returns: Structure - PictureBlock + +
+ +:::tip +Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + +```bsl title="Code example" + Name = "Image"; + URL = "https://api.athenaeum.digital/test_data/picture.jpg"; + + Result = OPI_Bitrix24.GetPictureBlock(Name, URL); +``` + + + + +```json title="Result" +{ + "IMAGE": { + "NAME": "Image", + "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md deleted file mode 100644 index af25593b0f..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Mark message as readed - Mark current and all previous messages as readed - - - -`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | MessageID | --message | String, Number | Id of last readed message | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat" + "1006"; - MessageID = "18126"; - - Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - MessageID = "18128"; - - Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "dialogId": 10, - "chatId": 10, - "lastId": 17682, - "counter": 0 - }, - "time": { - "start": 1728454899.00309, - "finish": 1728454899.04547, - "duration": 0.0423820018768311, - "processing": 0.0175080299377441, - "date_start": "2024-10-09T09:21:39+03:00", - "date_finish": "2024-10-09T09:21:39+03:00", - "operating_reset_at": 1728455499, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.mdx b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.mdx new file mode 100644 index 0000000000..aaed1bd512 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Mark message as readed + Mark current and all previous messages as readed + + + +`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | MessageID | --message | String, Number | Id of last readed message | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat" + "1006"; + MessageID = "18126"; + + Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + MessageID = "18128"; + + Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "dialogId": 10, + "chatId": 10, + "lastId": 17682, + "counter": 0 + }, + "time": { + "start": 1728454899.00309, + "finish": 1728454899.04547, + "duration": 0.0423820018768311, + "processing": 0.0175080299377441, + "date_start": "2024-10-09T09:21:39+03:00", + "date_finish": "2024-10-09T09:21:39+03:00", + "operating_reset_at": 1728455499, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md deleted file mode 100644 index c1c213594e..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Mark message as unreaded - Mark current and all messages after as unreaded - - - -`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | MessageID | --message | String, Number | ID of last unreaded message | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat" + "1006"; - MessageID = "18126"; - - Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - MessageID = "18128"; - - Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454899.19949, - "finish": 1728454899.27714, - "duration": 0.0776529312133789, - "processing": 0.0525820255279541, - "date_start": "2024-10-09T09:21:39+03:00", - "date_finish": "2024-10-09T09:21:39+03:00", - "operating_reset_at": 1728455499, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.mdx b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.mdx new file mode 100644 index 0000000000..01a6af0b0d --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Mark message as unreaded + Mark current and all messages after as unreaded + + + +`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | MessageID | --message | String, Number | ID of last unreaded message | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat" + "1006"; + MessageID = "18126"; + + Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + MessageID = "18128"; + + Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454899.19949, + "finish": 1728454899.27714, + "duration": 0.0776529312133789, + "processing": 0.0525820255279541, + "date_start": "2024-10-09T09:21:39+03:00", + "date_finish": "2024-10-09T09:21:39+03:00", + "operating_reset_at": 1728455499, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-file.md b/docs/en/md/Bitrix24/Message-management/Send-file.md deleted file mode 100644 index 0174f571ee..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Send-file.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Send file - Send disk file to chat - - - -`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | FileID | --fileid | String, Number | File ID from UploadFileToFolder method | - | Description | --description | String | File description | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "1006"; - File = "https://api.athenaeum.digital/test_data/document.docx"; // Binary Data, URL or path to file - Description = "Very important file"; - - Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); - FolderID = Directory["result"]["ID"]; - - UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID); - FileID = UploadedFile["result"]["ID"]; - - Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - ChatID = "1008"; - - Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); - FolderID = Directory["result"]["ID"]; - - UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token); - FileID = UploadedFile["result"]["ID"]; - - Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token); -``` - - - - -```json title="Result" -{ - "result": { - "FILES": { - "upload12614": { - "id": 12614, - "chatId": 988, - "date": {}, - "type": "file", - "name": "Imortant doc.docx", - "extension": "docx", - "size": 24071, - "image": false, - "status": "done", - "progress": 100, - "authorId": 1, - "authorName": "Антон Титовец", - "urlPreview": "", - "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12614&fileName=Imortant%20doc.docx", - "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12614&fileName=Imortant%20doc.docx", - "viewerAttrs": { - "viewer": null, - "viewerType": "cloud-document", - "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12614&fileName=Imortant%20doc.docx", - "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", - "viewerSeparateItem": true, - "viewerExtension": "im.integration.viewer", - "objectId": "12614", - "imChatId": 988, - "title": "Imortant doc.docx", - "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"12614\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" - } - } - }, - "DISK_ID": [ - "12614" - ], - "FILE_MODELS": { - "upload12614": { - "id": 12614, - "name": "Imortant doc.docx", - "createTime": {}, - "updateTime": {}, - "deleteTime": null, - "code": null, - "xmlId": null, - "storageId": 6, - "realObjectId": 12614, - "parentId": 12610, - "deletedType": 0, - "createdBy": "1", - "updatedBy": "1", - "deletedBy": "0", - "typeFile": 4, - "globalContentVersion": 2, - "fileId": 8688, - "size": 24071, - "etag": "46a4f72f7b8b92b6f5f2892c05e7faa7", - "links": { - "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=12614", - "showInGrid": "/bitrix/tools/disk/focus.php?objectId=12614&action=showObjectInGrid&ncc=1" - } - } - }, - "MESSAGE_ID": 17762 - }, - "time": { - "start": 1728454913.41449, - "finish": 1728454913.53076, - "duration": 0.116268157958984, - "processing": 0.0841860771179199, - "date_start": "2024-10-09T09:21:53+03:00", - "date_finish": "2024-10-09T09:21:53+03:00", - "operating_reset_at": 1728455513, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-file.mdx b/docs/en/md/Bitrix24/Message-management/Send-file.mdx new file mode 100644 index 0000000000..667dfb5ad4 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Send-file.mdx @@ -0,0 +1,141 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Send file + Send disk file to chat + + + +`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | FileID | --fileid | String, Number | File ID from UploadFileToFolder method | + | Description | --description | String | File description | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "1006"; + File = "https://api.athenaeum.digital/test_data/document.docx"; // Binary Data, URL or path to file + Description = "Very important file"; + + Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); + FolderID = Directory["result"]["ID"]; + + UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID); + FileID = UploadedFile["result"]["ID"]; + + Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + ChatID = "1008"; + + Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); + FolderID = Directory["result"]["ID"]; + + UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token); + FileID = UploadedFile["result"]["ID"]; + + Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token); +``` + + + + +```json title="Result" +{ + "result": { + "FILES": { + "upload12614": { + "id": 12614, + "chatId": 988, + "date": {}, + "type": "file", + "name": "Imortant doc.docx", + "extension": "docx", + "size": 24071, + "image": false, + "status": "done", + "progress": 100, + "authorId": 1, + "authorName": "Антон Титовец", + "urlPreview": "", + "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12614&fileName=Imortant%20doc.docx", + "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12614&fileName=Imortant%20doc.docx", + "viewerAttrs": { + "viewer": null, + "viewerType": "cloud-document", + "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12614&fileName=Imortant%20doc.docx", + "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", + "viewerSeparateItem": true, + "viewerExtension": "im.integration.viewer", + "objectId": "12614", + "imChatId": 988, + "title": "Imortant doc.docx", + "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"12614\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" + } + } + }, + "DISK_ID": [ + "12614" + ], + "FILE_MODELS": { + "upload12614": { + "id": 12614, + "name": "Imortant doc.docx", + "createTime": {}, + "updateTime": {}, + "deleteTime": null, + "code": null, + "xmlId": null, + "storageId": 6, + "realObjectId": 12614, + "parentId": 12610, + "deletedType": 0, + "createdBy": "1", + "updatedBy": "1", + "deletedBy": "0", + "typeFile": 4, + "globalContentVersion": 2, + "fileId": 8688, + "size": 24071, + "etag": "46a4f72f7b8b92b6f5f2892c05e7faa7", + "links": { + "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=12614", + "showInGrid": "/bitrix/tools/disk/focus.php?objectId=12614&action=showObjectInGrid&ncc=1" + } + } + }, + "MESSAGE_ID": 17762 + }, + "time": { + "start": 1728454913.41449, + "finish": 1728454913.53076, + "duration": 0.116268157958984, + "processing": 0.0841860771179199, + "date_start": "2024-10-09T09:21:53+03:00", + "date_finish": "2024-10-09T09:21:53+03:00", + "operating_reset_at": 1728455513, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-message.md b/docs/en/md/Bitrix24/Message-management/Send-message.md deleted file mode 100644 index 647eb42f36..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Send-message.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Send message - Send message to dialog - - - -`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Text | --text | String | Message text | - | Attachments | --blocks | Array of Structure | Array of attachments | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - ChatID = "chat" + "1006"; - Text = "Message text"; - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); - - Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.SendMessage(URL, UserID, Text, , Token); -``` - - - - -```json title="Result" -{ - "result": 17758, - "time": { - "start": 1728454905.16276, - "finish": 1728454905.25097, - "duration": 0.0882101058959961, - "processing": 0.0612020492553711, - "date_start": "2024-10-09T09:21:45+03:00", - "date_finish": "2024-10-09T09:21:45+03:00", - "operating_reset_at": 1728455505, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-message.mdx b/docs/en/md/Bitrix24/Message-management/Send-message.mdx new file mode 100644 index 0000000000..92b6f6ab04 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Send-message.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Send message + Send message to dialog + + + +`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Text | --text | String | Message text | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + ChatID = "chat" + "1006"; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); + + Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.SendMessage(URL, UserID, Text, , Token); +``` + + + + +```json title="Result" +{ + "result": 17758, + "time": { + "start": 1728454905.16276, + "finish": 1728454905.25097, + "duration": 0.0882101058959961, + "processing": 0.0612020492553711, + "date_start": "2024-10-09T09:21:45+03:00", + "date_finish": "2024-10-09T09:21:45+03:00", + "operating_reset_at": 1728455505, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md deleted file mode 100644 index e85869fca7..0000000000 --- a/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Set message reaction - Set or remove reaction mark on the message - - - -`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | MessageID | --message | String, Number | Message ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - MessageID = "18126"; - - Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - MessageID = "18128"; - - Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454910.6457, - "finish": 1728454910.70529, - "duration": 0.0595870018005371, - "processing": 0.0330779552459717, - "date_start": "2024-10-09T09:21:50+03:00", - "date_finish": "2024-10-09T09:21:50+03:00", - "operating_reset_at": 1728455510, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Message-management/Set-message-reaction.mdx b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.mdx new file mode 100644 index 0000000000..ad70df429e --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Set message reaction + Set or remove reaction mark on the message + + + +`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | Message ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + MessageID = "18126"; + + Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + MessageID = "18128"; + + Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454910.6457, + "finish": 1728454910.70529, + "duration": 0.0595870018005371, + "processing": 0.0330779552459717, + "date_start": "2024-10-09T09:21:50+03:00", + "date_finish": "2024-10-09T09:21:50+03:00", + "operating_reset_at": 1728455510, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md deleted file mode 100644 index 91912cc987..0000000000 --- a/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create personal notification - Creates a personal notification to the user - - - -`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --user | String, Number | User ID for sending the notification | - | Text | --text | String | Notification text | - | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | - | Attachments | --blocks | Array of Structure | Array of attachments | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) -::: -
- - -```bsl title="Code example" - UserID = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Text = "Message text"; - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); - - Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, ,Attachments); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - Tag = "New"; - UserID = 10; - - Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag, , Token); -``` - - - - -```json title="Result" -{ - "result": 17766, - "time": { - "start": 1728454921.39316, - "finish": 1728454921.47016, - "duration": 0.0769948959350586, - "processing": 0.0409860610961914, - "date_start": "2024-10-09T09:22:01+03:00", - "date_finish": "2024-10-09T09:22:01+03:00", - "operating_reset_at": 1728455521, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.mdx b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.mdx new file mode 100644 index 0000000000..56df134536 --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create personal notification + Creates a personal notification to the user + + + +`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --user | String, Number | User ID for sending the notification | + | Text | --text | String | Notification text | + | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) +::: +
+ + +```bsl title="Code example" + UserID = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); + + Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, ,Attachments); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + Tag = "New"; + UserID = 10; + + Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag, , Token); +``` + + + + +```json title="Result" +{ + "result": 17766, + "time": { + "start": 1728454921.39316, + "finish": 1728454921.47016, + "duration": 0.0769948959350586, + "processing": 0.0409860610961914, + "date_start": "2024-10-09T09:22:01+03:00", + "date_finish": "2024-10-09T09:22:01+03:00", + "operating_reset_at": 1728455521, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md deleted file mode 100644 index fc01ddf692..0000000000 --- a/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create system notification - Creates a system notification to the user - - - -`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --user | String, Number | User ID for sending the notification | - | Text | --text | String | Notification text | - | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | - | Attachments | --blocks | Array of Structure | Array of attachments | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) -::: -
- - -```bsl title="Code example" - UserID = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Text = "Message text"; - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); - - Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, ,Attachments); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - Tag = "New"; - UserID = 10; - - Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag, , Token); -``` - - - - -```json title="Result" -{ - "result": 17770, - "time": { - "start": 1728454921.63299, - "finish": 1728454921.69824, - "duration": 0.0652530193328857, - "processing": 0.0368680953979492, - "date_start": "2024-10-09T09:22:01+03:00", - "date_finish": "2024-10-09T09:22:01+03:00", - "operating_reset_at": 1728455521, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.mdx b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.mdx new file mode 100644 index 0000000000..f60720875a --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create system notification + Creates a system notification to the user + + + +`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --user | String, Number | User ID for sending the notification | + | Text | --text | String | Notification text | + | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) +::: +
+ + +```bsl title="Code example" + UserID = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1" , Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx" , File)); + + Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, ,Attachments); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + Tag = "New"; + UserID = 10; + + Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag, , Token); +``` + + + + +```json title="Result" +{ + "result": 17770, + "time": { + "start": 1728454921.63299, + "finish": 1728454921.69824, + "duration": 0.0652530193328857, + "processing": 0.0368680953979492, + "date_start": "2024-10-09T09:22:01+03:00", + "date_finish": "2024-10-09T09:22:01+03:00", + "operating_reset_at": 1728455521, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md deleted file mode 100644 index d4c329e728..0000000000 --- a/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete notification - Delete notification by ID - - - -`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | NotificationID | --notif | String, Number | Notification ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - NotificationID = "18134"; - - Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - NotificationID = "18136"; - - Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454921.75437, - "finish": 1728454921.80021, - "duration": 0.0458471775054932, - "processing": 0.0189189910888672, - "date_start": "2024-10-09T09:22:01+03:00", - "date_finish": "2024-10-09T09:22:01+03:00", - "operating_reset_at": 1728455521, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.mdx b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.mdx new file mode 100644 index 0000000000..5ac13f9ddc --- /dev/null +++ b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete notification + Delete notification by ID + + + +`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | NotificationID | --notif | String, Number | Notification ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + NotificationID = "18134"; + + Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + NotificationID = "18136"; + + Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454921.75437, + "finish": 1728454921.80021, + "duration": 0.0458471775054932, + "processing": 0.0189189910888672, + "date_start": "2024-10-09T09:22:01+03:00", + "date_finish": "2024-10-09T09:22:01+03:00", + "operating_reset_at": 1728455521, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md b/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md deleted file mode 100644 index fbc2697c68..0000000000 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get app authentication link - Forms a link for authorization via the browser - - - -`Function GetAppAuthLink(Val Domain, Val ClientID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Domain | --domain | String | Current Bitrix URL (like 'portal.bitrix24.com') | - | ClientID | --clientid | String | Client ID from app settings | - - - Returns: String - URL for browser transition - -
- - - - -```bsl title="Code example" - Domain = "b24-ar17wx.bitrix24.by"; - ClientID = "local.6667fc928a50a9.70414732"; - - Result = OPI_Bitrix24.GetAppAuthLink(Domain, ClientID); -``` - - - - -```json title="Result" -"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" -``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.mdx b/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.mdx new file mode 100644 index 0000000000..db5e9303ea --- /dev/null +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get app authentication link + Forms a link for authorization via the browser + + + +`Function GetAppAuthLink(Val Domain, Val ClientID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Domain | --domain | String | Current Bitrix URL (like 'portal.bitrix24.com') | + | ClientID | --clientid | String | Client ID from app settings | + + + Returns: String - URL for browser transition + +
+ + + + +```bsl title="Code example" + Domain = "b24-ar17wx.bitrix24.by"; + ClientID = "local.6667fc928a50a9.70414732"; + + Result = OPI_Bitrix24.GetAppAuthLink(Domain, ClientID); +``` + + + + +```json title="Result" +"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" +``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md b/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md deleted file mode 100644 index 9f0721356b..0000000000 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get token - Get token by auth code - - - -`Function GetToken(Val ClientID, Val ClientSecret, Val Code) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client ID from app settings | - | ClientSecret | --clientsecret | String | Client secret from app settings | - | Code | --code | String | Code from browser auth page | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- - - - -```bsl title="Code example" - ClientID = "local.6667fc928a50a9.70414732"; - ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; - Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; - - Result = OPI_Bitrix24.GetToken(ClientID, ClientSecret, Code); -``` - - - - -```json title="Result" -{ - "error": "expired_token", - "error_description": "The authorization token provided has expired." -} -``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.mdx b/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.mdx new file mode 100644 index 0000000000..945a8ee493 --- /dev/null +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get token + Get token by auth code + + + +`Function GetToken(Val ClientID, Val ClientSecret, Val Code) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client ID from app settings | + | ClientSecret | --clientsecret | String | Client secret from app settings | + | Code | --code | String | Code from browser auth page | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ + + + +```bsl title="Code example" + ClientID = "local.6667fc928a50a9.70414732"; + ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; + Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; + + Result = OPI_Bitrix24.GetToken(ClientID, ClientSecret, Code); +``` + + + + +```json title="Result" +{ + "error": "expired_token", + "error_description": "The authorization token provided has expired." +} +``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md b/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md deleted file mode 100644 index b47ee28048..0000000000 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Refresh token - Update token by refresh token - - - -`Function RefreshToken(Val ClientID, Val ClientSecret, Val Refresh) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client ID from app settings | - | ClientSecret | --clientsecret | String | Client secret from app settings | - | Refresh | --refresh | String | Refresh token | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- - - - -```bsl title="Code example" - ClientID = "local.6667fc928a50a9.70414732"; - ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; - Refresh = "11f43167006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RefreshToken(ClientID, ClientSecret, Refresh); -``` - - - - -```json title="Result" -{ - "access_token": "6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff", - "expires": 1728458347, - "expires_in": 3600, - "scope": "app", - "domain": "oauth.bitrix.info", - "server_endpoint": "https://oauth.bitrix.info/rest/", - "status": "L", - "client_endpoint": "https://b24-ar17wx.bitrix24.by/rest/", - "member_id": "00168f0dd11ff00b4aeb8ce5befaa139", - "user_id": 1, - "refresh_token": "5bad2d67006e9f06006b12e40000000100000735b526f7211741a7e65fac266c482aca" -} -``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.mdx b/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.mdx new file mode 100644 index 0000000000..65378a0e8e --- /dev/null +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Refresh token + Update token by refresh token + + + +`Function RefreshToken(Val ClientID, Val ClientSecret, Val Refresh) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client ID from app settings | + | ClientSecret | --clientsecret | String | Client secret from app settings | + | Refresh | --refresh | String | Refresh token | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ + + + +```bsl title="Code example" + ClientID = "local.6667fc928a50a9.70414732"; + ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; + Refresh = "11f43167006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RefreshToken(ClientID, ClientSecret, Refresh); +``` + + + + +```json title="Result" +{ + "access_token": "6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff", + "expires": 1728458347, + "expires_in": 3600, + "scope": "app", + "domain": "oauth.bitrix.info", + "server_endpoint": "https://oauth.bitrix.info/rest/", + "status": "L", + "client_endpoint": "https://b24-ar17wx.bitrix24.by/rest/", + "member_id": "00168f0dd11ff00b4aeb8ce5befaa139", + "user_id": 1, + "refresh_token": "5bad2d67006e9f06006b12e40000000100000735b526f7211741a7e65fac266c482aca" +} +``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md b/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md deleted file mode 100644 index 3ad7ef0fca..0000000000 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Server time - Get current server time - - - -`Function ServerTime(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [server_time](https://dev.1c-bitrix.ru/rest_help/general/server_time.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.ServerTime(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.ServerTime(URL, Token); -``` - - - - -```json title="Result" -{ - "result": "2024-10-09T09:19:10+03:00", - "time": { - "start": 1728454749.92311, - "finish": 1728454750.26845, - "duration": 0.345338821411133, - "processing": 0.0000450611114501953, - "date_start": "2024-10-09T09:19:09+03:00", - "date_finish": "2024-10-09T09:19:10+03:00", - "operating_reset_at": 1728455350, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.mdx b/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.mdx new file mode 100644 index 0000000000..d40c7b728a --- /dev/null +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Server time + Get current server time + + + +`Function ServerTime(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [server_time](https://dev.1c-bitrix.ru/rest_help/general/server_time.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.ServerTime(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.ServerTime(URL, Token); +``` + + + + +```json title="Result" +{ + "result": "2024-10-09T09:19:10+03:00", + "time": { + "start": 1728454749.92311, + "finish": 1728454750.26845, + "duration": 0.345338821411133, + "processing": 0.0000450611114501953, + "date_start": "2024-10-09T09:19:09+03:00", + "date_finish": "2024-10-09T09:19:10+03:00", + "operating_reset_at": 1728455350, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md deleted file mode 100644 index 809afb7a5f..0000000000 --- a/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Create folder at the storage - Create new foldera at the storage - - - -`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String | Storage ID | - | Name | --title | String | Folder name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) -::: -
- - -```bsl title="Code example" - StorageID = 3; - Name = "New catalog"; - Filename2 = "New folder 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": 12582, - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 12582, - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-10-09T09:20:23+03:00", - "UPDATE_TIME": "2024-10-09T09:20:23+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1728454823.86898, - "finish": 1728454823.94657, - "duration": 0.0775852203369141, - "processing": 0.0524609088897705, - "date_start": "2024-10-09T09:20:23+03:00", - "date_finish": "2024-10-09T09:20:23+03:00", - "operating_reset_at": 1728455423, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.mdx b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.mdx new file mode 100644 index 0000000000..fec1efe97f --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Create folder at the storage + Create new foldera at the storage + + + +`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String | Storage ID | + | Name | --title | String | Folder name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) +::: +
+ + +```bsl title="Code example" + StorageID = 3; + Name = "New catalog"; + Filename2 = "New folder 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": 12582, + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 12582, + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-10-09T09:20:23+03:00", + "UPDATE_TIME": "2024-10-09T09:20:23+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1728454823.86898, + "finish": 1728454823.94657, + "duration": 0.0775852203369141, + "processing": 0.0524609088897705, + "date_start": "2024-10-09T09:20:23+03:00", + "date_finish": "2024-10-09T09:20:23+03:00", + "operating_reset_at": 1728455423, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md deleted file mode 100644 index 517516c4d9..0000000000 --- a/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get storage for application data - Get information about storage with which the application can work to store its data - - - -`Function GetAppSotrage(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) -::: -
- - -```bsl title="Code example" - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetAppSotrage(URL, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "18", - "NAME": "New storage name", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1728454799.05907, - "finish": 1728454799.09081, - "duration": 0.0317399501800537, - "processing": 0.00446605682373047, - "date_start": "2024-10-09T09:19:59+03:00", - "date_finish": "2024-10-09T09:19:59+03:00", - "operating_reset_at": 1728455399, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.mdx b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.mdx new file mode 100644 index 0000000000..1759a3e3be --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get storage for application data + Get information about storage with which the application can work to store its data + + + +`Function GetAppSotrage(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) +::: +
+ + +```bsl title="Code example" + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetAppSotrage(URL, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1728454799.05907, + "finish": 1728454799.09081, + "duration": 0.0317399501800537, + "processing": 0.00446605682373047, + "date_start": "2024-10-09T09:19:59+03:00", + "date_finish": "2024-10-09T09:19:59+03:00", + "operating_reset_at": 1728455399, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md deleted file mode 100644 index fe89b74833..0000000000 --- a/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get a list of child storage objects - Get a list of files and folders, located at the root of the storage - - - -`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String, Number | Storage ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - StorageID = 3; - - Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "12574", - "NAME": "Picture2.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8664", - "SIZE": "2114023", - "CREATE_TIME": "2024-10-09T09:20:01+03:00", - "UPDATE_TIME": "2024-10-09T09:20:01+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzQmXz1MNklnblBHNkpDNTJHM1RLQW5Sc3pnSTBnMU9IbW44NA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelFtWHoxTU5rbG5ibEJITmtwRE5USkhNMVJMUVc1U2MzcG5TVEJuTVU5SWJXNDROQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.nYm8hGPR9CQlulZNy11OyTsbPvsviFlF7xqaziDP2rM%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg" - }, - { - "ID": "12576", - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8666", - "SIZE": "805189", - "CREATE_TIME": "2024-10-09T09:20:02+03:00", - "UPDATE_TIME": "2024-10-09T09:20:02+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1QUENCSFBmZnVXdmxYZ2F4ZkgxeEh2N2taaHFwVjA0eQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxUVVFTkNTRkJtWm5WWGRteFlaMkY0WmtneGVFaDJOMnRhYUhGd1ZqQTBlUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.ZlQXJpksSrH93BaypbRFzF7a3%2FtWFevKgyL0f%2B1oCg8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" - } - ], - "total": 2, - "time": { - "start": 1728454802.6587, - "finish": 1728454802.69218, - "duration": 0.033480167388916, - "processing": 0.00767111778259277, - "date_start": "2024-10-09T09:20:02+03:00", - "date_finish": "2024-10-09T09:20:02+03:00", - "operating_reset_at": 1728455402, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.mdx b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.mdx new file mode 100644 index 0000000000..20818a8aac --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.mdx @@ -0,0 +1,103 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get a list of child storage objects + Get a list of files and folders, located at the root of the storage + + + +`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + StorageID = 3; + + Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "12574", + "NAME": "Picture2.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8664", + "SIZE": "2114023", + "CREATE_TIME": "2024-10-09T09:20:01+03:00", + "UPDATE_TIME": "2024-10-09T09:20:01+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzQmXz1MNklnblBHNkpDNTJHM1RLQW5Sc3pnSTBnMU9IbW44NA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelFtWHoxTU5rbG5ibEJITmtwRE5USkhNMVJMUVc1U2MzcG5TVEJuTVU5SWJXNDROQT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.nYm8hGPR9CQlulZNy11OyTsbPvsviFlF7xqaziDP2rM%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg" + }, + { + "ID": "12576", + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8666", + "SIZE": "805189", + "CREATE_TIME": "2024-10-09T09:20:02+03:00", + "UPDATE_TIME": "2024-10-09T09:20:02+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=6b2e0667006e9f06006b12e4000000010000072c4914d2a629a27f8e468fd6a8ba64ff&token=disk%7CaWQ9MTI1NzYmXz1QUENCSFBmZnVXdmxYZ2F4ZkgxeEh2N2taaHFwVjA0eQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTFOelltWHoxUVVFTkNTRkJtWm5WWGRteFlaMkY0WmtneGVFaDJOMnRhYUhGd1ZqQTBlUT09fDZiMmUwNjY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3MmM0OTE0ZDJhNjI5YTI3ZjhlNDY4ZmQ2YThiYTY0ZmYi.ZlQXJpksSrH93BaypbRFzF7a3%2FtWFevKgyL0f%2B1oCg8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" + } + ], + "total": 2, + "time": { + "start": 1728454802.6587, + "finish": 1728454802.69218, + "duration": 0.033480167388916, + "processing": 0.00767111778259277, + "date_start": "2024-10-09T09:20:02+03:00", + "date_finish": "2024-10-09T09:20:02+03:00", + "operating_reset_at": 1728455402, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage.md b/docs/en/md/Bitrix24/Storages-managment/Get-storage.md deleted file mode 100644 index b27546592d..0000000000 --- a/docs/en/md/Bitrix24/Storages-managment/Get-storage.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get storage - Get information about storage - - - -`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String, Number | Storage ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - StorageID = 3; - - Result = OPI_Bitrix24.GetStorage(URL, StorageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - "time": { - "start": 1728454799.33094, - "finish": 1728454799.36621, - "duration": 0.0352659225463867, - "processing": 0.00424385070800781, - "date_start": "2024-10-09T09:19:59+03:00", - "date_finish": "2024-10-09T09:19:59+03:00", - "operating_reset_at": 1728455399, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage.mdx b/docs/en/md/Bitrix24/Storages-managment/Get-storage.mdx new file mode 100644 index 0000000000..2066792c69 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storage.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get storage + Get information about storage + + + +`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + StorageID = 3; + + Result = OPI_Bitrix24.GetStorage(URL, StorageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + "time": { + "start": 1728454799.33094, + "finish": 1728454799.36621, + "duration": 0.0352659225463867, + "processing": 0.00424385070800781, + "date_start": "2024-10-09T09:19:59+03:00", + "date_finish": "2024-10-09T09:19:59+03:00", + "operating_reset_at": 1728455399, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md deleted file mode 100644 index 9b5634d18c..0000000000 --- a/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of storages - Get list of available files storages - - - -`Function GetStoragesList(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Result = OPI_Bitrix24.GetStoragesList(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetStoragesList(URL, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "1", - "NAME": "Антон Титовец", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "1", - "ROOT_OBJECT_ID": "1" - }, - { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - { - "ID": "4", - "NAME": "Payment Processing Customer Support", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "4" - }, - { - "ID": "10", - "NAME": "CoPilot", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "4", - "ROOT_OBJECT_ID": "52" - }, - { - "ID": "12", - "NAME": "Поддержка Битрикс24", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "6", - "ROOT_OBJECT_ID": "70" - }, - { - "ID": "14", - "NAME": "Марта", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "8", - "ROOT_OBJECT_ID": "72" - }, - { - "ID": "16", - "NAME": "iscript13@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "10", - "ROOT_OBJECT_ID": "270" - }, - { - "ID": "20", - "NAME": "oarismos@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "12", - "ROOT_OBJECT_ID": "2810" - }, - { - "ID": "26", - "NAME": "yo@exepmple.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "18", - "ROOT_OBJECT_ID": "4602" - }, - { - "ID": "42", - "NAME": "f9535def-46c6-44af-950c-6f3f7767f5d2@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "34", - "ROOT_OBJECT_ID": "4618" - }, - { - "ID": "44", - "NAME": "Олег Лама", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "36", - "ROOT_OBJECT_ID": "4620" - }, - { - "ID": "46", - "NAME": "d95a9fe7-48e3-406c-ae52-62c4f4a55a10@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "38", - "ROOT_OBJECT_ID": "4622" - }, - { - "ID": "48", - "NAME": "Олег Лама", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "40", - "ROOT_OBJECT_ID": "4624" - }, - { - "ID": "50", - "NAME": "5565fd7a-6cbc-4e3b-ad9a-07ed12dc1c60@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "42", - "ROOT_OBJECT_ID": "4626" - }, - { - "ID": "52", - "NAME": "Олег Лама", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "44", - "ROOT_OBJECT_ID": "4628" - }, - { - "ID": "54", - "NAME": "6f72690f-e2b8-4437-87e5-38c1411dd757@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "46", - "ROOT_OBJECT_ID": "4630" - }, - { - "ID": "56", - "NAME": "Олег Лама", - "CODE": null, -... -``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.mdx b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.mdx new file mode 100644 index 0000000000..3e6e00ac66 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.mdx @@ -0,0 +1,196 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of storages + Get list of available files storages + + + +`Function GetStoragesList(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Result = OPI_Bitrix24.GetStoragesList(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStoragesList(URL, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "1", + "NAME": "Антон Титовец", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "1", + "ROOT_OBJECT_ID": "1" + }, + { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + { + "ID": "4", + "NAME": "Payment Processing Customer Support", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "4" + }, + { + "ID": "10", + "NAME": "CoPilot", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "4", + "ROOT_OBJECT_ID": "52" + }, + { + "ID": "12", + "NAME": "Поддержка Битрикс24", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "6", + "ROOT_OBJECT_ID": "70" + }, + { + "ID": "14", + "NAME": "Марта", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "8", + "ROOT_OBJECT_ID": "72" + }, + { + "ID": "16", + "NAME": "iscript13@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "10", + "ROOT_OBJECT_ID": "270" + }, + { + "ID": "20", + "NAME": "oarismos@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "12", + "ROOT_OBJECT_ID": "2810" + }, + { + "ID": "26", + "NAME": "yo@exepmple.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "18", + "ROOT_OBJECT_ID": "4602" + }, + { + "ID": "42", + "NAME": "f9535def-46c6-44af-950c-6f3f7767f5d2@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "34", + "ROOT_OBJECT_ID": "4618" + }, + { + "ID": "44", + "NAME": "Олег Лама", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "36", + "ROOT_OBJECT_ID": "4620" + }, + { + "ID": "46", + "NAME": "d95a9fe7-48e3-406c-ae52-62c4f4a55a10@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "38", + "ROOT_OBJECT_ID": "4622" + }, + { + "ID": "48", + "NAME": "Олег Лама", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "40", + "ROOT_OBJECT_ID": "4624" + }, + { + "ID": "50", + "NAME": "5565fd7a-6cbc-4e3b-ad9a-07ed12dc1c60@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "42", + "ROOT_OBJECT_ID": "4626" + }, + { + "ID": "52", + "NAME": "Олег Лама", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "44", + "ROOT_OBJECT_ID": "4628" + }, + { + "ID": "54", + "NAME": "6f72690f-e2b8-4437-87e5-38c1411dd757@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "46", + "ROOT_OBJECT_ID": "4630" + }, + { + "ID": "56", + "NAME": "Олег Лама", + "CODE": null, +... +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md deleted file mode 100644 index a152e26761..0000000000 --- a/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Rename storage - Change storage name (for app storage only, see. GetAppStorage) - - - -`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String, Number | Storage ID | - | Name | --title | String | New storage name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) -::: -
- - -```bsl title="Code example" - Name = "New storage name"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - StorageID = "18"; - - Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "18", - "NAME": "New storage name", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1728454799.15146, - "finish": 1728454799.18227, - "duration": 0.0308098793029785, - "processing": 0.00592279434204102, - "date_start": "2024-10-09T09:19:59+03:00", - "date_finish": "2024-10-09T09:19:59+03:00", - "operating_reset_at": 1728455399, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Rename-storage.mdx b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.mdx new file mode 100644 index 0000000000..de2dcda0c4 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Rename storage + Change storage name (for app storage only, see. GetAppStorage) + + + +`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Name | --title | String | New storage name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New storage name"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + StorageID = "18"; + + Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1728454799.15146, + "finish": 1728454799.18227, + "duration": 0.0308098793029785, + "processing": 0.00592279434204102, + "date_start": "2024-10-09T09:19:59+03:00", + "date_finish": "2024-10-09T09:19:59+03:00", + "operating_reset_at": 1728455399, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md deleted file mode 100644 index 8b83d98916..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Add tasks checklist element - Adds new element of tasks checklist - - - -`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Text | --text | String | Text (title) of checklist element | - | Completed | --complete | Boolean | Mark as completed | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Text = "Checklist element"; - - Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, , Token); -``` - - - - -```json title="Result" -{ - "result": 1460, - "time": { - "start": 1728454786.04734, - "finish": 1728454786.13143, - "duration": 0.0840880870819092, - "processing": 0.0545477867126465, - "date_start": "2024-10-09T09:19:46+03:00", - "date_finish": "2024-10-09T09:19:46+03:00", - "operating_reset_at": 1728455386, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.mdx new file mode 100644 index 0000000000..393009c33e --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Add tasks checklist element + Adds new element of tasks checklist + + + +`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Text | --text | String | Text (title) of checklist element | + | Completed | --complete | Boolean | Mark as completed | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Text = "Checklist element"; + + Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, , Token); +``` + + + + +```json title="Result" +{ + "result": 1460, + "time": { + "start": 1728454786.04734, + "finish": 1728454786.13143, + "duration": 0.0840880870819092, + "processing": 0.0545477867126465, + "date_start": "2024-10-09T09:19:46+03:00", + "date_finish": "2024-10-09T09:19:46+03:00", + "operating_reset_at": 1728455386, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md deleted file mode 100644 index 2d2f79ab18..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Complete tasks checklist element - Mark an element as completed - - - -`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Element ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - ElementID = "1496"; - - Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "2448"; - ElementID = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454787.01817, - "finish": 1728454787.07164, - "duration": 0.0534749031066894, - "processing": 0.0282580852508545, - "date_start": "2024-10-09T09:19:47+03:00", - "date_finish": "2024-10-09T09:19:47+03:00", - "operating_reset_at": 1728455387, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.mdx new file mode 100644 index 0000000000..5fa3eacc28 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Complete tasks checklist element + Mark an element as completed + + + +`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + ElementID = "1496"; + + Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "2448"; + ElementID = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454787.01817, + "finish": 1728454787.07164, + "duration": 0.0534749031066894, + "processing": 0.0282580852508545, + "date_start": "2024-10-09T09:19:47+03:00", + "date_finish": "2024-10-09T09:19:47+03:00", + "operating_reset_at": 1728455387, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md deleted file mode 100644 index eb249eb64d..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete tasks checklist element - Deletes element from tasks checklist - - - -`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | ID of deleted element | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - ElementID = "1496"; - - Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "2448"; - ElementID = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454787.47564, - "finish": 1728454787.54389, - "duration": 0.0682549476623535, - "processing": 0.0366320610046387, - "date_start": "2024-10-09T09:19:47+03:00", - "date_finish": "2024-10-09T09:19:47+03:00", - "operating_reset_at": 1728455387, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.mdx new file mode 100644 index 0000000000..a811113012 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete tasks checklist element + Deletes element from tasks checklist + + + +`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | ID of deleted element | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + ElementID = "1496"; + + Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "2448"; + ElementID = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454787.47564, + "finish": 1728454787.54389, + "duration": 0.0682549476623535, + "processing": 0.0366320610046387, + "date_start": "2024-10-09T09:19:47+03:00", + "date_finish": "2024-10-09T09:19:47+03:00", + "operating_reset_at": 1728455387, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md deleted file mode 100644 index 95ea098304..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get tasks checklist element - Gets tasks checklist element by ID - - - -`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Element ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - ElementID = "1496"; - - Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "2448"; - ElementID = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "1460", - "TASK_ID": "2398", - "PARENT_ID": "1458", - "CREATED_BY": "1", - "TITLE": "New elements text", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - "time": { - "start": 1728454786.80187, - "finish": 1728454786.86049, - "duration": 0.0586211681365967, - "processing": 0.0263149738311768, - "date_start": "2024-10-09T09:19:46+03:00", - "date_finish": "2024-10-09T09:19:46+03:00", - "operating_reset_at": 1728455386, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.mdx new file mode 100644 index 0000000000..6adfefd4b3 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get tasks checklist element + Gets tasks checklist element by ID + + + +`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + ElementID = "1496"; + + Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "2448"; + ElementID = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "1460", + "TASK_ID": "2398", + "PARENT_ID": "1458", + "CREATED_BY": "1", + "TITLE": "New elements text", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + "time": { + "start": 1728454786.80187, + "finish": 1728454786.86049, + "duration": 0.0586211681365967, + "processing": 0.0263149738311768, + "date_start": "2024-10-09T09:19:46+03:00", + "date_finish": "2024-10-09T09:19:46+03:00", + "operating_reset_at": 1728455386, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md deleted file mode 100644 index 5de5154383..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get tasks checklist - Gets the list of elements on the task checklist - - - -`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "1458", - "TASK_ID": "2398", - "PARENT_ID": 0, - "CREATED_BY": "1", - "TITLE": "BX_CHECKLIST_1", - "SORT_INDEX": "0", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - { - "ID": "1460", - "TASK_ID": "2398", - "PARENT_ID": "1458", - "CREATED_BY": "1", - "TITLE": "New elements text", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - } - ], - "time": { - "start": 1728454786.58925, - "finish": 1728454786.64143, - "duration": 0.0521810054779053, - "processing": 0.0244979858398438, - "date_start": "2024-10-09T09:19:46+03:00", - "date_finish": "2024-10-09T09:19:46+03:00", - "operating_reset_at": 1728455386, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.mdx new file mode 100644 index 0000000000..e52d7e33ea --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.mdx @@ -0,0 +1,91 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get tasks checklist + Gets the list of elements on the task checklist + + + +`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "1458", + "TASK_ID": "2398", + "PARENT_ID": 0, + "CREATED_BY": "1", + "TITLE": "BX_CHECKLIST_1", + "SORT_INDEX": "0", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + { + "ID": "1460", + "TASK_ID": "2398", + "PARENT_ID": "1458", + "CREATED_BY": "1", + "TITLE": "New elements text", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + } + ], + "time": { + "start": 1728454786.58925, + "finish": 1728454786.64143, + "duration": 0.0521810054779053, + "processing": 0.0244979858398438, + "date_start": "2024-10-09T09:19:46+03:00", + "date_finish": "2024-10-09T09:19:46+03:00", + "operating_reset_at": 1728455386, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md deleted file mode 100644 index d9d640980e..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Renew tasks checklist element - Unmark an element as completed - - - -`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Element ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - ElementID = "1496"; - - Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "2448"; - ElementID = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454787.24722, - "finish": 1728454787.30494, - "duration": 0.0577118396759033, - "processing": 0.0310859680175781, - "date_start": "2024-10-09T09:19:47+03:00", - "date_finish": "2024-10-09T09:19:47+03:00", - "operating_reset_at": 1728455387, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.mdx new file mode 100644 index 0000000000..c93d501092 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Renew tasks checklist element + Unmark an element as completed + + + +`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + ElementID = "1496"; + + Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "2448"; + ElementID = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454787.24722, + "finish": 1728454787.30494, + "duration": 0.0577118396759033, + "processing": 0.0310859680175781, + "date_start": "2024-10-09T09:19:47+03:00", + "date_finish": "2024-10-09T09:19:47+03:00", + "operating_reset_at": 1728455387, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md deleted file mode 100644 index fb151fbaaa..0000000000 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Update tasks checklist element - Updates text of element of tasks checklist - - - -`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Checklist element ID | - | Text | --text | String | Text (title) of checklist element | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - ElementID = "1496"; - - Text = "New elements text"; - - Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - ElementID = "1500"; - - Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token); -``` - - - - -```json title="Result" -{ - "result": null, - "time": { - "start": 1728454786.34816, - "finish": 1728454786.41181, - "duration": 0.0636470317840576, - "processing": 0.0358831882476807, - "date_start": "2024-10-09T09:19:46+03:00", - "date_finish": "2024-10-09T09:19:46+03:00", - "operating_reset_at": 1728455386, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.mdx b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.mdx new file mode 100644 index 0000000000..94c48ef5a1 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Update tasks checklist element + Updates text of element of tasks checklist + + + +`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Checklist element ID | + | Text | --text | String | Text (title) of checklist element | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + ElementID = "1496"; + + Text = "New elements text"; + + Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + ElementID = "1500"; + + Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token); +``` + + + + +```json title="Result" +{ + "result": null, + "time": { + "start": 1728454786.34816, + "finish": 1728454786.41181, + "duration": 0.0636470317840576, + "processing": 0.0358831882476807, + "date_start": "2024-10-09T09:19:46+03:00", + "date_finish": "2024-10-09T09:19:46+03:00", + "operating_reset_at": 1728455386, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md b/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md deleted file mode 100644 index 3318f461f4..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 17 ---- - -# Add task to favorites list - Add task to favorites list - - - -`Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.favorite.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454777.13737, - "finish": 1728454777.17877, - "duration": 0.0414021015167236, - "processing": 0.0116980075836182, - "date_start": "2024-10-09T09:19:37+03:00", - "date_finish": "2024-10-09T09:19:37+03:00", - "operating_reset_at": 1728455377, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.mdx b/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.mdx new file mode 100644 index 0000000000..cee738ec96 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 17 +--- + +# Add task to favorites list + Add task to favorites list + + + +`Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.favorite.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454777.13737, + "finish": 1728454777.17877, + "duration": 0.0414021015167236, + "processing": 0.0116980075836182, + "date_start": "2024-10-09T09:19:37+03:00", + "date_finish": "2024-10-09T09:19:37+03:00", + "operating_reset_at": 1728455377, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md deleted file mode 100644 index 9418e35efe..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Approve task - Approve task by ID - - - -`Function ApproveTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.approve](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_approve.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.ApproveTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.ApproveTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "title": "Another task title", - "description": "Another task description", - "descriptionInBbcode": "Y", - "declineReason": "", - "priority": "1", - "notViewed": "N", - "statusComplete": "2", - "multitask": "N", - "stageId": "0", - "responsibleId": "602", - "responsibleName": "Oleg", - "responsibleLastName": "Lama", - "responsibleSecondName": null, - "responsibleLogin": "c97e7aef-e5c1-4971-94a8-853cff3f0e5e@exepmple.org", - "responsibleWorkPosition": null, - "responsiblePhoto": null, - "dateStart": null, - "durationFact": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "replicate": "N", - "deadline": "2024-10-10T12:19:00+03:00", - "deadlineOrig": "10.10.2024 12:19:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "createdBy": "1", - "createdByName": "Антон", - "createdByLastName": "Титовец", - "createdBySecondName": null, - "createdByLogin": "VKuser657846756", - "createdByWorkPosition": null, - "createdByPhoto": "30", - "createdDate": "2024-10-09T09:19:28+03:00", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:39+03:00", - "statusChangedBy": "1", - "closedBy": "1", - "closedDate": "2024-10-09T09:19:39+03:00", - "activityDate": "2024-10-09T09:19:39+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "mark": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "matchWorkTime": "N", - "taskControl": "N", - "addInReport": "N", - "forumTopicId": "1664", - "parentId": null, - "commentsCount": "2", - "serviceCommentsCount": "2", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "6", - "viewedDate": "2024-10-09T09:19:40+03:00", - "deadlineCounted": "0", - "forkedByTemplateId": null, - "sorting": null, - "durationPlanSeconds": null, - "durationTypeAll": "days", - "scenarioName": [ - "default" - ], - "isRegular": "N", - "flowId": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "ufCrmTask": false, - "ufTaskWebdavFiles": false, - "ufMailMessage": null, - "status": "5", - "statusChangedDate": "2024-10-09T09:19:39+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "tags": [], - "checklist": [], - "files": [], - "dependsOn": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": false, - "approve": false, - "disapprove": false, - "start": false, - "pause": false, - "delegate": false, - "remove": true, - "edit": true, - "defer": false, - "renew": true, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, -... -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.mdx new file mode 100644 index 0000000000..fbc60b751a --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Approve task + Approve task by ID + + + +`Function ApproveTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.approve](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_approve.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.ApproveTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.ApproveTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "title": "Another task title", + "description": "Another task description", + "descriptionInBbcode": "Y", + "declineReason": "", + "priority": "1", + "notViewed": "N", + "statusComplete": "2", + "multitask": "N", + "stageId": "0", + "responsibleId": "602", + "responsibleName": "Oleg", + "responsibleLastName": "Lama", + "responsibleSecondName": null, + "responsibleLogin": "c97e7aef-e5c1-4971-94a8-853cff3f0e5e@exepmple.org", + "responsibleWorkPosition": null, + "responsiblePhoto": null, + "dateStart": null, + "durationFact": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "replicate": "N", + "deadline": "2024-10-10T12:19:00+03:00", + "deadlineOrig": "10.10.2024 12:19:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "createdBy": "1", + "createdByName": "Антон", + "createdByLastName": "Титовец", + "createdBySecondName": null, + "createdByLogin": "VKuser657846756", + "createdByWorkPosition": null, + "createdByPhoto": "30", + "createdDate": "2024-10-09T09:19:28+03:00", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:39+03:00", + "statusChangedBy": "1", + "closedBy": "1", + "closedDate": "2024-10-09T09:19:39+03:00", + "activityDate": "2024-10-09T09:19:39+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "mark": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "matchWorkTime": "N", + "taskControl": "N", + "addInReport": "N", + "forumTopicId": "1664", + "parentId": null, + "commentsCount": "2", + "serviceCommentsCount": "2", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "6", + "viewedDate": "2024-10-09T09:19:40+03:00", + "deadlineCounted": "0", + "forkedByTemplateId": null, + "sorting": null, + "durationPlanSeconds": null, + "durationTypeAll": "days", + "scenarioName": [ + "default" + ], + "isRegular": "N", + "flowId": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "ufCrmTask": false, + "ufTaskWebdavFiles": false, + "ufMailMessage": null, + "status": "5", + "statusChangedDate": "2024-10-09T09:19:39+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "tags": [], + "checklist": [], + "files": [], + "dependsOn": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": false, + "approve": false, + "disapprove": false, + "start": false, + "pause": false, + "delegate": false, + "remove": true, + "edit": true, + "defer": false, + "renew": true, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, +... +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md deleted file mode 100644 index c3be31f5c4..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Attach file to the topic - Attaches a file to the selected task - - - -`Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | FileID | --fileid | Number, String | File ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - FileID = "12872"; - - Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "attachmentId": 3606 - }, - "time": { - "start": 1728454790.16012, - "finish": 1728454790.22105, - "duration": 0.0609369277954102, - "processing": 0.0364110469818115, - "date_start": "2024-10-09T09:19:50+03:00", - "date_finish": "2024-10-09T09:19:50+03:00", - "operating_reset_at": 1728455390, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.mdx b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.mdx new file mode 100644 index 0000000000..3ba9cec771 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Attach file to the topic + Attaches a file to the selected task + + + +`Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | FileID | --fileid | Number, String | File ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + FileID = "12872"; + + Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "attachmentId": 3606 + }, + "time": { + "start": 1728454790.16012, + "finish": 1728454790.22105, + "duration": 0.0609369277954102, + "processing": 0.0364110469818115, + "date_start": "2024-10-09T09:19:50+03:00", + "date_finish": "2024-10-09T09:19:50+03:00", + "operating_reset_at": 1728455390, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md deleted file mode 100644 index 9561378403..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Check task acesses for users - Checks the availability of the task for users - - - -`Function CheckTaskAccesses(Val URL, Val TaskID, Val Users = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Users | --users | Array of String | User IDs for access checking | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) -::: -
- - -```bsl title="Code example" - ArrayOfUsers = New Array; - ArrayOfUsers.Add("1"); - ArrayOfUsers.Add("10"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers, Token); -``` - - - - -```json title="Result" -{ - "result": { - "allowedActions": { - "1": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": true, - "APPROVE": false, - "DISAPPROVE": false, - "START": true, - "PAUSE": false, - "DELEGATE": true, - "REMOVE": true, - "EDIT": true, - "DEFER": true, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": true, - "CHECKLIST_ADD_ITEMS": true, - "ADD_FAVORITE": true, - "DELETE_FAVORITE": false, - "RATE": true, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": true, - "ELAPSEDTIME.ADD": true, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": true, - "CHECKLIST.ADD": true, - "FAVORITE.ADD": true, - "FAVORITE.DELETE": false - }, - "10": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": false, - "APPROVE": false, - "DISAPPROVE": false, - "START": false, - "PAUSE": false, - "DELEGATE": false, - "REMOVE": false, - "EDIT": false, - "DEFER": false, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": false, - "CHECKLIST_ADD_ITEMS": false, - "ADD_FAVORITE": false, - "DELETE_FAVORITE": false, - "RATE": false, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": false, - "ELAPSEDTIME.ADD": false, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": false, - "CHECKLIST.ADD": false, - "FAVORITE.ADD": false, - "FAVORITE.DELETE": false - } - } - }, - "time": { - "start": 1728454785.80063, - "finish": 1728454785.85694, - "duration": 0.0563130378723144, - "processing": 0.0311760902404785, - "date_start": "2024-10-09T09:19:45+03:00", - "date_finish": "2024-10-09T09:19:45+03:00", - "operating_reset_at": 1728455385, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.mdx b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.mdx new file mode 100644 index 0000000000..cb57b4cbb6 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.mdx @@ -0,0 +1,126 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 20 +--- + +# Check task acesses for users + Checks the availability of the task for users + + + +`Function CheckTaskAccesses(Val URL, Val TaskID, Val Users = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Users | --users | Array of String | User IDs for access checking | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) +::: +
+ + +```bsl title="Code example" + ArrayOfUsers = New Array; + ArrayOfUsers.Add("1"); + ArrayOfUsers.Add("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers, Token); +``` + + + + +```json title="Result" +{ + "result": { + "allowedActions": { + "1": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": true, + "APPROVE": false, + "DISAPPROVE": false, + "START": true, + "PAUSE": false, + "DELEGATE": true, + "REMOVE": true, + "EDIT": true, + "DEFER": true, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": true, + "CHECKLIST_ADD_ITEMS": true, + "ADD_FAVORITE": true, + "DELETE_FAVORITE": false, + "RATE": true, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": true, + "ELAPSEDTIME.ADD": true, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": true, + "CHECKLIST.ADD": true, + "FAVORITE.ADD": true, + "FAVORITE.DELETE": false + }, + "10": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": false, + "APPROVE": false, + "DISAPPROVE": false, + "START": false, + "PAUSE": false, + "DELEGATE": false, + "REMOVE": false, + "EDIT": false, + "DEFER": false, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": false, + "CHECKLIST_ADD_ITEMS": false, + "ADD_FAVORITE": false, + "DELETE_FAVORITE": false, + "RATE": false, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": false, + "ELAPSEDTIME.ADD": false, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": false, + "CHECKLIST.ADD": false, + "FAVORITE.ADD": false, + "FAVORITE.DELETE": false + } + } + }, + "time": { + "start": 1728454785.80063, + "finish": 1728454785.85694, + "duration": 0.0563130378723144, + "processing": 0.0311760902404785, + "date_start": "2024-10-09T09:19:45+03:00", + "date_finish": "2024-10-09T09:19:45+03:00", + "operating_reset_at": 1728455385, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md deleted file mode 100644 index 0e1c045b90..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Complete task - Complete task by ID - - - -`Function CompleteTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_complete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.CompleteTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.CompleteTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:39+03:00", - "statusChangedBy": "1", - "closedBy": "1", - "closedDate": "2024-10-09T09:19:39+03:00", - "activityDate": "2024-10-09T09:19:39+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "2", - "serviceCommentsCount": "2", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "6", - "viewedDate": "2024-10-09T09:19:40+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "5", - "statusChangedDate": "2024-10-09T09:19:39+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": false, - "approve": false, - "disapprove": false, - "start": false, - "pause": false, - "delegate": false, - "remove": true, - "edit": true, - "defer": false, - "renew": true, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454779.77336, - "finish": 1728454780.18854, - "duration": 0.41517186164856, - "processing": 0.387953042984009, - "date_start": "2024-10-09T09:19:39+03:00", - "date_finish": "2024-10-09T09:19:40+03:00", - "operating_reset_at": 1728455379, - "operating": 0.387924909591675 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Complete-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.mdx new file mode 100644 index 0000000000..aa0a84293b --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Complete task + Complete task by ID + + + +`Function CompleteTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_complete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.CompleteTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.CompleteTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:39+03:00", + "statusChangedBy": "1", + "closedBy": "1", + "closedDate": "2024-10-09T09:19:39+03:00", + "activityDate": "2024-10-09T09:19:39+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "2", + "serviceCommentsCount": "2", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "6", + "viewedDate": "2024-10-09T09:19:40+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "5", + "statusChangedDate": "2024-10-09T09:19:39+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": false, + "approve": false, + "disapprove": false, + "start": false, + "pause": false, + "delegate": false, + "remove": true, + "edit": true, + "defer": false, + "renew": true, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454779.77336, + "finish": 1728454780.18854, + "duration": 0.41517186164856, + "processing": 0.387953042984009, + "date_start": "2024-10-09T09:19:39+03:00", + "date_finish": "2024-10-09T09:19:40+03:00", + "operating_reset_at": 1728455379, + "operating": 0.387924909591675 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-task.md b/docs/en/md/Bitrix24/Tasks-managment/Create-task.md deleted file mode 100644 index 9a1b271ae3..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Create-task.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create task - Create new task by fields structure (see GetTaskFieldsStructure) - - - -`Function CreateTask(Val URL, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldsStructure | --fields | Structure of KeyAndValue | Task fields structure (see GetTaskFieldsStructure) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_add.php) -::: -
- - -```bsl title="Code example" - // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() - - CurrentDate = OPI_Tools.GetCurrentDate(); - Hour = 3600; - Day = 24; - Responsible = 1; - - TaskData = New Structure; - TaskData.Insert("TITLE" , "New task"); - TaskData.Insert("DESCRIPTION" , "New task description"); - TaskData.Insert("PRIORITY" , "2"); - TaskData.Insert("DEADLINE" , CurrentDate + Hour * Day); - TaskData.Insert("RESPONSIBLE_ID", Responsible); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateTask(URL, TaskData); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateTask(URL, TaskData, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "New task", - "description": "New task description", - "mark": null, - "priority": "2", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:28+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-09T09:19:28+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "1", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:28+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454768.77934, - "finish": 1728454768.94599, - "duration": 0.166647911071777, - "processing": 0.140867948532104, - "date_start": "2024-10-09T09:19:28+03:00", - "date_finish": "2024-10-09T09:19:28+03:00", - "operating_reset_at": 1728455368, - "operating": 0.140851020812988 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Create-task.mdx new file mode 100644 index 0000000000..8dec3a0af0 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-task.mdx @@ -0,0 +1,204 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create task + Create new task by fields structure (see GetTaskFieldsStructure) + + + +`Function CreateTask(Val URL, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldsStructure | --fields | Structure of KeyAndValue | Task fields structure (see GetTaskFieldsStructure) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_add.php) +::: +
+ + +```bsl title="Code example" + // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() + + CurrentDate = OPI_Tools.GetCurrentDate(); + Hour = 3600; + Day = 24; + Responsible = 1; + + TaskData = New Structure; + TaskData.Insert("TITLE" , "New task"); + TaskData.Insert("DESCRIPTION" , "New task description"); + TaskData.Insert("PRIORITY" , "2"); + TaskData.Insert("DEADLINE" , CurrentDate + Hour * Day); + TaskData.Insert("RESPONSIBLE_ID", Responsible); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateTask(URL, TaskData); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateTask(URL, TaskData, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "New task", + "description": "New task description", + "mark": null, + "priority": "2", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:28+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-09T09:19:28+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "1", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:28+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454768.77934, + "finish": 1728454768.94599, + "duration": 0.166647911071777, + "processing": 0.140867948532104, + "date_start": "2024-10-09T09:19:28+03:00", + "date_finish": "2024-10-09T09:19:28+03:00", + "operating_reset_at": 1728455368, + "operating": 0.140851020812988 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md deleted file mode 100644 index 19f11b86d2..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 23 ---- - -# Create tasks dependencies - Creates the dependency of one task to another - - - -`Function CreateTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FromID | --taskfrom | String, Number | From task ID | - | DestinationID | --taskto | String, Number | To task ID | - | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) -::: -
- - -```bsl title="Code example" - FromID = "2446"; - DestinationID = "2448"; - LinkType = 0; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType); - - FromID = "2448"; - DestinationID = "2446"; - LinkType = 2; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType, Token); -``` - - - - -```json title="Result" -{ - "result": [], - "time": { - "start": 1728454774.59977, - "finish": 1728454774.6891, - "duration": 0.0893309116363525, - "processing": 0.0593829154968262, - "date_start": "2024-10-09T09:19:34+03:00", - "date_finish": "2024-10-09T09:19:34+03:00", - "operating_reset_at": 1728455374, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.mdx b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.mdx new file mode 100644 index 0000000000..f0d09fd1de --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 23 +--- + +# Create tasks dependencies + Creates the dependency of one task to another + + + +`Function CreateTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FromID | --taskfrom | String, Number | From task ID | + | DestinationID | --taskto | String, Number | To task ID | + | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) +::: +
+ + +```bsl title="Code example" + FromID = "2446"; + DestinationID = "2448"; + LinkType = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType); + + FromID = "2448"; + DestinationID = "2446"; + LinkType = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType, Token); +``` + + + + +```json title="Result" +{ + "result": [], + "time": { + "start": 1728454774.59977, + "finish": 1728454774.6891, + "duration": 0.0893309116363525, + "processing": 0.0593829154968262, + "date_start": "2024-10-09T09:19:34+03:00", + "date_finish": "2024-10-09T09:19:34+03:00", + "operating_reset_at": 1728455374, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md deleted file mode 100644 index 3707d7b348..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Defer task - Defer task by ID - - - -`Function DeferTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.defer](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_defer.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.DeferTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.DeferTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:39+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-09T09:19:38+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "1", - "serviceCommentsCount": "1", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "5", - "viewedDate": "2024-10-09T09:19:38+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "6", - "statusChangedDate": "2024-10-09T09:19:39+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": true, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454778.99194, - "finish": 1728454779.24467, - "duration": 0.252730131149292, - "processing": 0.22677493095398, - "date_start": "2024-10-09T09:19:38+03:00", - "date_finish": "2024-10-09T09:19:39+03:00", - "operating_reset_at": 1728455379, - "operating": 0.226752042770386 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Defer-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.mdx new file mode 100644 index 0000000000..90489a5b0e --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Defer task + Defer task by ID + + + +`Function DeferTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.defer](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_defer.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.DeferTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.DeferTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:39+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-09T09:19:38+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "1", + "serviceCommentsCount": "1", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "5", + "viewedDate": "2024-10-09T09:19:38+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "6", + "statusChangedDate": "2024-10-09T09:19:39+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": true, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454778.99194, + "finish": 1728454779.24467, + "duration": 0.252730131149292, + "processing": 0.22677493095398, + "date_start": "2024-10-09T09:19:38+03:00", + "date_finish": "2024-10-09T09:19:39+03:00", + "operating_reset_at": 1728455379, + "operating": 0.226752042770386 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md deleted file mode 100644 index f02f884833..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -sidebar_position: 16 ---- - -# Delegate task - Delegate task to another user - - - -`Function DelegateTask(Val URL, Val TaskID, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | UserID | --user | Number, String | ID of responsible user | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.delegate](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delegate.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - UserID = "626"; - - Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:38+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-09T09:19:38+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "1", - "serviceCommentsCount": "1", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "4", - "viewedDate": "2024-10-09T09:19:38+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:38+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454778.03536, - "finish": 1728454778.4922, - "duration": 0.45684289932251, - "processing": 0.422222852706909, - "date_start": "2024-10-09T09:19:38+03:00", - "date_finish": "2024-10-09T09:19:38+03:00", - "operating_reset_at": 1728455378, - "operating": 0.422200918197632 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.mdx new file mode 100644 index 0000000000..9107baccde --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.mdx @@ -0,0 +1,194 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 16 +--- + +# Delegate task + Delegate task to another user + + + +`Function DelegateTask(Val URL, Val TaskID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | UserID | --user | Number, String | ID of responsible user | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.delegate](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delegate.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + UserID = "626"; + + Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:38+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-09T09:19:38+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "1", + "serviceCommentsCount": "1", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "4", + "viewedDate": "2024-10-09T09:19:38+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:38+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454778.03536, + "finish": 1728454778.4922, + "duration": 0.45684289932251, + "processing": 0.422222852706909, + "date_start": "2024-10-09T09:19:38+03:00", + "date_finish": "2024-10-09T09:19:38+03:00", + "operating_reset_at": 1728455378, + "operating": 0.422200918197632 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md deleted file mode 100644 index ba4e6bf103..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete task - Delete task by ID - - - -`Function DeleteTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.DeleteTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.DeleteTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": true - }, - "time": { - "start": 1728454790.93474, - "finish": 1728454791.12862, - "duration": 0.193886995315552, - "processing": 0.171198129653931, - "date_start": "2024-10-09T09:19:50+03:00", - "date_finish": "2024-10-09T09:19:51+03:00", - "operating_reset_at": 1728455390, - "operating": 0.171180963516235 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.mdx new file mode 100644 index 0000000000..d3734119e6 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete task + Delete task by ID + + + +`Function DeleteTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.DeleteTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.DeleteTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": true + }, + "time": { + "start": 1728454790.93474, + "finish": 1728454791.12862, + "duration": 0.193886995315552, + "processing": 0.171198129653931, + "date_start": "2024-10-09T09:19:50+03:00", + "date_finish": "2024-10-09T09:19:51+03:00", + "operating_reset_at": 1728455390, + "operating": 0.171180963516235 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md deleted file mode 100644 index 7f42c7bac7..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 24 ---- - -# Delete tasks dependencies - Removes the dependency of one task to another - - - -`Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FromID | --taskfrom | String, Number | From task ID | - | DestinationID | --taskto | String, Number | To task ID | - | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) -::: -
- - -```bsl title="Code example" - FromID = "2446"; - DestinationID = "2448"; - LinkType = 0; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.DeleteTasksDependencies(URL, FromID, DestinationID, LinkType); - - FromID = "2448"; - DestinationID = "2446"; - LinkType = 2; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.DeleteTasksDependencies(URL, FromID, DestinationID, LinkType, Token); -``` - - - - -```json title="Result" -{ - "result": [], - "time": { - "start": 1728454775.18853, - "finish": 1728454775.22678, - "duration": 0.0382490158081055, - "processing": 0.0094759464263916, - "date_start": "2024-10-09T09:19:35+03:00", - "date_finish": "2024-10-09T09:19:35+03:00", - "operating_reset_at": 1728455375, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.mdx b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.mdx new file mode 100644 index 0000000000..1a2866266c --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 24 +--- + +# Delete tasks dependencies + Removes the dependency of one task to another + + + +`Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FromID | --taskfrom | String, Number | From task ID | + | DestinationID | --taskto | String, Number | To task ID | + | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) +::: +
+ + +```bsl title="Code example" + FromID = "2446"; + DestinationID = "2448"; + LinkType = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.DeleteTasksDependencies(URL, FromID, DestinationID, LinkType); + + FromID = "2448"; + DestinationID = "2446"; + LinkType = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.DeleteTasksDependencies(URL, FromID, DestinationID, LinkType, Token); +``` + + + + +```json title="Result" +{ + "result": [], + "time": { + "start": 1728454775.18853, + "finish": 1728454775.22678, + "duration": 0.0382490158081055, + "processing": 0.0094759464263916, + "date_start": "2024-10-09T09:19:35+03:00", + "date_finish": "2024-10-09T09:19:35+03:00", + "operating_reset_at": 1728455375, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md deleted file mode 100644 index 9a244e1c0b..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Disapprove task - Disapprove task by ID - - - -`Function DisapproveTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.disapprove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_disapprove.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.DisapproveTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.DisapproveTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "error": 1048582, - "error_description": "Действие над задачей не разрешено" -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.mdx new file mode 100644 index 0000000000..9ce9ad7004 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Disapprove task + Disapprove task by ID + + + +`Function DisapproveTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.disapprove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_disapprove.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.DisapproveTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.DisapproveTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "error": 1048582, + "error_description": "Действие над задачей не разрешено" +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md deleted file mode 100644 index 53631371d8..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 25 ---- - -# Get users daily tasks plan - Gets the task plan for the current users day - - - -`Function GetDailyPlan(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetDailyPlan(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetDailyPlan(URL, Token); -``` - - - - -```json title="Result" -{ - "result": [], - "time": { - "start": 1728454787.66892, - "finish": 1728454787.69815, - "duration": 0.0292289257049561, - "processing": 0.000327110290527344, - "date_start": "2024-10-09T09:19:47+03:00", - "date_finish": "2024-10-09T09:19:47+03:00", - "operating_reset_at": 1728455387, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.mdx b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.mdx new file mode 100644 index 0000000000..5dff621b51 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 25 +--- + +# Get users daily tasks plan + Gets the task plan for the current users day + + + +`Function GetDailyPlan(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetDailyPlan(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetDailyPlan(URL, Token); +``` + + + + +```json title="Result" +{ + "result": [], + "time": { + "start": 1728454787.66892, + "finish": 1728454787.69815, + "duration": 0.0292289257049561, + "processing": 0.000327110290527344, + "date_start": "2024-10-09T09:19:47+03:00", + "date_finish": "2024-10-09T09:19:47+03:00", + "operating_reset_at": 1728455387, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md deleted file mode 100644 index 4ee28f6c19..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_position: 26 ---- - -# Get task fields structure - Gets a structure with a description of the fields for creating a task - - - -`Function GetTaskFieldsStructure(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetTaskFieldsStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token); -``` - - - - -```json title="Result" -{ - "result": { - "fields": { - "ID": { - "title": "ID", - "type": "integer", - "primary": true - }, - "PARENT_ID": { - "title": "ID базовой задачи", - "type": "integer", - "default": 0 - }, - "TITLE": { - "title": "Название", - "type": "string", - "required": true - }, - "DESCRIPTION": { - "title": "Описание", - "type": "string" - }, - "MARK": { - "title": "Оценка", - "type": "enum", - "values": { - "N": "Отрицательная", - "P": "Положительная" - }, - "default": null - }, - "PRIORITY": { - "title": "Приоритет", - "type": "enum", - "values": { - "2": "Высокий", - "1": "Средний", - "0": "Низкий" - }, - "default": 1 - }, - "STATUS": { - "title": "Статус", - "type": "enum", - "values": { - "2": "Ждёт выполнения", - "3": "Выполняется", - "4": "Ожидает контроля", - "5": "Завершена", - "6": "Отложена" - }, - "default": 2 - }, - "MULTITASK": { - "title": "Множественная задача", - "type": "enum", - "values": { - "Y": "Да", - "N": "Нет" - }, - "default": "N" - }, - "NOT_VIEWED": { - "title": null, - "type": "enum", - "values": { - "Y": "Да", - "N": "Нет" - }, - "default": "N" - }, - "REPLICATE": { - "title": "Повторяемая задача", - "type": "enum", - "values": { - "Y": "Да", - "N": "Нет" - }, - "default": "N" - }, - "GROUP_ID": { - "title": "Проект", - "type": "integer", - "default": 0 - }, - "STAGE_ID": { - "title": "Стадия", - "type": "integer", - "default": 0 - }, - "CREATED_BY": { - "title": "Постановщик", - "type": "integer", - "required": true - }, - "CREATED_DATE": { - "title": null, - "type": "datetime" - }, - "RESPONSIBLE_ID": { - "title": "Исполнитель", - "type": "integer", - "required": true - }, - "ACCOMPLICES": { - "title": null, - "type": "array" - }, - "AUDITORS": { - "title": null, - "type": "array" - }, - "CHANGED_BY": { - "title": "Изменил", - "type": "integer" - }, - "CHANGED_DATE": { - "title": "Дата изменения", - "type": "datetime" - }, - "STATUS_CHANGED_BY": { - "title": "Изменил статус", - "type": "integer" - }, - "STATUS_CHANGED_DATE": { - "title": "Дата изменения статуса", - "type": "datetime" - }, - "CLOSED_BY": { - "title": "Закрыл задачу", - "type": "integer", - "default": null - }, - "CLOSED_DATE": { - "title": "Дата закрытия", - "type": "datetime", - "default": null - }, - "ACTIVITY_DATE": { - "title": null, - "type": "datetime", - "default": null - }, - "DATE_START": { - "title": "Дата начала", - "type": "datetime", - "default": null - }, - "DEADLINE": { - "title": "Крайний срок", -... -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.mdx b/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.mdx new file mode 100644 index 0000000000..3e247444a9 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.mdx @@ -0,0 +1,197 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 26 +--- + +# Get task fields structure + Gets a structure with a description of the fields for creating a task + + + +`Function GetTaskFieldsStructure(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetTaskFieldsStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token); +``` + + + + +```json title="Result" +{ + "result": { + "fields": { + "ID": { + "title": "ID", + "type": "integer", + "primary": true + }, + "PARENT_ID": { + "title": "ID базовой задачи", + "type": "integer", + "default": 0 + }, + "TITLE": { + "title": "Название", + "type": "string", + "required": true + }, + "DESCRIPTION": { + "title": "Описание", + "type": "string" + }, + "MARK": { + "title": "Оценка", + "type": "enum", + "values": { + "N": "Отрицательная", + "P": "Положительная" + }, + "default": null + }, + "PRIORITY": { + "title": "Приоритет", + "type": "enum", + "values": { + "2": "Высокий", + "1": "Средний", + "0": "Низкий" + }, + "default": 1 + }, + "STATUS": { + "title": "Статус", + "type": "enum", + "values": { + "2": "Ждёт выполнения", + "3": "Выполняется", + "4": "Ожидает контроля", + "5": "Завершена", + "6": "Отложена" + }, + "default": 2 + }, + "MULTITASK": { + "title": "Множественная задача", + "type": "enum", + "values": { + "Y": "Да", + "N": "Нет" + }, + "default": "N" + }, + "NOT_VIEWED": { + "title": null, + "type": "enum", + "values": { + "Y": "Да", + "N": "Нет" + }, + "default": "N" + }, + "REPLICATE": { + "title": "Повторяемая задача", + "type": "enum", + "values": { + "Y": "Да", + "N": "Нет" + }, + "default": "N" + }, + "GROUP_ID": { + "title": "Проект", + "type": "integer", + "default": 0 + }, + "STAGE_ID": { + "title": "Стадия", + "type": "integer", + "default": 0 + }, + "CREATED_BY": { + "title": "Постановщик", + "type": "integer", + "required": true + }, + "CREATED_DATE": { + "title": null, + "type": "datetime" + }, + "RESPONSIBLE_ID": { + "title": "Исполнитель", + "type": "integer", + "required": true + }, + "ACCOMPLICES": { + "title": null, + "type": "array" + }, + "AUDITORS": { + "title": null, + "type": "array" + }, + "CHANGED_BY": { + "title": "Изменил", + "type": "integer" + }, + "CHANGED_DATE": { + "title": "Дата изменения", + "type": "datetime" + }, + "STATUS_CHANGED_BY": { + "title": "Изменил статус", + "type": "integer" + }, + "STATUS_CHANGED_DATE": { + "title": "Дата изменения статуса", + "type": "datetime" + }, + "CLOSED_BY": { + "title": "Закрыл задачу", + "type": "integer", + "default": null + }, + "CLOSED_DATE": { + "title": "Дата закрытия", + "type": "datetime", + "default": null + }, + "ACTIVITY_DATE": { + "title": null, + "type": "datetime", + "default": null + }, + "DATE_START": { + "title": "Дата начала", + "type": "datetime", + "default": null + }, + "DEADLINE": { + "title": "Крайний срок", +... +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md deleted file mode 100644 index dd518a62e1..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 19 ---- - -# Get task history - Get history of task changing - - - -`Function GetTaskHistory(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.history.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_history_list.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "list": [ - { - "id": "29926", - "createdDate": "09.10.2024 09:19:28", - "field": "NEW", - "value": { - "from": null, - "to": null - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29928", - "createdDate": "09.10.2024 09:19:34", - "field": "START_DATE_PLAN", - "value": { - "from": "", - "to": "1728454768" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29930", - "createdDate": "09.10.2024 09:19:34", - "field": "END_DATE_PLAN", - "value": { - "from": "", - "to": "1728507600" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29932", - "createdDate": "09.10.2024 09:19:34", - "field": "DURATION_PLAN_SECONDS", - "value": { - "from": "", - "to": "52832" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29946", - "createdDate": "09.10.2024 09:19:35", - "field": "TITLE", - "value": { - "from": "New task", - "to": "Another task title" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29948", - "createdDate": "09.10.2024 09:19:35", - "field": "DESCRIPTION", - "value": { - "from": "", - "to": "" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29950", - "createdDate": "09.10.2024 09:19:35", - "field": "PRIORITY", - "value": { - "from": "2", - "to": "1" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29956", - "createdDate": "09.10.2024 09:19:38", - "field": "RESPONSIBLE_ID", - "value": { - "from": "1", - "to": "602" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29958", - "createdDate": "09.10.2024 09:19:38", - "field": "COMMENT", - "value": { - "from": null, - "to": "5932" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29962", - "createdDate": "09.10.2024 09:19:39", -... -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.mdx b/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.mdx new file mode 100644 index 0000000000..108b6c57f1 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 19 +--- + +# Get task history + Get history of task changing + + + +`Function GetTaskHistory(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.history.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_history_list.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "list": [ + { + "id": "29926", + "createdDate": "09.10.2024 09:19:28", + "field": "NEW", + "value": { + "from": null, + "to": null + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29928", + "createdDate": "09.10.2024 09:19:34", + "field": "START_DATE_PLAN", + "value": { + "from": "", + "to": "1728454768" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29930", + "createdDate": "09.10.2024 09:19:34", + "field": "END_DATE_PLAN", + "value": { + "from": "", + "to": "1728507600" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29932", + "createdDate": "09.10.2024 09:19:34", + "field": "DURATION_PLAN_SECONDS", + "value": { + "from": "", + "to": "52832" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29946", + "createdDate": "09.10.2024 09:19:35", + "field": "TITLE", + "value": { + "from": "New task", + "to": "Another task title" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29948", + "createdDate": "09.10.2024 09:19:35", + "field": "DESCRIPTION", + "value": { + "from": "", + "to": "" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29950", + "createdDate": "09.10.2024 09:19:35", + "field": "PRIORITY", + "value": { + "from": "2", + "to": "1" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29956", + "createdDate": "09.10.2024 09:19:38", + "field": "RESPONSIBLE_ID", + "value": { + "from": "1", + "to": "602" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29958", + "createdDate": "09.10.2024 09:19:38", + "field": "COMMENT", + "value": { + "from": null, + "to": "5932" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29962", + "createdDate": "09.10.2024 09:19:39", +... +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task.md deleted file mode 100644 index 3703f26a21..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get task - Get task by ID - - - -`Function GetTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.GetTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.GetTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:35+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-09T09:19:28+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:35+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454776.10713, - "finish": 1728454776.1767, - "duration": 0.069572925567627, - "processing": 0.0405688285827637, - "date_start": "2024-10-09T09:19:36+03:00", - "date_finish": "2024-10-09T09:19:36+03:00", - "operating_reset_at": 1728455376, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Get-task.mdx new file mode 100644 index 0000000000..daddf6b3c3 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get task + Get task by ID + + + +`Function GetTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.GetTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.GetTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:35+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-09T09:19:28+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:35+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454776.10713, + "finish": 1728454776.1767, + "duration": 0.069572925567627, + "processing": 0.0405688285827637, + "date_start": "2024-10-09T09:19:36+03:00", + "date_finish": "2024-10-09T09:19:36+03:00", + "operating_reset_at": 1728455376, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md deleted file mode 100644 index 4e12f828f8..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 27 ---- - -# Get structure of tasks filter - Return filter structure for GetTasksList - - - -`Function GetTasksFilterStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Bitrix24.GetTasksFilterStructure(); -``` - - - - -```json title="Result" -{ - "ID": "", - "PARENT_ID": "", - "GROUP_ID": "", - "CREATED_BY": "", - "STATUS_CHANGED_BY": "", - "PRIORITY": "", - "FORUM_TOPIC_ID": "", - "RESPONSIBLE_ID": "", - "TITLE": "", - "TAG": "", - "REAL_STATUS": "", - "MARK": "", - "SITE_ID": "", - "ADD_IN_REPORT": "", - "DATE_START": "", - "DEADLINE": "", - "CREATED_DATE": "", - "CLOSED_DATE": "", - "CHANGED_DATE": "", - "ACCOMPLICE": "", - "AUDITOR": "", - "DEPENDS_ON": "", - "ONLY_ROOT_TASKS": "", - "STAGE_ID": "", - "UF_CRM_TASK": "", - "STATUS": "" -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.mdx b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.mdx new file mode 100644 index 0000000000..584f7a9162 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 27 +--- + +# Get structure of tasks filter + Return filter structure for GetTasksList + + + +`Function GetTasksFilterStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Bitrix24.GetTasksFilterStructure(); +``` + + + + +```json title="Result" +{ + "ID": "", + "PARENT_ID": "", + "GROUP_ID": "", + "CREATED_BY": "", + "STATUS_CHANGED_BY": "", + "PRIORITY": "", + "FORUM_TOPIC_ID": "", + "RESPONSIBLE_ID": "", + "TITLE": "", + "TAG": "", + "REAL_STATUS": "", + "MARK": "", + "SITE_ID": "", + "ADD_IN_REPORT": "", + "DATE_START": "", + "DEADLINE": "", + "CREATED_DATE": "", + "CLOSED_DATE": "", + "CHANGED_DATE": "", + "ACCOMPLICE": "", + "AUDITOR": "", + "DEPENDS_ON": "", + "ONLY_ROOT_TASKS": "", + "STAGE_ID": "", + "UF_CRM_TASK": "", + "STATUS": "" +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md deleted file mode 100644 index b913a7a089..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get tasks list - Get tasks list (50 at one response max)) - - - -`Function GetTasksList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Filter | --filter | Structure of KeyAndValue | Structure of task filter (see GetTaskFieldsStructure) | - | Indent | --offset | Number, String | Offset of tasks list | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php) -::: -
- - -```bsl title="Code example" - // Full filter structure you can find at GetTasksFilterStructure method - Filter = New Structure; - Filter.Insert("CREATED_BY" , 1); - Filter.Insert("RESPONSIBLE_ID", 10); - - Indent = 1; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetTasksList(URL, Filter); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTasksList(URL, , Indent, Token); -``` - - - - -```json title="Result" -{ - "result": { - "tasks": [ - { - "id": "268", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T16:21:01+03:00", - "responsibleId": "10", - "changedBy": "1", - "changedDate": "2024-07-03T16:21:14+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-07-04T20:03:10+03:00", - "dateStart": "2024-07-03T16:21:12+03:00", - "deadline": "2024-07-04T16:21:00+03:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{29e9893d-226b-43a1-80bb-60af6434070f}", - "xmlId": null, - "commentsCount": "4", - "serviceCommentsCount": "4", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "258", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-07-04T20:03:10+03:00", - "sorting": "1024.0000000", - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T16:21:14+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "newCommentsCount": 0, - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "10", - "name": "Techno Pizza", - "link": "/company/personal/user/10/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "subStatus": "-1" - }, - { - "id": "270", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T16:21:02+03:00", - "responsibleId": "10", - "changedBy": "1", - "changedDate": "2024-07-03T16:21:14+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-07-04T20:03:10+03:00", - "dateStart": "2024-07-03T16:21:13+03:00", - "deadline": "2024-07-04T16:21:00+03:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{c8004012-7ca9-42da-b985-a1c0e90a285a}", - "xmlId": null, - "commentsCount": "4", - "serviceCommentsCount": "4", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "260", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-07-04T20:03:10+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T16:21:14+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "newCommentsCount": 0, - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, -... -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.mdx b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.mdx new file mode 100644 index 0000000000..6de5680f25 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.mdx @@ -0,0 +1,205 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get tasks list + Get tasks list (50 at one response max)) + + + +`Function GetTasksList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Filter | --filter | Structure of KeyAndValue | Structure of task filter (see GetTaskFieldsStructure) | + | Indent | --offset | Number, String | Offset of tasks list | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php) +::: +
+ + +```bsl title="Code example" + // Full filter structure you can find at GetTasksFilterStructure method + Filter = New Structure; + Filter.Insert("CREATED_BY" , 1); + Filter.Insert("RESPONSIBLE_ID", 10); + + Indent = 1; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetTasksList(URL, Filter); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTasksList(URL, , Indent, Token); +``` + + + + +```json title="Result" +{ + "result": { + "tasks": [ + { + "id": "268", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T16:21:01+03:00", + "responsibleId": "10", + "changedBy": "1", + "changedDate": "2024-07-03T16:21:14+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-07-04T20:03:10+03:00", + "dateStart": "2024-07-03T16:21:12+03:00", + "deadline": "2024-07-04T16:21:00+03:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{29e9893d-226b-43a1-80bb-60af6434070f}", + "xmlId": null, + "commentsCount": "4", + "serviceCommentsCount": "4", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "258", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-07-04T20:03:10+03:00", + "sorting": "1024.0000000", + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T16:21:14+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "newCommentsCount": 0, + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "10", + "name": "Techno Pizza", + "link": "/company/personal/user/10/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "subStatus": "-1" + }, + { + "id": "270", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T16:21:02+03:00", + "responsibleId": "10", + "changedBy": "1", + "changedDate": "2024-07-03T16:21:14+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-07-04T20:03:10+03:00", + "dateStart": "2024-07-03T16:21:13+03:00", + "deadline": "2024-07-04T16:21:00+03:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{c8004012-7ca9-42da-b985-a1c0e90a285a}", + "xmlId": null, + "commentsCount": "4", + "serviceCommentsCount": "4", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "260", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-07-04T20:03:10+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T16:21:14+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "newCommentsCount": 0, + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, +... +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md deleted file mode 100644 index c0be9613a6..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 21 ---- - -# Mute task - Mute task by ID - - - -`Function MuteTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.MuteTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.MuteTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:35+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-09T09:19:28+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "Y", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:35+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454776.52926, - "finish": 1728454776.60538, - "duration": 0.0761229991912842, - "processing": 0.0412311553955078, - "date_start": "2024-10-09T09:19:36+03:00", - "date_finish": "2024-10-09T09:19:36+03:00", - "operating_reset_at": 1728455376, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.mdx new file mode 100644 index 0000000000..910a1e61a9 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 21 +--- + +# Mute task + Mute task by ID + + + +`Function MuteTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.MuteTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.MuteTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:35+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-09T09:19:28+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "Y", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:35+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454776.52926, + "finish": 1728454776.60538, + "duration": 0.0761229991912842, + "processing": 0.0412311553955078, + "date_start": "2024-10-09T09:19:36+03:00", + "date_finish": "2024-10-09T09:19:36+03:00", + "operating_reset_at": 1728455376, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md deleted file mode 100644 index 94404f0c42..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Pause task - Pause a task by ID - - - -`Function PauseTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.pause](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_pause.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.PauseTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.PauseTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:43+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-09T09:19:41+03:00", - "dateStart": "2024-10-09T09:19:42+03:00", - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "10", - "viewedDate": "2024-10-09T09:19:41+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:43+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454783.39859, - "finish": 1728454783.66881, - "duration": 0.270220041275024, - "processing": 0.236293077468872, - "date_start": "2024-10-09T09:19:43+03:00", - "date_finish": "2024-10-09T09:19:43+03:00", - "operating_reset_at": 1728455383, - "operating": 0.236268043518066 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Pause-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.mdx new file mode 100644 index 0000000000..1e18e40d62 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Pause task + Pause a task by ID + + + +`Function PauseTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.pause](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_pause.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.PauseTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.PauseTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:43+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-09T09:19:41+03:00", + "dateStart": "2024-10-09T09:19:42+03:00", + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "10", + "viewedDate": "2024-10-09T09:19:41+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:43+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454783.39859, + "finish": 1728454783.66881, + "duration": 0.270220041275024, + "processing": 0.236293077468872, + "date_start": "2024-10-09T09:19:43+03:00", + "date_finish": "2024-10-09T09:19:43+03:00", + "operating_reset_at": 1728455383, + "operating": 0.236268043518066 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md b/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md deleted file mode 100644 index 7a85b3f03d..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 18 ---- - -# Remove task from favorites list - Delete task from favorites list - - - -`Function RemoveTaskFromFavorites(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.favorite.remove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_remove.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454777.3337, - "finish": 1728454777.3811, - "duration": 0.0473968982696533, - "processing": 0.0112500190734863, - "date_start": "2024-10-09T09:19:37+03:00", - "date_finish": "2024-10-09T09:19:37+03:00", - "operating_reset_at": 1728455377, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.mdx b/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.mdx new file mode 100644 index 0000000000..6b05429277 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 18 +--- + +# Remove task from favorites list + Delete task from favorites list + + + +`Function RemoveTaskFromFavorites(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.favorite.remove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_remove.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454777.3337, + "finish": 1728454777.3811, + "duration": 0.0473968982696533, + "processing": 0.0112500190734863, + "date_start": "2024-10-09T09:19:37+03:00", + "date_finish": "2024-10-09T09:19:37+03:00", + "operating_reset_at": 1728455377, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md deleted file mode 100644 index 4d8f397515..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Renew task - Returns a task to work by ID - - - -`Function RenewTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_renew.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.RenewTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.RenewTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:41+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-09T09:19:41+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "7", - "viewedDate": "2024-10-09T09:19:41+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:41+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454781.248, - "finish": 1728454781.64283, - "duration": 0.394833087921143, - "processing": 0.365943908691406, - "date_start": "2024-10-09T09:19:41+03:00", - "date_finish": "2024-10-09T09:19:41+03:00", - "operating_reset_at": 1728455381, - "operating": 0.365924119949341 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.mdx new file mode 100644 index 0000000000..cb8c45bfa5 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Renew task + Returns a task to work by ID + + + +`Function RenewTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_renew.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.RenewTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.RenewTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:41+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-09T09:19:41+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "7", + "viewedDate": "2024-10-09T09:19:41+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:41+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454781.248, + "finish": 1728454781.64283, + "duration": 0.394833087921143, + "processing": 0.365943908691406, + "date_start": "2024-10-09T09:19:41+03:00", + "date_finish": "2024-10-09T09:19:41+03:00", + "operating_reset_at": 1728455381, + "operating": 0.365924119949341 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-task.md b/docs/en/md/Bitrix24/Tasks-managment/Start-task.md deleted file mode 100644 index 0d0297c3a7..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Start-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Start a task - Start a task by ID - - - -`Function StartTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.start](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_start.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.StartTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.StartTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:42+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-09T09:19:41+03:00", - "dateStart": "2024-10-09T09:19:42+03:00", - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "8", - "viewedDate": "2024-10-09T09:19:41+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "3", - "statusChangedDate": "2024-10-09T09:19:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": true, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454782.01561, - "finish": 1728454782.2752, - "duration": 0.259591102600098, - "processing": 0.224385976791382, - "date_start": "2024-10-09T09:19:42+03:00", - "date_finish": "2024-10-09T09:19:42+03:00", - "operating_reset_at": 1728455382, - "operating": 0.224359035491943 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Start-task.mdx new file mode 100644 index 0000000000..ddd199d735 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Start-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Start a task + Start a task by ID + + + +`Function StartTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.start](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_start.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.StartTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.StartTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:42+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-09T09:19:41+03:00", + "dateStart": "2024-10-09T09:19:42+03:00", + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "8", + "viewedDate": "2024-10-09T09:19:41+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "3", + "statusChangedDate": "2024-10-09T09:19:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": true, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454782.01561, + "finish": 1728454782.2752, + "duration": 0.259591102600098, + "processing": 0.224385976791382, + "date_start": "2024-10-09T09:19:42+03:00", + "date_finish": "2024-10-09T09:19:42+03:00", + "operating_reset_at": 1728455382, + "operating": 0.224359035491943 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md b/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md deleted file mode 100644 index dc4ffc731f..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Start watching a task - Start watching a task by ID - - - -`Function StartWatchingTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.startwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_startwatch.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "602", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:42+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-09T09:19:41+03:00", - "dateStart": "2024-10-09T09:19:42+03:00", - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1664", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-10-09T09:19:41+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "3", - "statusChangedDate": "2024-10-09T09:19:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": true, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454782.5961, - "finish": 1728454782.79934, - "duration": 0.203248977661133, - "processing": 0.176992893218994, - "date_start": "2024-10-09T09:19:42+03:00", - "date_finish": "2024-10-09T09:19:42+03:00", - "operating_reset_at": 1728455382, - "operating": 0.176972150802612 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.mdx new file mode 100644 index 0000000000..cad58081db --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Start watching a task + Start watching a task by ID + + + +`Function StartWatchingTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.startwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_startwatch.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "602", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:42+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-09T09:19:41+03:00", + "dateStart": "2024-10-09T09:19:42+03:00", + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1664", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-10-09T09:19:41+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "3", + "statusChangedDate": "2024-10-09T09:19:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": true, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454782.5961, + "finish": 1728454782.79934, + "duration": 0.203248977661133, + "processing": 0.176992893218994, + "date_start": "2024-10-09T09:19:42+03:00", + "date_finish": "2024-10-09T09:19:42+03:00", + "operating_reset_at": 1728455382, + "operating": 0.176972150802612 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md b/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md deleted file mode 100644 index e85454c63d..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 15 ---- - -# Stop watching the task - Stop watching a task by ID - - - -`Function StopWatchingTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.stopwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_stopwatch.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "title": "Another task title", - "description": "Another task description", - "descriptionInBbcode": "Y", - "declineReason": "", - "priority": "1", - "notViewed": "N", - "statusComplete": "1", - "multitask": "N", - "stageId": "0", - "responsibleId": "602", - "responsibleName": "Oleg", - "responsibleLastName": "Lama", - "responsibleSecondName": null, - "responsibleLogin": "c97e7aef-e5c1-4971-94a8-853cff3f0e5e@exepmple.org", - "responsibleWorkPosition": null, - "responsiblePhoto": null, - "dateStart": "2024-10-09T09:19:42+03:00", - "durationFact": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "replicate": "N", - "deadline": "2024-10-10T12:19:00+03:00", - "deadlineOrig": "10.10.2024 12:19:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "createdBy": "1", - "createdByName": "Антон", - "createdByLastName": "Титовец", - "createdBySecondName": null, - "createdByLogin": "VKuser657846756", - "createdByWorkPosition": null, - "createdByPhoto": "30", - "createdDate": "2024-10-09T09:19:28+03:00", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:42+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-09T09:19:41+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "mark": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "matchWorkTime": "N", - "taskControl": "N", - "addInReport": "N", - "forumTopicId": "1664", - "parentId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-10-09T09:19:41+03:00", - "deadlineCounted": "0", - "forkedByTemplateId": null, - "sorting": null, - "durationPlanSeconds": null, - "durationTypeAll": "days", - "scenarioName": [ - "default" - ], - "isRegular": "N", - "flowId": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "ufCrmTask": false, - "ufTaskWebdavFiles": false, - "ufMailMessage": null, - "status": "3", - "statusChangedDate": "2024-10-09T09:19:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "tags": [], - "checklist": [], - "files": [], - "dependsOn": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "602", - "name": "Oleg Lama", - "link": "/company/personal/user/602/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": true, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, -... -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.mdx new file mode 100644 index 0000000000..2651fa437b --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 15 +--- + +# Stop watching the task + Stop watching a task by ID + + + +`Function StopWatchingTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.stopwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_stopwatch.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "title": "Another task title", + "description": "Another task description", + "descriptionInBbcode": "Y", + "declineReason": "", + "priority": "1", + "notViewed": "N", + "statusComplete": "1", + "multitask": "N", + "stageId": "0", + "responsibleId": "602", + "responsibleName": "Oleg", + "responsibleLastName": "Lama", + "responsibleSecondName": null, + "responsibleLogin": "c97e7aef-e5c1-4971-94a8-853cff3f0e5e@exepmple.org", + "responsibleWorkPosition": null, + "responsiblePhoto": null, + "dateStart": "2024-10-09T09:19:42+03:00", + "durationFact": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "replicate": "N", + "deadline": "2024-10-10T12:19:00+03:00", + "deadlineOrig": "10.10.2024 12:19:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "createdBy": "1", + "createdByName": "Антон", + "createdByLastName": "Титовец", + "createdBySecondName": null, + "createdByLogin": "VKuser657846756", + "createdByWorkPosition": null, + "createdByPhoto": "30", + "createdDate": "2024-10-09T09:19:28+03:00", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:42+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-09T09:19:41+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "mark": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "matchWorkTime": "N", + "taskControl": "N", + "addInReport": "N", + "forumTopicId": "1664", + "parentId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-10-09T09:19:41+03:00", + "deadlineCounted": "0", + "forkedByTemplateId": null, + "sorting": null, + "durationPlanSeconds": null, + "durationTypeAll": "days", + "scenarioName": [ + "default" + ], + "isRegular": "N", + "flowId": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "ufCrmTask": false, + "ufTaskWebdavFiles": false, + "ufMailMessage": null, + "status": "3", + "statusChangedDate": "2024-10-09T09:19:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "tags": [], + "checklist": [], + "files": [], + "dependsOn": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "602", + "name": "Oleg Lama", + "link": "/company/personal/user/602/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": true, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, +... +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md deleted file mode 100644 index 1394980ed4..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 22 ---- - -# Unmute task - Unmute task by ID - - - -`Function UnmuteTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.UnmuteTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.UnmuteTask(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:35+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-09T09:19:28+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:35+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454776.89475, - "finish": 1728454776.96928, - "duration": 0.0745260715484619, - "processing": 0.0435051918029785, - "date_start": "2024-10-09T09:19:36+03:00", - "date_finish": "2024-10-09T09:19:36+03:00", - "operating_reset_at": 1728455376, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.mdx new file mode 100644 index 0000000000..c959ef37c0 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 22 +--- + +# Unmute task + Unmute task by ID + + + +`Function UnmuteTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.UnmuteTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.UnmuteTask(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:35+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-09T09:19:28+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:35+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454776.89475, + "finish": 1728454776.96928, + "duration": 0.0745260715484619, + "processing": 0.0435051918029785, + "date_start": "2024-10-09T09:19:36+03:00", + "date_finish": "2024-10-09T09:19:36+03:00", + "operating_reset_at": 1728455376, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Update-task.md b/docs/en/md/Bitrix24/Tasks-managment/Update-task.md deleted file mode 100644 index ce2f7fe7cb..0000000000 --- a/docs/en/md/Bitrix24/Tasks-managment/Update-task.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Update task - Update a task - - - -`Function UpdateTask(Val URL, Val TaskID, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | FieldsStructure | --fields | Structure of KeyAndValue | Task fields structure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_update.php) -::: -
- - -```bsl title="Code example" - // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() - - TaskData = New Structure; - TaskData.Insert("TITLE" , "Another task title"); - TaskData.Insert("DESCRIPTION", "Another task description"); - TaskData.Insert("PRIORITY" , "1"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2446"; - - Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - TaskID = "2448"; - - Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData, Token); -``` - - - - -```json title="Result" -{ - "result": { - "task": { - "id": "2398", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-09T09:19:28+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-09T09:19:35+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-09T09:19:28+03:00", - "dateStart": null, - "deadline": "2024-10-10T12:19:00+03:00", - "startDatePlan": "2024-10-09T09:19:28+03:00", - "endDatePlan": "2024-10-10T00:00:00+03:00", - "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-09T09:19:35+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728454775.71852, - "finish": 1728454775.9367, - "duration": 0.218183040618896, - "processing": 0.191415071487427, - "date_start": "2024-10-09T09:19:35+03:00", - "date_finish": "2024-10-09T09:19:35+03:00", - "operating_reset_at": 1728455375, - "operating": 0.19139289855957 - } -} -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Update-task.mdx b/docs/en/md/Bitrix24/Tasks-managment/Update-task.mdx new file mode 100644 index 0000000000..385a8baf27 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Update-task.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Update task + Update a task + + + +`Function UpdateTask(Val URL, Val TaskID, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | FieldsStructure | --fields | Structure of KeyAndValue | Task fields structure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_update.php) +::: +
+ + +```bsl title="Code example" + // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() + + TaskData = New Structure; + TaskData.Insert("TITLE" , "Another task title"); + TaskData.Insert("DESCRIPTION", "Another task description"); + TaskData.Insert("PRIORITY" , "1"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2446"; + + Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + TaskID = "2448"; + + Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData, Token); +``` + + + + +```json title="Result" +{ + "result": { + "task": { + "id": "2398", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-09T09:19:28+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-09T09:19:35+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-09T09:19:28+03:00", + "dateStart": null, + "deadline": "2024-10-10T12:19:00+03:00", + "startDatePlan": "2024-10-09T09:19:28+03:00", + "endDatePlan": "2024-10-10T00:00:00+03:00", + "guid": "{51464df0-4e32-4fbe-9e9c-5d7081eb0ffb}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-09T09:19:35+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728454775.71852, + "finish": 1728454775.9367, + "duration": 0.218183040618896, + "processing": 0.191415071487427, + "date_start": "2024-10-09T09:19:35+03:00", + "date_finish": "2024-10-09T09:19:35+03:00", + "operating_reset_at": 1728455375, + "operating": 0.19139289855957 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md deleted file mode 100644 index ffc9a1bf50..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Add task time accounting - Adds information about the user's time spent to the task - - - -`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | ID of task for time accounting | - | Time | --amount | String, Number | Time spent in seconds | - | UserID | --user | String, Number | ID of user for time accounting | - | Text | --text | String | Comment text | - | SetupDate | --date | String | Date the record was set | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2454"; - - Time = 3600; - - Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Text = "Time spent on work"; - UserID = 10; - Time = 7200; - SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); - - Result = OPI_Bitrix24.AddTaskTimeAccounting(URL - , TaskID - , Time - , UserID - , Text - , SetupDate - , Token); -``` - - - - -```json title="Result" -{ - "result": 830, - "time": { - "start": 1728454837.39657, - "finish": 1728454837.48745, - "duration": 0.0908730030059814, - "processing": 0.0576651096343994, - "date_start": "2024-10-09T09:20:37+03:00", - "date_finish": "2024-10-09T09:20:37+03:00", - "operating_reset_at": 1728455437, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.mdx b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.mdx new file mode 100644 index 0000000000..e43d09cc2a --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Add task time accounting + Adds information about the user's time spent to the task + + + +`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task for time accounting | + | Time | --amount | String, Number | Time spent in seconds | + | UserID | --user | String, Number | ID of user for time accounting | + | Text | --text | String | Comment text | + | SetupDate | --date | String | Date the record was set | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2454"; + + Time = 3600; + + Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Text = "Time spent on work"; + UserID = 10; + Time = 7200; + SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); + + Result = OPI_Bitrix24.AddTaskTimeAccounting(URL + , TaskID + , Time + , UserID + , Text + , SetupDate + , Token); +``` + + + + +```json title="Result" +{ + "result": 830, + "time": { + "start": 1728454837.39657, + "finish": 1728454837.48745, + "duration": 0.0908730030059814, + "processing": 0.0576651096343994, + "date_start": "2024-10-09T09:20:37+03:00", + "date_finish": "2024-10-09T09:20:37+03:00", + "operating_reset_at": 1728455437, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md deleted file mode 100644 index 6caa009f85..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Delete task time accounting - Deletes record of time accounting - - - -`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | ID of task for time accounting | - | RecordID | --record | String, Number | Time record ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2454"; - RecordID = "848"; - - Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - RecordID = "850"; - - Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token); -``` - - - - -```json title="Result" -{ - "result": null, - "time": { - "start": 1728454838.38759, - "finish": 1728454838.44759, - "duration": 0.0600039958953857, - "processing": 0.0322821140289307, - "date_start": "2024-10-09T09:20:38+03:00", - "date_finish": "2024-10-09T09:20:38+03:00", - "operating_reset_at": 1728455438, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.mdx b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.mdx new file mode 100644 index 0000000000..2309909962 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Delete task time accounting + Deletes record of time accounting + + + +`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task for time accounting | + | RecordID | --record | String, Number | Time record ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2454"; + RecordID = "848"; + + Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + RecordID = "850"; + + Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token); +``` + + + + +```json title="Result" +{ + "result": null, + "time": { + "start": 1728454838.38759, + "finish": 1728454838.44759, + "duration": 0.0600039958953857, + "processing": 0.0322821140289307, + "date_start": "2024-10-09T09:20:38+03:00", + "date_finish": "2024-10-09T09:20:38+03:00", + "operating_reset_at": 1728455438, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md deleted file mode 100644 index 525ef21133..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get task time accounting list - Get list of time accounting records for task - - - -`Function GetTaskTimeAccountingList(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2454"; - - Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "828", - "TASK_ID": "2404", - "USER_ID": "1", - "COMMENT_TEXT": "", - "SECONDS": "3600", - "MINUTES": "60", - "SOURCE": "2", - "CREATED_DATE": "2024-10-09T09:20:37+03:00", - "DATE_START": "2024-10-09T09:20:37+03:00", - "DATE_STOP": "2024-10-09T09:20:37+03:00" - }, - { - "ID": "830", - "TASK_ID": "2404", - "USER_ID": "10", - "COMMENT_TEXT": "Time spent on work", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-09-09T09:20:37+03:00", - "DATE_START": "2024-10-09T09:20:37+03:00", - "DATE_STOP": "2024-10-09T09:20:37+03:00" - } - ], - "total": 2, - "time": { - "start": 1728454837.88515, - "finish": 1728454837.93688, - "duration": 0.0517289638519287, - "processing": 0.0237300395965576, - "date_start": "2024-10-09T09:20:37+03:00", - "date_finish": "2024-10-09T09:20:37+03:00", - "operating_reset_at": 1728455437, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.mdx b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.mdx new file mode 100644 index 0000000000..1f39c7fa3c --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get task time accounting list + Get list of time accounting records for task + + + +`Function GetTaskTimeAccountingList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2454"; + + Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "828", + "TASK_ID": "2404", + "USER_ID": "1", + "COMMENT_TEXT": "", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-10-09T09:20:37+03:00", + "DATE_START": "2024-10-09T09:20:37+03:00", + "DATE_STOP": "2024-10-09T09:20:37+03:00" + }, + { + "ID": "830", + "TASK_ID": "2404", + "USER_ID": "10", + "COMMENT_TEXT": "Time spent on work", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-09-09T09:20:37+03:00", + "DATE_START": "2024-10-09T09:20:37+03:00", + "DATE_STOP": "2024-10-09T09:20:37+03:00" + } + ], + "total": 2, + "time": { + "start": 1728454837.88515, + "finish": 1728454837.93688, + "duration": 0.0517289638519287, + "processing": 0.0237300395965576, + "date_start": "2024-10-09T09:20:37+03:00", + "date_finish": "2024-10-09T09:20:37+03:00", + "operating_reset_at": 1728455437, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md deleted file mode 100644 index 8813e17f84..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get task time accounting - Get time accounting record data - - - -`Function GetTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | Task ID | - | RecordID | --record | String, Number | Time record ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2454"; - RecordID = "848"; - - Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - RecordID = "850"; - - Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "830", - "TASK_ID": "2404", - "USER_ID": "10", - "COMMENT_TEXT": "Time spent on work", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-09-09T09:20:37+03:00", - "DATE_START": "2024-10-09T09:20:37+03:00", - "DATE_STOP": "2024-10-09T09:20:37+03:00" - }, - "time": { - "start": 1728454837.65834, - "finish": 1728454837.70708, - "duration": 0.0487430095672607, - "processing": 0.0207769870758057, - "date_start": "2024-10-09T09:20:37+03:00", - "date_finish": "2024-10-09T09:20:37+03:00", - "operating_reset_at": 1728455437, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.mdx b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.mdx new file mode 100644 index 0000000000..436124ab6a --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get task time accounting + Get time accounting record data + + + +`Function GetTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | RecordID | --record | String, Number | Time record ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2454"; + RecordID = "848"; + + Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + RecordID = "850"; + + Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "830", + "TASK_ID": "2404", + "USER_ID": "10", + "COMMENT_TEXT": "Time spent on work", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-09-09T09:20:37+03:00", + "DATE_START": "2024-10-09T09:20:37+03:00", + "DATE_STOP": "2024-10-09T09:20:37+03:00" + }, + "time": { + "start": 1728454837.65834, + "finish": 1728454837.70708, + "duration": 0.0487430095672607, + "processing": 0.0207769870758057, + "date_start": "2024-10-09T09:20:37+03:00", + "date_finish": "2024-10-09T09:20:37+03:00", + "operating_reset_at": 1728455437, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md deleted file mode 100644 index 33cb9d9986..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Get timekeeping settings - Gets user timekeeping settings - - - -`Function GetTimekeepingSettings(Val URL, Val UserID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetTimekeepingSettings(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 1; - - Result = OPI_Bitrix24.GetTimekeepingSettings(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "UF_TIMEMAN": true, - "UF_TM_FREE": false, - "UF_TM_MAX_START": "09:15:00", - "UF_TM_MIN_FINISH": "17:45:00", - "UF_TM_MIN_DURATION": "08:00:00", - "UF_TM_ALLOWED_DELTA": "00:15:00", - "ADMIN": true - }, - "time": { - "start": 1722332243.86487, - "finish": 1722332243.88732, - "duration": 0.0224521160125732, - "processing": 0.00417494773864746, - "date_start": "2024-07-30T09:37:23+00:00", - "date_finish": "2024-07-30T09:37:23+00:00", - "operating_reset_at": 1722332843, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.mdx b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.mdx new file mode 100644 index 0000000000..06211bc8fe --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Get timekeeping settings + Gets user timekeeping settings + + + +`Function GetTimekeepingSettings(Val URL, Val UserID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetTimekeepingSettings(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 1; + + Result = OPI_Bitrix24.GetTimekeepingSettings(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "UF_TIMEMAN": true, + "UF_TM_FREE": false, + "UF_TM_MAX_START": "09:15:00", + "UF_TM_MIN_FINISH": "17:45:00", + "UF_TM_MIN_DURATION": "08:00:00", + "UF_TM_ALLOWED_DELTA": "00:15:00", + "ADMIN": true + }, + "time": { + "start": 1722332243.86487, + "finish": 1722332243.88732, + "duration": 0.0224521160125732, + "processing": 0.00417494773864746, + "date_start": "2024-07-30T09:37:23+00:00", + "date_finish": "2024-07-30T09:37:23+00:00", + "operating_reset_at": 1722332843, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md deleted file mode 100644 index 917b91978a..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Get timekeeping status - Gets user timekeeping status - - - -`Function GetTimekeepingStatus(Val URL, Val UserID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetTimekeepingStatus(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 1; - - Result = OPI_Bitrix24.GetTimekeepingStatus(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328322.65261, - "finish": 1722328322.6837, - "duration": 0.0310959815979004, - "processing": 0.00899505615234375, - "date_start": "2024-07-30T08:32:02+00:00", - "date_finish": "2024-07-30T08:32:02+00:00", - "operating_reset_at": 1722328922, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.mdx b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.mdx new file mode 100644 index 0000000000..9f240e9520 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Get timekeeping status + Gets user timekeeping status + + + +`Function GetTimekeepingStatus(Val URL, Val UserID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetTimekeepingStatus(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 1; + + Result = OPI_Bitrix24.GetTimekeepingStatus(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328322.65261, + "finish": 1722328322.6837, + "duration": 0.0310959815979004, + "processing": 0.00899505615234375, + "date_start": "2024-07-30T08:32:02+00:00", + "date_finish": "2024-07-30T08:32:02+00:00", + "operating_reset_at": 1722328922, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md deleted file mode 100644 index 6412c6b159..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Stop timekeeping - Pauses user timekeeping - - - -`Function PauseTimekeeping(Val URL, Val UserID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.PauseTimekeeping(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 1; - - Result = OPI_Bitrix24.PauseTimekeeping(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328320.91942, - "finish": 1722328320.98461, - "duration": 0.0651938915252686, - "processing": 0.0352118015289307, - "date_start": "2024-07-30T08:32:00+00:00", - "date_finish": "2024-07-30T08:32:00+00:00", - "operating_reset_at": 1722328920, - "operating": 0 - } - } -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.mdx b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.mdx new file mode 100644 index 0000000000..91518d554e --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Stop timekeeping + Pauses user timekeeping + + + +`Function PauseTimekeeping(Val URL, Val UserID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.PauseTimekeeping(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 1; + + Result = OPI_Bitrix24.PauseTimekeeping(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328320.91942, + "finish": 1722328320.98461, + "duration": 0.0651938915252686, + "processing": 0.0352118015289307, + "date_start": "2024-07-30T08:32:00+00:00", + "date_finish": "2024-07-30T08:32:00+00:00", + "operating_reset_at": 1722328920, + "operating": 0 + } + } +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md deleted file mode 100644 index 75cecdf769..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Start timekeeping - Starts user timekeeping - - - -`Function StartTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Time | --time | Date | Start time. The date must match the current. Current time by default. | - | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.StartTimekeeping(URL); - - Hour = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 1; - Time = OPI_Tools.GetCurrentDate() - Hour; - Report = "Late"; - - Result = OPI_Bitrix24.StartTimekeeping(URL, UserID, Time, Report, Token); -``` - - - - -```json title="Result" -{ - "result": { - "STATUS": "OPENED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": null, - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "93.125.42.204", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328319.21856, - "finish": 1722328319.25781, - "duration": 0.0392520427703857, - "processing": 0.014214038848877, - "date_start": "2024-07-30T08:31:59+00:00", - "date_finish": "2024-07-30T08:31:59+00:00", - "operating_reset_at": 1722328919, - "operating": 0.181692123413086 - } - } -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.mdx b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.mdx new file mode 100644 index 0000000000..1c7f0f7607 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Start timekeeping + Starts user timekeeping + + + +`Function StartTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Time | --time | Date | Start time. The date must match the current. Current time by default. | + | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.StartTimekeeping(URL); + + Hour = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 1; + Time = OPI_Tools.GetCurrentDate() - Hour; + Report = "Late"; + + Result = OPI_Bitrix24.StartTimekeeping(URL, UserID, Time, Report, Token); +``` + + + + +```json title="Result" +{ + "result": { + "STATUS": "OPENED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": null, + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "93.125.42.204", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328319.21856, + "finish": 1722328319.25781, + "duration": 0.0392520427703857, + "processing": 0.014214038848877, + "date_start": "2024-07-30T08:31:59+00:00", + "date_finish": "2024-07-30T08:31:59+00:00", + "operating_reset_at": 1722328919, + "operating": 0.181692123413086 + } + } +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md deleted file mode 100644 index 57fa726818..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Stop timekeeping - Stops user timekeeping - - - -`Function StopTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Time | --time | Date | Stop time. The date must match the current. Current time by default. | - | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.StopTimekeeping(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = 1; - Time = OPI_Tools.GetCurrentDate(); - Report = "Time off"; - - Result = OPI_Bitrix24.StopTimekeeping(URL, UserID, Time, Report, Token); -``` - - - - -```json title="Result" -{ - "error": "WRONG_DATETIME_FORMAT", - "error_description": "Wrong datetime format" - } -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.mdx b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.mdx new file mode 100644 index 0000000000..bdcdc2532a --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Stop timekeeping + Stops user timekeeping + + + +`Function StopTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Time | --time | Date | Stop time. The date must match the current. Current time by default. | + | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.StopTimekeeping(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = 1; + Time = OPI_Tools.GetCurrentDate(); + Report = "Time off"; + + Result = OPI_Bitrix24.StopTimekeeping(URL, UserID, Time, Report, Token); +``` + + + + +```json title="Result" +{ + "error": "WRONG_DATETIME_FORMAT", + "error_description": "Wrong datetime format" + } +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md deleted file mode 100644 index d3cda78d4f..0000000000 --- a/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Update task time accounting - Update time accounting record data - - - -`Function UpdateTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Time, Val Text = "", Val SetupDate = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | Task ID | - | RecordID | --record | String, Number | Time record ID | - | Time | --amount | String, Number | Time spent in seconds | - | Text | --text | String | Comment text | - | SetupDate | --date | String | Date the record was set | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - TaskID = "2454"; - RecordID = "848"; - - Text = "The text I forgot last time"; - Time = 4800; - - Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL, TaskID, RecordID, Time, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - RecordID = "850"; - - Text = "New time record"; - Time = 4800; - SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); - - Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL - , TaskID - , RecordID - , Time - , Text - , SetupDate - , Token); -``` - - - - -```json title="Result" -{ - "result": null, - "time": { - "start": 1728454838.1335, - "finish": 1728454838.20827, - "duration": 0.0747687816619873, - "processing": 0.0432851314544678, - "date_start": "2024-10-09T09:20:38+03:00", - "date_finish": "2024-10-09T09:20:38+03:00", - "operating_reset_at": 1728455438, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.mdx b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.mdx new file mode 100644 index 0000000000..267c0fa43b --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Update task time accounting + Update time accounting record data + + + +`Function UpdateTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Time, Val Text = "", Val SetupDate = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | RecordID | --record | String, Number | Time record ID | + | Time | --amount | String, Number | Time spent in seconds | + | Text | --text | String | Comment text | + | SetupDate | --date | String | Date the record was set | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + TaskID = "2454"; + RecordID = "848"; + + Text = "The text I forgot last time"; + Time = 4800; + + Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL, TaskID, RecordID, Time, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + RecordID = "850"; + + Text = "New time record"; + Time = 4800; + SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); + + Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL + , TaskID + , RecordID + , Time + , Text + , SetupDate + , Token); +``` + + + + +```json title="Result" +{ + "result": null, + "time": { + "start": 1728454838.1335, + "finish": 1728454838.20827, + "duration": 0.0747687816619873, + "processing": 0.0432851314544678, + "date_start": "2024-10-09T09:20:38+03:00", + "date_finish": "2024-10-09T09:20:38+03:00", + "operating_reset_at": 1728455438, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Change-user-status.md b/docs/en/md/Bitrix24/Users-managment/Change-user-status.md deleted file mode 100644 index 3ad06f7df2..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Change-user-status.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Change user status - Activates or deactivates (fire) the selected user - - - -`Function ChangeUserStatus(Val URL, Val UserID, Val Fire = True, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | User ID | - | Fire | --fire | Boolean | True > Deactivation, False > Activation | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- - - - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - UserID = "624"; - - Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = "626"; - - Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454937.15091, - "finish": 1728454937.42878, - "duration": 0.277868986129761, - "processing": 0.252010822296143, - "date_start": "2024-10-09T09:22:17+03:00", - "date_finish": "2024-10-09T09:22:17+03:00", - "operating_reset_at": 1728455537, - "operating": 0.53964114189148 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Change-user-status.mdx b/docs/en/md/Bitrix24/Users-managment/Change-user-status.mdx new file mode 100644 index 0000000000..82731ecb4a --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Change-user-status.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Change user status + Activates or deactivates (fire) the selected user + + + +`Function ChangeUserStatus(Val URL, Val UserID, Val Fire = True, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | User ID | + | Fire | --fire | Boolean | True > Deactivation, False > Activation | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ + + + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + UserID = "624"; + + Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = "626"; + + Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454937.15091, + "finish": 1728454937.42878, + "duration": 0.277868986129761, + "processing": 0.252010822296143, + "date_start": "2024-10-09T09:22:17+03:00", + "date_finish": "2024-10-09T09:22:17+03:00", + "operating_reset_at": 1728455537, + "operating": 0.53964114189148 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Create-user.md b/docs/en/md/Bitrix24/Users-managment/Create-user.md deleted file mode 100644 index dc58262283..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Create-user.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create user - Create new user by fields structure - - - -`Function CreateUser(Val URL, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) - - If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID: [...] - - If you want to add an intranet user, you must pass UF_DEPARTMENT field: [...] -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Email = String(New UUID) + "@exepmple.org"; - // The full structure can be obtained with the function GetUserFieldsStructure - - UserStructure = New Structure; - UserStructure.Insert("EMAIL" , Email); - UserStructure.Insert("UF_DEPARTMENT", 7); - - Result = OPI_Bitrix24.CreateUser(URL, UserStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - Email = String(New UUID) + "@exepmple.org"; - - UserStructure = New Structure; - UserStructure.Insert("EMAIL" , Email); - UserStructure.Insert("NAME" , "Vitaly"); - UserStructure.Insert("LAST_NAME" , "Alpaca"); - UserStructure.Insert("PERSONAL_MOBILE", "88003553535"); - UserStructure.Insert("UF_DEPARTMENT" , 1); - - Result = OPI_Bitrix24.CreateUser(URL, UserStructure, Token); -``` - - - - -```json title="Result" -{ - "result": 606, - "time": { - "start": 1728454933.44558, - "finish": 1728454935.61149, - "duration": 2.16591095924377, - "processing": 2.13802599906921, - "date_start": "2024-10-09T09:22:13+03:00", - "date_finish": "2024-10-09T09:22:15+03:00", - "operating_reset_at": 1728455533, - "operating": 2.13800406455994 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Create-user.mdx b/docs/en/md/Bitrix24/Users-managment/Create-user.mdx new file mode 100644 index 0000000000..e91ad2f905 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Create-user.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create user + Create new user by fields structure + + + +`Function CreateUser(Val URL, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) + + If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID: [...] + + If you want to add an intranet user, you must pass UF_DEPARTMENT field: [...] +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Email = String(New UUID) + "@exepmple.org"; + // The full structure can be obtained with the function GetUserFieldsStructure + + UserStructure = New Structure; + UserStructure.Insert("EMAIL" , Email); + UserStructure.Insert("UF_DEPARTMENT", 7); + + Result = OPI_Bitrix24.CreateUser(URL, UserStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + Email = String(New UUID) + "@exepmple.org"; + + UserStructure = New Structure; + UserStructure.Insert("EMAIL" , Email); + UserStructure.Insert("NAME" , "Vitaly"); + UserStructure.Insert("LAST_NAME" , "Alpaca"); + UserStructure.Insert("PERSONAL_MOBILE", "88003553535"); + UserStructure.Insert("UF_DEPARTMENT" , 1); + + Result = OPI_Bitrix24.CreateUser(URL, UserStructure, Token); +``` + + + + +```json title="Result" +{ + "result": 606, + "time": { + "start": 1728454933.44558, + "finish": 1728454935.61149, + "duration": 2.16591095924377, + "processing": 2.13802599906921, + "date_start": "2024-10-09T09:22:13+03:00", + "date_finish": "2024-10-09T09:22:15+03:00", + "operating_reset_at": 1728455533, + "operating": 2.13800406455994 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Find-users.md b/docs/en/md/Bitrix24/Users-managment/Find-users.md deleted file mode 100644 index d6f0832e36..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Find-users.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Find users - Gets the list of users according to the specified filter - - - -`Function FindUsers(Val URL, Val FilterStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FilterStructure | --filter | Structure of KeyAndValue | Filter. See GetUserFilterStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - FilterStructure = New Structure; - FilterStructure.Insert("NAME" , "Vitaly"); - FilterStructure.Insert("LAST_NAME" , "Alpaca"); - FilterStructure.Insert("WORK_POSITION" , "DevOps engineer"); - FilterStructure.Insert("UF_DEPARTMENT_NAME", "Marketing department"); - FilterStructure.Insert("USER_TYPE" , "employee"); - - Result = OPI_Bitrix24.FindUsers(URL, FilterStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - FilterStructure = New Structure; - FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix"); - - Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token); -``` - - - - -```json title="Result" -{ - "result": [], - "time": { - "start": 1728454935.77575, - "finish": 1728454935.81785, - "duration": 0.0420989990234375, - "processing": 0.0130829811096191, - "date_start": "2024-10-09T09:22:15+03:00", - "date_finish": "2024-10-09T09:22:15+03:00", - "operating_reset_at": 1728455535, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Find-users.mdx b/docs/en/md/Bitrix24/Users-managment/Find-users.mdx new file mode 100644 index 0000000000..1eedfc70c2 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Find-users.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Find users + Gets the list of users according to the specified filter + + + +`Function FindUsers(Val URL, Val FilterStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FilterStructure | --filter | Structure of KeyAndValue | Filter. See GetUserFilterStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + FilterStructure = New Structure; + FilterStructure.Insert("NAME" , "Vitaly"); + FilterStructure.Insert("LAST_NAME" , "Alpaca"); + FilterStructure.Insert("WORK_POSITION" , "DevOps engineer"); + FilterStructure.Insert("UF_DEPARTMENT_NAME", "Marketing department"); + FilterStructure.Insert("USER_TYPE" , "employee"); + + Result = OPI_Bitrix24.FindUsers(URL, FilterStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + FilterStructure = New Structure; + FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix"); + + Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token); +``` + + + + +```json title="Result" +{ + "result": [], + "time": { + "start": 1728454935.77575, + "finish": 1728454935.81785, + "duration": 0.0420989990234375, + "processing": 0.0130829811096191, + "date_start": "2024-10-09T09:22:15+03:00", + "date_finish": "2024-10-09T09:22:15+03:00", + "operating_reset_at": 1728455535, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-current-user.md b/docs/en/md/Bitrix24/Users-managment/Get-current-user.md deleted file mode 100644 index 31525cbf4a..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Get-current-user.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get current user - Get current user data - - - -`Function GetCurrentUser(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetCurrentUser(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetCurrentUser(URL, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "1", - "XML_ID": "53818298", - "ACTIVE": true, - "NAME": "Антон", - "LAST_NAME": "Титовец", - "EMAIL": "no-reply@bitrix24.com", - "LAST_LOGIN": "2024-09-17T21:21:38+03:00", - "DATE_REGISTER": "2024-02-10T03:00:00+03:00", - "IS_ONLINE": "N", - "TIME_ZONE_OFFSET": "0", - "TIMESTAMP_X": "29.08.2024 10:12:45", - "LAST_ACTIVITY_DATE": "2024-09-17 21:21:49", - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 264 - ] - }, - "time": { - "start": 1728454930.6427, - "finish": 1728454930.67441, - "duration": 0.0317108631134033, - "processing": 0.00330090522766113, - "date_start": "2024-10-09T09:22:10+03:00", - "date_finish": "2024-10-09T09:22:10+03:00", - "operating_reset_at": 1728455530, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-current-user.mdx b/docs/en/md/Bitrix24/Users-managment/Get-current-user.mdx new file mode 100644 index 0000000000..109dbf8603 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-current-user.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get current user + Get current user data + + + +`Function GetCurrentUser(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetCurrentUser(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetCurrentUser(URL, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Антон", + "LAST_NAME": "Титовец", + "EMAIL": "no-reply@bitrix24.com", + "LAST_LOGIN": "2024-09-17T21:21:38+03:00", + "DATE_REGISTER": "2024-02-10T03:00:00+03:00", + "IS_ONLINE": "N", + "TIME_ZONE_OFFSET": "0", + "TIMESTAMP_X": "29.08.2024 10:12:45", + "LAST_ACTIVITY_DATE": "2024-09-17 21:21:49", + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 264 + ] + }, + "time": { + "start": 1728454930.6427, + "finish": 1728454930.67441, + "duration": 0.0317108631134033, + "processing": 0.00330090522766113, + "date_start": "2024-10-09T09:22:10+03:00", + "date_finish": "2024-10-09T09:22:10+03:00", + "operating_reset_at": 1728455530, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md deleted file mode 100644 index 7e8785e611..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get user fields structure - Gets the field structure for creating or modifying user information - - - -`Function GetUserFieldsStructure(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Result = OPI_Bitrix24.GetUserFieldsStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetUserFieldsStructure(URL, Token); -``` - - - - -```json title="Result" -{ - "result": { - "ID": "ID", - "XML_ID": "Внешний код", - "ACTIVE": "Активность", - "NAME": "Имя", - "LAST_NAME": "Фамилия", - "SECOND_NAME": "Отчество", - "TITLE": "Список пользователей", - "EMAIL": "E-Mail", - "LAST_LOGIN": "Последняя авторизация", - "DATE_REGISTER": "Дата регистрации", - "TIME_ZONE": "TIME_ZONE", - "IS_ONLINE": "IS_ONLINE", - "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", - "TIMESTAMP_X": "TIMESTAMP_X", - "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", - "PERSONAL_GENDER": "Пол", - "PERSONAL_PROFESSION": "Профессия", - "PERSONAL_WWW": "Домашняя страничка", - "PERSONAL_BIRTHDAY": "Дата рождения", - "PERSONAL_PHOTO": "Фотография", - "PERSONAL_ICQ": "ICQ", - "PERSONAL_PHONE": "Личный телефон", - "PERSONAL_FAX": "Факс", - "PERSONAL_MOBILE": "Личный мобильный", - "PERSONAL_PAGER": "Пейджер", - "PERSONAL_STREET": "Улица проживания", - "PERSONAL_CITY": "Город проживания", - "PERSONAL_STATE": "Область / край", - "PERSONAL_ZIP": "Почтовый индекс", - "PERSONAL_COUNTRY": "Страна", - "PERSONAL_MAILBOX": "Почтовый ящик", - "PERSONAL_NOTES": "Дополнительные заметки", - "WORK_PHONE": "Телефон компании", - "WORK_COMPANY": "Компания", - "WORK_POSITION": "Должность", - "WORK_DEPARTMENT": "Отдел", - "WORK_WWW": "Сайт компании", - "WORK_FAX": "WORK_FAX", - "WORK_PAGER": "WORK_PAGER", - "WORK_STREET": "WORK_STREET", - "WORK_MAILBOX": "WORK_MAILBOX", - "WORK_CITY": "Город работы", - "WORK_STATE": "WORK_STATE", - "WORK_ZIP": "WORK_ZIP", - "WORK_COUNTRY": "WORK_COUNTRY", - "WORK_PROFILE": "WORK_PROFILE", - "WORK_LOGO": "WORK_LOGO", - "WORK_NOTES": "WORK_NOTES", - "UF_SKYPE_LINK": "Ссылка на чат в Skype", - "UF_ZOOM": "Zoom", - "UF_EMPLOYMENT_DATE": "Дата принятия на работу", - "UF_TIMEMAN": "Учет рабочего времени", - "UF_DEPARTMENT": "Подразделения", - "UF_INTERESTS": "Интересы", - "UF_SKILLS": "Навыки", - "UF_WEB_SITES": "Другие сайты", - "UF_XING": "Xing", - "UF_LINKEDIN": "LinkedIn", - "UF_FACEBOOK": "Facebook", - "UF_TWITTER": "Twitter", - "UF_SKYPE": "Skype", - "UF_DISTRICT": "Район", - "UF_PHONE_INNER": "Внутренний телефон", - "USER_TYPE": "USER_TYPE" - }, - "time": { - "start": 1728454930.84083, - "finish": 1728454930.86898, - "duration": 0.0281410217285156, - "processing": 0.000678062438964844, - "date_start": "2024-10-09T09:22:10+03:00", - "date_finish": "2024-10-09T09:22:10+03:00", - "operating_reset_at": 1728455530, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.mdx b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.mdx new file mode 100644 index 0000000000..d596926485 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.mdx @@ -0,0 +1,124 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get user fields structure + Gets the field structure for creating or modifying user information + + + +`Function GetUserFieldsStructure(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Result = OPI_Bitrix24.GetUserFieldsStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetUserFieldsStructure(URL, Token); +``` + + + + +```json title="Result" +{ + "result": { + "ID": "ID", + "XML_ID": "Внешний код", + "ACTIVE": "Активность", + "NAME": "Имя", + "LAST_NAME": "Фамилия", + "SECOND_NAME": "Отчество", + "TITLE": "Список пользователей", + "EMAIL": "E-Mail", + "LAST_LOGIN": "Последняя авторизация", + "DATE_REGISTER": "Дата регистрации", + "TIME_ZONE": "TIME_ZONE", + "IS_ONLINE": "IS_ONLINE", + "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", + "TIMESTAMP_X": "TIMESTAMP_X", + "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", + "PERSONAL_GENDER": "Пол", + "PERSONAL_PROFESSION": "Профессия", + "PERSONAL_WWW": "Домашняя страничка", + "PERSONAL_BIRTHDAY": "Дата рождения", + "PERSONAL_PHOTO": "Фотография", + "PERSONAL_ICQ": "ICQ", + "PERSONAL_PHONE": "Личный телефон", + "PERSONAL_FAX": "Факс", + "PERSONAL_MOBILE": "Личный мобильный", + "PERSONAL_PAGER": "Пейджер", + "PERSONAL_STREET": "Улица проживания", + "PERSONAL_CITY": "Город проживания", + "PERSONAL_STATE": "Область / край", + "PERSONAL_ZIP": "Почтовый индекс", + "PERSONAL_COUNTRY": "Страна", + "PERSONAL_MAILBOX": "Почтовый ящик", + "PERSONAL_NOTES": "Дополнительные заметки", + "WORK_PHONE": "Телефон компании", + "WORK_COMPANY": "Компания", + "WORK_POSITION": "Должность", + "WORK_DEPARTMENT": "Отдел", + "WORK_WWW": "Сайт компании", + "WORK_FAX": "WORK_FAX", + "WORK_PAGER": "WORK_PAGER", + "WORK_STREET": "WORK_STREET", + "WORK_MAILBOX": "WORK_MAILBOX", + "WORK_CITY": "Город работы", + "WORK_STATE": "WORK_STATE", + "WORK_ZIP": "WORK_ZIP", + "WORK_COUNTRY": "WORK_COUNTRY", + "WORK_PROFILE": "WORK_PROFILE", + "WORK_LOGO": "WORK_LOGO", + "WORK_NOTES": "WORK_NOTES", + "UF_SKYPE_LINK": "Ссылка на чат в Skype", + "UF_ZOOM": "Zoom", + "UF_EMPLOYMENT_DATE": "Дата принятия на работу", + "UF_TIMEMAN": "Учет рабочего времени", + "UF_DEPARTMENT": "Подразделения", + "UF_INTERESTS": "Интересы", + "UF_SKILLS": "Навыки", + "UF_WEB_SITES": "Другие сайты", + "UF_XING": "Xing", + "UF_LINKEDIN": "LinkedIn", + "UF_FACEBOOK": "Facebook", + "UF_TWITTER": "Twitter", + "UF_SKYPE": "Skype", + "UF_DISTRICT": "Район", + "UF_PHONE_INNER": "Внутренний телефон", + "USER_TYPE": "USER_TYPE" + }, + "time": { + "start": 1728454930.84083, + "finish": 1728454930.86898, + "duration": 0.0281410217285156, + "processing": 0.000678062438964844, + "date_start": "2024-10-09T09:22:10+03:00", + "date_finish": "2024-10-09T09:22:10+03:00", + "operating_reset_at": 1728455530, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md deleted file mode 100644 index 95b00b7f9c..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get user filter structure - Returns the field structure for filtering users in the FindUsers method - - - -`Function GetUserFilterStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Bitrix24.GetUserFilterStructure(); -``` - - - - -```json title="Result" -{ - "NAME": "", - "LAST_NAME": "", - "WORK_POSITION": "", - "UF_DEPARTMENT_NAME": "", - "USER_TYPE": "" -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.mdx b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.mdx new file mode 100644 index 0000000000..5ac9527353 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get user filter structure + Returns the field structure for filtering users in the FindUsers method + + + +`Function GetUserFilterStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Bitrix24.GetUserFilterStructure(); +``` + + + + +```json title="Result" +{ + "NAME": "", + "LAST_NAME": "", + "WORK_POSITION": "", + "UF_DEPARTMENT_NAME": "", + "USER_TYPE": "" +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user.md b/docs/en/md/Bitrix24/Users-managment/Get-user.md deleted file mode 100644 index 329d068639..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Get-user.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get user - Gets user information by ID - - - -`Function GetUser(Val URL, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | User ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - UserID = "624"; - - Result = OPI_Bitrix24.GetUser(URL, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = "626"; - - Result = OPI_Bitrix24.GetUser(URL, UserID, Token); -``` - - - - -```json title="Result" -{ - "result": [ - { - "ID": "606", - "XML_ID": "57980692", - "ACTIVE": true, - "NAME": "Oleg", - "LAST_NAME": "Lama", - "EMAIL": "dd1a6790-a025-49be-90a4-d1cf06f2a89c@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-10-09T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_MOBILE": "88003553535", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 7 - ], - "USER_TYPE": "employee" - } - ], - "total": 1, - "time": { - "start": 1728454936.70035, - "finish": 1728454936.73915, - "duration": 0.0388009548187256, - "processing": 0.0093529224395752, - "date_start": "2024-10-09T09:22:16+03:00", - "date_finish": "2024-10-09T09:22:16+03:00", - "operating_reset_at": 1728455536, - "operating": 0 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user.mdx b/docs/en/md/Bitrix24/Users-managment/Get-user.mdx new file mode 100644 index 0000000000..55a9cc16e1 --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Get-user.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get user + Gets user information by ID + + + +`Function GetUser(Val URL, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | User ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + UserID = "624"; + + Result = OPI_Bitrix24.GetUser(URL, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = "626"; + + Result = OPI_Bitrix24.GetUser(URL, UserID, Token); +``` + + + + +```json title="Result" +{ + "result": [ + { + "ID": "606", + "XML_ID": "57980692", + "ACTIVE": true, + "NAME": "Oleg", + "LAST_NAME": "Lama", + "EMAIL": "dd1a6790-a025-49be-90a4-d1cf06f2a89c@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-10-09T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_MOBILE": "88003553535", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 7 + ], + "USER_TYPE": "employee" + } + ], + "total": 1, + "time": { + "start": 1728454936.70035, + "finish": 1728454936.73915, + "duration": 0.0388009548187256, + "processing": 0.0093529224395752, + "date_start": "2024-10-09T09:22:16+03:00", + "date_finish": "2024-10-09T09:22:16+03:00", + "operating_reset_at": 1728455536, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Update-user.md b/docs/en/md/Bitrix24/Users-managment/Update-user.md deleted file mode 100644 index 070c5e9447..0000000000 --- a/docs/en/md/Bitrix24/Users-managment/Update-user.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Update user - Updates user data - - - -`Function UpdateUser(Val URL, Val UserID, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | User ID | - | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - UserID = "624"; - Email = String(New UUID) + "@exepmple.org"; - - // The full structure can be obtained with the function GetUserFieldsStructure - - UserStructure = New Structure; - UserStructure.Insert("EMAIL" , Email); - UserStructure.Insert("UF_DEPARTMENT", 1); - - Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "21750a67006e9f06006b12e400000001000..."; - UserID = "626"; - Email = String(New UUID) + "@exepmple.org"; - - UserStructure = New Structure; - UserStructure.Insert("EMAIL" , Email); - UserStructure.Insert("NAME" , "Oleg"); - UserStructure.Insert("LAST_NAME" , "Lama"); - UserStructure.Insert("UF_DEPARTMENT" , 7); - - Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure, Token); -``` - - - - -```json title="Result" -{ - "result": true, - "time": { - "start": 1728454936.24134, - "finish": 1728454936.55634, - "duration": 0.315001964569092, - "processing": 0.287670135498047, - "date_start": "2024-10-09T09:22:16+03:00", - "date_finish": "2024-10-09T09:22:16+03:00", - "operating_reset_at": 1728455536, - "operating": 0.287650108337402 - } -} -``` diff --git a/docs/en/md/Bitrix24/Users-managment/Update-user.mdx b/docs/en/md/Bitrix24/Users-managment/Update-user.mdx new file mode 100644 index 0000000000..ddd9b14f3c --- /dev/null +++ b/docs/en/md/Bitrix24/Users-managment/Update-user.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Update user + Updates user data + + + +`Function UpdateUser(Val URL, Val UserID, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | User ID | + | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + UserID = "624"; + Email = String(New UUID) + "@exepmple.org"; + + // The full structure can be obtained with the function GetUserFieldsStructure + + UserStructure = New Structure; + UserStructure.Insert("EMAIL" , Email); + UserStructure.Insert("UF_DEPARTMENT", 1); + + Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "21750a67006e9f06006b12e400000001000..."; + UserID = "626"; + Email = String(New UUID) + "@exepmple.org"; + + UserStructure = New Structure; + UserStructure.Insert("EMAIL" , Email); + UserStructure.Insert("NAME" , "Oleg"); + UserStructure.Insert("LAST_NAME" , "Lama"); + UserStructure.Insert("UF_DEPARTMENT" , 7); + + Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure, Token); +``` + + + + +```json title="Result" +{ + "result": true, + "time": { + "start": 1728454936.24134, + "finish": 1728454936.55634, + "duration": 0.315001964569092, + "processing": 0.287670135498047, + "date_start": "2024-10-09T09:22:16+03:00", + "date_finish": "2024-10-09T09:22:16+03:00", + "operating_reset_at": 1728455536, + "operating": 0.287650108337402 + } +} +``` diff --git a/docs/en/md/CDEK/Common-methods/Get-token.md b/docs/en/md/CDEK/Common-methods/Get-token.md deleted file mode 100644 index 442081bd21..0000000000 --- a/docs/en/md/CDEK/Common-methods/Get-token.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get token - Gets a token based on account ID and password - - - -`Function GetToken(Val Account, Val Password, TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Account | --account | String | Client identifier (Account) | - | Password | --pass | String | Secret key (Password) | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Client authorization](https://api-docs.cdek.ru/29923918.html) -::: -
- - -```bsl title="Code example" - Account = "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP"; - Password = "RmAmgvSgSl..."; - - Result = OPI_CDEK.GetToken(Account, Password, True); -``` - - - - -```json title="Result" -{ - "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2NDk4NDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZXNzOmZhbHNlIiwiY29udHJhZ2VudC11dWlkOmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImZ1bGwtbmFtZTrQotC10YHRgtC40YDQvtCy0LDQvdC40LUg0JjQvdGC0LXQs9GA0LDRhtC40Lgg0JjQnCJdLCJqdGkiOiJob3R5QmQtd2xqdzJsd3V6NGp1ZUcxckU1NDAiLCJjbGllbnRfaWQiOiJ3cUd3aVF4MGdnOG1MdGlFS3NVaW5qVlNJQ0NqdFRFUCJ9.IXSw8O68ucBPSFm_sUv-HqRVe9jRi9Iv945fWN2vBKPNiG4CQSTnIKKzpub932vskhDC3MoR3sjIPDhcheOrc9jgpDl4gpLwIfgcz_a5xwikPxph6gpakIU16mrwp110AvkJvJchktNYpty44YjIKOi8UgwgtaJvbsWR-Ztb5A__TfikmtHZuvHZbhCU_QuGD9oloIdgtLueyQO7HsOqWHGy1VpUat_a985FRswUM96Jao66qO5zAeZmUkfzcz7mQPG1IDtMP1eLIV-OeX78W3F1aW5wkIpfjcV-iRe-JZRJH-mjSQI9TWcwy7g3mgxsyfqyHmSzGwIBd0v58_3jzg", - "token_type": "bearer", - "expires_in": 3599, - "scope": "location:all order:all payment:all", - "jti": "hotyBd-wljw2lwuz4jueG1rE540" -} -``` diff --git a/docs/en/md/CDEK/Common-methods/Get-token.mdx b/docs/en/md/CDEK/Common-methods/Get-token.mdx new file mode 100644 index 0000000000..4037cc6714 --- /dev/null +++ b/docs/en/md/CDEK/Common-methods/Get-token.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get token + Gets a token based on account ID and password + + + +`Function GetToken(Val Account, Val Password, TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Account | --account | String | Client identifier (Account) | + | Password | --pass | String | Secret key (Password) | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Client authorization](https://api-docs.cdek.ru/29923918.html) +::: +
+ + +```bsl title="Code example" + Account = "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP"; + Password = "RmAmgvSgSl..."; + + Result = OPI_CDEK.GetToken(Account, Password, True); +``` + + + + +```json title="Result" +{ + "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg2NDk4NDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFwaS12ZXJzaW9uOjEuMSIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJzb2xpZC1hZGRyZXNzOmZhbHNlIiwiY29udHJhZ2VudC11dWlkOmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImZ1bGwtbmFtZTrQotC10YHRgtC40YDQvtCy0LDQvdC40LUg0JjQvdGC0LXQs9GA0LDRhtC40Lgg0JjQnCJdLCJqdGkiOiJob3R5QmQtd2xqdzJsd3V6NGp1ZUcxckU1NDAiLCJjbGllbnRfaWQiOiJ3cUd3aVF4MGdnOG1MdGlFS3NVaW5qVlNJQ0NqdFRFUCJ9.IXSw8O68ucBPSFm_sUv-HqRVe9jRi9Iv945fWN2vBKPNiG4CQSTnIKKzpub932vskhDC3MoR3sjIPDhcheOrc9jgpDl4gpLwIfgcz_a5xwikPxph6gpakIU16mrwp110AvkJvJchktNYpty44YjIKOi8UgwgtaJvbsWR-Ztb5A__TfikmtHZuvHZbhCU_QuGD9oloIdgtLueyQO7HsOqWHGy1VpUat_a985FRswUM96Jao66qO5zAeZmUkfzcz7mQPG1IDtMP1eLIV-OeX78W3F1aW5wkIpfjcV-iRe-JZRJH-mjSQI9TWcwy7g3mgxsyfqyHmSzGwIBd0v58_3jzg", + "token_type": "bearer", + "expires_in": 3599, + "scope": "location:all order:all payment:all", + "jti": "hotyBd-wljw2lwuz4jueG1rE540" +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Create-customer-refund.md b/docs/en/md/CDEK/Orders-managment/Create-customer-refund.md deleted file mode 100644 index ce319fc3af..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Create-customer-refund.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Create customer refund - Processes customer returns for online store orders - - - -`Function CreateCustomerRefund(Val Token, Val UUID, Val Tariff, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | UUID | --uuid | String | Order UUID | - | Tariff | --tariff | Number | Tariff code (from those available under the contract) | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -This method is used if the direct order was delivered by CDEK and the recipient wants to return it in full - - If the order was delivered by another service, or you need to return not all items, you must use the CreateOrder method with is_client_return = true - - Method at API documentation: [Customer returns](https://api-docs.cdek.ru/122762174.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - Tariff = 139; - - Result = OPI_CDEK.CreateCustomerRefund(Token, UUID, Tariff, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" - }, - "requests": [ - { - "request_uuid": "12ae6a3a-b014-41df-a496-ae58ff5eccfe", - "type": "CREATE_CLIENT_RETURN", - "date_time": "2024-10-12T19:31:15+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Create-customer-refund.mdx b/docs/en/md/CDEK/Orders-managment/Create-customer-refund.mdx new file mode 100644 index 0000000000..5517dfe572 --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Create-customer-refund.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Create customer refund + Processes customer returns for online store orders + + + +`Function CreateCustomerRefund(Val Token, Val UUID, Val Tariff, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | UUID | --uuid | String | Order UUID | + | Tariff | --tariff | Number | Tariff code (from those available under the contract) | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +This method is used if the direct order was delivered by CDEK and the recipient wants to return it in full + + If the order was delivered by another service, or you need to return not all items, you must use the CreateOrder method with is_client_return = true + + Method at API documentation: [Customer returns](https://api-docs.cdek.ru/122762174.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + Tariff = 139; + + Result = OPI_CDEK.CreateCustomerRefund(Token, UUID, Tariff, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" + }, + "requests": [ + { + "request_uuid": "12ae6a3a-b014-41df-a496-ae58ff5eccfe", + "type": "CREATE_CLIENT_RETURN", + "date_time": "2024-10-12T19:31:15+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Create-order.md b/docs/en/md/CDEK/Orders-managment/Create-order.md deleted file mode 100644 index 5a1b0fd4e6..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Create-order.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create order - Creates an order based on field descriptions - - - -`Function CreateOrder(Val Token, Val OrderDescription, Val OnlineStore = False, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | OrderDescription | --order | Structure of KeyAndValue | Set of order fields. See GetOrderDescription | - | OnlineStore | --ostore | Boolean | Flag of Online store order type | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Order registration](https://api-docs.cdek.ru/29923926.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - - OrderDescription = New Structure; - - SendLocation = New Structure; - SendLocation.Insert("code" , "44"); - SendLocation.Insert("city" , "Moscow"); - SendLocation.Insert("address", "Ave. Leningradsky, 4"); - - DestLocation = New Structure; - DestLocation.Insert("code" , "270"); - DestLocation.Insert("city" , "Novosibirsk"); - DestLocation.Insert("address", "st. Bluchera, 32"); - - Recipient = New Structure; - - Phones = New Array; - Phones.Add(New Structure("number", "+79134637228")); - - Recipient.Insert("phones", Phones); - Recipient.Insert("name" , "Ivaniv Ivan"); - - Sender = New Structure("name", "Petrov Petr"); - - Services = New Array; - - Service = New Structure; - Service.Insert("code" , "SECURE_PACKAGE_A2"); - Service.Insert("parameter", 10); - - Services.Add(Service); - - Packages = New Array; - - Package = New Structure; - - Items = New Array; - - Item = New Structure; - - Payment = New Structure; - Payment.Insert("value", 3000); - - Item.Insert("payment" , Payment); - Item.Insert("ware_key", "00055"); - Item.Insert("name" , "Product"); - Item.Insert("cost" , 300); - Item.Insert("amount" , 2); - Item.Insert("weight" , 700); - Item.Insert("url" , "www.item.ru"); - - Items.Add(Item); - - Package.Insert("items" , Items); - Package.Insert("number" , "bar-001"); - Package.Insert("comment", "Packaging"); - Package.Insert("height" , 10); - Package.Insert("length" , 10); - Package.Insert("weight" , "4000"); - Package.Insert("width" , 10); - - Packages.Add(Package); - - OrderDescription.Insert("from_location", SendLocation); - OrderDescription.Insert("to_location" , DestLocation); - OrderDescription.Insert("packages" , Packages); - OrderDescription.Insert("recipient" , Recipient); - OrderDescription.Insert("sender" , Sender); - OrderDescription.Insert("services" , Services); - - OrderDescription.Insert("number" , "ddOererre7450813980068"); - OrderDescription.Insert("comment" , "New order"); - OrderDescription.Insert("tariff_code", 139); - - OrderDescription.Insert("delivery_recipient_cost" , New Structure("value" , 50)); - OrderDescription.Insert("delivery_recipient_cost_adv", New Structure("sum,threshold", 3000, 200)); - - Result = OPI_CDEK.CreateOrder(Token, OrderDescription, True, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" - }, - "requests": [ - { - "request_uuid": "825e8d4d-e04d-404e-939b-e119ba58707a", - "type": "CREATE", - "date_time": "2024-10-12T19:31:14+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Create-order.mdx b/docs/en/md/CDEK/Orders-managment/Create-order.mdx new file mode 100644 index 0000000000..894364bc5b --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Create-order.mdx @@ -0,0 +1,132 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create order + Creates an order based on field descriptions + + + +`Function CreateOrder(Val Token, Val OrderDescription, Val OnlineStore = False, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | OrderDescription | --order | Structure of KeyAndValue | Set of order fields. See GetOrderDescription | + | OnlineStore | --ostore | Boolean | Flag of Online store order type | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Order registration](https://api-docs.cdek.ru/29923926.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + + OrderDescription = New Structure; + + SendLocation = New Structure; + SendLocation.Insert("code" , "44"); + SendLocation.Insert("city" , "Moscow"); + SendLocation.Insert("address", "Ave. Leningradsky, 4"); + + DestLocation = New Structure; + DestLocation.Insert("code" , "270"); + DestLocation.Insert("city" , "Novosibirsk"); + DestLocation.Insert("address", "st. Bluchera, 32"); + + Recipient = New Structure; + + Phones = New Array; + Phones.Add(New Structure("number", "+79134637228")); + + Recipient.Insert("phones", Phones); + Recipient.Insert("name" , "Ivaniv Ivan"); + + Sender = New Structure("name", "Petrov Petr"); + + Services = New Array; + + Service = New Structure; + Service.Insert("code" , "SECURE_PACKAGE_A2"); + Service.Insert("parameter", 10); + + Services.Add(Service); + + Packages = New Array; + + Package = New Structure; + + Items = New Array; + + Item = New Structure; + + Payment = New Structure; + Payment.Insert("value", 3000); + + Item.Insert("payment" , Payment); + Item.Insert("ware_key", "00055"); + Item.Insert("name" , "Product"); + Item.Insert("cost" , 300); + Item.Insert("amount" , 2); + Item.Insert("weight" , 700); + Item.Insert("url" , "www.item.ru"); + + Items.Add(Item); + + Package.Insert("items" , Items); + Package.Insert("number" , "bar-001"); + Package.Insert("comment", "Packaging"); + Package.Insert("height" , 10); + Package.Insert("length" , 10); + Package.Insert("weight" , "4000"); + Package.Insert("width" , 10); + + Packages.Add(Package); + + OrderDescription.Insert("from_location", SendLocation); + OrderDescription.Insert("to_location" , DestLocation); + OrderDescription.Insert("packages" , Packages); + OrderDescription.Insert("recipient" , Recipient); + OrderDescription.Insert("sender" , Sender); + OrderDescription.Insert("services" , Services); + + OrderDescription.Insert("number" , "ddOererre7450813980068"); + OrderDescription.Insert("comment" , "New order"); + OrderDescription.Insert("tariff_code", 139); + + OrderDescription.Insert("delivery_recipient_cost" , New Structure("value" , 50)); + OrderDescription.Insert("delivery_recipient_cost_adv", New Structure("sum,threshold", 3000, 200)); + + Result = OPI_CDEK.CreateOrder(Token, OrderDescription, True, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" + }, + "requests": [ + { + "request_uuid": "825e8d4d-e04d-404e-939b-e119ba58707a", + "type": "CREATE", + "date_time": "2024-10-12T19:31:14+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Create-refusal.md b/docs/en/md/CDEK/Orders-managment/Create-refusal.md deleted file mode 100644 index 32d90143ee..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Create-refusal.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Create refusal - Creates an order refusal to return to the online store - - - -`Function CreateRefusal(Val Token, Val UUID, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | UUID | --uuid | String | Order UUID | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Registration of refusal](https://api-docs.cdek.ru/55327658.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - Result = OPI_CDEK.CreateRefusal(Token, UUID, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" - }, - "requests": [ - { - "request_uuid": "048cf376-c616-405b-9676-1f66f3106ce0", - "type": "CREATE_REFUSAL", - "date_time": "2024-10-12T19:31:15+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Create-refusal.mdx b/docs/en/md/CDEK/Orders-managment/Create-refusal.mdx new file mode 100644 index 0000000000..4dec81b8df --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Create-refusal.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Create refusal + Creates an order refusal to return to the online store + + + +`Function CreateRefusal(Val Token, Val UUID, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | UUID | --uuid | String | Order UUID | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Registration of refusal](https://api-docs.cdek.ru/55327658.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + Result = OPI_CDEK.CreateRefusal(Token, UUID, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" + }, + "requests": [ + { + "request_uuid": "048cf376-c616-405b-9676-1f66f3106ce0", + "type": "CREATE_REFUSAL", + "date_time": "2024-10-12T19:31:15+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Delete-order.md b/docs/en/md/CDEK/Orders-managment/Delete-order.md deleted file mode 100644 index f331f03b1f..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Delete-order.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete order - Deletes order by UUID - - - -`Function DeleteOrder(Val Token, Val UUID, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | UUID | --uuid | String | Order UUID for deletion | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Deleting an order](https://api-docs.cdek.ru/29924487.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - Result = OPI_CDEK.DeleteOrder(Token, UUID, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" - }, - "requests": [ - { - "request_uuid": "0112f5e9-36db-4146-ac65-ae0f6e67b488", - "type": "DELETE", - "date_time": "2024-10-12T19:31:15+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Delete-order.mdx b/docs/en/md/CDEK/Orders-managment/Delete-order.mdx new file mode 100644 index 0000000000..8dc9d9878e --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Delete-order.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete order + Deletes order by UUID + + + +`Function DeleteOrder(Val Token, Val UUID, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | UUID | --uuid | String | Order UUID for deletion | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Deleting an order](https://api-docs.cdek.ru/29924487.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + Result = OPI_CDEK.DeleteOrder(Token, UUID, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" + }, + "requests": [ + { + "request_uuid": "0112f5e9-36db-4146-ac65-ae0f6e67b488", + "type": "DELETE", + "date_time": "2024-10-12T19:31:15+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Get-order-by-number.md b/docs/en/md/CDEK/Orders-managment/Get-order-by-number.md deleted file mode 100644 index ee753d431f..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Get-order-by-number.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get order by number - Receives the order by CDEK number or number from customer IB - - - -`Function GetOrderByNumber(Val Token, Val OrderNumber, Val Internal = False, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | OrderNumber | --number | String | Order number | - | Internal | --internal | Boolean | Type of order number. True > number in the customer base, False > CDEK number | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Order information](https://api-docs.cdek.ru/29923975.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - - OrderNumber = "ddOererre7450813980068"; - Result = OPI_CDEK.GetOrderByNumber(Token, OrderNumber, True, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd", - "type": 1, - "is_return": false, - "is_reverse": false, - "number": "ddOererre7450813980068", - "tariff_code": 139, - "comment": "New order", - "delivery_recipient_cost": { - "value": 50 - }, - "delivery_recipient_cost_adv": [ - { - "threshold": 200, - "sum": 3000 - } - ], - "sender": { - "name": "Petrov Petr", - "passport_requirements_satisfied": false - }, - "seller": { - "name": "Тестирование Интеграции ИМ" - }, - "recipient": { - "name": "Ivaniv Ivan", - "phones": [ - { - "number": "+79134637228" - } - ], - "passport_requirements_satisfied": false - }, - "from_location": { - "code": 44, - "city_uuid": "7e8f36ba-d937-4ce4-8d53-e44177db6469", - "city": "Москва", - "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", - "kladr_code": "7700000000000", - "country_code": "RU", - "country": "Россия", - "region": "Москва", - "region_code": 81, - "sub_region": "Москва", - "longitude": 37.61556, - "latitude": 55.75222, - "address": "Ave. Leningradsky, 4" - }, - "to_location": { - "code": 270, - "city_uuid": "4e938d63-e189-454d-bb5c-54bfb2f1e4e2", - "city": "Новосибирск", - "kladr_code": "5400000100000", - "country_code": "RU", - "country": "Россия", - "region": "Новосибирская область", - "region_code": 23, - "sub_region": "городской округ Новосибирск", - "longitude": 82.906928, - "latitude": 55.028739, - "address": "st. Bluchera, 32" - }, - "services": [ - { - "code": "SECURE_PACKAGE_A2", - "parameter": "10" - } - ], - "packages": [ - { - "number": "bar-001", - "weight": 4000, - "length": 10, - "width": 10, - "height": 10, - "comment": "Packaging", - "items": [ - { - "name": "Product", - "ware_key": "00055", - "payment": { - "value": 3000 - }, - "weight": 700, - "amount": 2, - "url": "www.item.ru", - "return_item_detail": {}, - "excise": false, - "cost": 300 - } - ] - } - ], - "statuses": [ - { - "code": "ACCEPTED", - "name": "Принят", - "date_time": "2024-10-12T19:31:14+03:00", - "city": "Офис СДЭК" - } - ], - "is_client_return": false, - "delivery_detail": { - "total_sum": 0, - "payment_info": [] - }, - "calls": {} - }, - "requests": [ - { - "request_uuid": "825e8d4d-e04d-404e-939b-e119ba58707a", - "type": "CREATE", - "date_time": "2024-10-12T19:31:14+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Get-order-by-number.mdx b/docs/en/md/CDEK/Orders-managment/Get-order-by-number.mdx new file mode 100644 index 0000000000..800a9783d3 --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Get-order-by-number.mdx @@ -0,0 +1,163 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get order by number + Receives the order by CDEK number or number from customer IB + + + +`Function GetOrderByNumber(Val Token, Val OrderNumber, Val Internal = False, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | OrderNumber | --number | String | Order number | + | Internal | --internal | Boolean | Type of order number. True > number in the customer base, False > CDEK number | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Order information](https://api-docs.cdek.ru/29923975.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + + OrderNumber = "ddOererre7450813980068"; + Result = OPI_CDEK.GetOrderByNumber(Token, OrderNumber, True, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd", + "type": 1, + "is_return": false, + "is_reverse": false, + "number": "ddOererre7450813980068", + "tariff_code": 139, + "comment": "New order", + "delivery_recipient_cost": { + "value": 50 + }, + "delivery_recipient_cost_adv": [ + { + "threshold": 200, + "sum": 3000 + } + ], + "sender": { + "name": "Petrov Petr", + "passport_requirements_satisfied": false + }, + "seller": { + "name": "Тестирование Интеграции ИМ" + }, + "recipient": { + "name": "Ivaniv Ivan", + "phones": [ + { + "number": "+79134637228" + } + ], + "passport_requirements_satisfied": false + }, + "from_location": { + "code": 44, + "city_uuid": "7e8f36ba-d937-4ce4-8d53-e44177db6469", + "city": "Москва", + "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", + "kladr_code": "7700000000000", + "country_code": "RU", + "country": "Россия", + "region": "Москва", + "region_code": 81, + "sub_region": "Москва", + "longitude": 37.61556, + "latitude": 55.75222, + "address": "Ave. Leningradsky, 4" + }, + "to_location": { + "code": 270, + "city_uuid": "4e938d63-e189-454d-bb5c-54bfb2f1e4e2", + "city": "Новосибирск", + "kladr_code": "5400000100000", + "country_code": "RU", + "country": "Россия", + "region": "Новосибирская область", + "region_code": 23, + "sub_region": "городской округ Новосибирск", + "longitude": 82.906928, + "latitude": 55.028739, + "address": "st. Bluchera, 32" + }, + "services": [ + { + "code": "SECURE_PACKAGE_A2", + "parameter": "10" + } + ], + "packages": [ + { + "number": "bar-001", + "weight": 4000, + "length": 10, + "width": 10, + "height": 10, + "comment": "Packaging", + "items": [ + { + "name": "Product", + "ware_key": "00055", + "payment": { + "value": 3000 + }, + "weight": 700, + "amount": 2, + "url": "www.item.ru", + "return_item_detail": {}, + "excise": false, + "cost": 300 + } + ] + } + ], + "statuses": [ + { + "code": "ACCEPTED", + "name": "Принят", + "date_time": "2024-10-12T19:31:14+03:00", + "city": "Офис СДЭК" + } + ], + "is_client_return": false, + "delivery_detail": { + "total_sum": 0, + "payment_info": [] + }, + "calls": {} + }, + "requests": [ + { + "request_uuid": "825e8d4d-e04d-404e-939b-e119ba58707a", + "type": "CREATE", + "date_time": "2024-10-12T19:31:14+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Get-order-description.md b/docs/en/md/CDEK/Orders-managment/Get-order-description.md deleted file mode 100644 index 09a770016a..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Get-order-description.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get order description - Gets the layout of order for the CreateOrder function - - - -`Function GetOrderDescription(Val Clear = False, Val RequiredOnly = False, Val OnlineStore = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - | RequiredOnly | --required | Boolean | True > only required fields will be in the set | - | OnlineStore | --ostore | Boolean | Flag of including fields in the layout exclusively for online store orders | - - - Returns: Structure of KeyAndValue - Fields structure - -
- -:::tip -Required fields may depend on the type of order or nesting. Be sure to read the CDEK documentation - - Field descriptions in the documentation: [Order registration](https://api-docs.cdek.ru/29923926.html) -::: -
- - -```bsl title="Code example" - Result = OPI_CDEK.GetOrderDescription(); -``` - - - - -```json title="Result" -{ - "tariff_code": "", - "recipient": { - "company": "", - "name": "", - "passport_series": "", - "passport_number": "", - "passport_date_of_issue": "", - "passport_organization": "", - "tin": "", - "passport_date_of_birth": "", - "email": "", - "contragent_type": "", - "phones": [ - { - "number": "", - "additional": "" - } - ] - }, - "packages": [ - { - "number": "", - "weight": "", - "length": "", - "width": "", - "height": "", - "comment": "", - "items": [ - { - "name": "", - "ware_key": "", - "marking": "", - "payment": { - "value": "", - "vat_sum": "", - "vat_rate": "" - }, - "cost": "", - "weight": "", - "weight_gross": "", - "amount": "", - "name_i18n": "", - "brand": "", - "country_code": "", - "material": "", - "wifi_gsm": "", - "url": "" - } - ] - } - ], - "additional_order_types": "", - "comment": "", - "developer_key": "", - "shipment_point": "", - "delivery_point": "", - "date_invoice": "", - "shipper_name": "", - "shipper_address": "", - "sender": { - "company": "", - "name": "", - "email": "", - "passport_series": "", - "passport_number": "", - "passport_date_of_issue": "", - "passport_organization": "", - "tin": "", - "passport_date_of_birth": "", - "contragent_type": "", - "phones": [ - { - "number": "", - "additional": "" - } - ] - }, - "from_location": { - "code": "", - "fias_guid": "", - "postal_code": "", - "longitude": "", - "latitude": "", - "country_code": "", - "region": "", - "region_code": "", - "sub_region": "", - "city": "", - "kladr_code": "", - "address": "
" - }, - "to_location": { - "code": "", - "fias_guid": "", - "postal_code": "", - "longitude": "", - "latitude": "", - "country_code": "", - "region": "", - "region_code": "", - "sub_region": "", - "city": "", - "kladr_code": "", - "address": "
" - }, - "services": { - "code": "", - "parameter": "" - }, - "print": "", - "is_client_return": "", - "accompanying_number": "", - "widget_token": "" -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Get-order-description.mdx b/docs/en/md/CDEK/Orders-managment/Get-order-description.mdx new file mode 100644 index 0000000000..85895df95d --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Get-order-description.mdx @@ -0,0 +1,157 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get order description + Gets the layout of order for the CreateOrder function + + + +`Function GetOrderDescription(Val Clear = False, Val RequiredOnly = False, Val OnlineStore = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + | RequiredOnly | --required | Boolean | True > only required fields will be in the set | + | OnlineStore | --ostore | Boolean | Flag of including fields in the layout exclusively for online store orders | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ +:::tip +Required fields may depend on the type of order or nesting. Be sure to read the CDEK documentation + + Field descriptions in the documentation: [Order registration](https://api-docs.cdek.ru/29923926.html) +::: +
+ + +```bsl title="Code example" + Result = OPI_CDEK.GetOrderDescription(); +``` + + + + +```json title="Result" +{ + "tariff_code": "", + "recipient": { + "company": "", + "name": "", + "passport_series": "", + "passport_number": "", + "passport_date_of_issue": "", + "passport_organization": "", + "tin": "", + "passport_date_of_birth": "", + "email": "", + "contragent_type": "", + "phones": [ + { + "number": "", + "additional": "" + } + ] + }, + "packages": [ + { + "number": "", + "weight": "", + "length": "", + "width": "", + "height": "", + "comment": "", + "items": [ + { + "name": "", + "ware_key": "", + "marking": "", + "payment": { + "value": "", + "vat_sum": "", + "vat_rate": "" + }, + "cost": "", + "weight": "", + "weight_gross": "", + "amount": "", + "name_i18n": "", + "brand": "", + "country_code": "", + "material": "", + "wifi_gsm": "", + "url": "" + } + ] + } + ], + "additional_order_types": "", + "comment": "", + "developer_key": "", + "shipment_point": "", + "delivery_point": "", + "date_invoice": "", + "shipper_name": "", + "shipper_address": "", + "sender": { + "company": "", + "name": "", + "email": "", + "passport_series": "", + "passport_number": "", + "passport_date_of_issue": "", + "passport_organization": "", + "tin": "", + "passport_date_of_birth": "", + "contragent_type": "", + "phones": [ + { + "number": "", + "additional": "" + } + ] + }, + "from_location": { + "code": "", + "fias_guid": "", + "postal_code": "", + "longitude": "", + "latitude": "", + "country_code": "", + "region": "", + "region_code": "", + "sub_region": "", + "city": "", + "kladr_code": "", + "address": "
" + }, + "to_location": { + "code": "", + "fias_guid": "", + "postal_code": "", + "longitude": "", + "latitude": "", + "country_code": "", + "region": "", + "region_code": "", + "sub_region": "", + "city": "", + "kladr_code": "", + "address": "
" + }, + "services": { + "code": "", + "parameter": "" + }, + "print": "", + "is_client_return": "", + "accompanying_number": "", + "widget_token": "" +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Get-order.md b/docs/en/md/CDEK/Orders-managment/Get-order.md deleted file mode 100644 index bd88eb068f..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Get-order.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get order - Gets the order by UUID - - - -`Function GetOrder(Val Token, Val UUID, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | UUID | --uuid | String | Order UUID | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Order information](https://api-docs.cdek.ru/29923975.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - Result = OPI_CDEK.GetOrder(Token, UUID, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd", - "type": 1, - "number": "ddOererre7450813980068", - "tariff_code": 139, - "comment": "New order", - "delivery_recipient_cost": { - "value": 50 - }, - "delivery_recipient_cost_adv": [ - { - "threshold": 200, - "sum": 3000 - } - ], - "sender": { - "name": "Petrov Petr" - }, - "recipient": { - "name": "Ivaniv Ivan", - "phones": [ - { - "number": "+79134637228" - } - ] - }, - "from_location": { - "code": 44, - "city": "Moscow", - "address": "Ave. Leningradsky, 4" - }, - "to_location": { - "code": 270, - "city": "Novosibirsk", - "address": "st. Bluchera, 32" - }, - "services": [ - { - "code": "SECURE_PACKAGE_A2", - "parameter": "10" - } - ], - "packages": [ - { - "number": "bar-001", - "weight": 4000, - "length": 10, - "width": 10, - "height": 10, - "comment": "Packaging", - "items": [ - { - "name": "Product", - "ware_key": "00055", - "payment": { - "value": 3000 - }, - "weight": 700, - "amount": 2, - "url": "www.item.ru", - "cost": 300 - } - ] - } - ], - "statuses": [ - { - "code": "ACCEPTED", - "name": "Принят", - "date_time": "2024-10-12T19:31:14+03:00", - "city": "Офис СДЭК" - } - ] - }, - "requests": [ - { - "request_uuid": "825e8d4d-e04d-404e-939b-e119ba58707a", - "type": "CREATE", - "date_time": "2024-10-12T19:31:14+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Get-order.mdx b/docs/en/md/CDEK/Orders-managment/Get-order.mdx new file mode 100644 index 0000000000..c341c8db76 --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Get-order.mdx @@ -0,0 +1,128 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get order + Gets the order by UUID + + + +`Function GetOrder(Val Token, Val UUID, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | UUID | --uuid | String | Order UUID | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Order information](https://api-docs.cdek.ru/29923975.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + Result = OPI_CDEK.GetOrder(Token, UUID, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd", + "type": 1, + "number": "ddOererre7450813980068", + "tariff_code": 139, + "comment": "New order", + "delivery_recipient_cost": { + "value": 50 + }, + "delivery_recipient_cost_adv": [ + { + "threshold": 200, + "sum": 3000 + } + ], + "sender": { + "name": "Petrov Petr" + }, + "recipient": { + "name": "Ivaniv Ivan", + "phones": [ + { + "number": "+79134637228" + } + ] + }, + "from_location": { + "code": 44, + "city": "Moscow", + "address": "Ave. Leningradsky, 4" + }, + "to_location": { + "code": 270, + "city": "Novosibirsk", + "address": "st. Bluchera, 32" + }, + "services": [ + { + "code": "SECURE_PACKAGE_A2", + "parameter": "10" + } + ], + "packages": [ + { + "number": "bar-001", + "weight": 4000, + "length": 10, + "width": 10, + "height": 10, + "comment": "Packaging", + "items": [ + { + "name": "Product", + "ware_key": "00055", + "payment": { + "value": 3000 + }, + "weight": 700, + "amount": 2, + "url": "www.item.ru", + "cost": 300 + } + ] + } + ], + "statuses": [ + { + "code": "ACCEPTED", + "name": "Принят", + "date_time": "2024-10-12T19:31:14+03:00", + "city": "Офис СДЭК" + } + ] + }, + "requests": [ + { + "request_uuid": "825e8d4d-e04d-404e-939b-e119ba58707a", + "type": "CREATE", + "date_time": "2024-10-12T19:31:14+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/CDEK/Orders-managment/Update-order.md b/docs/en/md/CDEK/Orders-managment/Update-order.md deleted file mode 100644 index d509130c4a..0000000000 --- a/docs/en/md/CDEK/Orders-managment/Update-order.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Update order - Changes the field values of the selected order - - - -`Function UpdateOrder(Val Token, Val UUID, Val OrderDescription, Val TestAPI = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | UUID | --uuid | String | Order UUID for updating | - | OrderDescription | --order | Structure of KeyAndValue | Set of changing order fields | - | TestAPI | --testapi | Boolean | Flag to use test API for requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from CDEK - -
- -:::tip -Method at API documentation: [Change of order](https://api-docs.cdek.ru/36981178.html) -::: -
- - -```bsl title="Code example" - Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - OrderDescription = New Structure("comment", "NewComment"); - - Result = OPI_CDEK.UpdateOrder(Token, UUID, OrderDescription, True); -``` - - - - -```json title="Result" -{ - "entity": { - "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" - }, - "requests": [ - { - "request_uuid": "03d76b39-93a1-4c15-b5fa-ff49129579e4", - "type": "UPDATE", - "date_time": "2024-10-12T19:31:15+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/en/md/CDEK/Orders-managment/Update-order.mdx b/docs/en/md/CDEK/Orders-managment/Update-order.mdx new file mode 100644 index 0000000000..5ba203cae8 --- /dev/null +++ b/docs/en/md/CDEK/Orders-managment/Update-order.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Update order + Changes the field values of the selected order + + + +`Function UpdateOrder(Val Token, Val UUID, Val OrderDescription, Val TestAPI = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | UUID | --uuid | String | Order UUID for updating | + | OrderDescription | --order | Structure of KeyAndValue | Set of changing order fields | + | TestAPI | --testapi | Boolean | Flag to use test API for requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from CDEK + +
+ +:::tip +Method at API documentation: [Change of order](https://api-docs.cdek.ru/36981178.html) +::: +
+ + +```bsl title="Code example" + Token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + OrderDescription = New Structure("comment", "NewComment"); + + Result = OPI_CDEK.UpdateOrder(Token, UUID, OrderDescription, True); +``` + + + + +```json title="Result" +{ + "entity": { + "uuid": "9aedf214-562a-45a2-982c-897b753a0ebd" + }, + "requests": [ + { + "request_uuid": "03d76b39-93a1-4c15-b5fa-ff49129579e4", + "type": "UPDATE", + "date_time": "2024-10-12T19:31:15+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md b/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md deleted file mode 100644 index fe249d8ec3..0000000000 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get account information - Gets account information - - - -`Function GetAccountInformation(Val Token, Val Account = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Account | --account | String | Account ID. Current token account if not filled | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Result = OPI_Dropbox.GetAccountInformation(Token); -``` - - - - -```json title="Result" -{ - "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", - "name": { - "given_name": "Антон", - "surname": "Титовец", - "familiar_name": "Антон", - "display_name": "Антон Титовец", - "abbreviated_name": "АТ" - }, - "email": "bayselonarrend@gmail.com", - "email_verified": true, - "disabled": false, - "country": "BY", - "locale": "en", - "referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483", - "is_paired": false, - "account_type": { - ".tag": "basic" - }, - "root_info": { - ".tag": "user", - "root_namespace_id": "3179550035", - "home_namespace_id": "3179550035" - } -} -``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.mdx b/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.mdx new file mode 100644 index 0000000000..5608362acc --- /dev/null +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get account information + Gets account information + + + +`Function GetAccountInformation(Val Token, Val Account = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Account | --account | String | Account ID. Current token account if not filled | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Result = OPI_Dropbox.GetAccountInformation(Token); +``` + + + + +```json title="Result" +{ + "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", + "name": { + "given_name": "Антон", + "surname": "Титовец", + "familiar_name": "Антон", + "display_name": "Антон Титовец", + "abbreviated_name": "АТ" + }, + "email": "bayselonarrend@gmail.com", + "email_verified": true, + "disabled": false, + "country": "BY", + "locale": "en", + "referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483", + "is_paired": false, + "account_type": { + ".tag": "basic" + }, + "root_info": { + ".tag": "user", + "root_namespace_id": "3179550035", + "home_namespace_id": "3179550035" + } +} +``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md b/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md deleted file mode 100644 index 4210496bd6..0000000000 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get authorization link - Generates an authorization link for browser transition - - - -`Function GetAuthorizationLink(Val AppKey) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | AppKey | --appkey | String | Application key | - - - Returns: String - URL for browser transition - -
- - - - -```bsl title="Code example" - AppKey = "oynqxds..."; - Result = OPI_Dropbox.GetAuthorizationLink(AppKey); -``` - - - - -```json title="Result" -"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" -``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.mdx b/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.mdx new file mode 100644 index 0000000000..679af8390d --- /dev/null +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.mdx @@ -0,0 +1,37 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get authorization link + Generates an authorization link for browser transition + + + +`Function GetAuthorizationLink(Val AppKey) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | AppKey | --appkey | String | Application key | + + + Returns: String - URL for browser transition + +
+ + + + +```bsl title="Code example" + AppKey = "oynqxds..."; + Result = OPI_Dropbox.GetAuthorizationLink(AppKey); +``` + + + + +```json title="Result" +"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" +``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md b/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md deleted file mode 100644 index c609e9040a..0000000000 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get space usage data - Gets information on the amount of used disk space - - - -`Function GetSpaceUsageData(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Result = OPI_Dropbox.GetSpaceUsageData(Token); -``` - - - - -```json title="Result" -{ - "used": 1477704605, - "allocation": { - ".tag": "individual", - "allocated": 2147483648 - } -} -``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.mdx b/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.mdx new file mode 100644 index 0000000000..88448ce182 --- /dev/null +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get space usage data + Gets information on the amount of used disk space + + + +`Function GetSpaceUsageData(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Result = OPI_Dropbox.GetSpaceUsageData(Token); +``` + + + + +```json title="Result" +{ + "used": 1477704605, + "allocation": { + ".tag": "individual", + "allocated": 2147483648 + } +} +``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-token.md b/docs/en/md/Dropbox/Account-and-authorization/Get-token.md deleted file mode 100644 index 7de605cb86..0000000000 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-token.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get token - Gets token based on the code from the GetAuthorizationLink page - - - -`Function GetToken(Val AppKey, Val AppSecret, Val Code) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | AppKey | --appkey | String | Application key | - | AppSecret | --appsecret | String | Application secret | - | Code | --code | String | Code from the authorization page | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - AppKey = "oynqxds..."; - AppSecret = "tk2oewn..."; - Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; - - Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code); -``` - - - - -```json title="Result" -{ - "error": "invalid_grant", - "error_description": "code doesn't exist or has expired" - } -``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-token.mdx b/docs/en/md/Dropbox/Account-and-authorization/Get-token.mdx new file mode 100644 index 0000000000..484050c113 --- /dev/null +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-token.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get token + Gets token based on the code from the GetAuthorizationLink page + + + +`Function GetToken(Val AppKey, Val AppSecret, Val Code) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | AppKey | --appkey | String | Application key | + | AppSecret | --appsecret | String | Application secret | + | Code | --code | String | Code from the authorization page | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + AppKey = "oynqxds..."; + AppSecret = "tk2oewn..."; + Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; + + Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code); +``` + + + + +```json title="Result" +{ + "error": "invalid_grant", + "error_description": "code doesn't exist or has expired" + } +``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md b/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md deleted file mode 100644 index aab6ebde75..0000000000 --- a/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Refresh token - Gets a new token based on the refresh token - - - -`Function RefreshToken(Val AppKey, Val AppSecret, Val RefreshToken) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | AppKey | --appkey | String | Application key | - | AppSecret | --appsecret | String | Application secret | - | RefreshToken | --refresh | String | Refresh token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - AppKey = "oynqxds..."; - AppSecret = "tk2oewn..."; - RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; - - Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken); -``` - - - - -```json title="Result" -{ - "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", - "token_type": "bearer", - "expires_in": 14400 - } -``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.mdx b/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.mdx new file mode 100644 index 0000000000..3443ca4bd8 --- /dev/null +++ b/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Refresh token + Gets a new token based on the refresh token + + + +`Function RefreshToken(Val AppKey, Val AppSecret, Val RefreshToken) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | AppKey | --appkey | String | Application key | + | AppSecret | --appsecret | String | Application secret | + | RefreshToken | --refresh | String | Refresh token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + AppKey = "oynqxds..."; + AppSecret = "tk2oewn..."; + RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; + + Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken); +``` + + + + +```json title="Result" +{ + "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", + "token_type": "bearer", + "expires_in": 14400 + } +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md b/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md deleted file mode 100644 index f2c48299af..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Copy object - Copies a file or directory to the selected path - - - -`Function CopyObject(Val Token, Val From, Val Target) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | From | --from | String | Path to the original object | - | Target | --to | String | Target path for the new object | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Original = "/New/pic.png"; - Copy = "/New/pic_copy.png"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Result = OPI_Dropbox.CopyObject(Token, Original, Copy); -``` - - - - -```json title="Result" -{ - "metadata": { - ".tag": "file", - "name": "pic_copy.png", - "path_lower": "/new/pic_copy.png", - "path_display": "/New/pic_copy.png", - "id": "id:kJU6-a-pT48AAAAAAAAclQ", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:16:45Z", - "rev": "6240532c29927bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Copy-object.mdx b/docs/en/md/Dropbox/File-and-directory-management/Copy-object.mdx new file mode 100644 index 0000000000..fea84c68c2 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Copy-object.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Copy object + Copies a file or directory to the selected path + + + +`Function CopyObject(Val Token, Val From, Val Target) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | From | --from | String | Path to the original object | + | Target | --to | String | Target path for the new object | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Original = "/New/pic.png"; + Copy = "/New/pic_copy.png"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Result = OPI_Dropbox.CopyObject(Token, Original, Copy); +``` + + + + +```json title="Result" +{ + "metadata": { + ".tag": "file", + "name": "pic_copy.png", + "path_lower": "/new/pic_copy.png", + "path_display": "/New/pic_copy.png", + "id": "id:kJU6-a-pT48AAAAAAAAclQ", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:16:45Z", + "rev": "6240532c29927bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md b/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md deleted file mode 100644 index 8d86c28692..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Create folder - Creates an empty directory at the selected path - - - -`Function CreateFolder(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Target path for creating the directory | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New catalog"; - - Result = OPI_Dropbox.CreateFolder(Token, Path); -``` - - - - -```json title="Result" -{ - "metadata": { - "name": "New catalog", - "path_lower": "/new catalog", - "path_display": "/New catalog", - "id": "id:kJU6-a-pT48AAAAAAAAclw" - } -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Create-folder.mdx b/docs/en/md/Dropbox/File-and-directory-management/Create-folder.mdx new file mode 100644 index 0000000000..5021248a03 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Create-folder.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Create folder + Creates an empty directory at the selected path + + + +`Function CreateFolder(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Target path for creating the directory | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New catalog"; + + Result = OPI_Dropbox.CreateFolder(Token, Path); +``` + + + + +```json title="Result" +{ + "metadata": { + "name": "New catalog", + "path_lower": "/new catalog", + "path_display": "/New catalog", + "id": "id:kJU6-a-pT48AAAAAAAAclw" + } +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md b/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md deleted file mode 100644 index bd3d58b9f1..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Delete object - Deletes an object from the cloud drive - - - -`Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object to delete | - | Irrecoverable | --permanently | String | Delete object without the possibility of recovery | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Path = "/New/pic.png"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Result = OPI_Dropbox.DeleteObject(Token, Path); -``` - - - - -```json title="Result" -{ - "metadata": { - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAckw", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:16:39Z", - "rev": "624053263b1b1bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Delete-object.mdx b/docs/en/md/Dropbox/File-and-directory-management/Delete-object.mdx new file mode 100644 index 0000000000..2747369513 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Delete-object.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Delete object + Deletes an object from the cloud drive + + + +`Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object to delete | + | Irrecoverable | --permanently | String | Delete object without the possibility of recovery | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Path = "/New/pic.png"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Result = OPI_Dropbox.DeleteObject(Token, Path); +``` + + + + +```json title="Result" +{ + "metadata": { + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAckw", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:16:39Z", + "rev": "624053263b1b1bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Download-file.md b/docs/en/md/Dropbox/File-and-directory-management/Download-file.md deleted file mode 100644 index 97ac1686e0..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Download-file.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Download file - Downloads a file by the specified path or ID - - - -`Function DownloadFile(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path or ID of the file | - - - Returns: BinaryData - binary data of the file - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New/pic.png"; - - Result = OPI_Dropbox.DownloadFile(Token, Path); -``` - - - - -```json title="Result" -NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Download-file.mdx b/docs/en/md/Dropbox/File-and-directory-management/Download-file.mdx new file mode 100644 index 0000000000..f3120b2327 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Download-file.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Download file + Downloads a file by the specified path or ID + + + +`Function DownloadFile(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path or ID of the file | + + + Returns: BinaryData - binary data of the file + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New/pic.png"; + + Result = OPI_Dropbox.DownloadFile(Token, Path); +``` + + + + +```json title="Result" +NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md b/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md deleted file mode 100644 index 07ec4cb056..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Download folder - Downloads a zip archive with the contents of the specified directory - - - -`Function DownloadFolder(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path or ID of the directory | - - - Returns: BinaryData - binary data of the zip archive with the contents of the directory - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New"; - - Result = OPI_Dropbox.DownloadFolder(Token, Path); -``` - - - - -```json title="Result" -NOT JSON: 50 4B 03 04 14 00 00 08 00 00 78 94 48 59 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 84 7B 05 67 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Download-folder.mdx b/docs/en/md/Dropbox/File-and-directory-management/Download-folder.mdx new file mode 100644 index 0000000000..c979cc3f74 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Download-folder.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Download folder + Downloads a zip archive with the contents of the specified directory + + + +`Function DownloadFolder(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path or ID of the directory | + + + Returns: BinaryData - binary data of the zip archive with the contents of the directory + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New"; + + Result = OPI_Dropbox.DownloadFolder(Token, Path); +``` + + + + +```json title="Result" +NOT JSON: 50 4B 03 04 14 00 00 08 00 00 78 94 48 59 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 84 7B 05 67 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md b/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md deleted file mode 100644 index 78efcfbf90..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get list of folder files - Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified - - - -`Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the directory. Optional if the cursor is specified | - | Detailed | --detail | Boolean | Add information fields for mediafiles | - | Cursor | --cursor | String | Cursor from the previous request to get the next set of files | - - - Returns: HTTPResponse - Get list of folder files - -
- - - - -```bsl title="Code example" - Path = "/New"; - Token = "sl.B6AQWp9MlZlz4iaf41whVKxX9-MXeCiQhPRe4YIRxFmZ3zHsdjmOAatzgaWVhqmlIOvDD6WIUQ..."; - - Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True); -``` - - - - -```json title="Result" -{ - "entries": [ - { - ".tag": "file", - "name": "Dogs.mp3", - "path_lower": "/new/dogs.mp3", - "path_display": "/New/Dogs.mp3", - "id": "id:kJU6-a-pT48AAAAAAAAACA", - "client_modified": "2024-05-15T16:58:30Z", - "server_modified": "2024-10-09T06:18:27Z", - "rev": "6240538d38b44bd841553", - "size": 9229352, - "is_downloadable": true, - "content_hash": "376f728ef041d9cef08406f16debc12de89d83130e69c66a817fd834d2d82dc2" - }, - { - ".tag": "file", - "name": "url_doc (1).docx", - "path_lower": "/new/url_doc (1).docx", - "path_display": "/New/url_doc (1).docx", - "id": "id:kJU6-a-pT48AAAAAAAALvg", - "client_modified": "2024-07-15T17:40:28Z", - "server_modified": "2024-10-09T06:18:27Z", - "rev": "6240538d38b45bd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" - }, - { - ".tag": "file", - "name": "mydoc.docx", - "path_lower": "/new/mydoc.docx", - "path_display": "/New/mydoc.docx", - "id": "id:kJU6-a-pT48AAAAAAAAABw", - "client_modified": "2024-05-14T16:49:41Z", - "server_modified": "2024-10-09T06:18:27Z", - "rev": "6240538d38b46bd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" - } - ], - "cursor": "AAFjPjioXCUm-cvSmWhTXvwp-AUzcBlNDHgvyydaqo7QT6jkyTA4MLAzBdmSgdT0fsc_ssKPYWcv_tzh1hMAoOwuN09jJ9FS88bbx5mR6D4wXUd5v05GKJ_h52Nv88UOMiXah5SPwISriNOY3Vcez_oKLPyWrJ5pAuY1emSszhyeI7KLukeysjS8d79KvyQzi99nJ8smVQIQATrr2n0ioDwE", - "has_more": false -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.mdx b/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.mdx new file mode 100644 index 0000000000..ebdc9b7536 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get list of folder files + Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified + + + +`Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the directory. Optional if the cursor is specified | + | Detailed | --detail | Boolean | Add information fields for mediafiles | + | Cursor | --cursor | String | Cursor from the previous request to get the next set of files | + + + Returns: HTTPResponse - Get list of folder files + +
+ + + + +```bsl title="Code example" + Path = "/New"; + Token = "sl.B6AQWp9MlZlz4iaf41whVKxX9-MXeCiQhPRe4YIRxFmZ3zHsdjmOAatzgaWVhqmlIOvDD6WIUQ..."; + + Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True); +``` + + + + +```json title="Result" +{ + "entries": [ + { + ".tag": "file", + "name": "Dogs.mp3", + "path_lower": "/new/dogs.mp3", + "path_display": "/New/Dogs.mp3", + "id": "id:kJU6-a-pT48AAAAAAAAACA", + "client_modified": "2024-05-15T16:58:30Z", + "server_modified": "2024-10-09T06:18:27Z", + "rev": "6240538d38b44bd841553", + "size": 9229352, + "is_downloadable": true, + "content_hash": "376f728ef041d9cef08406f16debc12de89d83130e69c66a817fd834d2d82dc2" + }, + { + ".tag": "file", + "name": "url_doc (1).docx", + "path_lower": "/new/url_doc (1).docx", + "path_display": "/New/url_doc (1).docx", + "id": "id:kJU6-a-pT48AAAAAAAALvg", + "client_modified": "2024-07-15T17:40:28Z", + "server_modified": "2024-10-09T06:18:27Z", + "rev": "6240538d38b45bd841553", + "size": 24069, + "is_downloadable": true, + "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" + }, + { + ".tag": "file", + "name": "mydoc.docx", + "path_lower": "/new/mydoc.docx", + "path_display": "/New/mydoc.docx", + "id": "id:kJU6-a-pT48AAAAAAAAABw", + "client_modified": "2024-05-14T16:49:41Z", + "server_modified": "2024-10-09T06:18:27Z", + "rev": "6240538d38b46bd841553", + "size": 24069, + "is_downloadable": true, + "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" + } + ], + "cursor": "AAFjPjioXCUm-cvSmWhTXvwp-AUzcBlNDHgvyydaqo7QT6jkyTA4MLAzBdmSgdT0fsc_ssKPYWcv_tzh1hMAoOwuN09jJ9FS88bbx5mR6D4wXUd5v05GKJ_h52Nv88UOMiXah5SPwISriNOY3Vcez_oKLPyWrJ5pAuY1emSszhyeI7KLukeysjS8d79KvyQzi99nJ8smVQIQATrr2n0ioDwE", + "has_more": false +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md deleted file mode 100644 index 85ebfe6bc9..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get object information - Gets information about a file or directory - - - -`Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - | Detailed | --detail | Boolean | Add information fields for mediafiles | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Path = "/New/pic.png"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Result = OPI_Dropbox.GetObjectInformation(Token, Path, True); -``` - - - - -```json title="Result" -{ - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAckw", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:15:59Z", - "rev": "62405300c4139bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.mdx b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.mdx new file mode 100644 index 0000000000..37962228f6 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get object information + Gets information about a file or directory + + + +`Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + | Detailed | --detail | Boolean | Add information fields for mediafiles | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Path = "/New/pic.png"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Result = OPI_Dropbox.GetObjectInformation(Token, Path, True); +``` + + + + +```json title="Result" +{ + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAckw", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:15:59Z", + "rev": "62405300c4139bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md b/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md deleted file mode 100644 index 31ed6a7b02..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Get list of object versions - Gets the list of versions (revisions) of the object - - - -`Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - | Count | --amount | String, Number | Number of the latest versions of the object to display | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New/pic.png"; - - Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1); -``` - - - - -```json title="Result" -{ - "is_deleted": false, - "entries": [ - { - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAckw", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:15:59Z", - "rev": "62405300c4139bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } - ] -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.mdx b/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.mdx new file mode 100644 index 0000000000..e111ba4411 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Get list of object versions + Gets the list of versions (revisions) of the object + + + +`Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + | Count | --amount | String, Number | Number of the latest versions of the object to display | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New/pic.png"; + + Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1); +``` + + + + +```json title="Result" +{ + "is_deleted": false, + "entries": [ + { + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAckw", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:15:59Z", + "rev": "62405300c4139bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } + ] +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md deleted file mode 100644 index 73f3abe5cb..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get preview - Gets PDF or HTML preview of the object (for documents only) - - - -`Function GetPreview(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - - - Returns: BinaryData - document preview - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New/mydoc.docx"; - - Result = OPI_Dropbox.GetPreview(Token, Path); -``` - - - - -```json title="Result" -NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.mdx b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.mdx new file mode 100644 index 0000000000..87ddf2ec12 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get preview + Gets PDF or HTML preview of the object (for documents only) + + + +`Function GetPreview(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + + + Returns: BinaryData - document preview + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New/mydoc.docx"; + + Result = OPI_Dropbox.GetPreview(Token, Path); +``` + + + + +```json title="Result" +NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md b/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md deleted file mode 100644 index 0f5d9282f4..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get upload status by URL - Gets the upload status of the file by URL - - - -`Function GetUploadStatusByURL(Val Token, Val JobID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | JobID | --job | String | ID of async jsob from UploadFileByURL response | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - WorkID = "4SQ3zikww9gAAAAAAAAAAQ"; - Status = "in_progress"; - - WHile Status = "in_progress" Do - - Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID); - Status = Result[".tag"]; - - OPI_Tools.Pause(5); - - EndDo; -``` - - - - -```json title="Result" -{ - ".tag": "complete", - "name": "url_doc.docx", - "path_lower": "/new/url_doc.docx", - "path_display": "/New/url_doc.docx", - "id": "id:kJU6-a-pT48AAAAAAAAclg", - "client_modified": "2024-10-09T06:17:00Z", - "server_modified": "2024-10-09T06:17:01Z", - "rev": "6240533b3289cbd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.mdx b/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.mdx new file mode 100644 index 0000000000..0bae4c8bb7 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get upload status by URL + Gets the upload status of the file by URL + + + +`Function GetUploadStatusByURL(Val Token, Val JobID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | JobID | --job | String | ID of async jsob from UploadFileByURL response | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + WorkID = "4SQ3zikww9gAAAAAAAAAAQ"; + Status = "in_progress"; + + WHile Status = "in_progress" Do + + Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID); + Status = Result[".tag"]; + + OPI_Tools.Pause(5); + + EndDo; +``` + + + + +```json title="Result" +{ + ".tag": "complete", + "name": "url_doc.docx", + "path_lower": "/new/url_doc.docx", + "path_display": "/New/url_doc.docx", + "id": "id:kJU6-a-pT48AAAAAAAAclg", + "client_modified": "2024-10-09T06:17:00Z", + "server_modified": "2024-10-09T06:17:01Z", + "rev": "6240533b3289cbd841553", + "size": 24069, + "is_downloadable": true, + "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Move-object.md b/docs/en/md/Dropbox/File-and-directory-management/Move-object.md deleted file mode 100644 index 8772a39f78..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Move-object.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Move object - Moves an object to the selected path - - - -`Function MoveObject(Val Token, Val From, Val Target) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | From | --from | String | Path to the original object | - | Target | --to | String | Target path for the new object | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - OriginalPath = "/New/pic.png"; - TargetPath = "/pic.png"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath); -``` - - - - -```json title="Result" -{ - "metadata": { - ".tag": "file", - "name": "pic.png", - "path_lower": "/pic.png", - "path_display": "/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAckw", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:16:37Z", - "rev": "6240532489713bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Move-object.mdx b/docs/en/md/Dropbox/File-and-directory-management/Move-object.mdx new file mode 100644 index 0000000000..8cdaa49c8f --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Move-object.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Move object + Moves an object to the selected path + + + +`Function MoveObject(Val Token, Val From, Val Target) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | From | --from | String | Path to the original object | + | Target | --to | String | Target path for the new object | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + OriginalPath = "/New/pic.png"; + TargetPath = "/pic.png"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath); +``` + + + + +```json title="Result" +{ + "metadata": { + ".tag": "file", + "name": "pic.png", + "path_lower": "/pic.png", + "path_display": "/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAckw", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:16:37Z", + "rev": "6240532489713bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md b/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md deleted file mode 100644 index 31f3e0d4ee..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Restore object to version - Restores object state to required version (revision) - - - -`Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - | Version | --rev | String | ID of the version (revision) for restoration | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Version = "6246a08b887a8bd841553"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New/pic.png"; - - Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version); -``` - - - - -```json title="Result" -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAckw", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:15:59Z", - "rev": "62405300c4139bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.mdx b/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.mdx new file mode 100644 index 0000000000..588c81cb41 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Restore object to version + Restores object state to required version (revision) + + + +`Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + | Version | --rev | String | ID of the version (revision) for restoration | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Version = "6246a08b887a8bd841553"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New/pic.png"; + + Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version); +``` + + + + +```json title="Result" +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAckw", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:15:59Z", + "rev": "62405300c4139bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md b/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md deleted file mode 100644 index dabe114f7f..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Upload file by URL - Uploads a file to the cloud drive by fetching it from the specified URL - - - -`Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | FileURL | --url | String | URL source of the file | - | Path | --path | String | Save path on Dropbox | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Path = "/New/url_doc.docx"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - URL = "https://api.athenaeum.digital/test_data/document.docx"; - - Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path); -``` - - - - -```json title="Result" -{ - ".tag": "async_job_id", - "async_job_id": "GB72x7EzrHQAAAAAAAAAAQ" -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.mdx b/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.mdx new file mode 100644 index 0000000000..4832a61f7f --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Upload file by URL + Uploads a file to the cloud drive by fetching it from the specified URL + + + +`Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | FileURL | --url | String | URL source of the file | + | Path | --path | String | Save path on Dropbox | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Path = "/New/url_doc.docx"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + URL = "https://api.athenaeum.digital/test_data/document.docx"; + + Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path); +``` + + + + +```json title="Result" +{ + ".tag": "async_job_id", + "async_job_id": "GB72x7EzrHQAAAAAAAAAAQ" +} +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md deleted file mode 100644 index c677ac24e0..0000000000 --- a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Upload file - Uploads a file to the cloud drive - - - -`Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | File | --file | String, BinaryData | Data file for upload | - | Path | --path | String | Save path on Dropbox | - | Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Path = "/New/pic.png"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - - ImagePath = GetTempFileName("png"); - CopyFile(Image, ImagePath); - - Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True); -``` - - - - -```json title="Result" -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAckw", - "client_modified": "2024-10-09T06:15:59Z", - "server_modified": "2024-10-09T06:15:59Z", - "rev": "62405300c4139bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} -``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.mdx b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.mdx new file mode 100644 index 0000000000..d048248376 --- /dev/null +++ b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Upload file + Uploads a file to the cloud drive + + + +`Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | File | --file | String, BinaryData | Data file for upload | + | Path | --path | String | Save path on Dropbox | + | Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Path = "/New/pic.png"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + + ImagePath = GetTempFileName("png"); + CopyFile(Image, ImagePath); + + Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True); +``` + + + + +```json title="Result" +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAckw", + "client_modified": "2024-10-09T06:15:59Z", + "server_modified": "2024-10-09T06:15:59Z", + "rev": "62405300c4139bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md deleted file mode 100644 index 29027cf5b4..0000000000 --- a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Add users to file - Defines access to the file for third-party users - - - -`Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | FileID | --fileid | String | ID of the file to be accessed | - | EmailAddresses | --emails | String, Array of String | List of email addresses of users being added | - | ViewOnly | --readonly | Boolean | Prohibits file editing for the external user | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Email = "h5bk6ft62s@privaterelay.appleid.com"; - File = "kJU6-a-pT48AAAAAAAAABw"; - - Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False); -``` - - - - -```json title="Result" -[ - { - "member": { - ".tag": "email", - "email": "h5bk6ft62s@privaterelay.appleid.com" - }, - "result": { - ".tag": "success", - "success": { - ".tag": "editor" - } - }, - "sckey_sha1": "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4", - "invitation_signature": [ - "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4:ed7721b375882c806612d4056dad9f317cc98a22" - ] - } -] -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.mdx b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.mdx new file mode 100644 index 0000000000..5ad007f070 --- /dev/null +++ b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Add users to file + Defines access to the file for third-party users + + + +`Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | FileID | --fileid | String | ID of the file to be accessed | + | EmailAddresses | --emails | String, Array of String | List of email addresses of users being added | + | ViewOnly | --readonly | Boolean | Prohibits file editing for the external user | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Email = "h5bk6ft62s@privaterelay.appleid.com"; + File = "kJU6-a-pT48AAAAAAAAABw"; + + Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False); +``` + + + + +```json title="Result" +[ + { + "member": { + ".tag": "email", + "email": "h5bk6ft62s@privaterelay.appleid.com" + }, + "result": { + ".tag": "success", + "success": { + ".tag": "editor" + } + }, + "sckey_sha1": "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4", + "invitation_signature": [ + "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4:ed7721b375882c806612d4056dad9f317cc98a22" + ] + } +] +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md deleted file mode 100644 index f18d3f33b4..0000000000 --- a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Add users to folder - Grants external users access to the directory - - - -`Function AddUsersToFolder(Val Token, Val FolderID, Val EmailAddresses, Val ViewOnly = True) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | FolderID | --folder | String | ID of the public catalog (shared folder ID) | - | EmailAddresses | --emails | String, Array of String | List of email addresses of users being added | - | ViewOnly | --readonly | Boolean | Prohibits file editing for the external user | - - - Returns: Undefined - empty response - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Email = "h5bk6ft62s@privaterelay.appleid.com"; - Folder = "11727195745"; // shared_folder_id - - Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False); -``` - - - - -```json title="Result" -{} -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.mdx b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.mdx new file mode 100644 index 0000000000..0ed8ecf71c --- /dev/null +++ b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Add users to folder + Grants external users access to the directory + + + +`Function AddUsersToFolder(Val Token, Val FolderID, Val EmailAddresses, Val ViewOnly = True) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | FolderID | --folder | String | ID of the public catalog (shared folder ID) | + | EmailAddresses | --emails | String, Array of String | List of email addresses of users being added | + | ViewOnly | --readonly | Boolean | Prohibits file editing for the external user | + + + Returns: Undefined - empty response + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Email = "h5bk6ft62s@privaterelay.appleid.com"; + Folder = "11727195745"; // shared_folder_id + + Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False); +``` + + + + +```json title="Result" +{} +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md b/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md deleted file mode 100644 index 38d24f6cda..0000000000 --- a/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Unpublish file - Prohibits access to the file for external users - - - -`Function CancelFilePublication(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | FileID | --fileid | String | ID of the file to be accessed | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - File = "kJU6-a-pT48AAAAAAAAABw"; - - Result = OPI_Dropbox.CancelFilePublication(Token, File); -``` - - - - -```json title="Result" -{} -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.mdx b/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.mdx new file mode 100644 index 0000000000..6db556ff75 --- /dev/null +++ b/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Unpublish file + Prohibits access to the file for external users + + + +`Function CancelFilePublication(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | FileID | --fileid | String | ID of the file to be accessed | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + File = "kJU6-a-pT48AAAAAAAAABw"; + + Result = OPI_Dropbox.CancelFilePublication(Token, File); +``` + + + + +```json title="Result" +{} +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md b/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md deleted file mode 100644 index afbc5588c8..0000000000 --- a/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Unpublish folder - Cancels the public access mode for the directory - - - -`Function CancelFolderPublication(Val Token, Val FolderID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | FolderID | --folder | String | ID of the public catalog (shared folder ID) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Folder = "11727195745"; - - Result = OPI_Dropbox.CancelFolderPublication(Token, Folder); -``` - - - - -```json title="Result" -{ - ".tag": "async_job_id", - "async_job_id": "dbjid:AABIL_Y3eWbNQjjcels4kLWmUwVyjbJ-P7WpZzl6jIq3_fb2oSve73rWjYkC5VFtf8SOK2kP67Ms--L0g4pcUNzO" -} -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.mdx b/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.mdx new file mode 100644 index 0000000000..5d1e020882 --- /dev/null +++ b/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Unpublish folder + Cancels the public access mode for the directory + + + +`Function CancelFolderPublication(Val Token, Val FolderID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | FolderID | --folder | String | ID of the public catalog (shared folder ID) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Folder = "11727195745"; + + Result = OPI_Dropbox.CancelFolderPublication(Token, Folder); +``` + + + + +```json title="Result" +{ + ".tag": "async_job_id", + "async_job_id": "dbjid:AABIL_Y3eWbNQjjcels4kLWmUwVyjbJ-P7WpZzl6jIq3_fb2oSve73rWjYkC5VFtf8SOK2kP67Ms--L0g4pcUNzO" +} +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md b/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md deleted file mode 100644 index 56466f4f82..0000000000 --- a/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get asynchronous change status - Get async job status for access changes - - - -`Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | JobID | --job | String | AsynchronousJobID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - JobID = "dbjid:AACP-Bd0jYrnvlGEezhk65FDN-1sAlXg1FmEfjWibO2qt3sc3Yca2HQhzQuHu7aSqBCdN2pmgpS2ZUd8RkM2Yu8J"; - - Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID); -``` - - - - -```json title="Result" -{ - ".tag": "complete" -} -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.mdx b/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.mdx new file mode 100644 index 0000000000..7eb2253000 --- /dev/null +++ b/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get asynchronous change status + Get async job status for access changes + + + +`Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | JobID | --job | String | AsynchronousJobID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + JobID = "dbjid:AACP-Bd0jYrnvlGEezhk65FDN-1sAlXg1FmEfjWibO2qt3sc3Yca2HQhzQuHu7aSqBCdN2pmgpS2ZUd8RkM2Yu8J"; + + Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID); +``` + + + + +```json title="Result" +{ + ".tag": "complete" +} +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md deleted file mode 100644 index 8b54e93185..0000000000 --- a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Publish folder - Sets the directory to public access mode - - - -`Function PublishFolder(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the target directory | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New"; - - Result = OPI_Dropbox.PublishFolder(Token, Path); -``` - - - - -```json title="Result" -{ - ".tag": "complete", - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "path_display": "/New", - "path_lower": "/new", - "name": "New", - "policy": { - "acl_update_policy": { - ".tag": "editors" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "viewer_info_policy": { - ".tag": "enabled" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/ypsby2kvj4ds9c718922s/h?dl=0", - "shared_folder_id": "11679238129", - "time_invited": "2024-10-09T06:18:09Z", - "access_inheritance": { - ".tag": "inherit" - }, - "folder_id": "id:kJU6-a-pT48AAAAAAAAckg" -} -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.mdx b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.mdx new file mode 100644 index 0000000000..5e99908f5f --- /dev/null +++ b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Publish folder + Sets the directory to public access mode + + + +`Function PublishFolder(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the target directory | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New"; + + Result = OPI_Dropbox.PublishFolder(Token, Path); +``` + + + + +```json title="Result" +{ + ".tag": "complete", + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "path_display": "/New", + "path_lower": "/new", + "name": "New", + "policy": { + "acl_update_policy": { + ".tag": "editors" + }, + "shared_link_policy": { + ".tag": "anyone" + }, + "viewer_info_policy": { + ".tag": "enabled" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/ypsby2kvj4ds9c718922s/h?dl=0", + "shared_folder_id": "11679238129", + "time_invited": "2024-10-09T06:18:09Z", + "access_inheritance": { + ".tag": "inherit" + }, + "folder_id": "id:kJU6-a-pT48AAAAAAAAckg" +} +``` diff --git a/docs/en/md/Dropbox/Tags-managment/Add-tag.md b/docs/en/md/Dropbox/Tags-managment/Add-tag.md deleted file mode 100644 index 26074b9e41..0000000000 --- a/docs/en/md/Dropbox/Tags-managment/Add-tag.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Add tag - Add new tag to file or folder - - - -`Function AddTag(Val Token, Val Path, Val Tag) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object for which the tag needs to be created | - | Tag | --tag | String | Tag text | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Tag = "Important"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New/mydoc.docx"; - - Result = OPI_Dropbox.AddTag(Token, Path, Tag); -``` - - - - -```json title="Result" -{} -``` diff --git a/docs/en/md/Dropbox/Tags-managment/Add-tag.mdx b/docs/en/md/Dropbox/Tags-managment/Add-tag.mdx new file mode 100644 index 0000000000..b39e5b5d92 --- /dev/null +++ b/docs/en/md/Dropbox/Tags-managment/Add-tag.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Add tag + Add new tag to file or folder + + + +`Function AddTag(Val Token, Val Path, Val Tag) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object for which the tag needs to be created | + | Tag | --tag | String | Tag text | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Tag = "Important"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New/mydoc.docx"; + + Result = OPI_Dropbox.AddTag(Token, Path, Tag); +``` + + + + +```json title="Result" +{} +``` diff --git a/docs/en/md/Dropbox/Tags-managment/Delete-tag.md b/docs/en/md/Dropbox/Tags-managment/Delete-tag.md deleted file mode 100644 index 81329d870b..0000000000 --- a/docs/en/md/Dropbox/Tags-managment/Delete-tag.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete tag - Deletes the text tag of a file or directory - - - -`Function DeleteTag(Val Token, Val Path, Val Tag) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object whose tag needs to be deleted | - | Tag | --tag | String | Tag text | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Tag = "Important"; - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Path = "/New/mydoc.docx"; - - Result = OPI_Dropbox.DeleteTag(Token, Path, Tag); -``` - - - - -```json title="Result" -{} -``` diff --git a/docs/en/md/Dropbox/Tags-managment/Delete-tag.mdx b/docs/en/md/Dropbox/Tags-managment/Delete-tag.mdx new file mode 100644 index 0000000000..b2b2ddf57d --- /dev/null +++ b/docs/en/md/Dropbox/Tags-managment/Delete-tag.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete tag + Deletes the text tag of a file or directory + + + +`Function DeleteTag(Val Token, Val Path, Val Tag) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object whose tag needs to be deleted | + | Tag | --tag | String | Tag text | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Tag = "Important"; + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Path = "/New/mydoc.docx"; + + Result = OPI_Dropbox.DeleteTag(Token, Path, Tag); +``` + + + + +```json title="Result" +{} +``` diff --git a/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md b/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md deleted file mode 100644 index 27d15e9e06..0000000000 --- a/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of tags - Gets the list of tags of the selected files - - - -`Function GetTagList(Val Token, Val Paths) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Paths | --paths | String, Array of String | Path or set of paths to the files | - - - Returns: Map Of KeyAndValue - serialized JSON response from Dropbox - -
- - - - -```bsl title="Code example" - Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - PathsArray = New Array; - PathsArray.Add("/New/Dogs.mp3"); - PathsArray.Add("/New/mydoc.docx"); - - Result = OPI_Dropbox.GetTagList(Token, PathsArray); -``` - - - - -```json title="Result" -{ - "paths_to_tags": [ - { - "path": "/New/Dogs.mp3", - "tags": [] - }, - { - "path": "/New/mydoc.docx", - "tags": [ - { - ".tag": "user_generated_tag", - "tag_text": "important" - } - ] - } - ] -} -``` diff --git a/docs/en/md/Dropbox/Tags-managment/Get-tag-list.mdx b/docs/en/md/Dropbox/Tags-managment/Get-tag-list.mdx new file mode 100644 index 0000000000..605bc67170 --- /dev/null +++ b/docs/en/md/Dropbox/Tags-managment/Get-tag-list.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of tags + Gets the list of tags of the selected files + + + +`Function GetTagList(Val Token, Val Paths) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Paths | --paths | String, Array of String | Path or set of paths to the files | + + + Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + +
+ + + + +```bsl title="Code example" + Token = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + PathsArray = New Array; + PathsArray.Add("/New/Dogs.mp3"); + PathsArray.Add("/New/mydoc.docx"); + + Result = OPI_Dropbox.GetTagList(Token, PathsArray); +``` + + + + +```json title="Result" +{ + "paths_to_tags": [ + { + "path": "/New/Dogs.mp3", + "tags": [] + }, + { + "path": "/New/mydoc.docx", + "tags": [ + { + ".tag": "user_generated_tag", + "tag_text": "important" + } + ] + } + ] +} +``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md b/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md deleted file mode 100644 index 572504881b..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Add calendar to list - Adds an existing calendar to the user's list - - - -`Function AddCalendarToList(Val Token, Val Calendar) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Result = OPI_GoogleCalendar.AddCalendarToList(Token, Calendar); -``` - - - - -```json title="Result" -{ - "kind": "calendar#calendarListEntry", - "etag": "\"1728454322437000\"", - "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", - "summary": "New name", - "description": "New description", - "timeZone": "Europe/Moscow", - "colorId": "4", - "backgroundColor": "#fa573c", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.mdx b/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.mdx new file mode 100644 index 0000000000..508020f9c4 --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Add calendar to list + Adds an existing calendar to the user's list + + + +`Function AddCalendarToList(Val Token, Val Calendar) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Result = OPI_GoogleCalendar.AddCalendarToList(Token, Calendar); +``` + + + + +```json title="Result" +{ + "kind": "calendar#calendarListEntry", + "etag": "\"1728454322437000\"", + "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", + "summary": "New name", + "description": "New description", + "timeZone": "Europe/Moscow", + "colorId": "4", + "backgroundColor": "#fa573c", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md b/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md deleted file mode 100644 index a80aacb33a..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Remove calendar from list - Removes a calendar from the user's list - - - -`Function DeleteCalendarFromList(Val Token, Val Calendar) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Result = OPI_GoogleCalendar.DeleteCalendarFromList(Token, Calendar); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.mdx b/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.mdx new file mode 100644 index 0000000000..1a7c93372a --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Remove calendar from list + Removes a calendar from the user's list + + + +`Function DeleteCalendarFromList(Val Token, Val Calendar) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Result = OPI_GoogleCalendar.DeleteCalendarFromList(Token, Calendar); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md b/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md deleted file mode 100644 index 52940599da..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Edit list calendar - Edits the properties of a calendar from the user's list - - - -`Function EditListCalendar(Val Token, Val Calendar, Val PrimaryColor, Val SecondaryColor, Val Hidden = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | PrimaryColor | --primary | String | HEX primary color (#ffffff) | - | SecondaryColor | --secondary | String | HEX secondary color (#ffffff) | - | Hidden | --hidden | Boolean | Hidden calendar | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - PrimaryColor = "#000000"; - SecondaryColor = "#ffd800"; - Hidden = False; - - Result = OPI_GoogleCalendar.EditListCalendar(Token - , Calendar - , PrimaryColor - , SecondaryColor - , Hidden); -``` - - - - -```json title="Result" -{ - "kind": "calendar#calendarListEntry", - "etag": "\"1728454322717000\"", - "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", - "summary": "New name", - "description": "New description", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.mdx b/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.mdx new file mode 100644 index 0000000000..61c0495035 --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Edit list calendar + Edits the properties of a calendar from the user's list + + + +`Function EditListCalendar(Val Token, Val Calendar, Val PrimaryColor, Val SecondaryColor, Val Hidden = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | PrimaryColor | --primary | String | HEX primary color (#ffffff) | + | SecondaryColor | --secondary | String | HEX secondary color (#ffffff) | + | Hidden | --hidden | Boolean | Hidden calendar | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + PrimaryColor = "#000000"; + SecondaryColor = "#ffd800"; + Hidden = False; + + Result = OPI_GoogleCalendar.EditListCalendar(Token + , Calendar + , PrimaryColor + , SecondaryColor + , Hidden); +``` + + + + +```json title="Result" +{ + "kind": "calendar#calendarListEntry", + "etag": "\"1728454322717000\"", + "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", + "summary": "New name", + "description": "New description", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md b/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md deleted file mode 100644 index 9e9ee9a199..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of calendars - Gets an array of account calendars - - - -`Function GetCalendarList(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - Array of calendar data mappings - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Result = OPI_GoogleCalendar.GetCalendarList(Token); -``` - - - - -```json title="Result" -[ - { - "kind": "calendar#calendarListEntry", - "etag": "\"1713008096300000\"", - "id": "bayselonarrend@gmail.com", - "summary": "Тестовый календарь (изм.)", - "description": "ТестовоеОписание", - "timeZone": "Europe/Minsk", - "colorId": "19", - "backgroundColor": "#fffff0", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "notificationSettings": { - "notifications": [ - { - "type": "eventCreation", - "method": "email" - }, - { - "type": "eventChange", - "method": "email" - }, - { - "type": "eventCancellation", - "method": "email" - }, - { - "type": "eventResponse", - "method": "email" - } - ] - }, - "primary": true, - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626834830000\"", - "id": "ab71c432a2cd06ecad2f5c517b3540f04d56df7aadb6df1d7b001ea4d6ac4398@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835116000\"", - "id": "c1aa2a1fe0ac12393b65eab12294daf3a09c12d5b7e54571774ddc001c4de938@group.calendar.google.com", - "summary": "\\u0422\\u0435\\u0441\\u0442\\u043e\\u0432\\u044b\\u0439 \\u043a\\u0430\\u043b\\u0435\\u043d\\u0434\\u0430\\u0440\\u044c", - "timeZone": "Europe/Moscow", - "colorId": "5", - "backgroundColor": "#ff7537", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835376000\"", - "id": "ru.by#holiday@group.v.calendar.google.com", - "summary": "Праздники Беларуси", - "description": "Праздники и памятные даты Беларуси", - "timeZone": "Europe/Minsk", - "colorId": "8", - "backgroundColor": "#16a765", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "reader", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835701000\"", - "id": "b0b7ceee4056c516b0718eed0a1e4ad8694259935a6d2ffc056325df06232841@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835924000\"", - "id": "25f80e38669312d27a9c7441f065887c6beaacf63af84ea67ebd9251a6b5f32b@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626836240000\"", - "id": "36c14edd62c430b5646cbcaecfc67ee7fe7252d1d315ba3b099efca66084f7ff@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "11", - "backgroundColor": "#fbe983", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, -... -``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.mdx b/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.mdx new file mode 100644 index 0000000000..94fb85dacc --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.mdx @@ -0,0 +1,187 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of calendars + Gets an array of account calendars + + + +`Function GetCalendarList(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - Array of calendar data mappings + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Result = OPI_GoogleCalendar.GetCalendarList(Token); +``` + + + + +```json title="Result" +[ + { + "kind": "calendar#calendarListEntry", + "etag": "\"1713008096300000\"", + "id": "bayselonarrend@gmail.com", + "summary": "Тестовый календарь (изм.)", + "description": "ТестовоеОписание", + "timeZone": "Europe/Minsk", + "colorId": "19", + "backgroundColor": "#fffff0", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "notificationSettings": { + "notifications": [ + { + "type": "eventCreation", + "method": "email" + }, + { + "type": "eventChange", + "method": "email" + }, + { + "type": "eventCancellation", + "method": "email" + }, + { + "type": "eventResponse", + "method": "email" + } + ] + }, + "primary": true, + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626834830000\"", + "id": "ab71c432a2cd06ecad2f5c517b3540f04d56df7aadb6df1d7b001ea4d6ac4398@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835116000\"", + "id": "c1aa2a1fe0ac12393b65eab12294daf3a09c12d5b7e54571774ddc001c4de938@group.calendar.google.com", + "summary": "\\u0422\\u0435\\u0441\\u0442\\u043e\\u0432\\u044b\\u0439 \\u043a\\u0430\\u043b\\u0435\\u043d\\u0434\\u0430\\u0440\\u044c", + "timeZone": "Europe/Moscow", + "colorId": "5", + "backgroundColor": "#ff7537", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835376000\"", + "id": "ru.by#holiday@group.v.calendar.google.com", + "summary": "Праздники Беларуси", + "description": "Праздники и памятные даты Беларуси", + "timeZone": "Europe/Minsk", + "colorId": "8", + "backgroundColor": "#16a765", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "reader", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835701000\"", + "id": "b0b7ceee4056c516b0718eed0a1e4ad8694259935a6d2ffc056325df06232841@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835924000\"", + "id": "25f80e38669312d27a9c7441f065887c6beaacf63af84ea67ebd9251a6b5f32b@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626836240000\"", + "id": "36c14edd62c430b5646cbcaecfc67ee7fe7252d1d315ba3b099efca66084f7ff@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "11", + "backgroundColor": "#fbe983", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, +... +``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md b/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md deleted file mode 100644 index 0bd171e67e..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get list calendar - Gets a calendar from the user's list by ID - - - -`Function GetListCalendar(Val Token, Val Calendar) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Result = OPI_GoogleCalendar.GetListCalendar(Token, Calendar); -``` - - - - -```json title="Result" -{ - "kind": "calendar#calendarListEntry", - "etag": "\"1728454322717000\"", - "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", - "summary": "New name", - "description": "New description", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.mdx b/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.mdx new file mode 100644 index 0000000000..cc2f973784 --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get list calendar + Gets a calendar from the user's list by ID + + + +`Function GetListCalendar(Val Token, Val Calendar) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Result = OPI_GoogleCalendar.GetListCalendar(Token, Calendar); +``` + + + + +```json title="Result" +{ + "kind": "calendar#calendarListEntry", + "etag": "\"1728454322717000\"", + "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", + "summary": "New name", + "description": "New description", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md deleted file mode 100644 index 29bec243e3..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Clear primary calendar - Clears the event list of the primary calendar - - - -`Function ClearMainCalendar(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - - Result = OPI_GoogleCalendar.ClearMainCalendar(Token); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.mdx b/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.mdx new file mode 100644 index 0000000000..2e96445ed2 --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.mdx @@ -0,0 +1,38 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Clear primary calendar + Clears the event list of the primary calendar + + + +`Function ClearMainCalendar(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + + Result = OPI_GoogleCalendar.ClearMainCalendar(Token); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md deleted file mode 100644 index b561d686bf..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create calendar - Creates an empty calendar - - - -`Function CreateCalendar(Val Token, Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Name | --title | String | Name of the created calendar | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Name = "TestCalendar"; - - Result = OPI_GoogleCalendar.CreateCalendar(Token, Name); -``` - - - - -```json title="Result" -{ - "kind": "calendar#calendar", - "etag": "\"f-Xduc312TYuzWZZ-yIpBJJfeyo\"", - "id": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", - "summary": "TestCalendar", - "timeZone": "Europe/Moscow", - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.mdx b/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.mdx new file mode 100644 index 0000000000..80a6f8a963 --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create calendar + Creates an empty calendar + + + +`Function CreateCalendar(Val Token, Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Name | --title | String | Name of the created calendar | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Name = "TestCalendar"; + + Result = OPI_GoogleCalendar.CreateCalendar(Token, Name); +``` + + + + +```json title="Result" +{ + "kind": "calendar#calendar", + "etag": "\"f-Xduc312TYuzWZZ-yIpBJJfeyo\"", + "id": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", + "summary": "TestCalendar", + "timeZone": "Europe/Moscow", + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md deleted file mode 100644 index 21e7f508e0..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete calendar - Deletes a calendar by ID - - - -`Function DeleteCalendar(Val Token, Val Calendar) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Result = OPI_GoogleCalendar.DeleteCalendar(Token, Calendar); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.mdx b/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.mdx new file mode 100644 index 0000000000..3b0ca544e9 --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete calendar + Deletes a calendar by ID + + + +`Function DeleteCalendar(Val Token, Val Calendar) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Result = OPI_GoogleCalendar.DeleteCalendar(Token, Calendar); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md deleted file mode 100644 index 756d97a5ad..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Edit calendar - Edits properties of an existing calendar - - - -`Function EditCalendarMetadata(Val Token, Val Calendar, Val Name = "", Val Description = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | Name | --title | String | New name | - | Description | --description | String | New calendar description | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Name = "New name"; - Description = "New description"; - - Result = OPI_GoogleCalendar.EditCalendarMetadata(Token, Calendar, Name, Description); -``` - - - - -```json title="Result" -{ - "kind": "calendar#calendar", - "etag": "\"TKmlUu-rCWvGCZLbQ4hTqd8_K3U\"", - "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", - "summary": "New name", - "description": "New description", - "timeZone": "Europe/Moscow", - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.mdx b/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.mdx new file mode 100644 index 0000000000..02f94150fe --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Edit calendar + Edits properties of an existing calendar + + + +`Function EditCalendarMetadata(Val Token, Val Calendar, Val Name = "", Val Description = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | Name | --title | String | New name | + | Description | --description | String | New calendar description | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Name = "New name"; + Description = "New description"; + + Result = OPI_GoogleCalendar.EditCalendarMetadata(Token, Calendar, Name, Description); +``` + + + + +```json title="Result" +{ + "kind": "calendar#calendar", + "etag": "\"TKmlUu-rCWvGCZLbQ4hTqd8_K3U\"", + "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", + "summary": "New name", + "description": "New description", + "timeZone": "Europe/Moscow", + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md deleted file mode 100644 index 651e188c64..0000000000 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get calendar - Gets calendar information by ID - - - -`Function GetCalendarMetadata(Val Token, Val Calendar) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Result = OPI_GoogleCalendar.GetCalendarMetadata(Token, Calendar); -``` - - - - -```json title="Result" -{ - "kind": "calendar#calendar", - "etag": "\"TKmlUu-rCWvGCZLbQ4hTqd8_K3U\"", - "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", - "summary": "New name", - "description": "New description", - "timeZone": "Europe/Moscow", - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.mdx b/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.mdx new file mode 100644 index 0000000000..a77a51a64f --- /dev/null +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get calendar + Gets calendar information by ID + + + +`Function GetCalendarMetadata(Val Token, Val Calendar) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Result = OPI_GoogleCalendar.GetCalendarMetadata(Token, Calendar); +``` + + + + +```json title="Result" +{ + "kind": "calendar#calendar", + "etag": "\"TKmlUu-rCWvGCZLbQ4hTqd8_K3U\"", + "id": "48ff105e488eea0a588031479250116f2e769f150c2ca1274b7e79c4b057b46b@group.calendar.google.com", + "summary": "New name", + "description": "New description", + "timeZone": "Europe/Moscow", + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Create-event.md b/docs/en/md/Google_Calendar/Event-management/Create-event.md deleted file mode 100644 index c257c59f07..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Create-event.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Create event - Creates a new event - - - -`Function CreateEvent(Val Token, Val Calendar, Val EventDescription) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | EventDescription | --props | Map Of KeyAndValue | Event description | - - - Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response - -
- - - - -```bsl title="Code example" - CurrentDate = OPI_Tools.GetCurrentDate(); - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Name = "New event"; - Description = "TestEventDescription"; - Hour = 3600; - - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary or Path to file - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary or Path to file - Attachments = New Map; - - Attachments.Insert("Image1", Image1); - Attachments.Insert("Image2", Image2); - - EventDescription = New Map; - EventDescription.Insert("Description" , Description); - EventDescription.Insert("Title" , Name); - EventDescription.Insert("Venue" , "InOffice"); - EventDescription.Insert("StartDate" , CurrentDate); - EventDescription.Insert("EndDate" , EventDescription["StartDate"] + Hour); - EventDescription.Insert("ArrayOfAttachmentURLs" , Attachments); - EventDescription.Insert("SendNotifications" , True); - - Result = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventDescription); -``` - - - - -```json title="Result" -{ - "kind": "calendar#event", - "etag": "\"3456908679760000\"", - "id": "7rfbn0fb8nai4i7v4l435tgl1c", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", - "created": "2024-10-09T06:12:19Z", - "updated": "2024-10-09T06:12:19.88Z", - "summary": "New event", - "description": "TestEventDescription", - "location": "InOffice", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", - "displayName": "TestCalendar", - "self": true - }, - "start": { - "dateTime": "2024-10-09T12:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T13:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Image1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Image2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Create-event.mdx b/docs/en/md/Google_Calendar/Event-management/Create-event.mdx new file mode 100644 index 0000000000..f58a536d94 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Create-event.mdx @@ -0,0 +1,106 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Create event + Creates a new event + + + +`Function CreateEvent(Val Token, Val Calendar, Val EventDescription) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | EventDescription | --props | Map Of KeyAndValue | Event description | + + + Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response + +
+ + + + +```bsl title="Code example" + CurrentDate = OPI_Tools.GetCurrentDate(); + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Name = "New event"; + Description = "TestEventDescription"; + Hour = 3600; + + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary or Path to file + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary or Path to file + Attachments = New Map; + + Attachments.Insert("Image1", Image1); + Attachments.Insert("Image2", Image2); + + EventDescription = New Map; + EventDescription.Insert("Description" , Description); + EventDescription.Insert("Title" , Name); + EventDescription.Insert("Venue" , "InOffice"); + EventDescription.Insert("StartDate" , CurrentDate); + EventDescription.Insert("EndDate" , EventDescription["StartDate"] + Hour); + EventDescription.Insert("ArrayOfAttachmentURLs" , Attachments); + EventDescription.Insert("SendNotifications" , True); + + Result = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventDescription); +``` + + + + +```json title="Result" +{ + "kind": "calendar#event", + "etag": "\"3456908679760000\"", + "id": "7rfbn0fb8nai4i7v4l435tgl1c", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", + "created": "2024-10-09T06:12:19Z", + "updated": "2024-10-09T06:12:19.88Z", + "summary": "New event", + "description": "TestEventDescription", + "location": "InOffice", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", + "displayName": "TestCalendar", + "self": true + }, + "start": { + "dateTime": "2024-10-09T12:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T13:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Image1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Image2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Delete-event.md b/docs/en/md/Google_Calendar/Event-management/Delete-event.md deleted file mode 100644 index 8da3ac623d..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Delete-event.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Delete event - Deletes an event by ID - - - -`Function DeleteEvent(Val Token, Val Calendar, Val Event) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | Event | --event | String | Event ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Event = "33cn8ioc097i92k9i37mvpbj50"; - - Result = OPI_GoogleCalendar.DeleteEvent(Token, Calendar, Event); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Delete-event.mdx b/docs/en/md/Google_Calendar/Event-management/Delete-event.mdx new file mode 100644 index 0000000000..0461d862b3 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Delete-event.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Delete event + Deletes an event by ID + + + +`Function DeleteEvent(Val Token, Val Calendar, Val Event) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | Event | --event | String | Event ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Event = "33cn8ioc097i92k9i37mvpbj50"; + + Result = OPI_GoogleCalendar.DeleteEvent(Token, Calendar, Event); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Edit-event.md b/docs/en/md/Google_Calendar/Event-management/Edit-event.md deleted file mode 100644 index d002ccbba4..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Edit-event.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Edit event - Edits an existing event - - - -`Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | EventDescription | --props | String | New event description | - | Event | --event | String | Event ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Event = "33cn8ioc097i92k9i37mvpbj50"; - Description = "New event description"; - - EventDescription = New Map; - EventDescription.Insert("Description", Description); - - Result = OPI_GoogleCalendar.EditEvent(Token, Calendar, EventDescription, Event); -``` - - - - -```json title="Result" -{ - "kind": "calendar#event", - "etag": "\"3456908680754000\"", - "id": "7rfbn0fb8nai4i7v4l435tgl1c", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", - "created": "2024-10-09T06:12:19Z", - "updated": "2024-10-09T06:12:20.377Z", - "summary": "New event", - "description": "New event description", - "location": "InOffice", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", - "displayName": "TestCalendar", - "self": true - }, - "start": { - "dateTime": "2024-10-09T12:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T13:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Image1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Image2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Edit-event.mdx b/docs/en/md/Google_Calendar/Event-management/Edit-event.mdx new file mode 100644 index 0000000000..14293c82d7 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Edit-event.mdx @@ -0,0 +1,92 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Edit event + Edits an existing event + + + +`Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | EventDescription | --props | String | New event description | + | Event | --event | String | Event ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Event = "33cn8ioc097i92k9i37mvpbj50"; + Description = "New event description"; + + EventDescription = New Map; + EventDescription.Insert("Description", Description); + + Result = OPI_GoogleCalendar.EditEvent(Token, Calendar, EventDescription, Event); +``` + + + + +```json title="Result" +{ + "kind": "calendar#event", + "etag": "\"3456908680754000\"", + "id": "7rfbn0fb8nai4i7v4l435tgl1c", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", + "created": "2024-10-09T06:12:19Z", + "updated": "2024-10-09T06:12:20.377Z", + "summary": "New event", + "description": "New event description", + "location": "InOffice", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", + "displayName": "TestCalendar", + "self": true + }, + "start": { + "dateTime": "2024-10-09T12:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T13:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Image1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Image2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event-description.md b/docs/en/md/Google_Calendar/Event-management/Get-event-description.md deleted file mode 100644 index 398793c234..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Get-event-description.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get event description - Gets an empty layout to create the event - - - -`Function GetEventDescription(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Map Of KeyAndValue - Empty event template - -
- - - - -```bsl title="Code example" - Result = OPI_GoogleCalendar.GetEventDescription(); -``` - - - - -```json title="Result" -{ - "Description": "", - "Title": "New event", - "Venue": "", - "StartDate": "2024-10-09T09:12:24.0203603Z", - "EndDate": "2024-10-09T10:12:24.0203603Z", - "ArrayOfAttachmentURLs": {}, - "SendNotifications": true -} -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event-description.mdx b/docs/en/md/Google_Calendar/Event-management/Get-event-description.mdx new file mode 100644 index 0000000000..97960885f6 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Get-event-description.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get event description + Gets an empty layout to create the event + + + +`Function GetEventDescription(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Map Of KeyAndValue - Empty event template + +
+ + + + +```bsl title="Code example" + Result = OPI_GoogleCalendar.GetEventDescription(); +``` + + + + +```json title="Result" +{ + "Description": "", + "Title": "New event", + "Venue": "", + "StartDate": "2024-10-09T09:12:24.0203603Z", + "EndDate": "2024-10-09T10:12:24.0203603Z", + "ArrayOfAttachmentURLs": {}, + "SendNotifications": true +} +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event-list.md b/docs/en/md/Google_Calendar/Event-management/Get-event-list.md deleted file mode 100644 index b6dcb95c9b..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Get-event-list.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get list of events - Gets the list of all calendar events - - - -`Function GetEventList(Val Token, Val Calendar) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Map Of KeyAndValue - Array of event maps - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Result = OPI_GoogleCalendar.GetEventList(Token, Calendar); -``` - - - - -```json title="Result" -[ - { - "kind": "calendar#event", - "etag": "\"3456908687360000\"", - "id": "7rfbn0fb8nai4i7v4l435tgl1c", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", - "created": "2024-10-09T06:12:19Z", - "updated": "2024-10-09T06:12:23.68Z", - "summary": "New event", - "description": "New event description", - "location": "InOffice", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", - "displayName": "TestCalendar", - "self": true - }, - "start": { - "dateTime": "2024-10-09T12:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T13:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Image1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Image2", - "iconLink": "" - } - ], - "eventType": "default" - } -] -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event-list.mdx b/docs/en/md/Google_Calendar/Event-management/Get-event-list.mdx new file mode 100644 index 0000000000..d3eb930241 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Get-event-list.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get list of events + Gets the list of all calendar events + + + +`Function GetEventList(Val Token, Val Calendar) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Map Of KeyAndValue - Array of event maps + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Result = OPI_GoogleCalendar.GetEventList(Token, Calendar); +``` + + + + +```json title="Result" +[ + { + "kind": "calendar#event", + "etag": "\"3456908687360000\"", + "id": "7rfbn0fb8nai4i7v4l435tgl1c", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", + "created": "2024-10-09T06:12:19Z", + "updated": "2024-10-09T06:12:23.68Z", + "summary": "New event", + "description": "New event description", + "location": "InOffice", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", + "displayName": "TestCalendar", + "self": true + }, + "start": { + "dateTime": "2024-10-09T12:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T13:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Image1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Image2", + "iconLink": "" + } + ], + "eventType": "default" + } +] +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event.md b/docs/en/md/Google_Calendar/Event-management/Get-event.md deleted file mode 100644 index 5de3da45c3..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Get-event.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get event - Gets an event by ID - - - -`Function GetEvent(Val Token, Val Calendar, Val Event) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | Event | --event | String | Event ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Event = "33cn8ioc097i92k9i37mvpbj50"; - - Result = OPI_GoogleCalendar.GetEvent(Token, Calendar, Event); -``` - - - - -```json title="Result" -{ - "kind": "calendar#event", - "etag": "\"3456908680754000\"", - "id": "7rfbn0fb8nai4i7v4l435tgl1c", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", - "created": "2024-10-09T06:12:19Z", - "updated": "2024-10-09T06:12:20.377Z", - "summary": "New event", - "description": "New event description", - "location": "InOffice", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", - "displayName": "TestCalendar", - "self": true - }, - "start": { - "dateTime": "2024-10-09T12:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T13:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Image1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Image2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event.mdx b/docs/en/md/Google_Calendar/Event-management/Get-event.mdx new file mode 100644 index 0000000000..604cc9bcc0 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Get-event.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get event + Gets an event by ID + + + +`Function GetEvent(Val Token, Val Calendar, Val Event) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | Event | --event | String | Event ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Calendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Event = "33cn8ioc097i92k9i37mvpbj50"; + + Result = OPI_GoogleCalendar.GetEvent(Token, Calendar, Event); +``` + + + + +```json title="Result" +{ + "kind": "calendar#event", + "etag": "\"3456908680754000\"", + "id": "7rfbn0fb8nai4i7v4l435tgl1c", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", + "created": "2024-10-09T06:12:19Z", + "updated": "2024-10-09T06:12:20.377Z", + "summary": "New event", + "description": "New event description", + "location": "InOffice", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "60613d53c4670abdceec3e7693ca475b0e88dc1678db7210521356b4940a6148@group.calendar.google.com", + "displayName": "TestCalendar", + "self": true + }, + "start": { + "dateTime": "2024-10-09T12:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T13:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Image1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Image2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Move-event.md b/docs/en/md/Google_Calendar/Event-management/Move-event.md deleted file mode 100644 index f6c9bbdf3c..0000000000 --- a/docs/en/md/Google_Calendar/Event-management/Move-event.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Move event - Moves an event to another calendar - - - -`Function MoveEvent(Val Token, Val SourceCalendar, Val TargetCalendar, Val Event) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | SourceCalendar | --from | String | ID of the source calendar | - | TargetCalendar | --to | String | ID of the target calendar | - | Event | --event | String | ID of the source calendar event | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Event = "33cn8ioc097i92k9i37mvpbj50"; - - SourceCalendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - TargetCalendar = "bayselonarrend@gmail.com"; - - Result = OPI_GoogleCalendar.MoveEvent(Token, SourceCalendar, TargetCalendar, Event); -``` - - - - -```json title="Result" -{ - "kind": "calendar#event", - "etag": "\"3456908680754000\"", - "id": "7rfbn0fb8nai4i7v4l435tgl1c", - "status": "cancelled", - "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", - "created": "2024-10-09T06:12:19Z", - "updated": "2024-10-09T06:12:20.377Z", - "summary": "New event", - "description": "New event description", - "location": "InOffice", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "bayselonarrend@gmail.com" - }, - "start": { - "dateTime": "2024-10-09T12:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T13:12:19+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Image1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Image2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/en/md/Google_Calendar/Event-management/Move-event.mdx b/docs/en/md/Google_Calendar/Event-management/Move-event.mdx new file mode 100644 index 0000000000..233a9dba99 --- /dev/null +++ b/docs/en/md/Google_Calendar/Event-management/Move-event.mdx @@ -0,0 +1,88 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Move event + Moves an event to another calendar + + + +`Function MoveEvent(Val Token, Val SourceCalendar, Val TargetCalendar, Val Event) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | SourceCalendar | --from | String | ID of the source calendar | + | TargetCalendar | --to | String | ID of the target calendar | + | Event | --event | String | ID of the source calendar event | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Event = "33cn8ioc097i92k9i37mvpbj50"; + + SourceCalendar = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + TargetCalendar = "bayselonarrend@gmail.com"; + + Result = OPI_GoogleCalendar.MoveEvent(Token, SourceCalendar, TargetCalendar, Event); +``` + + + + +```json title="Result" +{ + "kind": "calendar#event", + "etag": "\"3456908680754000\"", + "id": "7rfbn0fb8nai4i7v4l435tgl1c", + "status": "cancelled", + "htmlLink": "https://www.google.com/calendar/event?eid=N3JmYm4wZmI4bmFpNGk3djRsNDM1dGdsMWMgNjA2MTNkNTNjNDY3MGFiZGNlZWMzZTc2OTNjYTQ3NWIwZTg4ZGMxNjc4ZGI3MjEwNTIxMzU2YjQ5NDBhNjE0OEBn", + "created": "2024-10-09T06:12:19Z", + "updated": "2024-10-09T06:12:20.377Z", + "summary": "New event", + "description": "New event description", + "location": "InOffice", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "bayselonarrend@gmail.com" + }, + "start": { + "dateTime": "2024-10-09T12:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T13:12:19+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "7rfbn0fb8nai4i7v4l435tgl1c@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Image1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Image2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/en/md/Google_Drive/Comment-management/Create-comment.md b/docs/en/md/Google_Drive/Comment-management/Create-comment.md deleted file mode 100644 index 812b7bff34..0000000000 --- a/docs/en/md/Google_Drive/Comment-management/Create-comment.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create comment - Creates a comment for a file or directory - - - -`Function CreateComment(Val Token, Val Identifier, Val Comment) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the object that needs a comment | - | Comment | --text | String | Comment text | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - Comment = "Comment text"; - - Result = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); -``` - - - - -```json title="Result" -{ - "id": "AAABW5rdEaE", - "kind": "drive#comment", - "createdTime": "2024-10-09T06:13:52.313Z", - "modifiedTime": "2024-10-09T06:13:52.313Z", - "replies": [], - "author": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" - }, - "deleted": false, - "htmlContent": "Comment text", - "content": "Comment text" -} -``` diff --git a/docs/en/md/Google_Drive/Comment-management/Create-comment.mdx b/docs/en/md/Google_Drive/Comment-management/Create-comment.mdx new file mode 100644 index 0000000000..df705a131b --- /dev/null +++ b/docs/en/md/Google_Drive/Comment-management/Create-comment.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create comment + Creates a comment for a file or directory + + + +`Function CreateComment(Val Token, Val Identifier, Val Comment) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the object that needs a comment | + | Comment | --text | String | Comment text | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + Comment = "Comment text"; + + Result = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); +``` + + + + +```json title="Result" +{ + "id": "AAABW5rdEaE", + "kind": "drive#comment", + "createdTime": "2024-10-09T06:13:52.313Z", + "modifiedTime": "2024-10-09T06:13:52.313Z", + "replies": [], + "author": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" + }, + "deleted": false, + "htmlContent": "Comment text", + "content": "Comment text" +} +``` diff --git a/docs/en/md/Google_Drive/Comment-management/Delete-comment.md b/docs/en/md/Google_Drive/Comment-management/Delete-comment.md deleted file mode 100644 index b212f79eeb..0000000000 --- a/docs/en/md/Google_Drive/Comment-management/Delete-comment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete comment - Deletes comment by ID - - - -`Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ObjectID | --object | String | Identifier of the file or directory where the comment is located | - | CommentID | --comment | String | Comment identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - CommentID = "AAABXOyqKNE"; - - Result = OPI_GoogleDrive.DeleteComment(Token, Identifier, CommentID); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Google_Drive/Comment-management/Delete-comment.mdx b/docs/en/md/Google_Drive/Comment-management/Delete-comment.mdx new file mode 100644 index 0000000000..229f0f861f --- /dev/null +++ b/docs/en/md/Google_Drive/Comment-management/Delete-comment.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete comment + Deletes comment by ID + + + +`Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ObjectID | --object | String | Identifier of the file or directory where the comment is located | + | CommentID | --comment | String | Comment identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + CommentID = "AAABXOyqKNE"; + + Result = OPI_GoogleDrive.DeleteComment(Token, Identifier, CommentID); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md b/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md deleted file mode 100644 index 5b60979b0b..0000000000 --- a/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get list of comments - Gets the list of all comments of the object - - - -`Function GetCommentList(Val Token, Val ObjectID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ObjectID | --object | String | Object identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - - Result = OPI_GoogleDrive.GetCommentList(Token, Identifier); -``` - - - - -```json title="Result" -{ - "kind": "drive#commentList", - "comments": [ - { - "id": "AAABW5rdEaE", - "kind": "drive#comment", - "createdTime": "2024-10-09T06:13:52.313Z", - "modifiedTime": "2024-10-09T06:13:52.313Z", - "replies": [], - "author": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" - }, - "deleted": false, - "htmlContent": "Comment text", - "content": "Comment text" - } - ] -} -``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment-list.mdx b/docs/en/md/Google_Drive/Comment-management/Get-comment-list.mdx new file mode 100644 index 0000000000..f6fa16c5dc --- /dev/null +++ b/docs/en/md/Google_Drive/Comment-management/Get-comment-list.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get list of comments + Gets the list of all comments of the object + + + +`Function GetCommentList(Val Token, Val ObjectID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ObjectID | --object | String | Object identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + + Result = OPI_GoogleDrive.GetCommentList(Token, Identifier); +``` + + + + +```json title="Result" +{ + "kind": "drive#commentList", + "comments": [ + { + "id": "AAABW5rdEaE", + "kind": "drive#comment", + "createdTime": "2024-10-09T06:13:52.313Z", + "modifiedTime": "2024-10-09T06:13:52.313Z", + "replies": [], + "author": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" + }, + "deleted": false, + "htmlContent": "Comment text", + "content": "Comment text" + } + ] +} +``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment.md b/docs/en/md/Google_Drive/Comment-management/Get-comment.md deleted file mode 100644 index 839522a68f..0000000000 --- a/docs/en/md/Google_Drive/Comment-management/Get-comment.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get comment - Gets comment by ID - - - -`Function GetComment(Val Token, Val ObjectID, Val CommentID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ObjectID | --object | String | Identifier of the file or directory where the comment is located | - | CommentID | --comment | String | Comment identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - CommentID = "AAABXOyqKNE"; - - Result = OPI_GoogleDrive.GetComment(Token, Identifier, CommentID); -``` - - - - -```json title="Result" -{ - "id": "AAABW5rdEaE", - "kind": "drive#comment", - "createdTime": "2024-10-09T06:13:52.313Z", - "modifiedTime": "2024-10-09T06:13:52.313Z", - "replies": [], - "author": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" - }, - "deleted": false, - "htmlContent": "Comment text", - "content": "Comment text" -} -``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment.mdx b/docs/en/md/Google_Drive/Comment-management/Get-comment.mdx new file mode 100644 index 0000000000..8d82cfa882 --- /dev/null +++ b/docs/en/md/Google_Drive/Comment-management/Get-comment.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get comment + Gets comment by ID + + + +`Function GetComment(Val Token, Val ObjectID, Val CommentID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ObjectID | --object | String | Identifier of the file or directory where the comment is located | + | CommentID | --comment | String | Comment identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + CommentID = "AAABXOyqKNE"; + + Result = OPI_GoogleDrive.GetComment(Token, Identifier, CommentID); +``` + + + + +```json title="Result" +{ + "id": "AAABW5rdEaE", + "kind": "drive#comment", + "createdTime": "2024-10-09T06:13:52.313Z", + "modifiedTime": "2024-10-09T06:13:52.313Z", + "replies": [], + "author": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" + }, + "deleted": false, + "htmlContent": "Comment text", + "content": "Comment text" +} +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md b/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md deleted file mode 100644 index cb613c656f..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Copy object - Copies file or directory - - - -`Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Object identifier | - | NewName | --title | String | New object name | - | NewParent | --catalog | String | New parent directory | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - NewName = "CopiedFile.jpeg"; - NewParent = "root"; - - Result = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewParent); -``` - - - - -```json title="Result" -{ - "kind": "drive#file", - "id": "19rwnmeC5Vro9P_yBfeKsPLeuSOU9Y9oC", - "name": "CopiedFile.jpeg", - "mimeType": "image/jpeg" -} -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.mdx new file mode 100644 index 0000000000..fcc62dd70e --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Copy object + Copies file or directory + + + +`Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Object identifier | + | NewName | --title | String | New object name | + | NewParent | --catalog | String | New parent directory | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + NewName = "CopiedFile.jpeg"; + NewParent = "root"; + + Result = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewParent); +``` + + + + +```json title="Result" +{ + "kind": "drive#file", + "id": "19rwnmeC5Vro9P_yBfeKsPLeuSOU9Y9oC", + "name": "CopiedFile.jpeg", + "mimeType": "image/jpeg" +} +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md b/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md deleted file mode 100644 index 52368ec5b6..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Create folder - Creates an empty directory on the drive - - - -`Function CreateFolder(Val Token, Val Name, Val Parent = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Name | --title | String | Folder name | - | Parent | --catalog | String | Parent | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Directory = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; - Name = "TestFolder"; - - Result = OPI_GoogleDrive.CreateFolder(Token, Name, Directory); -``` - - - - -```json title="Result" -{ - "kind": "drive#file", - "id": "1grSYVEN_m8PfHLj5ZrpDyMqDEtbF00E9", - "name": "TestFolder", - "mimeType": "application/vnd.google-apps.folder" -} -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.mdx new file mode 100644 index 0000000000..1dfff2aed0 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Create folder + Creates an empty directory on the drive + + + +`Function CreateFolder(Val Token, Val Name, Val Parent = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Name | --title | String | Folder name | + | Parent | --catalog | String | Parent | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Directory = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; + Name = "TestFolder"; + + Result = OPI_GoogleDrive.CreateFolder(Token, Name, Directory); +``` + + + + +```json title="Result" +{ + "kind": "drive#file", + "id": "1grSYVEN_m8PfHLj5ZrpDyMqDEtbF00E9", + "name": "TestFolder", + "mimeType": "application/vnd.google-apps.folder" +} +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md b/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md deleted file mode 100644 index bf6020ad76..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Delete object - Deletes file or directory by ID - - - -`Function DeleteObject(Val Token, Val Identifier) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the object to delete | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - - Result = OPI_GoogleDrive.DeleteObject(Token, Identifier); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.mdx new file mode 100644 index 0000000000..360b47cb64 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Delete object + Deletes file or directory by ID + + + +`Function DeleteObject(Val Token, Val Identifier) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the object to delete | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + + Result = OPI_GoogleDrive.DeleteObject(Token, Identifier); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md b/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md deleted file mode 100644 index a2fb5b3f42..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Download file - Gets file by ID - - - -`Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | File identifier | - | SavePath | --out | String | File save path | - - - Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - - Result = OPI_GoogleDrive.DownloadFile(Token, Identifier); -``` - - - - -```json title="Result" -NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Download-file.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Download-file.mdx new file mode 100644 index 0000000000..f3298eb103 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Download-file.mdx @@ -0,0 +1,41 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Download file + Gets file by ID + + + +`Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | File identifier | + | SavePath | --out | String | File save path | + + + Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + + Result = OPI_GoogleDrive.DownloadFile(Token, Identifier); +``` + + + + +```json title="Result" +NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md deleted file mode 100644 index 8799e1a4e8..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get list of directories - Gets the list of drive directories - - - -`Function GetDirectoriesList(Val Token, Val NameContains = "", Val Detailed = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | NameContains | --querry | String | Filter by name | - | Detailed | --depth | Boolean | Adds a list of files to the directory fields | - - - Returns: Map Of KeyAndValue - Array of directory mappings - -
- - - - -```bsl title="Code example" - Name = "TestFolder"; - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - - Result = OPI_GoogleDrive.GetDirectoriesList(Token, Name, True); -``` - - - - -```json title="Result" -[ - { - "kind": "drive#file", - "copyRequiresWriterPermission": false, - "writersCanShare": true, - "viewedByMe": false, - "mimeType": "application/vnd.google-apps.folder", - "parents": [ - "0AN2vrbrhqfJrUk9PVA" - ], - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "shared": false, - "lastModifyingUser": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - }, - "owners": [ - { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - } - ], - "webViewLink": "https://drive.google.com/drive/folders/1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", - "viewersCanCopyContent": true, - "permissions": [ - { - "id": "07468399490707249352", - "displayName": "Антон Титовец", - "type": "user", - "kind": "drive#permission", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", - "deleted": false, - "pendingOwner": false - } - ], - "hasThumbnail": false, - "spaces": [ - "drive" - ], - "folderColorRgb": "#8f8f8f", - "id": "1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", - "name": "TestFolder", - "description": "", - "starred": false, - "trashed": false, - "explicitlyTrashed": false, - "createdTime": "2024-06-03T07:24:06.147Z", - "modifiedTime": "2024-06-03T07:24:06.147Z", - "modifiedByMeTime": "2024-06-03T07:24:06.147Z", - "quotaBytesUsed": "0", - "version": "1", - "ownedByMe": true, - "isAppAuthorized": true, - "capabilities": { - "canChangeViewersCanCopyContent": false, - "canEdit": true, - "canCopy": false, - "canComment": true, - "canAddChildren": true, - "canDelete": true, - "canDownload": true, - "canListChildren": true, - "canRemoveChildren": true, - "canRename": true, - "canTrash": true, - "canReadRevisions": false, - "canChangeCopyRequiresWriterPermission": false, - "canMoveItemIntoTeamDrive": true, - "canUntrash": true, - "canModifyContent": true, - "canMoveItemOutOfDrive": true, - "canAddMyDriveParent": false, - "canRemoveMyDriveParent": true, - "canMoveItemWithinDrive": true, - "canShare": true, - "canMoveChildrenWithinDrive": true, - "canModifyContentRestriction": false, - "canChangeSecurityUpdateEnabled": false, - "canAcceptOwnership": false, - "canReadLabels": false, - "canModifyLabels": false, - "canModifyEditorContentRestriction": false, - "canModifyOwnerContentRestriction": false, - "canRemoveContentRestriction": false - }, - "thumbnailVersion": "0", - "modifiedByMe": true, - "permissionIds": [ - "07468399490707249352" - ], - "linkShareMetadata": { - "securityUpdateEligible": false, - "securityUpdateEnabled": true - }, - "files": [ - { - "kind": "drive#file", - "fileExtension": "jpg", - "copyRequiresWriterPermission": false, - "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", - "writersCanShare": true, - "viewedByMe": false, - "mimeType": "image/jpeg", - "parents": [ - "1Q3vl7hcmdeJvd86jC84pdGKW5772apUy" - ], - "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNAUm3pUadxI0PF3K2NLWZ81X_FVCOH-Ky07uWbsY1aFyC_GygKf4L-OjOqUKOqaZym4JYizjxeGTkBQjbEHmhtj79EuDaWQBrKGRsMSzEPeDs=s220", - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", - "shared": false, - "lastModifyingUser": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - }, - "owners": [ - { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - } - ], - "headRevisionId": "0B92vrbrhqfJrRTVPUUhub2t5dytHRm93enlyY2hYakozV1dFPQ", - "webViewLink": "https://drive.google.com/file/d/1-vL_2o3B_v0-fYVKRgok5PmF3goKOsW3/view?usp=drivesdk", - "webContentLink": "https://drive.google.com/uc?id=1-vL_2o3B_v0-fYVKRgok5PmF3goKOsW3&export=download", - "size": "2114025", - "viewersCanCopyContent": true, - "permissions": [ - { - "id": "07468399490707249352", - "displayName": "Антон Титовец", - "type": "user", - "kind": "drive#permission", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "emailAddress": "bayselonarrend@gmail.com", -... -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.mdx new file mode 100644 index 0000000000..94db9e6ed0 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.mdx @@ -0,0 +1,191 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get list of directories + Gets the list of drive directories + + + +`Function GetDirectoriesList(Val Token, Val NameContains = "", Val Detailed = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | NameContains | --querry | String | Filter by name | + | Detailed | --depth | Boolean | Adds a list of files to the directory fields | + + + Returns: Map Of KeyAndValue - Array of directory mappings + +
+ + + + +```bsl title="Code example" + Name = "TestFolder"; + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + + Result = OPI_GoogleDrive.GetDirectoriesList(Token, Name, True); +``` + + + + +```json title="Result" +[ + { + "kind": "drive#file", + "copyRequiresWriterPermission": false, + "writersCanShare": true, + "viewedByMe": false, + "mimeType": "application/vnd.google-apps.folder", + "parents": [ + "0AN2vrbrhqfJrUk9PVA" + ], + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "shared": false, + "lastModifyingUser": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + }, + "owners": [ + { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + } + ], + "webViewLink": "https://drive.google.com/drive/folders/1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", + "viewersCanCopyContent": true, + "permissions": [ + { + "id": "07468399490707249352", + "displayName": "Антон Титовец", + "type": "user", + "kind": "drive#permission", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", + "deleted": false, + "pendingOwner": false + } + ], + "hasThumbnail": false, + "spaces": [ + "drive" + ], + "folderColorRgb": "#8f8f8f", + "id": "1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", + "name": "TestFolder", + "description": "", + "starred": false, + "trashed": false, + "explicitlyTrashed": false, + "createdTime": "2024-06-03T07:24:06.147Z", + "modifiedTime": "2024-06-03T07:24:06.147Z", + "modifiedByMeTime": "2024-06-03T07:24:06.147Z", + "quotaBytesUsed": "0", + "version": "1", + "ownedByMe": true, + "isAppAuthorized": true, + "capabilities": { + "canChangeViewersCanCopyContent": false, + "canEdit": true, + "canCopy": false, + "canComment": true, + "canAddChildren": true, + "canDelete": true, + "canDownload": true, + "canListChildren": true, + "canRemoveChildren": true, + "canRename": true, + "canTrash": true, + "canReadRevisions": false, + "canChangeCopyRequiresWriterPermission": false, + "canMoveItemIntoTeamDrive": true, + "canUntrash": true, + "canModifyContent": true, + "canMoveItemOutOfDrive": true, + "canAddMyDriveParent": false, + "canRemoveMyDriveParent": true, + "canMoveItemWithinDrive": true, + "canShare": true, + "canMoveChildrenWithinDrive": true, + "canModifyContentRestriction": false, + "canChangeSecurityUpdateEnabled": false, + "canAcceptOwnership": false, + "canReadLabels": false, + "canModifyLabels": false, + "canModifyEditorContentRestriction": false, + "canModifyOwnerContentRestriction": false, + "canRemoveContentRestriction": false + }, + "thumbnailVersion": "0", + "modifiedByMe": true, + "permissionIds": [ + "07468399490707249352" + ], + "linkShareMetadata": { + "securityUpdateEligible": false, + "securityUpdateEnabled": true + }, + "files": [ + { + "kind": "drive#file", + "fileExtension": "jpg", + "copyRequiresWriterPermission": false, + "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", + "writersCanShare": true, + "viewedByMe": false, + "mimeType": "image/jpeg", + "parents": [ + "1Q3vl7hcmdeJvd86jC84pdGKW5772apUy" + ], + "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNAUm3pUadxI0PF3K2NLWZ81X_FVCOH-Ky07uWbsY1aFyC_GygKf4L-OjOqUKOqaZym4JYizjxeGTkBQjbEHmhtj79EuDaWQBrKGRsMSzEPeDs=s220", + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", + "shared": false, + "lastModifyingUser": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + }, + "owners": [ + { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + } + ], + "headRevisionId": "0B92vrbrhqfJrRTVPUUhub2t5dytHRm93enlyY2hYakozV1dFPQ", + "webViewLink": "https://drive.google.com/file/d/1-vL_2o3B_v0-fYVKRgok5PmF3goKOsW3/view?usp=drivesdk", + "webContentLink": "https://drive.google.com/uc?id=1-vL_2o3B_v0-fYVKRgok5PmF3goKOsW3&export=download", + "size": "2114025", + "viewersCanCopyContent": true, + "permissions": [ + { + "id": "07468399490707249352", + "displayName": "Антон Титовец", + "type": "user", + "kind": "drive#permission", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "emailAddress": "bayselonarrend@gmail.com", +... +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md deleted file mode 100644 index f49a7bd06b..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Get file description - Gets a blank description template for uploading a file - - - -`Function GetFileDescription(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Map Of KeyAndValue - File description - -
- - - - -```bsl title="Code example" - Result = OPI_GoogleDrive.GetFileDescription(); -``` - - - - -```json title="Result" -{ - "MIME": "image/jpeg", - "Name": "New file.jpg", - "Description": "This is a new file", - "Parent": "root" -} -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.mdx new file mode 100644 index 0000000000..6b6b5b6da5 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.mdx @@ -0,0 +1,41 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Get file description + Gets a blank description template for uploading a file + + + +`Function GetFileDescription(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Map Of KeyAndValue - File description + +
+ + + + +```bsl title="Code example" + Result = OPI_GoogleDrive.GetFileDescription(); +``` + + + + +```json title="Result" +{ + "MIME": "image/jpeg", + "Name": "New file.jpg", + "Description": "This is a new file", + "Parent": "root" +} +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md deleted file mode 100644 index b9afc61942..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get list of files - Gets the list of files - - - -`Function GetFilesList(Val Token, Val NameContains = "", Val Directory = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | NameContains | --querry | String | Filter by name | - | Directory | --catalog | String | Filter by parent directory ID | - - - Returns: Map Of KeyAndValue - Array of file mappings - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Directory = "root"; - NameContains = "data"; - - Result = OPI_GoogleDrive.GetFilesList(Token, NameContains, Directory); -``` - - - - -```json title="Result" -[ - { - "kind": "drive#file", - "fileExtension": "json", - "copyRequiresWriterPermission": false, - "md5Checksum": "cf83e956f3cddf775f02ff1955954efd", - "writersCanShare": true, - "viewedByMe": true, - "mimeType": "application/json", - "parents": [ - "0AN2vrbrhqfJrUk9PVA" - ], - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/json", - "shared": false, - "lastModifyingUser": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - }, - "owners": [ - { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - } - ], - "headRevisionId": "0B92vrbrhqfJrYWlNZXZQbXhaZm84c2xqVzdIYzM4N2luVkV3PQ", - "webViewLink": "https://drive.google.com/file/d/1NKMmj4SJh3WUw74nhLuMofW7dfpUR520/view?usp=drivesdk", - "webContentLink": "https://drive.google.com/uc?id=1NKMmj4SJh3WUw74nhLuMofW7dfpUR520&export=download", - "size": "10577", - "viewersCanCopyContent": true, - "permissions": [ - { - "id": "07468399490707249352", - "displayName": "Антон Титовец", - "type": "user", - "kind": "drive#permission", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", - "deleted": false, - "pendingOwner": false - } - ], - "hasThumbnail": false, - "spaces": [ - "drive" - ], - "id": "1NKMmj4SJh3WUw74nhLuMofW7dfpUR520", - "name": "data.json", - "starred": false, - "trashed": false, - "explicitlyTrashed": false, - "createdTime": "2024-02-29T19:22:49.616Z", - "modifiedTime": "2024-10-08T17:03:36.717Z", - "modifiedByMeTime": "2024-10-08T17:03:36.717Z", - "viewedByMeTime": "2024-10-08T17:03:36.717Z", - "quotaBytesUsed": "10577", - "version": "5878", - "originalFilename": "data.json", - "ownedByMe": true, - "fullFileExtension": "json", - "isAppAuthorized": false, - "capabilities": { - "canChangeViewersCanCopyContent": true, - "canEdit": true, - "canCopy": true, - "canComment": true, - "canAddChildren": false, - "canDelete": true, - "canDownload": true, - "canListChildren": false, - "canRemoveChildren": false, - "canRename": true, - "canTrash": true, - "canReadRevisions": true, - "canChangeCopyRequiresWriterPermission": true, - "canMoveItemIntoTeamDrive": true, - "canUntrash": true, - "canModifyContent": true, - "canMoveItemOutOfDrive": true, - "canAddMyDriveParent": false, - "canRemoveMyDriveParent": true, - "canMoveItemWithinDrive": true, - "canShare": true, - "canMoveChildrenWithinDrive": false, - "canModifyContentRestriction": true, - "canChangeSecurityUpdateEnabled": false, - "canAcceptOwnership": false, - "canReadLabels": false, - "canModifyLabels": false, - "canModifyEditorContentRestriction": true, - "canModifyOwnerContentRestriction": true, - "canRemoveContentRestriction": false - }, - "thumbnailVersion": "0", - "modifiedByMe": true, - "permissionIds": [ - "07468399490707249352" - ], - "linkShareMetadata": { - "securityUpdateEligible": false, - "securityUpdateEnabled": true - }, - "sha1Checksum": "f2d5069322045898ea4932524eb2450b0ef1fdd5", - "sha256Checksum": "2353109234e9285120e08407374b196bf640ef55adfb6923da467a52d9b28084" - } -] -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.mdx new file mode 100644 index 0000000000..cf6570c24c --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.mdx @@ -0,0 +1,155 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get list of files + Gets the list of files + + + +`Function GetFilesList(Val Token, Val NameContains = "", Val Directory = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | NameContains | --querry | String | Filter by name | + | Directory | --catalog | String | Filter by parent directory ID | + + + Returns: Map Of KeyAndValue - Array of file mappings + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Directory = "root"; + NameContains = "data"; + + Result = OPI_GoogleDrive.GetFilesList(Token, NameContains, Directory); +``` + + + + +```json title="Result" +[ + { + "kind": "drive#file", + "fileExtension": "json", + "copyRequiresWriterPermission": false, + "md5Checksum": "cf83e956f3cddf775f02ff1955954efd", + "writersCanShare": true, + "viewedByMe": true, + "mimeType": "application/json", + "parents": [ + "0AN2vrbrhqfJrUk9PVA" + ], + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/json", + "shared": false, + "lastModifyingUser": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + }, + "owners": [ + { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + } + ], + "headRevisionId": "0B92vrbrhqfJrYWlNZXZQbXhaZm84c2xqVzdIYzM4N2luVkV3PQ", + "webViewLink": "https://drive.google.com/file/d/1NKMmj4SJh3WUw74nhLuMofW7dfpUR520/view?usp=drivesdk", + "webContentLink": "https://drive.google.com/uc?id=1NKMmj4SJh3WUw74nhLuMofW7dfpUR520&export=download", + "size": "10577", + "viewersCanCopyContent": true, + "permissions": [ + { + "id": "07468399490707249352", + "displayName": "Антон Титовец", + "type": "user", + "kind": "drive#permission", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", + "deleted": false, + "pendingOwner": false + } + ], + "hasThumbnail": false, + "spaces": [ + "drive" + ], + "id": "1NKMmj4SJh3WUw74nhLuMofW7dfpUR520", + "name": "data.json", + "starred": false, + "trashed": false, + "explicitlyTrashed": false, + "createdTime": "2024-02-29T19:22:49.616Z", + "modifiedTime": "2024-10-08T17:03:36.717Z", + "modifiedByMeTime": "2024-10-08T17:03:36.717Z", + "viewedByMeTime": "2024-10-08T17:03:36.717Z", + "quotaBytesUsed": "10577", + "version": "5878", + "originalFilename": "data.json", + "ownedByMe": true, + "fullFileExtension": "json", + "isAppAuthorized": false, + "capabilities": { + "canChangeViewersCanCopyContent": true, + "canEdit": true, + "canCopy": true, + "canComment": true, + "canAddChildren": false, + "canDelete": true, + "canDownload": true, + "canListChildren": false, + "canRemoveChildren": false, + "canRename": true, + "canTrash": true, + "canReadRevisions": true, + "canChangeCopyRequiresWriterPermission": true, + "canMoveItemIntoTeamDrive": true, + "canUntrash": true, + "canModifyContent": true, + "canMoveItemOutOfDrive": true, + "canAddMyDriveParent": false, + "canRemoveMyDriveParent": true, + "canMoveItemWithinDrive": true, + "canShare": true, + "canMoveChildrenWithinDrive": false, + "canModifyContentRestriction": true, + "canChangeSecurityUpdateEnabled": false, + "canAcceptOwnership": false, + "canReadLabels": false, + "canModifyLabels": false, + "canModifyEditorContentRestriction": true, + "canModifyOwnerContentRestriction": true, + "canRemoveContentRestriction": false + }, + "thumbnailVersion": "0", + "modifiedByMe": true, + "permissionIds": [ + "07468399490707249352" + ], + "linkShareMetadata": { + "securityUpdateEligible": false, + "securityUpdateEnabled": true + }, + "sha1Checksum": "f2d5069322045898ea4932524eb2450b0ef1fdd5", + "sha256Checksum": "2353109234e9285120e08407374b196bf640ef55adfb6923da467a52d9b28084" + } +] +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md deleted file mode 100644 index d9f69e32c1..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get object information - Gets information about a folder or file by ID - - - -`Function GetObjectInformation(Val Token, Val Identifier) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the file or folder | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; - - Result = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); -``` - - - - -```json title="Result" -{ - "kind": "drive#file", - "id": "1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", - "name": "TestFolder", - "mimeType": "application/vnd.google-apps.folder", - "description": "", - "starred": false, - "trashed": false, - "explicitlyTrashed": false, - "parents": [ - "0AN2vrbrhqfJrUk9PVA" - ], - "spaces": [ - "drive" - ], - "version": "1", - "webViewLink": "https://drive.google.com/drive/folders/1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "hasThumbnail": false, - "thumbnailVersion": "0", - "viewedByMe": false, - "createdTime": "2024-06-03T07:24:06.147Z", - "modifiedTime": "2024-06-03T07:24:06.147Z", - "modifiedByMeTime": "2024-06-03T07:24:06.147Z", - "modifiedByMe": true, - "owners": [ - { - "kind": "drive#user", - "displayName": "Антон Титовец", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com" - } - ], - "lastModifyingUser": { - "kind": "drive#user", - "displayName": "Антон Титовец", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com" - }, - "shared": false, - "ownedByMe": true, - "capabilities": { - "canAcceptOwnership": false, - "canAddChildren": true, - "canAddMyDriveParent": false, - "canChangeCopyRequiresWriterPermission": false, - "canChangeSecurityUpdateEnabled": false, - "canChangeViewersCanCopyContent": false, - "canComment": true, - "canCopy": false, - "canDelete": true, - "canDownload": true, - "canEdit": true, - "canListChildren": true, - "canModifyContent": true, - "canModifyContentRestriction": false, - "canModifyEditorContentRestriction": false, - "canModifyOwnerContentRestriction": false, - "canModifyLabels": false, - "canMoveChildrenWithinDrive": true, - "canMoveItemIntoTeamDrive": true, - "canMoveItemOutOfDrive": true, - "canMoveItemWithinDrive": true, - "canReadLabels": false, - "canReadRevisions": false, - "canRemoveChildren": true, - "canRemoveContentRestriction": false, - "canRemoveMyDriveParent": true, - "canRename": true, - "canShare": true, - "canTrash": true, - "canUntrash": true - }, - "viewersCanCopyContent": true, - "copyRequiresWriterPermission": false, - "writersCanShare": true, - "permissions": [ - { - "kind": "drive#permission", - "id": "07468399490707249352", - "type": "user", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", - "displayName": "Антон Титовец", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "deleted": false, - "pendingOwner": false - } - ], - "permissionIds": [ - "07468399490707249352" - ], - "folderColorRgb": "#8f8f8f", - "quotaBytesUsed": "0", - "isAppAuthorized": true, - "linkShareMetadata": { - "securityUpdateEligible": false, - "securityUpdateEnabled": true - } -} -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.mdx new file mode 100644 index 0000000000..d470665e76 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.mdx @@ -0,0 +1,143 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get object information + Gets information about a folder or file by ID + + + +`Function GetObjectInformation(Val Token, Val Identifier) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the file or folder | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; + + Result = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); +``` + + + + +```json title="Result" +{ + "kind": "drive#file", + "id": "1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", + "name": "TestFolder", + "mimeType": "application/vnd.google-apps.folder", + "description": "", + "starred": false, + "trashed": false, + "explicitlyTrashed": false, + "parents": [ + "0AN2vrbrhqfJrUk9PVA" + ], + "spaces": [ + "drive" + ], + "version": "1", + "webViewLink": "https://drive.google.com/drive/folders/1Q3vl7hcmdeJvd86jC84pdGKW5772apUy", + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "hasThumbnail": false, + "thumbnailVersion": "0", + "viewedByMe": false, + "createdTime": "2024-06-03T07:24:06.147Z", + "modifiedTime": "2024-06-03T07:24:06.147Z", + "modifiedByMeTime": "2024-06-03T07:24:06.147Z", + "modifiedByMe": true, + "owners": [ + { + "kind": "drive#user", + "displayName": "Антон Титовец", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com" + } + ], + "lastModifyingUser": { + "kind": "drive#user", + "displayName": "Антон Титовец", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com" + }, + "shared": false, + "ownedByMe": true, + "capabilities": { + "canAcceptOwnership": false, + "canAddChildren": true, + "canAddMyDriveParent": false, + "canChangeCopyRequiresWriterPermission": false, + "canChangeSecurityUpdateEnabled": false, + "canChangeViewersCanCopyContent": false, + "canComment": true, + "canCopy": false, + "canDelete": true, + "canDownload": true, + "canEdit": true, + "canListChildren": true, + "canModifyContent": true, + "canModifyContentRestriction": false, + "canModifyEditorContentRestriction": false, + "canModifyOwnerContentRestriction": false, + "canModifyLabels": false, + "canMoveChildrenWithinDrive": true, + "canMoveItemIntoTeamDrive": true, + "canMoveItemOutOfDrive": true, + "canMoveItemWithinDrive": true, + "canReadLabels": false, + "canReadRevisions": false, + "canRemoveChildren": true, + "canRemoveContentRestriction": false, + "canRemoveMyDriveParent": true, + "canRename": true, + "canShare": true, + "canTrash": true, + "canUntrash": true + }, + "viewersCanCopyContent": true, + "copyRequiresWriterPermission": false, + "writersCanShare": true, + "permissions": [ + { + "kind": "drive#permission", + "id": "07468399490707249352", + "type": "user", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", + "displayName": "Антон Титовец", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "deleted": false, + "pendingOwner": false + } + ], + "permissionIds": [ + "07468399490707249352" + ], + "folderColorRgb": "#8f8f8f", + "quotaBytesUsed": "0", + "isAppAuthorized": true, + "linkShareMetadata": { + "securityUpdateEligible": false, + "securityUpdateEnabled": true + } +} +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md b/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md deleted file mode 100644 index 88481b940f..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Update file - Updates file binary data - - - -`Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the object to update | - | File | --file | BinaryData,String | File source for update | - | NewName | --title | String | New file name (if necessary) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - NewName = "UpdatedFile.jpg"; - Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - File = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary Data or Path to file - - Result = OPI_GoogleDrive.UpdateFile(Token, Identifier, File, NewName); -``` - - - - -```json title="Result" -{ - "kind": "drive#file", - "id": "1slRtvK9Yap08a-wh_iE5go6dkCMwZrYH", - "name": "UpdatedFile.jpg", - "mimeType": "image/jpeg" -} -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Update-file.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Update-file.mdx new file mode 100644 index 0000000000..7e6d45ed12 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Update-file.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Update file + Updates file binary data + + + +`Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the object to update | + | File | --file | BinaryData,String | File source for update | + | NewName | --title | String | New file name (if necessary) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + NewName = "UpdatedFile.jpg"; + Identifier = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + File = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary Data or Path to file + + Result = OPI_GoogleDrive.UpdateFile(Token, Identifier, File, NewName); +``` + + + + +```json title="Result" +{ + "kind": "drive#file", + "id": "1slRtvK9Yap08a-wh_iE5go6dkCMwZrYH", + "name": "UpdatedFile.jpg", + "mimeType": "image/jpeg" +} +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md b/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md deleted file mode 100644 index ba96ef76c1..0000000000 --- a/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Upload file - Uploads a file to the drive - - - -`Function UploadFile(Val Token, Val File, Val Description) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | File | --file | BinaryData,String | File to be uploaded | - | Description | --props | Map Of KeyAndValue | JSON description or path to .json | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - Directory = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; - - Description = OPI_GoogleDrive.GetFileDescription(); - Description.Insert("Parent", Directory); - - Result = OPI_GoogleDrive.UploadFile(Token, Image, Description); -``` - - - - -```json title="Result" -{ - "kind": "drive#file", - "id": "1iscrZRfSVq4khO1E3n-uSbfSFDTZfYdE", - "name": "New file.jpg", - "mimeType": "image/jpeg" -} -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.mdx b/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.mdx new file mode 100644 index 0000000000..c3b5382a72 --- /dev/null +++ b/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Upload file + Uploads a file to the drive + + + +`Function UploadFile(Val Token, Val File, Val Description) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | File | --file | BinaryData,String | File to be uploaded | + | Description | --props | Map Of KeyAndValue | JSON description or path to .json | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + Directory = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; + + Description = OPI_GoogleDrive.GetFileDescription(); + Description.Insert("Parent", Directory); + + Result = OPI_GoogleDrive.UploadFile(Token, Image, Description); +``` + + + + +```json title="Result" +{ + "kind": "drive#file", + "id": "1iscrZRfSVq4khO1E3n-uSbfSFDTZfYdE", + "name": "New file.jpg", + "mimeType": "image/jpeg" +} +``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md b/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md deleted file mode 100644 index 4f16c2609c..0000000000 --- a/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Clear cells - Clears the value in cells - - - -`Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Spreadsheet | --spreadsheet | String | SpreadsheetID | - | CellsArray | --cells | Array of String | Array of cells like A1 to be cleared | - | Sheet | --sheetname | String | Sheet name (first sheet by default) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Sheet = "Sheet2"; - - CellsArray = New Array; - CellsArray.Add("B2"); - CellsArray.Add("A3"); - CellsArray.Add("B4"); - - Result = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "clearedRanges": [ - "Sheet2!B2", - "Sheet2!A3", - "Sheet2!B4" - ] -} -``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Clear-cells.mdx b/docs/en/md/Google_Sheets/Data-managment/Clear-cells.mdx new file mode 100644 index 0000000000..709461ea2d --- /dev/null +++ b/docs/en/md/Google_Sheets/Data-managment/Clear-cells.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Clear cells + Clears the value in cells + + + +`Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Spreadsheet | --spreadsheet | String | SpreadsheetID | + | CellsArray | --cells | Array of String | Array of cells like A1 to be cleared | + | Sheet | --sheetname | String | Sheet name (first sheet by default) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Sheet = "Sheet2"; + + CellsArray = New Array; + CellsArray.Add("B2"); + CellsArray.Add("A3"); + CellsArray.Add("B4"); + + Result = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "clearedRanges": [ + "Sheet2!B2", + "Sheet2!A3", + "Sheet2!B4" + ] +} +``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md b/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md deleted file mode 100644 index 29ac06e906..0000000000 --- a/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get cell values - Gets cell values of the table - - - -`Function GetCellValues(Val Token, Val Spreadsheet, Val CellsArray = "", Val Sheet = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Spreadsheet | --spreadsheet | String | SpreadsheetID | - | 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) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Sheet = "Sheet2"; - - CellsArray = New Array; - CellsArray.Add("B2"); - CellsArray.Add("A3"); - CellsArray.Add("B4"); - - Result = OPI_GoogleSheets.GetCellValues(Token, Spreadsheet, CellsArray, Sheet); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "valueRanges": [ - { - "range": "Sheet2!B2", - "majorDimension": "ROWS", - "values": [ - [ - "ThisIsB2" - ] - ] - }, - { - "range": "Sheet2!A3", - "majorDimension": "ROWS", - "values": [ - [ - "ThisIsA3" - ] - ] - }, - { - "range": "Sheet2!B4", - "majorDimension": "ROWS", - "values": [ - [ - "ThisIsB4" - ] - ] - } - ] -} -``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.mdx b/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.mdx new file mode 100644 index 0000000000..c19b7999de --- /dev/null +++ b/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get cell values + Gets cell values of the table + + + +`Function GetCellValues(Val Token, Val Spreadsheet, Val CellsArray = "", Val Sheet = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Spreadsheet | --spreadsheet | String | SpreadsheetID | + | 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) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Sheet = "Sheet2"; + + CellsArray = New Array; + CellsArray.Add("B2"); + CellsArray.Add("A3"); + CellsArray.Add("B4"); + + Result = OPI_GoogleSheets.GetCellValues(Token, Spreadsheet, CellsArray, Sheet); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "valueRanges": [ + { + "range": "Sheet2!B2", + "majorDimension": "ROWS", + "values": [ + [ + "ThisIsB2" + ] + ] + }, + { + "range": "Sheet2!A3", + "majorDimension": "ROWS", + "values": [ + [ + "ThisIsA3" + ] + ] + }, + { + "range": "Sheet2!B4", + "majorDimension": "ROWS", + "values": [ + [ + "ThisIsB4" + ] + ] + } + ] +} +``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md b/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md deleted file mode 100644 index 32fc0c2481..0000000000 --- a/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Set cell values - Sets sheet cell values - - - -`Function SetCellValues(Val Token, Val Spreadsheet, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Spreadsheet | --spreadsheet | String | SpreadsheetID | - | 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) | - | MajorDimension | --dim | String | Main dimension when filling the array range | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Sheet = "Sheet2"; - - ValueMapping = New Map; - ValueMapping.Insert("A1", "ThisIsA1"); - ValueMapping.Insert("A2", "ThisIsA2"); - ValueMapping.Insert("B2", "ThisIsB2"); - ValueMapping.Insert("B3", "ThisIsB3"); - ValueMapping.Insert("A3", "ThisIsA3"); - ValueMapping.Insert("A4", "ThisIsA4"); - ValueMapping.Insert("B1", "ThisIsB1"); - ValueMapping.Insert("B4", "ThisIsB4"); - - Result = OPI_GoogleSheets.SetCellValues(Token, Spreadsheet, ValueMapping, Sheet); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "totalUpdatedRows": 4, - "totalUpdatedColumns": 2, - "totalUpdatedCells": 8, - "totalUpdatedSheets": 1, - "responses": [ - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!A1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!A2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!B2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!B3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!A3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!A4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!B1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "updatedRange": "Sheet2!B4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - } - ] -} -``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.mdx b/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.mdx new file mode 100644 index 0000000000..827713fdae --- /dev/null +++ b/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.mdx @@ -0,0 +1,118 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Set cell values + Sets sheet cell values + + + +`Function SetCellValues(Val Token, Val Spreadsheet, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Spreadsheet | --spreadsheet | String | SpreadsheetID | + | 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) | + | MajorDimension | --dim | String | Main dimension when filling the array range | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Sheet = "Sheet2"; + + ValueMapping = New Map; + ValueMapping.Insert("A1", "ThisIsA1"); + ValueMapping.Insert("A2", "ThisIsA2"); + ValueMapping.Insert("B2", "ThisIsB2"); + ValueMapping.Insert("B3", "ThisIsB3"); + ValueMapping.Insert("A3", "ThisIsA3"); + ValueMapping.Insert("A4", "ThisIsA4"); + ValueMapping.Insert("B1", "ThisIsB1"); + ValueMapping.Insert("B4", "ThisIsB4"); + + Result = OPI_GoogleSheets.SetCellValues(Token, Spreadsheet, ValueMapping, Sheet); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "totalUpdatedRows": 4, + "totalUpdatedColumns": 2, + "totalUpdatedCells": 8, + "totalUpdatedSheets": 1, + "responses": [ + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!A1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!A2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!B2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!B3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!A3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!A4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!B1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "updatedRange": "Sheet2!B4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + } + ] +} +``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md b/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md deleted file mode 100644 index 7fa6c4046c..0000000000 --- a/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create spreadsheet - Creates a new spreadsheet - - - -`Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Name | --title | String | Name | - | ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Name = "TestTable"; - - SheetArray = New Array; - SheetArray.Add("Sheet1"); - SheetArray.Add("Sheet2"); - - Result = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, SheetArray); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", - "properties": { - "title": "TestTable", - "locale": "ru_RU", - "autoRecalc": "ON_CHANGE", - "timeZone": "Etc/GMT", - "defaultFormat": { - "backgroundColor": { - "red": 1, - "green": 1, - "blue": 1 - }, - "padding": { - "top": 2, - "right": 3, - "bottom": 2, - "left": 3 - }, - "verticalAlignment": "BOTTOM", - "wrapStrategy": "OVERFLOW_CELL", - "textFormat": { - "foregroundColor": {}, - "fontFamily": "arial,sans,sans-serif", - "fontSize": 10, - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "foregroundColorStyle": { - "rgbColor": {} - } - }, - "backgroundColorStyle": { - "rgbColor": { - "red": 1, - "green": 1, - "blue": 1 - } - } - }, - "spreadsheetTheme": { - "primaryFontFamily": "Arial", - "themeColors": [ - { - "colorType": "TEXT", - "color": { - "rgbColor": {} - } - }, - { - "colorType": "BACKGROUND", - "color": { - "rgbColor": { - "red": 1, - "green": 1, - "blue": 1 - } - } - }, - { - "colorType": "ACCENT1", - "color": { - "rgbColor": { - "red": 0.25882354, - "green": 0.52156866, - "blue": 0.95686275 - } - } - }, - { - "colorType": "ACCENT2", - "color": { - "rgbColor": { - "red": 0.91764706, - "green": 0.2627451, - "blue": 0.20784314 - } - } - }, - { - "colorType": "ACCENT3", - "color": { - "rgbColor": { - "red": 0.9843137, - "green": 0.7372549, - "blue": 0.015686275 - } - } - }, - { - "colorType": "ACCENT4", - "color": { - "rgbColor": { - "red": 0.20392157, - "green": 0.65882355, - "blue": 0.3254902 - } - } - }, - { - "colorType": "ACCENT5", - "color": { - "rgbColor": { - "red": 1, - "green": 0.42745098, - "blue": 0.003921569 - } - } - }, - { - "colorType": "ACCENT6", - "color": { - "rgbColor": { - "red": 0.27450982, - "green": 0.7411765, - "blue": 0.7764706 - } - } - }, - { - "colorType": "LINK", - "color": { - "rgbColor": { - "red": 0.06666667, - "green": 0.33333334, - "blue": 0.8 - } - } - } - ] - } - }, - "sheets": [ - { - "properties": { - "sheetId": 1448844153, - "title": "Sheet1", - "index": 0, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - }, - { - "properties": { - "sheetId": 1415561922, - "title": "Sheet2", -... -``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.mdx b/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.mdx new file mode 100644 index 0000000000..3dcf7ed1fd --- /dev/null +++ b/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.mdx @@ -0,0 +1,195 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create spreadsheet + Creates a new spreadsheet + + + +`Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Name | --title | String | Name | + | ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Name = "TestTable"; + + SheetArray = New Array; + SheetArray.Add("Sheet1"); + SheetArray.Add("Sheet2"); + + Result = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, SheetArray); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1p_i-5lmOKdBEbi88O0SkXq2Q_gG0c4EY7N_wtWGKSCs", + "properties": { + "title": "TestTable", + "locale": "ru_RU", + "autoRecalc": "ON_CHANGE", + "timeZone": "Etc/GMT", + "defaultFormat": { + "backgroundColor": { + "red": 1, + "green": 1, + "blue": 1 + }, + "padding": { + "top": 2, + "right": 3, + "bottom": 2, + "left": 3 + }, + "verticalAlignment": "BOTTOM", + "wrapStrategy": "OVERFLOW_CELL", + "textFormat": { + "foregroundColor": {}, + "fontFamily": "arial,sans,sans-serif", + "fontSize": 10, + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "foregroundColorStyle": { + "rgbColor": {} + } + }, + "backgroundColorStyle": { + "rgbColor": { + "red": 1, + "green": 1, + "blue": 1 + } + } + }, + "spreadsheetTheme": { + "primaryFontFamily": "Arial", + "themeColors": [ + { + "colorType": "TEXT", + "color": { + "rgbColor": {} + } + }, + { + "colorType": "BACKGROUND", + "color": { + "rgbColor": { + "red": 1, + "green": 1, + "blue": 1 + } + } + }, + { + "colorType": "ACCENT1", + "color": { + "rgbColor": { + "red": 0.25882354, + "green": 0.52156866, + "blue": 0.95686275 + } + } + }, + { + "colorType": "ACCENT2", + "color": { + "rgbColor": { + "red": 0.91764706, + "green": 0.2627451, + "blue": 0.20784314 + } + } + }, + { + "colorType": "ACCENT3", + "color": { + "rgbColor": { + "red": 0.9843137, + "green": 0.7372549, + "blue": 0.015686275 + } + } + }, + { + "colorType": "ACCENT4", + "color": { + "rgbColor": { + "red": 0.20392157, + "green": 0.65882355, + "blue": 0.3254902 + } + } + }, + { + "colorType": "ACCENT5", + "color": { + "rgbColor": { + "red": 1, + "green": 0.42745098, + "blue": 0.003921569 + } + } + }, + { + "colorType": "ACCENT6", + "color": { + "rgbColor": { + "red": 0.27450982, + "green": 0.7411765, + "blue": 0.7764706 + } + } + }, + { + "colorType": "LINK", + "color": { + "rgbColor": { + "red": 0.06666667, + "green": 0.33333334, + "blue": 0.8 + } + } + } + ] + } + }, + "sheets": [ + { + "properties": { + "sheetId": 1448844153, + "title": "Sheet1", + "index": 0, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + }, + { + "properties": { + "sheetId": 1415561922, + "title": "Sheet2", +... +``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md b/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md deleted file mode 100644 index 970d18b6da..0000000000 --- a/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Change spreadsheet name - Changes the name of the existing spreadsheet - - - -`Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Spreadsheet | --spreadsheet | String | SpreadsheetID | - | Name | --title | String | New name | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Name = "Test table (changed.)"; - - Result = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1psqJkXdtlHOc7Qzr4ficNkFth5dWLl0HdmMDhSTM7ZQ", - "replies": [ - {} - ] -} -``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.mdx b/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.mdx new file mode 100644 index 0000000000..f73962fc3d --- /dev/null +++ b/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Change spreadsheet name + Changes the name of the existing spreadsheet + + + +`Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Spreadsheet | --spreadsheet | String | SpreadsheetID | + | Name | --title | String | New name | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Name = "Test table (changed.)"; + + Result = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1psqJkXdtlHOc7Qzr4ficNkFth5dWLl0HdmMDhSTM7ZQ", + "replies": [ + {} + ] +} +``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md b/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md deleted file mode 100644 index 5176f39baf..0000000000 --- a/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get spreadsheet - Gets information about the spreadsheet by ID - - - -`Function GetSpreadsheet(Val Token, Val Identifier) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --spreadsheet | String | Spreadsheet identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Identifier = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - - Result = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); -``` - - - - -```json title="Result" - -``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.mdx b/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.mdx new file mode 100644 index 0000000000..a0a9b40922 --- /dev/null +++ b/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get spreadsheet + Gets information about the spreadsheet by ID + + + +`Function GetSpreadsheet(Val Token, Val Identifier) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --spreadsheet | String | Spreadsheet identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Identifier = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + + Result = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); +``` + + + + +```json title="Result" + +``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md b/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md deleted file mode 100644 index 66a9ec2fa0..0000000000 --- a/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Add sheet - Adds a new sheet to the spreadsheet - - - -`Function AddSheet(Val Token, Val Spreadsheet, Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Spreadsheet | --spreadsheet | String | Spreadsheet identifier | - | Name | --title | String | NewSheetName | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Name = "TestSheet"; - - Result = OPI_GoogleSheets.AddSheet(Token, Spreadsheet, Name); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1psqJkXdtlHOc7Qzr4ficNkFth5dWLl0HdmMDhSTM7ZQ", - "replies": [ - { - "addSheet": { - "properties": { - "sheetId": 1019462179, - "title": "TestSheet", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - } - ] -} -``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.mdx b/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.mdx new file mode 100644 index 0000000000..9e07df9e98 --- /dev/null +++ b/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Add sheet + Adds a new sheet to the spreadsheet + + + +`Function AddSheet(Val Token, Val Spreadsheet, Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Spreadsheet | --spreadsheet | String | Spreadsheet identifier | + | Name | --title | String | NewSheetName | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Name = "TestSheet"; + + Result = OPI_GoogleSheets.AddSheet(Token, Spreadsheet, Name); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1psqJkXdtlHOc7Qzr4ficNkFth5dWLl0HdmMDhSTM7ZQ", + "replies": [ + { + "addSheet": { + "properties": { + "sheetId": 1019462179, + "title": "TestSheet", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + } + ] +} +``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md b/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md deleted file mode 100644 index f368b06fd9..0000000000 --- a/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Copy sheet - Copies a sheet from one spreadsheet to another - - - -`Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | From | --from | String | Source spreadsheet ID | - | Target | --to | String | Destination spreadsheet ID | - | Sheet | --sheet | String | CopiedSheetID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - From = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Target = "1WBgDTXbFwMmu1pOOxkej3eD-fx3KQ9kiQ0Np5B2oeMY"; - Sheet = "1710472523"; - - Result = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); -``` - - - - -```json title="Result" -{ - "sheetId": 1272386935, - "title": "Sheet1 (копия)", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } -} -``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.mdx b/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.mdx new file mode 100644 index 0000000000..591aea9ec4 --- /dev/null +++ b/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Copy sheet + Copies a sheet from one spreadsheet to another + + + +`Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | From | --from | String | Source spreadsheet ID | + | Target | --to | String | Destination spreadsheet ID | + | Sheet | --sheet | String | CopiedSheetID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + From = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Target = "1WBgDTXbFwMmu1pOOxkej3eD-fx3KQ9kiQ0Np5B2oeMY"; + Sheet = "1710472523"; + + Result = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); +``` + + + + +```json title="Result" +{ + "sheetId": 1272386935, + "title": "Sheet1 (копия)", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } +} +``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md b/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md deleted file mode 100644 index 3948adf99e..0000000000 --- a/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Delete sheet - Deletes a sheet from the spreadsheet - - - -`Function DeleteSheet(Val Token, Val Spreadsheet, Val Sheet) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Spreadsheet | --spreadsheet | String | Spreadsheet identifier | - | Sheet | --sheet | String | IdentifierOfSheetToDelete | - - - Returns: Map Of KeyAndValue - serialized JSON response from Google - -
- - - - -```bsl title="Code example" - Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Sheet = "1710472523"; - - Result = OPI_GoogleSheets.DeleteSheet(Token, Spreadsheet, Sheet); -``` - - - - -```json title="Result" -{ - "spreadsheetId": "1psqJkXdtlHOc7Qzr4ficNkFth5dWLl0HdmMDhSTM7ZQ", - "replies": [ - {} - ] -} -``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.mdx b/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.mdx new file mode 100644 index 0000000000..bf7a4654fc --- /dev/null +++ b/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Delete sheet + Deletes a sheet from the spreadsheet + + + +`Function DeleteSheet(Val Token, Val Spreadsheet, Val Sheet) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Spreadsheet | --spreadsheet | String | Spreadsheet identifier | + | Sheet | --sheet | String | IdentifierOfSheetToDelete | + + + Returns: Map Of KeyAndValue - serialized JSON response from Google + +
+ + + + +```bsl title="Code example" + Token = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Spreadsheet = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Sheet = "1710472523"; + + Result = OPI_GoogleSheets.DeleteSheet(Token, Spreadsheet, Sheet); +``` + + + + +```json title="Result" +{ + "spreadsheetId": "1psqJkXdtlHOc7Qzr4ficNkFth5dWLl0HdmMDhSTM7ZQ", + "replies": [ + {} + ] +} +``` diff --git a/docs/en/md/Neocities/Data-retrieving/Get-site-data.md b/docs/en/md/Neocities/Data-retrieving/Get-site-data.md deleted file mode 100644 index 0de5f80830..0000000000 --- a/docs/en/md/Neocities/Data-retrieving/Get-site-data.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get site data - Gets information about a site by its name or token - - - -`Function GetSiteData(Val Token, Val Website = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | Website | --sitename | String | Site name (login) for information. Current, if not filled in | - - - Returns: Map Of KeyAndValue - serialized JSON response from Neocities - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Code example" - Token = "7419cd51de4037f7..."; - Website = "2athenaeum"; - - Result = OPI_Neocities.GetSiteData(Token); - - Result = OPI_Neocities.GetSiteData(Token, Website); -``` - - - - -```json title="Result" -{ - "result": "success", - "info": { - "sitename": "opi-test", - "views": 9086, - "hits": 17120, - "created_at": "Thu, 20 Jun 2024 07:28:29 -0000", - "last_updated": "Wed, 09 Oct 2024 06:27:52 -0000", - "domain": null, - "tags": [] - } -} -``` diff --git a/docs/en/md/Neocities/Data-retrieving/Get-site-data.mdx b/docs/en/md/Neocities/Data-retrieving/Get-site-data.mdx new file mode 100644 index 0000000000..ef29a0d97c --- /dev/null +++ b/docs/en/md/Neocities/Data-retrieving/Get-site-data.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get site data + Gets information about a site by its name or token + + + +`Function GetSiteData(Val Token, Val Website = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | Website | --sitename | String | Site name (login) for information. Current, if not filled in | + + + Returns: Map Of KeyAndValue - serialized JSON response from Neocities + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Code example" + Token = "7419cd51de4037f7..."; + Website = "2athenaeum"; + + Result = OPI_Neocities.GetSiteData(Token); + + Result = OPI_Neocities.GetSiteData(Token, Website); +``` + + + + +```json title="Result" +{ + "result": "success", + "info": { + "sitename": "opi-test", + "views": 9086, + "hits": 17120, + "created_at": "Thu, 20 Jun 2024 07:28:29 -0000", + "last_updated": "Wed, 09 Oct 2024 06:27:52 -0000", + "domain": null, + "tags": [] + } +} +``` diff --git a/docs/en/md/Neocities/Data-retrieving/Get-token.md b/docs/en/md/Neocities/Data-retrieving/Get-token.md deleted file mode 100644 index c396ef6a80..0000000000 --- a/docs/en/md/Neocities/Data-retrieving/Get-token.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get token - Receives authorization token by login and password - - - -`Function GetToken(Val Login, Val Password) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Login | --login | String | Users login | - | Password | --password | String | Users password | - - - Returns: Map Of KeyAndValue - serialized JSON response from Neocities - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Code example" - Login = "2athenaeum"; - Password = "Rit..."; - - Result = OPI_Neocities.GetToken(Login, Password); -``` - - - - -```json title="Result" -{ - "result": "success", - "api_key": "***" -} -``` diff --git a/docs/en/md/Neocities/Data-retrieving/Get-token.mdx b/docs/en/md/Neocities/Data-retrieving/Get-token.mdx new file mode 100644 index 0000000000..ba91bb6cf0 --- /dev/null +++ b/docs/en/md/Neocities/Data-retrieving/Get-token.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get token + Receives authorization token by login and password + + + +`Function GetToken(Val Login, Val Password) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Login | --login | String | Users login | + | Password | --password | String | Users password | + + + Returns: Map Of KeyAndValue - serialized JSON response from Neocities + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Code example" + Login = "2athenaeum"; + Password = "Rit..."; + + Result = OPI_Neocities.GetToken(Login, Password); +``` + + + + +```json title="Result" +{ + "result": "success", + "api_key": "***" +} +``` diff --git a/docs/en/md/Neocities/File-managment/Delete-selected-files.md b/docs/en/md/Neocities/File-managment/Delete-selected-files.md deleted file mode 100644 index 41d9a2320c..0000000000 --- a/docs/en/md/Neocities/File-managment/Delete-selected-files.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete selected files - Deletes a file or multiple files from Neocities - - - -`Function DeleteSelectedFiles(Val Token, Val Paths) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | Paths | --paths | String, Array of String | Path or multiple paths of the files to be deleted | - - - Returns: Map Of KeyAndValue - serialized JSON response from Neocities - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Code example" - Token = "7419cd51de4037f7..."; - - Paths = New Array; - Paths.Add("/test/pic1.png"); - Paths.Add("/test/gif.gif"); - Paths.Add("/pic2.png"); - - Result = OPI_Neocities.DeleteSelectedFiles(Token, Paths); -``` - - - - -```json title="Result" -{ - "result": "success", - "message": "file(s) have been deleted" -} -``` diff --git a/docs/en/md/Neocities/File-managment/Delete-selected-files.mdx b/docs/en/md/Neocities/File-managment/Delete-selected-files.mdx new file mode 100644 index 0000000000..a4eafa97ce --- /dev/null +++ b/docs/en/md/Neocities/File-managment/Delete-selected-files.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete selected files + Deletes a file or multiple files from Neocities + + + +`Function DeleteSelectedFiles(Val Token, Val Paths) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | Paths | --paths | String, Array of String | Path or multiple paths of the files to be deleted | + + + Returns: Map Of KeyAndValue - serialized JSON response from Neocities + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Code example" + Token = "7419cd51de4037f7..."; + + Paths = New Array; + Paths.Add("/test/pic1.png"); + Paths.Add("/test/gif.gif"); + Paths.Add("/pic2.png"); + + Result = OPI_Neocities.DeleteSelectedFiles(Token, Paths); +``` + + + + +```json title="Result" +{ + "result": "success", + "message": "file(s) have been deleted" +} +``` diff --git a/docs/en/md/Neocities/File-managment/Get-files-list.md b/docs/en/md/Neocities/File-managment/Get-files-list.md deleted file mode 100644 index 3c0ab54f0a..0000000000 --- a/docs/en/md/Neocities/File-managment/Get-files-list.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get list of files - Gets a list of files with or without directory selection - - - -`Function GetFilesList(Val Token, Val Path = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | Path | --path | String | Selection of files by catalog. All if not filled in | - - - Returns: Map Of KeyAndValue - serialized JSON response from Neocities - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Code example" - Token = "7419cd51de4037f7..."; - Path = "test"; - - Result = OPI_Neocities.GetFilesList(Token, Path); - - Result = OPI_Neocities.GetFilesList(Token); -``` - - - - -```json title="Result" -{ - "result": "success", - "files": [ - { - "path": "test/gif.gif", - "is_directory": false, - "size": 805189, - "created_at": "Wed, 09 Oct 2024 06:27:52 -0000", - "updated_at": "Wed, 09 Oct 2024 06:27:52 -0000", - "sha1_hash": null - }, - { - "path": "test/pic1.png", - "is_directory": false, - "size": 2114023, - "created_at": "Wed, 09 Oct 2024 06:27:52 -0000", - "updated_at": "Wed, 09 Oct 2024 06:27:52 -0000", - "sha1_hash": null - } - ] -} -``` diff --git a/docs/en/md/Neocities/File-managment/Get-files-list.mdx b/docs/en/md/Neocities/File-managment/Get-files-list.mdx new file mode 100644 index 0000000000..8b83e830d4 --- /dev/null +++ b/docs/en/md/Neocities/File-managment/Get-files-list.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get list of files + Gets a list of files with or without directory selection + + + +`Function GetFilesList(Val Token, Val Path = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | Path | --path | String | Selection of files by catalog. All if not filled in | + + + Returns: Map Of KeyAndValue - serialized JSON response from Neocities + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Code example" + Token = "7419cd51de4037f7..."; + Path = "test"; + + Result = OPI_Neocities.GetFilesList(Token, Path); + + Result = OPI_Neocities.GetFilesList(Token); +``` + + + + +```json title="Result" +{ + "result": "success", + "files": [ + { + "path": "test/gif.gif", + "is_directory": false, + "size": 805189, + "created_at": "Wed, 09 Oct 2024 06:27:52 -0000", + "updated_at": "Wed, 09 Oct 2024 06:27:52 -0000", + "sha1_hash": null + }, + { + "path": "test/pic1.png", + "is_directory": false, + "size": 2114023, + "created_at": "Wed, 09 Oct 2024 06:27:52 -0000", + "updated_at": "Wed, 09 Oct 2024 06:27:52 -0000", + "sha1_hash": null + } + ] +} +``` diff --git a/docs/en/md/Neocities/File-managment/Synchronize-folders.md b/docs/en/md/Neocities/File-managment/Synchronize-folders.md deleted file mode 100644 index 10dfccad74..0000000000 --- a/docs/en/md/Neocities/File-managment/Synchronize-folders.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Synchronize folders - Creates a copy of the local directory at the selected path on the Neocities server - - - -`Function SynchronizeFolders(Val Token, Val LocalFolder, Val RemoteFolder = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | LocalFolder | --local | String | Local source catalog | - | RemoteFolder | --remote | String | Remote receiver catalog. Root by default | - - - Returns: Structure of KeyAndValue - synchronization error information - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) - - The method deletes files on the server if they do not exist in the local directory -::: -
- - -```bsl title="Code example" - Token = "7419cd51de4037f7..."; - - LocalFolder = "C:\test_site"; - RemoteFolder = "test_sync"; - - Result = OPI_Neocities.SynchronizeFolders(Token, LocalFolder, RemoteFolder); -``` - - - - -```json title="Result" -{ - "errors": 0, - "items": [] -} -``` diff --git a/docs/en/md/Neocities/File-managment/Synchronize-folders.mdx b/docs/en/md/Neocities/File-managment/Synchronize-folders.mdx new file mode 100644 index 0000000000..34d397fa05 --- /dev/null +++ b/docs/en/md/Neocities/File-managment/Synchronize-folders.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Synchronize folders + Creates a copy of the local directory at the selected path on the Neocities server + + + +`Function SynchronizeFolders(Val Token, Val LocalFolder, Val RemoteFolder = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | LocalFolder | --local | String | Local source catalog | + | RemoteFolder | --remote | String | Remote receiver catalog. Root by default | + + + Returns: Structure of KeyAndValue - synchronization error information + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) + + The method deletes files on the server if they do not exist in the local directory +::: +
+ + +```bsl title="Code example" + Token = "7419cd51de4037f7..."; + + LocalFolder = "C:\test_site"; + RemoteFolder = "test_sync"; + + Result = OPI_Neocities.SynchronizeFolders(Token, LocalFolder, RemoteFolder); +``` + + + + +```json title="Result" +{ + "errors": 0, + "items": [] +} +``` diff --git a/docs/en/md/Neocities/File-managment/Upload-file.md b/docs/en/md/Neocities/File-managment/Upload-file.md deleted file mode 100644 index 3e3ca30080..0000000000 --- a/docs/en/md/Neocities/File-managment/Upload-file.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Upload file - Upload single file to Neocities - - - -`Function UploadFile(Val Token, Val Path, Val Data) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | Path | --path | String | File path on Neocities | - | Data | --file | String, BinaryData | URL, path or file data | - - - Returns: Map Of KeyAndValue - serialized JSON response from Neocities - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Code example" - Token = "7419cd51de4037f7..."; - Data = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data - Path = "testfolder/test_pic.png"; - - Result = OPI_Neocities.UploadFile(Token, Path, Data); -``` - - - - -```json title="Result" -{ - "result": "success", - "message": "your file(s) have been successfully uploaded" -} -``` diff --git a/docs/en/md/Neocities/File-managment/Upload-file.mdx b/docs/en/md/Neocities/File-managment/Upload-file.mdx new file mode 100644 index 0000000000..2a72f8d318 --- /dev/null +++ b/docs/en/md/Neocities/File-managment/Upload-file.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Upload file + Upload single file to Neocities + + + +`Function UploadFile(Val Token, Val Path, Val Data) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | Path | --path | String | File path on Neocities | + | Data | --file | String, BinaryData | URL, path or file data | + + + Returns: Map Of KeyAndValue - serialized JSON response from Neocities + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Code example" + Token = "7419cd51de4037f7..."; + Data = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data + Path = "testfolder/test_pic.png"; + + Result = OPI_Neocities.UploadFile(Token, Path, Data); +``` + + + + +```json title="Result" +{ + "result": "success", + "message": "your file(s) have been successfully uploaded" +} +``` diff --git a/docs/en/md/Neocities/File-managment/Upload-files.md b/docs/en/md/Neocities/File-managment/Upload-files.md deleted file mode 100644 index f639594716..0000000000 --- a/docs/en/md/Neocities/File-managment/Upload-files.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Upload files - Uploads multiple files to Neocities - - - -`Function UploadFiles(Val Token, Val FileMapping, Val Singly = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Auth token | - | FileMapping | --files | Map Of KeyAndValue | Files: Key > destination path on NC, Value > file | - | Singly | --singly | Boolean | True > sends files in separate requests | - - - Returns: Map Of KeyAndValue - serialized JSON response from Neocities - -
- -:::tip -Neocities API docs: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Code example" - Token = "7419cd51de4037f7..."; - - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Path or Binary Data - GIF = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Path or Binary Data - - FileMapping = New Map; - FileMapping.Insert("test/pic1.png", Image1); - FileMapping.Insert("test/gif.gif" , Image2); - FileMapping.Insert("pic2.png" , GIF); - - Result = OPI_Neocities.UploadFiles(Token, FileMapping); -``` - - - - -```json title="Result" -{ - "result": "success", - "message": "your file(s) have been successfully uploaded" -} -``` diff --git a/docs/en/md/Neocities/File-managment/Upload-files.mdx b/docs/en/md/Neocities/File-managment/Upload-files.mdx new file mode 100644 index 0000000000..58383cc358 --- /dev/null +++ b/docs/en/md/Neocities/File-managment/Upload-files.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Upload files + Uploads multiple files to Neocities + + + +`Function UploadFiles(Val Token, Val FileMapping, Val Singly = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Auth token | + | FileMapping | --files | Map Of KeyAndValue | Files: Key > destination path on NC, Value > file | + | Singly | --singly | Boolean | True > sends files in separate requests | + + + Returns: Map Of KeyAndValue - serialized JSON response from Neocities + +
+ +:::tip +Neocities API docs: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Code example" + Token = "7419cd51de4037f7..."; + + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Path or Binary Data + GIF = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Path or Binary Data + + FileMapping = New Map; + FileMapping.Insert("test/pic1.png", Image1); + FileMapping.Insert("test/gif.gif" , Image2); + FileMapping.Insert("pic2.png" , GIF); + + Result = OPI_Neocities.UploadFiles(Token, FileMapping); +``` + + + + +```json title="Result" +{ + "result": "success", + "message": "your file(s) have been successfully uploaded" +} +``` diff --git a/docs/en/md/Notion/Blocks-managment/Create-block.md b/docs/en/md/Notion/Blocks-managment/Create-block.md deleted file mode 100644 index ea4de75896..0000000000 --- a/docs/en/md/Notion/Blocks-managment/Create-block.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create block - Creates a new block based on an existing block - - - -`Function CreateBlock(Val Token, Val Parent, Val Block, Val InsertAfter = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --page | String | Parent block or page ID | - | Block | --block | String, Map Of KeyAndValue | Block ID or block sample itself | - | InsertAfter | --prev | String | Block ID after which to insert the new one | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff986b7511c0779f77"; - Block = "d7021bdd15b944ababcb02bd2b1a5f6a"; - - BlockData = OPI_Notion.ReturnBlock(Token, Block); - Result = OPI_Notion.CreateBlock(Token, Parent, BlockData); -``` - - - - -```json title="Result" -{ - "object": "list", - "results": [ - { - "object": "block", - "id": "11a82aa7-fc4e-817b-994e-c3d1a6fadf1b", - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "created_time": "2024-10-09T06:14:00Z", - "last_edited_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "has_children": false, - "archived": false, - "in_trash": false, - "type": "to_do", - "to_do": { - "rich_text": [ - { - "type": "text", - "text": { - "content": "YoYO", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "YoYO", - "href": null - } - ], - "checked": false, - "color": "default" - } - } - ], - "next_cursor": null, - "has_more": false, - "type": "block", - "block": {}, - "request_id": "f8c21aa2-8ec9-41a8-9bfe-d447541b32e1" -} -``` diff --git a/docs/en/md/Notion/Blocks-managment/Create-block.mdx b/docs/en/md/Notion/Blocks-managment/Create-block.mdx new file mode 100644 index 0000000000..d47fdce775 --- /dev/null +++ b/docs/en/md/Notion/Blocks-managment/Create-block.mdx @@ -0,0 +1,98 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create block + Creates a new block based on an existing block + + + +`Function CreateBlock(Val Token, Val Parent, Val Block, Val InsertAfter = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --page | String | Parent block or page ID | + | Block | --block | String, Map Of KeyAndValue | Block ID or block sample itself | + | InsertAfter | --prev | String | Block ID after which to insert the new one | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff986b7511c0779f77"; + Block = "d7021bdd15b944ababcb02bd2b1a5f6a"; + + BlockData = OPI_Notion.ReturnBlock(Token, Block); + Result = OPI_Notion.CreateBlock(Token, Parent, BlockData); +``` + + + + +```json title="Result" +{ + "object": "list", + "results": [ + { + "object": "block", + "id": "11a82aa7-fc4e-817b-994e-c3d1a6fadf1b", + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "created_time": "2024-10-09T06:14:00Z", + "last_edited_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "has_children": false, + "archived": false, + "in_trash": false, + "type": "to_do", + "to_do": { + "rich_text": [ + { + "type": "text", + "text": { + "content": "YoYO", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "YoYO", + "href": null + } + ], + "checked": false, + "color": "default" + } + } + ], + "next_cursor": null, + "has_more": false, + "type": "block", + "block": {}, + "request_id": "f8c21aa2-8ec9-41a8-9bfe-d447541b32e1" +} +``` diff --git a/docs/en/md/Notion/Blocks-managment/Delete-block.md b/docs/en/md/Notion/Blocks-managment/Delete-block.md deleted file mode 100644 index 8431c234bf..0000000000 --- a/docs/en/md/Notion/Blocks-managment/Delete-block.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete block - Deletes block by ID - - - -`Function DeleteBlock(Val Token, Val BlockID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | BlockID | --block | String | Block ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Block = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; - - Result = OPI_Notion.DeleteBlock(Token, Block); -``` - - - - -```json title="Result" -{ - "object": "block", - "id": "11a82aa7-fc4e-817b-994e-c3d1a6fadf1b", - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "created_time": "2024-10-09T06:14:00Z", - "last_edited_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "has_children": false, - "archived": true, - "in_trash": true, - "type": "to_do", - "to_do": { - "rich_text": [ - { - "type": "text", - "text": { - "content": "YoYO", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "YoYO", - "href": null - } - ], - "checked": false, - "color": "default" - }, - "request_id": "62e67e42-3ae5-4e59-9472-2c72c2be1b62" -} -``` diff --git a/docs/en/md/Notion/Blocks-managment/Delete-block.mdx b/docs/en/md/Notion/Blocks-managment/Delete-block.mdx new file mode 100644 index 0000000000..95d54fedf3 --- /dev/null +++ b/docs/en/md/Notion/Blocks-managment/Delete-block.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete block + Deletes block by ID + + + +`Function DeleteBlock(Val Token, Val BlockID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | BlockID | --block | String | Block ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Block = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; + + Result = OPI_Notion.DeleteBlock(Token, Block); +``` + + + + +```json title="Result" +{ + "object": "block", + "id": "11a82aa7-fc4e-817b-994e-c3d1a6fadf1b", + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "created_time": "2024-10-09T06:14:00Z", + "last_edited_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "has_children": false, + "archived": true, + "in_trash": true, + "type": "to_do", + "to_do": { + "rich_text": [ + { + "type": "text", + "text": { + "content": "YoYO", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "YoYO", + "href": null + } + ], + "checked": false, + "color": "default" + }, + "request_id": "62e67e42-3ae5-4e59-9472-2c72c2be1b62" +} +``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-block.md b/docs/en/md/Notion/Blocks-managment/Return-block.md deleted file mode 100644 index d09ba72a61..0000000000 --- a/docs/en/md/Notion/Blocks-managment/Return-block.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Return block - Returns the block structure by ID - - - -`Function ReturnBlock(Val Token, Val BlockID, Val OnlyBase = True) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | BlockID | --block | String | Block ID | - | OnlyBase | --core | Boolean | True > service fields are deleted, only the block itself remains | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Block = "d7021bdd15b944ababcb02bd2b1a5f6a"; - - Result = OPI_Notion.ReturnBlock(Token, Block); -``` - - - - -```json title="Result" -{ - "object": "block", - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "in_trash": true, - "type": "to_do", - "to_do": { - "rich_text": [ - { - "type": "text", - "text": { - "content": "YoYO", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "YoYO", - "href": null - } - ], - "checked": false, - "color": "default" - } -} -``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-block.mdx b/docs/en/md/Notion/Blocks-managment/Return-block.mdx new file mode 100644 index 0000000000..645e086d0f --- /dev/null +++ b/docs/en/md/Notion/Blocks-managment/Return-block.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Return block + Returns the block structure by ID + + + +`Function ReturnBlock(Val Token, Val BlockID, Val OnlyBase = True) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | BlockID | --block | String | Block ID | + | OnlyBase | --core | Boolean | True > service fields are deleted, only the block itself remains | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Block = "d7021bdd15b944ababcb02bd2b1a5f6a"; + + Result = OPI_Notion.ReturnBlock(Token, Block); +``` + + + + +```json title="Result" +{ + "object": "block", + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "in_trash": true, + "type": "to_do", + "to_do": { + "rich_text": [ + { + "type": "text", + "text": { + "content": "YoYO", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "YoYO", + "href": null + } + ], + "checked": false, + "color": "default" + } +} +``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md deleted file mode 100644 index e9b5b95cdf..0000000000 --- a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Return child blocks - Returns list of child blocks of parent block - - - -`Function ReturnChildBlocks(Val Token, Val BlockID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | BlockID | --block | String | Parent block ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Block = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; - - Result = OPI_Notion.ReturnChildBlocks(Token, Block); -``` - - - - -```json title="Result" -{ - "object": "list", - "results": [], - "next_cursor": null, - "has_more": false, - "type": "block", - "block": {}, - "request_id": "8e767421-eb28-4a76-ab19-60cea883414e" -} -``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.mdx b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.mdx new file mode 100644 index 0000000000..f6bbda3fba --- /dev/null +++ b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Return child blocks + Returns list of child blocks of parent block + + + +`Function ReturnChildBlocks(Val Token, Val BlockID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | BlockID | --block | String | Parent block ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Block = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; + + Result = OPI_Notion.ReturnChildBlocks(Token, Block); +``` + + + + +```json title="Result" +{ + "object": "list", + "results": [], + "next_cursor": null, + "has_more": false, + "type": "block", + "block": {}, + "request_id": "8e767421-eb28-4a76-ab19-60cea883414e" +} +``` diff --git a/docs/en/md/Notion/Database-management/Create-database.md b/docs/en/md/Notion/Database-management/Create-database.md deleted file mode 100644 index 324f67a126..0000000000 --- a/docs/en/md/Notion/Database-management/Create-database.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create database - Creates a database - - - -`Function CreateDatabase(Val Token, Val Parent, Val Title, Val Properties = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --page | String | Parent page ID | - | Title | --title | String | Database title | - | Properties | --props | Structure Of String | Database properties | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff986b7511c0779f77"; - Title = "TestTitle"; - - Properties = New Map; - Properties.Insert("Name" , "title"); - Properties.Insert("Description" , "rich_text"); - Properties.Insert("Number" , "number"); - Properties.Insert("Status" , "status"); - Properties.Insert("CreationDate" , "date"); - Properties.Insert("Image" , "files"); - Properties.Insert("Active" , "checkbox"); - Properties.Insert("Website" , "url"); - Properties.Insert("Email" , "email"); - Properties.Insert("Phone" , "phone_number"); - Properties.Insert("User" , "people"); - - ValueSelection = New Map; - ValueSelection.Insert("New" , "green"); - ValueSelection.Insert("InProgress" , "yellow"); - ValueSelection.Insert("Remote" , "red"); - - Properties.Insert("Status", ValueSelection); - - Result = OPI_Notion.CreateDatabase(Token, Parent, Title, Properties); -``` - - - - -```json title="Result" -{ - "object": "database", - "id": "11a82aa7-fc4e-8138-a724-ee8786147d82", - "cover": null, - "icon": null, - "created_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_time": "2024-10-09T06:14:00Z", - "title": [ - { - "type": "text", - "text": { - "content": "TestTitle", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "TestTitle", - "href": null - } - ], - "description": [], - "is_inline": false, - "properties": { - "Description": { - "id": "%3COFd", - "name": "Description", - "type": "rich_text", - "rich_text": {} - }, - "Phone": { - "id": "Ne%7DI", - "name": "Phone", - "type": "phone_number", - "phone_number": {} - }, - "CreationDate": { - "id": "P%3Doo", - "name": "CreationDate", - "type": "date", - "date": {} - }, - "Active": { - "id": "Ub%7C%5D", - "name": "Active", - "type": "checkbox", - "checkbox": {} - }, - "Number": { - "id": "%5Dotl", - "name": "Number", - "type": "number", - "number": { - "format": "number" - } - }, - "Email": { - "id": "%60%7DN%3F", - "name": "Email", - "type": "email", - "email": {} - }, - "Status": { - "id": "bAZ%7D", - "name": "Status", - "type": "select", - "select": { - "options": [ - { - "id": "0e626378-0386-4985-88de-b747968504e7", - "name": "New", - "color": "green", - "description": null - }, - { - "id": "e9a7ad5c-196f-4b2a-b2de-e84e849f2183", - "name": "InProgress", - "color": "yellow", - "description": null - }, - { - "id": "1b214a08-6768-4381-b3cb-d8dd88250f8c", - "name": "Remote", - "color": "red", - "description": null - } - ] - } - }, - "Website": { - "id": "fd%3F%60", - "name": "Website", - "type": "url", - "url": {} - }, - "User": { - "id": "%7B%3Bsu", - "name": "User", - "type": "people", - "people": {} - }, - "Image": { - "id": "%7B%3F%5B%3F", - "name": "Image", - "type": "files", - "files": {} - }, - "Name": { - "id": "title", - "name": "Name", - "type": "title", - "title": {} - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "url": "https://www.notion.so/11a82aa7fc4e8138a724ee8786147d82", - "public_url": null, - "archived": false, - "in_trash": false, - "request_id": "6abe3614-54de-4d28-8771-1e641c3a5828" -} -``` diff --git a/docs/en/md/Notion/Database-management/Create-database.mdx b/docs/en/md/Notion/Database-management/Create-database.mdx new file mode 100644 index 0000000000..f999137ae3 --- /dev/null +++ b/docs/en/md/Notion/Database-management/Create-database.mdx @@ -0,0 +1,199 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create database + Creates a database + + + +`Function CreateDatabase(Val Token, Val Parent, Val Title, Val Properties = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --page | String | Parent page ID | + | Title | --title | String | Database title | + | Properties | --props | Structure Of String | Database properties | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff986b7511c0779f77"; + Title = "TestTitle"; + + Properties = New Map; + Properties.Insert("Name" , "title"); + Properties.Insert("Description" , "rich_text"); + Properties.Insert("Number" , "number"); + Properties.Insert("Status" , "status"); + Properties.Insert("CreationDate" , "date"); + Properties.Insert("Image" , "files"); + Properties.Insert("Active" , "checkbox"); + Properties.Insert("Website" , "url"); + Properties.Insert("Email" , "email"); + Properties.Insert("Phone" , "phone_number"); + Properties.Insert("User" , "people"); + + ValueSelection = New Map; + ValueSelection.Insert("New" , "green"); + ValueSelection.Insert("InProgress" , "yellow"); + ValueSelection.Insert("Remote" , "red"); + + Properties.Insert("Status", ValueSelection); + + Result = OPI_Notion.CreateDatabase(Token, Parent, Title, Properties); +``` + + + + +```json title="Result" +{ + "object": "database", + "id": "11a82aa7-fc4e-8138-a724-ee8786147d82", + "cover": null, + "icon": null, + "created_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_time": "2024-10-09T06:14:00Z", + "title": [ + { + "type": "text", + "text": { + "content": "TestTitle", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "TestTitle", + "href": null + } + ], + "description": [], + "is_inline": false, + "properties": { + "Description": { + "id": "%3COFd", + "name": "Description", + "type": "rich_text", + "rich_text": {} + }, + "Phone": { + "id": "Ne%7DI", + "name": "Phone", + "type": "phone_number", + "phone_number": {} + }, + "CreationDate": { + "id": "P%3Doo", + "name": "CreationDate", + "type": "date", + "date": {} + }, + "Active": { + "id": "Ub%7C%5D", + "name": "Active", + "type": "checkbox", + "checkbox": {} + }, + "Number": { + "id": "%5Dotl", + "name": "Number", + "type": "number", + "number": { + "format": "number" + } + }, + "Email": { + "id": "%60%7DN%3F", + "name": "Email", + "type": "email", + "email": {} + }, + "Status": { + "id": "bAZ%7D", + "name": "Status", + "type": "select", + "select": { + "options": [ + { + "id": "0e626378-0386-4985-88de-b747968504e7", + "name": "New", + "color": "green", + "description": null + }, + { + "id": "e9a7ad5c-196f-4b2a-b2de-e84e849f2183", + "name": "InProgress", + "color": "yellow", + "description": null + }, + { + "id": "1b214a08-6768-4381-b3cb-d8dd88250f8c", + "name": "Remote", + "color": "red", + "description": null + } + ] + } + }, + "Website": { + "id": "fd%3F%60", + "name": "Website", + "type": "url", + "url": {} + }, + "User": { + "id": "%7B%3Bsu", + "name": "User", + "type": "people", + "people": {} + }, + "Image": { + "id": "%7B%3F%5B%3F", + "name": "Image", + "type": "files", + "files": {} + }, + "Name": { + "id": "title", + "name": "Name", + "type": "title", + "title": {} + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "url": "https://www.notion.so/11a82aa7fc4e8138a724ee8786147d82", + "public_url": null, + "archived": false, + "in_trash": false, + "request_id": "6abe3614-54de-4d28-8771-1e641c3a5828" +} +``` diff --git a/docs/en/md/Notion/Database-management/Edit-database-properties.md b/docs/en/md/Notion/Database-management/Edit-database-properties.md deleted file mode 100644 index 3d03e4dff3..0000000000 --- a/docs/en/md/Notion/Database-management/Edit-database-properties.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Edit database properties - Edits properties of an existing database - - - -`Function EditDatabaseProperties(Val Token, Val Base, Val Properties = "", Val Title = "", Val Description = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Target database ID | - | Properties | --props | Map of KeyAndValue | New or modified database properties | - | Title | --title | String | New database title | - | Description | --description | String | New database description | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Base = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; - - Title = "TestTitle"; - Description = "TestDescription"; - - Properties = New Map; - Properties.Insert("Email", "rich_text"); // Type fields "Email" will changed with email to text - Properties.Insert("Website"); // Field "Website" will deleted - - Result = OPI_Notion.EditDatabaseProperties(Token, Base, Properties, Title, Description); -``` - - - - -```json title="Result" -{ - "object": "database", - "id": "11a82aa7-fc4e-8138-a724-ee8786147d82", - "cover": null, - "icon": null, - "created_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_time": "2024-10-09T06:14:00Z", - "title": [ - { - "type": "text", - "text": { - "content": "TestTitle", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "TestTitle", - "href": null - } - ], - "description": [ - { - "type": "text", - "text": { - "content": "TestDescription", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "TestDescription", - "href": null - } - ], - "is_inline": false, - "properties": { - "Description": { - "id": "%3COFd", - "name": "Description", - "type": "rich_text", - "rich_text": {} - }, - "Phone": { - "id": "Ne%7DI", - "name": "Phone", - "type": "phone_number", - "phone_number": {} - }, - "CreationDate": { - "id": "P%3Doo", - "name": "CreationDate", - "type": "date", - "date": {} - }, - "Active": { - "id": "Ub%7C%5D", - "name": "Active", - "type": "checkbox", - "checkbox": {} - }, - "Number": { - "id": "%5Dotl", - "name": "Number", - "type": "number", - "number": { - "format": "number" - } - }, - "Email": { - "id": "%60%7DN%3F", - "name": "Email", - "type": "rich_text", - "rich_text": {} - }, - "Status": { - "id": "bAZ%7D", - "name": "Status", - "type": "select", - "select": { - "options": [ - { - "id": "0e626378-0386-4985-88de-b747968504e7", - "name": "New", - "color": "green", - "description": null - }, - { - "id": "e9a7ad5c-196f-4b2a-b2de-e84e849f2183", - "name": "InProgress", - "color": "yellow", - "description": null - }, - { - "id": "1b214a08-6768-4381-b3cb-d8dd88250f8c", - "name": "Remote", - "color": "red", - "description": null - } - ] - } - }, - "User": { - "id": "%7B%3Bsu", - "name": "User", - "type": "people", - "people": {} - }, - "Image": { - "id": "%7B%3F%5B%3F", - "name": "Image", - "type": "files", - "files": {} - }, - "Name": { - "id": "title", - "name": "Name", - "type": "title", - "title": {} - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "url": "https://www.notion.so/11a82aa7fc4e8138a724ee8786147d82", - "public_url": null, - "archived": false, - "in_trash": false, - "request_id": "2db0d0b9-71b2-45a9-87bc-e25489f09cf3" -} -``` diff --git a/docs/en/md/Notion/Database-management/Edit-database-properties.mdx b/docs/en/md/Notion/Database-management/Edit-database-properties.mdx new file mode 100644 index 0000000000..a1711a0903 --- /dev/null +++ b/docs/en/md/Notion/Database-management/Edit-database-properties.mdx @@ -0,0 +1,198 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Edit database properties + Edits properties of an existing database + + + +`Function EditDatabaseProperties(Val Token, Val Base, Val Properties = "", Val Title = "", Val Description = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Target database ID | + | Properties | --props | Map of KeyAndValue | New or modified database properties | + | Title | --title | String | New database title | + | Description | --description | String | New database description | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Base = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; + + Title = "TestTitle"; + Description = "TestDescription"; + + Properties = New Map; + Properties.Insert("Email", "rich_text"); // Type fields "Email" will changed with email to text + Properties.Insert("Website"); // Field "Website" will deleted + + Result = OPI_Notion.EditDatabaseProperties(Token, Base, Properties, Title, Description); +``` + + + + +```json title="Result" +{ + "object": "database", + "id": "11a82aa7-fc4e-8138-a724-ee8786147d82", + "cover": null, + "icon": null, + "created_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_time": "2024-10-09T06:14:00Z", + "title": [ + { + "type": "text", + "text": { + "content": "TestTitle", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "TestTitle", + "href": null + } + ], + "description": [ + { + "type": "text", + "text": { + "content": "TestDescription", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "TestDescription", + "href": null + } + ], + "is_inline": false, + "properties": { + "Description": { + "id": "%3COFd", + "name": "Description", + "type": "rich_text", + "rich_text": {} + }, + "Phone": { + "id": "Ne%7DI", + "name": "Phone", + "type": "phone_number", + "phone_number": {} + }, + "CreationDate": { + "id": "P%3Doo", + "name": "CreationDate", + "type": "date", + "date": {} + }, + "Active": { + "id": "Ub%7C%5D", + "name": "Active", + "type": "checkbox", + "checkbox": {} + }, + "Number": { + "id": "%5Dotl", + "name": "Number", + "type": "number", + "number": { + "format": "number" + } + }, + "Email": { + "id": "%60%7DN%3F", + "name": "Email", + "type": "rich_text", + "rich_text": {} + }, + "Status": { + "id": "bAZ%7D", + "name": "Status", + "type": "select", + "select": { + "options": [ + { + "id": "0e626378-0386-4985-88de-b747968504e7", + "name": "New", + "color": "green", + "description": null + }, + { + "id": "e9a7ad5c-196f-4b2a-b2de-e84e849f2183", + "name": "InProgress", + "color": "yellow", + "description": null + }, + { + "id": "1b214a08-6768-4381-b3cb-d8dd88250f8c", + "name": "Remote", + "color": "red", + "description": null + } + ] + } + }, + "User": { + "id": "%7B%3Bsu", + "name": "User", + "type": "people", + "people": {} + }, + "Image": { + "id": "%7B%3F%5B%3F", + "name": "Image", + "type": "files", + "files": {} + }, + "Name": { + "id": "title", + "name": "Name", + "type": "title", + "title": {} + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "url": "https://www.notion.so/11a82aa7fc4e8138a724ee8786147d82", + "public_url": null, + "archived": false, + "in_trash": false, + "request_id": "2db0d0b9-71b2-45a9-87bc-e25489f09cf3" +} +``` diff --git a/docs/en/md/Notion/Database-management/Get-database.md b/docs/en/md/Notion/Database-management/Get-database.md deleted file mode 100644 index 8991b71ce5..0000000000 --- a/docs/en/md/Notion/Database-management/Get-database.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get database - Get database information - - - -`Function GetDatabase(Val Token, Val Base) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Base = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; - - Result = OPI_Notion.GetDatabase(Token, Base); -``` - - - - -```json title="Result" -{ - "object": "database", - "id": "11a82aa7-fc4e-8138-a724-ee8786147d82", - "cover": null, - "icon": null, - "created_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_time": "2024-10-09T06:14:00Z", - "title": [ - { - "type": "text", - "text": { - "content": "TestTitle", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "TestTitle", - "href": null - } - ], - "description": [ - { - "type": "text", - "text": { - "content": "TestDescription", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "TestDescription", - "href": null - } - ], - "is_inline": false, - "properties": { - "Description": { - "id": "%3COFd", - "name": "Description", - "type": "rich_text", - "rich_text": {} - }, - "Phone": { - "id": "Ne%7DI", - "name": "Phone", - "type": "phone_number", - "phone_number": {} - }, - "CreationDate": { - "id": "P%3Doo", - "name": "CreationDate", - "type": "date", - "date": {} - }, - "Active": { - "id": "Ub%7C%5D", - "name": "Active", - "type": "checkbox", - "checkbox": {} - }, - "Number": { - "id": "%5Dotl", - "name": "Number", - "type": "number", - "number": { - "format": "number" - } - }, - "Email": { - "id": "%60%7DN%3F", - "name": "Email", - "type": "rich_text", - "rich_text": {} - }, - "Status": { - "id": "bAZ%7D", - "name": "Status", - "type": "select", - "select": { - "options": [ - { - "id": "0e626378-0386-4985-88de-b747968504e7", - "name": "New", - "color": "green", - "description": null - }, - { - "id": "e9a7ad5c-196f-4b2a-b2de-e84e849f2183", - "name": "InProgress", - "color": "yellow", - "description": null - }, - { - "id": "1b214a08-6768-4381-b3cb-d8dd88250f8c", - "name": "Remote", - "color": "red", - "description": null - } - ] - } - }, - "User": { - "id": "%7B%3Bsu", - "name": "User", - "type": "people", - "people": {} - }, - "Image": { - "id": "%7B%3F%5B%3F", - "name": "Image", - "type": "files", - "files": {} - }, - "Name": { - "id": "title", - "name": "Name", - "type": "title", - "title": {} - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "url": "https://www.notion.so/11a82aa7fc4e8138a724ee8786147d82", - "public_url": null, - "archived": false, - "in_trash": false, - "request_id": "6bee1b66-c2c7-47c4-96a3-54c83460045a" -} -``` diff --git a/docs/en/md/Notion/Database-management/Get-database.mdx b/docs/en/md/Notion/Database-management/Get-database.mdx new file mode 100644 index 0000000000..ffb7c7a89f --- /dev/null +++ b/docs/en/md/Notion/Database-management/Get-database.mdx @@ -0,0 +1,188 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get database + Get database information + + + +`Function GetDatabase(Val Token, Val Base) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Base = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; + + Result = OPI_Notion.GetDatabase(Token, Base); +``` + + + + +```json title="Result" +{ + "object": "database", + "id": "11a82aa7-fc4e-8138-a724-ee8786147d82", + "cover": null, + "icon": null, + "created_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_time": "2024-10-09T06:14:00Z", + "title": [ + { + "type": "text", + "text": { + "content": "TestTitle", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "TestTitle", + "href": null + } + ], + "description": [ + { + "type": "text", + "text": { + "content": "TestDescription", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "TestDescription", + "href": null + } + ], + "is_inline": false, + "properties": { + "Description": { + "id": "%3COFd", + "name": "Description", + "type": "rich_text", + "rich_text": {} + }, + "Phone": { + "id": "Ne%7DI", + "name": "Phone", + "type": "phone_number", + "phone_number": {} + }, + "CreationDate": { + "id": "P%3Doo", + "name": "CreationDate", + "type": "date", + "date": {} + }, + "Active": { + "id": "Ub%7C%5D", + "name": "Active", + "type": "checkbox", + "checkbox": {} + }, + "Number": { + "id": "%5Dotl", + "name": "Number", + "type": "number", + "number": { + "format": "number" + } + }, + "Email": { + "id": "%60%7DN%3F", + "name": "Email", + "type": "rich_text", + "rich_text": {} + }, + "Status": { + "id": "bAZ%7D", + "name": "Status", + "type": "select", + "select": { + "options": [ + { + "id": "0e626378-0386-4985-88de-b747968504e7", + "name": "New", + "color": "green", + "description": null + }, + { + "id": "e9a7ad5c-196f-4b2a-b2de-e84e849f2183", + "name": "InProgress", + "color": "yellow", + "description": null + }, + { + "id": "1b214a08-6768-4381-b3cb-d8dd88250f8c", + "name": "Remote", + "color": "red", + "description": null + } + ] + } + }, + "User": { + "id": "%7B%3Bsu", + "name": "User", + "type": "people", + "people": {} + }, + "Image": { + "id": "%7B%3F%5B%3F", + "name": "Image", + "type": "files", + "files": {} + }, + "Name": { + "id": "title", + "name": "Name", + "type": "title", + "title": {} + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "url": "https://www.notion.so/11a82aa7fc4e8138a724ee8786147d82", + "public_url": null, + "archived": false, + "in_trash": false, + "request_id": "6bee1b66-c2c7-47c4-96a3-54c83460045a" +} +``` diff --git a/docs/en/md/Notion/Page-management/Create-page-in-database.md b/docs/en/md/Notion/Page-management/Create-page-in-database.md deleted file mode 100644 index 39755dc317..0000000000 --- a/docs/en/md/Notion/Page-management/Create-page-in-database.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create page in database - Creates a page in the parent database - - - -`Function CreatePageInDatabase(Val Token, Val Parent, Val Data) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --base | String | Parent database ID | - | Data | --data | Map Of KeyAndValue | Properties map | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Base = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; - Image_ = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file - - Image = New Map; - Image.Insert("Logo", Image_); - - Properties = New Map; - Properties.Insert("Name" , "LLC Vector"); - Properties.Insert("Description" , "OurFirstClient"); - Properties.Insert("Number" , 1); - Properties.Insert("Status" , "Regular"); - Properties.Insert("CreationDate" , OPI_Tools.GetCurrentDate()); - Properties.Insert("Image" , Image); - Properties.Insert("Active" , True); - Properties.Insert("Website" , "https://vector.ru"); - Properties.Insert("Email" , "mail@vector.ru"); - Properties.Insert("Phone" , "88005553535"); - Properties.Insert("Status" , "New"); - - Result = OPI_Notion.CreatePageInDatabase(Token, Base, Properties); -``` - - - - -```json title="Result" -{ - "object": "page", - "id": "11a82aa7-fc4e-8196-95c5-d8db91cb3fb1", - "created_time": "2024-10-09T06:14:00Z", - "last_edited_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": null, - "icon": null, - "parent": { - "type": "database_id", - "database_id": "11a82aa7-fc4e-8138-a724-ee8786147d82" - }, - "archived": false, - "in_trash": false, - "properties": { - "Description": { - "id": "%3COFd", - "type": "rich_text", - "rich_text": [ - { - "type": "text", - "text": { - "content": "OurFirstClient", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "OurFirstClient", - "href": null - } - ] - }, - "Phone": { - "id": "Ne%7DI", - "type": "phone_number", - "phone_number": "88005553535" - }, - "CreationDate": { - "id": "P%3Doo", - "type": "date", - "date": { - "start": "2024-10-09T12:14:00+03:00", - "end": null, - "time_zone": null - } - }, - "Active": { - "id": "Ub%7C%5D", - "type": "checkbox", - "checkbox": true - }, - "Number": { - "id": "%5Dotl", - "type": "number", - "number": 1 - }, - "Email": { - "id": "%60%7DN%3F", - "type": "rich_text", - "rich_text": [ - { - "type": "text", - "text": { - "content": "mail@vector.ru", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "mail@vector.ru", - "href": null - } - ] - }, - "Status": { - "id": "bAZ%7D", - "type": "select", - "select": { - "id": "0e626378-0386-4985-88de-b747968504e7", - "name": "New", - "color": "green" - } - }, - "User": { - "id": "%7B%3Bsu", - "type": "people", - "people": [] - }, - "Image": { - "id": "%7B%3F%5B%3F", - "type": "files", - "files": [ - { - "name": "Logo", - "type": "external", - "external": { - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - } - } - ] - }, - "Name": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "LLC Vector", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "LLC Vector", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/LLC-Vector-11a82aa7fc4e819695c5d8db91cb3fb1", - "public_url": null, - "request_id": "32934a59-8bbd-495e-b65a-559df6d5762f" -} -``` diff --git a/docs/en/md/Notion/Page-management/Create-page-in-database.mdx b/docs/en/md/Notion/Page-management/Create-page-in-database.mdx new file mode 100644 index 0000000000..96894b1409 --- /dev/null +++ b/docs/en/md/Notion/Page-management/Create-page-in-database.mdx @@ -0,0 +1,204 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create page in database + Creates a page in the parent database + + + +`Function CreatePageInDatabase(Val Token, Val Parent, Val Data) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --base | String | Parent database ID | + | Data | --data | Map Of KeyAndValue | Properties map | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Base = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; + Image_ = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file + + Image = New Map; + Image.Insert("Logo", Image_); + + Properties = New Map; + Properties.Insert("Name" , "LLC Vector"); + Properties.Insert("Description" , "OurFirstClient"); + Properties.Insert("Number" , 1); + Properties.Insert("Status" , "Regular"); + Properties.Insert("CreationDate" , OPI_Tools.GetCurrentDate()); + Properties.Insert("Image" , Image); + Properties.Insert("Active" , True); + Properties.Insert("Website" , "https://vector.ru"); + Properties.Insert("Email" , "mail@vector.ru"); + Properties.Insert("Phone" , "88005553535"); + Properties.Insert("Status" , "New"); + + Result = OPI_Notion.CreatePageInDatabase(Token, Base, Properties); +``` + + + + +```json title="Result" +{ + "object": "page", + "id": "11a82aa7-fc4e-8196-95c5-d8db91cb3fb1", + "created_time": "2024-10-09T06:14:00Z", + "last_edited_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": null, + "icon": null, + "parent": { + "type": "database_id", + "database_id": "11a82aa7-fc4e-8138-a724-ee8786147d82" + }, + "archived": false, + "in_trash": false, + "properties": { + "Description": { + "id": "%3COFd", + "type": "rich_text", + "rich_text": [ + { + "type": "text", + "text": { + "content": "OurFirstClient", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "OurFirstClient", + "href": null + } + ] + }, + "Phone": { + "id": "Ne%7DI", + "type": "phone_number", + "phone_number": "88005553535" + }, + "CreationDate": { + "id": "P%3Doo", + "type": "date", + "date": { + "start": "2024-10-09T12:14:00+03:00", + "end": null, + "time_zone": null + } + }, + "Active": { + "id": "Ub%7C%5D", + "type": "checkbox", + "checkbox": true + }, + "Number": { + "id": "%5Dotl", + "type": "number", + "number": 1 + }, + "Email": { + "id": "%60%7DN%3F", + "type": "rich_text", + "rich_text": [ + { + "type": "text", + "text": { + "content": "mail@vector.ru", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "mail@vector.ru", + "href": null + } + ] + }, + "Status": { + "id": "bAZ%7D", + "type": "select", + "select": { + "id": "0e626378-0386-4985-88de-b747968504e7", + "name": "New", + "color": "green" + } + }, + "User": { + "id": "%7B%3Bsu", + "type": "people", + "people": [] + }, + "Image": { + "id": "%7B%3F%5B%3F", + "type": "files", + "files": [ + { + "name": "Logo", + "type": "external", + "external": { + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + } + } + ] + }, + "Name": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "LLC Vector", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "LLC Vector", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/LLC-Vector-11a82aa7fc4e819695c5d8db91cb3fb1", + "public_url": null, + "request_id": "32934a59-8bbd-495e-b65a-559df6d5762f" +} +``` diff --git a/docs/en/md/Notion/Page-management/Create-page.md b/docs/en/md/Notion/Page-management/Create-page.md deleted file mode 100644 index 5aecfffe0e..0000000000 --- a/docs/en/md/Notion/Page-management/Create-page.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create page - Creates a child page above another parent page - - - -`Function CreatePage(Val Token, Val Parent, Val Title) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --page | String | Parent ID | - | Title | --title | String | Page title | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff986b7511c0779f77"; - Title = "TestTitle"; - - Result = OPI_Notion.CreatePage(Token, Parent, Title); -``` - - - - -```json title="Result" -{ - "object": "page", - "id": "11a82aa7-fc4e-8198-ad23-eeb2e6ea678f", - "created_time": "2024-10-09T06:14:00Z", - "last_edited_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": null, - "icon": null, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "archived": false, - "in_trash": false, - "properties": { - "title": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "title", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "title", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/title-11a82aa7fc4e8198ad23eeb2e6ea678f", - "public_url": null, - "request_id": "17934ae2-309f-4eb5-9123-bd100ad5a559" -} -``` diff --git a/docs/en/md/Notion/Page-management/Create-page.mdx b/docs/en/md/Notion/Page-management/Create-page.mdx new file mode 100644 index 0000000000..8645781cec --- /dev/null +++ b/docs/en/md/Notion/Page-management/Create-page.mdx @@ -0,0 +1,91 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create page + Creates a child page above another parent page + + + +`Function CreatePage(Val Token, Val Parent, Val Title) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --page | String | Parent ID | + | Title | --title | String | Page title | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff986b7511c0779f77"; + Title = "TestTitle"; + + Result = OPI_Notion.CreatePage(Token, Parent, Title); +``` + + + + +```json title="Result" +{ + "object": "page", + "id": "11a82aa7-fc4e-8198-ad23-eeb2e6ea678f", + "created_time": "2024-10-09T06:14:00Z", + "last_edited_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": null, + "icon": null, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "archived": false, + "in_trash": false, + "properties": { + "title": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "title", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "title", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/title-11a82aa7fc4e8198ad23eeb2e6ea678f", + "public_url": null, + "request_id": "17934ae2-309f-4eb5-9123-bd100ad5a559" +} +``` diff --git a/docs/en/md/Notion/Page-management/Edit-page-properties.md b/docs/en/md/Notion/Page-management/Edit-page-properties.md deleted file mode 100644 index 9ecd4f6cf8..0000000000 --- a/docs/en/md/Notion/Page-management/Edit-page-properties.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Edit page properties - Changes the properties of an existing page - - - -`Function EditPageProperties(Val Token, Val Page, Val Data = "", Val Icon = "", Val Cover = "", Val Archived = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Page | --page | String | ID of the page being modified | - | Data | --data | Map Of KeyAndValue | Map of editable parameters | - | Icon | --icon | String | URL of the page icon image | - | Cover | --cover | String | URL of the page cover image | - | Archived | --archive | Boolean | Archive page or not (boolean) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Page = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; - Icon = "https://api.athenaeum.digital/test_data/picture.jpg"; - Cover = "https://api.athenaeum.digital/test_data/picture2.jpg"; - Archive = False; - - Properties = New Map; - Properties.Insert("Active" , False); - Properties.Insert("Email" , "vector@mail.ru"); - - Result = OPI_Notion.EditPageProperties(Token - , Page - , Properties - , Icon - , Cover - , Archive); -``` - - - - -```json title="Result" -{ - "object": "page", - "id": "11a82aa7-fc4e-8198-ad23-eeb2e6ea678f", - "created_time": "2024-10-09T06:14:00Z", - "last_edited_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": { - "type": "external", - "external": { - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" - } - }, - "icon": { - "type": "external", - "external": { - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "archived": false, - "in_trash": false, - "properties": { - "title": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "title", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "title", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/title-11a82aa7fc4e8198ad23eeb2e6ea678f", - "public_url": null, - "request_id": "e069f5c5-7f34-4674-b438-48d3c6042971" -} -``` diff --git a/docs/en/md/Notion/Page-management/Edit-page-properties.mdx b/docs/en/md/Notion/Page-management/Edit-page-properties.mdx new file mode 100644 index 0000000000..3a111afd3b --- /dev/null +++ b/docs/en/md/Notion/Page-management/Edit-page-properties.mdx @@ -0,0 +1,115 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Edit page properties + Changes the properties of an existing page + + + +`Function EditPageProperties(Val Token, Val Page, Val Data = "", Val Icon = "", Val Cover = "", Val Archived = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Page | --page | String | ID of the page being modified | + | Data | --data | Map Of KeyAndValue | Map of editable parameters | + | Icon | --icon | String | URL of the page icon image | + | Cover | --cover | String | URL of the page cover image | + | Archived | --archive | Boolean | Archive page or not (boolean) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Page = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; + Icon = "https://api.athenaeum.digital/test_data/picture.jpg"; + Cover = "https://api.athenaeum.digital/test_data/picture2.jpg"; + Archive = False; + + Properties = New Map; + Properties.Insert("Active" , False); + Properties.Insert("Email" , "vector@mail.ru"); + + Result = OPI_Notion.EditPageProperties(Token + , Page + , Properties + , Icon + , Cover + , Archive); +``` + + + + +```json title="Result" +{ + "object": "page", + "id": "11a82aa7-fc4e-8198-ad23-eeb2e6ea678f", + "created_time": "2024-10-09T06:14:00Z", + "last_edited_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": { + "type": "external", + "external": { + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" + } + }, + "icon": { + "type": "external", + "external": { + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "archived": false, + "in_trash": false, + "properties": { + "title": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "title", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "title", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/title-11a82aa7fc4e8198ad23eeb2e6ea678f", + "public_url": null, + "request_id": "e069f5c5-7f34-4674-b438-48d3c6042971" +} +``` diff --git a/docs/en/md/Notion/Page-management/Get-page.md b/docs/en/md/Notion/Page-management/Get-page.md deleted file mode 100644 index 3a4d574def..0000000000 --- a/docs/en/md/Notion/Page-management/Get-page.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get page - Gets information about the page by ID - - - -`Function GetPage(Val Token, Val Page) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Page | --page | String | Page ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Page = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; - - Result = OPI_Notion.GetPage(Token, Page); -``` - - - - -```json title="Result" -{ - "object": "page", - "id": "11a82aa7-fc4e-8198-ad23-eeb2e6ea678f", - "created_time": "2024-10-09T06:14:00Z", - "last_edited_time": "2024-10-09T06:14:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": null, - "icon": null, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "archived": false, - "in_trash": false, - "properties": { - "title": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "title", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "title", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/title-11a82aa7fc4e8198ad23eeb2e6ea678f", - "public_url": null, - "request_id": "73d93b68-a4cf-48cb-ba49-0f24a81661ce" -} -``` diff --git a/docs/en/md/Notion/Page-management/Get-page.mdx b/docs/en/md/Notion/Page-management/Get-page.mdx new file mode 100644 index 0000000000..d6f078ad62 --- /dev/null +++ b/docs/en/md/Notion/Page-management/Get-page.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get page + Gets information about the page by ID + + + +`Function GetPage(Val Token, Val Page) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Page | --page | String | Page ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Page = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; + + Result = OPI_Notion.GetPage(Token, Page); +``` + + + + +```json title="Result" +{ + "object": "page", + "id": "11a82aa7-fc4e-8198-ad23-eeb2e6ea678f", + "created_time": "2024-10-09T06:14:00Z", + "last_edited_time": "2024-10-09T06:14:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": null, + "icon": null, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "archived": false, + "in_trash": false, + "properties": { + "title": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "title", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "title", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/title-11a82aa7fc4e8198ad23eeb2e6ea678f", + "public_url": null, + "request_id": "73d93b68-a4cf-48cb-ba49-0f24a81661ce" +} +``` diff --git a/docs/en/md/Notion/Users/Get-user-data.md b/docs/en/md/Notion/Users/Get-user-data.md deleted file mode 100644 index 6aeb6f2bbc..0000000000 --- a/docs/en/md/Notion/Users/Get-user-data.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get user data - Gets user data by ID - - - -`Function GetUserData(Val Token, Val UserID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | UserID | --user | String | Target user ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - User = "ed71865a-9891-46bc-86cd-a92aa499cfdb"; - - Result = OPI_Notion.GetUserData(Token, User); -``` - - - - -```json title="Result" -{ - "object": "user", - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "name": "Techno Pizza", - "avatar_url": null, - "type": "person", - "person": { - "email": "iscript13@gmail.com" - }, - "request_id": "a6fc9071-fac0-4069-84ba-e724b783d9ce" -} -``` diff --git a/docs/en/md/Notion/Users/Get-user-data.mdx b/docs/en/md/Notion/Users/Get-user-data.mdx new file mode 100644 index 0000000000..72c914ea3c --- /dev/null +++ b/docs/en/md/Notion/Users/Get-user-data.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get user data + Gets user data by ID + + + +`Function GetUserData(Val Token, Val UserID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | UserID | --user | String | Target user ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + User = "ed71865a-9891-46bc-86cd-a92aa499cfdb"; + + Result = OPI_Notion.GetUserData(Token, User); +``` + + + + +```json title="Result" +{ + "object": "user", + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "name": "Techno Pizza", + "avatar_url": null, + "type": "person", + "person": { + "email": "iscript13@gmail.com" + }, + "request_id": "a6fc9071-fac0-4069-84ba-e724b783d9ce" +} +``` diff --git a/docs/en/md/Notion/Users/User-list.md b/docs/en/md/Notion/Users/User-list.md deleted file mode 100644 index bd821fdf1e..0000000000 --- a/docs/en/md/Notion/Users/User-list.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 1 ---- - -# User list - Returns a list of workspace users - - - -`Function UserList(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Notion - -
- - - - -```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - - Result = OPI_Notion.UserList(Token); -``` - - - - -```json title="Result" -{ - "object": "list", - "results": [ - { - "object": "user", - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "name": "Techno Pizza", - "avatar_url": null, - "type": "person", - "person": { - "email": "iscript13@gmail.com" - } - }, - { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "name": "1C Integration", - "avatar_url": null, - "type": "bot", - "bot": { - "owner": { - "type": "workspace", - "workspace": true - }, - "workspace_name": "Bayselonarrends Notion" - } - } - ], - "next_cursor": null, - "has_more": false, - "type": "user", - "user": {}, - "request_id": "ad031a0a-82a1-4d62-b104-184ef7dbb29b" -} -``` diff --git a/docs/en/md/Notion/Users/User-list.mdx b/docs/en/md/Notion/Users/User-list.mdx new file mode 100644 index 0000000000..cdeaa37e38 --- /dev/null +++ b/docs/en/md/Notion/Users/User-list.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# User list + Returns a list of workspace users + + + +`Function UserList(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Notion + +
+ + + + +```bsl title="Code example" + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + + Result = OPI_Notion.UserList(Token); +``` + + + + +```json title="Result" +{ + "object": "list", + "results": [ + { + "object": "user", + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "name": "Techno Pizza", + "avatar_url": null, + "type": "person", + "person": { + "email": "iscript13@gmail.com" + } + }, + { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "name": "1C Integration", + "avatar_url": null, + "type": "bot", + "bot": { + "owner": { + "type": "workspace", + "workspace": true + }, + "workspace_name": "Bayselonarrends Notion" + } + } + ], + "next_cursor": null, + "has_more": false, + "type": "user", + "user": {}, + "request_id": "ad031a0a-82a1-4d62-b104-184ef7dbb29b" +} +``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-attribute-values.md b/docs/en/md/Ozon/Attributes-and-features/Get-attribute-values.md deleted file mode 100644 index 9cab232354..0000000000 --- a/docs/en/md/Ozon/Attributes-and-features/Get-attribute-values.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get attribute values - Gets the list of available values of the attribute - - - -`Function GetAttributeValues(Val ClientID, Val APIKey, Val CategoryID, Val TypeID, Val AttributeID, Val CatalogID = 1, Val Lang = "DEFAULT") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | CategoryID | --categoryid | String, Number | Category identifier | - | TypeID | --typeid | String, Number | Item type identifier | - | AttributeID | --attributeid | String, Number | Attribute IDs for obtaining values | - | CatalogID | --start | String, Number | ID of the first catalog in the response | - | Lang | --lang | String | Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can find out if there is a nested catalog by the GetCharacteristicsCategories method() - - Method at API documentation: [post /v1/description-category/attribute/values](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributeValues) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - CategoryID = 17054869; - TypeID = 97311; - AttributeID = 85; - - Result = OPI_Ozon.GetAttributeValues(ClientID, APIKey, CategoryID, TypeID, AttributeID); -``` - - - - -```json title="Result" -{ - "result": [ - { - "id": 5056737, - "value": "Essence", - "info": "Красота и здоровье", - "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6088253599.jpg" - }, - { - "id": 5057962, - "value": "Hot", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6011312389.jpg" - }, - { - "id": 5058518, - "value": "CS", - "info": "", - "picture": "" - }, - { - "id": 5059837, - "value": "Каскад", - "info": "Зоотовары", - "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6027361156.jpg" - }, - { - "id": 5062537, - "value": "Enigma", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-5/6427347617.jpg" - }, - { - "id": 5062790, - "value": "Kitfort", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-6/6737348550.jpg" - }, - { - "id": 5064843, - "value": "Parlux", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6011101280.jpg" - }, - { - "id": 5065236, - "value": "Сателлит", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6010470136.jpg" - }, - { - "id": 5066816, - "value": "Carioca", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-8/6063013796.jpg" - }, - { - "id": 5068632, - "value": "Bawi", - "info": "", - "picture": "" - }, - { - "id": 5069237, - "value": "Kodak", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-m/6011062066.jpg" - }, - { - "id": 5069442, - "value": "Mattel", - "info": "Детские игрушки", - "picture": "https://cdn1.ozone.ru/multimedia/1013076413.jpg" - }, - { - "id": 5071003, - "value": "Ivo", - "info": "", - "picture": "" - }, - { - "id": 5071289, - "value": "HTC", - "info": "", - "picture": "https://cdn1.ozone.ru/multimedia/1011058578.jpg" - }, - { - "id": 5073069, - "value": "Ghost", - "info": "", - "picture": "" - }, - { - "id": 5073089, - "value": "Oleg Cassini", - "info": "", - "picture": "" - }, - { - "id": 5073356, - "value": "Ritzenhoff & Breker", - "info": "", - "picture": "" - }, - { - "id": 5073389, - "value": "William Levene", - "info": "", - "picture": "" - }, - { - "id": 5074417, - "value": "KEF", - "info": "", - "picture": "" - }, - { - "id": 5074684, - "value": "Cutipol", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-o/6011755428.jpg" - }, - { - "id": 5075889, - "value": "Jacob Zeidler & Co", - "info": "", - "picture": "" - }, - { - "id": 5076255, - "value": "The Original Book Works Limited", - "info": "", - "picture": "" - }, - { - "id": 5076787, - "value": "Ocean Extreme", - "info": "", - "picture": "" - }, - { - "id": 5077287, - "value": "Народное искусство", - "info": "", - "picture": "" - }, - { - "id": 5077379, - "value": "Zyliss", - "info": "", -... -``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-attribute-values.mdx b/docs/en/md/Ozon/Attributes-and-features/Get-attribute-values.mdx new file mode 100644 index 0000000000..8999eec7f1 --- /dev/null +++ b/docs/en/md/Ozon/Attributes-and-features/Get-attribute-values.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get attribute values + Gets the list of available values of the attribute + + + +`Function GetAttributeValues(Val ClientID, Val APIKey, Val CategoryID, Val TypeID, Val AttributeID, Val CatalogID = 1, Val Lang = "DEFAULT") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | CategoryID | --categoryid | String, Number | Category identifier | + | TypeID | --typeid | String, Number | Item type identifier | + | AttributeID | --attributeid | String, Number | Attribute IDs for obtaining values | + | CatalogID | --start | String, Number | ID of the first catalog in the response | + | Lang | --lang | String | Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can find out if there is a nested catalog by the GetCharacteristicsCategories method() + + Method at API documentation: [post /v1/description-category/attribute/values](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributeValues) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + CategoryID = 17054869; + TypeID = 97311; + AttributeID = 85; + + Result = OPI_Ozon.GetAttributeValues(ClientID, APIKey, CategoryID, TypeID, AttributeID); +``` + + + + +```json title="Result" +{ + "result": [ + { + "id": 5056737, + "value": "Essence", + "info": "Красота и здоровье", + "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6088253599.jpg" + }, + { + "id": 5057962, + "value": "Hot", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6011312389.jpg" + }, + { + "id": 5058518, + "value": "CS", + "info": "", + "picture": "" + }, + { + "id": 5059837, + "value": "Каскад", + "info": "Зоотовары", + "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6027361156.jpg" + }, + { + "id": 5062537, + "value": "Enigma", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-5/6427347617.jpg" + }, + { + "id": 5062790, + "value": "Kitfort", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-6/6737348550.jpg" + }, + { + "id": 5064843, + "value": "Parlux", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6011101280.jpg" + }, + { + "id": 5065236, + "value": "Сателлит", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6010470136.jpg" + }, + { + "id": 5066816, + "value": "Carioca", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-8/6063013796.jpg" + }, + { + "id": 5068632, + "value": "Bawi", + "info": "", + "picture": "" + }, + { + "id": 5069237, + "value": "Kodak", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-m/6011062066.jpg" + }, + { + "id": 5069442, + "value": "Mattel", + "info": "Детские игрушки", + "picture": "https://cdn1.ozone.ru/multimedia/1013076413.jpg" + }, + { + "id": 5071003, + "value": "Ivo", + "info": "", + "picture": "" + }, + { + "id": 5071289, + "value": "HTC", + "info": "", + "picture": "https://cdn1.ozone.ru/multimedia/1011058578.jpg" + }, + { + "id": 5073069, + "value": "Ghost", + "info": "", + "picture": "" + }, + { + "id": 5073089, + "value": "Oleg Cassini", + "info": "", + "picture": "" + }, + { + "id": 5073356, + "value": "Ritzenhoff & Breker", + "info": "", + "picture": "" + }, + { + "id": 5073389, + "value": "William Levene", + "info": "", + "picture": "" + }, + { + "id": 5074417, + "value": "KEF", + "info": "", + "picture": "" + }, + { + "id": 5074684, + "value": "Cutipol", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-o/6011755428.jpg" + }, + { + "id": 5075889, + "value": "Jacob Zeidler & Co", + "info": "", + "picture": "" + }, + { + "id": 5076255, + "value": "The Original Book Works Limited", + "info": "", + "picture": "" + }, + { + "id": 5076787, + "value": "Ocean Extreme", + "info": "", + "picture": "" + }, + { + "id": 5077287, + "value": "Народное искусство", + "info": "", + "picture": "" + }, + { + "id": 5077379, + "value": "Zyliss", + "info": "", +... +``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.md b/docs/en/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.md deleted file mode 100644 index 2936d3e6ab..0000000000 --- a/docs/en/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get categories and product types tree - Returns the categories and types for products in a tree view - - - -`Function GetCategoriesAndProductTypesTree(Val ClientID, Val APIKey, Val Lang = "DEFAULT") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Lang | --lang | String | Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Product creation is only available in the last level categories, compare exactly with the categories on your site. Categories are not created at the user's request - - Carefully choose the category for the product: different commission rates apply for different categories. - - Method at API documentation: [post /v1/description-category/tree](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetTree) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - Result = OPI_Ozon.GetCategoriesAndProductTypesTree(ClientID, APIKey, "EN"); - - Result = OPI_Ozon.GetCategoriesAndProductTypesTree(ClientID, APIKey); -``` - - - - -```json title="Result" -{ - "result": [ - { - "description_category_id": 17027492, - "category_name": "Канцелярские товары", - "disabled": false, - "children": [ - { - "description_category_id": 71328593, - "category_name": "Оборудование для торговли", - "disabled": false, - "children": [ - { - "type_name": "Ценник", - "type_id": 970615927, - "disabled": false, - "children": [] - }, - { - "type_name": "Коробка для товара", - "type_id": 971448894, - "disabled": false, - "children": [] - }, - { - "type_name": "Демонстрационная система", - "type_id": 94485, - "disabled": false, - "children": [] - }, - { - "type_name": "Счетчик посетителей электронный", - "type_id": 661551652, - "disabled": false, - "children": [] - }, - { - "type_name": "Дисплей торговый", - "type_id": 970616770, - "disabled": false, - "children": [] - }, - { - "type_name": "Светодиодная вывеска для магазина", - "type_id": 970694426, - "disabled": false, - "children": [] - }, - { - "type_name": "Разменный аппарат", - "type_id": 971132995, - "disabled": false, - "children": [] - }, - { - "type_name": "Полочный разделитель", - "type_id": 970616683, - "disabled": false, - "children": [] - }, - { - "type_name": "Карман информационный", - "type_id": 970615403, - "disabled": false, - "children": [] - }, - { - "type_name": "Антикражный замок для витрины", - "type_id": 971001293, - "disabled": false, - "children": [] - }, - { - "type_name": "Крючок на перфорацию", - "type_id": 971844358, - "disabled": false, - "children": [] - }, - { - "type_name": "Тележка покупательская", - "type_id": 970855215, - "disabled": false, - "children": [] - }, - { - "type_name": "Рекламный воблер", - "type_id": 971036158, - "disabled": false, - "children": [] - }, - { - "type_name": "Биркодержатель для игольчатого пистолета", - "type_id": 971323480, - "disabled": false, - "children": [] - }, - { - "type_name": "Комплектующее для торгового оборудования", - "type_id": 972101856, - "disabled": false, - "children": [] - }, - { - "type_name": "Пресс-волл", - "type_id": 971043038, - "disabled": false, - "children": [] - }, - { - "type_name": "Урна для пожертвований", - "type_id": 970842802, - "disabled": false, - "children": [] - }, - { - "type_name": "Торговый автомат механический", - "type_id": 971065057, - "disabled": false, - "children": [] - }, - { - "type_name": "Рамка информационная", - "type_id": 970615353, - "disabled": false, - "children": [] - }, - { - "type_name": "Кассета для купюроприемника", - "type_id": 971287223, - "disabled": false, - "children": [] - }, - { - "type_name": "Поручень рекламный", - "type_id": 971432456, - "disabled": false, - "children": [] - }, - { - "type_name": "Гардеробные номерки", - "type_id": 970986820, - "disabled": false, - "children": [] - }, - { - "type_name": "Информационный стенд", - "type_id": 790183771, - "disabled": false, - "children": [] - }, -... -``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.mdx b/docs/en/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.mdx new file mode 100644 index 0000000000..4213fe3ed0 --- /dev/null +++ b/docs/en/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get categories and product types tree + Returns the categories and types for products in a tree view + + + +`Function GetCategoriesAndProductTypesTree(Val ClientID, Val APIKey, Val Lang = "DEFAULT") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Lang | --lang | String | Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Product creation is only available in the last level categories, compare exactly with the categories on your site. Categories are not created at the user's request + + Carefully choose the category for the product: different commission rates apply for different categories. + + Method at API documentation: [post /v1/description-category/tree](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetTree) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + Result = OPI_Ozon.GetCategoriesAndProductTypesTree(ClientID, APIKey, "EN"); + + Result = OPI_Ozon.GetCategoriesAndProductTypesTree(ClientID, APIKey); +``` + + + + +```json title="Result" +{ + "result": [ + { + "description_category_id": 17027492, + "category_name": "Канцелярские товары", + "disabled": false, + "children": [ + { + "description_category_id": 71328593, + "category_name": "Оборудование для торговли", + "disabled": false, + "children": [ + { + "type_name": "Ценник", + "type_id": 970615927, + "disabled": false, + "children": [] + }, + { + "type_name": "Коробка для товара", + "type_id": 971448894, + "disabled": false, + "children": [] + }, + { + "type_name": "Демонстрационная система", + "type_id": 94485, + "disabled": false, + "children": [] + }, + { + "type_name": "Счетчик посетителей электронный", + "type_id": 661551652, + "disabled": false, + "children": [] + }, + { + "type_name": "Дисплей торговый", + "type_id": 970616770, + "disabled": false, + "children": [] + }, + { + "type_name": "Светодиодная вывеска для магазина", + "type_id": 970694426, + "disabled": false, + "children": [] + }, + { + "type_name": "Разменный аппарат", + "type_id": 971132995, + "disabled": false, + "children": [] + }, + { + "type_name": "Полочный разделитель", + "type_id": 970616683, + "disabled": false, + "children": [] + }, + { + "type_name": "Карман информационный", + "type_id": 970615403, + "disabled": false, + "children": [] + }, + { + "type_name": "Антикражный замок для витрины", + "type_id": 971001293, + "disabled": false, + "children": [] + }, + { + "type_name": "Крючок на перфорацию", + "type_id": 971844358, + "disabled": false, + "children": [] + }, + { + "type_name": "Тележка покупательская", + "type_id": 970855215, + "disabled": false, + "children": [] + }, + { + "type_name": "Рекламный воблер", + "type_id": 971036158, + "disabled": false, + "children": [] + }, + { + "type_name": "Биркодержатель для игольчатого пистолета", + "type_id": 971323480, + "disabled": false, + "children": [] + }, + { + "type_name": "Комплектующее для торгового оборудования", + "type_id": 972101856, + "disabled": false, + "children": [] + }, + { + "type_name": "Пресс-волл", + "type_id": 971043038, + "disabled": false, + "children": [] + }, + { + "type_name": "Урна для пожертвований", + "type_id": 970842802, + "disabled": false, + "children": [] + }, + { + "type_name": "Торговый автомат механический", + "type_id": 971065057, + "disabled": false, + "children": [] + }, + { + "type_name": "Рамка информационная", + "type_id": 970615353, + "disabled": false, + "children": [] + }, + { + "type_name": "Кассета для купюроприемника", + "type_id": 971287223, + "disabled": false, + "children": [] + }, + { + "type_name": "Поручень рекламный", + "type_id": 971432456, + "disabled": false, + "children": [] + }, + { + "type_name": "Гардеробные номерки", + "type_id": 970986820, + "disabled": false, + "children": [] + }, + { + "type_name": "Информационный стенд", + "type_id": 790183771, + "disabled": false, + "children": [] + }, +... +``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-category-attributes.md b/docs/en/md/Ozon/Attributes-and-features/Get-category-attributes.md deleted file mode 100644 index f485108ecc..0000000000 --- a/docs/en/md/Ozon/Attributes-and-features/Get-category-attributes.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get category attributes - Gets the characteristics for the specified category and product type - - - -`Function GetCategoryAttributes(Val ClientID, Val APIKey, Val CategoryID, Val TypeID, Val Lang = "DEFAULT") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | CategoryID | --categoryid | String, Number | Category identifier | - | TypeID | --typeid | String, Number | Item type identifier | - | Lang | --lang | String | Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -If dictionary_id has a value of 0, the attribute has no nested directories. If the value is different, there are directories. You can get them using the GetValuesCharacteristics method() - - Method at API documentation: [post /v1/description-category/attribute](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributes) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - CategoryID = 17029016; - TypeID = 970778135; - - Result = OPI_Ozon.GetCategoryAttributes(ClientID, APIKey, CategoryID, TypeID); -``` - - - - -```json title="Result" -{ - "result": [ - { - "id": 85, - "attribute_complex_id": 0, - "name": "Бренд", - "description": "Укажите наименование бренда, под которым произведен товар. Если товар не имеет бренда, используйте значение \"Нет бренда\".", - "type": "String", - "is_collection": false, - "is_required": true, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 28732849, - "category_dependent": true - }, - { - "id": 4080, - "attribute_complex_id": 0, - "name": "3D-изображение", - "description": "Укажите ссылки на фото, через запятую, которые показывает товар под разными равными углами. В серии фото важно соблюдать последовательность, чтобы ракурс каждого следующего фото отличался от предыдущего на равный угол. Из этих фотографий на сайте автоматически сформируется 3D-модель товара. Минимальное рекомендованное количество - 15 штук.", - "type": "URL", - "is_collection": true, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4180, - "attribute_complex_id": 0, - "name": "Название", - "description": "Название пишется по принципу:\nТип + Бренд + Модель (серия + пояснение) + Артикул производителя + , (запятая) + Атрибут\nНазвание не пишется большими буквами (не используем caps lock).\nПеред атрибутом ставится запятая. Если атрибутов несколько, они так же разделяются запятыми.\nЕсли какой-то составной части названия нет - пропускаем её.\nАтрибутом может быть: цвет, вес, объём, количество штук в упаковке и т.д.\nЦвет пишется с маленькой буквы, в мужском роде, единственном числе.\nСлово цвет в названии не пишем.\nТочка в конце не ставится.\nНикаких знаков препинания, кроме запятой, не используем.\nКавычки используем только для названий на русском языке.\nПримеры корректных названий:\nСмартфон Apple iPhone XS MT572RU/A, space black \nКеды Dr. Martens Киноклассика, бело-черные, размер 43\nСтиральный порошок Ariel Магия белого с мерной ложкой, 15 кг\nСоус Heinz Xtreme Tabasco суперострый, 10 мл\nИгрушка для животных Четыре лапы \"Бегающая мышка\" БММ, белый", - "type": "String", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4191, - "attribute_complex_id": 0, - "name": "Аннотация", - "description": "Описание товара, маркетинговый текст. Необходимо заполнять на русском языке.", - "type": "multiline", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4385, - "attribute_complex_id": 0, - "name": "Гарантийный срок", - "description": "Укажите гарантийный срок. Гарантийный срок – это период, в течение которого изготовитель гарантирует качество товара и обязуется принять данный товар у потребителя для проведения проверки качества (экспертизы) и выполнения предусмотренных законом требований.", - "type": "String", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4389, - "attribute_complex_id": 0, - "name": "Страна-изготовитель", - "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", - "type": "String", - "is_collection": true, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1935, - "category_dependent": false - }, - { - "id": 6548, - "attribute_complex_id": 0, - "name": "Материал", - "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", - "type": "String", - "is_collection": true, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1503, - "category_dependent": true - }, - { - "id": 8229, - "attribute_complex_id": 0, - "name": "Тип", - "description": "Выберите наиболее подходящий тип товара. По типам товары распределяются по категориям на сайте Ozon. Если тип указан неправильно, товар попадет в неверную категорию. Чтобы правильно указать тип, найдите на сайте Ozon товары, похожие на ваш, и посмотрите, какой тип у них указан.", - "type": "String", - "is_collection": false, - "is_required": true, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1960, - "category_dependent": true - }, - { - "id": 8245, - "attribute_complex_id": 0, - "name": "Число строк", - "description": "Выберите из списка. Можно указать только одно значение.", - "type": "String", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1324, - "category_dependent": true - }, - { - "id": 8249, - "attribute_complex_id": 0, - "name": "Число знаков шрифта для выделения", - "description": "Можно указать только целое число.", - "type": "Integer", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, -... -``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-category-attributes.mdx b/docs/en/md/Ozon/Attributes-and-features/Get-category-attributes.mdx new file mode 100644 index 0000000000..4ebc825a94 --- /dev/null +++ b/docs/en/md/Ozon/Attributes-and-features/Get-category-attributes.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get category attributes + Gets the characteristics for the specified category and product type + + + +`Function GetCategoryAttributes(Val ClientID, Val APIKey, Val CategoryID, Val TypeID, Val Lang = "DEFAULT") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | CategoryID | --categoryid | String, Number | Category identifier | + | TypeID | --typeid | String, Number | Item type identifier | + | Lang | --lang | String | Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +If dictionary_id has a value of 0, the attribute has no nested directories. If the value is different, there are directories. You can get them using the GetValuesCharacteristics method() + + Method at API documentation: [post /v1/description-category/attribute](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributes) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + CategoryID = 17029016; + TypeID = 970778135; + + Result = OPI_Ozon.GetCategoryAttributes(ClientID, APIKey, CategoryID, TypeID); +``` + + + + +```json title="Result" +{ + "result": [ + { + "id": 85, + "attribute_complex_id": 0, + "name": "Бренд", + "description": "Укажите наименование бренда, под которым произведен товар. Если товар не имеет бренда, используйте значение \"Нет бренда\".", + "type": "String", + "is_collection": false, + "is_required": true, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 28732849, + "category_dependent": true + }, + { + "id": 4080, + "attribute_complex_id": 0, + "name": "3D-изображение", + "description": "Укажите ссылки на фото, через запятую, которые показывает товар под разными равными углами. В серии фото важно соблюдать последовательность, чтобы ракурс каждого следующего фото отличался от предыдущего на равный угол. Из этих фотографий на сайте автоматически сформируется 3D-модель товара. Минимальное рекомендованное количество - 15 штук.", + "type": "URL", + "is_collection": true, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4180, + "attribute_complex_id": 0, + "name": "Название", + "description": "Название пишется по принципу:\nТип + Бренд + Модель (серия + пояснение) + Артикул производителя + , (запятая) + Атрибут\nНазвание не пишется большими буквами (не используем caps lock).\nПеред атрибутом ставится запятая. Если атрибутов несколько, они так же разделяются запятыми.\nЕсли какой-то составной части названия нет - пропускаем её.\nАтрибутом может быть: цвет, вес, объём, количество штук в упаковке и т.д.\nЦвет пишется с маленькой буквы, в мужском роде, единственном числе.\nСлово цвет в названии не пишем.\nТочка в конце не ставится.\nНикаких знаков препинания, кроме запятой, не используем.\nКавычки используем только для названий на русском языке.\nПримеры корректных названий:\nСмартфон Apple iPhone XS MT572RU/A, space black \nКеды Dr. Martens Киноклассика, бело-черные, размер 43\nСтиральный порошок Ariel Магия белого с мерной ложкой, 15 кг\nСоус Heinz Xtreme Tabasco суперострый, 10 мл\nИгрушка для животных Четыре лапы \"Бегающая мышка\" БММ, белый", + "type": "String", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4191, + "attribute_complex_id": 0, + "name": "Аннотация", + "description": "Описание товара, маркетинговый текст. Необходимо заполнять на русском языке.", + "type": "multiline", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4385, + "attribute_complex_id": 0, + "name": "Гарантийный срок", + "description": "Укажите гарантийный срок. Гарантийный срок – это период, в течение которого изготовитель гарантирует качество товара и обязуется принять данный товар у потребителя для проведения проверки качества (экспертизы) и выполнения предусмотренных законом требований.", + "type": "String", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4389, + "attribute_complex_id": 0, + "name": "Страна-изготовитель", + "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", + "type": "String", + "is_collection": true, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1935, + "category_dependent": false + }, + { + "id": 6548, + "attribute_complex_id": 0, + "name": "Материал", + "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", + "type": "String", + "is_collection": true, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1503, + "category_dependent": true + }, + { + "id": 8229, + "attribute_complex_id": 0, + "name": "Тип", + "description": "Выберите наиболее подходящий тип товара. По типам товары распределяются по категориям на сайте Ozon. Если тип указан неправильно, товар попадет в неверную категорию. Чтобы правильно указать тип, найдите на сайте Ozon товары, похожие на ваш, и посмотрите, какой тип у них указан.", + "type": "String", + "is_collection": false, + "is_required": true, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1960, + "category_dependent": true + }, + { + "id": 8245, + "attribute_complex_id": 0, + "name": "Число строк", + "description": "Выберите из списка. Можно указать только одно значение.", + "type": "String", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1324, + "category_dependent": true + }, + { + "id": 8249, + "attribute_complex_id": 0, + "name": "Число знаков шрифта для выделения", + "description": "Можно указать только целое число.", + "type": "Integer", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, +... +``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-products-requests-limits.md b/docs/en/md/Ozon/Attributes-and-features/Get-products-requests-limits.md deleted file mode 100644 index 63165b8aea..0000000000 --- a/docs/en/md/Ozon/Attributes-and-features/Get-products-requests-limits.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get products requests limits - Get requests limits for products managment methods - - - -`Function GetProductsRequestsLimits(Val ClientID, Val APIKey) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v4/product/info/limit](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetUploadQuota) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - Result = OPI_Ozon.GetProductsRequestsLimits(ClientID, APIKey); -``` - - - - -```json title="Result" -{ - "daily_create": { - "usage": 0, - "limit": 1500, - "reset_at": "2024-10-10T00:00:00Z" - }, - "daily_update": { - "usage": 0, - "limit": 5000, - "reset_at": "2024-10-10T00:00:00Z" - }, - "total": { - "usage": 4, - "limit": 20000 - } -} -``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Get-products-requests-limits.mdx b/docs/en/md/Ozon/Attributes-and-features/Get-products-requests-limits.mdx new file mode 100644 index 0000000000..759c910047 --- /dev/null +++ b/docs/en/md/Ozon/Attributes-and-features/Get-products-requests-limits.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get products requests limits + Get requests limits for products managment methods + + + +`Function GetProductsRequestsLimits(Val ClientID, Val APIKey) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v4/product/info/limit](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetUploadQuota) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + Result = OPI_Ozon.GetProductsRequestsLimits(ClientID, APIKey); +``` + + + + +```json title="Result" +{ + "daily_create": { + "usage": 0, + "limit": 1500, + "reset_at": "2024-10-10T00:00:00Z" + }, + "daily_update": { + "usage": 0, + "limit": 5000, + "reset_at": "2024-10-10T00:00:00Z" + }, + "total": { + "usage": 4, + "limit": 20000 + } +} +``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Search-attribute-value.md b/docs/en/md/Ozon/Attributes-and-features/Search-attribute-value.md deleted file mode 100644 index 05d7d85367..0000000000 --- a/docs/en/md/Ozon/Attributes-and-features/Search-attribute-value.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Search attribute value - Gets the reference values of the attribute by the specified value - - - -`Function SearchAttributeValue(Val ClientID, Val APIKey, Val CategoryID, Val TypeID, Val AttributeID, Val Value) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | CategoryID | --categoryid | String, Number | Category identifier | - | TypeID | --typeid | String, Number | Item type identifier | - | AttributeID | --attributeid | String, Number | Attribute IDs for obtaining values | - | Value | --value | String | Search value | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can find out if there is a nested catalog by the GetCharacteristicsCategories method() - - Method at API documentation: [post /v1/description-category/attribute/values/search](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_SearchAttributeValues) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - CategoryID = 17054869; - TypeID = 97311; - AttributeID = 85; - Value = "Sunshine"; - - Result = OPI_Ozon.SearchAttributeValue(ClientID - , APIKey - , CategoryID - , TypeID - , AttributeID - , Value); -``` - - - - -```json title="Result" -{ - "result": [ - { - "id": 5055881, - "value": "Sunshine", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-i/6010930878.jpg" - }, - { - "id": 971026862, - "value": "SUNSHINE", - "info": "Спорт и отдых", - "picture": "" - }, - { - "id": 971719299, - "value": "Sunshine", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6601244203.jpg" - }, - { - "id": 971818888, - "value": "Sunshine", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6644299477.jpg" - }, - { - "id": 972176200, - "value": "sunshine", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/e6dcf5aa-eb30-442d-afa0-5812652d2816.png" - }, - { - "id": 972202223, - "value": "SUNSHINE", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/68384d8e-4b49-4f99-a045-3403c1f10f0f.jpg" - }, - { - "id": 971227292, - "value": "Sunshine Baby", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-r/6299308959.jpg" - }, - { - "id": 972029069, - "value": "Sunshine Beams", - "info": "", - "picture": "" - }, - { - "id": 971168926, - "value": "Sunshine-Craft", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-u/6267516354.jpg" - }, - { - "id": 972173064, - "value": "Sunshine Day", - "info": "", - "picture": "" - }, - { - "id": 970974258, - "value": "sunshinefilm", - "info": "Защитная пленка на экран смартфона, гидрогелевая", - "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6048813188.jpg" - }, - { - "id": 972066951, - "value": "SunShineFox", - "info": "", - "picture": "" - }, - { - "id": 972172514, - "value": "SUNSHINEFXY", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/d48c1614-b9c4-4785-b9ef-3142f5cfb12c.png" - }, - { - "id": 971110891, - "value": "Sunshine Habibi", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6158730376.jpg" - }, - { - "id": 971896068, - "value": "Sunshine House", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-b/6704404415.jpg" - }, - { - "id": 971967921, - "value": "SunShine in me", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6775950013.jpg" - }, - { - "id": 970712762, - "value": "Sunshine Innovations", - "info": "", - "picture": "" - }, - { - "id": 5115939, - "value": "Sunshine Kids", - "info": "", - "picture": "" - }, - { - "id": 971303326, - "value": "Sunshine Lady", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6371652253.jpg" - }, - { - "id": 972131760, - "value": "Sunshineland", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/63bfd44b-6338-4fa6-8843-39b1c7827099.jpg" - }, - { - "id": 5142226, - "value": "Sunshine Optics", - "info": "", - "picture": "" - }, - { - "id": 972026686, - "value": "SUNSHINE PANDI", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-3/6842409075.jpg" - }, - { - "id": 970954160, - "value": "SUNSHINE PEARL", - "info": "Соль для ванны", - "picture": "https://cdn1.ozone.ru/s3/multimedia-j/6041114827.jpg" - }, - { - "id": 970697481, - "value": "SunShines", - "info": "", - "picture": "" - }, - { - "id": 972077059, - "value": "Sunshine shop", - "info": "", -... -``` diff --git a/docs/en/md/Ozon/Attributes-and-features/Search-attribute-value.mdx b/docs/en/md/Ozon/Attributes-and-features/Search-attribute-value.mdx new file mode 100644 index 0000000000..1238d9c395 --- /dev/null +++ b/docs/en/md/Ozon/Attributes-and-features/Search-attribute-value.mdx @@ -0,0 +1,208 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Search attribute value + Gets the reference values of the attribute by the specified value + + + +`Function SearchAttributeValue(Val ClientID, Val APIKey, Val CategoryID, Val TypeID, Val AttributeID, Val Value) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | CategoryID | --categoryid | String, Number | Category identifier | + | TypeID | --typeid | String, Number | Item type identifier | + | AttributeID | --attributeid | String, Number | Attribute IDs for obtaining values | + | Value | --value | String | Search value | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can find out if there is a nested catalog by the GetCharacteristicsCategories method() + + Method at API documentation: [post /v1/description-category/attribute/values/search](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_SearchAttributeValues) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + CategoryID = 17054869; + TypeID = 97311; + AttributeID = 85; + Value = "Sunshine"; + + Result = OPI_Ozon.SearchAttributeValue(ClientID + , APIKey + , CategoryID + , TypeID + , AttributeID + , Value); +``` + + + + +```json title="Result" +{ + "result": [ + { + "id": 5055881, + "value": "Sunshine", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-i/6010930878.jpg" + }, + { + "id": 971026862, + "value": "SUNSHINE", + "info": "Спорт и отдых", + "picture": "" + }, + { + "id": 971719299, + "value": "Sunshine", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6601244203.jpg" + }, + { + "id": 971818888, + "value": "Sunshine", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6644299477.jpg" + }, + { + "id": 972176200, + "value": "sunshine", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/e6dcf5aa-eb30-442d-afa0-5812652d2816.png" + }, + { + "id": 972202223, + "value": "SUNSHINE", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/68384d8e-4b49-4f99-a045-3403c1f10f0f.jpg" + }, + { + "id": 971227292, + "value": "Sunshine Baby", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-r/6299308959.jpg" + }, + { + "id": 972029069, + "value": "Sunshine Beams", + "info": "", + "picture": "" + }, + { + "id": 971168926, + "value": "Sunshine-Craft", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-u/6267516354.jpg" + }, + { + "id": 972173064, + "value": "Sunshine Day", + "info": "", + "picture": "" + }, + { + "id": 970974258, + "value": "sunshinefilm", + "info": "Защитная пленка на экран смартфона, гидрогелевая", + "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6048813188.jpg" + }, + { + "id": 972066951, + "value": "SunShineFox", + "info": "", + "picture": "" + }, + { + "id": 972172514, + "value": "SUNSHINEFXY", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/d48c1614-b9c4-4785-b9ef-3142f5cfb12c.png" + }, + { + "id": 971110891, + "value": "Sunshine Habibi", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6158730376.jpg" + }, + { + "id": 971896068, + "value": "Sunshine House", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-b/6704404415.jpg" + }, + { + "id": 971967921, + "value": "SunShine in me", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6775950013.jpg" + }, + { + "id": 970712762, + "value": "Sunshine Innovations", + "info": "", + "picture": "" + }, + { + "id": 5115939, + "value": "Sunshine Kids", + "info": "", + "picture": "" + }, + { + "id": 971303326, + "value": "Sunshine Lady", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6371652253.jpg" + }, + { + "id": 972131760, + "value": "Sunshineland", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/63bfd44b-6338-4fa6-8843-39b1c7827099.jpg" + }, + { + "id": 5142226, + "value": "Sunshine Optics", + "info": "", + "picture": "" + }, + { + "id": 972026686, + "value": "SUNSHINE PANDI", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-3/6842409075.jpg" + }, + { + "id": 970954160, + "value": "SUNSHINE PEARL", + "info": "Соль для ванны", + "picture": "https://cdn1.ozone.ru/s3/multimedia-j/6041114827.jpg" + }, + { + "id": 970697481, + "value": "SunShines", + "info": "", + "picture": "" + }, + { + "id": 972077059, + "value": "Sunshine shop", + "info": "", +... +``` diff --git a/docs/en/md/Ozon/Barcodes/Bind-barcodes.md b/docs/en/md/Ozon/Barcodes/Bind-barcodes.md deleted file mode 100644 index f727f1bfa1..0000000000 --- a/docs/en/md/Ozon/Barcodes/Bind-barcodes.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Bind barcodes - Binds barcodes to products - - - -`Function BindBarcodes(Val ClientID, Val APIKey, Val BarcodesMap) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | BarcodesMap | --barcodes | Map Of KeyAndValue | Key > product SKU, Value > barcode | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/barcode/add](https://docs.ozon.ru/api/seller/#operation/add-barcode) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - BarcodesMap = New Map; - BarcodesMap.Insert(1626044001, "112233"); - - Result = OPI_Ozon.BindBarcodes(ClientID, APIKey, BarcodesMap); -``` - - - - -```json title="Result" -{ - "errors": [ - { - "barcode": "112233", - "code": "item_not_found", - "error": "sellerID of item 1626044001 is not 2128753", - "sku": 1626044001 - } - ] -} -``` diff --git a/docs/en/md/Ozon/Barcodes/Bind-barcodes.mdx b/docs/en/md/Ozon/Barcodes/Bind-barcodes.mdx new file mode 100644 index 0000000000..d1ec2dae8c --- /dev/null +++ b/docs/en/md/Ozon/Barcodes/Bind-barcodes.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Bind barcodes + Binds barcodes to products + + + +`Function BindBarcodes(Val ClientID, Val APIKey, Val BarcodesMap) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | BarcodesMap | --barcodes | Map Of KeyAndValue | Key > product SKU, Value > barcode | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/barcode/add](https://docs.ozon.ru/api/seller/#operation/add-barcode) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + BarcodesMap = New Map; + BarcodesMap.Insert(1626044001, "112233"); + + Result = OPI_Ozon.BindBarcodes(ClientID, APIKey, BarcodesMap); +``` + + + + +```json title="Result" +{ + "errors": [ + { + "barcode": "112233", + "code": "item_not_found", + "error": "sellerID of item 1626044001 is not 2128753", + "sku": 1626044001 + } + ] +} +``` diff --git a/docs/en/md/Ozon/Barcodes/Create-barcodes.md b/docs/en/md/Ozon/Barcodes/Create-barcodes.md deleted file mode 100644 index 8af4f2c4db..0000000000 --- a/docs/en/md/Ozon/Barcodes/Create-barcodes.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create barcodes - Generates new barcodes for products - - - -`Function CreateBarcodes(Val ClientID, Val APIKey, Val ProductsID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsID | --productids | String, Array of String | Products IDs for barcodes creating | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can create barcodes for a maximum of 100 products per request - - From one merchant account, you can use the method no more than 20 times per minute - - Method at API documentation: [post /v1/barcode/generate](https://docs.ozon.ru/api/seller/#operation/generate-barcode) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Result = OPI_Ozon.CreateBarcodes(ClientID, APIKey, ProductID); -``` - - - - -```json title="Result" -{ - "errors": [] -} -``` diff --git a/docs/en/md/Ozon/Barcodes/Create-barcodes.mdx b/docs/en/md/Ozon/Barcodes/Create-barcodes.mdx new file mode 100644 index 0000000000..aa9a972fbd --- /dev/null +++ b/docs/en/md/Ozon/Barcodes/Create-barcodes.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create barcodes + Generates new barcodes for products + + + +`Function CreateBarcodes(Val ClientID, Val APIKey, Val ProductsID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsID | --productids | String, Array of String | Products IDs for barcodes creating | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can create barcodes for a maximum of 100 products per request + + From one merchant account, you can use the method no more than 20 times per minute + + Method at API documentation: [post /v1/barcode/generate](https://docs.ozon.ru/api/seller/#operation/generate-barcode) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Result = OPI_Ozon.CreateBarcodes(ClientID, APIKey, ProductID); +``` + + + + +```json title="Result" +{ + "errors": [] +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-discount-information.md b/docs/en/md/Ozon/Prices-and-stocks/Get-discount-information.md deleted file mode 100644 index 8d9065c8c9..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Get-discount-information.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get discount information - Retrieves discount and main product information by SKU of the discounted items - - - -`Function GetDiscountInformation(Val ClientID, Val APIKey, Val SKU) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | SKU | --sku | Number, Array Of Number | SKU of discounted products | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/info/discounted](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDiscounted) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Result = OPI_Ozon.GetDiscountInformation(ClientID, APIKey, SKU); -``` - - - - -```json title="Result" -{ - "items": [] -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-discount-information.mdx b/docs/en/md/Ozon/Prices-and-stocks/Get-discount-information.mdx new file mode 100644 index 0000000000..6bffb5ca30 --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Get-discount-information.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get discount information + Retrieves discount and main product information by SKU of the discounted items + + + +`Function GetDiscountInformation(Val ClientID, Val APIKey, Val SKU) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | SKU | --sku | Number, Array Of Number | SKU of discounted products | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/info/discounted](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDiscounted) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Result = OPI_Ozon.GetDiscountInformation(ClientID, APIKey, SKU); +``` + + + + +```json title="Result" +{ + "items": [] +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-product-price-structure.md b/docs/en/md/Ozon/Prices-and-stocks/Get-product-price-structure.md deleted file mode 100644 index 0decc53961..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Get-product-price-structure.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get product price structure - Gets the product price structure for the UpdateProductsPrices function - - - -`Function GetProductPriceStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Filter fields structure - -
- -:::tip -The description of the filter fields can be found on the documentation page for product list retrieving method: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) -::: -
- - -```bsl title="Code example" - Result = OPI_Ozon.GetProductPriceStructure(); -``` - - - - -```json title="Result" -{ - "auto_action_enabled": "", - "currency_code": "", - "min_price": "", - "offer_id": "", - "old_price": "", - "price": "", - "price_strategy_enabled": "", - "product_id": "" -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-product-price-structure.mdx b/docs/en/md/Ozon/Prices-and-stocks/Get-product-price-structure.mdx new file mode 100644 index 0000000000..4df971a005 --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Get-product-price-structure.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get product price structure + Gets the product price structure for the UpdateProductsPrices function + + + +`Function GetProductPriceStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Filter fields structure + +
+ +:::tip +The description of the filter fields can be found on the documentation page for product list retrieving method: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) +::: +
+ + +```bsl title="Code example" + Result = OPI_Ozon.GetProductPriceStructure(); +``` + + + + +```json title="Result" +{ + "auto_action_enabled": "", + "currency_code": "", + "min_price": "", + "offer_id": "", + "old_price": "", + "price": "", + "price_strategy_enabled": "", + "product_id": "" +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.md b/docs/en/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.md deleted file mode 100644 index a0b915ca75..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get product stocks structure - Gets the data structure for udpating product stocks in the UpdateProductsStocks function - - - -`Function GetProductStocksStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Filter fields structure - -
- -:::tip -The description of the filter fields can be found on the documentation page for product list retrieving method: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) -::: -
- - -```bsl title="Code example" - Result = OPI_Ozon.GetProductStocksStructure(); -``` - - - - -```json title="Result" -{ - "offer_id": "
", - "product_id": "", - "stock": "", - "warehouse_id": "" -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.mdx b/docs/en/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.mdx new file mode 100644 index 0000000000..b958732004 --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get product stocks structure + Gets the data structure for udpating product stocks in the UpdateProductsStocks function + + + +`Function GetProductStocksStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Filter fields structure + +
+ +:::tip +The description of the filter fields can be found on the documentation page for product list retrieving method: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) +::: +
+ + +```bsl title="Code example" + Result = OPI_Ozon.GetProductStocksStructure(); +``` + + + + +```json title="Result" +{ + "offer_id": "
", + "product_id": "", + "stock": "", + "warehouse_id": "" +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-products-prices.md b/docs/en/md/Ozon/Prices-and-stocks/Get-products-prices.md deleted file mode 100644 index 19b3f80381..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Get-products-prices.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get products prices - Gets products prices with or without filter - - - -`Function GetProductsPrices(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | - | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v4/product/info/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoPricesV4) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - Result = OPI_Ozon.GetProductsPrices(ClientID, APIKey, New Structure); -``` - - - - -```json title="Result" -{ - "result": { - "items": [ - { - "product_id": 1156646653, - "offer_id": "91132", - "price": { - "price": "1100.0000", - "old_price": "1100.0000", - "premium_price": "", - "recommended_price": "", - "retail_price": "0.0000", - "vat": "0.100000", - "min_ozon_price": "", - "marketing_price": "", - "marketing_seller_price": "", - "min_price": "0.0000", - "currency_code": "RUB", - "auto_action_enabled": false - }, - "price_index": "0.00", - "commissions": { - "sales_percent": 0, - "fbo_fulfillment_amount": 0, - "fbo_direct_flow_trans_min_amount": 0, - "fbo_direct_flow_trans_max_amount": 0, - "fbo_deliv_to_customer_amount": 0, - "fbo_return_flow_amount": 0, - "fbo_return_flow_trans_min_amount": 0, - "fbo_return_flow_trans_max_amount": 0, - "fbs_first_mile_min_amount": 0, - "fbs_first_mile_max_amount": 25, - "fbs_direct_flow_trans_min_amount": 0, - "fbs_direct_flow_trans_max_amount": 0, - "fbs_deliv_to_customer_amount": 0, - "fbs_return_flow_amount": 0, - "fbs_return_flow_trans_min_amount": 0, - "fbs_return_flow_trans_max_amount": 0, - "sales_percent_fbo": 0, - "sales_percent_fbs": 0 - }, - "marketing_actions": null, - "volume_weight": 1.2, - "price_indexes": { - "price_index": "WITHOUT_INDEX", - "external_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "ozon_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "self_marketplaces_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - } - }, - "acquiring": 0 - }, - { - "product_id": 1179304145, - "offer_id": "143210610", - "price": { - "price": "1300.0000", - "old_price": "1400.0000", - "premium_price": "", - "recommended_price": "", - "retail_price": "0.0000", - "vat": "0.100000", - "min_ozon_price": "", - "marketing_price": "", - "marketing_seller_price": "", - "min_price": "1300.0000", - "currency_code": "RUB", - "auto_action_enabled": false - }, - "price_index": "0.00", - "commissions": { - "sales_percent": 0, - "fbo_fulfillment_amount": 0, - "fbo_direct_flow_trans_min_amount": 0, - "fbo_direct_flow_trans_max_amount": 0, - "fbo_deliv_to_customer_amount": 0, - "fbo_return_flow_amount": 0, - "fbo_return_flow_trans_min_amount": 0, - "fbo_return_flow_trans_max_amount": 0, - "fbs_first_mile_min_amount": 0, - "fbs_first_mile_max_amount": 25, - "fbs_direct_flow_trans_min_amount": 0, - "fbs_direct_flow_trans_max_amount": 0, - "fbs_deliv_to_customer_amount": 0, - "fbs_return_flow_amount": 0, - "fbs_return_flow_trans_min_amount": 0, - "fbs_return_flow_trans_max_amount": 0, - "sales_percent_fbo": 0, - "sales_percent_fbs": 0 - }, - "marketing_actions": null, - "volume_weight": 0.1, - "price_indexes": { - "price_index": "WITHOUT_INDEX", - "external_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "ozon_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "self_marketplaces_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - } - }, - "acquiring": 0 - }, - { - "product_id": 1179307106, - "offer_id": "143210611", - "price": { - "price": "1300.0000", - "old_price": "1300.0000", - "premium_price": "", - "recommended_price": "", - "retail_price": "0.0000", - "vat": "0.100000", - "min_ozon_price": "", - "marketing_price": "", - "marketing_seller_price": "", - "min_price": "0.0000", - "currency_code": "RUB", - "auto_action_enabled": false - }, - "price_index": "0.00", - "commissions": { - "sales_percent": 0, - "fbo_fulfillment_amount": 0, - "fbo_direct_flow_trans_min_amount": 0, - "fbo_direct_flow_trans_max_amount": 0, - "fbo_deliv_to_customer_amount": 0, - "fbo_return_flow_amount": 0, - "fbo_return_flow_trans_min_amount": 0, - "fbo_return_flow_trans_max_amount": 0, -... -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-products-prices.mdx b/docs/en/md/Ozon/Prices-and-stocks/Get-products-prices.mdx new file mode 100644 index 0000000000..177888cdfb --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Get-products-prices.mdx @@ -0,0 +1,195 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get products prices + Gets products prices with or without filter + + + +`Function GetProductsPrices(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | + | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v4/product/info/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoPricesV4) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + Result = OPI_Ozon.GetProductsPrices(ClientID, APIKey, New Structure); +``` + + + + +```json title="Result" +{ + "result": { + "items": [ + { + "product_id": 1156646653, + "offer_id": "91132", + "price": { + "price": "1100.0000", + "old_price": "1100.0000", + "premium_price": "", + "recommended_price": "", + "retail_price": "0.0000", + "vat": "0.100000", + "min_ozon_price": "", + "marketing_price": "", + "marketing_seller_price": "", + "min_price": "0.0000", + "currency_code": "RUB", + "auto_action_enabled": false + }, + "price_index": "0.00", + "commissions": { + "sales_percent": 0, + "fbo_fulfillment_amount": 0, + "fbo_direct_flow_trans_min_amount": 0, + "fbo_direct_flow_trans_max_amount": 0, + "fbo_deliv_to_customer_amount": 0, + "fbo_return_flow_amount": 0, + "fbo_return_flow_trans_min_amount": 0, + "fbo_return_flow_trans_max_amount": 0, + "fbs_first_mile_min_amount": 0, + "fbs_first_mile_max_amount": 25, + "fbs_direct_flow_trans_min_amount": 0, + "fbs_direct_flow_trans_max_amount": 0, + "fbs_deliv_to_customer_amount": 0, + "fbs_return_flow_amount": 0, + "fbs_return_flow_trans_min_amount": 0, + "fbs_return_flow_trans_max_amount": 0, + "sales_percent_fbo": 0, + "sales_percent_fbs": 0 + }, + "marketing_actions": null, + "volume_weight": 1.2, + "price_indexes": { + "price_index": "WITHOUT_INDEX", + "external_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "ozon_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "self_marketplaces_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + } + }, + "acquiring": 0 + }, + { + "product_id": 1179304145, + "offer_id": "143210610", + "price": { + "price": "1300.0000", + "old_price": "1400.0000", + "premium_price": "", + "recommended_price": "", + "retail_price": "0.0000", + "vat": "0.100000", + "min_ozon_price": "", + "marketing_price": "", + "marketing_seller_price": "", + "min_price": "1300.0000", + "currency_code": "RUB", + "auto_action_enabled": false + }, + "price_index": "0.00", + "commissions": { + "sales_percent": 0, + "fbo_fulfillment_amount": 0, + "fbo_direct_flow_trans_min_amount": 0, + "fbo_direct_flow_trans_max_amount": 0, + "fbo_deliv_to_customer_amount": 0, + "fbo_return_flow_amount": 0, + "fbo_return_flow_trans_min_amount": 0, + "fbo_return_flow_trans_max_amount": 0, + "fbs_first_mile_min_amount": 0, + "fbs_first_mile_max_amount": 25, + "fbs_direct_flow_trans_min_amount": 0, + "fbs_direct_flow_trans_max_amount": 0, + "fbs_deliv_to_customer_amount": 0, + "fbs_return_flow_amount": 0, + "fbs_return_flow_trans_min_amount": 0, + "fbs_return_flow_trans_max_amount": 0, + "sales_percent_fbo": 0, + "sales_percent_fbs": 0 + }, + "marketing_actions": null, + "volume_weight": 0.1, + "price_indexes": { + "price_index": "WITHOUT_INDEX", + "external_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "ozon_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "self_marketplaces_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + } + }, + "acquiring": 0 + }, + { + "product_id": 1179307106, + "offer_id": "143210611", + "price": { + "price": "1300.0000", + "old_price": "1300.0000", + "premium_price": "", + "recommended_price": "", + "retail_price": "0.0000", + "vat": "0.100000", + "min_ozon_price": "", + "marketing_price": "", + "marketing_seller_price": "", + "min_price": "0.0000", + "currency_code": "RUB", + "auto_action_enabled": false + }, + "price_index": "0.00", + "commissions": { + "sales_percent": 0, + "fbo_fulfillment_amount": 0, + "fbo_direct_flow_trans_min_amount": 0, + "fbo_direct_flow_trans_max_amount": 0, + "fbo_deliv_to_customer_amount": 0, + "fbo_return_flow_amount": 0, + "fbo_return_flow_trans_min_amount": 0, + "fbo_return_flow_trans_max_amount": 0, +... +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-products-stocks.md b/docs/en/md/Ozon/Prices-and-stocks/Get-products-stocks.md deleted file mode 100644 index 47b8b609a4..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Get-products-stocks.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get products stocks - Gets the number of items in the balance with or without filtering - - - -`Function GetProductsStocks(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | - | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v3/product/info/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoStocksV3) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - IDArray = New Array; - IDArray.Add("143210608"); - - Filter = New Structure; - Filter.Insert("visibility" , "ALL"); - Filter.Insert("offer_id" , IDArray); - - Result = OPI_Ozon.GetProductsStocks(ClientID, APIKey, Filter); -``` - - - - -```json title="Result" -{ - "result": { - "items": [], - "total": 0, - "last_id": "" - } -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Get-products-stocks.mdx b/docs/en/md/Ozon/Prices-and-stocks/Get-products-stocks.mdx new file mode 100644 index 0000000000..18da145835 --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Get-products-stocks.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get products stocks + Gets the number of items in the balance with or without filtering + + + +`Function GetProductsStocks(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | + | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v3/product/info/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoStocksV3) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + IDArray = New Array; + IDArray.Add("143210608"); + + Filter = New Structure; + Filter.Insert("visibility" , "ALL"); + Filter.Insert("offer_id" , IDArray); + + Result = OPI_Ozon.GetProductsStocks(ClientID, APIKey, Filter); +``` + + + + +```json title="Result" +{ + "result": { + "items": [], + "total": 0, + "last_id": "" + } +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Set-product-discount.md b/docs/en/md/Ozon/Prices-and-stocks/Set-product-discount.md deleted file mode 100644 index 33639165ce..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Set-product-discount.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Set product discount - Sets the amount of discount on discounted products sold under the FBS scheme - - - -`Function SetProductDiscount(Val ClientID, Val APIKey, Val ProductID, Val Discount) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductID | --productid | String, Number | Product identifier | - | Discount | --discount | String, Number | Discount amount | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/update/discount](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateDiscount) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = 1156646653; - - Discount = 10; - - Result = OPI_Ozon.SetProductDiscount(ClientID, APIKey, ProductID, Discount); -``` - - - - -```json title="Result" -{ - "code": 5, - "message": "item discount not found", - "details": [] -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Set-product-discount.mdx b/docs/en/md/Ozon/Prices-and-stocks/Set-product-discount.mdx new file mode 100644 index 0000000000..4ba8ed4bba --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Set-product-discount.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Set product discount + Sets the amount of discount on discounted products sold under the FBS scheme + + + +`Function SetProductDiscount(Val ClientID, Val APIKey, Val ProductID, Val Discount) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductID | --productid | String, Number | Product identifier | + | Discount | --discount | String, Number | Discount amount | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/update/discount](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateDiscount) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = 1156646653; + + Discount = 10; + + Result = OPI_Ozon.SetProductDiscount(ClientID, APIKey, ProductID, Discount); +``` + + + + +```json title="Result" +{ + "code": 5, + "message": "item discount not found", + "details": [] +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Update-products-prices.md b/docs/en/md/Ozon/Prices-and-stocks/Update-products-prices.md deleted file mode 100644 index d312998570..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Update-products-prices.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Update products prices - Changes the price of one or more items - - - -`Function UpdateProductsPrices(Val ClientID, Val APIKey, Val Prices) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Prices | --prices | Array of Structure | Products prices. See GetProductPriceStructure | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Prices = New Structure; - Prices.Insert("auto_action_enabled" , "DISABLED"); - Prices.Insert("currency_code" , "RUB"); - Prices.Insert("min_price" , "1300"); - Prices.Insert("offer_id" , "143210610"); - Prices.Insert("old_price" , "1400"); - Prices.Insert("price" , "1300"); - Prices.Insert("price_strategy_enabled", "DISABLED"); - Prices.Insert("product_id" , ProductID); - - Result = OPI_Ozon.UpdateProductsPrices(ClientID, APIKey, Prices); -``` - - - - -```json title="Result" -{ - "result": [ - { - "product_id": 1179304145, - "offer_id": "143210610", - "updated": true, - "errors": [] - } - ] -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Update-products-prices.mdx b/docs/en/md/Ozon/Prices-and-stocks/Update-products-prices.mdx new file mode 100644 index 0000000000..c92803fef1 --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Update-products-prices.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Update products prices + Changes the price of one or more items + + + +`Function UpdateProductsPrices(Val ClientID, Val APIKey, Val Prices) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Prices | --prices | Array of Structure | Products prices. See GetProductPriceStructure | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Prices = New Structure; + Prices.Insert("auto_action_enabled" , "DISABLED"); + Prices.Insert("currency_code" , "RUB"); + Prices.Insert("min_price" , "1300"); + Prices.Insert("offer_id" , "143210610"); + Prices.Insert("old_price" , "1400"); + Prices.Insert("price" , "1300"); + Prices.Insert("price_strategy_enabled", "DISABLED"); + Prices.Insert("product_id" , ProductID); + + Result = OPI_Ozon.UpdateProductsPrices(ClientID, APIKey, Prices); +``` + + + + +```json title="Result" +{ + "result": [ + { + "product_id": 1179304145, + "offer_id": "143210610", + "updated": true, + "errors": [] + } + ] +} +``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Update-products-stocks.md b/docs/en/md/Ozon/Prices-and-stocks/Update-products-stocks.md deleted file mode 100644 index 3bef1d8e2b..0000000000 --- a/docs/en/md/Ozon/Prices-and-stocks/Update-products-stocks.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Update products stocks - Changes the information about the stock amount of a product - - - -`Function UpdateProductsStocks(Val ClientID, Val APIKey, Val Stocks) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Stocks | --stocks | Array of Structure | Array of stocks data. See GetProductStocksStructure | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can change availability for 100 products per request. You can send up to 80 requests per minute from one merchant account. - - You can only update the stock of an item in one warehouse once every 2 minutes. You can set the availability of a product only after its status changes to price_sent - - Stocks of bulky goods can only be renewed in the warehouses designated for them - - Method at API documentation: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Stocks = New Structure; - Stocks.Insert("offer_id" , "143210610"); - Stocks.Insert("product_id" , ProductID); - Stocks.Insert("stock" , 20); - Stocks.Insert("warehouse_id", 1); - - Result = OPI_Ozon.UpdateProductsStocks(ClientID, APIKey, Stocks); -``` - - - - -```json title="Result" -{ - "result": [ - { - "warehouse_id": 1, - "product_id": 0, - "offer_id": "143210610", - "updated": false, - "errors": [ - { - "code": "WAREHOUSE_NOT_FOUND", - "message": "warehouse has wrong id: 1" - } - ] - } - ] -} -``` diff --git a/docs/en/md/Ozon/Prices-and-stocks/Update-products-stocks.mdx b/docs/en/md/Ozon/Prices-and-stocks/Update-products-stocks.mdx new file mode 100644 index 0000000000..ee3a9c2ae3 --- /dev/null +++ b/docs/en/md/Ozon/Prices-and-stocks/Update-products-stocks.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Update products stocks + Changes the information about the stock amount of a product + + + +`Function UpdateProductsStocks(Val ClientID, Val APIKey, Val Stocks) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Stocks | --stocks | Array of Structure | Array of stocks data. See GetProductStocksStructure | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can change availability for 100 products per request. You can send up to 80 requests per minute from one merchant account. + + You can only update the stock of an item in one warehouse once every 2 minutes. You can set the availability of a product only after its status changes to price_sent + + Stocks of bulky goods can only be renewed in the warehouses designated for them + + Method at API documentation: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Stocks = New Structure; + Stocks.Insert("offer_id" , "143210610"); + Stocks.Insert("product_id" , ProductID); + Stocks.Insert("stock" , 20); + Stocks.Insert("warehouse_id", 1); + + Result = OPI_Ozon.UpdateProductsStocks(ClientID, APIKey, Stocks); +``` + + + + +```json title="Result" +{ + "result": [ + { + "warehouse_id": 1, + "product_id": 0, + "offer_id": "143210610", + "updated": false, + "errors": [ + { + "code": "WAREHOUSE_NOT_FOUND", + "message": "warehouse has wrong id: 1" + } + ] + } + ] +} +``` diff --git a/docs/en/md/Ozon/Promotions-managment/Get-available-promo-products.md b/docs/en/md/Ozon/Promotions-managment/Get-available-promo-products.md deleted file mode 100644 index 078659fd3e..0000000000 --- a/docs/en/md/Ozon/Promotions-managment/Get-available-promo-products.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get available promo products - Gets the products available in the selected promotion - - - -`Function GetAvailablePromoProducts(Val ClientID, Val APIKey, Val PromoID, Val Indent = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | PromoID | --actionid | Number | Promo ID | - | Indent | --offset | Number | Offst of items list | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/actions/candidates](https://docs.ozon.ru/api/seller/#operation/PromosCandidates) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - PromoID = 111111111; - - Result = OPI_Ozon.GetAvailablePromoProducts(ClientID, APIKey, PromoID); -``` - - - - -```json title="Result" -{ - "code": 5, - "message": "Resource not found", - "details": [] -} -``` diff --git a/docs/en/md/Ozon/Promotions-managment/Get-available-promo-products.mdx b/docs/en/md/Ozon/Promotions-managment/Get-available-promo-products.mdx new file mode 100644 index 0000000000..6e17d84df1 --- /dev/null +++ b/docs/en/md/Ozon/Promotions-managment/Get-available-promo-products.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get available promo products + Gets the products available in the selected promotion + + + +`Function GetAvailablePromoProducts(Val ClientID, Val APIKey, Val PromoID, Val Indent = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | PromoID | --actionid | Number | Promo ID | + | Indent | --offset | Number | Offst of items list | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/actions/candidates](https://docs.ozon.ru/api/seller/#operation/PromosCandidates) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + PromoID = 111111111; + + Result = OPI_Ozon.GetAvailablePromoProducts(ClientID, APIKey, PromoID); +``` + + + + +```json title="Result" +{ + "code": 5, + "message": "Resource not found", + "details": [] +} +``` diff --git a/docs/en/md/Ozon/Promotions-managment/Get-current-promo-products.md b/docs/en/md/Ozon/Promotions-managment/Get-current-promo-products.md deleted file mode 100644 index 24442af881..0000000000 --- a/docs/en/md/Ozon/Promotions-managment/Get-current-promo-products.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get current promo products - Gets the products featured in the selected promotion - - - -`Function GetCurrentPromoProducts(Val ClientID, Val APIKey, Val PromoID, Val Indent = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | PromoID | --actionid | Number | Promo ID | - | Indent | --offset | Number | Offst of items list | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/actions/products](https://docs.ozon.ru/api/seller/#operation/PromosProducts) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - PromoID = 111111111; - - Result = OPI_Ozon.GetCurrentPromoProducts(ClientID, APIKey, PromoID); -``` - - - - -```json title="Result" -{ - "code": 5, - "message": "Resource not found", - "details": [] -} -``` diff --git a/docs/en/md/Ozon/Promotions-managment/Get-current-promo-products.mdx b/docs/en/md/Ozon/Promotions-managment/Get-current-promo-products.mdx new file mode 100644 index 0000000000..df313a5ff1 --- /dev/null +++ b/docs/en/md/Ozon/Promotions-managment/Get-current-promo-products.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get current promo products + Gets the products featured in the selected promotion + + + +`Function GetCurrentPromoProducts(Val ClientID, Val APIKey, Val PromoID, Val Indent = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | PromoID | --actionid | Number | Promo ID | + | Indent | --offset | Number | Offst of items list | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/actions/products](https://docs.ozon.ru/api/seller/#operation/PromosProducts) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + PromoID = 111111111; + + Result = OPI_Ozon.GetCurrentPromoProducts(ClientID, APIKey, PromoID); +``` + + + + +```json title="Result" +{ + "code": 5, + "message": "Resource not found", + "details": [] +} +``` diff --git a/docs/en/md/Ozon/Promotions-managment/Get-promotions-list.md b/docs/en/md/Ozon/Promotions-managment/Get-promotions-list.md deleted file mode 100644 index d8ba6ef385..0000000000 --- a/docs/en/md/Ozon/Promotions-managment/Get-promotions-list.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get promotions list - Gets a list of available promotions - - - -`Function GetPromotionsList(Val ClientID, Val APIKey) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/actions](https://docs.ozon.ru/api/seller/#operation/Promos) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - Result = OPI_Ozon.GetPromotionsList(ClientID, APIKey); -``` - - - - -```json title="Result" -{ - "result": [] -} -``` diff --git a/docs/en/md/Ozon/Promotions-managment/Get-promotions-list.mdx b/docs/en/md/Ozon/Promotions-managment/Get-promotions-list.mdx new file mode 100644 index 0000000000..ec62747b04 --- /dev/null +++ b/docs/en/md/Ozon/Promotions-managment/Get-promotions-list.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get promotions list + Gets a list of available promotions + + + +`Function GetPromotionsList(Val ClientID, Val APIKey) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/actions](https://docs.ozon.ru/api/seller/#operation/Promos) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + Result = OPI_Ozon.GetPromotionsList(ClientID, APIKey); +``` + + + + +```json title="Result" +{ + "result": [] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.md b/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.md deleted file mode 100644 index 65b702b252..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 25 ---- - -# Add product video cover - Adds a video cover to the product attributes - - - -`Function AddProductVideoCover(ItemStructure, Val URL) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ItemStructure | --item | Structure Of String | The basic structure of the product fields. See GetProductStructure | - | URL | --url | String | URL of the video cover | - - - Returns: Structure of KeyAndValue - Structure of product fields with added video - -
- -:::tip -In 1C the method can be used as a procedure, without getting a return value. Return value is required for CLI version -::: -
- - -```bsl title="Code example" - Video = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; - - ItemStructure = New Structure; - ItemStructure.Insert("description_category_id", 17028922); - ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); - ItemStructure.Insert("offer_id" , "143210608"); - ItemStructure.Insert("barcode" , "112772873170"); - ItemStructure.Insert("price" , "1000"); - ItemStructure.Insert("old_price" , "1100"); - ItemStructure.Insert("vat" , "0.1"); - ItemStructure.Insert("height" , 250); - ItemStructure.Insert("width" , 150); - ItemStructure.Insert("depth" , 10); - ItemStructure.Insert("dimension_unit" , "mm"); - ItemStructure.Insert("weight" , 100); - ItemStructure.Insert("weight_unit" , "g"); - - // Videocover - - OPI_Ozon.AddProductVideoCover(ItemStructure, Video); -``` - - - - -```json title="Result" -{ - "description_category_id": 17028922, - "name": "Protective film set for X3 NFC. Dark cotton", - "offer_id": "143210608", - "barcode": "112772873170", - "price": "1000", - "old_price": "1100", - "vat": "0.1", - "height": 250, - "width": 150, - "depth": 10, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "complex_attributes": [ - { - "attributes": [ - { - "id": 21845, - "complex_id": 100002, - "values": [ - { - "dictionary_value_id": 0, - "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" - } - ] - } - ] - } - ] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.mdx new file mode 100644 index 0000000000..b68467760b --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 25 +--- + +# Add product video cover + Adds a video cover to the product attributes + + + +`Function AddProductVideoCover(ItemStructure, Val URL) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ItemStructure | --item | Structure Of String | The basic structure of the product fields. See GetProductStructure | + | URL | --url | String | URL of the video cover | + + + Returns: Structure of KeyAndValue - Structure of product fields with added video + +
+ +:::tip +In 1C the method can be used as a procedure, without getting a return value. Return value is required for CLI version +::: +
+ + +```bsl title="Code example" + Video = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; + + ItemStructure = New Structure; + ItemStructure.Insert("description_category_id", 17028922); + ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); + ItemStructure.Insert("offer_id" , "143210608"); + ItemStructure.Insert("barcode" , "112772873170"); + ItemStructure.Insert("price" , "1000"); + ItemStructure.Insert("old_price" , "1100"); + ItemStructure.Insert("vat" , "0.1"); + ItemStructure.Insert("height" , 250); + ItemStructure.Insert("width" , 150); + ItemStructure.Insert("depth" , 10); + ItemStructure.Insert("dimension_unit" , "mm"); + ItemStructure.Insert("weight" , 100); + ItemStructure.Insert("weight_unit" , "g"); + + // Videocover + + OPI_Ozon.AddProductVideoCover(ItemStructure, Video); +``` + + + + +```json title="Result" +{ + "description_category_id": 17028922, + "name": "Protective film set for X3 NFC. Dark cotton", + "offer_id": "143210608", + "barcode": "112772873170", + "price": "1000", + "old_price": "1100", + "vat": "0.1", + "height": 250, + "width": 150, + "depth": 10, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "complex_attributes": [ + { + "attributes": [ + { + "id": 21845, + "complex_id": 100002, + "values": [ + { + "dictionary_value_id": 0, + "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" + } + ] + } + ] + } + ] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video.md b/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video.md deleted file mode 100644 index 4fa0d108cd..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -sidebar_position: 24 ---- - -# Add product video - Adds video to product attributes - - - -`Function AddProductVideo(ItemStructure, Val URL, Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ItemStructure | --item | Structure Of String | The basic structure of the product fields. See GetProductStructure | - | URL | --url | String | URL of the video | - | Name | --title | String | Technical name of the video | - - - Returns: Structure of KeyAndValue - Structure of product fields with added video - -
- -:::tip -In 1C the method can be used as a procedure, without getting a return value. Return value is required for CLI version -::: -
- - -```bsl title="Code example" - Video = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; - - ItemStructure = New Structure; - ItemStructure.Insert("description_category_id", 17028922); - ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); - ItemStructure.Insert("offer_id" , "143210608"); - ItemStructure.Insert("barcode" , "112772873170"); - ItemStructure.Insert("price" , "1000"); - ItemStructure.Insert("old_price" , "1100"); - ItemStructure.Insert("vat" , "0.1"); - ItemStructure.Insert("height" , 250); - ItemStructure.Insert("width" , 150); - ItemStructure.Insert("depth" , 10); - ItemStructure.Insert("dimension_unit" , "mm"); - ItemStructure.Insert("weight" , 100); - ItemStructure.Insert("weight_unit" , "g"); - - // Video - - OPI_Ozon.AddProductVideo(ItemStructure, Video, "viedo1"); -``` - - - - -```json title="Result" -{ - "description_category_id": 17028922, - "name": "Protective film set for X3 NFC. Dark cotton", - "offer_id": "143210608", - "barcode": "112772873170", - "price": "1000", - "old_price": "1100", - "vat": "0.1", - "height": 250, - "width": 150, - "depth": 10, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "complex_attributes": [ - { - "attributes": [ - { - "id": 21841, - "complex_id": 100001, - "values": [ - { - "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" - } - ] - }, - { - "id": 21837, - "complex_id": 100001, - "values": [ - { - "value": "viedo1" - } - ] - } - ] - } - ] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video.mdx new file mode 100644 index 0000000000..db5830568f --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Add-product-video.mdx @@ -0,0 +1,98 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 24 +--- + +# Add product video + Adds video to product attributes + + + +`Function AddProductVideo(ItemStructure, Val URL, Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ItemStructure | --item | Structure Of String | The basic structure of the product fields. See GetProductStructure | + | URL | --url | String | URL of the video | + | Name | --title | String | Technical name of the video | + + + Returns: Structure of KeyAndValue - Structure of product fields with added video + +
+ +:::tip +In 1C the method can be used as a procedure, without getting a return value. Return value is required for CLI version +::: +
+ + +```bsl title="Code example" + Video = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; + + ItemStructure = New Structure; + ItemStructure.Insert("description_category_id", 17028922); + ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); + ItemStructure.Insert("offer_id" , "143210608"); + ItemStructure.Insert("barcode" , "112772873170"); + ItemStructure.Insert("price" , "1000"); + ItemStructure.Insert("old_price" , "1100"); + ItemStructure.Insert("vat" , "0.1"); + ItemStructure.Insert("height" , 250); + ItemStructure.Insert("width" , 150); + ItemStructure.Insert("depth" , 10); + ItemStructure.Insert("dimension_unit" , "mm"); + ItemStructure.Insert("weight" , 100); + ItemStructure.Insert("weight_unit" , "g"); + + // Video + + OPI_Ozon.AddProductVideo(ItemStructure, Video, "viedo1"); +``` + + + + +```json title="Result" +{ + "description_category_id": 17028922, + "name": "Protective film set for X3 NFC. Dark cotton", + "offer_id": "143210608", + "barcode": "112772873170", + "price": "1000", + "old_price": "1100", + "vat": "0.1", + "height": 250, + "width": 150, + "depth": 10, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "complex_attributes": [ + { + "attributes": [ + { + "id": 21841, + "complex_id": 100001, + "values": [ + { + "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" + } + ] + }, + { + "id": 21837, + "complex_id": 100001, + "values": [ + { + "value": "viedo1" + } + ] + } + ] + } + ] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Archive-products.md b/docs/en/md/Ozon/Uploading-and-updating-products/Archive-products.md deleted file mode 100644 index 6f9f1bfeec..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Archive-products.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Archive products - Moves selected items to the archive - - - -`Function ArchiveProducts(Val ClientID, Val APIKey, Val ProductsID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsID | --products | String, Number, Array of String, Number | Product IDs for archiving | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can pass up to 100 identifiers at a time - - Method at API documentation: [post /v1/product/archive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductArchive) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Result = OPI_Ozon.ArchiveProducts(ClientID, APIKey, ProductID); -``` - - - - -```json title="Result" -{ - "result": true -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Archive-products.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Archive-products.mdx new file mode 100644 index 0000000000..e9ee1ad24a --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Archive-products.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Archive products + Moves selected items to the archive + + + +`Function ArchiveProducts(Val ClientID, Val APIKey, Val ProductsID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsID | --products | String, Number, Array of String, Number | Product IDs for archiving | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can pass up to 100 identifiers at a time + + Method at API documentation: [post /v1/product/archive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductArchive) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Result = OPI_Ozon.ArchiveProducts(ClientID, APIKey, ProductID); +``` + + + + +```json title="Result" +{ + "result": true +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.md b/docs/en/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.md deleted file mode 100644 index 641bff44f2..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Check products images upload - Check images upload by products IDs - - - -`Function CheckProductsImagesUpload(Val ClientID, Val APIKey, Val ProductsID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsID | --products | String, Number, Array of String, Number | Product IDs to be inspected | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/pictures/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductInfoPictures) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Result = OPI_Ozon.CheckProductsImagesUpload(ClientID, APIKey, ProductID); -``` - - - - -```json title="Result" -{ - "result": { - "pictures": [ - { - "product_id": 1215763512, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "state": "imported", - "is_primary": true, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215763512, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215763512, - "url": "GREEN", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": true - } - ] - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.mdx new file mode 100644 index 0000000000..25b4784ca8 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Check products images upload + Check images upload by products IDs + + + +`Function CheckProductsImagesUpload(Val ClientID, Val APIKey, Val ProductsID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsID | --products | String, Number, Array of String, Number | Product IDs to be inspected | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/pictures/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductInfoPictures) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Result = OPI_Ozon.CheckProductsImagesUpload(ClientID, APIKey, ProductID); +``` + + + + +```json title="Result" +{ + "result": { + "pictures": [ + { + "product_id": 1215763512, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "state": "imported", + "is_primary": true, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215763512, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215763512, + "url": "GREEN", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": true + } + ] + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.md b/docs/en/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.md deleted file mode 100644 index d6440aeccb..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -sidebar_position: 26 ---- - -# Complete the complex attribute - Formats the value in attribute format and adds it to the Attributes array of the collection - - - -`Function CompleteComplexAttribute(Collection, Val AttributeID, Val ComplexID, Val Values) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Collection | --object | Structure Of String | Complex attribute structure or product structure | - | AttributeID | --attributeid | String, Number | Attribute ID | - | ComplexID | --complexid | String, Number | Complex attribute ID | - | Values | --values | Arbitrary | Value or array of values to add to Values field | - - - Returns: Structure - A collection enhanced with a new attribute - -
- -:::tip -In 1C the method can be used as a procedure, without getting a return value. Return value is required for CLI version -::: -
- - -```bsl title="Code example" - ItemStructure = New Structure; - ItemStructure.Insert("description_category_id", 17028922); - ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); - ItemStructure.Insert("offer_id" , "143210608"); - ItemStructure.Insert("barcode" , "112772873170"); - ItemStructure.Insert("price" , "1000"); - ItemStructure.Insert("old_price" , "1100"); - ItemStructure.Insert("vat" , "0.1"); - ItemStructure.Insert("height" , 250); - ItemStructure.Insert("width" , 150); - ItemStructure.Insert("depth" , 10); - ItemStructure.Insert("dimension_unit" , "mm"); - ItemStructure.Insert("weight" , 100); - ItemStructure.Insert("weight_unit" , "g"); - - CategoryAttribute1 = New Structure("dictionary_value_id,value", 971082156, "Speaker stand"); - - CategoryAttribute2 = New Structure("value", "Protective film set for X3 NFC. Dark cotton"); - - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 5076 , 0, CategoryAttribute1); - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 9048 , 0, CategoryAttribute2); -``` - - - - -```json title="Result" -{ - "description_category_id": 17028922, - "name": "Protective film set for X3 NFC. Dark cotton", - "offer_id": "143210608", - "barcode": "112772873170", - "price": "1000", - "old_price": "1100", - "vat": "0.1", - "height": 250, - "width": 150, - "depth": 10, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "attributes": [ - { - "id": 5076, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 971082156, - "value": "Speaker stand" - } - ] - }, - { - "id": 9048, - "complex_id": 0, - "values": [ - { - "value": "Protective film set for X3 NFC. Dark cotton" - } - ] - } - ] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.mdx new file mode 100644 index 0000000000..7b7885a721 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.mdx @@ -0,0 +1,97 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 26 +--- + +# Complete the complex attribute + Formats the value in attribute format and adds it to the Attributes array of the collection + + + +`Function CompleteComplexAttribute(Collection, Val AttributeID, Val ComplexID, Val Values) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Collection | --object | Structure Of String | Complex attribute structure or product structure | + | AttributeID | --attributeid | String, Number | Attribute ID | + | ComplexID | --complexid | String, Number | Complex attribute ID | + | Values | --values | Arbitrary | Value or array of values to add to Values field | + + + Returns: Structure - A collection enhanced with a new attribute + +
+ +:::tip +In 1C the method can be used as a procedure, without getting a return value. Return value is required for CLI version +::: +
+ + +```bsl title="Code example" + ItemStructure = New Structure; + ItemStructure.Insert("description_category_id", 17028922); + ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); + ItemStructure.Insert("offer_id" , "143210608"); + ItemStructure.Insert("barcode" , "112772873170"); + ItemStructure.Insert("price" , "1000"); + ItemStructure.Insert("old_price" , "1100"); + ItemStructure.Insert("vat" , "0.1"); + ItemStructure.Insert("height" , 250); + ItemStructure.Insert("width" , 150); + ItemStructure.Insert("depth" , 10); + ItemStructure.Insert("dimension_unit" , "mm"); + ItemStructure.Insert("weight" , 100); + ItemStructure.Insert("weight_unit" , "g"); + + CategoryAttribute1 = New Structure("dictionary_value_id,value", 971082156, "Speaker stand"); + + CategoryAttribute2 = New Structure("value", "Protective film set for X3 NFC. Dark cotton"); + + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 5076 , 0, CategoryAttribute1); + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 9048 , 0, CategoryAttribute2); +``` + + + + +```json title="Result" +{ + "description_category_id": 17028922, + "name": "Protective film set for X3 NFC. Dark cotton", + "offer_id": "143210608", + "barcode": "112772873170", + "price": "1000", + "old_price": "1100", + "vat": "0.1", + "height": 250, + "width": 150, + "depth": 10, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "attributes": [ + { + "id": 5076, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 971082156, + "value": "Speaker stand" + } + ] + }, + { + "id": 9048, + "complex_id": 0, + "values": [ + { + "value": "Protective film set for X3 NFC. Dark cotton" + } + ] + } + ] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.md b/docs/en/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.md deleted file mode 100644 index 89c240318d..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Create products by Ozon ID - Creates a product by specified Ozon ID - - - -`Function CreateProductByOzonID(Val ClientID, Val APIKey, Val ProductsArray) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsArray | --items | Array Of String | Array or one simplified structure of product fields | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can get an empty structure using the GetSimplifiedProductStructure method() - - It is not possible to update a product fields by Ozon ID - - Method at API documentation: [post /v1/product/import-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsBySKU) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - ItemStructure = New Structure; - ItemStructure.Insert("name" , "New imported product"); - ItemStructure.Insert("sku" , 1626044001); - ItemStructure.Insert("offer_id" , "91132"); - ItemStructure.Insert("price" , "1100"); - ItemStructure.Insert("old_price" , "1100"); - ItemStructure.Insert("vat" , "0.1"); - ItemStructure.Insert("currency_code", "RUB"); - - Result = OPI_Ozon.CreateProductByOzonID(ClientID, APIKey, ItemStructure); -``` - - - - -```json title="Result" -{ - "result": { - "task_id": 1347188275, - "unmatched_sku_list": [] - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.mdx new file mode 100644 index 0000000000..0b2b0ea870 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Create products by Ozon ID + Creates a product by specified Ozon ID + + + +`Function CreateProductByOzonID(Val ClientID, Val APIKey, Val ProductsArray) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsArray | --items | Array Of String | Array or one simplified structure of product fields | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can get an empty structure using the GetSimplifiedProductStructure method() + + It is not possible to update a product fields by Ozon ID + + Method at API documentation: [post /v1/product/import-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsBySKU) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + ItemStructure = New Structure; + ItemStructure.Insert("name" , "New imported product"); + ItemStructure.Insert("sku" , 1626044001); + ItemStructure.Insert("offer_id" , "91132"); + ItemStructure.Insert("price" , "1100"); + ItemStructure.Insert("old_price" , "1100"); + ItemStructure.Insert("vat" , "0.1"); + ItemStructure.Insert("currency_code", "RUB"); + + Result = OPI_Ozon.CreateProductByOzonID(ClientID, APIKey, ItemStructure); +``` + + + + +```json title="Result" +{ + "result": { + "task_id": 1347188275, + "unmatched_sku_list": [] + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Create-update-products.md b/docs/en/md/Ozon/Uploading-and-updating-products/Create-update-products.md deleted file mode 100644 index 709626ee49..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Create-update-products.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Create update product - Creates new products or updates existing products, based on data structures - - - -`Function CreateUpdateProducts(Val ClientID, Val APIKey, Val ProductsArray) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsArray | --items | Array Of String | Array or one structure of product description fields | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Methods of product structure formation: GetProductStructure(), AddProductVideo(), AddProductVideoCover() - - Uploading status check - GetProductCreationStatus() - - Method at API documentation: [post /v3/product/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsV3) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; - Video = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; - - ImageArray = New Array; - ImageArray.Add(Image1); - ImageArray.Add(Image2); - - // Common fields - - ItemStructure = New Structure; - ItemStructure.Insert("description_category_id", 17028922); - ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); - ItemStructure.Insert("offer_id" , "143210609"); - ItemStructure.Insert("barcode" , "112772873170"); - ItemStructure.Insert("price" , "1300"); - ItemStructure.Insert("old_price" , "1300"); - ItemStructure.Insert("vat" , "0.1"); - ItemStructure.Insert("height" , 250); - ItemStructure.Insert("width" , 150); - ItemStructure.Insert("depth" , 10); - ItemStructure.Insert("dimension_unit" , "mm"); - ItemStructure.Insert("weight" , 100); - ItemStructure.Insert("weight_unit" , "g"); - ItemStructure.Insert("images" , ImageArray); - - // Video - - OPI_Ozon.AddProductVideo(ItemStructure, Video, "viedo1"); - - // Attributes individualized for different categories - - CategoryAttribute1 = New Structure("dictionary_value_id,value", 971082156, "Speaker stand"); - CategoryAttribute2 = New Structure("dictionary_value_id,value", 5060050 , "Samsung"); - CategoryAttribute3 = New Structure("dictionary_value_id,value", 61576 , "gray"); - CategoryAttribute4 = New Structure("dictionary_value_id,value", 95911 , "Protective film set for X3 NFC. Dark cotton"); - - CategoryAttribute5 = New Structure("value", "Protective film set for X3 NFC. Dark cotton"); - - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 5076 , 0, CategoryAttribute1); - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 85 , 0, CategoryAttribute2); - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 10096, 0, CategoryAttribute3); - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 8229 , 0, CategoryAttribute4); - OPI_Ozon.CompleteComplexAttribute(ItemStructure, 9048 , 0, CategoryAttribute5); - - Result = OPI_Ozon.CreateUpdateProducts(ClientID, APIKey, ItemStructure); -``` - - - - -```json title="Result" -{ - "result": { - "task_id": 1347187465 - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Create-update-products.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Create-update-products.mdx new file mode 100644 index 0000000000..b403f57127 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Create-update-products.mdx @@ -0,0 +1,96 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Create update product + Creates new products or updates existing products, based on data structures + + + +`Function CreateUpdateProducts(Val ClientID, Val APIKey, Val ProductsArray) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsArray | --items | Array Of String | Array or one structure of product description fields | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Methods of product structure formation: GetProductStructure(), AddProductVideo(), AddProductVideoCover() + + Uploading status check - GetProductCreationStatus() + + Method at API documentation: [post /v3/product/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsV3) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; + Video = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; + + ImageArray = New Array; + ImageArray.Add(Image1); + ImageArray.Add(Image2); + + // Common fields + + ItemStructure = New Structure; + ItemStructure.Insert("description_category_id", 17028922); + ItemStructure.Insert("name" , "Protective film set for X3 NFC. Dark cotton"); + ItemStructure.Insert("offer_id" , "143210609"); + ItemStructure.Insert("barcode" , "112772873170"); + ItemStructure.Insert("price" , "1300"); + ItemStructure.Insert("old_price" , "1300"); + ItemStructure.Insert("vat" , "0.1"); + ItemStructure.Insert("height" , 250); + ItemStructure.Insert("width" , 150); + ItemStructure.Insert("depth" , 10); + ItemStructure.Insert("dimension_unit" , "mm"); + ItemStructure.Insert("weight" , 100); + ItemStructure.Insert("weight_unit" , "g"); + ItemStructure.Insert("images" , ImageArray); + + // Video + + OPI_Ozon.AddProductVideo(ItemStructure, Video, "viedo1"); + + // Attributes individualized for different categories + + CategoryAttribute1 = New Structure("dictionary_value_id,value", 971082156, "Speaker stand"); + CategoryAttribute2 = New Structure("dictionary_value_id,value", 5060050 , "Samsung"); + CategoryAttribute3 = New Structure("dictionary_value_id,value", 61576 , "gray"); + CategoryAttribute4 = New Structure("dictionary_value_id,value", 95911 , "Protective film set for X3 NFC. Dark cotton"); + + CategoryAttribute5 = New Structure("value", "Protective film set for X3 NFC. Dark cotton"); + + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 5076 , 0, CategoryAttribute1); + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 85 , 0, CategoryAttribute2); + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 10096, 0, CategoryAttribute3); + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 8229 , 0, CategoryAttribute4); + OPI_Ozon.CompleteComplexAttribute(ItemStructure, 9048 , 0, CategoryAttribute5); + + Result = OPI_Ozon.CreateUpdateProducts(ClientID, APIKey, ItemStructure); +``` + + + + +```json title="Result" +{ + "result": { + "task_id": 1347187465 + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.md b/docs/en/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.md deleted file mode 100644 index 69b61730f7..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Delete products without SKU - Deletes products without SKU from archive - - - -`Function DeleteProductsWithoutSKU(Val ClientID, Val APIKey, Val Articles) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Articles | --articles | String, Number, Array of String, Number | Products articles | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -The product must be pre-archived (see ArchiveProducts) - - Up to 500 identifiers can be passed in one request - - Method at API documentation: [post /v2/products/delete](https://docs.ozon.ru/api/seller/#operation/ProductAPI_DeleteProducts) -::: -
- - -```bsl title="Code example" - OPI_Tools.Pause(30); - - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Result = OPI_Ozon.ArchiveProducts(ClientID, APIKey, ProductID); - - Article = "143210609"; - - Result = OPI_Ozon.DeleteProductsWithoutSKU(ClientID, APIKey, Article); -``` - - - - -```json title="Result" -{ - "status": [ - { - "offer_id": "143210609", - "is_deleted": true, - "error": "" - } - ] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.mdx new file mode 100644 index 0000000000..407b6f9ddd --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Delete products without SKU + Deletes products without SKU from archive + + + +`Function DeleteProductsWithoutSKU(Val ClientID, Val APIKey, Val Articles) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Articles | --articles | String, Number, Array of String, Number | Products articles | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +The product must be pre-archived (see ArchiveProducts) + + Up to 500 identifiers can be passed in one request + + Method at API documentation: [post /v2/products/delete](https://docs.ozon.ru/api/seller/#operation/ProductAPI_DeleteProducts) +::: +
+ + +```bsl title="Code example" + OPI_Tools.Pause(30); + + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Result = OPI_Ozon.ArchiveProducts(ClientID, APIKey, ProductID); + + Article = "143210609"; + + Result = OPI_Ozon.DeleteProductsWithoutSKU(ClientID, APIKey, Article); +``` + + + + +```json title="Result" +{ + "status": [ + { + "offer_id": "143210609", + "is_deleted": true, + "error": "" + } + ] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.md deleted file mode 100644 index b0962f9568..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 22 ---- - -# Get attributes update structure - Gets the structure for updating product characteristics in the UpdateProductsAttributes function() - - - -`Function GetAttributesUpdateStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Product fields structure - -
- -:::tip -Attributes are structures with complex_id, id and values fields. For their quick creation there is the CompleteComplexAttribute method() -::: -
- - -```bsl title="Code example" - Result = OPI_Ozon.GetAttributesUpdateStructure(); -``` - - - - -```json title="Result" -{ - "offer_id": "
", - "attributes": "" -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.mdx new file mode 100644 index 0000000000..ec11a207d8 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 22 +--- + +# Get attributes update structure + Gets the structure for updating product characteristics in the UpdateProductsAttributes function() + + + +`Function GetAttributesUpdateStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Product fields structure + +
+ +:::tip +Attributes are structures with complex_id, id and values fields. For their quick creation there is the CompleteComplexAttribute method() +::: +
+ + +```bsl title="Code example" + Result = OPI_Ozon.GetAttributesUpdateStructure(); +``` + + + + +```json title="Result" +{ + "offer_id": "
", + "attributes": "" +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.md deleted file mode 100644 index f42854f472..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 19 ---- - -# Get codes upload status - Gets the status of digital item codes upload by task ID - - - -`Function GetCodesUploadStatus(Val ClientID, Val APIKey, Val TaskID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | TaskID | --taskid | String, Number | Add product task ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/upload_digital_codes/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCodeInfo) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - TaskID = "1"; - - Result = OPI_Ozon.GetCodesUploadStatus(ClientID, APIKey, TaskID); -``` - - - - -```json title="Result" -{ - "code": 7, - "message": "s2s: method \"/endpoints.v1.Service/GetDigitalCodesTaskByID\" is not allowed for the provided access tokens: permission denied", - "details": [] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.mdx new file mode 100644 index 0000000000..457f744c69 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 19 +--- + +# Get codes upload status + Gets the status of digital item codes upload by task ID + + + +`Function GetCodesUploadStatus(Val ClientID, Val APIKey, Val TaskID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | TaskID | --taskid | String, Number | Add product task ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/upload_digital_codes/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCodeInfo) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + TaskID = "1"; + + Result = OPI_Ozon.GetCodesUploadStatus(ClientID, APIKey, TaskID); +``` + + + + +```json title="Result" +{ + "code": 7, + "message": "s2s: method \"/endpoints.v1.Service/GetDigitalCodesTaskByID\" is not allowed for the provided access tokens: permission denied", + "details": [] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.md deleted file mode 100644 index d54d6b560e..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 18 ---- - -# Get product creation status - Gets the status of adding a new product by task ID - - - -`Function GetProductCreationStatus(Val ClientID, Val APIKey, Val TaskID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | TaskID | --taskid | String, Number | Add product task ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/import/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetImportProductsInfo) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - TaskID = "1352681806"; - - Result = OPI_Ozon.GetProductCreationStatus(ClientID, APIKey, TaskID); -``` - - - - -```json title="Result" -{ - "result": { - "items": [ - { - "offer_id": "143210609", - "product_id": 1215763512, - "status": "imported", - "errors": [ - { - "code": "SELLER_NO_CONTRACT_FAILED", - "field": "", - "attribute_id": 0, - "state": "unmatched", - "level": "error", - "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", - "optional_description_elements": {}, - "attribute_name": "", - "message": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете." - } - ] - } - ], - "total": 1 - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.mdx new file mode 100644 index 0000000000..4848feff83 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 18 +--- + +# Get product creation status + Gets the status of adding a new product by task ID + + + +`Function GetProductCreationStatus(Val ClientID, Val APIKey, Val TaskID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | TaskID | --taskid | String, Number | Add product task ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/import/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetImportProductsInfo) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + TaskID = "1352681806"; + + Result = OPI_Ozon.GetProductCreationStatus(ClientID, APIKey, TaskID); +``` + + + + +```json title="Result" +{ + "result": { + "items": [ + { + "offer_id": "143210609", + "product_id": 1215763512, + "status": "imported", + "errors": [ + { + "code": "SELLER_NO_CONTRACT_FAILED", + "field": "", + "attribute_id": 0, + "state": "unmatched", + "level": "error", + "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", + "optional_description_elements": {}, + "attribute_name": "", + "message": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете." + } + ] + } + ], + "total": 1 + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-description.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-description.md deleted file mode 100644 index d80287eda5..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-description.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get product description - Get product description by IDs - - - -`Function GetProductDescription(Val ClientID, Val APIKey, Val ProductID = 0, Val Article = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductID | --productid | String, Number | Product identifier | - | Article | --offerid | String, Number | Item identifier in the vendor's system (Article) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/info/description](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDescription) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - Article = "143210609"; - - Result = OPI_Ozon.GetProductDescription(ClientID, APIKey, , Article); -``` - - - - -```json title="Result" -{ - "result": { - "id": 1215763512, - "offer_id": "143210609", - "name": "Protective film set for X3 NFC. Dark cotton", - "description": "" - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-description.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-description.mdx new file mode 100644 index 0000000000..676aa4ac9d --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-description.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get product description + Get product description by IDs + + + +`Function GetProductDescription(Val ClientID, Val APIKey, Val ProductID = 0, Val Article = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductID | --productid | String, Number | Product identifier | + | Article | --offerid | String, Number | Item identifier in the vendor's system (Article) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/info/description](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDescription) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + Article = "143210609"; + + Result = OPI_Ozon.GetProductDescription(ClientID, APIKey, , Article); +``` + + + + +```json title="Result" +{ + "result": { + "id": 1215763512, + "offer_id": "143210609", + "name": "Protective film set for X3 NFC. Dark cotton", + "description": "" + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-list.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-list.md deleted file mode 100644 index bac234945b..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-list.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get product list - Gets a list of products with or without filter - - - -`Function GetProductList(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | - | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - IDArray = New Array; - IDArray.Add("143210609"); - - Filter = New Structure; - Filter.Insert("visibility" , "ALL"); - Filter.Insert("offer_id" , IDArray); - - Result = OPI_Ozon.GetProductList(ClientID, APIKey, Filter); -``` - - - - -```json title="Result" -{ - "result": { - "items": [ - { - "product_id": 1215763512, - "offer_id": "143210609", - "is_fbo_visible": false, - "is_fbs_visible": false, - "archived": false, - "is_discounted": false - } - ], - "total": 1, - "last_id": "WzEyMTU3NjM1MTIsMTIxNTc2MzUxMl0=" - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-list.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-list.mdx new file mode 100644 index 0000000000..a9ad379893 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-list.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get product list + Gets a list of products with or without filter + + + +`Function GetProductList(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | + | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + IDArray = New Array; + IDArray.Add("143210609"); + + Filter = New Structure; + Filter.Insert("visibility" , "ALL"); + Filter.Insert("offer_id" , IDArray); + + Result = OPI_Ozon.GetProductList(ClientID, APIKey, Filter); +``` + + + + +```json title="Result" +{ + "result": { + "items": [ + { + "product_id": 1215763512, + "offer_id": "143210609", + "is_fbo_visible": false, + "is_fbs_visible": false, + "archived": false, + "is_discounted": false + } + ], + "total": 1, + "last_id": "WzEyMTU3NjM1MTIsMTIxNTc2MzUxMl0=" + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-structure.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-structure.md deleted file mode 100644 index fe0f4b209b..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Get product structure - Gets the structure of product standard fields - - - -`Function GetProductStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Product fields structure - -
- -:::tip -This structure should be supplemented with fields that depend on the product category from GetCategoryAttributes() - - The first image in the image array (images field) will be the main image -::: -
- - -```bsl title="Code example" - Result = OPI_Ozon.GetProductStructure(); -``` - - - - -```json title="Result" -{ - "description_category_id": "", - "name": "", - "offer_id": "
", - "barcode": "", - "price": "", - "old_price": "", - "vat": "", - "height": "", - "width": "", - "depth": "", - "dimension_unit": "", - "weight": "", - "weight_unit": "", - "images": "", - "images360": "", - "color_image": "" -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-structure.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-structure.mdx new file mode 100644 index 0000000000..1773e2cade --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-structure.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 20 +--- + +# Get product structure + Gets the structure of product standard fields + + + +`Function GetProductStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Product fields structure + +
+ +:::tip +This structure should be supplemented with fields that depend on the product category from GetCategoryAttributes() + + The first image in the image array (images field) will be the main image +::: +
+ + +```bsl title="Code example" + Result = OPI_Ozon.GetProductStructure(); +``` + + + + +```json title="Result" +{ + "description_category_id": "", + "name": "", + "offer_id": "
", + "barcode": "", + "price": "", + "old_price": "", + "vat": "", + "height": "", + "width": "", + "depth": "", + "dimension_unit": "", + "weight": "", + "weight_unit": "", + "images": "", + "images360": "", + "color_image": "" +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.md deleted file mode 100644 index 3e962bfcfb..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 16 ---- - -# Get product subscribers count - Gets the number of users who clicked Know about arrival button on the product page - - - -`Function GetProductSubscribersCount(Val ClientID, Val APIKey, Val SKU) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/info/subscription](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoSubscription) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Result = OPI_Ozon.GetProductSubscribersCount(ClientID, APIKey, SKU); -``` - - - - -```json title="Result" -{ - "result": [ - { - "sku": 1626044001, - "count": 1 - } - ] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.mdx new file mode 100644 index 0000000000..269f6c9a7d --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 16 +--- + +# Get product subscribers count + Gets the number of users who clicked Know about arrival button on the product page + + + +`Function GetProductSubscribersCount(Val ClientID, Val APIKey, Val SKU) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/info/subscription](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoSubscription) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Result = OPI_Ozon.GetProductSubscribersCount(ClientID, APIKey, SKU); +``` + + + + +```json title="Result" +{ + "result": [ + { + "sku": 1626044001, + "count": 1 + } + ] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.md deleted file mode 100644 index 1410a5bd5e..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get products attributes data - Retrieves product attributes descriptions with or without filtering - - - -`Function GetProductsAttributesData(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | - | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v3/products/info/attributes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductAttributesV3) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - IDArray = New Array; - IDArray.Add("143210609"); - - Filter = New Structure; - Filter.Insert("visibility", "ALL"); - Filter.Insert("offer_id" , IDArray); - - Result = OPI_Ozon.GetProductsAttributesData(ClientID, APIKey, Filter); -``` - - - - -```json title="Result" -{ - "result": [ - { - "id": 1215763512, - "barcode": "", - "category_id": 0, - "name": "Protective film set for X3 NFC. Dark cotton", - "offer_id": "143210609", - "height": 250, - "depth": 10, - "width": 150, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "images": [ - { - "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "default": false, - "index": 1 - }, - { - "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "default": false, - "index": 2 - } - ], - "image_group_id": "", - "images360": [], - "pdf_list": [], - "attributes": [ - { - "attribute_id": 85, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 5060050, - "value": "Samsung" - } - ] - }, - { - "attribute_id": 10096, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 61576, - "value": "red" - } - ] - }, - { - "attribute_id": 8229, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 95911, - "value": "Protective film set for X3 NFC. Dark cotton" - } - ] - }, - { - "attribute_id": 9048, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "Protective film set for X3 NFC. Dark cotton" - } - ] - }, - { - "attribute_id": 4180, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "Protective film set for X3 NFC. Dark cotton" - } - ] - }, - { - "attribute_id": 9024, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "143210609" - } - ] - }, - { - "attribute_id": 20900, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "true" - } - ] - } - ], - "complex_attributes": [ - { - "attributes": [ - { - "attribute_id": 21841, - "complex_id": 100001, - "values": [ - { - "dictionary_value_id": 0, - "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" - } - ] - }, - { - "attribute_id": 21837, - "complex_id": 100001, - "values": [ - { - "dictionary_value_id": 0, - "value": "viedo1" - } - ] - } - ] - } - ], - "color_image": "", - "last_id": "", - "description_category_id": 17028922, - "type_id": 95911 - } - ], - "total": 1, - "last_id": "" -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.mdx new file mode 100644 index 0000000000..82e64f2ea2 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.mdx @@ -0,0 +1,187 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get products attributes data + Retrieves product attributes descriptions with or without filtering + + + +`Function GetProductsAttributesData(Val ClientID, Val APIKey, Val Filter = "", Val LastID = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | Filter | --filter | Structure of KeyAndValue | Product selection filter. See GetProductsFilterStructure | + | LastID | --last | String, Number | ID of the last value (last_id) from the previous response | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v3/products/info/attributes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductAttributesV3) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + IDArray = New Array; + IDArray.Add("143210609"); + + Filter = New Structure; + Filter.Insert("visibility", "ALL"); + Filter.Insert("offer_id" , IDArray); + + Result = OPI_Ozon.GetProductsAttributesData(ClientID, APIKey, Filter); +``` + + + + +```json title="Result" +{ + "result": [ + { + "id": 1215763512, + "barcode": "", + "category_id": 0, + "name": "Protective film set for X3 NFC. Dark cotton", + "offer_id": "143210609", + "height": 250, + "depth": 10, + "width": 150, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "images": [ + { + "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "default": false, + "index": 1 + }, + { + "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "default": false, + "index": 2 + } + ], + "image_group_id": "", + "images360": [], + "pdf_list": [], + "attributes": [ + { + "attribute_id": 85, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 5060050, + "value": "Samsung" + } + ] + }, + { + "attribute_id": 10096, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 61576, + "value": "red" + } + ] + }, + { + "attribute_id": 8229, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 95911, + "value": "Protective film set for X3 NFC. Dark cotton" + } + ] + }, + { + "attribute_id": 9048, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "Protective film set for X3 NFC. Dark cotton" + } + ] + }, + { + "attribute_id": 4180, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "Protective film set for X3 NFC. Dark cotton" + } + ] + }, + { + "attribute_id": 9024, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "143210609" + } + ] + }, + { + "attribute_id": 20900, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "true" + } + ] + } + ], + "complex_attributes": [ + { + "attributes": [ + { + "attribute_id": 21841, + "complex_id": 100001, + "values": [ + { + "dictionary_value_id": 0, + "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" + } + ] + }, + { + "attribute_id": 21837, + "complex_id": 100001, + "values": [ + { + "dictionary_value_id": 0, + "value": "viedo1" + } + ] + } + ] + } + ], + "color_image": "", + "last_id": "", + "description_category_id": 17028922, + "type_id": 95911 + } + ], + "total": 1, + "last_id": "" +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.md deleted file mode 100644 index 567836dd57..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get products content rating - Gets products content rating by SKU - - - -`Function GetProductsContentRating(Val ClientID, Val APIKey, Val SKU) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/rating-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductRatingBySku) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Result = OPI_Ozon.GetProductsContentRating(ClientID, APIKey, SKU); -``` - - - - -```json title="Result" -{ - "products": [ - { - "sku": 1626044001, - "rating": 70, - "groups": [ - { - "key": "important_attributes", - "name": "Важные атрибуты", - "rating": 100, - "weight": 30, - "conditions": [ - { - "key": "important_2", - "description": "Заполнено 2 атрибута и более", - "fulfilled": true, - "cost": 50 - }, - { - "key": "important_50_percent", - "description": "Заполнено более 50% атрибутов", - "fulfilled": true, - "cost": 25 - }, - { - "key": "important_70_percent", - "description": "Заполнено более 70% атрибутов", - "fulfilled": true, - "cost": 25 - } - ], - "improve_attributes": [], - "improve_at_least": 0 - }, - { - "key": "other_attributes", - "name": "Остальные атрибуты", - "rating": 100, - "weight": 25, - "conditions": [ - { - "key": "other_2", - "description": "Заполнено 2 атрибута и более", - "fulfilled": true, - "cost": 50 - }, - { - "key": "other_50_percent", - "description": "Заполнено более 50% атрибутов", - "fulfilled": true, - "cost": 50 - } - ], - "improve_attributes": [], - "improve_at_least": 0 - }, - { - "key": "text", - "name": "Текстовое описание", - "rating": 50, - "weight": 20, - "conditions": [ - { - "key": "text_annotation_100_chars", - "description": "Аннотация более 100 знаков", - "fulfilled": true, - "cost": 25 - }, - { - "key": "text_annotation_500_chars", - "description": "Аннотация более 500 знаков", - "fulfilled": true, - "cost": 25 - }, - { - "key": "text_rich", - "description": "Заполнен Rich-контент", - "fulfilled": false, - "cost": 100 - } - ], - "improve_attributes": [ - { - "id": 11254, - "name": "Rich-контент JSON" - } - ], - "improve_at_least": 1 - }, - { - "key": "media", - "name": "Медиа", - "rating": 20, - "weight": 25, - "conditions": [ - { - "key": "media_video_cover", - "description": "Добавлена видеообложка", - "fulfilled": false, - "cost": 50 - }, - { - "key": "media_video", - "description": "Добавлено видео", - "fulfilled": false, - "cost": 30 - }, - { - "key": "media_images_3", - "description": "Добавлено 3 изображения и более", - "fulfilled": true, - "cost": 20 - } - ], - "improve_attributes": [ - { - "id": 21841, - "name": "Озон.Видео: ссылка" - }, - { - "id": 21845, - "name": "Озон.Видеообложка: ссылка" - } - ], - "improve_at_least": 2 - } - ] - } - ] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.mdx new file mode 100644 index 0000000000..7919f32cb6 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.mdx @@ -0,0 +1,174 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get products content rating + Gets products content rating by SKU + + + +`Function GetProductsContentRating(Val ClientID, Val APIKey, Val SKU) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/rating-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductRatingBySku) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Result = OPI_Ozon.GetProductsContentRating(ClientID, APIKey, SKU); +``` + + + + +```json title="Result" +{ + "products": [ + { + "sku": 1626044001, + "rating": 70, + "groups": [ + { + "key": "important_attributes", + "name": "Важные атрибуты", + "rating": 100, + "weight": 30, + "conditions": [ + { + "key": "important_2", + "description": "Заполнено 2 атрибута и более", + "fulfilled": true, + "cost": 50 + }, + { + "key": "important_50_percent", + "description": "Заполнено более 50% атрибутов", + "fulfilled": true, + "cost": 25 + }, + { + "key": "important_70_percent", + "description": "Заполнено более 70% атрибутов", + "fulfilled": true, + "cost": 25 + } + ], + "improve_attributes": [], + "improve_at_least": 0 + }, + { + "key": "other_attributes", + "name": "Остальные атрибуты", + "rating": 100, + "weight": 25, + "conditions": [ + { + "key": "other_2", + "description": "Заполнено 2 атрибута и более", + "fulfilled": true, + "cost": 50 + }, + { + "key": "other_50_percent", + "description": "Заполнено более 50% атрибутов", + "fulfilled": true, + "cost": 50 + } + ], + "improve_attributes": [], + "improve_at_least": 0 + }, + { + "key": "text", + "name": "Текстовое описание", + "rating": 50, + "weight": 20, + "conditions": [ + { + "key": "text_annotation_100_chars", + "description": "Аннотация более 100 знаков", + "fulfilled": true, + "cost": 25 + }, + { + "key": "text_annotation_500_chars", + "description": "Аннотация более 500 знаков", + "fulfilled": true, + "cost": 25 + }, + { + "key": "text_rich", + "description": "Заполнен Rich-контент", + "fulfilled": false, + "cost": 100 + } + ], + "improve_attributes": [ + { + "id": 11254, + "name": "Rich-контент JSON" + } + ], + "improve_at_least": 1 + }, + { + "key": "media", + "name": "Медиа", + "rating": 20, + "weight": 25, + "conditions": [ + { + "key": "media_video_cover", + "description": "Добавлена видеообложка", + "fulfilled": false, + "cost": 50 + }, + { + "key": "media_video", + "description": "Добавлено видео", + "fulfilled": false, + "cost": 30 + }, + { + "key": "media_images_3", + "description": "Добавлено 3 изображения и более", + "fulfilled": true, + "cost": 20 + } + ], + "improve_attributes": [ + { + "id": 21841, + "name": "Озон.Видео: ссылка" + }, + { + "id": 21845, + "name": "Озон.Видеообложка: ссылка" + } + ], + "improve_at_least": 2 + } + ] + } + ] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.md deleted file mode 100644 index 1febcb0e8d..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 23 ---- - -# Get products filter structure - Gets the structure for selecting the list of products - - - -`Function GetProductsFilterStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Filter fields structure - -
- -:::tip -Related functions: GetProductList, GetProductsStocks, GetProductsPrices - - The description of the filter fields can be found on the documentation page for product list retrieving method: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) -::: -
- - -```bsl title="Code example" - Result = OPI_Ozon.GetProductsFilterStructure(); -``` - - - - -```json title="Result" -{ - "offer_id": "", - "product_id": "", - "visibility": "" -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.mdx new file mode 100644 index 0000000000..d1b60bdea7 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 23 +--- + +# Get products filter structure + Gets the structure for selecting the list of products + + + +`Function GetProductsFilterStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Filter fields structure + +
+ +:::tip +Related functions: GetProductList, GetProductsStocks, GetProductsPrices + + The description of the filter fields can be found on the documentation page for product list retrieving method: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) +::: +
+ + +```bsl title="Code example" + Result = OPI_Ozon.GetProductsFilterStructure(); +``` + + + + +```json title="Result" +{ + "offer_id": "", + "product_id": "", + "visibility": "" +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-information.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-information.md deleted file mode 100644 index 64c3a50399..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-information.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get products informations - Gets information about products by an array of identifiers - - - -`Function GetProductsInformation(Val ClientID, Val APIKey, Val ProductsID = 0, Val SKU = 0, Val Articles = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsID | --productid | Number, Array Of Number | Products identifier | - | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | - | Articles | --offerid | String, Array of String | Item identifiers in the vendor's system (Article) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Specify the minimum price of the product after all promotions have been applied in your personal cabinet. The min_price parameter from the method response is being reworked and returns 0 - - The active_product parameter is deprecated, use the values of the visible parameter - - The fbs_sku and fbo_sku parameters from the method response were disabled on August 15, 2023 - - The body of the request must contain a single identifier or an array of identical identifiers, the response will be an array of items - - Method at API documentation: [post /v2/product/info/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoListV2) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - Article = "143210609"; - - Result = OPI_Ozon.GetProductsInformation(ClientID, APIKey, , , Article); -``` - - - - -```json title="Result" -{ - "result": { - "items": [ - { - "id": 1215763512, - "name": "Protective film set for X3 NFC. Dark cotton", - "offer_id": "143210609", - "barcode": "", - "buybox_price": "", - "category_id": 0, - "created_at": "2024-10-09T06:25:24.931356Z", - "images": [ - "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" - ], - "marketing_price": "", - "min_ozon_price": "", - "old_price": "1300.0000", - "premium_price": "", - "price": "1300.0000", - "recommended_price": "", - "min_price": "", - "sources": [], - "stocks": { - "coming": 0, - "present": 0, - "reserved": 0 - }, - "errors": [], - "vat": "0.100000", - "visible": false, - "visibility_details": { - "has_price": false, - "has_stock": false, - "active_product": false, - "reasons": {} - }, - "price_index": "0.00", - "images360": [], - "color_image": "", - "primary_image": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "status": { - "state": "imported", - "state_failed": "unmatched", - "moderate_status": "", - "decline_reasons": [], - "validation_state": "pending", - "state_name": "Не продается", - "state_description": "Не создан", - "is_failed": true, - "is_created": false, - "state_tooltip": "Не прошел валидацию", - "item_errors": [ - { - "code": "SELLER_NO_CONTRACT_FAILED", - "field": "", - "attribute_id": 0, - "state": "unmatched", - "level": "error", - "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", - "optional_description_elements": {}, - "attribute_name": "" - } - ], - "state_updated_at": "2024-10-09T06:26:09.61423Z" - }, - "state": "", - "service_type": "IS_CODE_SERVICE", - "fbo_sku": 0, - "fbs_sku": 0, - "currency_code": "RUB", - "is_kgt": false, - "rating": "", - "discounted_stocks": { - "coming": 0, - "present": 0, - "reserved": 0 - }, - "is_discounted": false, - "has_discounted_item": false, - "barcodes": [], - "updated_at": "2024-10-09T06:26:07.502714Z", - "price_indexes": { - "price_index": "WITHOUT_INDEX", - "external_index_data": null, - "ozon_index_data": null, - "self_marketplaces_index_data": null - }, - "sku": 0, - "description_category_id": 17028922, - "type_id": 95911, - "is_archived": false, - "is_autoarchived": false - } - ] - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-information.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-information.mdx new file mode 100644 index 0000000000..a265e85daa --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-products-information.mdx @@ -0,0 +1,150 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get products informations + Gets information about products by an array of identifiers + + + +`Function GetProductsInformation(Val ClientID, Val APIKey, Val ProductsID = 0, Val SKU = 0, Val Articles = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsID | --productid | Number, Array Of Number | Products identifier | + | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | + | Articles | --offerid | String, Array of String | Item identifiers in the vendor's system (Article) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Specify the minimum price of the product after all promotions have been applied in your personal cabinet. The min_price parameter from the method response is being reworked and returns 0 + + The active_product parameter is deprecated, use the values of the visible parameter + + The fbs_sku and fbo_sku parameters from the method response were disabled on August 15, 2023 + + The body of the request must contain a single identifier or an array of identical identifiers, the response will be an array of items + + Method at API documentation: [post /v2/product/info/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoListV2) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + Article = "143210609"; + + Result = OPI_Ozon.GetProductsInformation(ClientID, APIKey, , , Article); +``` + + + + +```json title="Result" +{ + "result": { + "items": [ + { + "id": 1215763512, + "name": "Protective film set for X3 NFC. Dark cotton", + "offer_id": "143210609", + "barcode": "", + "buybox_price": "", + "category_id": 0, + "created_at": "2024-10-09T06:25:24.931356Z", + "images": [ + "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" + ], + "marketing_price": "", + "min_ozon_price": "", + "old_price": "1300.0000", + "premium_price": "", + "price": "1300.0000", + "recommended_price": "", + "min_price": "", + "sources": [], + "stocks": { + "coming": 0, + "present": 0, + "reserved": 0 + }, + "errors": [], + "vat": "0.100000", + "visible": false, + "visibility_details": { + "has_price": false, + "has_stock": false, + "active_product": false, + "reasons": {} + }, + "price_index": "0.00", + "images360": [], + "color_image": "", + "primary_image": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "status": { + "state": "imported", + "state_failed": "unmatched", + "moderate_status": "", + "decline_reasons": [], + "validation_state": "pending", + "state_name": "Не продается", + "state_description": "Не создан", + "is_failed": true, + "is_created": false, + "state_tooltip": "Не прошел валидацию", + "item_errors": [ + { + "code": "SELLER_NO_CONTRACT_FAILED", + "field": "", + "attribute_id": 0, + "state": "unmatched", + "level": "error", + "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", + "optional_description_elements": {}, + "attribute_name": "" + } + ], + "state_updated_at": "2024-10-09T06:26:09.61423Z" + }, + "state": "", + "service_type": "IS_CODE_SERVICE", + "fbo_sku": 0, + "fbs_sku": 0, + "currency_code": "RUB", + "is_kgt": false, + "rating": "", + "discounted_stocks": { + "coming": 0, + "present": 0, + "reserved": 0 + }, + "is_discounted": false, + "has_discounted_item": false, + "barcodes": [], + "updated_at": "2024-10-09T06:26:07.502714Z", + "price_indexes": { + "price_index": "WITHOUT_INDEX", + "external_index_data": null, + "ozon_index_data": null, + "self_marketplaces_index_data": null + }, + "sku": 0, + "description_category_id": 17028922, + "type_id": 95911, + "is_archived": false, + "is_autoarchived": false + } + ] + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.md deleted file mode 100644 index 718e7f4fee..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 17 ---- - -# Get related SKUs - Gets a single SKU from the old SKU FBS and SKU FBO identifiers - - - -`Function GetRelatedSKUs(Val ClientID, Val APIKey, Val SKU) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -The response will contain all SKUs associated with the passed SKUs. The method can process any SKU, even hidden or deleted. - - Send up to 200 SKUs in a single request. - - Method at API documentation: [post /v1/product/related-sku/get](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductGetRelatedSKU) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Result = OPI_Ozon.GetRelatedSKUs(ClientID, APIKey, SKU); -``` - - - - -```json title="Result" -{ - "items": [ - { - "delivery_schema": "SDS", - "sku": 1626044001, - "product_id": 1108702494, - "availability": "AVAILABLE", - "deleted_at": null - } - ], - "errors": [] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.mdx new file mode 100644 index 0000000000..4812061bfc --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 17 +--- + +# Get related SKUs + Gets a single SKU from the old SKU FBS and SKU FBO identifiers + + + +`Function GetRelatedSKUs(Val ClientID, Val APIKey, Val SKU) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | SKU | --sku | Number, Array Of Number | Products identifiers in the Ozon system (SKU) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +The response will contain all SKUs associated with the passed SKUs. The method can process any SKU, even hidden or deleted. + + Send up to 200 SKUs in a single request. + + Method at API documentation: [post /v1/product/related-sku/get](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductGetRelatedSKU) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Result = OPI_Ozon.GetRelatedSKUs(ClientID, APIKey, SKU); +``` + + + + +```json title="Result" +{ + "items": [ + { + "delivery_schema": "SDS", + "sku": 1626044001, + "product_id": 1108702494, + "availability": "AVAILABLE", + "deleted_at": null + } + ], + "errors": [] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.md b/docs/en/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.md deleted file mode 100644 index b6cb2894e7..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 21 ---- - -# Get simplified product structure - Gets the structure for creating a product based on Ozon ID in the CreateProductByOzonID function() - - - -`Function GetSimplifiedProductStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Product fields structure - -
- - - - -```bsl title="Code example" - Result = OPI_Ozon.GetSimplifiedProductStructure(); -``` - - - - -```json title="Result" -{ - "name": "", - "sku": "", - "offer_id": "
", - "price": "", - "old_price": "", - "vat": "", - "currency_code": "" -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.mdx new file mode 100644 index 0000000000..4024f9b6c7 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 21 +--- + +# Get simplified product structure + Gets the structure for creating a product based on Ozon ID in the CreateProductByOzonID function() + + + +`Function GetSimplifiedProductStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Product fields structure + +
+ + + + +```bsl title="Code example" + Result = OPI_Ozon.GetSimplifiedProductStructure(); +``` + + + + +```json title="Result" +{ + "name": "", + "sku": "", + "offer_id": "
", + "price": "", + "old_price": "", + "vat": "", + "currency_code": "" +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Unarchive-products.md b/docs/en/md/Ozon/Uploading-and-updating-products/Unarchive-products.md deleted file mode 100644 index d80a25d7a2..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Unarchive-products.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Unarchive products - Returns selected items from the archive - - - -`Function UnarchiveProducts(Val ClientID, Val APIKey, Val ProductsID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductsID | --products | String, Number, Array of String, Number | Product IDs for recovery | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can restore from the archive no more than 10 products that were automatically archived per day. There are no restrictions on unarchiving products that were manually moved to the archive. - - Method at API documentation: [post /v1/product/unarchive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUnarchive) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Result = OPI_Ozon.UnarchiveProducts(ClientID, APIKey, ProductID); -``` - - - - -```json title="Result" -{ - "result": true -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Unarchive-products.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Unarchive-products.mdx new file mode 100644 index 0000000000..fcd806ddbd --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Unarchive-products.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Unarchive products + Returns selected items from the archive + + + +`Function UnarchiveProducts(Val ClientID, Val APIKey, Val ProductsID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductsID | --products | String, Number, Array of String, Number | Product IDs for recovery | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can restore from the archive no more than 10 products that were automatically archived per day. There are no restrictions on unarchiving products that were manually moved to the archive. + + Method at API documentation: [post /v1/product/unarchive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUnarchive) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Result = OPI_Ozon.UnarchiveProducts(ClientID, APIKey, ProductID); +``` + + + + +```json title="Result" +{ + "result": true +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Update-product-images.md b/docs/en/md/Ozon/Uploading-and-updating-products/Update-product-images.md deleted file mode 100644 index 67c9e84a8d..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Update-product-images.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Update product images - Update images and marketing color - - - -`Function UpdateProductImages(Val ClientID, Val APIKey, Val ProductID, Val ImagesArray = "", Val Array360 = "", Val MarketingColor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductID | --productid | String, Number | Product identifier | - | ImagesArray | --images | Array Of String | Array of images URLs | - | Array360 | --images360 | Array Of String | Array of 360 images | - | MarketingColor | --color | String | Marketing color | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -On each method call, send all the images that should be on the product card - - To upload, pass the link address of the image to public cloud storage. Image format of the linked image: JPG or PNG - - If you want to change the composition or order of the images, get the information using the GetProductInformation() method, copy the data of the images, images360, color_image fields, change and complete the composition or order as needed - - Method at API documentation: [post /v1/product/pictures/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductImportPictures) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; - - MarketingColor = "GREEN"; - - ImagesArray = New Array; - ImagesArray.Add(Image1); - ImagesArray.Add(Image2); - - Result = OPI_Ozon.UpdateProductImages(ClientID - , APIKey - , ProductID - , ImagesArray - , - , MarketingColor); -``` - - - - -```json title="Result" -{ - "result": { - "pictures": [ - { - "product_id": 1215763512, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "state": "imported", - "is_primary": true, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215763512, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215763512, - "url": "GREEN", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": true - } - ] - } -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Update-product-images.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Update-product-images.mdx new file mode 100644 index 0000000000..48d3d30856 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Update-product-images.mdx @@ -0,0 +1,97 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Update product images + Update images and marketing color + + + +`Function UpdateProductImages(Val ClientID, Val APIKey, Val ProductID, Val ImagesArray = "", Val Array360 = "", Val MarketingColor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductID | --productid | String, Number | Product identifier | + | ImagesArray | --images | Array Of String | Array of images URLs | + | Array360 | --images360 | Array Of String | Array of 360 images | + | MarketingColor | --color | String | Marketing color | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +On each method call, send all the images that should be on the product card + + To upload, pass the link address of the image to public cloud storage. Image format of the linked image: JPG or PNG + + If you want to change the composition or order of the images, get the information using the GetProductInformation() method, copy the data of the images, images360, color_image fields, change and complete the composition or order as needed + + Method at API documentation: [post /v1/product/pictures/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductImportPictures) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; + + MarketingColor = "GREEN"; + + ImagesArray = New Array; + ImagesArray.Add(Image1); + ImagesArray.Add(Image2); + + Result = OPI_Ozon.UpdateProductImages(ClientID + , APIKey + , ProductID + , ImagesArray + , + , MarketingColor); +``` + + + + +```json title="Result" +{ + "result": { + "pictures": [ + { + "product_id": 1215763512, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "state": "imported", + "is_primary": true, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215763512, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215763512, + "url": "GREEN", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": true + } + ] + } +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-articles.md b/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-articles.md deleted file mode 100644 index 93b19106ab..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-articles.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Update products articles - Modifies articles of existing products - - - -`Function UpdateProductsArticles(Val ClientID, Val APIKey, Val ArticlesMap) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ArticlesMap | --offers | Map Of KeyAndValue | Articles: Key > current, Value > new | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/product/update/offer-id](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateOfferID) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - ArticlesMap = New Map; - ArticlesMap.Insert("143210609", "143210612"); - - Result = OPI_Ozon.UpdateProductsArticles(ClientID, APIKey, ArticlesMap); -``` - - - - -```json title="Result" -{ - "errors": [] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-articles.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-articles.mdx new file mode 100644 index 0000000000..431ca39c70 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-articles.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Update products articles + Modifies articles of existing products + + + +`Function UpdateProductsArticles(Val ClientID, Val APIKey, Val ArticlesMap) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ArticlesMap | --offers | Map Of KeyAndValue | Articles: Key > current, Value > new | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/product/update/offer-id](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateOfferID) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + ArticlesMap = New Map; + ArticlesMap.Insert("143210609", "143210612"); + + Result = OPI_Ozon.UpdateProductsArticles(ClientID, APIKey, ArticlesMap); +``` + + + + +```json title="Result" +{ + "errors": [] +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-attributes.md b/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-attributes.md deleted file mode 100644 index a5c68246f8..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-attributes.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Update products attributes - Updates the attributes of the selected items - - - -`Function UpdateProductsAttributes(Val ClientID, Val APIKey, Val AttributesArray) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | AttributesArray | --items | Array Of String | Array or one structure of product attribute fields | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -You can get an empty structure using the GetAttributesUpdateStructure method() - - Method at API documentation: [post /v1/product/attributes/update](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateAttributes) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - AttributesStructure = New Structure("offer_id", "143210609"); - - CategoryAttribute1 = New Structure("dictionary_value_id,value", 971082156, "Speaker stand"); - CategoryAttribute2 = New Structure("dictionary_value_id,value", 5060050 , "Samsung"); - CategoryAttribute3 = New Structure("dictionary_value_id,value", 61576 , "red"); - - OPI_Ozon.CompleteComplexAttribute(AttributesStructure, 5076 , 0, CategoryAttribute1); - OPI_Ozon.CompleteComplexAttribute(AttributesStructure, 85 , 0, CategoryAttribute2); - OPI_Ozon.CompleteComplexAttribute(AttributesStructure, 10096, 0, CategoryAttribute3); - - Result = OPI_Ozon.UpdateProductsAttributes(ClientID, APIKey, AttributesStructure); -``` - - - - -```json title="Result" -{ - "task_id": 1347189194 -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-attributes.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-attributes.mdx new file mode 100644 index 0000000000..9c2b885e8e --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Update-products-attributes.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Update products attributes + Updates the attributes of the selected items + + + +`Function UpdateProductsAttributes(Val ClientID, Val APIKey, Val AttributesArray) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | AttributesArray | --items | Array Of String | Array or one structure of product attribute fields | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +You can get an empty structure using the GetAttributesUpdateStructure method() + + Method at API documentation: [post /v1/product/attributes/update](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateAttributes) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + AttributesStructure = New Structure("offer_id", "143210609"); + + CategoryAttribute1 = New Structure("dictionary_value_id,value", 971082156, "Speaker stand"); + CategoryAttribute2 = New Structure("dictionary_value_id,value", 5060050 , "Samsung"); + CategoryAttribute3 = New Structure("dictionary_value_id,value", 61576 , "red"); + + OPI_Ozon.CompleteComplexAttribute(AttributesStructure, 5076 , 0, CategoryAttribute1); + OPI_Ozon.CompleteComplexAttribute(AttributesStructure, 85 , 0, CategoryAttribute2); + OPI_Ozon.CompleteComplexAttribute(AttributesStructure, 10096, 0, CategoryAttribute3); + + Result = OPI_Ozon.UpdateProductsAttributes(ClientID, APIKey, AttributesStructure); +``` + + + + +```json title="Result" +{ + "task_id": 1347189194 +} +``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.md b/docs/en/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.md deleted file mode 100644 index 56cd9db265..0000000000 --- a/docs/en/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 15 ---- - -# Upload product activations codes - Uploads activation codes for a digital product or service - - - -`Function UploadProductActivationCodes(Val ClientID, Val APIKey, Val ProductID, Val Codes) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - | ProductID | --productid | Number | Product ID | - | Codes | --codes | String, Array of String | Digital product activation codes | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -The activation code is linked to the digital product card - - Uploading status check - GetCodesUploadStatus() - - Method at API documentation: [post /v1/product/upload_digital_codes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCode) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - ProductID = "1220696576"; - - Codes = New Array; - Codes.Add("11111111"); - Codes.Add("22222222"); - - Result = OPI_Ozon.UploadProductActivationCodes(ClientID, APIKey, ProductID, Codes); -``` - - - - -```json title="Result" -{ - "code": 7, - "message": "s2s: method \"/endpoints.v1.Service/UploadDigitalCodes\" is not allowed for the provided access tokens: permission denied", - "details": [] -} -``` diff --git a/docs/en/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.mdx b/docs/en/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.mdx new file mode 100644 index 0000000000..0077122813 --- /dev/null +++ b/docs/en/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 15 +--- + +# Upload product activations codes + Uploads activation codes for a digital product or service + + + +`Function UploadProductActivationCodes(Val ClientID, Val APIKey, Val ProductID, Val Codes) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + | ProductID | --productid | Number | Product ID | + | Codes | --codes | String, Array of String | Digital product activation codes | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +The activation code is linked to the digital product card + + Uploading status check - GetCodesUploadStatus() + + Method at API documentation: [post /v1/product/upload_digital_codes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCode) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + ProductID = "1220696576"; + + Codes = New Array; + Codes.Add("11111111"); + Codes.Add("22222222"); + + Result = OPI_Ozon.UploadProductActivationCodes(ClientID, APIKey, ProductID, Codes); +``` + + + + +```json title="Result" +{ + "code": 7, + "message": "s2s: method \"/endpoints.v1.Service/UploadDigitalCodes\" is not allowed for the provided access tokens: permission denied", + "details": [] +} +``` diff --git a/docs/en/md/Ozon/Warehouses-managment/Get-warehouses-list.md b/docs/en/md/Ozon/Warehouses-managment/Get-warehouses-list.md deleted file mode 100644 index e508de4821..0000000000 --- a/docs/en/md/Ozon/Warehouses-managment/Get-warehouses-list.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get warehouses list - Gets compnay warehouses list - - - -`Function GetWarehousesList(Val ClientID, Val APIKey) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ClientID | --clientid | String | Client identifier | - | APIKey | --apikey | String | API key | - - - Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API - -
- -:::tip -Method at API documentation: [post /v1/warehouse/list](https://docs.ozon.ru/api/seller/#operation/WarehouseAPI_WarehouseList) -::: -
- - -```bsl title="Code example" - ClientID = "2128753"; - APIKey = "7cc90d26-33e4-499b..."; - - Result = OPI_Ozon.GetWarehousesList(ClientID, APIKey); -``` - - - - -```json title="Result" -{ - "result": [] -} -``` diff --git a/docs/en/md/Ozon/Warehouses-managment/Get-warehouses-list.mdx b/docs/en/md/Ozon/Warehouses-managment/Get-warehouses-list.mdx new file mode 100644 index 0000000000..16b6dff18c --- /dev/null +++ b/docs/en/md/Ozon/Warehouses-managment/Get-warehouses-list.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get warehouses list + Gets compnay warehouses list + + + +`Function GetWarehousesList(Val ClientID, Val APIKey) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ClientID | --clientid | String | Client identifier | + | APIKey | --apikey | String | API key | + + + Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API + +
+ +:::tip +Method at API documentation: [post /v1/warehouse/list](https://docs.ozon.ru/api/seller/#operation/WarehouseAPI_WarehouseList) +::: +
+ + +```bsl title="Code example" + ClientID = "2128753"; + APIKey = "7cc90d26-33e4-499b..."; + + Result = OPI_Ozon.GetWarehousesList(ClientID, APIKey); +``` + + + + +```json title="Result" +{ + "result": [] +} +``` diff --git a/docs/en/md/Slack/Block-formation/Generate-image-block.md b/docs/en/md/Slack/Block-formation/Generate-image-block.md deleted file mode 100644 index 3ec73ffdc5..0000000000 --- a/docs/en/md/Slack/Block-formation/Generate-image-block.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Generate image block - Generates a block with an image to add to the message block array - - - -`Function GenerateImageBlock(Val URL, Val AlternateText = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --picture | String | Image URL | - | AlternateText | --alt | String | Alternate text of the image | - - - Returns: Map Of KeyAndValue - Image block - -
- - - - -```bsl title="Code example" - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - - Result = OPI_Slack.GenerateImageBlock(Image, "Image"); -``` - - - - -```json title="Result" -{ - "type": "image", - "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "alt_text": "Image" -} -``` diff --git a/docs/en/md/Slack/Block-formation/Generate-image-block.mdx b/docs/en/md/Slack/Block-formation/Generate-image-block.mdx new file mode 100644 index 0000000000..c2e813d94d --- /dev/null +++ b/docs/en/md/Slack/Block-formation/Generate-image-block.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Generate image block + Generates a block with an image to add to the message block array + + + +`Function GenerateImageBlock(Val URL, Val AlternateText = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --picture | String | Image URL | + | AlternateText | --alt | String | Alternate text of the image | + + + Returns: Map Of KeyAndValue - Image block + +
+ + + + +```bsl title="Code example" + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + + Result = OPI_Slack.GenerateImageBlock(Image, "Image"); +``` + + + + +```json title="Result" +{ + "type": "image", + "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "alt_text": "Image" +} +``` diff --git a/docs/en/md/Slack/Channel-management/Archive-channel.md b/docs/en/md/Slack/Channel-management/Archive-channel.md deleted file mode 100644 index 6cf5b954ed..0000000000 --- a/docs/en/md/Slack/Channel-management/Archive-channel.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Archive channel - Archives an active channel - - - -`Function ArchiveChannel(Val Token, Val Channel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - - Result = OPI_Slack.ArchiveChannel(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/Slack/Channel-management/Archive-channel.mdx b/docs/en/md/Slack/Channel-management/Archive-channel.mdx new file mode 100644 index 0000000000..f622157aca --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Archive-channel.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Archive channel + Archives an active channel + + + +`Function ArchiveChannel(Val Token, Val Channel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + + Result = OPI_Slack.ArchiveChannel(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/Slack/Channel-management/Create-channel.md b/docs/en/md/Slack/Channel-management/Create-channel.md deleted file mode 100644 index d8d741120a..0000000000 --- a/docs/en/md/Slack/Channel-management/Create-channel.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create channel - Creates a new channel - - - -`Function CreateChannel(Val Token, Val Name, Val Private = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Name | --title | String | Channel name | - | Private | --private | Boolean | Create channel as private | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Name = "testconv" + String(New UUID); - - Result = OPI_Slack.CreateChannel(Token, Name); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454513809, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "0000000000.000000", - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [], - "priority": 0 - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Create-channel.mdx b/docs/en/md/Slack/Channel-management/Create-channel.mdx new file mode 100644 index 0000000000..25a1d7e9db --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Create-channel.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create channel + Creates a new channel + + + +`Function CreateChannel(Val Token, Val Name, Val Private = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Name | --title | String | Channel name | + | Private | --private | Boolean | Create channel as private | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Name = "testconv" + String(New UUID); + + Result = OPI_Slack.CreateChannel(Token, Name); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454513809, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "0000000000.000000", + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [], + "priority": 0 + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-history.md b/docs/en/md/Slack/Channel-management/Get-channel-history.md deleted file mode 100644 index db43911640..0000000000 --- a/docs/en/md/Slack/Channel-management/Get-channel-history.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get channel history - Gets information about channel events - - - -`Function GetChannelHistory(Val Token, Val Channel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - - Result = OPI_Slack.GetChannelHistory(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "messages": [ - { - "subtype": "channel_join", - "user": "U06UABH3APP", - "text": "<@U06UABH3APP> has joined the channel", - "inviter": "U06UG1CAYH2", - "type": "message", - "ts": "1728454514.991459" - }, - { - "subtype": "channel_purpose", - "user": "U06UG1CAYH2", - "purpose": "TestGoal", - "text": "set the channel description: TestGoal", - "type": "message", - "ts": "1728454514.555299" - }, - { - "subtype": "channel_topic", - "user": "U06UG1CAYH2", - "topic": "TestTopic", - "text": "set the channel topic: TestTopic", - "type": "message", - "ts": "1728454514.302599" - }, - { - "subtype": "channel_join", - "user": "U06UG1CAYH2", - "text": "<@U06UG1CAYH2> has joined the channel", - "type": "message", - "ts": "1728454513.920549" - } - ], - "has_more": false, - "is_limited": false, - "pin_count": 0, - "channel_actions_ts": null, - "channel_actions_count": 0 -} -``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-history.mdx b/docs/en/md/Slack/Channel-management/Get-channel-history.mdx new file mode 100644 index 0000000000..9641056b5e --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Get-channel-history.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get channel history + Gets information about channel events + + + +`Function GetChannelHistory(Val Token, Val Channel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + + Result = OPI_Slack.GetChannelHistory(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "messages": [ + { + "subtype": "channel_join", + "user": "U06UABH3APP", + "text": "<@U06UABH3APP> has joined the channel", + "inviter": "U06UG1CAYH2", + "type": "message", + "ts": "1728454514.991459" + }, + { + "subtype": "channel_purpose", + "user": "U06UG1CAYH2", + "purpose": "TestGoal", + "text": "set the channel description: TestGoal", + "type": "message", + "ts": "1728454514.555299" + }, + { + "subtype": "channel_topic", + "user": "U06UG1CAYH2", + "topic": "TestTopic", + "text": "set the channel topic: TestTopic", + "type": "message", + "ts": "1728454514.302599" + }, + { + "subtype": "channel_join", + "user": "U06UG1CAYH2", + "text": "<@U06UG1CAYH2> has joined the channel", + "type": "message", + "ts": "1728454513.920549" + } + ], + "has_more": false, + "is_limited": false, + "pin_count": 0, + "channel_actions_ts": null, + "channel_actions_count": 0 +} +``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-list.md b/docs/en/md/Slack/Channel-management/Get-channel-list.md deleted file mode 100644 index 2104ced974..0000000000 --- a/docs/en/md/Slack/Channel-management/Get-channel-list.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get channel list - Gets a list of available channels - - - -`Function GetChannelList(Val Token, Val ExcludeArchived = False, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ExcludeArchived | --notarchived | Boolean | Indicator of excluding archived channels | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - - Result = OPI_Slack.GetChannelList(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "channels": [ - { - "id": "C06UD92DF1Q", - "name": "general", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713202497, - "is_archived": false, - "is_general": true, - "unlinked": 0, - "name_normalized": "general", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1724394518358, - "parent_conversation": null, - "creator": "U06UABH3APP", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "This is the one channel that will always include everyone. It’s a great spot for announcements and team-wide conversations.", - "creator": "U06UABH3APP", - "last_set": 1713202497 - }, - "properties": { - "use_case": "welcome" - }, - "previous_names": [], - "num_members": 1 - }, - { - "id": "C06UFNUTKUL", - "name": "slack-api-librarry", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713202541, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "slack-api-librarry", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1724394515808, - "parent_conversation": null, - "creator": "U06UABH3APP", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "This channel is for everything #slack-api-librarry. Hold meetings, share docs, and make decisions together with your team.", - "creator": "U06UABH3APP", - "last_set": 1713202541 - }, - "properties": { - "tabs": [ - { - "id": "files", - "label": "", - "type": "files" - } - ], - "use_case": "project" - }, - "previous_names": [], - "num_members": 2 - }, - { - "id": "C06UW6XHU5V", - "name": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713701752, - "is_archived": true, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1724394515915, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [], - "num_members": 0 - }, - { - "id": "C06UWD6523Z", - "name": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713712534, - "is_archived": true, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", - "is_shared": false, -... -``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-list.mdx b/docs/en/md/Slack/Channel-management/Get-channel-list.mdx new file mode 100644 index 0000000000..2ba1baaaf1 --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Get-channel-list.mdx @@ -0,0 +1,190 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get channel list + Gets a list of available channels + + + +`Function GetChannelList(Val Token, Val ExcludeArchived = False, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ExcludeArchived | --notarchived | Boolean | Indicator of excluding archived channels | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + + Result = OPI_Slack.GetChannelList(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "channels": [ + { + "id": "C06UD92DF1Q", + "name": "general", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713202497, + "is_archived": false, + "is_general": true, + "unlinked": 0, + "name_normalized": "general", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1724394518358, + "parent_conversation": null, + "creator": "U06UABH3APP", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "This is the one channel that will always include everyone. It’s a great spot for announcements and team-wide conversations.", + "creator": "U06UABH3APP", + "last_set": 1713202497 + }, + "properties": { + "use_case": "welcome" + }, + "previous_names": [], + "num_members": 1 + }, + { + "id": "C06UFNUTKUL", + "name": "slack-api-librarry", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713202541, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "slack-api-librarry", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1724394515808, + "parent_conversation": null, + "creator": "U06UABH3APP", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "This channel is for everything #slack-api-librarry. Hold meetings, share docs, and make decisions together with your team.", + "creator": "U06UABH3APP", + "last_set": 1713202541 + }, + "properties": { + "tabs": [ + { + "id": "files", + "label": "", + "type": "files" + } + ], + "use_case": "project" + }, + "previous_names": [], + "num_members": 2 + }, + { + "id": "C06UW6XHU5V", + "name": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713701752, + "is_archived": true, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1724394515915, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [], + "num_members": 0 + }, + { + "id": "C06UWD6523Z", + "name": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713712534, + "is_archived": true, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", + "is_shared": false, +... +``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-user-list.md b/docs/en/md/Slack/Channel-management/Get-channel-user-list.md deleted file mode 100644 index 8966bf2a0d..0000000000 --- a/docs/en/md/Slack/Channel-management/Get-channel-user-list.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get channel user list - Gets a list of users in the specified channel - - - -`Function GetChannelUserList(Val Token, Val Channel, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - - Result = OPI_Slack.GetChannelUserList(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "members": [ - "U06UG1CAYH2" - ], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-user-list.mdx b/docs/en/md/Slack/Channel-management/Get-channel-user-list.mdx new file mode 100644 index 0000000000..64201b96ab --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Get-channel-user-list.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get channel user list + Gets a list of users in the specified channel + + + +`Function GetChannelUserList(Val Token, Val Channel, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + + Result = OPI_Slack.GetChannelUserList(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "members": [ + "U06UG1CAYH2" + ], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel.md b/docs/en/md/Slack/Channel-management/Get-channel.md deleted file mode 100644 index c71dbfe2b3..0000000000 --- a/docs/en/md/Slack/Channel-management/Get-channel.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get channel - Gets information about the channel - - - -`Function GetChannel(Val Token, Val Channel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - - Result = OPI_Slack.GetChannel(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454514526, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "0000000000.000000", - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "previous_names": [] - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel.mdx b/docs/en/md/Slack/Channel-management/Get-channel.mdx new file mode 100644 index 0000000000..f31448908a --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Get-channel.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get channel + Gets information about the channel + + + +`Function GetChannel(Val Token, Val Channel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + + Result = OPI_Slack.GetChannel(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454514526, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "0000000000.000000", + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "previous_names": [] + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md b/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md deleted file mode 100644 index e9ff683ef5..0000000000 --- a/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Invite users to channel - Adds specified users to the channel - - - -`Function InviteUsersToChannel(Val Token, Val Channel, Val ArrayOfUsers) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | ArrayOfUsers | --users | Array Of String | User ID Array | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - User = "U06UABH3APP"; - - Result = OPI_Slack.InviteUsersToChannel(Token, Channel, User); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454514526, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "0000000000.000000", - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "previous_names": [] - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Invite-users-to-channel.mdx b/docs/en/md/Slack/Channel-management/Invite-users-to-channel.mdx new file mode 100644 index 0000000000..88b3536c3f --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Invite-users-to-channel.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Invite users to channel + Adds specified users to the channel + + + +`Function InviteUsersToChannel(Val Token, Val Channel, Val ArrayOfUsers) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | ArrayOfUsers | --users | Array Of String | User ID Array | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + User = "U06UABH3APP"; + + Result = OPI_Slack.InviteUsersToChannel(Token, Channel, User); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454514526, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "0000000000.000000", + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "previous_names": [] + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Join-channel.md b/docs/en/md/Slack/Channel-management/Join-channel.md deleted file mode 100644 index ca19163376..0000000000 --- a/docs/en/md/Slack/Channel-management/Join-channel.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Join channel - Adds the current bot to the channel - - - -`Function JoinChannel(Val Token, Val Channel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - - Result = OPI_Slack.JoinChannel(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454514526, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1728454514.991459", - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "previous_names": [], - "priority": 0 - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Join-channel.mdx b/docs/en/md/Slack/Channel-management/Join-channel.mdx new file mode 100644 index 0000000000..c041d6c823 --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Join-channel.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Join channel + Adds the current bot to the channel + + + +`Function JoinChannel(Val Token, Val Channel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + + Result = OPI_Slack.JoinChannel(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454514526, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1728454514.991459", + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "previous_names": [], + "priority": 0 + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md b/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md deleted file mode 100644 index 959bf640d9..0000000000 --- a/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Kick user from channel - Removes specified user from channel - - - -`Function KickUserFromChannel(Val Token, Val Channel, Val User) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | User | --user | String | User ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - User = "U06UABH3APP"; - - Result = OPI_Slack.KickUserFromChannel(Token, Channel, User); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/Slack/Channel-management/Kick-user-from-channel.mdx b/docs/en/md/Slack/Channel-management/Kick-user-from-channel.mdx new file mode 100644 index 0000000000..b3b5ed25a9 --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Kick-user-from-channel.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Kick user from channel + Removes specified user from channel + + + +`Function KickUserFromChannel(Val Token, Val Channel, Val User) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | User | --user | String | User ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + User = "U06UABH3APP"; + + Result = OPI_Slack.KickUserFromChannel(Token, Channel, User); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/Slack/Channel-management/Leave-channel.md b/docs/en/md/Slack/Channel-management/Leave-channel.md deleted file mode 100644 index cee159f7c4..0000000000 --- a/docs/en/md/Slack/Channel-management/Leave-channel.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Leave channel - Removes the current bot from the channel - - - -`Function LeaveChannel(Val Token, Val Channel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - - Result = OPI_Slack.LeaveChannel(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/Slack/Channel-management/Leave-channel.mdx b/docs/en/md/Slack/Channel-management/Leave-channel.mdx new file mode 100644 index 0000000000..946cace89f --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Leave-channel.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Leave channel + Removes the current bot from the channel + + + +`Function LeaveChannel(Val Token, Val Channel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + + Result = OPI_Slack.LeaveChannel(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/Slack/Channel-management/Rename-channel.md b/docs/en/md/Slack/Channel-management/Rename-channel.md deleted file mode 100644 index b122d0fd24..0000000000 --- a/docs/en/md/Slack/Channel-management/Rename-channel.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Rename channel - Changes the name of the channel - - - -`Function RenameChannel(Val Token, Val Channel, Val Name) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Name | --title | String | New channel name | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - Name = "testconv" + String(New UUID); - - Result = OPI_Slack.RenameChannel(Token, Channel, Name); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconvb42c1906-4136-4c7e-ae81-ba7ea2d8c02b", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconvb42c1906-4136-4c7e-ae81-ba7ea2d8c02b", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454516450, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1728454514.991459", - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "previous_names": [ - "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66" - ] - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Rename-channel.mdx b/docs/en/md/Slack/Channel-management/Rename-channel.mdx new file mode 100644 index 0000000000..66944bfbd1 --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Rename-channel.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Rename channel + Changes the name of the channel + + + +`Function RenameChannel(Val Token, Val Channel, Val Name) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Name | --title | String | New channel name | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + Name = "testconv" + String(New UUID); + + Result = OPI_Slack.RenameChannel(Token, Channel, Name); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconvb42c1906-4136-4c7e-ae81-ba7ea2d8c02b", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconvb42c1906-4136-4c7e-ae81-ba7ea2d8c02b", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454516450, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1728454514.991459", + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "previous_names": [ + "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66" + ] + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-goal.md b/docs/en/md/Slack/Channel-management/Set-channel-goal.md deleted file mode 100644 index 1790c63ac2..0000000000 --- a/docs/en/md/Slack/Channel-management/Set-channel-goal.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Set channel purpose - Sets the channel purpose (description) - - - -`Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Purpose | --purpose | String | Channel purpose | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - Purpose = "TestGoal"; - - Result = OPI_Slack.SetChannelGoal(Token, Channel, Purpose); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454514526, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "previous_names": [] - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-goal.mdx b/docs/en/md/Slack/Channel-management/Set-channel-goal.mdx new file mode 100644 index 0000000000..579ca128fe --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Set-channel-goal.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Set channel purpose + Sets the channel purpose (description) + + + +`Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Purpose | --purpose | String | Channel purpose | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + Purpose = "TestGoal"; + + Result = OPI_Slack.SetChannelGoal(Token, Channel, Purpose); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454514526, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "previous_names": [] + } +} +``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-topic.md b/docs/en/md/Slack/Channel-management/Set-channel-topic.md deleted file mode 100644 index fb7d758eed..0000000000 --- a/docs/en/md/Slack/Channel-management/Set-channel-topic.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Set channel topic - Sets the channel topic - - - -`Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Topic | --theme | String | Channel topic | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C07R7MSSPDM"; - Topic = "TestTopic"; - - Result = OPI_Slack.SetChannelTopic(Token, Channel, Topic); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": { - "id": "C07R448PZJ8", - "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728454513, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728454514283, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1728454514 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [] - } -} -``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-topic.mdx b/docs/en/md/Slack/Channel-management/Set-channel-topic.mdx new file mode 100644 index 0000000000..f42d486afb --- /dev/null +++ b/docs/en/md/Slack/Channel-management/Set-channel-topic.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Set channel topic + Sets the channel topic + + + +`Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Topic | --theme | String | Channel topic | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C07R7MSSPDM"; + Topic = "TestTopic"; + + Result = OPI_Slack.SetChannelTopic(Token, Channel, Topic); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": { + "id": "C07R448PZJ8", + "name": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728454513, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2383f9a9-fc9f-4928-ba19-511c3b7e9c66", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728454514283, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1728454514 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [] + } +} +``` diff --git a/docs/en/md/Slack/Dialog-management/Close-dialog.md b/docs/en/md/Slack/Dialog-management/Close-dialog.md deleted file mode 100644 index 6108f1618b..0000000000 --- a/docs/en/md/Slack/Dialog-management/Close-dialog.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Close dialog - Closes an existing dialog - - - -`Function CloseDialog(Val Token, Val Dialog) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Dialog | --conv | String | Dialog ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Dialog = "D06UAKK1C6R"; - - Result = OPI_Slack.CloseDialog(Token, Dialog); -``` - - - - -```json title="Result" -{ - "ok": true, - "already_closed": false, - "no_op": false -} -``` diff --git a/docs/en/md/Slack/Dialog-management/Close-dialog.mdx b/docs/en/md/Slack/Dialog-management/Close-dialog.mdx new file mode 100644 index 0000000000..a796d42e93 --- /dev/null +++ b/docs/en/md/Slack/Dialog-management/Close-dialog.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Close dialog + Closes an existing dialog + + + +`Function CloseDialog(Val Token, Val Dialog) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Dialog | --conv | String | Dialog ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Dialog = "D06UAKK1C6R"; + + Result = OPI_Slack.CloseDialog(Token, Dialog); +``` + + + + +```json title="Result" +{ + "ok": true, + "already_closed": false, + "no_op": false +} +``` diff --git a/docs/en/md/Slack/Dialog-management/Open-dialog.md b/docs/en/md/Slack/Dialog-management/Open-dialog.md deleted file mode 100644 index d0cc4740dc..0000000000 --- a/docs/en/md/Slack/Dialog-management/Open-dialog.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Open dialog - Opens a new dialog with one or more users - - - -`Function OpenDialog(Val Token, Val ArrayOfUsers) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ArrayOfUsers | --users | Array of String | User ID Array | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - User = "U06UABH3APP"; - - Result = OPI_Slack.OpenDialog(Token, User); -``` - - - - -```json title="Result" -{ - "ok": true, - "no_op": false, - "already_open": false, - "channel": { - "id": "D06UAKK1C6R" - } -} -``` diff --git a/docs/en/md/Slack/Dialog-management/Open-dialog.mdx b/docs/en/md/Slack/Dialog-management/Open-dialog.mdx new file mode 100644 index 0000000000..b1777b98a8 --- /dev/null +++ b/docs/en/md/Slack/Dialog-management/Open-dialog.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Open dialog + Opens a new dialog with one or more users + + + +`Function OpenDialog(Val Token, Val ArrayOfUsers) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ArrayOfUsers | --users | Array of String | User ID Array | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + User = "U06UABH3APP"; + + Result = OPI_Slack.OpenDialog(Token, User); +``` + + + + +```json title="Result" +{ + "ok": true, + "no_op": false, + "already_open": false, + "channel": { + "id": "D06UAKK1C6R" + } +} +``` diff --git a/docs/en/md/Slack/External-files-management/Add-external-file.md b/docs/en/md/Slack/External-files-management/Add-external-file.md deleted file mode 100644 index 68a1913e04..0000000000 --- a/docs/en/md/Slack/External-files-management/Add-external-file.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Add external file - Adds a new external file - - - -`Function AddExternalFile(Val Token, Val URL, Val Title) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | URL | --url | String | URL to external file | - | Title | --title | String | File title for Slack | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Title = "NewFile"; - File = "https://api.athenaeum.digital/test_data/document.docx"; - - Result = OPI_Slack.AddExternalFile(Token, File, Title); -``` - - - - -```json title="Result" -{ - "ok": true, - "file": { - "id": "F07QYP172FP", - "created": 1728454531, - "timestamp": 1728454531, - "name": "NewFile", - "title": "NewFile", - "mimetype": "application/vnd.slack-remote", - "filetype": "remote", - "pretty_type": "Remote", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 0, - "mode": "external", - "is_external": true, - "external_type": "app", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://slack.com/api/files.remote.add", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYP172FP/newfile", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "3a61913c-c2ce-412b-a4b4-6875373db31a", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } -} -``` diff --git a/docs/en/md/Slack/External-files-management/Add-external-file.mdx b/docs/en/md/Slack/External-files-management/Add-external-file.mdx new file mode 100644 index 0000000000..0fe0243b9d --- /dev/null +++ b/docs/en/md/Slack/External-files-management/Add-external-file.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Add external file + Adds a new external file + + + +`Function AddExternalFile(Val Token, Val URL, Val Title) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | URL | --url | String | URL to external file | + | Title | --title | String | File title for Slack | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Title = "NewFile"; + File = "https://api.athenaeum.digital/test_data/document.docx"; + + Result = OPI_Slack.AddExternalFile(Token, File, Title); +``` + + + + +```json title="Result" +{ + "ok": true, + "file": { + "id": "F07QYP172FP", + "created": 1728454531, + "timestamp": 1728454531, + "name": "NewFile", + "title": "NewFile", + "mimetype": "application/vnd.slack-remote", + "filetype": "remote", + "pretty_type": "Remote", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 0, + "mode": "external", + "is_external": true, + "external_type": "app", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://slack.com/api/files.remote.add", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYP172FP/newfile", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "3a61913c-c2ce-412b-a4b4-6875373db31a", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } +} +``` diff --git a/docs/en/md/Slack/External-files-management/Delete-external-file.md b/docs/en/md/Slack/External-files-management/Delete-external-file.md deleted file mode 100644 index 6ffada6c47..0000000000 --- a/docs/en/md/Slack/External-files-management/Delete-external-file.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete external file - Deletes an external file from Slack - - - -`Function DeleteExternalFile(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - FileID = "F07RN8F33GS"; - - Result = OPI_Slack.DeleteExternalFile(Token, FileID); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/Slack/External-files-management/Delete-external-file.mdx b/docs/en/md/Slack/External-files-management/Delete-external-file.mdx new file mode 100644 index 0000000000..03fafa5d15 --- /dev/null +++ b/docs/en/md/Slack/External-files-management/Delete-external-file.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete external file + Deletes an external file from Slack + + + +`Function DeleteExternalFile(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + FileID = "F07RN8F33GS"; + + Result = OPI_Slack.DeleteExternalFile(Token, FileID); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/Slack/External-files-management/Get-external-file-list.md b/docs/en/md/Slack/External-files-management/Get-external-file-list.md deleted file mode 100644 index 7b54476663..0000000000 --- a/docs/en/md/Slack/External-files-management/Get-external-file-list.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of external files - Gets a list of external files of a user or channel - - - -`Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel for selection | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - - Result = OPI_Slack.GetExternalFileList(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "files": [], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/en/md/Slack/External-files-management/Get-external-file-list.mdx b/docs/en/md/Slack/External-files-management/Get-external-file-list.mdx new file mode 100644 index 0000000000..3c20801a40 --- /dev/null +++ b/docs/en/md/Slack/External-files-management/Get-external-file-list.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of external files + Gets a list of external files of a user or channel + + + +`Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel for selection | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + + Result = OPI_Slack.GetExternalFileList(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "files": [], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/en/md/Slack/External-files-management/Get-external-file.md b/docs/en/md/Slack/External-files-management/Get-external-file.md deleted file mode 100644 index 209a746c03..0000000000 --- a/docs/en/md/Slack/External-files-management/Get-external-file.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get external file - Gets information about the external file - - - -`Function GetExternalFile(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - FileID = "F07RN8F33GS"; - - Result = OPI_Slack.GetExternalFile(Token, FileID); -``` - - - - -```json title="Result" -{ - "ok": true, - "file": { - "id": "F07QYP172FP", - "created": 1728454531, - "timestamp": 1728454531, - "name": "NewFile", - "title": "NewFile", - "mimetype": "application/vnd.slack-remote", - "filetype": "remote", - "pretty_type": "Remote", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 0, - "mode": "external", - "is_external": true, - "external_type": "app", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://slack.com/api/files.remote.add", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYP172FP/newfile", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "3a61913c-c2ce-412b-a4b4-6875373db31a", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } -} -``` diff --git a/docs/en/md/Slack/External-files-management/Get-external-file.mdx b/docs/en/md/Slack/External-files-management/Get-external-file.mdx new file mode 100644 index 0000000000..fd8d9b9441 --- /dev/null +++ b/docs/en/md/Slack/External-files-management/Get-external-file.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get external file + Gets information about the external file + + + +`Function GetExternalFile(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + FileID = "F07RN8F33GS"; + + Result = OPI_Slack.GetExternalFile(Token, FileID); +``` + + + + +```json title="Result" +{ + "ok": true, + "file": { + "id": "F07QYP172FP", + "created": 1728454531, + "timestamp": 1728454531, + "name": "NewFile", + "title": "NewFile", + "mimetype": "application/vnd.slack-remote", + "filetype": "remote", + "pretty_type": "Remote", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 0, + "mode": "external", + "is_external": true, + "external_type": "app", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://slack.com/api/files.remote.add", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYP172FP/newfile", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "3a61913c-c2ce-412b-a4b4-6875373db31a", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } +} +``` diff --git a/docs/en/md/Slack/External-files-management/Send-external-file.md b/docs/en/md/Slack/External-files-management/Send-external-file.md deleted file mode 100644 index 849b12273a..0000000000 --- a/docs/en/md/Slack/External-files-management/Send-external-file.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Send external file - Sends an external file to a list of channels - - - -`Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - | ChannelArray | --channels | Array Of String | Array of channels for sending | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - FileID = "F07RN8F33GS"; - - Result = OPI_Slack.SendExternalFile(Token, FileID, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "file": { - "id": "F07QYP172FP", - "created": 1728454531, - "timestamp": 1728454531, - "name": "NewFile", - "title": "NewFile", - "mimetype": "application/vnd.slack-remote", - "filetype": "remote", - "pretty_type": "Remote", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 0, - "mode": "external", - "is_external": true, - "external_type": "app", - "is_public": true, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://slack.com/api/files.remote.add", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYP172FP/newfile", - "comments_count": 0, - "is_starred": false, - "shares": { - "public": { - "C06UFNUTKUL": [ - { - "reply_users": [], - "reply_users_count": 0, - "reply_count": 0, - "ts": "1728454531.918939", - "channel_name": "slack-api-librarry", - "team_id": "T06UD92BS3C", - "share_user_id": "U06UG1CAYH2", - "source": "UNKNOWN" - } - ] - } - }, - "channels": [ - "C06UFNUTKUL" - ], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "3a61913c-c2ce-412b-a4b4-6875373db31a", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } -} -``` diff --git a/docs/en/md/Slack/External-files-management/Send-external-file.mdx b/docs/en/md/Slack/External-files-management/Send-external-file.mdx new file mode 100644 index 0000000000..787671b098 --- /dev/null +++ b/docs/en/md/Slack/External-files-management/Send-external-file.mdx @@ -0,0 +1,96 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Send external file + Sends an external file to a list of channels + + + +`Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + | ChannelArray | --channels | Array Of String | Array of channels for sending | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + FileID = "F07RN8F33GS"; + + Result = OPI_Slack.SendExternalFile(Token, FileID, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "file": { + "id": "F07QYP172FP", + "created": 1728454531, + "timestamp": 1728454531, + "name": "NewFile", + "title": "NewFile", + "mimetype": "application/vnd.slack-remote", + "filetype": "remote", + "pretty_type": "Remote", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 0, + "mode": "external", + "is_external": true, + "external_type": "app", + "is_public": true, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://slack.com/api/files.remote.add", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYP172FP/newfile", + "comments_count": 0, + "is_starred": false, + "shares": { + "public": { + "C06UFNUTKUL": [ + { + "reply_users": [], + "reply_users_count": 0, + "reply_count": 0, + "ts": "1728454531.918939", + "channel_name": "slack-api-librarry", + "team_id": "T06UD92BS3C", + "share_user_id": "U06UG1CAYH2", + "source": "UNKNOWN" + } + ] + } + }, + "channels": [ + "C06UFNUTKUL" + ], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "3a61913c-c2ce-412b-a4b4-6875373db31a", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } +} +``` diff --git a/docs/en/md/Slack/File-managment/Delete-file.md b/docs/en/md/Slack/File-managment/Delete-file.md deleted file mode 100644 index 5ebd82907c..0000000000 --- a/docs/en/md/Slack/File-managment/Delete-file.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete file - Deletes a file on Slack - - - -`Function DeleteFile(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - FileID = "F07RFKJR7GW"; - - Result = OPI_Slack.DeleteFile(Token, FileID); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/Slack/File-managment/Delete-file.mdx b/docs/en/md/Slack/File-managment/Delete-file.mdx new file mode 100644 index 0000000000..523ddb73d0 --- /dev/null +++ b/docs/en/md/Slack/File-managment/Delete-file.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete file + Deletes a file on Slack + + + +`Function DeleteFile(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + FileID = "F07RFKJR7GW"; + + Result = OPI_Slack.DeleteFile(Token, FileID); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/Slack/File-managment/Get-file-data.md b/docs/en/md/Slack/File-managment/Get-file-data.md deleted file mode 100644 index 822634b088..0000000000 --- a/docs/en/md/Slack/File-managment/Get-file-data.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get file data - Gets information about the file - - - -`Function GetFileData(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - FileID = "F07RFKJR7GW"; - - Result = OPI_Slack.GetFileData(Token, FileID); -``` - - - - -```json title="Result" -{ - "ok": true, - "file": { - "id": "F07QV0PCS1L", - "created": 1728454525, - "timestamp": 1728454525, - "name": "megadoc.docx", - "title": "NewFile", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", - "favorites": [], - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible", - "comments_count": 0 - }, - "comments": [], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/en/md/Slack/File-managment/Get-file-data.mdx b/docs/en/md/Slack/File-managment/Get-file-data.mdx new file mode 100644 index 0000000000..d1d6548483 --- /dev/null +++ b/docs/en/md/Slack/File-managment/Get-file-data.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get file data + Gets information about the file + + + +`Function GetFileData(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + FileID = "F07RFKJR7GW"; + + Result = OPI_Slack.GetFileData(Token, FileID); +``` + + + + +```json title="Result" +{ + "ok": true, + "file": { + "id": "F07QV0PCS1L", + "created": 1728454525, + "timestamp": 1728454525, + "name": "megadoc.docx", + "title": "NewFile", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", + "favorites": [], + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible", + "comments_count": 0 + }, + "comments": [], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/en/md/Slack/File-managment/Get-files-list.md b/docs/en/md/Slack/File-managment/Get-files-list.md deleted file mode 100644 index 3360021982..0000000000 --- a/docs/en/md/Slack/File-managment/Get-files-list.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get list of files - Gets a list of files of the bot or channel - - - -`Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel for selection | - | PageNumber | --page | Number, String | Page number | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - - Result = OPI_Slack.GetFilesList(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "files": [], - "paging": { - "count": 100, - "total": 12, - "page": 1, - "pages": 1 - } -} -``` diff --git a/docs/en/md/Slack/File-managment/Get-files-list.mdx b/docs/en/md/Slack/File-managment/Get-files-list.mdx new file mode 100644 index 0000000000..3ce5bfb19f --- /dev/null +++ b/docs/en/md/Slack/File-managment/Get-files-list.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get list of files + Gets a list of files of the bot or channel + + + +`Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel for selection | + | PageNumber | --page | Number, String | Page number | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + + Result = OPI_Slack.GetFilesList(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "files": [], + "paging": { + "count": 100, + "total": 12, + "page": 1, + "pages": 1 + } +} +``` diff --git a/docs/en/md/Slack/File-managment/Make-file-private.md b/docs/en/md/Slack/File-managment/Make-file-private.md deleted file mode 100644 index 87fba445b8..0000000000 --- a/docs/en/md/Slack/File-managment/Make-file-private.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Make file private - Removes the public URL from the file. Requires user token - - - -`Function MakeFilePrivate(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | User token | - | FileID | --fileid | String | File identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - FileID = "F07RFKJR7GW"; - - Result = OPI_Slack.MakeFilePrivate(Token, FileID); -``` - - - - -```json title="Result" -{ - "ok": true, - "files": [ - { - "id": "F07QV0PCS1L", - "created": 1728454525, - "timestamp": 1728454525, - "name": "megadoc.docx", - "title": "NewFile", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] -} -``` diff --git a/docs/en/md/Slack/File-managment/Make-file-private.mdx b/docs/en/md/Slack/File-managment/Make-file-private.mdx new file mode 100644 index 0000000000..b951f9cbe8 --- /dev/null +++ b/docs/en/md/Slack/File-managment/Make-file-private.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Make file private + Removes the public URL from the file. Requires user token + + + +`Function MakeFilePrivate(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | User token | + | FileID | --fileid | String | File identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + FileID = "F07RFKJR7GW"; + + Result = OPI_Slack.MakeFilePrivate(Token, FileID); +``` + + + + +```json title="Result" +{ + "ok": true, + "files": [ + { + "id": "F07QV0PCS1L", + "created": 1728454525, + "timestamp": 1728454525, + "name": "megadoc.docx", + "title": "NewFile", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible" + } + ] +} +``` diff --git a/docs/en/md/Slack/File-managment/Make-file-public.md b/docs/en/md/Slack/File-managment/Make-file-public.md deleted file mode 100644 index aade2c4e49..0000000000 --- a/docs/en/md/Slack/File-managment/Make-file-public.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Make file public - Creates a public URL for the file. Requires user token - - - -`Function MakeFilePublic(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | User token | - | FileID | --fileid | String | File identifier | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - FileID = "F07RFKJR7GW"; - - Result = OPI_Slack.MakeFilePublic(Token, FileID); -``` - - - - -```json title="Result" -{ - "ok": true, - "files": [ - { - "id": "F07QV0PCS1L", - "created": 1728454525, - "timestamp": 1728454525, - "name": "megadoc.docx", - "title": "NewFile", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] -} -``` diff --git a/docs/en/md/Slack/File-managment/Make-file-public.mdx b/docs/en/md/Slack/File-managment/Make-file-public.mdx new file mode 100644 index 0000000000..1ce8c21734 --- /dev/null +++ b/docs/en/md/Slack/File-managment/Make-file-public.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Make file public + Creates a public URL for the file. Requires user token + + + +`Function MakeFilePublic(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | User token | + | FileID | --fileid | String | File identifier | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + FileID = "F07RFKJR7GW"; + + Result = OPI_Slack.MakeFilePublic(Token, FileID); +``` + + + + +```json title="Result" +{ + "ok": true, + "files": [ + { + "id": "F07QV0PCS1L", + "created": 1728454525, + "timestamp": 1728454525, + "name": "megadoc.docx", + "title": "NewFile", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible" + } + ] +} +``` diff --git a/docs/en/md/Slack/File-managment/Upload-file.md b/docs/en/md/Slack/File-managment/Upload-file.md deleted file mode 100644 index f861b0dfdc..0000000000 --- a/docs/en/md/Slack/File-managment/Upload-file.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Upload file - Uploads a file to Slack servers - - - -`Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | File | --file | String, BinaryData | File for upload | - | FileName | --filename | String | File name with extension | - | Title | --title | String | File name in Slack | - | Channel | --channel | String | Channel ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - File = "https://api.athenaeum.digital/test_data/document.docx"; // URL, Binary Data or Path to file - - FileName = "megadoc.docx"; - Title = "NewFile"; - - Result = OPI_Slack.UploadFile(Token, File, FileName, Title); - - Result = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "files": [ - { - "id": "F07QV0PCS1L", - "created": 1728454525, - "timestamp": 1728454525, - "name": "megadoc.docx", - "title": "NewFile", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] -} -``` diff --git a/docs/en/md/Slack/File-managment/Upload-file.mdx b/docs/en/md/Slack/File-managment/Upload-file.mdx new file mode 100644 index 0000000000..bae32ff2f3 --- /dev/null +++ b/docs/en/md/Slack/File-managment/Upload-file.mdx @@ -0,0 +1,88 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Upload file + Uploads a file to Slack servers + + + +`Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | File | --file | String, BinaryData | File for upload | + | FileName | --filename | String | File name with extension | + | Title | --title | String | File name in Slack | + | Channel | --channel | String | Channel ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + File = "https://api.athenaeum.digital/test_data/document.docx"; // URL, Binary Data or Path to file + + FileName = "megadoc.docx"; + Title = "NewFile"; + + Result = OPI_Slack.UploadFile(Token, File, FileName, Title); + + Result = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "files": [ + { + "id": "F07QV0PCS1L", + "created": 1728454525, + "timestamp": 1728454525, + "name": "megadoc.docx", + "title": "NewFile", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07QV0PCS1L/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QV0PCS1L/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07QV0PCS1L-dec85076a5", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible" + } + ] +} +``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md b/docs/en/md/Slack/Management-and-settings/Get-bot-information.md deleted file mode 100644 index 8571328ecd..0000000000 --- a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get bot information - Gets basic information about the bot - - - -`Function GetBotInformation(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Result = OPI_Slack.GetBotInformation(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "url": "https://openintegrationsgroup.slack.com/", - "team": "OpenIntegrations", - "user": "openintegrations", - "team_id": "T06UD92BS3C", - "user_id": "U06UG1CAYH2", - "bot_id": "B06TZ0MJV5M", - "is_enterprise_install": false -} -``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-bot-information.mdx b/docs/en/md/Slack/Management-and-settings/Get-bot-information.mdx new file mode 100644 index 0000000000..e4562ae6da --- /dev/null +++ b/docs/en/md/Slack/Management-and-settings/Get-bot-information.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get bot information + Gets basic information about the bot + + + +`Function GetBotInformation(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Result = OPI_Slack.GetBotInformation(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "url": "https://openintegrationsgroup.slack.com/", + "team": "OpenIntegrations", + "user": "openintegrations", + "team_id": "T06UD92BS3C", + "user_id": "U06UG1CAYH2", + "bot_id": "B06TZ0MJV5M", + "is_enterprise_install": false +} +``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-user-list.md b/docs/en/md/Slack/Management-and-settings/Get-user-list.md deleted file mode 100644 index 330aa940a9..0000000000 --- a/docs/en/md/Slack/Management-and-settings/Get-user-list.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get user list - Gets a list of users in the workspace - - - -`Function GetUserList(Val Token, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Result = OPI_Slack.GetUserList(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "members": [ - { - "id": "USLACKBOT", - "team_id": "T06UD92BS3C", - "name": "slackbot", - "deleted": false, - "color": "757575", - "real_name": "Slackbot", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "Slackbot", - "real_name_normalized": "Slackbot", - "display_name": "Slackbot", - "display_name_normalized": "Slackbot", - "fields": {}, - "status_text": "", - "status_emoji": "", - "status_emoji_display_info": [], - "status_expiration": 0, - "avatar_hash": "sv41d8cd98f0", - "always_active": true, - "first_name": "slackbot", - "last_name": "", - "image_24": "https://a.slack-edge.com/80588/img/slackbot_24.png", - "image_32": "https://a.slack-edge.com/80588/img/slackbot_32.png", - "image_48": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/slackbot_72.png", - "image_192": "https://a.slack-edge.com/80588/marketing/img/avatars/slackbot/avatar-slackbot.png", - "image_512": "https://a.slack-edge.com/80588/img/slackbot_512.png", - "status_text_canonical": "", - "team": "T06UD92BS3C" - }, - "is_admin": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "is_bot": false, - "is_app_user": false, - "updated": 0, - "is_email_confirmed": false, - "who_can_share_contact_card": "EVERYONE" - }, - { - "id": "U06UABH3APP", - "team_id": "T06UD92BS3C", - "name": "bayselonarrend", - "deleted": false, - "color": "9f69e7", - "real_name": "Антон Титовец", - "tz": "Europe/Moscow", - "tz_label": "Moscow Time", - "tz_offset": 10800, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "Антон Титовец", - "real_name_normalized": "Anton Titovec", - "display_name": "", - "display_name_normalized": "", - "fields": null, - "status_text": "", - "status_emoji": "", - "status_emoji_display_info": [], - "status_expiration": 0, - "avatar_hash": "65215daf7a4a", - "image_original": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_original.png", - "is_custom_image": true, - "email": "bayselonarrend@gmail.com", - "first_name": "Антон", - "last_name": "Титовец", - "image_24": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_24.png", - "image_32": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_32.png", - "image_48": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_48.png", - "image_72": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_72.png", - "image_192": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_192.png", - "image_512": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_512.png", - "image_1024": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_1024.png", - "status_text_canonical": "", - "team": "T06UD92BS3C" - }, - "is_admin": true, - "is_owner": true, - "is_primary_owner": true, - "is_restricted": false, - "is_ultra_restricted": false, - "is_bot": false, - "is_app_user": false, - "updated": 1713202518, - "is_email_confirmed": true, - "who_can_share_contact_card": "EVERYONE" - }, - { - "id": "U06UG1CAYH2", - "team_id": "T06UD92BS3C", - "name": "openintegrations", - "deleted": false, - "color": "4bbe2e", - "real_name": "OpenIntegrations", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "OpenIntegrations", - "real_name_normalized": "OpenIntegrations", - "display_name": "", - "display_name_normalized": "", - "fields": null, - "status_text": "", - "status_emoji": "", - "status_emoji_display_info": [], - "status_expiration": 0, - "avatar_hash": "gada2f598798", - "api_app_id": "A06TYNH45RV", - "always_active": false, - "bot_id": "B06TZ0MJV5M", - "first_name": "OpenIntegrations", - "last_name": "", - "image_24": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=24&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-24.png", - "image_32": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=32&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-32.png", - "image_48": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=48&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-48.png", - "image_72": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=72&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-72.png", - "image_192": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-192.png", - "image_512": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=512&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-512.png", - "status_text_canonical": "", - "team": "T06UD92BS3C" - }, - "is_admin": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "is_bot": true, - "is_app_user": false, - "updated": 1713205238, - "is_email_confirmed": false, - "who_can_share_contact_card": "EVERYONE" - } - ], -... -``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-user-list.mdx b/docs/en/md/Slack/Management-and-settings/Get-user-list.mdx new file mode 100644 index 0000000000..c67f91fea2 --- /dev/null +++ b/docs/en/md/Slack/Management-and-settings/Get-user-list.mdx @@ -0,0 +1,188 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get user list + Gets a list of users in the workspace + + + +`Function GetUserList(Val Token, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Result = OPI_Slack.GetUserList(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "members": [ + { + "id": "USLACKBOT", + "team_id": "T06UD92BS3C", + "name": "slackbot", + "deleted": false, + "color": "757575", + "real_name": "Slackbot", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "Slackbot", + "real_name_normalized": "Slackbot", + "display_name": "Slackbot", + "display_name_normalized": "Slackbot", + "fields": {}, + "status_text": "", + "status_emoji": "", + "status_emoji_display_info": [], + "status_expiration": 0, + "avatar_hash": "sv41d8cd98f0", + "always_active": true, + "first_name": "slackbot", + "last_name": "", + "image_24": "https://a.slack-edge.com/80588/img/slackbot_24.png", + "image_32": "https://a.slack-edge.com/80588/img/slackbot_32.png", + "image_48": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/slackbot_72.png", + "image_192": "https://a.slack-edge.com/80588/marketing/img/avatars/slackbot/avatar-slackbot.png", + "image_512": "https://a.slack-edge.com/80588/img/slackbot_512.png", + "status_text_canonical": "", + "team": "T06UD92BS3C" + }, + "is_admin": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "is_bot": false, + "is_app_user": false, + "updated": 0, + "is_email_confirmed": false, + "who_can_share_contact_card": "EVERYONE" + }, + { + "id": "U06UABH3APP", + "team_id": "T06UD92BS3C", + "name": "bayselonarrend", + "deleted": false, + "color": "9f69e7", + "real_name": "Антон Титовец", + "tz": "Europe/Moscow", + "tz_label": "Moscow Time", + "tz_offset": 10800, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "Антон Титовец", + "real_name_normalized": "Anton Titovec", + "display_name": "", + "display_name_normalized": "", + "fields": null, + "status_text": "", + "status_emoji": "", + "status_emoji_display_info": [], + "status_expiration": 0, + "avatar_hash": "65215daf7a4a", + "image_original": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_original.png", + "is_custom_image": true, + "email": "bayselonarrend@gmail.com", + "first_name": "Антон", + "last_name": "Титовец", + "image_24": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_24.png", + "image_32": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_32.png", + "image_48": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_48.png", + "image_72": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_72.png", + "image_192": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_192.png", + "image_512": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_512.png", + "image_1024": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_1024.png", + "status_text_canonical": "", + "team": "T06UD92BS3C" + }, + "is_admin": true, + "is_owner": true, + "is_primary_owner": true, + "is_restricted": false, + "is_ultra_restricted": false, + "is_bot": false, + "is_app_user": false, + "updated": 1713202518, + "is_email_confirmed": true, + "who_can_share_contact_card": "EVERYONE" + }, + { + "id": "U06UG1CAYH2", + "team_id": "T06UD92BS3C", + "name": "openintegrations", + "deleted": false, + "color": "4bbe2e", + "real_name": "OpenIntegrations", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "OpenIntegrations", + "real_name_normalized": "OpenIntegrations", + "display_name": "", + "display_name_normalized": "", + "fields": null, + "status_text": "", + "status_emoji": "", + "status_emoji_display_info": [], + "status_expiration": 0, + "avatar_hash": "gada2f598798", + "api_app_id": "A06TYNH45RV", + "always_active": false, + "bot_id": "B06TZ0MJV5M", + "first_name": "OpenIntegrations", + "last_name": "", + "image_24": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=24&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-24.png", + "image_32": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=32&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-32.png", + "image_48": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=48&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-48.png", + "image_72": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=72&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-72.png", + "image_192": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-192.png", + "image_512": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=512&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-512.png", + "status_text_canonical": "", + "team": "T06UD92BS3C" + }, + "is_admin": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "is_bot": true, + "is_app_user": false, + "updated": 1713205238, + "is_email_confirmed": false, + "who_can_share_contact_card": "EVERYONE" + } + ], +... +``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md b/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md deleted file mode 100644 index cff1a2994d..0000000000 --- a/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get workspace list - Gets a list of workspaces where the bot is connected - - - -`Function GetWorkspaceList(Val Token, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Result = OPI_Slack.GetWorkspaceList(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "teams": [ - { - "id": "T06UD92BS3C", - "name": "OpenIntegrations" - } - ] -} -``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-workspace-list.mdx b/docs/en/md/Slack/Management-and-settings/Get-workspace-list.mdx new file mode 100644 index 0000000000..deb2108af7 --- /dev/null +++ b/docs/en/md/Slack/Management-and-settings/Get-workspace-list.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get workspace list + Gets a list of workspaces where the bot is connected + + + +`Function GetWorkspaceList(Val Token, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Result = OPI_Slack.GetWorkspaceList(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "teams": [ + { + "id": "T06UD92BS3C", + "name": "OpenIntegrations" + } + ] +} +``` diff --git a/docs/en/md/Slack/Message-management/Delete-message.md b/docs/en/md/Slack/Message-management/Delete-message.md deleted file mode 100644 index a54227818b..0000000000 --- a/docs/en/md/Slack/Message-management/Delete-message.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete message - Deletes a channel message by timestamp - - - -`Function DeleteMessage(Val Token, Val Channel, Val Timestamp, Val IsDelayed = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Timestamp | --stamp | String | Timestamp or message ID | - | IsDelayed | --issheduled | Boolean | Indicator of deleting a delayed message | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - Timestamp = "1728823163.597989"; - - Result = OPI_Slack.DeleteMessage(Token, Channel, Timestamp); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1728454508.757479" -} -``` diff --git a/docs/en/md/Slack/Message-management/Delete-message.mdx b/docs/en/md/Slack/Message-management/Delete-message.mdx new file mode 100644 index 0000000000..8a5cd0af8e --- /dev/null +++ b/docs/en/md/Slack/Message-management/Delete-message.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete message + Deletes a channel message by timestamp + + + +`Function DeleteMessage(Val Token, Val Channel, Val Timestamp, Val IsDelayed = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Timestamp | --stamp | String | Timestamp or message ID | + | IsDelayed | --issheduled | Boolean | Indicator of deleting a delayed message | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + Timestamp = "1728823163.597989"; + + Result = OPI_Slack.DeleteMessage(Token, Channel, Timestamp); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1728454508.757479" +} +``` diff --git a/docs/en/md/Slack/Message-management/Edit-message.md b/docs/en/md/Slack/Message-management/Edit-message.md deleted file mode 100644 index 0d9e0feb1e..0000000000 --- a/docs/en/md/Slack/Message-management/Edit-message.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Edit message - Edits the content of an existing message - - - -`Function EditMessage(Val Token, Val Channel, Val Timestamp, Val Text = "", Val BlockArray = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Timestamp | --stamp | String | Message timestamp | - | Text | --text | String | New message text | - | BlockArray | --blocks | Array of Structure | JSON array of block descriptions | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - Timestamp = "1728823163.597989"; - - Text = "TestMessage2"; - - Result = OPI_Slack.EditMessage(Token, Channel, Timestamp, Text); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1728454508.757479", - "text": "TestMessage2", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "edited": { - "user": "B06TZ0MJV5M", - "ts": "1728454510.000000" - }, - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "TestMessage2", - "team": "T06UD92BS3C", - "bot_profile": { - "id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "name": "OpenIntegrations", - "icons": { - "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", - "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" - }, - "deleted": false, - "updated": 1713205238, - "team_id": "T06UD92BS3C" - }, - "blocks": [ - { - "type": "rich_text", - "block_id": "0dMq", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "TestMessage2" - } - ] - } - ] - } - ] - } -} -``` diff --git a/docs/en/md/Slack/Message-management/Edit-message.mdx b/docs/en/md/Slack/Message-management/Edit-message.mdx new file mode 100644 index 0000000000..b44af34f37 --- /dev/null +++ b/docs/en/md/Slack/Message-management/Edit-message.mdx @@ -0,0 +1,93 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Edit message + Edits the content of an existing message + + + +`Function EditMessage(Val Token, Val Channel, Val Timestamp, Val Text = "", Val BlockArray = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Timestamp | --stamp | String | Message timestamp | + | Text | --text | String | New message text | + | BlockArray | --blocks | Array of Structure | JSON array of block descriptions | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + Timestamp = "1728823163.597989"; + + Text = "TestMessage2"; + + Result = OPI_Slack.EditMessage(Token, Channel, Timestamp, Text); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1728454508.757479", + "text": "TestMessage2", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "edited": { + "user": "B06TZ0MJV5M", + "ts": "1728454510.000000" + }, + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "TestMessage2", + "team": "T06UD92BS3C", + "bot_profile": { + "id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "name": "OpenIntegrations", + "icons": { + "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", + "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" + }, + "deleted": false, + "updated": 1713205238, + "team_id": "T06UD92BS3C" + }, + "blocks": [ + { + "type": "rich_text", + "block_id": "0dMq", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "TestMessage2" + } + ] + } + ] + } + ] + } +} +``` diff --git a/docs/en/md/Slack/Message-management/Get-delayed-message-list.md b/docs/en/md/Slack/Message-management/Get-delayed-message-list.md deleted file mode 100644 index ede2ec132d..0000000000 --- a/docs/en/md/Slack/Message-management/Get-delayed-message-list.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get list of delayed messages - Gets a list of delayed channel messages - - - -`Function GetDelayedMessageList(Val Token, Val Channel, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - - Result = OPI_Slack.GetDelayedMessageList(Token, Channel); -``` - - - - -```json title="Result" -{ - "ok": true, - "scheduled_messages": [], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/en/md/Slack/Message-management/Get-delayed-message-list.mdx b/docs/en/md/Slack/Message-management/Get-delayed-message-list.mdx new file mode 100644 index 0000000000..ec98a89f99 --- /dev/null +++ b/docs/en/md/Slack/Message-management/Get-delayed-message-list.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get list of delayed messages + Gets a list of delayed channel messages + + + +`Function GetDelayedMessageList(Val Token, Val Channel, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + + Result = OPI_Slack.GetDelayedMessageList(Token, Channel); +``` + + + + +```json title="Result" +{ + "ok": true, + "scheduled_messages": [], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/en/md/Slack/Message-management/Get-message-link.md b/docs/en/md/Slack/Message-management/Get-message-link.md deleted file mode 100644 index 4713df7935..0000000000 --- a/docs/en/md/Slack/Message-management/Get-message-link.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get message link - Gets a permanent URL to the channel message - - - -`Function GetMessageLink(Val Token, Val Channel, Val Timestamp) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Timestamp | --stamp | String | Timestamp or message ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - Timestamp = "1728823163.597989"; - - Result = OPI_Slack.GetMessageLink(Token, Channel, Timestamp); -``` - - - - -```json title="Result" -{ - "ok": true, - "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1728454508757479", - "channel": "C06UFNUTKUL" -} -``` diff --git a/docs/en/md/Slack/Message-management/Get-message-link.mdx b/docs/en/md/Slack/Message-management/Get-message-link.mdx new file mode 100644 index 0000000000..aef421bd8d --- /dev/null +++ b/docs/en/md/Slack/Message-management/Get-message-link.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get message link + Gets a permanent URL to the channel message + + + +`Function GetMessageLink(Val Token, Val Channel, Val Timestamp) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Timestamp | --stamp | String | Timestamp or message ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + Timestamp = "1728823163.597989"; + + Result = OPI_Slack.GetMessageLink(Token, Channel, Timestamp); +``` + + + + +```json title="Result" +{ + "ok": true, + "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1728454508757479", + "channel": "C06UFNUTKUL" +} +``` diff --git a/docs/en/md/Slack/Message-management/Get-message-reply-list.md b/docs/en/md/Slack/Message-management/Get-message-reply-list.md deleted file mode 100644 index 6597245dd7..0000000000 --- a/docs/en/md/Slack/Message-management/Get-message-reply-list.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get list of message replies - Gets an array of messages that are replies to the specified - - - -`Function GetMessageReplyList(Val Token, Val Channel, Val Timestamp, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Timestamp | --stamp | String | Timestamp or message ID | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - Timestamp = "1728823163.597989"; - - Result = OPI_Slack.GetMessageReplyList(Token, Channel, Timestamp); -``` - - - - -```json title="Result" -{ - "ok": true, - "messages": [ - { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1728454508.757479", - "edited": { - "user": "B06TZ0MJV5M", - "ts": "1728454510.000000" - }, - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "TestMessage2", - "team": "T06UD92BS3C", - "bot_profile": { - "id": "B06TZ0MJV5M", - "deleted": false, - "name": "OpenIntegrations", - "updated": 1713205238, - "app_id": "A06TYNH45RV", - "icons": { - "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", - "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" - }, - "team_id": "T06UD92BS3C" - }, - "blocks": [ - { - "type": "rich_text", - "block_id": "kWY", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "TestMessage2" - } - ] - } - ] - } - ] - } - ], - "has_more": false -} -``` diff --git a/docs/en/md/Slack/Message-management/Get-message-reply-list.mdx b/docs/en/md/Slack/Message-management/Get-message-reply-list.mdx new file mode 100644 index 0000000000..ca1e19a453 --- /dev/null +++ b/docs/en/md/Slack/Message-management/Get-message-reply-list.mdx @@ -0,0 +1,91 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get list of message replies + Gets an array of messages that are replies to the specified + + + +`Function GetMessageReplyList(Val Token, Val Channel, Val Timestamp, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Timestamp | --stamp | String | Timestamp or message ID | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + Timestamp = "1728823163.597989"; + + Result = OPI_Slack.GetMessageReplyList(Token, Channel, Timestamp); +``` + + + + +```json title="Result" +{ + "ok": true, + "messages": [ + { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1728454508.757479", + "edited": { + "user": "B06TZ0MJV5M", + "ts": "1728454510.000000" + }, + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "TestMessage2", + "team": "T06UD92BS3C", + "bot_profile": { + "id": "B06TZ0MJV5M", + "deleted": false, + "name": "OpenIntegrations", + "updated": 1713205238, + "app_id": "A06TYNH45RV", + "icons": { + "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", + "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" + }, + "team_id": "T06UD92BS3C" + }, + "blocks": [ + { + "type": "rich_text", + "block_id": "kWY", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "TestMessage2" + } + ] + } + ] + } + ] + } + ], + "has_more": false +} +``` diff --git a/docs/en/md/Slack/Message-management/Send-ephemeral-message.md b/docs/en/md/Slack/Message-management/Send-ephemeral-message.md deleted file mode 100644 index 7a3c9b423f..0000000000 --- a/docs/en/md/Slack/Message-management/Send-ephemeral-message.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Send ephemeral message -Sends a message that arrives in the channel but is visible only to a specific user - - - -`Function SendEphemeralMessage(Val Token, Val Channel, Val Text = "", Val User = "", Val Blocks = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Text | --text | String | Message text | - | User | --user | String | User ID | - | Blocks | --blocks | Array of Structure | JSON array of block descriptions | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - User = "U06UABH3APP"; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - Text = "Ephemeral message"; - - Block = OPI_Slack.GenerateImageBlock(Image, "Image"); - Result = OPI_Slack.SendEphemeralMessage(Token, Channel, Text, User, Block); -``` - - - - -```json title="Result" -{ - "ok": true, - "message_ts": "1728454511.000300" -} -``` diff --git a/docs/en/md/Slack/Message-management/Send-ephemeral-message.mdx b/docs/en/md/Slack/Message-management/Send-ephemeral-message.mdx new file mode 100644 index 0000000000..525138646d --- /dev/null +++ b/docs/en/md/Slack/Message-management/Send-ephemeral-message.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Send ephemeral message +Sends a message that arrives in the channel but is visible only to a specific user + + + +`Function SendEphemeralMessage(Val Token, Val Channel, Val Text = "", Val User = "", Val Blocks = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Text | --text | String | Message text | + | User | --user | String | User ID | + | Blocks | --blocks | Array of Structure | JSON array of block descriptions | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + User = "U06UABH3APP"; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + Text = "Ephemeral message"; + + Block = OPI_Slack.GenerateImageBlock(Image, "Image"); + Result = OPI_Slack.SendEphemeralMessage(Token, Channel, Text, User, Block); +``` + + + + +```json title="Result" +{ + "ok": true, + "message_ts": "1728454511.000300" +} +``` diff --git a/docs/en/md/Slack/Message-management/Send-message.md b/docs/en/md/Slack/Message-management/Send-message.md deleted file mode 100644 index 19b966bf6a..0000000000 --- a/docs/en/md/Slack/Message-management/Send-message.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Send message - Sends a message at a selected hour - - - -`Function SendMessage(Val Token, Val Channel, Val Text = "", Val SendingDate = "", Val Blocks = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Text | --text | String | Message text | - | SendingDate | --date | Date | Sending date for delayed message | - | Blocks | --blocks | Array of Structure | JSON array of block descriptions | - - - Returns: Map Of KeyAndValue - serialized JSON response from Slack - -
- - - - -```bsl title="Code example" - Token = "xoxb-6965308400114-696804637..."; - Channel = "C06UFNUTKUL"; - - // Text - - Text = "TestMessage1"; - Result = OPI_Slack.SendMessage(Token, Channel, Text); - - // With attachments (picture block in the example) - - Text = "Message with picture"; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - BlockArray = New Array; - - Block = OPI_Slack.GenerateImageBlock(Image, "Image"); - BlockArray.Add(Block); - - Result = OPI_Slack.SendMessage(Token, Channel, Text, , BlockArray); - - // Sheduled - - Text = "Sheduled message"; - Hour = 3600; - Day = 24; - - SendingDate = OPI_Tools.GetCurrentDate() + (Day * Hour); - Result = OPI_Slack.SendMessage(Token, Channel, Text, SendingDate); -``` - - - - -```json title="Result" -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1728454508.757479", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1728454508.757479", - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "TestMessage1", - "team": "T06UD92BS3C", - "bot_profile": { - "id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "name": "OpenIntegrations", - "icons": { - "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", - "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" - }, - "deleted": false, - "updated": 1713205238, - "team_id": "T06UD92BS3C" - }, - "blocks": [ - { - "type": "rich_text", - "block_id": "g/EJA", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "TestMessage1" - } - ] - } - ] - } - ] - } -} -``` diff --git a/docs/en/md/Slack/Message-management/Send-message.mdx b/docs/en/md/Slack/Message-management/Send-message.mdx new file mode 100644 index 0000000000..d14ff838a8 --- /dev/null +++ b/docs/en/md/Slack/Message-management/Send-message.mdx @@ -0,0 +1,109 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Send message + Sends a message at a selected hour + + + +`Function SendMessage(Val Token, Val Channel, Val Text = "", Val SendingDate = "", Val Blocks = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Text | --text | String | Message text | + | SendingDate | --date | Date | Sending date for delayed message | + | Blocks | --blocks | Array of Structure | JSON array of block descriptions | + + + Returns: Map Of KeyAndValue - serialized JSON response from Slack + +
+ + + + +```bsl title="Code example" + Token = "xoxb-6965308400114-696804637..."; + Channel = "C06UFNUTKUL"; + + // Text + + Text = "TestMessage1"; + Result = OPI_Slack.SendMessage(Token, Channel, Text); + + // With attachments (picture block in the example) + + Text = "Message with picture"; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + BlockArray = New Array; + + Block = OPI_Slack.GenerateImageBlock(Image, "Image"); + BlockArray.Add(Block); + + Result = OPI_Slack.SendMessage(Token, Channel, Text, , BlockArray); + + // Sheduled + + Text = "Sheduled message"; + Hour = 3600; + Day = 24; + + SendingDate = OPI_Tools.GetCurrentDate() + (Day * Hour); + Result = OPI_Slack.SendMessage(Token, Channel, Text, SendingDate); +``` + + + + +```json title="Result" +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1728454508.757479", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1728454508.757479", + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "TestMessage1", + "team": "T06UD92BS3C", + "bot_profile": { + "id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "name": "OpenIntegrations", + "icons": { + "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", + "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" + }, + "deleted": false, + "updated": 1713205238, + "team_id": "T06UD92BS3C" + }, + "blocks": [ + { + "type": "rich_text", + "block_id": "g/EJA", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "TestMessage1" + } + ] + } + ] + } + ] + } +} +``` diff --git a/docs/en/md/Telegram/Administration/Ban.md b/docs/en/md/Telegram/Administration/Ban.md deleted file mode 100644 index ab9d5c1f80..0000000000 --- a/docs/en/md/Telegram/Administration/Ban.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Ban - Bans a user in the selected chat - - - -`Function Ban(Val Token, Val ChatID, Val UserID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | UserID | --user | String, Number | Target user ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [banChatMember](https://core.telegram.org/bots/api#banchatmember) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - UserID = "461699897"; - ChannelID = "@testsichee"; - - Result = OPI_Telegram.Ban(Token, ChannelID, UserID); -``` - - - - -```json title="Result" -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} -``` diff --git a/docs/en/md/Telegram/Administration/Ban.mdx b/docs/en/md/Telegram/Administration/Ban.mdx new file mode 100644 index 0000000000..fe8b5e55f7 --- /dev/null +++ b/docs/en/md/Telegram/Administration/Ban.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Ban + Bans a user in the selected chat + + + +`Function Ban(Val Token, Val ChatID, Val UserID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | UserID | --user | String, Number | Target user ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [banChatMember](https://core.telegram.org/bots/api#banchatmember) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + UserID = "461699897"; + ChannelID = "@testsichee"; + + Result = OPI_Telegram.Ban(Token, ChannelID, UserID); +``` + + + + +```json title="Result" +{ + "ok": false, + "error_code": 400, + "description": "Bad Request: can't remove chat owner" +} +``` diff --git a/docs/en/md/Telegram/Administration/Create-invitation-link.md b/docs/en/md/Telegram/Administration/Create-invitation-link.md deleted file mode 100644 index 634a054cec..0000000000 --- a/docs/en/md/Telegram/Administration/Create-invitation-link.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create invitation link - Creates a link for joining a closed chat - - - -`Function CreateInvitationLink(Val Token, Val ChatID, Val Title = "", Val ExpirationDate = "", Val UserLimit = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Title | --title | String | Invitation title | - | ExpirationDate | --expire | Date | Link expiration date (permanent if not specified) | - | UserLimit | --limit | Number | User limit (infinite if not specified) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [createChatInviteLink](https://core.telegram.org/bots/api#createchatinvitelink) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - Day = 86400; - CurrentDate = OPI_Tools.GetCurrentDate(); - - Title = "Link " + String(CurrentDate); - Expiration = CurrentDate + Day; - UnixExpiration = OPI_Tools.UNIXTime(Expiration); - - Result = OPI_Telegram.CreateInvitationLink(Token, ChannelID, Title, Expiration, 200); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "invite_link": "https://t.me/+hUgH4yjb_7wyZDBi", - "name": "Link 09.10.2024 8:58:10", - "creator": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "expire_date": 1728547090, - "member_limit": 200, - "creates_join_request": false, - "is_primary": false, - "is_revoked": false - } -} -``` diff --git a/docs/en/md/Telegram/Administration/Create-invitation-link.mdx b/docs/en/md/Telegram/Administration/Create-invitation-link.mdx new file mode 100644 index 0000000000..1ec3edddd9 --- /dev/null +++ b/docs/en/md/Telegram/Administration/Create-invitation-link.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create invitation link + Creates a link for joining a closed chat + + + +`Function CreateInvitationLink(Val Token, Val ChatID, Val Title = "", Val ExpirationDate = "", Val UserLimit = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Title | --title | String | Invitation title | + | ExpirationDate | --expire | Date | Link expiration date (permanent if not specified) | + | UserLimit | --limit | Number | User limit (infinite if not specified) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [createChatInviteLink](https://core.telegram.org/bots/api#createchatinvitelink) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + Day = 86400; + CurrentDate = OPI_Tools.GetCurrentDate(); + + Title = "Link " + String(CurrentDate); + Expiration = CurrentDate + Day; + UnixExpiration = OPI_Tools.UNIXTime(Expiration); + + Result = OPI_Telegram.CreateInvitationLink(Token, ChannelID, Title, Expiration, 200); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "invite_link": "https://t.me/+hUgH4yjb_7wyZDBi", + "name": "Link 09.10.2024 8:58:10", + "creator": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "expire_date": 1728547090, + "member_limit": 200, + "creates_join_request": false, + "is_primary": false, + "is_revoked": false + } +} +``` diff --git a/docs/en/md/Telegram/Administration/Delete-message.md b/docs/en/md/Telegram/Administration/Delete-message.md deleted file mode 100644 index c6e5685e34..0000000000 --- a/docs/en/md/Telegram/Administration/Delete-message.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Delete message - Delete message from chat or channel - - - -`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --chat | String, Number | Target chat ID | - | MessageID | --message | String, Number | ID of message to delete | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [deleteMessage](https://core.telegram.org/bots/api#deletemessage) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "@testsichee"; - MessageID = "9761"; - - Result = OPI_Telegram.DeleteMessage(Token, ChatID, MessageID); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Administration/Delete-message.mdx b/docs/en/md/Telegram/Administration/Delete-message.mdx new file mode 100644 index 0000000000..3876d727cf --- /dev/null +++ b/docs/en/md/Telegram/Administration/Delete-message.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Delete message + Delete message from chat or channel + + + +`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --chat | String, Number | Target chat ID | + | MessageID | --message | String, Number | ID of message to delete | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [deleteMessage](https://core.telegram.org/bots/api#deletemessage) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "@testsichee"; + MessageID = "9761"; + + Result = OPI_Telegram.DeleteMessage(Token, ChatID, MessageID); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Administration/Get-participant-count.md b/docs/en/md/Telegram/Administration/Get-participant-count.md deleted file mode 100644 index badb77df25..0000000000 --- a/docs/en/md/Telegram/Administration/Get-participant-count.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get participant count - Gets the total number of chat participants - - - -`Function GetParticipantCount(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [getChatMemberCount](https://core.telegram.org/bots/api#getchatmembercount) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - - Result = OPI_Telegram.GetParticipantCount(Token, ChannelID); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": 2 -} -``` diff --git a/docs/en/md/Telegram/Administration/Get-participant-count.mdx b/docs/en/md/Telegram/Administration/Get-participant-count.mdx new file mode 100644 index 0000000000..b48e79f682 --- /dev/null +++ b/docs/en/md/Telegram/Administration/Get-participant-count.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get participant count + Gets the total number of chat participants + + + +`Function GetParticipantCount(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [getChatMemberCount](https://core.telegram.org/bots/api#getchatmembercount) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + + Result = OPI_Telegram.GetParticipantCount(Token, ChannelID); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": 2 +} +``` diff --git a/docs/en/md/Telegram/Administration/Pin-message.md b/docs/en/md/Telegram/Administration/Pin-message.md deleted file mode 100644 index 322bca0d2c..0000000000 --- a/docs/en/md/Telegram/Administration/Pin-message.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Pin message - Pins a message in the chat header - - - -`Function PinMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --chat | String, Number | Target chat ID | - | MessageID | --message | String, Number | Target message ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [pinChatMessage](https://core.telegram.org/bots/api#pinchatmessage) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - MessageID = "9761"; - - Result = OPI_Telegram.PinMessage(Token, ChannelID, MessageID); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Administration/Pin-message.mdx b/docs/en/md/Telegram/Administration/Pin-message.mdx new file mode 100644 index 0000000000..7d1a51de89 --- /dev/null +++ b/docs/en/md/Telegram/Administration/Pin-message.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Pin message + Pins a message in the chat header + + + +`Function PinMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --chat | String, Number | Target chat ID | + | MessageID | --message | String, Number | Target message ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [pinChatMessage](https://core.telegram.org/bots/api#pinchatmessage) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + MessageID = "9761"; + + Result = OPI_Telegram.PinMessage(Token, ChannelID, MessageID); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Administration/Unban.md b/docs/en/md/Telegram/Administration/Unban.md deleted file mode 100644 index cd22f33c0b..0000000000 --- a/docs/en/md/Telegram/Administration/Unban.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Unban - Unbans a previously banned user - - - -`Function Unban(Val Token, Val ChatID, Val UserID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | UserID | --user | String, Number | Target user ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [unbanChatMember](https://core.telegram.org/bots/api#unbanchatmember) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - UserID = "461699897"; - ChannelID = "@testsichee"; - - Result = OPI_Telegram.Unban(Token, ChannelID, UserID); -``` - - - - -```json title="Result" -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} -``` diff --git a/docs/en/md/Telegram/Administration/Unban.mdx b/docs/en/md/Telegram/Administration/Unban.mdx new file mode 100644 index 0000000000..48aa0c688c --- /dev/null +++ b/docs/en/md/Telegram/Administration/Unban.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Unban + Unbans a previously banned user + + + +`Function Unban(Val Token, Val ChatID, Val UserID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | UserID | --user | String, Number | Target user ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [unbanChatMember](https://core.telegram.org/bots/api#unbanchatmember) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + UserID = "461699897"; + ChannelID = "@testsichee"; + + Result = OPI_Telegram.Unban(Token, ChannelID, UserID); +``` + + + + +```json title="Result" +{ + "ok": false, + "error_code": 400, + "description": "Bad Request: can't remove chat owner" +} +``` diff --git a/docs/en/md/Telegram/Administration/Unpin-message.md b/docs/en/md/Telegram/Administration/Unpin-message.md deleted file mode 100644 index 392644d3eb..0000000000 --- a/docs/en/md/Telegram/Administration/Unpin-message.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Unpin message - Unpins a message in the chat header - - - -`Function UnpinMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID | - | MessageID | --message | String, Number | Target message ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [unpinChatMessage](https://core.telegram.org/bots/api#unpinchatmessage) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - MessageID = "9761"; - - Result = OPI_Telegram.UnpinMessage(Token, ChannelID, MessageID); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Administration/Unpin-message.mdx b/docs/en/md/Telegram/Administration/Unpin-message.mdx new file mode 100644 index 0000000000..1b66f8f227 --- /dev/null +++ b/docs/en/md/Telegram/Administration/Unpin-message.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Unpin message + Unpins a message in the chat header + + + +`Function UnpinMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID | + | MessageID | --message | String, Number | Target message ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [unpinChatMessage](https://core.telegram.org/bots/api#unpinchatmessage) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + MessageID = "9761"; + + Result = OPI_Telegram.UnpinMessage(Token, ChannelID, MessageID); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md deleted file mode 100644 index 6fcb84e439..0000000000 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete webhook - Deletes the bot event handler URL for webhook operation - - - -`Function DeleteWebhook(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [deleteWebhook](https://core.telegram.org/bots/api#deletewebhook) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.DeleteWebhook(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true, - "description": "Webhook was deleted" -} -``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.mdx b/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.mdx new file mode 100644 index 0000000000..154c649c0f --- /dev/null +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete webhook + Deletes the bot event handler URL for webhook operation + + + +`Function DeleteWebhook(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [deleteWebhook](https://core.telegram.org/bots/api#deletewebhook) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.DeleteWebhook(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true, + "description": "Webhook was deleted" +} +``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md deleted file mode 100644 index 166ee17d33..0000000000 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Download file - Download file from Telegram servers - - - -`Function DownloadFile(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | FileID | --fileid | String | File ID for downloading | - - - Returns: BinaryData - file's binary data - -
- -:::tip -Method at API documentation: [getFile](https://core.telegram.org/bots/api#getfile) -::: -
- - -```bsl title="Code example" - FileID = "CQACAgIAAx0EcNsaZQACJdtnC600ChemDs9AfeCwKyUUQnYwzgACp1sAAj1KYEhCC24y7dGmOjYE"; - Token = "6129457865:AAFyzNYOAFbu..."; - - Result = OPI_Telegram.DownloadFile(Token, FileID); -``` - - - - -```json title="Result" -NOT JSON: 49 44 33 03 00 00 00 05 1F 76 54 49 54 32 00 00 00 0B 00 00 01 FF FE 44 00 6F 00 67 00 73 00 54 50 45 31 00 00 00 15 00 00 01 FF FE 4D 00 6F 00 74 00 6F 00 72 00 68 00 65 00 61 00 64 00 54 59… -``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.mdx b/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.mdx new file mode 100644 index 0000000000..2dfddc6095 --- /dev/null +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Download file + Download file from Telegram servers + + + +`Function DownloadFile(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | FileID | --fileid | String | File ID for downloading | + + + Returns: BinaryData - file's binary data + +
+ +:::tip +Method at API documentation: [getFile](https://core.telegram.org/bots/api#getfile) +::: +
+ + +```bsl title="Code example" + FileID = "CQACAgIAAx0EcNsaZQACJdtnC600ChemDs9AfeCwKyUUQnYwzgACp1sAAj1KYEhCC24y7dGmOjYE"; + Token = "6129457865:AAFyzNYOAFbu..."; + + Result = OPI_Telegram.DownloadFile(Token, FileID); +``` + + + + +```json title="Result" +NOT JSON: 49 44 33 03 00 00 00 05 1F 76 54 49 54 32 00 00 00 0B 00 00 01 FF FE 44 00 6F 00 67 00 73 00 54 50 45 31 00 00 00 15 00 00 01 FF FE 4D 00 6F 00 74 00 6F 00 72 00 68 00 65 00 61 00 64 00 54 59… +``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md deleted file mode 100644 index 2cb693fd4a..0000000000 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get bot information - Executes the request, returning basic bot information: name, id, ability to add the bot to groups, etc.. - - - -`Function GetBotInformation(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [getMe](https://core.telegram.org/bots/api#getme) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.GetBotInformation(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot", - "can_join_groups": true, - "can_read_all_group_messages": false, - "supports_inline_queries": false, - "can_connect_to_business": false, - "has_main_web_app": false - } -} -``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.mdx b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.mdx new file mode 100644 index 0000000000..1c3c3af373 --- /dev/null +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get bot information + Executes the request, returning basic bot information: name, id, ability to add the bot to groups, etc.. + + + +`Function GetBotInformation(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [getMe](https://core.telegram.org/bots/api#getme) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.GetBotInformation(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot", + "can_join_groups": true, + "can_read_all_group_messages": false, + "supports_inline_queries": false, + "can_connect_to_business": false, + "has_main_web_app": false + } +} +``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md deleted file mode 100644 index 6374134b23..0000000000 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get updates - Executes a request, returning information about bot events. Used in polling mode - - - -`Function GetUpdates(Val Token, Val Timeout = 0, Val Offset = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | Timeout | --timeout | String, Number | Waiting time for new events | - | Offset | --offset | String, Number | Offset in the list of received messages | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [getUpdates](https://core.telegram.org/bots/api#getupdates) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.GetUpdates(Token); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": [ - { - "update_id": 291369021, - "channel_post": { - "message_id": 9439, - "sender_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "date": 1728411383, - "pinned_message": { - "message_id": 9420, - "sender_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "date": 1728411163, - "text": "Строковое значение" - } - } - }, - { - "update_id": 291369022, - "message": { - "message_id": 5396, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728411415, - "message_thread_id": 5396, - "forum_topic_created": { - "name": "TestTopic 8efb59a8-19c1-46f6-afb9-ceadd411e795", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - } - }, - { - "update_id": 291369023, - "message": { - "message_id": 5398, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728411416, - "message_thread_id": 5396, - "reply_to_message": { - "message_id": 5396, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728411415, - "message_thread_id": 5396, - "forum_topic_created": { - "name": "TestTopic 8efb59a8-19c1-46f6-afb9-ceadd411e795", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - }, - "forum_topic_edited": { - "name": "NewTestTitle", - "icon_custom_emoji_id": "5310132165583840589" - }, - "is_topic_message": true - } - }, - { - "update_id": 291369024, - "message": { - "message_id": 5399, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728411421, - "forum_topic_reopened": {} - } - }, - { - "update_id": 291369025, - "message": { - "message_id": 5400, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728411421, -... -``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.mdx b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.mdx new file mode 100644 index 0000000000..25ae3bb41b --- /dev/null +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get updates + Executes a request, returning information about bot events. Used in polling mode + + + +`Function GetUpdates(Val Token, Val Timeout = 0, Val Offset = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | Timeout | --timeout | String, Number | Waiting time for new events | + | Offset | --offset | String, Number | Offset in the list of received messages | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [getUpdates](https://core.telegram.org/bots/api#getupdates) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.GetUpdates(Token); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": [ + { + "update_id": 291369021, + "channel_post": { + "message_id": 9439, + "sender_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "date": 1728411383, + "pinned_message": { + "message_id": 9420, + "sender_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "date": 1728411163, + "text": "Строковое значение" + } + } + }, + { + "update_id": 291369022, + "message": { + "message_id": 5396, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728411415, + "message_thread_id": 5396, + "forum_topic_created": { + "name": "TestTopic 8efb59a8-19c1-46f6-afb9-ceadd411e795", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + } + }, + { + "update_id": 291369023, + "message": { + "message_id": 5398, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728411416, + "message_thread_id": 5396, + "reply_to_message": { + "message_id": 5396, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728411415, + "message_thread_id": 5396, + "forum_topic_created": { + "name": "TestTopic 8efb59a8-19c1-46f6-afb9-ceadd411e795", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + }, + "forum_topic_edited": { + "name": "NewTestTitle", + "icon_custom_emoji_id": "5310132165583840589" + }, + "is_topic_message": true + } + }, + { + "update_id": 291369024, + "message": { + "message_id": 5399, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728411421, + "forum_topic_reopened": {} + } + }, + { + "update_id": 291369025, + "message": { + "message_id": 5400, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728411421, +... +``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md deleted file mode 100644 index 7caa1dad24..0000000000 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Set Webhook - Set webhook URL for bot event handling in webhook mode - - - -`Function SetWebhook(Val Token, Val URL) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | URL | --url | String | Request handling address from Telegram (with https:) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [setWebhook](https://core.telegram.org/bots/api#setwebhook) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - URL = "https://api.athenaeum.digital/opi/hs/twitter"; - - Result = OPI_Telegram.SetWebhook(Token, URL); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true, - "description": "Webhook was set" -} -``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.mdx b/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.mdx new file mode 100644 index 0000000000..dc1c54c386 --- /dev/null +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Set Webhook + Set webhook URL for bot event handling in webhook mode + + + +`Function SetWebhook(Val Token, Val URL) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | URL | --url | String | Request handling address from Telegram (with https:) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [setWebhook](https://core.telegram.org/bots/api#setwebhook) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + URL = "https://api.athenaeum.digital/opi/hs/twitter"; + + Result = OPI_Telegram.SetWebhook(Token, URL); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true, + "description": "Webhook was set" +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md b/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md deleted file mode 100644 index 55fa758879..0000000000 --- a/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Generate keyboard from array of buttons - Generates a simple JSON keyboard from an array of buttons for a message or bottom panel - - - -`Function FormKeyboardFromButtonArray(Val ButtonArray, Val UnderMessage = False, Val OneByOne = True) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ButtonArray | --buttons | Array of String | Array of buttons | - | UnderMessage | --under | Boolean | Keyboard under the message or on the bottom panel | - | OneByOne | --column | Boolean | True > buttons are displayed in a column, False > in a row | - - - Returns: String - Keyboard JSON - -
- -:::tip -About keyboards in the API documentation: [InlineKeyboardMarkup](https://core.telegram.org/bots/api#inlinekeyboardmarkup) -::: -
- - -```bsl title="Code example" - ButtonArray = New Array; - ButtonArray.Add("Button1"); - ButtonArray.Add("Button2"); - ButtonArray.Add("Button3"); - - Result = OPI_Telegram.FormKeyboardFromButtonArray(ButtonArray); -``` - - - - -```json title="Result" -"{\r\n \"keyboard\": [\r\n [\r\n {\r\n \"text\": \"Button1\",\r\n \"callback_data\": \"Button1\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Button2\",\r\n \"callback_data\": \"Button2\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Button3\",\r\n \"callback_data\": \"Button3\"\r\n }\r\n ]\r\n ],\r\n \"resize_keyboard\": true\r\n}" -``` diff --git a/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.mdx b/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.mdx new file mode 100644 index 0000000000..36577377a0 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Generate keyboard from array of buttons + Generates a simple JSON keyboard from an array of buttons for a message or bottom panel + + + +`Function FormKeyboardFromButtonArray(Val ButtonArray, Val UnderMessage = False, Val OneByOne = True) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ButtonArray | --buttons | Array of String | Array of buttons | + | UnderMessage | --under | Boolean | Keyboard under the message or on the bottom panel | + | OneByOne | --column | Boolean | True > buttons are displayed in a column, False > in a row | + + + Returns: String - Keyboard JSON + +
+ +:::tip +About keyboards in the API documentation: [InlineKeyboardMarkup](https://core.telegram.org/bots/api#inlinekeyboardmarkup) +::: +
+ + +```bsl title="Code example" + ButtonArray = New Array; + ButtonArray.Add("Button1"); + ButtonArray.Add("Button2"); + ButtonArray.Add("Button3"); + + Result = OPI_Telegram.FormKeyboardFromButtonArray(ButtonArray); +``` + + + + +```json title="Result" +"{\r\n \"keyboard\": [\r\n [\r\n {\r\n \"text\": \"Button1\",\r\n \"callback_data\": \"Button1\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Button2\",\r\n \"callback_data\": \"Button2\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Button3\",\r\n \"callback_data\": \"Button3\"\r\n }\r\n ]\r\n ],\r\n \"resize_keyboard\": true\r\n}" +``` diff --git a/docs/en/md/Telegram/Data-sending/Forward-message.md b/docs/en/md/Telegram/Data-sending/Forward-message.md deleted file mode 100644 index 574b48cdd0..0000000000 --- a/docs/en/md/Telegram/Data-sending/Forward-message.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Forward message - Forwards a message between chats or within a chat - - - -`Function ForwardMessage(Val Token, Val OriginalID, Val FromID, Val ToID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | OriginalID | --message | String, Number | Original message ID | - | FromID | --from | String, Number | Chat ID of the original message | - | ToID | --to | String, Number | Target chat ID or ChatID*TopicID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [forwardMessage](https://core.telegram.org/bots/api#forwardmessage) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - MessageID = "9761"; - - Result = OPI_Telegram.ForwardMessage(Token, MessageID, ChannelID, ChatID); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8315, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453470, - "forward_origin": { - "type": "channel", - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "message_id": 9440, - "date": 1728453289 - }, - "forward_from_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "forward_from_message_id": 9440, - "forward_date": 1728453289, - "text": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Forward-message.mdx b/docs/en/md/Telegram/Data-sending/Forward-message.mdx new file mode 100644 index 0000000000..f7b8a3a680 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Forward-message.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Forward message + Forwards a message between chats or within a chat + + + +`Function ForwardMessage(Val Token, Val OriginalID, Val FromID, Val ToID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | OriginalID | --message | String, Number | Original message ID | + | FromID | --from | String, Number | Chat ID of the original message | + | ToID | --to | String, Number | Target chat ID or ChatID*TopicID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [forwardMessage](https://core.telegram.org/bots/api#forwardmessage) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + MessageID = "9761"; + + Result = OPI_Telegram.ForwardMessage(Token, MessageID, ChannelID, ChatID); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8315, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453470, + "forward_origin": { + "type": "channel", + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "message_id": 9440, + "date": 1728453289 + }, + "forward_from_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "forward_from_message_id": 9440, + "forward_date": 1728453289, + "text": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-audio.md b/docs/en/md/Telegram/Data-sending/Send-audio.md deleted file mode 100644 index 0bab6579d0..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-audio.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Send audio - Sends an audio file to a chat or channel - - - -`Function SendAudio(Val Token, Val ChatID, Val Text, Val Audio, Val Keyboard = "", Val Markup = "Markdown") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | Audio | --audio | BinaryData, String | Audio file | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendAudio](https://core.telegram.org/bots/api#sendaudio) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "Строковое значение"; - Audio = "https://api.athenaeum.digital/test_data/song.mp3"; - - AudioPath = GetTempFileName("mp3"); - CopyFile(Audio, AudioPath); - - AudioDD = New BinaryData(AudioPath); - - Result = OPI_Telegram.SendAudio(Token, ChatID, Text, Audio); - - Result = OPI_Telegram.SendAudio(Token, ChannelID, Text, AudioPath); - - Result = OPI_Telegram.SendAudio(Token, ChannelID, Text, AudioDD); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8306, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453355, - "audio": { - "duration": 228, - "file_name": "audio", - "mime_type": "audio/mpeg", - "title": "Dogs", - "performer": "Motorhead", - "file_id": "CQACAgIAAxkDAAIgcmcGGuszMgUnk-JaG65Sngu8yYGMAAJNWgAC_cg4SEo4WdCQr5DQNgQ", - "file_unique_id": "AgADTVoAAv3IOEg", - "file_size": 9229352 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-audio.mdx b/docs/en/md/Telegram/Data-sending/Send-audio.mdx new file mode 100644 index 0000000000..6da79ae0b4 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-audio.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Send audio + Sends an audio file to a chat or channel + + + +`Function SendAudio(Val Token, Val ChatID, Val Text, Val Audio, Val Keyboard = "", Val Markup = "Markdown") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | Audio | --audio | BinaryData, String | Audio file | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendAudio](https://core.telegram.org/bots/api#sendaudio) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "Строковое значение"; + Audio = "https://api.athenaeum.digital/test_data/song.mp3"; + + AudioPath = GetTempFileName("mp3"); + CopyFile(Audio, AudioPath); + + AudioDD = New BinaryData(AudioPath); + + Result = OPI_Telegram.SendAudio(Token, ChatID, Text, Audio); + + Result = OPI_Telegram.SendAudio(Token, ChannelID, Text, AudioPath); + + Result = OPI_Telegram.SendAudio(Token, ChannelID, Text, AudioDD); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8306, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453355, + "audio": { + "duration": 228, + "file_name": "audio", + "mime_type": "audio/mpeg", + "title": "Dogs", + "performer": "Motorhead", + "file_id": "CQACAgIAAxkDAAIgcmcGGuszMgUnk-JaG65Sngu8yYGMAAJNWgAC_cg4SEo4WdCQr5DQNgQ", + "file_unique_id": "AgADTVoAAv3IOEg", + "file_size": 9229352 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-contact.md b/docs/en/md/Telegram/Data-sending/Send-contact.md deleted file mode 100644 index 13dd7f673e..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-contact.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Send contact - Sends a contact with name and phone number - - - -`Function SendContact(Val Token, Val ChatID, Val Name, Val LastName, Val Phone, Val Keyboard = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Name | --name | String | Contact name | - | LastName | --surname | String | Contact last name | - | Phone | --phone | String | Contact phone number | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendContact](https://core.telegram.org/bots/api#sendcontact) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Name = "Петр"; - LastName = "Петров"; - Phone = "88005553535"; - - Result = OPI_Telegram.SendContact(Token, ChatID , Name, LastName, Phone); - - Result = OPI_Telegram.SendContact(Token, ChannelID, Name, LastName, Phone); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8313, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453435, - "contact": { - "phone_number": "88005553535", - "first_name": "Петр", - "last_name": "Петров" - } - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-contact.mdx b/docs/en/md/Telegram/Data-sending/Send-contact.mdx new file mode 100644 index 0000000000..ee46a7cc76 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-contact.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Send contact + Sends a contact with name and phone number + + + +`Function SendContact(Val Token, Val ChatID, Val Name, Val LastName, Val Phone, Val Keyboard = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Name | --name | String | Contact name | + | LastName | --surname | String | Contact last name | + | Phone | --phone | String | Contact phone number | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendContact](https://core.telegram.org/bots/api#sendcontact) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Name = "Петр"; + LastName = "Петров"; + Phone = "88005553535"; + + Result = OPI_Telegram.SendContact(Token, ChatID , Name, LastName, Phone); + + Result = OPI_Telegram.SendContact(Token, ChannelID, Name, LastName, Phone); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8313, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453435, + "contact": { + "phone_number": "88005553535", + "first_name": "Петр", + "last_name": "Петров" + } + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-document.md b/docs/en/md/Telegram/Data-sending/Send-document.md deleted file mode 100644 index e33e47c480..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-document.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Send document - Sends a document to a chat or channel - - - -`Function SendDocument(Val Token, Val ChatID, Val Text, Val Document, Val Keyboard = "", Val Markup = "Markdown", Val FileName = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | Document | --doc | BinaryData, String | Document file | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - | FileName | --filename | String | Custom displayed file name with extension, if necessary | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendDocument](https://core.telegram.org/bots/api#senddocument) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "Строковое значение"; - Document = "https://api.athenaeum.digital/test_data/document.docx"; - - DocumentPath = GetTempFileName("docx"); - CopyFile(Document, DocumentPath); - - DocumentDD = New BinaryData(DocumentPath); - - Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document); - - Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document, , , "customname.docx"); - - Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentPath); - - Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentDD, , , "customname.docx"); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8307, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453390, - "document": { - "file_name": "document.docx", - "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "file_id": "BQACAgIAAxkDAAIgc2cGGw4a6yPdiNLubNQsFLQQPLHoAAJPWgAC_cg4SJF9HYfiILIbNgQ", - "file_unique_id": "AgADT1oAAv3IOEg", - "file_size": 24069 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-document.mdx b/docs/en/md/Telegram/Data-sending/Send-document.mdx new file mode 100644 index 0000000000..533d454539 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-document.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Send document + Sends a document to a chat or channel + + + +`Function SendDocument(Val Token, Val ChatID, Val Text, Val Document, Val Keyboard = "", Val Markup = "Markdown", Val FileName = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | Document | --doc | BinaryData, String | Document file | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + | FileName | --filename | String | Custom displayed file name with extension, if necessary | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendDocument](https://core.telegram.org/bots/api#senddocument) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "Строковое значение"; + Document = "https://api.athenaeum.digital/test_data/document.docx"; + + DocumentPath = GetTempFileName("docx"); + CopyFile(Document, DocumentPath); + + DocumentDD = New BinaryData(DocumentPath); + + Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document); + + Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document, , , "customname.docx"); + + Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentPath); + + Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentDD, , , "customname.docx"); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8307, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453390, + "document": { + "file_name": "document.docx", + "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "file_id": "BQACAgIAAxkDAAIgc2cGGw4a6yPdiNLubNQsFLQQPLHoAAJPWgAC_cg4SJF9HYfiILIbNgQ", + "file_unique_id": "AgADT1oAAv3IOEg", + "file_size": 24069 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-gif.md b/docs/en/md/Telegram/Data-sending/Send-gif.md deleted file mode 100644 index 20bcd07fd9..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-gif.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Send GIF - Sends a GIF to a chat or channel - - - -`Function SendGif(Val Token, Val ChatID, Val Text, Val GIF, Val Keyboard = "", Val Markup = "Markdown") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | GIF | --gif | BinaryData, String | GIF file | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendAnimation](https://core.telegram.org/bots/api#sendanimation) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "Строковое значение"; - GIF = "https://api.athenaeum.digital/test_data/animation.gif"; - - GifPath = GetTempFileName("gif"); - CopyFile(GIF, GifPath); - - GifDD = New BinaryData(GifPath); - - Result = OPI_Telegram.SendGif(Token, ChatID, Text, GIF); - - Result = OPI_Telegram.SendGif(Token, ChannelID, Text, GifPath); - - Result = OPI_Telegram.SendGif(Token, ChannelID, Text, GifDD); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8309, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453403, - "animation": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "duration": 3, - "width": 220, - "height": 220, - "thumbnail": { - "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", - "file_unique_id": "AQADUVoAAv3IOEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", - "file_unique_id": "AQADUVoAAv3IOEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAIgdWcGGxuVxSPfXdxBWSyEamU7jqpPAAJRWgAC_cg4SO6OiBK2xkBtNgQ", - "file_unique_id": "AgADUVoAAv3IOEg", - "file_size": 84941 - }, - "document": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", - "file_unique_id": "AQADUVoAAv3IOEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", - "file_unique_id": "AQADUVoAAv3IOEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAIgdWcGGxuVxSPfXdxBWSyEamU7jqpPAAJRWgAC_cg4SO6OiBK2xkBtNgQ", - "file_unique_id": "AgADUVoAAv3IOEg", - "file_size": 84941 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-gif.mdx b/docs/en/md/Telegram/Data-sending/Send-gif.mdx new file mode 100644 index 0000000000..021bcf6a19 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-gif.mdx @@ -0,0 +1,124 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Send GIF + Sends a GIF to a chat or channel + + + +`Function SendGif(Val Token, Val ChatID, Val Text, Val GIF, Val Keyboard = "", Val Markup = "Markdown") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | GIF | --gif | BinaryData, String | GIF file | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendAnimation](https://core.telegram.org/bots/api#sendanimation) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "Строковое значение"; + GIF = "https://api.athenaeum.digital/test_data/animation.gif"; + + GifPath = GetTempFileName("gif"); + CopyFile(GIF, GifPath); + + GifDD = New BinaryData(GifPath); + + Result = OPI_Telegram.SendGif(Token, ChatID, Text, GIF); + + Result = OPI_Telegram.SendGif(Token, ChannelID, Text, GifPath); + + Result = OPI_Telegram.SendGif(Token, ChannelID, Text, GifDD); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8309, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453403, + "animation": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "duration": 3, + "width": 220, + "height": 220, + "thumbnail": { + "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", + "file_unique_id": "AQADUVoAAv3IOEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", + "file_unique_id": "AQADUVoAAv3IOEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAIgdWcGGxuVxSPfXdxBWSyEamU7jqpPAAJRWgAC_cg4SO6OiBK2xkBtNgQ", + "file_unique_id": "AgADUVoAAv3IOEg", + "file_size": 84941 + }, + "document": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", + "file_unique_id": "AQADUVoAAv3IOEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAiB1ZwYbG5XFI99d3EFZLIRqZTuOqk8AAlFaAAL9yDhI7o6IErbGQG0BAAdtAAM2BA", + "file_unique_id": "AQADUVoAAv3IOEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAIgdWcGGxuVxSPfXdxBWSyEamU7jqpPAAJRWgAC_cg4SO6OiBK2xkBtNgQ", + "file_unique_id": "AgADUVoAAv3IOEg", + "file_size": 84941 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-image.md b/docs/en/md/Telegram/Data-sending/Send-image.md deleted file mode 100644 index 5c7af94206..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-image.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Send image - Sends an image to a chat or channel - - - -`Function SendImage(Val Token, Val ChatID, Val Text, Val Image, Val Keyboard = "", Val Markup = "Markdown") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | Image | --picture | BinaryData, String | Image file | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendPhoto](https://core.telegram.org/bots/api#sendphoto) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "String value"; - Image = "https://openintegrations.dev/test_data/picture.jpg"; - - ImagePath = GetTempFileName("png"); - FileCopy(Image, ImagePath); - - ImageDD = New BinaryData(ImagePath); - - Result = OPI_Telegram.SendImage(Token, ChatID, Text, Image); - - Result = OPI_Telegram.SendImage(Token, ChannelID, Text, ImagePath); - - Result = OPI_Telegram.SendImage(Token, ChannelID, Text, ImageDD); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8304, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453303, - "photo": [ - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Ety", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-image.mdx b/docs/en/md/Telegram/Data-sending/Send-image.mdx new file mode 100644 index 0000000000..46f1b75d07 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-image.mdx @@ -0,0 +1,116 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Send image + Sends an image to a chat or channel + + + +`Function SendImage(Val Token, Val ChatID, Val Text, Val Image, Val Keyboard = "", Val Markup = "Markdown") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | Image | --picture | BinaryData, String | Image file | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendPhoto](https://core.telegram.org/bots/api#sendphoto) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "String value"; + Image = "https://openintegrations.dev/test_data/picture.jpg"; + + ImagePath = GetTempFileName("png"); + FileCopy(Image, ImagePath); + + ImageDD = New BinaryData(ImagePath); + + Result = OPI_Telegram.SendImage(Token, ChatID, Text, Image); + + Result = OPI_Telegram.SendImage(Token, ChannelID, Text, ImagePath); + + Result = OPI_Telegram.SendImage(Token, ChannelID, Text, ImageDD); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8304, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453303, + "photo": [ + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Ety", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-location.md b/docs/en/md/Telegram/Data-sending/Send-location.md deleted file mode 100644 index acdcce3f2b..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-location.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Send location - Sends location by geographic latitude and longitude to a chat or channel - - - -`Function SendLocation(Val Token, Val ChatID, Val Latitude, Val Longitude, Val Keyboard = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Latitude | --lat | String, Number | Geographic latitude | - | Longitude | --long | String, Number | Geographic longitude | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendLocation](https://core.telegram.org/bots/api#sendlocation) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Width = "48.87373649724122"; - Longitude = "48.87373649724122"; - - Result = OPI_Telegram.SendLocation(Token, ChatID, Width, Longitude); - - Result = OPI_Telegram.SendLocation(Token, ChannelID, Width, Longitude); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8312, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453427, - "location": { - "latitude": 48.873739, - "longitude": 48.873733 - } - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-location.mdx b/docs/en/md/Telegram/Data-sending/Send-location.mdx new file mode 100644 index 0000000000..6bedbcdc89 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-location.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Send location + Sends location by geographic latitude and longitude to a chat or channel + + + +`Function SendLocation(Val Token, Val ChatID, Val Latitude, Val Longitude, Val Keyboard = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Latitude | --lat | String, Number | Geographic latitude | + | Longitude | --long | String, Number | Geographic longitude | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendLocation](https://core.telegram.org/bots/api#sendlocation) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Width = "48.87373649724122"; + Longitude = "48.87373649724122"; + + Result = OPI_Telegram.SendLocation(Token, ChatID, Width, Longitude); + + Result = OPI_Telegram.SendLocation(Token, ChannelID, Width, Longitude); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8312, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453427, + "location": { + "latitude": 48.873739, + "longitude": 48.873733 + } + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-media-group.md b/docs/en/md/Telegram/Data-sending/Send-media-group.md deleted file mode 100644 index 7b134fd940..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-media-group.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Send media group - Sends a set of files to a chat or channel. Media types: audio, document, photo, video - - - -`Function SendMediaGroup(Val Token, Val ChatID, Val Text, Val FileMapping, Val Keyboard = "", Val Markup = "Markdown") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | FileMapping | --media | Map of KeyAndValue | File collection: Key > File, Value > Media Type | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - Text = "Строковое значение"; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - Video = "https://api.athenaeum.digital/test_data/video.mp4"; - - ImagePath = GetTempFileName("png"); - CopyFile(Image, ImagePath); - - VideoPath = GetTempFileName("mp4"); - CopyFile(Video, VideoPath); - - VideoDD = New BinaryData(VideoPath); - - MediaGroup = New Map; - MediaGroup.Insert(ImagePath, "photo"); - MediaGroup.Insert(VideoDD , "video"); - - Result = OPI_Telegram.SendMediaGroup(Token, ChatID, Text, MediaGroup); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": [ - { - "message_id": 8310, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453419, - "media_group_id": "13827627353456290", - "photo": [ - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Ety", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "Строковое значение" - }, - { - "message_id": 8311, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453419, - "media_group_id": "13827627353456290", - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video1", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADFQdnBhsq6-bI-FK3CYb2iTi0EMaRSQACU1oAAv3IOEhuDaGGTZyj9AEAB20AAzYE", - "file_unique_id": "AQADU1oAAv3IOEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADFQdnBhsq6-bI-FK3CYb2iTi0EMaRSQACU1oAAv3IOEhuDaGGTZyj9AEAB20AAzYE", - "file_unique_id": "AQADU1oAAv3IOEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxUHZwYbKuvmyPhStwmG9ok4tBDGkUkAAlNaAAL9yDhIbg2hhk2co_Q2BA", - "file_unique_id": "AgADU1oAAv3IOEg", - "file_size": 1137878 - } - } - ] -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-media-group.mdx b/docs/en/md/Telegram/Data-sending/Send-media-group.mdx new file mode 100644 index 0000000000..61ad2bc6f6 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-media-group.mdx @@ -0,0 +1,164 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Send media group + Sends a set of files to a chat or channel. Media types: audio, document, photo, video + + + +`Function SendMediaGroup(Val Token, Val ChatID, Val Text, Val FileMapping, Val Keyboard = "", Val Markup = "Markdown") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | FileMapping | --media | Map of KeyAndValue | File collection: Key > File, Value > Media Type | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + Text = "Строковое значение"; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + Video = "https://api.athenaeum.digital/test_data/video.mp4"; + + ImagePath = GetTempFileName("png"); + CopyFile(Image, ImagePath); + + VideoPath = GetTempFileName("mp4"); + CopyFile(Video, VideoPath); + + VideoDD = New BinaryData(VideoPath); + + MediaGroup = New Map; + MediaGroup.Insert(ImagePath, "photo"); + MediaGroup.Insert(VideoDD , "video"); + + Result = OPI_Telegram.SendMediaGroup(Token, ChatID, Text, MediaGroup); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": [ + { + "message_id": 8310, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453419, + "media_group_id": "13827627353456290", + "photo": [ + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Ety", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "Строковое значение" + }, + { + "message_id": 8311, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453419, + "media_group_id": "13827627353456290", + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video1", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADFQdnBhsq6-bI-FK3CYb2iTi0EMaRSQACU1oAAv3IOEhuDaGGTZyj9AEAB20AAzYE", + "file_unique_id": "AQADU1oAAv3IOEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADFQdnBhsq6-bI-FK3CYb2iTi0EMaRSQACU1oAAv3IOEhuDaGGTZyj9AEAB20AAzYE", + "file_unique_id": "AQADU1oAAv3IOEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxUHZwYbKuvmyPhStwmG9ok4tBDGkUkAAlNaAAL9yDhIbg2hhk2co_Q2BA", + "file_unique_id": "AgADU1oAAv3IOEg", + "file_size": 1137878 + } + } + ] +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-poll.md b/docs/en/md/Telegram/Data-sending/Send-poll.md deleted file mode 100644 index e2241936fc..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-poll.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Send poll - Sends a poll with answer options - - - -`Function SendPoll(Val Token, Val ChatID, Val Question, Val AnswersArray, Val Anonymous = True) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Question | --question | String | Poll question | - | AnswersArray | --options | Array of String | Array of answer options | - | Anonymous | --anonymous | Boolean | Survey anonymity flag | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendPoll](https://core.telegram.org/bots/api#sendpoll) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Question = "What's your favorite color?"; - - AnswersArray = New Array; - AnswersArray.Add("Red"); - AnswersArray.Add("Yellow"); - AnswersArray.Add("Green"); - AnswersArray.Add("Blue"); - - Result = OPI_Telegram.SendPoll(Token, ChatID , Question, AnswersArray, False); - - Result = OPI_Telegram.SendPoll(Token, ChannelID, Question, AnswersArray, True); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8314, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453463, - "poll": { - "id": "5204130358378891890", - "question": "What's your favorite color?", - "options": [ - { - "text": "Red", - "voter_count": 0 - }, - { - "text": "Yellow", - "voter_count": 0 - }, - { - "text": "Green", - "voter_count": 0 - }, - { - "text": "Blue", - "voter_count": 0 - } - ], - "total_voter_count": 0, - "is_closed": false, - "is_anonymous": false, - "type": "regular", - "allows_multiple_answers": false - } - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-poll.mdx b/docs/en/md/Telegram/Data-sending/Send-poll.mdx new file mode 100644 index 0000000000..c8cd77fef3 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-poll.mdx @@ -0,0 +1,102 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Send poll + Sends a poll with answer options + + + +`Function SendPoll(Val Token, Val ChatID, Val Question, Val AnswersArray, Val Anonymous = True) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Question | --question | String | Poll question | + | AnswersArray | --options | Array of String | Array of answer options | + | Anonymous | --anonymous | Boolean | Survey anonymity flag | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendPoll](https://core.telegram.org/bots/api#sendpoll) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Question = "What's your favorite color?"; + + AnswersArray = New Array; + AnswersArray.Add("Red"); + AnswersArray.Add("Yellow"); + AnswersArray.Add("Green"); + AnswersArray.Add("Blue"); + + Result = OPI_Telegram.SendPoll(Token, ChatID , Question, AnswersArray, False); + + Result = OPI_Telegram.SendPoll(Token, ChannelID, Question, AnswersArray, True); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8314, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453463, + "poll": { + "id": "5204130358378891890", + "question": "What's your favorite color?", + "options": [ + { + "text": "Red", + "voter_count": 0 + }, + { + "text": "Yellow", + "voter_count": 0 + }, + { + "text": "Green", + "voter_count": 0 + }, + { + "text": "Blue", + "voter_count": 0 + } + ], + "total_voter_count": 0, + "is_closed": false, + "is_anonymous": false, + "type": "regular", + "allows_multiple_answers": false + } + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-text-message.md b/docs/en/md/Telegram/Data-sending/Send-text-message.md deleted file mode 100644 index 6db8844dfc..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-text-message.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Send text message - Sends a text message to a chat or channel - - - -`Function SendTextMessage(Val Token, Val ChatID, Val Text, Val Keyboard = "", Val Markup = "Markdown", Val RepliedID = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - | RepliedID | --reply | String, Number | Reply to message ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendMessage](https://core.telegram.org/bots/api#sendmessage) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "Строковое значение"; - - Result = OPI_Telegram.SendTextMessage(Token, ChatID, Text); - - Result = OPI_Telegram.SendTextMessage(Token, ChannelID, Text); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8302, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453289, - "text": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-text-message.mdx b/docs/en/md/Telegram/Data-sending/Send-text-message.mdx new file mode 100644 index 0000000000..1b99d3f35b --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-text-message.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Send text message + Sends a text message to a chat or channel + + + +`Function SendTextMessage(Val Token, Val ChatID, Val Text, Val Keyboard = "", Val Markup = "Markdown", Val RepliedID = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + | RepliedID | --reply | String, Number | Reply to message ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendMessage](https://core.telegram.org/bots/api#sendmessage) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "Строковое значение"; + + Result = OPI_Telegram.SendTextMessage(Token, ChatID, Text); + + Result = OPI_Telegram.SendTextMessage(Token, ChannelID, Text); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8302, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453289, + "text": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-video.md b/docs/en/md/Telegram/Data-sending/Send-video.md deleted file mode 100644 index 3e83f487f5..0000000000 --- a/docs/en/md/Telegram/Data-sending/Send-video.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Send video - Sends a video to a chat or channel - - - -`Function SendVideo(Val Token, Val ChatID, Val Text, Val Video, Val Keyboard = "", Val Markup = "Markdown") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | Video | --video | BinaryData, String | Video file | - | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [sendVideo](https://core.telegram.org/bots/api#sendvideo) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "Строковое значение"; - Video = "https://api.athenaeum.digital/test_data/video.mp4"; - - VideoPath = GetTempFileName("mp4"); - CopyFile(Video, VideoPath); - - VideoDD = New BinaryData(VideoPath); - - Result = OPI_Telegram.SendVideo(Token, ChatID, Text, Video); - - Result = OPI_Telegram.SendVideo(Token, ChannelID, Text, VideoPath); - - Result = OPI_Telegram.SendVideo(Token, ChannelID, Text, VideoDD); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_id": 8305, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728453323, - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAiBxZwYayqajllz9GMFHYBYZ7YpNjTEAAktaAAL9yDhIF3QIvLsyAUIBAAdtAAM2BA", - "file_unique_id": "AQADS1oAAv3IOEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAiBxZwYayqajllz9GMFHYBYZ7YpNjTEAAktaAAL9yDhIF3QIvLsyAUIBAAdtAAM2BA", - "file_unique_id": "AQADS1oAAv3IOEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxkDAAIgcWcGGsqmo5Zc_RjBR2AWGe2KTY0xAAJLWgAC_cg4SBd0CLy7MgFCNgQ", - "file_unique_id": "AgADS1oAAv3IOEg", - "file_size": 1137878 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/en/md/Telegram/Data-sending/Send-video.mdx b/docs/en/md/Telegram/Data-sending/Send-video.mdx new file mode 100644 index 0000000000..22dfb6dc27 --- /dev/null +++ b/docs/en/md/Telegram/Data-sending/Send-video.mdx @@ -0,0 +1,103 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Send video + Sends a video to a chat or channel + + + +`Function SendVideo(Val Token, Val ChatID, Val Text, Val Video, Val Keyboard = "", Val Markup = "Markdown") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | Video | --video | BinaryData, String | Video file | + | Keyboard | --keyboard | String | Keyboard. See FormKeyboardFromButtonArray | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [sendVideo](https://core.telegram.org/bots/api#sendvideo) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "Строковое значение"; + Video = "https://api.athenaeum.digital/test_data/video.mp4"; + + VideoPath = GetTempFileName("mp4"); + CopyFile(Video, VideoPath); + + VideoDD = New BinaryData(VideoPath); + + Result = OPI_Telegram.SendVideo(Token, ChatID, Text, Video); + + Result = OPI_Telegram.SendVideo(Token, ChannelID, Text, VideoPath); + + Result = OPI_Telegram.SendVideo(Token, ChannelID, Text, VideoDD); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_id": 8305, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728453323, + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAiBxZwYayqajllz9GMFHYBYZ7YpNjTEAAktaAAL9yDhIF3QIvLsyAUIBAAdtAAM2BA", + "file_unique_id": "AQADS1oAAv3IOEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAiBxZwYayqajllz9GMFHYBYZ7YpNjTEAAktaAAL9yDhIF3QIvLsyAUIBAAdtAAM2BA", + "file_unique_id": "AQADS1oAAv3IOEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxkDAAIgcWcGGsqmo5Zc_RjBR2AWGe2KTY0xAAJLWgAC_cg4SBd0CLy7MgFCNgQ", + "file_unique_id": "AgADS1oAAv3IOEg", + "file_size": 1137878 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md b/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md deleted file mode 100644 index 29e23c57ce..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Clear thread's pinned messages list - Clears the list of pinned messages in the forum thread - - - -`Function ClearThreadPinnedMessagesList(Val Token, Val ChatID, Val ThreadID = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID. Main if not filled | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [unpinAllForumTopicMessages](https://core.telegram.org/bots/api#unpinallforumtopicmessages) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "3896"; - - Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat); - - Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat, Topic); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.mdx b/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.mdx new file mode 100644 index 0000000000..000e4108cb --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Clear thread's pinned messages list + Clears the list of pinned messages in the forum thread + + + +`Function ClearThreadPinnedMessagesList(Val Token, Val ChatID, Val ThreadID = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID. Main if not filled | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [unpinAllForumTopicMessages](https://core.telegram.org/bots/api#unpinallforumtopicmessages) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "3896"; + + Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat); + + Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat, Topic); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md b/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md deleted file mode 100644 index 83ddc3dda6..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Close forum thread - Closes the thread for new messages - - - -`Function CloseForumThread(Val Token, Val ChatID, Val ThreadID = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [closeForumTopic](https://core.telegram.org/bots/api#closeforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "3896"; - - Result = OPI_Telegram.CloseForumThread(Token, Chat); // Closes main topic - - Result = OPI_Telegram.CloseForumThread(Token, Chat, Topic); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.mdx b/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.mdx new file mode 100644 index 0000000000..db983d436a --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Close forum thread + Closes the thread for new messages + + + +`Function CloseForumThread(Val Token, Val ChatID, Val ThreadID = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [closeForumTopic](https://core.telegram.org/bots/api#closeforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "3896"; + + Result = OPI_Telegram.CloseForumThread(Token, Chat); // Closes main topic + + Result = OPI_Telegram.CloseForumThread(Token, Chat, Topic); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md b/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md deleted file mode 100644 index 20b03dd3f9..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create forum thread - Creates a new thread in the group with theme functionality enabled - - - -`Function CreateForumThread(Val Token, Val ChatID, Val Title, Val IconID = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread creation chat ID | - | Title | --title | String | Thread title | - | IconID | --icon | String | See GetAvatarIconList | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [createForumTopic](https://core.telegram.org/bots/api#createforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Icon = "5357419403325481346"; - Name = "TestTopic " + String(New UUID); - - Result = OPI_Telegram.CreateForumThread(Token, Chat, Name, Icon); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": { - "message_thread_id": 5407, - "name": "TestTopic 6e8a9d01-e4f4-4c9e-80fc-004f9bd0d697", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - } -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.mdx b/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.mdx new file mode 100644 index 0000000000..994fb5dd10 --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create forum thread + Creates a new thread in the group with theme functionality enabled + + + +`Function CreateForumThread(Val Token, Val ChatID, Val Title, Val IconID = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread creation chat ID | + | Title | --title | String | Thread title | + | IconID | --icon | String | See GetAvatarIconList | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [createForumTopic](https://core.telegram.org/bots/api#createforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Icon = "5357419403325481346"; + Name = "TestTopic " + String(New UUID); + + Result = OPI_Telegram.CreateForumThread(Token, Chat, Name, Icon); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": { + "message_thread_id": 5407, + "name": "TestTopic 6e8a9d01-e4f4-4c9e-80fc-004f9bd0d697", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + } +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md deleted file mode 100644 index 7603b52e5f..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Delete forum thread - Deletes a forum thread - - - -`Function DeleteForumTopic(Val Token, Val ChatID, Val ThreadID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [deleteForumTopic](https://core.telegram.org/bots/api#deleteforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "5543"; - - Result = OPI_Telegram.DeleteForumTopic(Token, Chat, Topic); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.mdx b/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.mdx new file mode 100644 index 0000000000..45fdcfc6e1 --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Delete forum thread + Deletes a forum thread + + + +`Function DeleteForumTopic(Val Token, Val ChatID, Val ThreadID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [deleteForumTopic](https://core.telegram.org/bots/api#deleteforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "5543"; + + Result = OPI_Telegram.DeleteForumTopic(Token, Chat, Topic); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md deleted file mode 100644 index 8b11631edd..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Edit forum thread - Creates a new thread in the group with theme functionality enabled - - - -`Function EditForumTopic(Val Token, Val ChatID, Val ThreadID, Val Title = Undefined, Val IconID = Undefined) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread creation chat ID | - | ThreadID | --topic | String, Number | Thread ID | - | Title | --title | String | New title | - | IconID | --icon | String | See GetAvatarIconList | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [editForumTopic](https://core.telegram.org/bots/api#editforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "5543"; - NewName = "NewTestTitle"; - NewIcon = "5310132165583840589"; - - Result = OPI_Telegram.EditForumTopic(Token, Chat, Topic, NewName, NewIcon); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.mdx b/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.mdx new file mode 100644 index 0000000000..d51bf34b63 --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Edit forum thread + Creates a new thread in the group with theme functionality enabled + + + +`Function EditForumTopic(Val Token, Val ChatID, Val ThreadID, Val Title = Undefined, Val IconID = Undefined) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread creation chat ID | + | ThreadID | --topic | String, Number | Thread ID | + | Title | --title | String | New title | + | IconID | --icon | String | See GetAvatarIconList | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [editForumTopic](https://core.telegram.org/bots/api#editforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "5543"; + NewName = "NewTestTitle"; + NewIcon = "5310132165583840589"; + + Result = OPI_Telegram.EditForumTopic(Token, Chat, Topic, NewName, NewIcon); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md b/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md deleted file mode 100644 index 215bce3202..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Edit main forum thread name - Edits the name of the main forum thread - - - -`Function EditMainForumTopicName(Val Token, Val ChatID, Val Title) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | Title | --title | String | New main thread name | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [editGeneralForumTopic](https://core.telegram.org/bots/api#editgeneralforumtopic) -::: -
- - -```bsl title="Code example" - Title = "New main thread name " + String(New UUID); - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - - Result = OPI_Telegram.EditMainForumTopicName(Token, Chat, Title); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.mdx b/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.mdx new file mode 100644 index 0000000000..53599bbcfb --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Edit main forum thread name + Edits the name of the main forum thread + + + +`Function EditMainForumTopicName(Val Token, Val ChatID, Val Title) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | Title | --title | String | New main thread name | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [editGeneralForumTopic](https://core.telegram.org/bots/api#editgeneralforumtopic) +::: +
+ + +```bsl title="Code example" + Title = "New main thread name " + String(New UUID); + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + + Result = OPI_Telegram.EditMainForumTopicName(Token, Chat, Title); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md b/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md deleted file mode 100644 index 229d7f84a2..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get avatar icon list - Gets the mapping of Emoji IDs for setting as forum theme icons - - - -`Function GetAvatarIconList(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - Key > ID, Value > Emoji - -
- -:::tip -Method at API documentation: [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.GetAvatarIconList(Token); -``` - - - - -```json title="Result" -{ - "5434144690511290129": "📰", - "5312536423851630001": "💡", - "5312016608254762256": "⚡️", - "5377544228505134960": "🎙", - "5418085807791545980": "🔝", - "5370870893004203704": "🗣", - "5420216386448270341": "🆒", - "5379748062124056162": "❗️", - "5373251851074415873": "📝", - "5433614043006903194": "📆", - "5357315181649076022": "📁", - "5309965701241379366": "🔎", - "5309984423003823246": "📣", - "5312241539987020022": "🔥", - "5312138559556164615": "❤️", - "5377316857231450742": "❓", - "5350305691942788490": "📈", - "5350713563512052787": "📉", - "5309958691854754293": "💎", - "5350452584119279096": "💰", - "5309929258443874898": "💸", - "5377690785674175481": "🪙", - "5310107765874632305": "💱", - "5377438129928020693": "⁉️", - "5309950797704865693": "🎮", - "5350554349074391003": "💻", - "5409357944619802453": "📱", - "5312322066328853156": "🚗", - "5312486108309757006": "🏠", - "5310029292527164639": "💘", - "5310228579009699834": "🎉", - "5377498341074542641": "‼️", - "5312315739842026755": "🏆", - "5408906741125490282": "🏁", - "5368653135101310687": "🎬", - "5310045076531978942": "🎵", - "5420331611830886484": "🔞", - "5350481781306958339": "📚", - "5357107601584693888": "👑", - "5375159220280762629": "⚽️", - "5384327463629233871": "🏀", - "5350513667144163474": "📺", - "5357121491508928442": "👀", - "5357185426392096577": "🫦", - "5310157398516703416": "🍓", - "5310262535021142850": "💄", - "5368741306484925109": "👠", - "5348436127038579546": "✈️", - "5357120306097956843": "🧳", - "5310303848311562896": "🏖", - "5350424168615649565": "⛅️", - "5413625003218313783": "🦄", - "5350699789551935589": "🛍", - "5377478880577724584": "👜", - "5431492767249342908": "🛒", - "5350497316203668441": "🚂", - "5350422527938141909": "🛥", - "5418196338774907917": "🏔", - "5350648297189023928": "🏕", - "5309832892262654231": "🤖", - "5350751634102166060": "🪩", - "5377624166436445368": "🎟", - "5386395194029515402": "🏴‍☠️", - "5350387571199319521": "🗳", - "5357419403325481346": "🎓", - "5368585403467048206": "🔭", - "5377580546748588396": "🔬", - "5377317729109811382": "🎶", - "5382003830487523366": "🎤", - "5357298525765902091": "🕺", - "5357370526597653193": "💃", - "5357188789351490453": "🪖", - "5348227245599105972": "💼", - "5411138633765757782": "🧪", - "5386435923204382258": "👨‍👩‍👧‍👦", - "5377675010259297233": "👶", - "5386609083400856174": "🤰", - "5368808634392257474": "💅", - "5350548830041415279": "🏛", - "5355127101970194557": "🧮", - "5386379624773066504": "🖨", - "5377494501373780436": "👮‍♂️", - "5350307998340226571": "🩺", - "5310094636159607472": "💊", - "5310139157790596888": "💉", - "5377468357907849200": "🧼", - "5418115271267197333": "🪪", - "5372819184658949787": "🛃", - "5350344462612570293": "🍽", - "5384574037701696503": "🐟", - "5310039132297242441": "🎨", - "5350658016700013471": "🎭", - "5357504778685392027": "🎩", - "5350367161514732241": "🔮", - "5350520238444126134": "🍹", - "5310132165583840589": "🎂", - "5350392020785437399": "☕️", - "5350406176997646350": "🍣", - "5350403544182694064": "🍔", - "5350444672789519765": "🍕", - "5312424913615723286": "🦠", - "5417915203100613993": "💬", - "5312054580060625569": "🎄", - "5309744892677727325": "🎃", - "5238156910363950406": "✍️", - "5235579393115438657": "⭐️", - "5237699328843200968": "✅", - "5238027455754680851": "🎖", - "5238234236955148254": "🤡", - "5237889595894414384": "🧠", - "5237999392438371490": "🦮", - "5235912661102773458": "🐈" -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.mdx b/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.mdx new file mode 100644 index 0000000000..675d256f4d --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.mdx @@ -0,0 +1,153 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get avatar icon list + Gets the mapping of Emoji IDs for setting as forum theme icons + + + +`Function GetAvatarIconList(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - Key > ID, Value > Emoji + +
+ +:::tip +Method at API documentation: [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.GetAvatarIconList(Token); +``` + + + + +```json title="Result" +{ + "5434144690511290129": "📰", + "5312536423851630001": "💡", + "5312016608254762256": "⚡️", + "5377544228505134960": "🎙", + "5418085807791545980": "🔝", + "5370870893004203704": "🗣", + "5420216386448270341": "🆒", + "5379748062124056162": "❗️", + "5373251851074415873": "📝", + "5433614043006903194": "📆", + "5357315181649076022": "📁", + "5309965701241379366": "🔎", + "5309984423003823246": "📣", + "5312241539987020022": "🔥", + "5312138559556164615": "❤️", + "5377316857231450742": "❓", + "5350305691942788490": "📈", + "5350713563512052787": "📉", + "5309958691854754293": "💎", + "5350452584119279096": "💰", + "5309929258443874898": "💸", + "5377690785674175481": "🪙", + "5310107765874632305": "💱", + "5377438129928020693": "⁉️", + "5309950797704865693": "🎮", + "5350554349074391003": "💻", + "5409357944619802453": "📱", + "5312322066328853156": "🚗", + "5312486108309757006": "🏠", + "5310029292527164639": "💘", + "5310228579009699834": "🎉", + "5377498341074542641": "‼️", + "5312315739842026755": "🏆", + "5408906741125490282": "🏁", + "5368653135101310687": "🎬", + "5310045076531978942": "🎵", + "5420331611830886484": "🔞", + "5350481781306958339": "📚", + "5357107601584693888": "👑", + "5375159220280762629": "⚽️", + "5384327463629233871": "🏀", + "5350513667144163474": "📺", + "5357121491508928442": "👀", + "5357185426392096577": "🫦", + "5310157398516703416": "🍓", + "5310262535021142850": "💄", + "5368741306484925109": "👠", + "5348436127038579546": "✈️", + "5357120306097956843": "🧳", + "5310303848311562896": "🏖", + "5350424168615649565": "⛅️", + "5413625003218313783": "🦄", + "5350699789551935589": "🛍", + "5377478880577724584": "👜", + "5431492767249342908": "🛒", + "5350497316203668441": "🚂", + "5350422527938141909": "🛥", + "5418196338774907917": "🏔", + "5350648297189023928": "🏕", + "5309832892262654231": "🤖", + "5350751634102166060": "🪩", + "5377624166436445368": "🎟", + "5386395194029515402": "🏴‍☠️", + "5350387571199319521": "🗳", + "5357419403325481346": "🎓", + "5368585403467048206": "🔭", + "5377580546748588396": "🔬", + "5377317729109811382": "🎶", + "5382003830487523366": "🎤", + "5357298525765902091": "🕺", + "5357370526597653193": "💃", + "5357188789351490453": "🪖", + "5348227245599105972": "💼", + "5411138633765757782": "🧪", + "5386435923204382258": "👨‍👩‍👧‍👦", + "5377675010259297233": "👶", + "5386609083400856174": "🤰", + "5368808634392257474": "💅", + "5350548830041415279": "🏛", + "5355127101970194557": "🧮", + "5386379624773066504": "🖨", + "5377494501373780436": "👮‍♂️", + "5350307998340226571": "🩺", + "5310094636159607472": "💊", + "5310139157790596888": "💉", + "5377468357907849200": "🧼", + "5418115271267197333": "🪪", + "5372819184658949787": "🛃", + "5350344462612570293": "🍽", + "5384574037701696503": "🐟", + "5310039132297242441": "🎨", + "5350658016700013471": "🎭", + "5357504778685392027": "🎩", + "5350367161514732241": "🔮", + "5350520238444126134": "🍹", + "5310132165583840589": "🎂", + "5350392020785437399": "☕️", + "5350406176997646350": "🍣", + "5350403544182694064": "🍔", + "5350444672789519765": "🍕", + "5312424913615723286": "🦠", + "5417915203100613993": "💬", + "5312054580060625569": "🎄", + "5309744892677727325": "🎃", + "5238156910363950406": "✍️", + "5235579393115438657": "⭐️", + "5237699328843200968": "✅", + "5238027455754680851": "🎖", + "5238234236955148254": "🤡", + "5237889595894414384": "🧠", + "5237999392438371490": "🦮", + "5235912661102773458": "🐈" +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md deleted file mode 100644 index 378ea993da..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Hide main forum thread - Hides the main forum thread - - - -`Function HideMainForumTopic(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [hideGeneralForumTopic](https://core.telegram.org/bots/api#hidegeneralforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - - Result = OPI_Telegram.HideMainForumTopic(Token, Chat); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.mdx b/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.mdx new file mode 100644 index 0000000000..a684b4eeba --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Hide main forum thread + Hides the main forum thread + + + +`Function HideMainForumTopic(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [hideGeneralForumTopic](https://core.telegram.org/bots/api#hidegeneralforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + + Result = OPI_Telegram.HideMainForumTopic(Token, Chat); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md b/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md deleted file mode 100644 index 341880a06c..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Open forum thread - Reopens a previously closed forum thread - - - -`Function OpenForumThread(Val Token, Val ChatID, Val ThreadID = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [reopenForumTopic](https://core.telegram.org/bots/api#reopenforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "3896"; - - Result = OPI_Telegram.OpenForumThread(Token, Chat); // Opens main topic - - Result = OPI_Telegram.OpenForumThread(Token, Chat, Topic); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.mdx b/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.mdx new file mode 100644 index 0000000000..1865693d91 --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Open forum thread + Reopens a previously closed forum thread + + + +`Function OpenForumThread(Val Token, Val ChatID, Val ThreadID = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [reopenForumTopic](https://core.telegram.org/bots/api#reopenforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "3896"; + + Result = OPI_Telegram.OpenForumThread(Token, Chat); // Opens main topic + + Result = OPI_Telegram.OpenForumThread(Token, Chat, Topic); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md deleted file mode 100644 index 1ea311446e..0000000000 --- a/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Show main forum thread - Shows a previously hidden main forum thread - - - -`Function ShowMainForumTopic(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Telegram - -
- -:::tip -Method at API documentation: [unhideGeneralForumTopic](https://core.telegram.org/bots/api#unhidegeneralforumtopic) -::: -
- - -```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - - Result = OPI_Telegram.ShowMainForumTopic(Token, Chat); -``` - - - - -```json title="Result" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.mdx b/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.mdx new file mode 100644 index 0000000000..0eb6c363d2 --- /dev/null +++ b/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Show main forum thread + Shows a previously hidden main forum thread + + + +`Function ShowMainForumTopic(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Telegram + +
+ +:::tip +Method at API documentation: [unhideGeneralForumTopic](https://core.telegram.org/bots/api#unhidegeneralforumtopic) +::: +
+ + +```bsl title="Code example" + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + + Result = OPI_Telegram.ShowMainForumTopic(Token, Chat); +``` + + + + +```json title="Result" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md b/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md deleted file mode 100644 index 185bb9396a..0000000000 --- a/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get authorization link - Forms a link for authorization via the browser - - - -`Function GetAuthorizationLink(Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: String - URL for browser transition - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Result = OPI_Twitter.GetAuthorizationLink(Parameters); -``` - - - - -```json title="Result" -"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https://api.athenaeum.digital/opi/hs/twitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" -``` diff --git a/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.mdx b/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.mdx new file mode 100644 index 0000000000..4cede8e820 --- /dev/null +++ b/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.mdx @@ -0,0 +1,37 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get authorization link + Forms a link for authorization via the browser + + + +`Function GetAuthorizationLink(Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: String - URL for browser transition + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Result = OPI_Twitter.GetAuthorizationLink(Parameters); +``` + + + + +```json title="Result" +"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https://api.athenaeum.digital/opi/hs/twitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" +``` diff --git a/docs/en/md/Twitter/Data-and-settings/Get-token.md b/docs/en/md/Twitter/Data-and-settings/Get-token.md deleted file mode 100644 index 3cc96beafd..0000000000 --- a/docs/en/md/Twitter/Data-and-settings/Get-token.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get token - Gets the token by the code received when authorizing using the link from GetAuthorizationLink - - - -`Function GetToken(Val Code, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Code | --code | String | Code obtained from authorization See GetAuthorizationLink | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Code = "123456"; - - Result = OPI_Twitter.GetToken(Code, Parameters); -``` - - - - -```json title="Result" -{ - "error": "invalid_request", - "error_description": "Value passed for the authorization code was invalid." -} -``` diff --git a/docs/en/md/Twitter/Data-and-settings/Get-token.mdx b/docs/en/md/Twitter/Data-and-settings/Get-token.mdx new file mode 100644 index 0000000000..0979c6a940 --- /dev/null +++ b/docs/en/md/Twitter/Data-and-settings/Get-token.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get token + Gets the token by the code received when authorizing using the link from GetAuthorizationLink + + + +`Function GetToken(Val Code, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Code | --code | String | Code obtained from authorization See GetAuthorizationLink | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Code = "123456"; + + Result = OPI_Twitter.GetToken(Code, Parameters); +``` + + + + +```json title="Result" +{ + "error": "invalid_request", + "error_description": "Value passed for the authorization code was invalid." +} +``` diff --git a/docs/en/md/Twitter/Data-and-settings/Refresh-token.md b/docs/en/md/Twitter/Data-and-settings/Refresh-token.md deleted file mode 100644 index 0e96c5a4b2..0000000000 --- a/docs/en/md/Twitter/Data-and-settings/Refresh-token.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Refresh token - Updates the v2 token using the refresh_token - - - -`Function RefreshToken(Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Result = OPI_Twitter.RefreshToken(Parameters); -``` - - - - -```json title="Result" -{ - "token_type": "bearer", - "expires_in": 7200, - "access_token": "TW1qcjhrVzUyT2tYaVVfZWtvem9wNVFPVlJEcE1xd3ZaU1ZRSkYxOTkzU1hyOjE3Mjg0NTI5NDY2NDM6MToxOmF0OjE", - "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", - "refresh_token": "bnRnOXpVdXVjdlp2azlkVjYzaEMwY2FxdFloTS03aWhYaHFjcEdodVpqMThjOjE3Mjg0NTI5NDY2NDM6MToxOnJ0OjE" -} -``` diff --git a/docs/en/md/Twitter/Data-and-settings/Refresh-token.mdx b/docs/en/md/Twitter/Data-and-settings/Refresh-token.mdx new file mode 100644 index 0000000000..b5eacb1012 --- /dev/null +++ b/docs/en/md/Twitter/Data-and-settings/Refresh-token.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Refresh token + Updates the v2 token using the refresh_token + + + +`Function RefreshToken(Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Result = OPI_Twitter.RefreshToken(Parameters); +``` + + + + +```json title="Result" +{ + "token_type": "bearer", + "expires_in": 7200, + "access_token": "TW1qcjhrVzUyT2tYaVVfZWtvem9wNVFPVlJEcE1xd3ZaU1ZRSkYxOTkzU1hyOjE3Mjg0NTI5NDY2NDM6MToxOmF0OjE", + "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", + "refresh_token": "bnRnOXpVdXVjdlp2azlkVjYzaEMwY2FxdFloTS03aWhYaHFjcEdodVpqMThjOjE3Mjg0NTI5NDY2NDM6MToxOnJ0OjE" +} +``` diff --git a/docs/en/md/Twitter/Tweets/Create-custom-tweet.md b/docs/en/md/Twitter/Tweets/Create-custom-tweet.md deleted file mode 100644 index dfc7886e95..0000000000 --- a/docs/en/md/Twitter/Tweets/Create-custom-tweet.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create custom tweet - Creates a tweet with custom content - - - -`Function CreateCustomTweet(Val Text = "", Val MediaArray = "", Val PollOptionsArray = "", Val PollDuration = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Tweet text | - | MediaArray | --media | Array of String, BinaryData | Array of binary data or file paths | - | PollOptionsArray | --options | Array of String | Array of poll options, if necessary | - | PollDuration | --dur | String, Number | Poll duration if necessary (poll without duration is not created) | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Text = "TestTweet" + String(New UUID); - - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary Data or Path to file - - ImageArray = New Array(); - ImageArray.Add(Image1); - ImageArray.Add(Image2); - - MediaArray = OPI_Twitter.UploadAttachmentsArray(ImageArray, "tweet_image", Parameters); - Result = OPI_Twitter.CreateCustomTweet(Text, MediaArray, , , Parameters); -``` - - - - -```json title="Result" -{ - "data": { - "text": "TestTweetd32c4a6d-1279-4adc-a8e8-c86303e1264b", - "id": "1843892614518501750", - "edit_history_tweet_ids": [ - "1843892614518501750" - ] - } -} -``` diff --git a/docs/en/md/Twitter/Tweets/Create-custom-tweet.mdx b/docs/en/md/Twitter/Tweets/Create-custom-tweet.mdx new file mode 100644 index 0000000000..52badcd3b2 --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Create-custom-tweet.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create custom tweet + Creates a tweet with custom content + + + +`Function CreateCustomTweet(Val Text = "", Val MediaArray = "", Val PollOptionsArray = "", Val PollDuration = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Tweet text | + | MediaArray | --media | Array of String, BinaryData | Array of binary data or file paths | + | PollOptionsArray | --options | Array of String | Array of poll options, if necessary | + | PollDuration | --dur | String, Number | Poll duration if necessary (poll without duration is not created) | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Text = "TestTweet" + String(New UUID); + + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary Data or Path to file + + ImageArray = New Array(); + ImageArray.Add(Image1); + ImageArray.Add(Image2); + + MediaArray = OPI_Twitter.UploadAttachmentsArray(ImageArray, "tweet_image", Parameters); + Result = OPI_Twitter.CreateCustomTweet(Text, MediaArray, , , Parameters); +``` + + + + +```json title="Result" +{ + "data": { + "text": "TestTweetd32c4a6d-1279-4adc-a8e8-c86303e1264b", + "id": "1843892614518501750", + "edit_history_tweet_ids": [ + "1843892614518501750" + ] + } +} +``` diff --git a/docs/en/md/Twitter/Tweets/Create-gif-tweet.md b/docs/en/md/Twitter/Tweets/Create-gif-tweet.md deleted file mode 100644 index e4d4ba843b..0000000000 --- a/docs/en/md/Twitter/Tweets/Create-gif-tweet.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Create gif tweet - Creates a tweet with a gif attachment - - - -`Function CreateGifTweet(Val Text, Val GifsArray, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Tweet text | - | GifsArray | --gifs | Array of String, BinaryData | Gif files array | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Text = "TestTweet" + String(New UUID); - - GIF = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Binary or Path to file - Gif2 = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Binary or Path to file - - GifsArray = New Array; - GifsArray.Add(GIF); - GifsArray.Add(Gif2); - - Result = OPI_Twitter.CreateGifTweet(Text, GifsArray, Parameters); - - Text = "TestTweet" + String(New UUID); - Result = OPI_Twitter.CreateGifTweet(Text, GIF, Parameters); -``` - - - - -```json title="Result" -{ - "data": { - "text": "TestTweet27989425-2fb9-4d49-ac50-2b73dff7c69e https://t.co/m6q4Bzxea3", - "id": "1843892227023507612", - "edit_history_tweet_ids": [ - "1843892227023507612" - ] - } -} -``` diff --git a/docs/en/md/Twitter/Tweets/Create-gif-tweet.mdx b/docs/en/md/Twitter/Tweets/Create-gif-tweet.mdx new file mode 100644 index 0000000000..7d0fcbfd80 --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Create-gif-tweet.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Create gif tweet + Creates a tweet with a gif attachment + + + +`Function CreateGifTweet(Val Text, Val GifsArray, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Tweet text | + | GifsArray | --gifs | Array of String, BinaryData | Gif files array | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Text = "TestTweet" + String(New UUID); + + GIF = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Binary or Path to file + Gif2 = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Binary or Path to file + + GifsArray = New Array; + GifsArray.Add(GIF); + GifsArray.Add(Gif2); + + Result = OPI_Twitter.CreateGifTweet(Text, GifsArray, Parameters); + + Text = "TestTweet" + String(New UUID); + Result = OPI_Twitter.CreateGifTweet(Text, GIF, Parameters); +``` + + + + +```json title="Result" +{ + "data": { + "text": "TestTweet27989425-2fb9-4d49-ac50-2b73dff7c69e https://t.co/m6q4Bzxea3", + "id": "1843892227023507612", + "edit_history_tweet_ids": [ + "1843892227023507612" + ] + } +} +``` diff --git a/docs/en/md/Twitter/Tweets/Create-image-tweet.md b/docs/en/md/Twitter/Tweets/Create-image-tweet.md deleted file mode 100644 index 68bf1750ba..0000000000 --- a/docs/en/md/Twitter/Tweets/Create-image-tweet.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create image tweet - Creates a tweet with an image attachment - - - -`Function CreateImageTweet(Val Text, Val ImageArray, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Tweet text | - | ImageArray | --pictures | Array of String, BinaryData | Image files array | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Text = "TestTweet" + String(New UUID); - - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary or Path to file - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary or Path to file - - ImageArray = New Array; - ImageArray.Add(Image); - ImageArray.Add(Image2); - - Result = OPI_Twitter.CreateImageTweet(Text, ImageArray, Parameters); - - Text = "TestTweet" + String(New UUID); - Result = OPI_Twitter.CreateImageTweet(Text, Image, Parameters); -``` - - - - -```json title="Result" -{ - "data": { - "id": "1843891880246775903", - "edit_history_tweet_ids": [ - "1843891880246775903" - ], - "text": "TestTweet451aa501-9a10-4e00-bcc5-0c3c8d61221a https://t.co/VWvjWsdQHs" - } -} -``` diff --git a/docs/en/md/Twitter/Tweets/Create-image-tweet.mdx b/docs/en/md/Twitter/Tweets/Create-image-tweet.mdx new file mode 100644 index 0000000000..8862a68ffe --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Create-image-tweet.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create image tweet + Creates a tweet with an image attachment + + + +`Function CreateImageTweet(Val Text, Val ImageArray, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Tweet text | + | ImageArray | --pictures | Array of String, BinaryData | Image files array | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Text = "TestTweet" + String(New UUID); + + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary or Path to file + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary or Path to file + + ImageArray = New Array; + ImageArray.Add(Image); + ImageArray.Add(Image2); + + Result = OPI_Twitter.CreateImageTweet(Text, ImageArray, Parameters); + + Text = "TestTweet" + String(New UUID); + Result = OPI_Twitter.CreateImageTweet(Text, Image, Parameters); +``` + + + + +```json title="Result" +{ + "data": { + "id": "1843891880246775903", + "edit_history_tweet_ids": [ + "1843891880246775903" + ], + "text": "TestTweet451aa501-9a10-4e00-bcc5-0c3c8d61221a https://t.co/VWvjWsdQHs" + } +} +``` diff --git a/docs/en/md/Twitter/Tweets/Create-poll-tweet.md b/docs/en/md/Twitter/Tweets/Create-poll-tweet.md deleted file mode 100644 index 715680206a..0000000000 --- a/docs/en/md/Twitter/Tweets/Create-poll-tweet.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Create poll tweet - Creates a tweet with a poll - - - -`Function CreatePollTweet(Val Text, Val OptionArray, Val Duration, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Tweet text | - | OptionArray | --options | Array of String | Poll options array | - | Duration | --duration | String, Number | Poll duration | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Text = "TestTweet" + String(New UUID); - - AnswersArray = New Array; - AnswersArray.Add("Option 1"); - AnswersArray.Add("Option 2"); - - Result = OPI_Twitter.CreatePollTweet(Text, AnswersArray, 60, Parameters); -``` - - - - -```json title="Result" -{ - "data": { - "text": "TestTweetc6891802-9272-4c6d-bbd7-71cbb02f0702", - "edit_history_tweet_ids": [ - "1843892524672258331" - ], - "id": "1843892524672258331" - } -} -``` diff --git a/docs/en/md/Twitter/Tweets/Create-poll-tweet.mdx b/docs/en/md/Twitter/Tweets/Create-poll-tweet.mdx new file mode 100644 index 0000000000..1271511520 --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Create-poll-tweet.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Create poll tweet + Creates a tweet with a poll + + + +`Function CreatePollTweet(Val Text, Val OptionArray, Val Duration, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Tweet text | + | OptionArray | --options | Array of String | Poll options array | + | Duration | --duration | String, Number | Poll duration | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Text = "TestTweet" + String(New UUID); + + AnswersArray = New Array; + AnswersArray.Add("Option 1"); + AnswersArray.Add("Option 2"); + + Result = OPI_Twitter.CreatePollTweet(Text, AnswersArray, 60, Parameters); +``` + + + + +```json title="Result" +{ + "data": { + "text": "TestTweetc6891802-9272-4c6d-bbd7-71cbb02f0702", + "edit_history_tweet_ids": [ + "1843892524672258331" + ], + "id": "1843892524672258331" + } +} +``` diff --git a/docs/en/md/Twitter/Tweets/Create-text-tweet.md b/docs/en/md/Twitter/Tweets/Create-text-tweet.md deleted file mode 100644 index 578b20d5fd..0000000000 --- a/docs/en/md/Twitter/Tweets/Create-text-tweet.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create text tweet - Creates a tweet without attachments - - - -`Function CreateTextTweet(Val Text, Val Parameters = "") ExportReturn CreateCustomTweet(Text, , , , Parameters);EndFunction` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Tweet text | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Text = "TestTweet" + String(New UUID); - - Result = OPI_Twitter.CreateTextTweet(Text, Parameters); -``` - - - - -```json title="Result" -{ - "data": { - "edit_history_tweet_ids": [ - "1843891450397839870" - ], - "text": "TestTweeteea716eb-0e64-4c2d-b9c9-fb3cca5c6c4e", - "id": "1843891450397839870" - } -} -``` diff --git a/docs/en/md/Twitter/Tweets/Create-text-tweet.mdx b/docs/en/md/Twitter/Tweets/Create-text-tweet.mdx new file mode 100644 index 0000000000..226d600d2f --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Create-text-tweet.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create text tweet + Creates a tweet without attachments + + + +`Function CreateTextTweet(Val Text, Val Parameters = "") ExportReturn CreateCustomTweet(Text, , , , Parameters);EndFunction` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Tweet text | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Text = "TestTweet" + String(New UUID); + + Result = OPI_Twitter.CreateTextTweet(Text, Parameters); +``` + + + + +```json title="Result" +{ + "data": { + "edit_history_tweet_ids": [ + "1843891450397839870" + ], + "text": "TestTweeteea716eb-0e64-4c2d-b9c9-fb3cca5c6c4e", + "id": "1843891450397839870" + } +} +``` diff --git a/docs/en/md/Twitter/Tweets/Create-video-tweet.md b/docs/en/md/Twitter/Tweets/Create-video-tweet.md deleted file mode 100644 index 7c2b403439..0000000000 --- a/docs/en/md/Twitter/Tweets/Create-video-tweet.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Create video tweet - Creates a tweet with a video attachment - - - -`Function CreateVideoTweet(Val Text, Val VideosArray, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Tweet text | - | VideosArray | --videos | Array of String, BinaryData | Video files array | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Map Of KeyAndValue - serialized JSON response from Twitter - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - Text = "TestTweet" + String(New UUID); - - Video = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Binary or Path to file - Video2 = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Binary or Path to file - - VideosArray = New Array; - VideosArray.Add(Video); - VideosArray.Add(Video2); - - Result = OPI_Twitter.CreateVideoTweet(Text, VideosArray, Parameters); - - Text = "TestTweet" + String(New UUID); - Result = OPI_Twitter.CreateVideoTweet(Text, Video, Parameters); -``` - - - - -```json title="Result" -{ - "data": { - "edit_history_tweet_ids": [ - "1843891542655709641" - ], - "id": "1843891542655709641", - "text": "TestTweet9e678e5d-a3b4-4775-a584-75094c588bfa https://t.co/kYlj98ZsLS" - } -} -``` diff --git a/docs/en/md/Twitter/Tweets/Create-video-tweet.mdx b/docs/en/md/Twitter/Tweets/Create-video-tweet.mdx new file mode 100644 index 0000000000..ebf1103fc4 --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Create-video-tweet.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Create video tweet + Creates a tweet with a video attachment + + + +`Function CreateVideoTweet(Val Text, Val VideosArray, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Tweet text | + | VideosArray | --videos | Array of String, BinaryData | Video files array | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Map Of KeyAndValue - serialized JSON response from Twitter + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + Text = "TestTweet" + String(New UUID); + + Video = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Binary or Path to file + Video2 = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Binary or Path to file + + VideosArray = New Array; + VideosArray.Add(Video); + VideosArray.Add(Video2); + + Result = OPI_Twitter.CreateVideoTweet(Text, VideosArray, Parameters); + + Text = "TestTweet" + String(New UUID); + Result = OPI_Twitter.CreateVideoTweet(Text, Video, Parameters); +``` + + + + +```json title="Result" +{ + "data": { + "edit_history_tweet_ids": [ + "1843891542655709641" + ], + "id": "1843891542655709641", + "text": "TestTweet9e678e5d-a3b4-4775-a584-75094c588bfa https://t.co/kYlj98ZsLS" + } +} +``` diff --git a/docs/en/md/Twitter/Tweets/Upload-attachments-array.md b/docs/en/md/Twitter/Tweets/Upload-attachments-array.md deleted file mode 100644 index 64a358f491..0000000000 --- a/docs/en/md/Twitter/Tweets/Upload-attachments-array.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Upload attachments array - Uploads files to the server and returns their IDs - - - -`Function UploadAttachmentsArray(Val ArrayOfFiles, Val AttachmentsType, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ArrayOfFiles | --files | Array of String, BinaryData | Array of files to be uploaded | - | AttachmentsType | --type | String | Attachment type: tweet_video, tweet_image, tweet_gif | - | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | - - - Returns: Array Of String - Media ID array - -
- - - - -```bsl title="Code example" - Parameters = GetTwitterAuthData(); - - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary Data or Path to file - - ImageArray = New Array(); - ImageArray.Add(Image1); - ImageArray.Add(Image2); - - Result = OPI_Twitter.UploadAttachmentsArray(ImageArray, "tweet_image", Parameters); -``` - - - - -```json title="Result" -[ - "1843891479330058240", - "1843891499429142528" -] -``` diff --git a/docs/en/md/Twitter/Tweets/Upload-attachments-array.mdx b/docs/en/md/Twitter/Tweets/Upload-attachments-array.mdx new file mode 100644 index 0000000000..e01b9e2cfc --- /dev/null +++ b/docs/en/md/Twitter/Tweets/Upload-attachments-array.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Upload attachments array + Uploads files to the server and returns their IDs + + + +`Function UploadAttachmentsArray(Val ArrayOfFiles, Val AttachmentsType, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ArrayOfFiles | --files | Array of String, BinaryData | Array of files to be uploaded | + | AttachmentsType | --type | String | Attachment type: tweet_video, tweet_image, tweet_gif | + | Parameters | --auth | Structure Of String | Authorization data. See GetStandardParameters | + + + Returns: Array Of String - Media ID array + +
+ + + + +```bsl title="Code example" + Parameters = GetTwitterAuthData(); + + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary Data or Path to file + + ImageArray = New Array(); + ImageArray.Add(Image1); + ImageArray.Add(Image2); + + Result = OPI_Twitter.UploadAttachmentsArray(ImageArray, "tweet_image", Parameters); +``` + + + + +```json title="Result" +[ + "1843891479330058240", + "1843891499429142528" +] +``` diff --git a/docs/en/md/VK/Ad-account-management/Create-ad.md b/docs/en/md/VK/Ad-account-management/Create-ad.md deleted file mode 100644 index 8639795dbc..0000000000 --- a/docs/en/md/VK/Ad-account-management/Create-ad.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create advertising post - Creates an advertising post based on a post - - - -`Function CreateAd(Val CampaignNumber, Val DailyLimit, Val CategoryNumber, Val PostID, Val AccountID, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | CampaignNumber | --campaign | String, Number | Advertising campaign ID | - | DailyLimit | --limit | String, Number | Daily limit in rubles | - | CategoryNumber | --category | String, Number | Advertising category number | - | PostID | --post | String, Number | ID of the post used for advertising | - | AccountID | --cabinet | String, Number | Advertising account 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(); - - CampaignNumber = "1030715875"; - DailyLimit = 150; - CategoryNumber = 126; - PostID = "4712"; - AccountID = "1607951446"; - - Result = OPI_VK.CreateAd(CampaignNumber - , DailyLimit - , CategoryNumber - , PostID - , AccountID - , Parameters); -``` - - - - -```json title="Result" -{ - "response": [ - { - "id": 0, - "error_code": 603, - "error_desc": "Some ads error occurs: ORD details must be presented." - } - ] -} -``` diff --git a/docs/en/md/VK/Ad-account-management/Create-ad.mdx b/docs/en/md/VK/Ad-account-management/Create-ad.mdx new file mode 100644 index 0000000000..f9b991a45c --- /dev/null +++ b/docs/en/md/VK/Ad-account-management/Create-ad.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create advertising post + Creates an advertising post based on a post + + + +`Function CreateAd(Val CampaignNumber, Val DailyLimit, Val CategoryNumber, Val PostID, Val AccountID, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | CampaignNumber | --campaign | String, Number | Advertising campaign ID | + | DailyLimit | --limit | String, Number | Daily limit in rubles | + | CategoryNumber | --category | String, Number | Advertising category number | + | PostID | --post | String, Number | ID of the post used for advertising | + | AccountID | --cabinet | String, Number | Advertising account 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(); + + CampaignNumber = "1030715875"; + DailyLimit = 150; + CategoryNumber = 126; + PostID = "4712"; + AccountID = "1607951446"; + + Result = OPI_VK.CreateAd(CampaignNumber + , DailyLimit + , CategoryNumber + , PostID + , AccountID + , Parameters); +``` + + + + +```json title="Result" +{ + "response": [ + { + "id": 0, + "error_code": 603, + "error_desc": "Some ads error occurs: ORD details must be presented." + } + ] +} +``` diff --git a/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md b/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md deleted file mode 100644 index b20ec9501d..0000000000 --- a/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create advertising campaign - Creates a campaign in the selected advertising account - - - -`Function CreateAdvertisingCampaign(Val AccountID, Val Name, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | AccountID | --cabinet | String, Number | Advertising account ID | - | Name | --title | String | Campaign name | - | 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(); - - AccountID = "1607951446"; - Name = "New campaign"; - - Result = OPI_VK.CreateAdvertisingCampaign(AccountID, Name, Parameters); -``` - - - - -```json title="Result" -{ - "response": [ - { - "id": 1030702431, - "error_code": 602, - "error_desc": "Some part of the request has not been completed" - } - ] -} -``` diff --git a/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.mdx b/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.mdx new file mode 100644 index 0000000000..5b9d53c9df --- /dev/null +++ b/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create advertising campaign + Creates a campaign in the selected advertising account + + + +`Function CreateAdvertisingCampaign(Val AccountID, Val Name, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | AccountID | --cabinet | String, Number | Advertising account ID | + | Name | --title | String | Campaign name | + | 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(); + + AccountID = "1607951446"; + Name = "New campaign"; + + Result = OPI_VK.CreateAdvertisingCampaign(AccountID, Name, Parameters); +``` + + + + +```json title="Result" +{ + "response": [ + { + "id": 1030702431, + "error_code": 602, + "error_desc": "Some part of the request has not been completed" + } + ] +} +``` diff --git a/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md b/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md deleted file mode 100644 index bff821ddcc..0000000000 --- a/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get a list of advertising categories - Gets a list of advertising category IDs for creating an advertising post - - - -`Function GetAdvertisingCategoryList(Val Parameters = "") Export` - - | Parameter | CLI option | Type | 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(); - - Result = OPI_VK.GetAdvertisingCategoryList(Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "v1": [ - { - "id": 1, - "name": "Авто/мото", - "subcategories": [ - { - "id": 2, - "name": "Автомобильные дилеры" - }, - { - "id": 3, - "name": "Автопроизводители" - }, - { - "id": 4, - "name": "Автострахование" - }, - { - "id": 5, - "name": "Запчасти и аксессуары" - }, - { - "id": 7, - "name": "Курсы вождения" - }, - { - "id": 6, - "name": "Мотоциклы" - }, - { - "id": 8, - "name": "Техническое обслуживание" - }, - { - "id": 9, - "name": "Транспортные услуги" - } - ] - }, - { - "id": 112, - "name": "Бизнес", - "subcategories": [ - { - "id": 113, - "name": "Всё для офиса" - }, - { - "id": 114, - "name": "Деловые услуги" - }, - { - "id": 115, - "name": "Программное обеспечение и БД" - } - ] - }, - { - "id": 116, - "name": "Дом и быт", - "subcategories": [ - { - "id": 117, - "name": "Бытовая химия" - }, - { - "id": 122, - "name": "Дизайн интерьера" - }, - { - "id": 120, - "name": "Домашние животные" - }, - { - "id": 119, - "name": "Обустройства дома, мебель" - }, - { - "id": 123, - "name": "Ремонт, стройматериалы" - }, - { - "id": 121, - "name": "Садоводство" - }, - { - "id": 124, - "name": "Товары для детей" - }, - { - "id": 118, - "name": "Услуги клининговых компаний" - } - ] - }, - { - "id": 75, - "name": "Красота и здоровье", - "subcategories": [ - { - "id": 80, - "name": "БАДы" - }, - { - "id": 86, - "name": "Косметика и парфюмерия" - }, - { - "id": 82, - "name": "Косметология" - }, - { - "id": 77, - "name": "Лекарства и медицинские товары" - }, - { - "id": 76, - "name": "Медицинские учреждения" - }, - { - "id": 79, - "name": "Медицинское страхование" - }, - { - "id": 78, - "name": "Методы лечения" - }, - { - "id": 81, - "name": "Нетрадиционная медицина" - }, - { - "id": 83, - "name": "Пластическая хирургия" - }, - { - "id": 85, - "name": "Салоны красоты" - }, - { - "id": 84, - "name": "Стоматология" - }, - { - "id": 87, - "name": "Другие товары для красоты и здоровья" - } - ] -... -``` diff --git a/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.mdx b/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.mdx new file mode 100644 index 0000000000..31238ab466 --- /dev/null +++ b/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.mdx @@ -0,0 +1,188 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get a list of advertising categories + Gets a list of advertising category IDs for creating an advertising post + + + +`Function GetAdvertisingCategoryList(Val Parameters = "") Export` + + | Parameter | CLI option | Type | 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(); + + Result = OPI_VK.GetAdvertisingCategoryList(Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "v1": [ + { + "id": 1, + "name": "Авто/мото", + "subcategories": [ + { + "id": 2, + "name": "Автомобильные дилеры" + }, + { + "id": 3, + "name": "Автопроизводители" + }, + { + "id": 4, + "name": "Автострахование" + }, + { + "id": 5, + "name": "Запчасти и аксессуары" + }, + { + "id": 7, + "name": "Курсы вождения" + }, + { + "id": 6, + "name": "Мотоциклы" + }, + { + "id": 8, + "name": "Техническое обслуживание" + }, + { + "id": 9, + "name": "Транспортные услуги" + } + ] + }, + { + "id": 112, + "name": "Бизнес", + "subcategories": [ + { + "id": 113, + "name": "Всё для офиса" + }, + { + "id": 114, + "name": "Деловые услуги" + }, + { + "id": 115, + "name": "Программное обеспечение и БД" + } + ] + }, + { + "id": 116, + "name": "Дом и быт", + "subcategories": [ + { + "id": 117, + "name": "Бытовая химия" + }, + { + "id": 122, + "name": "Дизайн интерьера" + }, + { + "id": 120, + "name": "Домашние животные" + }, + { + "id": 119, + "name": "Обустройства дома, мебель" + }, + { + "id": 123, + "name": "Ремонт, стройматериалы" + }, + { + "id": 121, + "name": "Садоводство" + }, + { + "id": 124, + "name": "Товары для детей" + }, + { + "id": 118, + "name": "Услуги клининговых компаний" + } + ] + }, + { + "id": 75, + "name": "Красота и здоровье", + "subcategories": [ + { + "id": 80, + "name": "БАДы" + }, + { + "id": 86, + "name": "Косметика и парфюмерия" + }, + { + "id": 82, + "name": "Косметология" + }, + { + "id": 77, + "name": "Лекарства и медицинские товары" + }, + { + "id": 76, + "name": "Медицинские учреждения" + }, + { + "id": 79, + "name": "Медицинское страхование" + }, + { + "id": 78, + "name": "Методы лечения" + }, + { + "id": 81, + "name": "Нетрадиционная медицина" + }, + { + "id": 83, + "name": "Пластическая хирургия" + }, + { + "id": 85, + "name": "Салоны красоты" + }, + { + "id": 84, + "name": "Стоматология" + }, + { + "id": 87, + "name": "Другие товары для красоты и здоровья" + } + ] +... +``` diff --git a/docs/en/md/VK/Ad-account-management/Pause-advertising.md b/docs/en/md/VK/Ad-account-management/Pause-advertising.md deleted file mode 100644 index 1881a0741a..0000000000 --- a/docs/en/md/VK/Ad-account-management/Pause-advertising.md +++ /dev/null @@ -1,83 +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 | Description | - |-|-|-|-| - | 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" - Parameters = GetVKParameters(); - - AccountID = "1607951446"; - AdID = "0"; - - Result = OPI_VK.PauseAdvertising(AccountID, AdID, Parameters); -``` - - - - -```json title="Result" -{ - "error": { - "error_code": 100, - "error_msg": "One of the parameters specified was missing or invalid: data[0][ad_id] is invalid", - "request_params": [ - { - "key": "from_group", - "value": "1" - }, - { - "key": "owner_id", - "value": "-218861756" - }, - { - "key": "v", - "value": "5.131" - }, - { - "key": "app_id", - "value": "51694790" - }, - { - "key": "group_id", - "value": "218861756" - }, - { - "key": "account_id", - "value": "1607951446" - }, - { - "key": "data", - "value": "[\r\n {\r\n \"ad_id\": \"0\",\r\n \"status\": 0\r\n }\r\n]" - }, - { - "key": "method", - "value": "ads.updateAds" - }, - { - "key": "oauth", - "value": "1" - } - ] - } -} -``` diff --git a/docs/en/md/VK/Ad-account-management/Pause-advertising.mdx b/docs/en/md/VK/Ad-account-management/Pause-advertising.mdx new file mode 100644 index 0000000000..38ab2682eb --- /dev/null +++ b/docs/en/md/VK/Ad-account-management/Pause-advertising.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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" + Parameters = GetVKParameters(); + + AccountID = "1607951446"; + AdID = "0"; + + Result = OPI_VK.PauseAdvertising(AccountID, AdID, Parameters); +``` + + + + +```json title="Result" +{ + "error": { + "error_code": 100, + "error_msg": "One of the parameters specified was missing or invalid: data[0][ad_id] is invalid", + "request_params": [ + { + "key": "from_group", + "value": "1" + }, + { + "key": "owner_id", + "value": "-218861756" + }, + { + "key": "v", + "value": "5.131" + }, + { + "key": "app_id", + "value": "51694790" + }, + { + "key": "group_id", + "value": "218861756" + }, + { + "key": "account_id", + "value": "1607951446" + }, + { + "key": "data", + "value": "[\r\n {\r\n \"ad_id\": \"0\",\r\n \"status\": 0\r\n }\r\n]" + }, + { + "key": "method", + "value": "ads.updateAds" + }, + { + "key": "oauth", + "value": "1" + } + ] + } +} +``` diff --git a/docs/en/md/VK/Community-managment/Create-album.md b/docs/en/md/VK/Community-managment/Create-album.md deleted file mode 100644 index 6de4138107..0000000000 --- a/docs/en/md/VK/Community-managment/Create-album.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Create album - Creates an album to store images - - - -`Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | 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); -``` - - - - -```json title="Result" -{ - "response": { - "id": 306043366, - "owner_id": -218861756, - "size": 0, - "title": "AlbumFromAutoTest", - "feed_disabled": 0, - "feed_has_pinned": 0, - "can_upload": 1, - "comments_disabled": 0, - "created": 1728453690, - "description": "NewAlbumFromAutoTest", - "thumb_id": 0, - "updated": 1728453690, - "upload_by_admins_only": 1 - } -} -``` diff --git a/docs/en/md/VK/Community-managment/Create-album.mdx b/docs/en/md/VK/Community-managment/Create-album.mdx new file mode 100644 index 0000000000..1eb629975f --- /dev/null +++ b/docs/en/md/VK/Community-managment/Create-album.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Create album + Creates an album to store images + + + +`Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | 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); +``` + + + + +```json title="Result" +{ + "response": { + "id": 306043366, + "owner_id": -218861756, + "size": 0, + "title": "AlbumFromAutoTest", + "feed_disabled": 0, + "feed_has_pinned": 0, + "can_upload": 1, + "comments_disabled": 0, + "created": 1728453690, + "description": "NewAlbumFromAutoTest", + "thumb_id": 0, + "updated": 1728453690, + "upload_by_admins_only": 1 + } +} +``` diff --git a/docs/en/md/VK/Community-managment/Create-composite-post.md b/docs/en/md/VK/Community-managment/Create-composite-post.md deleted file mode 100644 index 010bdb2267..0000000000 --- a/docs/en/md/VK/Community-managment/Create-composite-post.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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 | Description | - |-|-|-|-| - | 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://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data - Video = "https://api.athenaeum.digital/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); -``` - - - - -```json title="Result" -{ - "response": { - "post_id": 4555 - } -} -``` diff --git a/docs/en/md/VK/Community-managment/Create-composite-post.mdx b/docs/en/md/VK/Community-managment/Create-composite-post.mdx new file mode 100644 index 0000000000..ab4e4cfc0a --- /dev/null +++ b/docs/en/md/VK/Community-managment/Create-composite-post.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data + Video = "https://api.athenaeum.digital/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); +``` + + + + +```json title="Result" +{ + "response": { + "post_id": 4555 + } +} +``` diff --git a/docs/en/md/VK/Community-managment/Create-poll.md b/docs/en/md/VK/Community-managment/Create-poll.md deleted file mode 100644 index 069074f6a1..0000000000 --- a/docs/en/md/VK/Community-managment/Create-poll.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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 | Description | - |-|-|-|-| - | 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); -``` - - - - -```json title="Result" -{ - "response": { - "post_id": 4556 - } -} -``` diff --git a/docs/en/md/VK/Community-managment/Create-poll.mdx b/docs/en/md/VK/Community-managment/Create-poll.mdx new file mode 100644 index 0000000000..75ba5d4b64 --- /dev/null +++ b/docs/en/md/VK/Community-managment/Create-poll.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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); +``` + + + + +```json title="Result" +{ + "response": { + "post_id": 4556 + } +} +``` diff --git a/docs/en/md/VK/Community-managment/Create-post.md b/docs/en/md/VK/Community-managment/Create-post.md deleted file mode 100644 index 1a0d8ea680..0000000000 --- a/docs/en/md/VK/Community-managment/Create-post.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 | Description | - |-|-|-|-| - | 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://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data - Image2 = "https://api.athenaeum.digital/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); -``` - - - - -```json title="Result" -{ - "response": { - "post_id": 4552 - } -} -``` diff --git a/docs/en/md/VK/Community-managment/Create-post.mdx b/docs/en/md/VK/Community-managment/Create-post.mdx new file mode 100644 index 0000000000..df02f3cc28 --- /dev/null +++ b/docs/en/md/VK/Community-managment/Create-post.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data + Image2 = "https://api.athenaeum.digital/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); +``` + + + + +```json title="Result" +{ + "response": { + "post_id": 4552 + } +} +``` diff --git a/docs/en/md/VK/Community-managment/Create-story.md b/docs/en/md/VK/Community-managment/Create-story.md deleted file mode 100644 index 824aea0255..0000000000 --- a/docs/en/md/VK/Community-managment/Create-story.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Create story - Creates a story from an image - - - -`Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | 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://api.athenaeum.digital/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); -``` - - - - -```json title="Result" -{ - "response": { - "count": 1, - "items": [ - { - "id": 456240002, - "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": 1728453724, - "expires_at": 1728540124, - "link": { - "text": "Ещё", - "url": "https://github.com/Bayselonarrend/OpenIntegrations" - }, - "photo": { - "album_id": -81, - "date": 1728453724, - "id": 457249076, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun56-1.userapi.com/s/v1/ig2/ThGIg1sYfgXAZUYVzUjJqluCzKhtUuvDLcJtPsHGrioIwe8KrLy5AyHySWYkCP15VtugfWaIFYv4zKyHHkFzOvJP.jpg?size=75x56&quality=95&type=story" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun56-1.userapi.com/s/v1/ig2/ORIQl3y2_g7mMeup9alevCqrO3fE7bSbLJ2JkXpQdshBBCfI8AOhOQPiXVxXWFEfjjhHeahup5i4GP_F431DdWVA.jpg?size=130x97&quality=95&type=story" - }, - { - "height": 192, - "type": "j", - "width": 256, - "url": "https://sun56-1.userapi.com/s/v1/ig2/xoto12wh7mi1WEO1y9hDlvijf9J0FS4X9Og8hRscocnwcg_VldRIzwUKwf-mddh_OtPzZIJDxy9KBTW8uTdGlsgU.jpg?size=256x192&quality=95&type=story" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun56-1.userapi.com/s/v1/ig2/0C2jpD_cTXilTHPedjRJxqRmo9CoCrcFK58dWrmctdyAVoOmdS5q-X7RX0lw482Zwc-pl426jUvsjf_li5WPDIq4.jpg?size=604x453&quality=95&type=story" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun56-1.userapi.com/s/v1/ig2/Sb_g2E27IHayxpRXUUYt8o87y4aXcO_YsG1Bv5zKjTfgaa3gXGYUteMhFqAlnad1-yklST95wEidi_wLVvb-6w2N.jpg?size=807x605&quality=95&type=story" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun56-1.userapi.com/s/v1/ig2/jK_pcU1ucaExAG4jpzdjIUpuyp4YoHpoexaam4jk911tLWd_BWEW5Yb-VFKWYvB7x9ONtOj4KbR8lqeCM_I5Ccrw.jpg?size=1280x960&quality=95&type=story" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun56-1.userapi.com/s/v1/ig2/y6YSc3M4nLKIyt48O5DW3XvuxIg8UC-par28D54_vJLn0dyS-0VAUMYRCY1g9T926sG4XHLXw6loMFbHNvzFF35G.jpg?size=2560x1920&quality=95&type=story" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "cec38f3d661278427c", - "has_tags": false - }, - "replies": { - "count": 0, - "new": 0 - }, - "track_code": "story/3AAQAdLy9G9EAs4bMauCA84nNfHkBAAFoAagB6AIAA==", - "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 - } - ] - } -} -``` diff --git a/docs/en/md/VK/Community-managment/Create-story.mdx b/docs/en/md/VK/Community-managment/Create-story.mdx new file mode 100644 index 0000000000..b12a4f8521 --- /dev/null +++ b/docs/en/md/VK/Community-managment/Create-story.mdx @@ -0,0 +1,139 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Create story + Creates a story from an image + + + +`Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | 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://api.athenaeum.digital/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); +``` + + + + +```json title="Result" +{ + "response": { + "count": 1, + "items": [ + { + "id": 456240002, + "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": 1728453724, + "expires_at": 1728540124, + "link": { + "text": "Ещё", + "url": "https://github.com/Bayselonarrend/OpenIntegrations" + }, + "photo": { + "album_id": -81, + "date": 1728453724, + "id": 457249076, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun56-1.userapi.com/s/v1/ig2/ThGIg1sYfgXAZUYVzUjJqluCzKhtUuvDLcJtPsHGrioIwe8KrLy5AyHySWYkCP15VtugfWaIFYv4zKyHHkFzOvJP.jpg?size=75x56&quality=95&type=story" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun56-1.userapi.com/s/v1/ig2/ORIQl3y2_g7mMeup9alevCqrO3fE7bSbLJ2JkXpQdshBBCfI8AOhOQPiXVxXWFEfjjhHeahup5i4GP_F431DdWVA.jpg?size=130x97&quality=95&type=story" + }, + { + "height": 192, + "type": "j", + "width": 256, + "url": "https://sun56-1.userapi.com/s/v1/ig2/xoto12wh7mi1WEO1y9hDlvijf9J0FS4X9Og8hRscocnwcg_VldRIzwUKwf-mddh_OtPzZIJDxy9KBTW8uTdGlsgU.jpg?size=256x192&quality=95&type=story" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun56-1.userapi.com/s/v1/ig2/0C2jpD_cTXilTHPedjRJxqRmo9CoCrcFK58dWrmctdyAVoOmdS5q-X7RX0lw482Zwc-pl426jUvsjf_li5WPDIq4.jpg?size=604x453&quality=95&type=story" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun56-1.userapi.com/s/v1/ig2/Sb_g2E27IHayxpRXUUYt8o87y4aXcO_YsG1Bv5zKjTfgaa3gXGYUteMhFqAlnad1-yklST95wEidi_wLVvb-6w2N.jpg?size=807x605&quality=95&type=story" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun56-1.userapi.com/s/v1/ig2/jK_pcU1ucaExAG4jpzdjIUpuyp4YoHpoexaam4jk911tLWd_BWEW5Yb-VFKWYvB7x9ONtOj4KbR8lqeCM_I5Ccrw.jpg?size=1280x960&quality=95&type=story" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun56-1.userapi.com/s/v1/ig2/y6YSc3M4nLKIyt48O5DW3XvuxIg8UC-par28D54_vJLn0dyS-0VAUMYRCY1g9T926sG4XHLXw6loMFbHNvzFF35G.jpg?size=2560x1920&quality=95&type=story" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "cec38f3d661278427c", + "has_tags": false + }, + "replies": { + "count": 0, + "new": 0 + }, + "track_code": "story/3AAQAdLy9G9EAs4bMauCA84nNfHkBAAFoAagB6AIAA==", + "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 + } + ] + } +} +``` diff --git a/docs/en/md/VK/Community-managment/Delete-album.md b/docs/en/md/VK/Community-managment/Delete-album.md deleted file mode 100644 index dc61bdd235..0000000000 --- a/docs/en/md/VK/Community-managment/Delete-album.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Delete album - Deletes a previously created album - - - -`Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | 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 = "306093980"; - - Result = OPI_VK.DeleteAlbum(AlbumID, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Community-managment/Delete-album.mdx b/docs/en/md/VK/Community-managment/Delete-album.mdx new file mode 100644 index 0000000000..b66176d075 --- /dev/null +++ b/docs/en/md/VK/Community-managment/Delete-album.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Delete album + Deletes a previously created album + + + +`Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | 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 = "306093980"; + + Result = OPI_VK.DeleteAlbum(AlbumID, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Community-managment/Delete-image.md b/docs/en/md/VK/Community-managment/Delete-image.md deleted file mode 100644 index af8366b881..0000000000 --- a/docs/en/md/VK/Community-managment/Delete-image.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Delete image - Deletes an image from the album - - - -`Function DeleteImage(Val ImageID, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | 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 = "457249318"; - - Result = OPI_VK.DeleteImage(ImageID, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Community-managment/Delete-image.mdx b/docs/en/md/VK/Community-managment/Delete-image.mdx new file mode 100644 index 0000000000..24e910d864 --- /dev/null +++ b/docs/en/md/VK/Community-managment/Delete-image.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Delete image + Deletes an image from the album + + + +`Function DeleteImage(Val ImageID, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | 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 = "457249318"; + + Result = OPI_VK.DeleteImage(ImageID, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Community-managment/Delete-post.md b/docs/en/md/VK/Community-managment/Delete-post.md deleted file mode 100644 index 697d60c841..0000000000 --- a/docs/en/md/VK/Community-managment/Delete-post.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Delete post - Deletes a post by ID - - - -`Function DeletePost(Val PostID, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | 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 = "4712"; - - Result = OPI_VK.DeletePost(PostID, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Community-managment/Delete-post.mdx b/docs/en/md/VK/Community-managment/Delete-post.mdx new file mode 100644 index 0000000000..911cc32023 --- /dev/null +++ b/docs/en/md/VK/Community-managment/Delete-post.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Delete post + Deletes a post by ID + + + +`Function DeletePost(Val PostID, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | 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 = "4712"; + + Result = OPI_VK.DeletePost(PostID, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Community-managment/Save-image-to-album.md b/docs/en/md/VK/Community-managment/Save-image-to-album.md deleted file mode 100644 index b4e064e87e..0000000000 --- a/docs/en/md/VK/Community-managment/Save-image-to-album.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -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 | Description | - |-|-|-|-| - | 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 = "305187504"; - - Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data - TFN = GetTempFileName("png"); - FileCopy(Image, TFN); - - Image = New BinaryData(TFN); - - Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters); - - Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters); -``` - - - - -```json title="Result" -{ - "response": [ - { - "album_id": 306043366, - "date": 1728453694, - "id": 457249074, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "AutoTestImage", - "user_id": 100, - "web_view_token": "13475c6ff6a2421d42", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - } - ] -} -``` diff --git a/docs/en/md/VK/Community-managment/Save-image-to-album.mdx b/docs/en/md/VK/Community-managment/Save-image-to-album.mdx new file mode 100644 index 0000000000..55a4cdc11d --- /dev/null +++ b/docs/en/md/VK/Community-managment/Save-image-to-album.mdx @@ -0,0 +1,132 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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 = "305187504"; + + Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data + TFN = GetTempFileName("png"); + FileCopy(Image, TFN); + + Image = New BinaryData(TFN); + + Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters); + + Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters); +``` + + + + +```json title="Result" +{ + "response": [ + { + "album_id": 306043366, + "date": 1728453694, + "id": 457249074, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "AutoTestImage", + "user_id": 100, + "web_view_token": "13475c6ff6a2421d42", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + } + ] +} +``` diff --git a/docs/en/md/VK/Community-managment/Upload-photo-to-server.md b/docs/en/md/VK/Community-managment/Upload-photo-to-server.md deleted file mode 100644 index db3427835c..0000000000 --- a/docs/en/md/VK/Community-managment/Upload-photo-to-server.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -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 | Description | - |-|-|-|-| - | 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" - Parameters = GetVKParameters(); - - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file - View = "Post"; - - Result = OPI_VK.UploadPhotoToServer(Image, Parameters, View); -``` - - - - -```json title="Result" -{ - "response":[ - { - "album_id":289219319, - "date":1673516629, - "id":457239023, - "owner_id":743784474, - "sizes":[{"height":50,"type":"s","width":75,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Vus7E6r8jZjgv5E9bnuM6fbvL9U_NP4-goegNOaEy8t4Z1DnzofjER9exwblecB6Hxb3EUbWv7lQvxdRaErZGoT3.jpg?size=75x50&quality=96&type=album"},{"height":87,"type":"m","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":402,"type":"x","width":604,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/2DBzUBeOMpydPcypQFkirgj6g9mzsj8le0qsrWQ_lPX3zNQN1229bLivxf26ya-91HF9D57exLSnkSnJwUxJdUBN.jpg?size=604x402&quality=96&type=album"},{"height":537,"type":"y","width":807,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Biye5eNVG4UA_ymuN60MU6Qp26yO7rYp0WB-ch55oxkaATpXs4Kmqqznz1keCYHg_BHyvPhyrSGyK3zRK29LoVKH.jpg?size=807x537&quality=96&type=album"},{"height":852,"type":"z","width":1280,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/O-BkqGyWMw2ZKcOyYz8sH543Ihkws7mAn6x76JYh0mVW2MCR9x9eig_AS6gT6OLeySlvewx5oyri1Ejj0uNhJuKo.jpg?size=1280x852&quality=96&type=album"},{"height":1704,"type":"w","width":2560,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/o5klH0kpqicWBkDGQl_ch2j8VRpW69xrnq_PXw823wrMYc2qnXQLuDZeECtcKSaka1gfCpP9smoz7XwGAMDTk7vo.jpg?size=2560x1704&quality=96&type=album"},{"height":87,"type":"o","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":133,"type":"p","width":200,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/dFvcZ_sYZeMJtmvotINsevf_0x4KbDxo-jcrZojRQtebIKvM0juMU9U9NjybaidOukkrImr2CWcW8u6IHdlceWKD.jpg?size=200x133&quality=96&type=album"},{"height":213,"type":"q","width":320,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/GglL_Kv0x1_rnPwXwtTPZUMFg9sT_JB9xUSUeNvNIRapPRhGvQbQAaCwD57WBhUKU8sPD6-BhyadPIXaALqERkS1.jpg?size=320x213&quality=96&type=album"},{"height":340,"type":"r","width":510,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/LnQwirb-SUb689R2k90Q8MwuwHJ0tfO03a0IkCeXObaQERRE2-UUyLBCTTLme2qkLcxXAekHVbkLMEZhRq5E6Ggr.jpg?size=510x340&quality=96&crop=2,0,2556,1704&type=album"}], - "text":"", - "has_tags":false - } - ] - } -``` diff --git a/docs/en/md/VK/Community-managment/Upload-photo-to-server.mdx b/docs/en/md/VK/Community-managment/Upload-photo-to-server.mdx new file mode 100644 index 0000000000..c1090d637d --- /dev/null +++ b/docs/en/md/VK/Community-managment/Upload-photo-to-server.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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" + Parameters = GetVKParameters(); + + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary Data or Path to file + View = "Post"; + + Result = OPI_VK.UploadPhotoToServer(Image, Parameters, View); +``` + + + + +```json title="Result" +{ + "response":[ + { + "album_id":289219319, + "date":1673516629, + "id":457239023, + "owner_id":743784474, + "sizes":[{"height":50,"type":"s","width":75,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Vus7E6r8jZjgv5E9bnuM6fbvL9U_NP4-goegNOaEy8t4Z1DnzofjER9exwblecB6Hxb3EUbWv7lQvxdRaErZGoT3.jpg?size=75x50&quality=96&type=album"},{"height":87,"type":"m","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":402,"type":"x","width":604,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/2DBzUBeOMpydPcypQFkirgj6g9mzsj8le0qsrWQ_lPX3zNQN1229bLivxf26ya-91HF9D57exLSnkSnJwUxJdUBN.jpg?size=604x402&quality=96&type=album"},{"height":537,"type":"y","width":807,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Biye5eNVG4UA_ymuN60MU6Qp26yO7rYp0WB-ch55oxkaATpXs4Kmqqznz1keCYHg_BHyvPhyrSGyK3zRK29LoVKH.jpg?size=807x537&quality=96&type=album"},{"height":852,"type":"z","width":1280,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/O-BkqGyWMw2ZKcOyYz8sH543Ihkws7mAn6x76JYh0mVW2MCR9x9eig_AS6gT6OLeySlvewx5oyri1Ejj0uNhJuKo.jpg?size=1280x852&quality=96&type=album"},{"height":1704,"type":"w","width":2560,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/o5klH0kpqicWBkDGQl_ch2j8VRpW69xrnq_PXw823wrMYc2qnXQLuDZeECtcKSaka1gfCpP9smoz7XwGAMDTk7vo.jpg?size=2560x1704&quality=96&type=album"},{"height":87,"type":"o","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":133,"type":"p","width":200,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/dFvcZ_sYZeMJtmvotINsevf_0x4KbDxo-jcrZojRQtebIKvM0juMU9U9NjybaidOukkrImr2CWcW8u6IHdlceWKD.jpg?size=200x133&quality=96&type=album"},{"height":213,"type":"q","width":320,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/GglL_Kv0x1_rnPwXwtTPZUMFg9sT_JB9xUSUeNvNIRapPRhGvQbQAaCwD57WBhUKU8sPD6-BhyadPIXaALqERkS1.jpg?size=320x213&quality=96&type=album"},{"height":340,"type":"r","width":510,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/LnQwirb-SUb689R2k90Q8MwuwHJ0tfO03a0IkCeXObaQERRE2-UUyLBCTTLme2qkLcxXAekHVbkLMEZhRq5E6Ggr.jpg?size=510x340&quality=96&crop=2,0,2556,1704&type=album"}], + "text":"", + "has_tags":false + } + ] + } +``` diff --git a/docs/en/md/VK/Community-managment/Upload-video-to-server.md b/docs/en/md/VK/Community-managment/Upload-video-to-server.md deleted file mode 100644 index e3bbc16762..0000000000 --- a/docs/en/md/VK/Community-managment/Upload-video-to-server.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 | Description | - |-|-|-|-| - | 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" - Parameters = GetVKParameters(); - - Video = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Binary Data or Path to file - Name = "NewVideo"; - Description = "Video description"; - - Result = OPI_VK.UploadVideoToServer(Video, Name, Description, , Parameters); -``` - - - - -```json title="Result" -{ - "video_hash": "948ffc06db1b09fb7f", - "size": 1137878, - "direct_link": "https://vkvd382.okcdn.ru/?expires=1728713194552&srcIp=93.125.42.204&pr=40&srcAg=UNKNOWN&ms=45.136.20.139&type=4&sig=VAfnTuuSNjs&ct=27&urls=45.136.22.139&clientType=14&appId=512000384397&zs=72&id=7195954121353", - "owner_id": -218861756, - "video_id": 456239605 -} -``` diff --git a/docs/en/md/VK/Community-managment/Upload-video-to-server.mdx b/docs/en/md/VK/Community-managment/Upload-video-to-server.mdx new file mode 100644 index 0000000000..b272ab1efa --- /dev/null +++ b/docs/en/md/VK/Community-managment/Upload-video-to-server.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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" + Parameters = GetVKParameters(); + + Video = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Binary Data or Path to file + Name = "NewVideo"; + Description = "Video description"; + + Result = OPI_VK.UploadVideoToServer(Video, Name, Description, , Parameters); +``` + + + + +```json title="Result" +{ + "video_hash": "948ffc06db1b09fb7f", + "size": 1137878, + "direct_link": "https://vkvd382.okcdn.ru/?expires=1728713194552&srcIp=93.125.42.204&pr=40&srcAg=UNKNOWN&ms=45.136.20.139&type=4&sig=VAfnTuuSNjs&ct=27&urls=45.136.22.139&clientType=14&appId=512000384397&zs=72&id=7195954121353", + "owner_id": -218861756, + "video_id": 456239605 +} +``` diff --git a/docs/en/md/VK/Discussion-management/Close-discussion.md b/docs/en/md/VK/Discussion-management/Close-discussion.md deleted file mode 100644 index bf0f5c6001..0000000000 --- a/docs/en/md/VK/Discussion-management/Close-discussion.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Close discussion - Close or delete discussion - - - -`Function CloseDiscussion(Val DiscussionID, Val DeleteCompletely = False, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | DiscussionID | --topic | String, Number | Discussion ID | - | DeleteCompletely | --remove | Boolean | Delete completely (True) or close | - | 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(); - DiscussionID = "52595199"; - Result = OPI_VK.CloseDiscussion(DiscussionID, False, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Discussion-management/Close-discussion.mdx b/docs/en/md/VK/Discussion-management/Close-discussion.mdx new file mode 100644 index 0000000000..cd46401831 --- /dev/null +++ b/docs/en/md/VK/Discussion-management/Close-discussion.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Close discussion + Close or delete discussion + + + +`Function CloseDiscussion(Val DiscussionID, Val DeleteCompletely = False, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | DiscussionID | --topic | String, Number | Discussion ID | + | DeleteCompletely | --remove | Boolean | Delete completely (True) or close | + | 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(); + DiscussionID = "52595199"; + Result = OPI_VK.CloseDiscussion(DiscussionID, False, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Discussion-management/Create-discussion.md b/docs/en/md/VK/Discussion-management/Create-discussion.md deleted file mode 100644 index d390ef27a6..0000000000 --- a/docs/en/md/VK/Discussion-management/Create-discussion.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create discussion - Creates a new discussion - - - -`Function CreateDiscussion(Val Name, Val FirstMessageText, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Discussion name | - | FirstMessageText | --text | String | Text of the first message | - | 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 = "Discussing: Which color is better?"; - Message = "Red, yellow, blue, or some other?"; - - Result = OPI_VK.CreateDiscussion(Name, Message, Parameters); -``` - - - - -```json title="Result" -{ - "response": 52573385 -} -``` diff --git a/docs/en/md/VK/Discussion-management/Create-discussion.mdx b/docs/en/md/VK/Discussion-management/Create-discussion.mdx new file mode 100644 index 0000000000..05210d54bd --- /dev/null +++ b/docs/en/md/VK/Discussion-management/Create-discussion.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create discussion + Creates a new discussion + + + +`Function CreateDiscussion(Val Name, Val FirstMessageText, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Discussion name | + | FirstMessageText | --text | String | Text of the first message | + | 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 = "Discussing: Which color is better?"; + Message = "Red, yellow, blue, or some other?"; + + Result = OPI_VK.CreateDiscussion(Name, Message, Parameters); +``` + + + + +```json title="Result" +{ + "response": 52573385 +} +``` diff --git a/docs/en/md/VK/Discussion-management/Open-discussion.md b/docs/en/md/VK/Discussion-management/Open-discussion.md deleted file mode 100644 index 30b5303722..0000000000 --- a/docs/en/md/VK/Discussion-management/Open-discussion.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Open discussion - Opens a previously closed discussion - - - -`Function OpenDiscussion(Val DiscussionID, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | DiscussionID | --topic | String, Number | Discussion 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(); - DiscussionID = "52595199"; - Result = OPI_VK.OpenDiscussion(DiscussionID, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Discussion-management/Open-discussion.mdx b/docs/en/md/VK/Discussion-management/Open-discussion.mdx new file mode 100644 index 0000000000..60cad52837 --- /dev/null +++ b/docs/en/md/VK/Discussion-management/Open-discussion.mdx @@ -0,0 +1,41 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Open discussion + Opens a previously closed discussion + + + +`Function OpenDiscussion(Val DiscussionID, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | DiscussionID | --topic | String, Number | Discussion 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(); + DiscussionID = "52595199"; + Result = OPI_VK.OpenDiscussion(DiscussionID, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Discussion-management/Write-in-discussion.md b/docs/en/md/VK/Discussion-management/Write-in-discussion.md deleted file mode 100644 index 3de5d9eb1b..0000000000 --- a/docs/en/md/VK/Discussion-management/Write-in-discussion.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Write in discussion - Adds a message to the discussion on behalf of the group - - - -`Function WriteInDiscussion(Val DiscussionID, Val Text, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | DiscussionID | --topic | String, Number | Discussion ID | - | Text | --text | String | Message text | - | 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(); - DiscussionID = "51798392"; - Message = "I like yellow more"; - - Result = OPI_VK.WriteInDiscussion(DiscussionID, Message, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1513 -} -``` diff --git a/docs/en/md/VK/Discussion-management/Write-in-discussion.mdx b/docs/en/md/VK/Discussion-management/Write-in-discussion.mdx new file mode 100644 index 0000000000..7c1c03c12e --- /dev/null +++ b/docs/en/md/VK/Discussion-management/Write-in-discussion.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Write in discussion + Adds a message to the discussion on behalf of the group + + + +`Function WriteInDiscussion(Val DiscussionID, Val Text, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | DiscussionID | --topic | String, Number | Discussion ID | + | Text | --text | String | Message text | + | 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(); + DiscussionID = "51798392"; + Message = "I like yellow more"; + + Result = OPI_VK.WriteInDiscussion(DiscussionID, Message, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1513 +} +``` diff --git a/docs/en/md/VK/Interactive-actions/Like-post.md b/docs/en/md/VK/Interactive-actions/Like-post.md deleted file mode 100644 index 30d00814fa..0000000000 --- a/docs/en/md/VK/Interactive-actions/Like-post.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Like - Likes a post - - - -`Function LikePost(Val PostID, Val WallID = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | PostID | --post | String, Number | Post ID | - | WallID | --wall | String, Number | ID of the wall where the post is located | - | 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 = "4712"; - - Result = OPI_VK.LikePost(PostID, , Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "likes": 1 - } -} -``` diff --git a/docs/en/md/VK/Interactive-actions/Like-post.mdx b/docs/en/md/VK/Interactive-actions/Like-post.mdx new file mode 100644 index 0000000000..0c438717d1 --- /dev/null +++ b/docs/en/md/VK/Interactive-actions/Like-post.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Like + Likes a post + + + +`Function LikePost(Val PostID, Val WallID = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | PostID | --post | String, Number | Post ID | + | WallID | --wall | String, Number | ID of the wall where the post is located | + | 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 = "4712"; + + Result = OPI_VK.LikePost(PostID, , Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "likes": 1 + } +} +``` diff --git a/docs/en/md/VK/Interactive-actions/Make-repost.md b/docs/en/md/VK/Interactive-actions/Make-repost.md deleted file mode 100644 index 8a91a2c446..0000000000 --- a/docs/en/md/VK/Interactive-actions/Make-repost.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Make repost - Reposts the record - - - -`Function MakeRepost(Val PostID, Val WallID = "", Val TargetWall = "", Val Advertising = False, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | PostID | --post | String, Number | Post ID | - | WallID | --from | String, Number | ID of the wall where the post is located | - | TargetWall | --to | String, Number | ID of the target wall or group | - | Advertising | --ad | Boolean | Sign of an advertising 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(); - PostID = 2571; - WallID = -218704372; - - Result = OPI_VK.MakeRepost(PostID, WallID, , , Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "success": 1, - "post_id": 4558, - "reposts_count": 3, - "likes_count": 10, - "wall_repost_count": 1, - "mail_repost_count": 2, - "badges": { - "type": 11, - "id": 2571, - "owner_id": -218704372 - } - } -} -``` diff --git a/docs/en/md/VK/Interactive-actions/Make-repost.mdx b/docs/en/md/VK/Interactive-actions/Make-repost.mdx new file mode 100644 index 0000000000..71e30745c9 --- /dev/null +++ b/docs/en/md/VK/Interactive-actions/Make-repost.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Make repost + Reposts the record + + + +`Function MakeRepost(Val PostID, Val WallID = "", Val TargetWall = "", Val Advertising = False, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | PostID | --post | String, Number | Post ID | + | WallID | --from | String, Number | ID of the wall where the post is located | + | TargetWall | --to | String, Number | ID of the target wall or group | + | Advertising | --ad | Boolean | Sign of an advertising 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(); + PostID = 2571; + WallID = -218704372; + + Result = OPI_VK.MakeRepost(PostID, WallID, , , Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "success": 1, + "post_id": 4558, + "reposts_count": 3, + "likes_count": 10, + "wall_repost_count": 1, + "mail_repost_count": 2, + "badges": { + "type": 11, + "id": 2571, + "owner_id": -218704372 + } + } +} +``` diff --git a/docs/en/md/VK/Interactive-actions/Shorten-link.md b/docs/en/md/VK/Interactive-actions/Shorten-link.md deleted file mode 100644 index 4746b828a6..0000000000 --- a/docs/en/md/VK/Interactive-actions/Shorten-link.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Shorten link - Creates a shortened URL from a regular one - - - -`Function ShortenLink(Val URL, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | URL | --url | String | URL for shortening | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: String - Shortened URL - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - - Result = OPI_VK.ShortenLink("https://github.com/Bayselonarrend/OpenIntegrations", Parameters); -``` - - - - -```json title="Result" -"https://vk.cc/ctL1sM" -``` diff --git a/docs/en/md/VK/Interactive-actions/Shorten-link.mdx b/docs/en/md/VK/Interactive-actions/Shorten-link.mdx new file mode 100644 index 0000000000..f45da6006e --- /dev/null +++ b/docs/en/md/VK/Interactive-actions/Shorten-link.mdx @@ -0,0 +1,39 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Shorten link + Creates a shortened URL from a regular one + + + +`Function ShortenLink(Val URL, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | URL | --url | String | URL for shortening | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: String - Shortened URL + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + + Result = OPI_VK.ShortenLink("https://github.com/Bayselonarrend/OpenIntegrations", Parameters); +``` + + + + +```json title="Result" +"https://vk.cc/ctL1sM" +``` diff --git a/docs/en/md/VK/Interactive-actions/Write-comment.md b/docs/en/md/VK/Interactive-actions/Write-comment.md deleted file mode 100644 index 2e6513ae87..0000000000 --- a/docs/en/md/VK/Interactive-actions/Write-comment.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Write a comment - Creates a comment under the selected record - - - -`Function WriteComment(Val PostID, Val WallID, Val Text, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | PostID | --post | String, Number | ID of the target post | - | WallID | --wall | String, Number | ID of the wall where the post is located | - | Text | --text | String | Comment text | - | 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 = "NewComment"; - PostID = "4712"; - WallID = Parameters["owner_id"]; - - Result = OPI_VK.WriteComment(PostID, WallID, Text, Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "comment_id": 4559, - "parents_stack": [] - } -} -``` diff --git a/docs/en/md/VK/Interactive-actions/Write-comment.mdx b/docs/en/md/VK/Interactive-actions/Write-comment.mdx new file mode 100644 index 0000000000..509d56df01 --- /dev/null +++ b/docs/en/md/VK/Interactive-actions/Write-comment.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Write a comment + Creates a comment under the selected record + + + +`Function WriteComment(Val PostID, Val WallID, Val Text, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | PostID | --post | String, Number | ID of the target post | + | WallID | --wall | String, Number | ID of the wall where the post is located | + | Text | --text | String | Comment text | + | 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 = "NewComment"; + PostID = "4712"; + WallID = Parameters["owner_id"]; + + Result = OPI_VK.WriteComment(PostID, WallID, Text, Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "comment_id": 4559, + "parents_stack": [] + } +} +``` diff --git a/docs/en/md/VK/Interactive-actions/Write-message.md b/docs/en/md/VK/Interactive-actions/Write-message.md deleted file mode 100644 index 8fb44fc2c9..0000000000 --- a/docs/en/md/VK/Interactive-actions/Write-message.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Write a message - Write a message to a user in the community's dialog - - - -`Function WriteMessage(Val Text, Val UserID, Val Communitytoken, Val Keyboard = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Message text | - | UserID | --user | String | Recipient user ID | - | Communitytoken | --ct | String | Community chat bot token, which can be obtained in the settings | - | Keyboard | --keyboard | String | JSON keyboard. See FormKeyboard | - | 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 = "Message from autotest"; - UserID = "657846756"; - Communitytoken = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8I..."; - - 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); -``` - - - - -```json title="Result" -{ - "response": 563 -} -``` diff --git a/docs/en/md/VK/Interactive-actions/Write-message.mdx b/docs/en/md/VK/Interactive-actions/Write-message.mdx new file mode 100644 index 0000000000..a1d7fbf455 --- /dev/null +++ b/docs/en/md/VK/Interactive-actions/Write-message.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Write a message + Write a message to a user in the community's dialog + + + +`Function WriteMessage(Val Text, Val UserID, Val Communitytoken, Val Keyboard = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Message text | + | UserID | --user | String | Recipient user ID | + | Communitytoken | --ct | String | Community chat bot token, which can be obtained in the settings | + | Keyboard | --keyboard | String | JSON keyboard. See FormKeyboard | + | 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 = "Message from autotest"; + UserID = "657846756"; + Communitytoken = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8I..."; + + 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); +``` + + + + +```json title="Result" +{ + "response": 563 +} +``` diff --git a/docs/en/md/VK/Order-management/Get-order-list.md b/docs/en/md/VK/Order-management/Get-order-list.md deleted file mode 100644 index e21a90645f..0000000000 --- a/docs/en/md/VK/Order-management/Get-order-list.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get order list - Returns the community's order list - - - -`Function GetOrderList(Val Parameters = "") Export` - - | Parameter | CLI option | Type | 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(); - Result = OPI_VK.GetOrderList(Parameters); -``` - - - - -```json title="Result" -[ - { - "id": 397209, - "group_id": 218861756, - "user_id": 657846756, - "date": 1708092731, - "status": 0, - "items_count": 1, - "total_price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽" - }, - "display_order_id": "657846756-397209", - "merchant_comment": "", - "weight": 100, - "tags": [], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "preview_order_items": [ - { - "owner_id": -218861756, - "item_id": 8653766, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽" - }, - "quantity": 1, - "item": { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "", - "section": { - "id": 9000, - "name": "Все товары" - } - }, - "description": "Описание товара", - "id": 8653766, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (Красный)", - "date": 1708083983, - "item_type": 0, - "is_owner": true, - "is_adult": false, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/wosvBQJa9bQ.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6068bf9db412cd491d405a90737e5208&c_uniq_tag=k-olNZ8Ykr5YbvQQiBDDJlj5UeQvopai5F2oAP29As8", - "cart_quantity": 0, - "sku": "12 345", - "reject_info": { - "title": "Отредактируйте товар, чтобы опубликовать в Маркете ВКонтакте", - "description": "Товар отклонён. Чтобы добавить его в «Маркет», укажите реальную цену товара или стоимость оказания услуги.", - "moderation_status": 2, - "info_link": "[https://vk.com/faq20323|Правила Маркета ВКонтакте]", - "write_to_support_link": "https://vk.com/im?media=&sel=-215808305&ref=ProductId%3D-218861756_8653766", - "in_progress": false, - "buttons": [ - { - "type": "market_edit", - "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653766&type=market" - }, - { - "type": "market_delete" - } - ] - }, - "has_group_access": true, - "market_url": "https://vk.com/market/product/testovy-tovar-krasny-218861756-8653766" - }, - "title": "Тестовый товар (Красный)", - "photo": { - "album_id": -105, - "date": 1708092731, - "id": 457241543, - "owner_id": 657846756, - "sizes": [ - { - "height": 75, - "type": "s", - "width": 75, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=75x75" - }, - { - "height": 130, - "type": "m", - "width": 130, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" - }, - { - "height": 604, - "type": "x", - "width": 604, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=604x604" - }, - { - "height": 807, - "type": "y", - "width": 807, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=807x807" - }, - { - "height": 1024, - "type": "z", - "width": 1024, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=1024x1024" - }, - { - "height": 130, - "type": "o", - "width": 130, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" - }, - { - "height": 200, - "type": "p", - "width": 200, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=200x200" - }, - { - "height": 320, - "type": "q", - "width": 320, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=320x320" - }, - { -... -``` diff --git a/docs/en/md/VK/Order-management/Get-order-list.mdx b/docs/en/md/VK/Order-management/Get-order-list.mdx new file mode 100644 index 0000000000..f2ac3119de --- /dev/null +++ b/docs/en/md/VK/Order-management/Get-order-list.mdx @@ -0,0 +1,187 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get order list + Returns the community's order list + + + +`Function GetOrderList(Val Parameters = "") Export` + + | Parameter | CLI option | Type | 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(); + Result = OPI_VK.GetOrderList(Parameters); +``` + + + + +```json title="Result" +[ + { + "id": 397209, + "group_id": 218861756, + "user_id": 657846756, + "date": 1708092731, + "status": 0, + "items_count": 1, + "total_price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽" + }, + "display_order_id": "657846756-397209", + "merchant_comment": "", + "weight": 100, + "tags": [], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "preview_order_items": [ + { + "owner_id": -218861756, + "item_id": 8653766, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽" + }, + "quantity": 1, + "item": { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "", + "section": { + "id": 9000, + "name": "Все товары" + } + }, + "description": "Описание товара", + "id": 8653766, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (Красный)", + "date": 1708083983, + "item_type": 0, + "is_owner": true, + "is_adult": false, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/wosvBQJa9bQ.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6068bf9db412cd491d405a90737e5208&c_uniq_tag=k-olNZ8Ykr5YbvQQiBDDJlj5UeQvopai5F2oAP29As8", + "cart_quantity": 0, + "sku": "12 345", + "reject_info": { + "title": "Отредактируйте товар, чтобы опубликовать в Маркете ВКонтакте", + "description": "Товар отклонён. Чтобы добавить его в «Маркет», укажите реальную цену товара или стоимость оказания услуги.", + "moderation_status": 2, + "info_link": "[https://vk.com/faq20323|Правила Маркета ВКонтакте]", + "write_to_support_link": "https://vk.com/im?media=&sel=-215808305&ref=ProductId%3D-218861756_8653766", + "in_progress": false, + "buttons": [ + { + "type": "market_edit", + "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653766&type=market" + }, + { + "type": "market_delete" + } + ] + }, + "has_group_access": true, + "market_url": "https://vk.com/market/product/testovy-tovar-krasny-218861756-8653766" + }, + "title": "Тестовый товар (Красный)", + "photo": { + "album_id": -105, + "date": 1708092731, + "id": 457241543, + "owner_id": 657846756, + "sizes": [ + { + "height": 75, + "type": "s", + "width": 75, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=75x75" + }, + { + "height": 130, + "type": "m", + "width": 130, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" + }, + { + "height": 604, + "type": "x", + "width": 604, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=604x604" + }, + { + "height": 807, + "type": "y", + "width": 807, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=807x807" + }, + { + "height": 1024, + "type": "z", + "width": 1024, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=1024x1024" + }, + { + "height": 130, + "type": "o", + "width": 130, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" + }, + { + "height": 200, + "type": "p", + "width": 200, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=200x200" + }, + { + "height": 320, + "type": "q", + "width": 320, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=320x320" + }, + { +... +``` diff --git a/docs/en/md/VK/Others/Form-keyboard.md b/docs/en/md/VK/Others/Form-keyboard.md deleted file mode 100644 index 554e596d1b..0000000000 --- a/docs/en/md/VK/Others/Form-keyboard.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create keyboard - Forms a keyboard from an array of buttons - - - -`Function FormKeyboard(Val ButtonArray) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ButtonArray | --buttons | Array of String | Array of button titles | - - - Returns: String - Keyboard JSON - -
- - - - -```bsl title="Code example" - ButtonArray = New Array; - ButtonArray.Add("Button 1"); - ButtonArray.Add("Button 2"); - - Keyboard = OPI_VK.FormKeyboard(ButtonArray); -``` - - - - -```json title="Result" -{ - "buttons": [ - [ - { - "action": { - "type": "text", - "label": "Button 1" - } - }, - { - "action": { - "type": "text", - "label": "Button 2" - } - } - ] - ], - "one_time": false - } -``` diff --git a/docs/en/md/VK/Others/Form-keyboard.mdx b/docs/en/md/VK/Others/Form-keyboard.mdx new file mode 100644 index 0000000000..94787f26e9 --- /dev/null +++ b/docs/en/md/VK/Others/Form-keyboard.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create keyboard + Forms a keyboard from an array of buttons + + + +`Function FormKeyboard(Val ButtonArray) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ButtonArray | --buttons | Array of String | Array of button titles | + + + Returns: String - Keyboard JSON + +
+ + + + +```bsl title="Code example" + ButtonArray = New Array; + ButtonArray.Add("Button 1"); + ButtonArray.Add("Button 2"); + + Keyboard = OPI_VK.FormKeyboard(ButtonArray); +``` + + + + +```json title="Result" +{ + "buttons": [ + [ + { + "action": { + "type": "text", + "label": "Button 1" + } + }, + { + "action": { + "type": "text", + "label": "Button 2" + } + } + ] + ], + "one_time": false + } +``` diff --git a/docs/en/md/VK/Product-management/Add-product.md b/docs/en/md/VK/Product-management/Add-product.md deleted file mode 100644 index 296b4a8048..0000000000 --- a/docs/en/md/VK/Product-management/Add-product.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Add product - Adds a new product to the community's catalog - - - -`Function AddProduct(Val ProductDescription, Val Selection = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ProductDescription | --product | Map Of KeyAndValue | JSON description of the product or path | - | Selection | --sel | String | Selection ID for placing the product, if needed | - | 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(); - - Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary or Path to file - Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary or Path to file - Selection = "130"; - - ImageArray = New Array; - ImageArray.Add(Image1); - ImageArray.Add(Image2); - - 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"); - - Result = OPI_VK.AddProduct(ProductDescription, Selection, Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "market_item_id": 9709208 - } -} -``` diff --git a/docs/en/md/VK/Product-management/Add-product.mdx b/docs/en/md/VK/Product-management/Add-product.mdx new file mode 100644 index 0000000000..fed2bb1c37 --- /dev/null +++ b/docs/en/md/VK/Product-management/Add-product.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Add product + Adds a new product to the community's catalog + + + +`Function AddProduct(Val ProductDescription, Val Selection = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ProductDescription | --product | Map Of KeyAndValue | JSON description of the product or path | + | Selection | --sel | String | Selection ID for placing the product, if needed | + | 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(); + + Image1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Binary or Path to file + Image2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Binary or Path to file + Selection = "130"; + + ImageArray = New Array; + ImageArray.Add(Image1); + ImageArray.Add(Image2); + + 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"); + + Result = OPI_VK.AddProduct(ProductDescription, Selection, Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "market_item_id": 9709208 + } +} +``` diff --git a/docs/en/md/VK/Product-management/Delete-product.md b/docs/en/md/VK/Product-management/Delete-product.md deleted file mode 100644 index 1d51fa4454..0000000000 --- a/docs/en/md/VK/Product-management/Delete-product.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Delete product - Deletes a previously created product - - - -`Function DeleteProduct(Val Product, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Product | --item | String, Number | Product 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(); - - Product = "9756133"; - - Result = OPI_VK.DeleteProduct(Product, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-management/Delete-product.mdx b/docs/en/md/VK/Product-management/Delete-product.mdx new file mode 100644 index 0000000000..3b530de0f1 --- /dev/null +++ b/docs/en/md/VK/Product-management/Delete-product.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Delete product + Deletes a previously created product + + + +`Function DeleteProduct(Val Product, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Product | --item | String, Number | Product 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(); + + Product = "9756133"; + + Result = OPI_VK.DeleteProduct(Product, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-management/Edit-product.md b/docs/en/md/VK/Product-management/Edit-product.md deleted file mode 100644 index df6638ba67..0000000000 --- a/docs/en/md/VK/Product-management/Edit-product.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Edit product - Edits a previously created product - - - -`Function EditProduct(Val Product, Val ProductDescription, Val Selection = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Product | --item | Number, String | Identifier of the product being edited | - | ProductDescription | --product | Map Of KeyAndValue | JSON description of the product or path | - | Selection | --sel | String | Identifier of the new selection, if needed | - | 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(); - - Product = "9756133"; - - ProductDescription = New Map; - ProductDescription.Insert("Name", "EditedTestProduct"); - - Result = OPI_VK.EditProduct(Product, ProductDescription, , Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-management/Edit-product.mdx b/docs/en/md/VK/Product-management/Edit-product.mdx new file mode 100644 index 0000000000..e0bbdc98d2 --- /dev/null +++ b/docs/en/md/VK/Product-management/Edit-product.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Edit product + Edits a previously created product + + + +`Function EditProduct(Val Product, Val ProductDescription, Val Selection = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Product | --item | Number, String | Identifier of the product being edited | + | ProductDescription | --product | Map Of KeyAndValue | JSON description of the product or path | + | Selection | --sel | String | Identifier of the new selection, if needed | + | 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(); + + Product = "9756133"; + + ProductDescription = New Map; + ProductDescription.Insert("Name", "EditedTestProduct"); + + Result = OPI_VK.EditProduct(Product, ProductDescription, , Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-management/Get-product-category-list.md b/docs/en/md/VK/Product-management/Get-product-category-list.md deleted file mode 100644 index 1e72ac2999..0000000000 --- a/docs/en/md/VK/Product-management/Get-product-category-list.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get a list of product categories - Gets a list of product category IDs to specify when creating a product - - - -`Function GetProductCategoryList(Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Map Of String - Key - ID, Value - Name - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - - Result = OPI_VK.GetProductCategoryList(Parameters); -``` - - - - -```json title="Result" -{ - "20000": "Женщинам", - "20001": "Мужчинам", - "20002": "Детям", - "20003": "Смартфоны и гаджеты", - "20004": "Квадрокоптеры и аксессуары", - "20005": "Планшеты и электронные книги", - "20006": "Умный дом и безопасность", - "20007": "ТВ, аудио и видео", - "20008": "Фото- и видеокамеры", - "20009": "Компьютеры и ноутбуки", - "20010": "Сетевое оборудование", - "20011": "Оргтехника и расходники", - "20012": "Навигаторы", - "20013": "Крупная бытовая техника", - "20014": "Малая бытовая техника для кухни", - "20015": "Техника для дома", - "20016": "Климатическая техника", - "20017": "Встраиваемая бытовая техника", - "20018": "Техника для красоты и здоровья", - "20019": "Хозяйственные товары", - "20020": "Посуда и товары для кухни", - "20021": "Товары для праздников", - "20022": "Аксесcуары для ванной и туалета", - "20023": "Домашний текстиль", - "20024": "Интерьер и декор", - "20025": "Освещение", - "20026": "Мебель", - "20027": "Дача и сад", - "20179": "Ритуальные товары", - "20177": "Гадания и эзотерика", - "20028": "Билеты и путешествия", - "20029": "Книги и журналы", - "20030": "Рукоделие и творчество", - "20031": "Настольные и карточные игры", - "20033": "Музыкальные инструменты", - "20034": "Коллекционирование", - "20035": "Подарочные сертификаты", - "20036": "Сувениры и цветы", - "20147": "Теннис и бадминтон", - "20148": "Дартс", - "20146": "Гольф", - "20037": "Тренажеры и фитнес", - "20038": "Спортивная одежда", - "20039": "Спортивная обувь", - "20040": "Зимний спорт", - "20041": "Командные виды спорта", - "20042": "Бокс и единоборства", - "20043": "Водный спорт", - "20044": "Художественная гимнастика", - "20045": "Велосипеды и аксессуары", - "20047": "Самокаты, скейтборды и ролики", - "20048": "Электротранспорт", - "20049": "Настольные спортивные игры", - "20050": "Спортивные комплексы", - "20051": "Охота и рыбалка", - "20052": "Туризм и отдых на природе", - "20053": "Чемоданы, сумки и рюкзаки", - "20054": "Спортивное питание", - "20055": "Бакалея", - "20056": "Мясо и птица", - "20057": "Рыба и морепродукты", - "20058": "Овощи, фрукты, зелень", - "20059": "Соленья", - "20060": "Молочные продукты и яйца", - "20061": "Мясные деликатесы", - "20062": "Детское питание", - "20063": "Еда на заказ", - "20064": "Напитки", - "20180": "Замороженные продукты", - "20065": "Автокресла", - "20066": "Детская комната", - "20067": "Коляски", - "20068": "Игрушки и игры", - "20069": "Подгузники и гигиена", - "20070": "Техника для мам и детей", - "20071": "Товары для кормления", - "20072": "Детское питание и кормление", - "20073": "Спорт и отдых", - "20074": "Хобби и творчество", - "20076": "Игровые приставки", - "20077": "Игровые ноутбуки", - "20078": "Игровые компьютеры", - "20079": "Игровые мониторы", - "20080": "Игры для ПК", - "20081": "Игровая периферия", - "20082": "Игровые столы", - "20083": "Компьютерные кресла", - "20085": "Игровая атрибутика", - "20086": "Макияж", - "20087": "Уход за лицом", - "20088": "Уход за телом", - "20089": "Защита от солнца и автозагар", - "20090": "Уход за волосами", - "20091": "Маникюр и педикюр", - "20092": "Мужская косметика", - "20093": "Парфюмерия", - "20094": "Ароматерапия", - "20095": "Средства гигиены", - "20096": "Контактные линзы, очки и аксессуары", - "20097": "Ортопедия, Компрессионный трикотаж", - "20098": "Витамины, БАДы и пищевые добавки", - "20099": "Контрацептивы и лубриканты", - "20100": "Товары для людей с ограниченными возможностями", - "20178": "Медицинские изделия и расходные материалы", - "20176": "Промышленное оборудование и материалы", - "20101": "Строительные материалы", - "20102": "Инструмент", - "20103": "Электрика", - "20104": "Сантехника и инженерные системы", - "20105": "Отделочные материалы", - "20106": "Сауны и бани", - "20107": "Для собак", - "20108": "Для кошек", - "20109": "Для грызунов", - "20110": "Для птиц", - "20111": "Для рыб и рептилий", - "20112": "Для лошадей", - "20113": "Для фермерского хозяйства", - "20183": "Витамины, БАДы и пищевые добавки", - "20114": "Автомобили", - "20115": "Водный транспорт", - "20116": "Мототехника", - "20117": "Прицепы и полуприцепы", - "20118": "Автобусы", - "20119": "Грузовики", - "20120": "Спецтехника", - "20121": "Авиационный транспорт", - "20122": "Запчасти", - "20123": "Оборудование и тюнинг", - "20124": "Шины и диски", - "20125": "Масла и автохимия", - "20126": "Автоэлектроника и GPS", - "20127": "Инструменты", - "20128": "Аудио и видео", - "20129": "Противоугонные устройства", - "20130": "Багажные системы", - "20131": "Автоаксессуары", - "20132": "Недвижимость за рубежом", - "20133": "Недвижимость в России", - "20134": "Зажигалки, спички и аксессуары", - "20135": "Пепельницы", - "20136": "Портсигары", - "20141": "Товары для БДСМ", - "20142": "Эротические сувениры и игры", - "20143": "Аксессуары для взрослых", - "20144": "Секс-игрушки", - "20145": "Эротическое белье и костюмы", - "20154": "Ластики", - "20168": "Печати и штампы", -... -``` diff --git a/docs/en/md/VK/Product-management/Get-product-category-list.mdx b/docs/en/md/VK/Product-management/Get-product-category-list.mdx new file mode 100644 index 0000000000..837e1ce0a7 --- /dev/null +++ b/docs/en/md/VK/Product-management/Get-product-category-list.mdx @@ -0,0 +1,188 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get a list of product categories + Gets a list of product category IDs to specify when creating a product + + + +`Function GetProductCategoryList(Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Map Of String - Key - ID, Value - Name + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + + Result = OPI_VK.GetProductCategoryList(Parameters); +``` + + + + +```json title="Result" +{ + "20000": "Женщинам", + "20001": "Мужчинам", + "20002": "Детям", + "20003": "Смартфоны и гаджеты", + "20004": "Квадрокоптеры и аксессуары", + "20005": "Планшеты и электронные книги", + "20006": "Умный дом и безопасность", + "20007": "ТВ, аудио и видео", + "20008": "Фото- и видеокамеры", + "20009": "Компьютеры и ноутбуки", + "20010": "Сетевое оборудование", + "20011": "Оргтехника и расходники", + "20012": "Навигаторы", + "20013": "Крупная бытовая техника", + "20014": "Малая бытовая техника для кухни", + "20015": "Техника для дома", + "20016": "Климатическая техника", + "20017": "Встраиваемая бытовая техника", + "20018": "Техника для красоты и здоровья", + "20019": "Хозяйственные товары", + "20020": "Посуда и товары для кухни", + "20021": "Товары для праздников", + "20022": "Аксесcуары для ванной и туалета", + "20023": "Домашний текстиль", + "20024": "Интерьер и декор", + "20025": "Освещение", + "20026": "Мебель", + "20027": "Дача и сад", + "20179": "Ритуальные товары", + "20177": "Гадания и эзотерика", + "20028": "Билеты и путешествия", + "20029": "Книги и журналы", + "20030": "Рукоделие и творчество", + "20031": "Настольные и карточные игры", + "20033": "Музыкальные инструменты", + "20034": "Коллекционирование", + "20035": "Подарочные сертификаты", + "20036": "Сувениры и цветы", + "20147": "Теннис и бадминтон", + "20148": "Дартс", + "20146": "Гольф", + "20037": "Тренажеры и фитнес", + "20038": "Спортивная одежда", + "20039": "Спортивная обувь", + "20040": "Зимний спорт", + "20041": "Командные виды спорта", + "20042": "Бокс и единоборства", + "20043": "Водный спорт", + "20044": "Художественная гимнастика", + "20045": "Велосипеды и аксессуары", + "20047": "Самокаты, скейтборды и ролики", + "20048": "Электротранспорт", + "20049": "Настольные спортивные игры", + "20050": "Спортивные комплексы", + "20051": "Охота и рыбалка", + "20052": "Туризм и отдых на природе", + "20053": "Чемоданы, сумки и рюкзаки", + "20054": "Спортивное питание", + "20055": "Бакалея", + "20056": "Мясо и птица", + "20057": "Рыба и морепродукты", + "20058": "Овощи, фрукты, зелень", + "20059": "Соленья", + "20060": "Молочные продукты и яйца", + "20061": "Мясные деликатесы", + "20062": "Детское питание", + "20063": "Еда на заказ", + "20064": "Напитки", + "20180": "Замороженные продукты", + "20065": "Автокресла", + "20066": "Детская комната", + "20067": "Коляски", + "20068": "Игрушки и игры", + "20069": "Подгузники и гигиена", + "20070": "Техника для мам и детей", + "20071": "Товары для кормления", + "20072": "Детское питание и кормление", + "20073": "Спорт и отдых", + "20074": "Хобби и творчество", + "20076": "Игровые приставки", + "20077": "Игровые ноутбуки", + "20078": "Игровые компьютеры", + "20079": "Игровые мониторы", + "20080": "Игры для ПК", + "20081": "Игровая периферия", + "20082": "Игровые столы", + "20083": "Компьютерные кресла", + "20085": "Игровая атрибутика", + "20086": "Макияж", + "20087": "Уход за лицом", + "20088": "Уход за телом", + "20089": "Защита от солнца и автозагар", + "20090": "Уход за волосами", + "20091": "Маникюр и педикюр", + "20092": "Мужская косметика", + "20093": "Парфюмерия", + "20094": "Ароматерапия", + "20095": "Средства гигиены", + "20096": "Контактные линзы, очки и аксессуары", + "20097": "Ортопедия, Компрессионный трикотаж", + "20098": "Витамины, БАДы и пищевые добавки", + "20099": "Контрацептивы и лубриканты", + "20100": "Товары для людей с ограниченными возможностями", + "20178": "Медицинские изделия и расходные материалы", + "20176": "Промышленное оборудование и материалы", + "20101": "Строительные материалы", + "20102": "Инструмент", + "20103": "Электрика", + "20104": "Сантехника и инженерные системы", + "20105": "Отделочные материалы", + "20106": "Сауны и бани", + "20107": "Для собак", + "20108": "Для кошек", + "20109": "Для грызунов", + "20110": "Для птиц", + "20111": "Для рыб и рептилий", + "20112": "Для лошадей", + "20113": "Для фермерского хозяйства", + "20183": "Витамины, БАДы и пищевые добавки", + "20114": "Автомобили", + "20115": "Водный транспорт", + "20116": "Мототехника", + "20117": "Прицепы и полуприцепы", + "20118": "Автобусы", + "20119": "Грузовики", + "20120": "Спецтехника", + "20121": "Авиационный транспорт", + "20122": "Запчасти", + "20123": "Оборудование и тюнинг", + "20124": "Шины и диски", + "20125": "Масла и автохимия", + "20126": "Автоэлектроника и GPS", + "20127": "Инструменты", + "20128": "Аудио и видео", + "20129": "Противоугонные устройства", + "20130": "Багажные системы", + "20131": "Автоаксессуары", + "20132": "Недвижимость за рубежом", + "20133": "Недвижимость в России", + "20134": "Зажигалки, спички и аксессуары", + "20135": "Пепельницы", + "20136": "Портсигары", + "20141": "Товары для БДСМ", + "20142": "Эротические сувениры и игры", + "20143": "Аксессуары для взрослых", + "20144": "Секс-игрушки", + "20145": "Эротическое белье и костюмы", + "20154": "Ластики", + "20168": "Печати и штампы", +... +``` diff --git a/docs/en/md/VK/Product-management/Get-product-description.md b/docs/en/md/VK/Product-management/Get-product-description.md deleted file mode 100644 index 7d3d56f17a..0000000000 --- a/docs/en/md/VK/Product-management/Get-product-description.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get product description - Gets the description template for creating a product - - - -`Function GetProductDescription(Val Clear = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Map Of KeyAndValue - Fields map - -
- - - - -```bsl title="Code example" - Result = OPI_VK.GetProductDescription(); -``` - - - - -```json title="Result" -{ - "Name": "New product", - "Description": "Product description", - "Category": "20173", - "Price": 1, - "OldPrice": null, - "MainPhoto": null, - "URL": null, - "AdditionalPhotos": [], - "PropertyValues": [], - "MainInGroup": false, - "Width": null, - "Height": null, - "Depth": null, - "Weight": null, - "SKU": null, - "AvailableBalance": 1 -} -``` diff --git a/docs/en/md/VK/Product-management/Get-product-description.mdx b/docs/en/md/VK/Product-management/Get-product-description.mdx new file mode 100644 index 0000000000..037cc42807 --- /dev/null +++ b/docs/en/md/VK/Product-management/Get-product-description.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get product description + Gets the description template for creating a product + + + +`Function GetProductDescription(Val Clear = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Map Of KeyAndValue - Fields map + +
+ + + + +```bsl title="Code example" + Result = OPI_VK.GetProductDescription(); +``` + + + + +```json title="Result" +{ + "Name": "New product", + "Description": "Product description", + "Category": "20173", + "Price": 1, + "OldPrice": null, + "MainPhoto": null, + "URL": null, + "AdditionalPhotos": [], + "PropertyValues": [], + "MainInGroup": false, + "Width": null, + "Height": null, + "Depth": null, + "Weight": null, + "SKU": null, + "AvailableBalance": 1 +} +``` diff --git a/docs/en/md/VK/Product-management/Get-product-list.md b/docs/en/md/VK/Product-management/Get-product-list.md deleted file mode 100644 index 884a8f69c7..0000000000 --- a/docs/en/md/VK/Product-management/Get-product-list.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get product list - Gets the community's product list - - - -`Function GetProductList(Val Selection = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Selection | --sel | String, Number | Selection ID, if filtering is needed | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Map Of KeyAndValue - Array of product maps - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - Result = OPI_VK.GetProductList(, Parameters); -``` - - - - -```json title="Result" -[ - { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "Батарейки", - "section": { - "id": 10016, - "name": "Канцелярские товары" - } - }, - "description": "Описание товара", - "id": 9642576, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (со свойством)", - "other_items": [ - { - "title": "Другие товары сообщества", - "view_type": 1, - "item_ids": [ - "-218861756_9640025", - "-218861756_9578921", - "-218861756_9499082", - "-218861756_9423489", - "-218861756_9387853", - "-218861756_9320009", - "-218861756_9320008", - "-218861756_9259547", - "-218861756_9259390", - "-218861756_9192466" - ], - "referrer_item_type": "other_goods" - } - ], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "weight": 100, - "albums_ids": [], - "photos": [], - "can_comment": 1, - "can_repost": 1, - "likes": { - "count": 0, - "user_likes": 0 - }, - "reposts": { - "count": 0 - }, - "views_count": 0, - "variants_grid": [], - "owner_info": { - "avatar": [], - "name": "Test", - "category": "Батарейки", - "category_url": "/market-218861756", - "is_corporated_market": false, - "market_type": "pro" - }, - "can_edit": true, - "can_delete": true, - "can_recover": false, - "can_show_convert_to_service": true, - "promotion": { - "is_available": true - }, - "labels": [], - "date": 1727611884, - "item_type": 0, - "is_owner": true, - "is_adult": false, - "thumb_photo": "", - "variants_grouping_id": 10666, - "cart_quantity": 0, - "sku": "12345", - "has_group_access": true, - "market_url": "https://vk.com/market/product/testovy-tovar-so-svoystvom-218861756-9642576" - }, - { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "Батарейки", - "section": { - "id": 10016, - "name": "Канцелярские товары" - } - }, - "description": "Описание товара", - "id": 9640025, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (другой)", - "other_items": [ - { - "title": "Другие товары сообщества", - "view_type": 1, - "item_ids": [ - "-218861756_9642576", - "-218861756_9578921", - "-218861756_9499082", - "-218861756_9423489", - "-218861756_9387853", - "-218861756_9320009", - "-218861756_9320008", - "-218861756_9259547", - "-218861756_9259390", - "-218861756_9192466" - ], - "referrer_item_type": "other_goods" - } - ], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "weight": 100, - "albums_ids": [], - "photos": [], - "can_comment": 1, - "can_repost": 1, - "likes": { -... -``` diff --git a/docs/en/md/VK/Product-management/Get-product-list.mdx b/docs/en/md/VK/Product-management/Get-product-list.mdx new file mode 100644 index 0000000000..d09afda94d --- /dev/null +++ b/docs/en/md/VK/Product-management/Get-product-list.mdx @@ -0,0 +1,188 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get product list + Gets the community's product list + + + +`Function GetProductList(Val Selection = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Selection | --sel | String, Number | Selection ID, if filtering is needed | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Map Of KeyAndValue - Array of product maps + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + Result = OPI_VK.GetProductList(, Parameters); +``` + + + + +```json title="Result" +[ + { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "Батарейки", + "section": { + "id": 10016, + "name": "Канцелярские товары" + } + }, + "description": "Описание товара", + "id": 9642576, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (со свойством)", + "other_items": [ + { + "title": "Другие товары сообщества", + "view_type": 1, + "item_ids": [ + "-218861756_9640025", + "-218861756_9578921", + "-218861756_9499082", + "-218861756_9423489", + "-218861756_9387853", + "-218861756_9320009", + "-218861756_9320008", + "-218861756_9259547", + "-218861756_9259390", + "-218861756_9192466" + ], + "referrer_item_type": "other_goods" + } + ], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "weight": 100, + "albums_ids": [], + "photos": [], + "can_comment": 1, + "can_repost": 1, + "likes": { + "count": 0, + "user_likes": 0 + }, + "reposts": { + "count": 0 + }, + "views_count": 0, + "variants_grid": [], + "owner_info": { + "avatar": [], + "name": "Test", + "category": "Батарейки", + "category_url": "/market-218861756", + "is_corporated_market": false, + "market_type": "pro" + }, + "can_edit": true, + "can_delete": true, + "can_recover": false, + "can_show_convert_to_service": true, + "promotion": { + "is_available": true + }, + "labels": [], + "date": 1727611884, + "item_type": 0, + "is_owner": true, + "is_adult": false, + "thumb_photo": "", + "variants_grouping_id": 10666, + "cart_quantity": 0, + "sku": "12345", + "has_group_access": true, + "market_url": "https://vk.com/market/product/testovy-tovar-so-svoystvom-218861756-9642576" + }, + { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "Батарейки", + "section": { + "id": 10016, + "name": "Канцелярские товары" + } + }, + "description": "Описание товара", + "id": 9640025, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (другой)", + "other_items": [ + { + "title": "Другие товары сообщества", + "view_type": 1, + "item_ids": [ + "-218861756_9642576", + "-218861756_9578921", + "-218861756_9499082", + "-218861756_9423489", + "-218861756_9387853", + "-218861756_9320009", + "-218861756_9320008", + "-218861756_9259547", + "-218861756_9259390", + "-218861756_9192466" + ], + "referrer_item_type": "other_goods" + } + ], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "weight": 100, + "albums_ids": [], + "photos": [], + "can_comment": 1, + "can_repost": 1, + "likes": { +... +``` diff --git a/docs/en/md/VK/Product-management/Get-products-by-id.md b/docs/en/md/VK/Product-management/Get-products-by-id.md deleted file mode 100644 index a2a223da22..0000000000 --- a/docs/en/md/VK/Product-management/Get-products-by-id.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get products by ID - Gets information about products by array of IDs - - - -`Function GetProductsByID(Val Products, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Products | --items | String, Array of String | Array of product IDs | - | 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(); - - Item1 = "9755489"; - Item2 = "9755490"; - - ProductsArray = New Array; - ProductsArray.Add(Item1); - ProductsArray.Add(Item2); - - Result = OPI_VK.GetProductsByID(ProductsArray, Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "count": 2, - "items": [ - { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "Батарейки", - "section": { - "id": 10016, - "name": "Канцелярские товары" - } - }, - "description": "Product description", - "id": 9709213, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Test product (with prop)", - "other_items": [ - { - "title": "Другие товары сообщества", - "view_type": 1, - "item_ids": [ - "-218861756_9709215", - "-218861756_9642576", - "-218861756_9640025", - "-218861756_9578921", - "-218861756_9499082", - "-218861756_9423489", - "-218861756_9387853", - "-218861756_9320009", - "-218861756_9320008", - "-218861756_9259547" - ], - "referrer_item_type": "other_goods" - } - ], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "weight": 100, - "albums_ids": [], - "photos": [ - { - "album_id": -53, - "date": 1728453912, - "id": 457249082, - "owner_id": -218861756, - "access_key": "6f2a29d38b1ed801b2", - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "12496d9e422e90cedd", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - }, - { - "album_id": -53, - "date": 1728453916, - "id": 457249083, - "owner_id": -218861756, - "access_key": "b72689d2618669fe74", - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/GbPNCmNwr6zHgzZoHvTc_U72QL6bfQMRxksnAvEjdkAe7RjmsCkewnYf56isbGizhc84sSxBerTju5bf53Rt_BRs.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, -... -``` diff --git a/docs/en/md/VK/Product-management/Get-products-by-id.mdx b/docs/en/md/VK/Product-management/Get-products-by-id.mdx new file mode 100644 index 0000000000..b97703a9d9 --- /dev/null +++ b/docs/en/md/VK/Product-management/Get-products-by-id.mdx @@ -0,0 +1,196 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get products by ID + Gets information about products by array of IDs + + + +`Function GetProductsByID(Val Products, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Products | --items | String, Array of String | Array of product IDs | + | 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(); + + Item1 = "9755489"; + Item2 = "9755490"; + + ProductsArray = New Array; + ProductsArray.Add(Item1); + ProductsArray.Add(Item2); + + Result = OPI_VK.GetProductsByID(ProductsArray, Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "count": 2, + "items": [ + { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "Батарейки", + "section": { + "id": 10016, + "name": "Канцелярские товары" + } + }, + "description": "Product description", + "id": 9709213, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Test product (with prop)", + "other_items": [ + { + "title": "Другие товары сообщества", + "view_type": 1, + "item_ids": [ + "-218861756_9709215", + "-218861756_9642576", + "-218861756_9640025", + "-218861756_9578921", + "-218861756_9499082", + "-218861756_9423489", + "-218861756_9387853", + "-218861756_9320009", + "-218861756_9320008", + "-218861756_9259547" + ], + "referrer_item_type": "other_goods" + } + ], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "weight": 100, + "albums_ids": [], + "photos": [ + { + "album_id": -53, + "date": 1728453912, + "id": 457249082, + "owner_id": -218861756, + "access_key": "6f2a29d38b1ed801b2", + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "12496d9e422e90cedd", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-13.userapi.com/s/v1/ig2/BRraTEhjTmc3iomRoahXiRER1_N-S0W-HiUcs_bp7AAd8lLn6tJus30pTY0eioD8NnB7l3aFZaLh9Wb-NZ8Xqsf4.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + }, + { + "album_id": -53, + "date": 1728453916, + "id": 457249083, + "owner_id": -218861756, + "access_key": "b72689d2618669fe74", + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/GbPNCmNwr6zHgzZoHvTc_U72QL6bfQMRxksnAvEjdkAe7RjmsCkewnYf56isbGizhc84sSxBerTju5bf53Rt_BRs.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, +... +``` diff --git a/docs/en/md/VK/Product-management/Group-products.md b/docs/en/md/VK/Product-management/Group-products.md deleted file mode 100644 index 15eed48c32..0000000000 --- a/docs/en/md/VK/Product-management/Group-products.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Group products - Groups products based on similar sets of properties - - - -`Function GroupProducts(Val ProductsArray, Val ExistingGroup = "", Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ProductsArray | --items | Array Of String | Array of product IDs | - | ExistingGroup | --sellgroup | String | ID of the existing group, if needed | - | 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(); - - Item1 = "9755489"; - Item2 = "9755490"; - - ProductsArray = New Array; - ProductsArray.Add(Item1); - ProductsArray.Add(Item2); - - Result = OPI_VK.GroupProducts(ProductsArray, , Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "item_group_id": 11253 - } -} -``` diff --git a/docs/en/md/VK/Product-management/Group-products.mdx b/docs/en/md/VK/Product-management/Group-products.mdx new file mode 100644 index 0000000000..219e2a54b4 --- /dev/null +++ b/docs/en/md/VK/Product-management/Group-products.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Group products + Groups products based on similar sets of properties + + + +`Function GroupProducts(Val ProductsArray, Val ExistingGroup = "", Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ProductsArray | --items | Array Of String | Array of product IDs | + | ExistingGroup | --sellgroup | String | ID of the existing group, if needed | + | 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(); + + Item1 = "9755489"; + Item2 = "9755490"; + + ProductsArray = New Array; + ProductsArray.Add(Item1); + ProductsArray.Add(Item2); + + Result = OPI_VK.GroupProducts(ProductsArray, , Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "item_group_id": 11253 + } +} +``` diff --git a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md deleted file mode 100644 index c119cf45b3..0000000000 --- a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Add product property variant - Adds a variant for an existing property - - - -`Function AddProductPropertyVariant(Val Value, Val Property, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Value | --value | String | Property value | - | Property | --prop | String, Number | Property ID where the variant is added | - | 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(); - - Property = "878"; - 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; -``` - - - - -```json title="Result" -{ - "response": { - "variant_id": 2563 - } -} -``` diff --git a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.mdx b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.mdx new file mode 100644 index 0000000000..56a025342b --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Add product property variant + Adds a variant for an existing property + + + +`Function AddProductPropertyVariant(Val Value, Val Property, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Value | --value | String | Property value | + | Property | --prop | String, Number | Property ID where the variant is added | + | 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(); + + Property = "878"; + 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; +``` + + + + +```json title="Result" +{ + "response": { + "variant_id": 2563 + } +} +``` diff --git a/docs/en/md/VK/Product-properties-management/Create-product-property.md b/docs/en/md/VK/Product-properties-management/Create-product-property.md deleted file mode 100644 index 6f6aa57798..0000000000 --- a/docs/en/md/VK/Product-properties-management/Create-product-property.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create product property - Creates a new property for use in products - - - -`Function CreateProductProperty(Val Name, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Property name | - | 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 = "Color"; - - Result = OPI_VK.CreateProductProperty(Name, Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "property_id": 856 - } -} -``` diff --git a/docs/en/md/VK/Product-properties-management/Create-product-property.mdx b/docs/en/md/VK/Product-properties-management/Create-product-property.mdx new file mode 100644 index 0000000000..16d94b272d --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Create-product-property.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create product property + Creates a new property for use in products + + + +`Function CreateProductProperty(Val Name, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Property name | + | 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 = "Color"; + + Result = OPI_VK.CreateProductProperty(Name, Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "property_id": 856 + } +} +``` diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md deleted file mode 100644 index c36f4176eb..0000000000 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Delete product property variant - Deletes the previously created product property variant - - - -`Function DeleteProductPropertyVariant(Val Option, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Option | --option | String, Number | Variant 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(); - - Option = "2601"; - - Result = OPI_VK.DeleteProductPropertyVariant(Option, Parameters); - - OPI_TestDataRetrieval.Check_VKTrue(Result); - - OPI_Tools.Pause(5); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.mdx b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.mdx new file mode 100644 index 0000000000..c953e13b00 --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Delete product property variant + Deletes the previously created product property variant + + + +`Function DeleteProductPropertyVariant(Val Option, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Option | --option | String, Number | Variant 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(); + + Option = "2601"; + + Result = OPI_VK.DeleteProductPropertyVariant(Option, Parameters); + + OPI_TestDataRetrieval.Check_VKTrue(Result); + + OPI_Tools.Pause(5); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property.md b/docs/en/md/VK/Product-properties-management/Delete-product-property.md deleted file mode 100644 index 93816d689a..0000000000 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete product property - Deletes the existing product property - - - -`Function DeleteProductProperty(Val Property, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Property | --prop | String, Number | Property 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(); - - Property = "878"; - - Result = OPI_VK.DeleteProductProperty(Property, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 - } -``` diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property.mdx b/docs/en/md/VK/Product-properties-management/Delete-product-property.mdx new file mode 100644 index 0000000000..69611174c5 --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete product property + Deletes the existing product property + + + +`Function DeleteProductProperty(Val Property, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Property | --prop | String, Number | Property 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(); + + Property = "878"; + + Result = OPI_VK.DeleteProductProperty(Property, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 + } +``` diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md deleted file mode 100644 index 920b0cd4a0..0000000000 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Edit product property variant - Edits the value of an existing product property variant - - - -`Function EditProductPropertyVariant(Val Value, Val Property, Val Option, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Value | --value | String | New property value | - | Property | --prop | String, Number | Property ID | - | Option | --option | String, Number | Variant 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(); - - Property = "878"; - Option = "2601"; - Value = "New variant name"; - - Result = OPI_VK.EditProductPropertyVariant(Value - , Property - , Option - , Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.mdx b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.mdx new file mode 100644 index 0000000000..3880ae8ad2 --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Edit product property variant + Edits the value of an existing product property variant + + + +`Function EditProductPropertyVariant(Val Value, Val Property, Val Option, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Value | --value | String | New property value | + | Property | --prop | String, Number | Property ID | + | Option | --option | String, Number | Variant 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(); + + Property = "878"; + Option = "2601"; + Value = "New variant name"; + + Result = OPI_VK.EditProductPropertyVariant(Value + , Property + , Option + , Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property.md b/docs/en/md/VK/Product-properties-management/Edit-product-property.md deleted file mode 100644 index c1f3a79985..0000000000 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Edit product property - Edits the existing product property - - - -`Function EditProductProperty(Val Name, Val Property, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | New name | - | Property | --prop | String, Number | Property 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(); - - Name = "Color (change.)"; - Property = "878"; - - Result = OPI_VK.EditProductProperty(Name, Property, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property.mdx b/docs/en/md/VK/Product-properties-management/Edit-product-property.mdx new file mode 100644 index 0000000000..1992b2e9da --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Edit product property + Edits the existing product property + + + +`Function EditProductProperty(Val Name, Val Property, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | New name | + | Property | --prop | String, Number | Property 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(); + + Name = "Color (change.)"; + Property = "878"; + + Result = OPI_VK.EditProductProperty(Name, Property, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-properties-management/Get-property-list.md b/docs/en/md/VK/Product-properties-management/Get-property-list.md deleted file mode 100644 index 2bff3b0121..0000000000 --- a/docs/en/md/VK/Product-properties-management/Get-property-list.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get property list - Gets the list of properties of group products - - - -`Function GetPropertyList(Val Parameters = "") Export` - - | Parameter | CLI option | Type | 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(); - Result = OPI_VK.GetPropertyList(Parameters); -``` - - - - -```json title="Result" -[ - { - "id": 509, - "title": "Color (change.)", - "type": "text", - "variants": [ - { - "id": 1629, - "title": "Yellowf3f597d4-38bc-4a58-9506-01477ec7529d" - }, - { - "id": 1630, - "title": "Blue51f47ff4-81e6-4394-9b2a-acaf901f5946" - }, - { - "id": 1631, - "title": "Red00b87017-f2e8-427d-88ce-7ace6762d332" - } - ] - }, - { - "id": 549, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 1751, - "title": "Желтый494c9013-bdd8-415c-bd16-96330d63c08b" - }, - { - "id": 1752, - "title": "Синий9e94071e-9b75-4b14-9849-61a6bcdc2e8c" - }, - { - "id": 1753, - "title": "Красныйa015bcd7-1328-45c5-abab-a162a89dba95" - } - ] - }, - { - "id": 558, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 1778, - "title": "Новое имя варианта" - }, - { - "id": 1779, - "title": "Синий" - }, - { - "id": 1780, - "title": "Красный" - } - ] - }, - { - "id": 623, - "title": "Color (change.)", - "type": "text", - "variants": [ - { - "id": 1976, - "title": "New variant name" - }, - { - "id": 1977, - "title": "Blue" - }, - { - "id": 1978, - "title": "Red" - } - ] - }, - { - "id": 665, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2096, - "title": "Новое имя варианта" - }, - { - "id": 2097, - "title": "Синий" - }, - { - "id": 2098, - "title": "Красный" - } - ] - }, - { - "id": 779, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2378, - "title": "Новое имя варианта" - }, - { - "id": 2379, - "title": "Синий" - }, - { - "id": 2380, - "title": "Красный" - } - ] - }, - { - "id": 791, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2404, - "title": "Новое имя варианта" - }, - { - "id": 2405, - "title": "Синий" - }, - { - "id": 2406, - "title": "Красный" - } - ] - }, - { - "id": 844, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2531, - "title": "Новое имя варианта" - }, - { - "id": 2532, - "title": "Синий" - }, - { - "id": 2533, - "title": "Красный" -... -``` diff --git a/docs/en/md/VK/Product-properties-management/Get-property-list.mdx b/docs/en/md/VK/Product-properties-management/Get-property-list.mdx new file mode 100644 index 0000000000..ac09d20dcf --- /dev/null +++ b/docs/en/md/VK/Product-properties-management/Get-property-list.mdx @@ -0,0 +1,187 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get property list + Gets the list of properties of group products + + + +`Function GetPropertyList(Val Parameters = "") Export` + + | Parameter | CLI option | Type | 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(); + Result = OPI_VK.GetPropertyList(Parameters); +``` + + + + +```json title="Result" +[ + { + "id": 509, + "title": "Color (change.)", + "type": "text", + "variants": [ + { + "id": 1629, + "title": "Yellowf3f597d4-38bc-4a58-9506-01477ec7529d" + }, + { + "id": 1630, + "title": "Blue51f47ff4-81e6-4394-9b2a-acaf901f5946" + }, + { + "id": 1631, + "title": "Red00b87017-f2e8-427d-88ce-7ace6762d332" + } + ] + }, + { + "id": 549, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 1751, + "title": "Желтый494c9013-bdd8-415c-bd16-96330d63c08b" + }, + { + "id": 1752, + "title": "Синий9e94071e-9b75-4b14-9849-61a6bcdc2e8c" + }, + { + "id": 1753, + "title": "Красныйa015bcd7-1328-45c5-abab-a162a89dba95" + } + ] + }, + { + "id": 558, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 1778, + "title": "Новое имя варианта" + }, + { + "id": 1779, + "title": "Синий" + }, + { + "id": 1780, + "title": "Красный" + } + ] + }, + { + "id": 623, + "title": "Color (change.)", + "type": "text", + "variants": [ + { + "id": 1976, + "title": "New variant name" + }, + { + "id": 1977, + "title": "Blue" + }, + { + "id": 1978, + "title": "Red" + } + ] + }, + { + "id": 665, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2096, + "title": "Новое имя варианта" + }, + { + "id": 2097, + "title": "Синий" + }, + { + "id": 2098, + "title": "Красный" + } + ] + }, + { + "id": 779, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2378, + "title": "Новое имя варианта" + }, + { + "id": 2379, + "title": "Синий" + }, + { + "id": 2380, + "title": "Красный" + } + ] + }, + { + "id": 791, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2404, + "title": "Новое имя варианта" + }, + { + "id": 2405, + "title": "Синий" + }, + { + "id": 2406, + "title": "Красный" + } + ] + }, + { + "id": 844, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2531, + "title": "Новое имя варианта" + }, + { + "id": 2532, + "title": "Синий" + }, + { + "id": 2533, + "title": "Красный" +... +``` diff --git a/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md b/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md deleted file mode 100644 index 385a05a695..0000000000 --- a/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md +++ /dev/null @@ -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 | Description | - |-|-|-|-| - | 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" - Parameters = GetVKParameters(); - - Product = "9756133"; - Selection = "130"; - - Result = OPI_VK.AddProductToCollection(Product, Selection, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-selection-management/Add-product-to-collection.mdx b/docs/en/md/VK/Product-selection-management/Add-product-to-collection.mdx new file mode 100644 index 0000000000..76311415bc --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Add-product-to-collection.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +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 | Description | + |-|-|-|-| + | 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" + Parameters = GetVKParameters(); + + Product = "9756133"; + Selection = "130"; + + Result = OPI_VK.AddProductToCollection(Product, Selection, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-selection-management/Create-product-collection.md b/docs/en/md/VK/Product-selection-management/Create-product-collection.md deleted file mode 100644 index 4b50c961f2..0000000000 --- a/docs/en/md/VK/Product-selection-management/Create-product-collection.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create product selection - Creates an empty product selection - - - -`Function CreateProductCollection(Val Name, Val Image, Val Main = False, Val Hidden = False, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | Selection name | - | Image | --picture | String, BinaryData | Image file | - | Main | --main | Boolean | Main | - | Hidden | --hidden | Boolean | Hidden | - | 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 = "TestCollection"; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; - Main = True; - Hidden = False; - - Result = OPI_VK.CreateProductCollection(Name - , Image - , Main - , Hidden - , Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "market_album_id": 125, - "albums_count": 66 - } -} -``` diff --git a/docs/en/md/VK/Product-selection-management/Create-product-collection.mdx b/docs/en/md/VK/Product-selection-management/Create-product-collection.mdx new file mode 100644 index 0000000000..8be264c085 --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Create-product-collection.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Create product selection + Creates an empty product selection + + + +`Function CreateProductCollection(Val Name, Val Image, Val Main = False, Val Hidden = False, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | Selection name | + | Image | --picture | String, BinaryData | Image file | + | Main | --main | Boolean | Main | + | Hidden | --hidden | Boolean | Hidden | + | 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 = "TestCollection"; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; + Main = True; + Hidden = False; + + Result = OPI_VK.CreateProductCollection(Name + , Image + , Main + , Hidden + , Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "market_album_id": 125, + "albums_count": 66 + } +} +``` diff --git a/docs/en/md/VK/Product-selection-management/Delete-selection.md b/docs/en/md/VK/Product-selection-management/Delete-selection.md deleted file mode 100644 index 9293caab31..0000000000 --- a/docs/en/md/VK/Product-selection-management/Delete-selection.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Delete selection - Deletes the selection by ID - - - -`Function DeleteSelection(Val Selection, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | 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" - Parameters = GetVKParameters(); - - Selection = "125"; - - Result = OPI_VK.DeleteSelection(Selection, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-selection-management/Delete-selection.mdx b/docs/en/md/VK/Product-selection-management/Delete-selection.mdx new file mode 100644 index 0000000000..bf596511c4 --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Delete-selection.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Delete selection + Deletes the selection by ID + + + +`Function DeleteSelection(Val Selection, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | 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" + Parameters = GetVKParameters(); + + Selection = "125"; + + Result = OPI_VK.DeleteSelection(Selection, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-selection-management/Edit-product-collection.md b/docs/en/md/VK/Product-selection-management/Edit-product-collection.md deleted file mode 100644 index 7de6fadba4..0000000000 --- a/docs/en/md/VK/Product-selection-management/Edit-product-collection.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Edit product selection - Edits the properties of a product selection - - - -`Function EditProductCollection(Val Name, Val Selection, Val Image = "", Val Main = False, Val Hidden = False, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Name | --title | String | New selection name | - | Selection | --sel | String | Selection ID | - | Image | --picture | String, BinaryData | New selection image | - | Main | --main | Boolean | Main | - | Hidden | --hidden | Boolean | Hidden | - | 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 = "EditedCollection"; - Selection = "130"; - - Result = OPI_VK.EditProductCollection(Name, Selection, , , , Parameters); - - OPI_TestDataRetrieval.Check_VKTrue(Result); - - OPI_Tools.Pause(5); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-selection-management/Edit-product-collection.mdx b/docs/en/md/VK/Product-selection-management/Edit-product-collection.mdx new file mode 100644 index 0000000000..aca517d60f --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Edit-product-collection.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Edit product selection + Edits the properties of a product selection + + + +`Function EditProductCollection(Val Name, Val Selection, Val Image = "", Val Main = False, Val Hidden = False, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Name | --title | String | New selection name | + | Selection | --sel | String | Selection ID | + | Image | --picture | String, BinaryData | New selection image | + | Main | --main | Boolean | Main | + | Hidden | --hidden | Boolean | Hidden | + | 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 = "EditedCollection"; + Selection = "130"; + + Result = OPI_VK.EditProductCollection(Name, Selection, , , , Parameters); + + OPI_TestDataRetrieval.Check_VKTrue(Result); + + OPI_Tools.Pause(5); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Product-selection-management/Get-selection-list.md b/docs/en/md/VK/Product-selection-management/Get-selection-list.md deleted file mode 100644 index f93b141782..0000000000 --- a/docs/en/md/VK/Product-selection-management/Get-selection-list.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get selection list - Gets the list of product selections - - - -`Function GetSelectionList(Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Map Of KeyAndValue - Array of selection maps - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - Result = OPI_VK.GetSelectionList(Parameters); -``` - - - - -```json title="Result" -[ - { - "id": 124, - "owner_id": -218861756, - "title": "Измененная подборка", - "count": 0, - "updated_time": 1728135129, - "is_main": false, - "is_hidden": false, - "photo": { - "album_id": -53, - "date": 1728135128, - "id": 457248915, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "7519843be2e3c3cf4f", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - } - }, - { - "id": 123, - "owner_id": -218861756, - "title": "Измененная подборка", - "count": 0, - "updated_time": 1728133931, - "is_main": false, - "is_hidden": false, - "photo": { - "album_id": -53, - "date": 1728133931, - "id": 457248908, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, -... -``` diff --git a/docs/en/md/VK/Product-selection-management/Get-selection-list.mdx b/docs/en/md/VK/Product-selection-management/Get-selection-list.mdx new file mode 100644 index 0000000000..8cfd7f9277 --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Get-selection-list.mdx @@ -0,0 +1,187 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get selection list + Gets the list of product selections + + + +`Function GetSelectionList(Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Map Of KeyAndValue - Array of selection maps + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + Result = OPI_VK.GetSelectionList(Parameters); +``` + + + + +```json title="Result" +[ + { + "id": 124, + "owner_id": -218861756, + "title": "Измененная подборка", + "count": 0, + "updated_time": 1728135129, + "is_main": false, + "is_hidden": false, + "photo": { + "album_id": -53, + "date": 1728135128, + "id": 457248915, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "7519843be2e3c3cf4f", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + } + }, + { + "id": 123, + "owner_id": -218861756, + "title": "Измененная подборка", + "count": 0, + "updated_time": 1728133931, + "is_main": false, + "is_hidden": false, + "photo": { + "album_id": -53, + "date": 1728133931, + "id": 457248908, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, +... +``` diff --git a/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md b/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md deleted file mode 100644 index 0e685d1c3d..0000000000 --- a/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get selections by ID - Gets the list of selections by array of IDs - - - -`Function GetSelectionsByID(Val Selections, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Selections | --sels | String, Array of String | Selection IDs | - | 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(); - Selection = "130"; - - Result = OPI_VK.GetSelectionsByID(Selection, Parameters); -``` - - - - -```json title="Result" -{ - "response": { - "count": 1, - "items": [ - { - "id": 125, - "owner_id": -218861756, - "title": "EditedCollection", - "count": 0, - "updated_time": 1728453834, - "is_main": false, - "is_hidden": false, - "photo": { - "album_id": -53, - "date": 1728453834, - "id": 457249078, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "58dba33b94197947f7", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - } - } - ] - } -} -``` diff --git a/docs/en/md/VK/Product-selection-management/Get-selections-by-id.mdx b/docs/en/md/VK/Product-selection-management/Get-selections-by-id.mdx new file mode 100644 index 0000000000..db436f376b --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Get-selections-by-id.mdx @@ -0,0 +1,133 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get selections by ID + Gets the list of selections by array of IDs + + + +`Function GetSelectionsByID(Val Selections, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Selections | --sels | String, Array of String | Selection IDs | + | 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(); + Selection = "130"; + + Result = OPI_VK.GetSelectionsByID(Selection, Parameters); +``` + + + + +```json title="Result" +{ + "response": { + "count": 1, + "items": [ + { + "id": 125, + "owner_id": -218861756, + "title": "EditedCollection", + "count": 0, + "updated_time": 1728453834, + "is_main": false, + "is_hidden": false, + "photo": { + "album_id": -53, + "date": 1728453834, + "id": 457249078, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "58dba33b94197947f7", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-13.userapi.com/s/v1/ig2/KOvRo9GEvfnql8EgjDfJjytV9fYpcf8Z2wPPE9q8iCFWKkAPmznIR0jHrxRxoIkbr4lneZZKXwu0RG6PiLpxhCSF.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + } + } + ] + } +} +``` diff --git a/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md b/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md deleted file mode 100644 index d6edf711bd..0000000000 --- a/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Remove product from selection - Removes a previously added product from the selection - - - -`Function RemoveProductFromSelection(Val Product, Val Selection, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Product | --item | String | Product ID | - | 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" - Parameters = GetVKParameters(); - - Product = "9372711"; - Selection = "125"; - - Result = OPI_VK.RemoveProductFromSelection(Product, Selection, Parameters); -``` - - - - -```json title="Result" -{ - "response": 1 -} -``` diff --git a/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.mdx b/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.mdx new file mode 100644 index 0000000000..d035b55a61 --- /dev/null +++ b/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Remove product from selection + Removes a previously added product from the selection + + + +`Function RemoveProductFromSelection(Val Product, Val Selection, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Product | --item | String | Product ID | + | 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" + Parameters = GetVKParameters(); + + Product = "9372711"; + Selection = "125"; + + Result = OPI_VK.RemoveProductFromSelection(Product, Selection, Parameters); +``` + + + + +```json title="Result" +{ + "response": 1 +} +``` diff --git a/docs/en/md/VK/Statistics/Get-post-statistics.md b/docs/en/md/VK/Statistics/Get-post-statistics.md deleted file mode 100644 index f9a41fd2e8..0000000000 --- a/docs/en/md/VK/Statistics/Get-post-statistics.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get post statistics - Gets statistics in terms of posts - - - -`Function GetPostStatistics(Val PostIDsArray, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | PostIDsArray | --posts | Array of String,Number | Array of post IDs | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Array of Arbitrary - Array of post statistics data - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - - ArrayOfPosts = New Array; - ArrayOfPosts.Add(214); - ArrayOfPosts.Add(215); - - Result = OPI_VK.GetPostStatistics(ArrayOfPosts, Parameters); -``` - - - - -```json title="Result" -[ - { - "post_id": 214, - "hide": 0, - "join_group": 0, - "links": 0, - "reach_subscribers": 1, - "reach_total": 1, - "reach_viral": 0, - "reach_ads": 0, - "report": 0, - "to_group": 1, - "unsubscribe": 0, - "ad_views": 0, - "ad_subscribers": 0, - "ad_hide": 0, - "ad_unsubscribe": 0, - "ad_links": 0, - "ad_to_group": 0, - "ad_join_group": 0, - "ad_coverage": 0, - "ad_report": 0 - }, - { - "post_id": 215, - "hide": 0, - "join_group": 0, - "links": 0, - "reach_subscribers": 1, - "reach_total": 1, - "reach_viral": 0, - "reach_ads": 0, - "report": 0, - "to_group": 0, - "unsubscribe": 0, - "ad_views": 0, - "ad_subscribers": 0, - "ad_hide": 0, - "ad_unsubscribe": 0, - "ad_links": 0, - "ad_to_group": 0, - "ad_join_group": 0, - "ad_coverage": 0, - "ad_report": 0 - } -] -``` diff --git a/docs/en/md/VK/Statistics/Get-post-statistics.mdx b/docs/en/md/VK/Statistics/Get-post-statistics.mdx new file mode 100644 index 0000000000..9305166642 --- /dev/null +++ b/docs/en/md/VK/Statistics/Get-post-statistics.mdx @@ -0,0 +1,88 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get post statistics + Gets statistics in terms of posts + + + +`Function GetPostStatistics(Val PostIDsArray, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | PostIDsArray | --posts | Array of String,Number | Array of post IDs | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Array of Arbitrary - Array of post statistics data + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + + ArrayOfPosts = New Array; + ArrayOfPosts.Add(214); + ArrayOfPosts.Add(215); + + Result = OPI_VK.GetPostStatistics(ArrayOfPosts, Parameters); +``` + + + + +```json title="Result" +[ + { + "post_id": 214, + "hide": 0, + "join_group": 0, + "links": 0, + "reach_subscribers": 1, + "reach_total": 1, + "reach_viral": 0, + "reach_ads": 0, + "report": 0, + "to_group": 1, + "unsubscribe": 0, + "ad_views": 0, + "ad_subscribers": 0, + "ad_hide": 0, + "ad_unsubscribe": 0, + "ad_links": 0, + "ad_to_group": 0, + "ad_join_group": 0, + "ad_coverage": 0, + "ad_report": 0 + }, + { + "post_id": 215, + "hide": 0, + "join_group": 0, + "links": 0, + "reach_subscribers": 1, + "reach_total": 1, + "reach_viral": 0, + "reach_ads": 0, + "report": 0, + "to_group": 0, + "unsubscribe": 0, + "ad_views": 0, + "ad_subscribers": 0, + "ad_hide": 0, + "ad_unsubscribe": 0, + "ad_links": 0, + "ad_to_group": 0, + "ad_join_group": 0, + "ad_coverage": 0, + "ad_report": 0 + } +] +``` diff --git a/docs/en/md/VK/Statistics/Get-statistics.md b/docs/en/md/VK/Statistics/Get-statistics.md deleted file mode 100644 index b683fe7cb4..0000000000 --- a/docs/en/md/VK/Statistics/Get-statistics.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get statistics - Gets the overall community statistics for a period - - - -`Function GetStatistics(Val StartDate, Val EndDate, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | StartDate | --datefrom | Date | Start date of the period | - | EndDate | --dateto | Date | End date of the period | - | 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(); - - CurrentDate = OPI_Tools.GetCurrentDate(); - StartDate = BegOfDay(CurrentDate); - EndDate = EndOfDay(StartDate); - - Result = OPI_VK.GetStatistics(StartDate, EndDate, Parameters); -``` - - - - -```json title="Result" -{ - "response": [ - { - "activity": { - "comments": 1, - "likes": 1 - }, - "period_from": 1728432000, - "period_to": 1728518399, - "reach": { - "age": [ - { - "value": "12-18", - "count": 0 - }, - { - "value": "18-21", - "count": 0 - }, - { - "value": "21-24", - "count": 1 - }, - { - "value": "24-27", - "count": 0 - }, - { - "value": "27-30", - "count": 0 - }, - { - "value": "30-35", - "count": 0 - }, - { - "value": "35-45", - "count": 0 - }, - { - "value": "45-100", - "count": 0 - } - ], - "cities": [], - "countries": [ - { - "code": "BY", - "count": 1, - "name": "Беларусь", - "value": 3 - } - ], - "mobile_reach": 1, - "reach": 1, - "reach_subscribers": 1, - "sex": [ - { - "value": "f", - "count": 0 - }, - { - "value": "m", - "count": 1 - } - ], - "sex_age": [ - { - "value": "f;12-18", - "count": 0 - }, - { - "value": "f;18-21", - "count": 0 - }, - { - "value": "f;21-24", - "count": 0 - }, - { - "value": "f;24-27", - "count": 0 - }, - { - "value": "f;27-30", - "count": 0 - }, - { - "value": "f;30-35", - "count": 0 - }, - { - "value": "f;35-45", - "count": 0 - }, - { - "value": "f;45-100", - "count": 0 - }, - { - "value": "m;12-18", - "count": 0 - }, - { - "value": "m;18-21", - "count": 0 - }, - { - "value": "m;21-24", - "count": 1 - }, - { - "value": "m;24-27", - "count": 0 - }, - { - "value": "m;27-30", - "count": 0 - }, - { - "value": "m;30-35", - "count": 0 - }, - { - "value": "m;35-45", - "count": 0 - }, - { - "value": "m;45-100", - "count": 0 - } - ] - }, - "visitors": { - "cities": [], - "countries": [ - { - "code": "RU", - "count": 1, - "name": "Россия", - "value": 1 - } - ], - "mobile_views": 0, - "views": 1, - "visitors": 1 - } - }, - { - "activity": { -... -``` diff --git a/docs/en/md/VK/Statistics/Get-statistics.mdx b/docs/en/md/VK/Statistics/Get-statistics.mdx new file mode 100644 index 0000000000..d4b98b39a3 --- /dev/null +++ b/docs/en/md/VK/Statistics/Get-statistics.mdx @@ -0,0 +1,194 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get statistics + Gets the overall community statistics for a period + + + +`Function GetStatistics(Val StartDate, Val EndDate, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | StartDate | --datefrom | Date | Start date of the period | + | EndDate | --dateto | Date | End date of the period | + | 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(); + + CurrentDate = OPI_Tools.GetCurrentDate(); + StartDate = BegOfDay(CurrentDate); + EndDate = EndOfDay(StartDate); + + Result = OPI_VK.GetStatistics(StartDate, EndDate, Parameters); +``` + + + + +```json title="Result" +{ + "response": [ + { + "activity": { + "comments": 1, + "likes": 1 + }, + "period_from": 1728432000, + "period_to": 1728518399, + "reach": { + "age": [ + { + "value": "12-18", + "count": 0 + }, + { + "value": "18-21", + "count": 0 + }, + { + "value": "21-24", + "count": 1 + }, + { + "value": "24-27", + "count": 0 + }, + { + "value": "27-30", + "count": 0 + }, + { + "value": "30-35", + "count": 0 + }, + { + "value": "35-45", + "count": 0 + }, + { + "value": "45-100", + "count": 0 + } + ], + "cities": [], + "countries": [ + { + "code": "BY", + "count": 1, + "name": "Беларусь", + "value": 3 + } + ], + "mobile_reach": 1, + "reach": 1, + "reach_subscribers": 1, + "sex": [ + { + "value": "f", + "count": 0 + }, + { + "value": "m", + "count": 1 + } + ], + "sex_age": [ + { + "value": "f;12-18", + "count": 0 + }, + { + "value": "f;18-21", + "count": 0 + }, + { + "value": "f;21-24", + "count": 0 + }, + { + "value": "f;24-27", + "count": 0 + }, + { + "value": "f;27-30", + "count": 0 + }, + { + "value": "f;30-35", + "count": 0 + }, + { + "value": "f;35-45", + "count": 0 + }, + { + "value": "f;45-100", + "count": 0 + }, + { + "value": "m;12-18", + "count": 0 + }, + { + "value": "m;18-21", + "count": 0 + }, + { + "value": "m;21-24", + "count": 1 + }, + { + "value": "m;24-27", + "count": 0 + }, + { + "value": "m;27-30", + "count": 0 + }, + { + "value": "m;30-35", + "count": 0 + }, + { + "value": "m;35-45", + "count": 0 + }, + { + "value": "m;45-100", + "count": 0 + } + ] + }, + "visitors": { + "cities": [], + "countries": [ + { + "code": "RU", + "count": 1, + "name": "Россия", + "value": 1 + } + ], + "mobile_views": 0, + "views": 1, + "visitors": 1 + } + }, + { + "activity": { +... +``` diff --git a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md deleted file mode 100644 index aaf6e826d2..0000000000 --- a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create token retrieval link -Getting a link for interactive token retrieval (access_token), which is necessary for further actions - - - -`Function CreateTokenRetrievalLink(Val App_id) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | app_id | --app | String, Number | app_id from application settings | - - - Returns: String - URL to go to in the browser - -
- - - - -```bsl title="Code example" - Application = "51694790"; - Result = OPI_VK.CreateTokenRetrievalLink(Application); -``` - - - - -```json title="Result" -"https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" -``` diff --git a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.mdx b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.mdx new file mode 100644 index 0000000000..367e78eee0 --- /dev/null +++ b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.mdx @@ -0,0 +1,37 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Create token retrieval link +Getting a link for interactive token retrieval (access_token), which is necessary for further actions + + + +`Function CreateTokenRetrievalLink(Val App_id) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | app_id | --app | String, Number | app_id from application settings | + + + Returns: String - URL to go to in the browser + +
+ + + + +```bsl title="Code example" + Application = "51694790"; + Result = OPI_VK.CreateTokenRetrievalLink(Application); +``` + + + + +```json title="Result" +"https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" +``` diff --git a/docs/en/md/VKTeams/Chat-management/Approve-pending.md b/docs/en/md/VKTeams/Chat-management/Approve-pending.md deleted file mode 100644 index 76c840bb72..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Approve-pending.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Approve pending - Confirms the user's request to join a private chat room - - - -`Function ApprovePending(Val Token, Val ChatID, Val UserID = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | UserID | --userid | String, Number | User ID. For all active requests if not filled in | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - User = 1011987091; - - Result = OPI_VKTeams.ApprovePending(Token, ChatID, User); - - Result = OPI_VKTeams.ApprovePending(Token, ChatID); -``` - - - - -```json title="Result" -{ - "ok": false, - "description": "User is not pending or nobody in pending list" -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Approve-pending.mdx b/docs/en/md/VKTeams/Chat-management/Approve-pending.mdx new file mode 100644 index 0000000000..fc461fa66f --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Approve-pending.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Approve pending + Confirms the user's request to join a private chat room + + + +`Function ApprovePending(Val Token, Val ChatID, Val UserID = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | UserID | --userid | String, Number | User ID. For all active requests if not filled in | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + User = 1011987091; + + Result = OPI_VKTeams.ApprovePending(Token, ChatID, User); + + Result = OPI_VKTeams.ApprovePending(Token, ChatID); +``` + + + + +```json title="Result" +{ + "ok": false, + "description": "User is not pending or nobody in pending list" +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Block-chat-user.md b/docs/en/md/VKTeams/Chat-management/Block-chat-user.md deleted file mode 100644 index 64011ee795..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Block-chat-user.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Block chat user - Blocks the selected user in chat - - - -`Function BlockChatUser(Val Token, Val ChatID, Val UserID, Val DeleteLastMessages = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | UserID | --userid | String, Number | User ID to be blocked | - | DeleteLastMessages | --dellast | Boolean | Delete last messages before blocking | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats​/blockUser](https://teams.vk.com/botapi/#/chats/get_chats_blockUser) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - User = 1011987091; - - Result = OPI_VKTeams.BlockChatUser(Token, ChatID, User, True); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Block-chat-user.mdx b/docs/en/md/VKTeams/Chat-management/Block-chat-user.mdx new file mode 100644 index 0000000000..571b3f63c3 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Block-chat-user.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Block chat user + Blocks the selected user in chat + + + +`Function BlockChatUser(Val Token, Val ChatID, Val UserID, Val DeleteLastMessages = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | UserID | --userid | String, Number | User ID to be blocked | + | DeleteLastMessages | --dellast | Boolean | Delete last messages before blocking | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats​/blockUser](https://teams.vk.com/botapi/#/chats/get_chats_blockUser) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + User = 1011987091; + + Result = OPI_VKTeams.BlockChatUser(Token, ChatID, User, True); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Change-chat-picture.md b/docs/en/md/VKTeams/Chat-management/Change-chat-picture.md deleted file mode 100644 index 702c071fdf..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Change-chat-picture.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Change chat picture - Changes the chat avatar picture - - - -`Function ChangeChatPicture(Val Token, Val ChatID, Val File) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | File | --file | BinaryData, String | Image file | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [POST ​/chats​/avatar​/set](https://teams.vk.com/botapi/#/chats/post_chats_avatar_set) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - - File = "https://api.athenaeum.digital/test_data/spy2.png"; // URL - FilePath = GetTempFileName("png"); // Path - - CopyFile(File, FilePath); - - FileBD = New BinaryData(FilePath); // Binary - - Result = OPI_VKTeams.ChangeChatPicture(Token, ChatID, File); - - Result = OPI_VKTeams.ChangeChatPicture(Token, ChatID, FilePath); - - Result = OPI_VKTeams.ChangeChatPicture(Token, ChatID, FileBD); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Change-chat-picture.mdx b/docs/en/md/VKTeams/Chat-management/Change-chat-picture.mdx new file mode 100644 index 0000000000..c66ac50493 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Change-chat-picture.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Change chat picture + Changes the chat avatar picture + + + +`Function ChangeChatPicture(Val Token, Val ChatID, Val File) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | File | --file | BinaryData, String | Image file | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [POST ​/chats​/avatar​/set](https://teams.vk.com/botapi/#/chats/post_chats_avatar_set) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + + File = "https://api.athenaeum.digital/test_data/spy2.png"; // URL + FilePath = GetTempFileName("png"); // Path + + CopyFile(File, FilePath); + + FileBD = New BinaryData(FilePath); // Binary + + Result = OPI_VKTeams.ChangeChatPicture(Token, ChatID, File); + + Result = OPI_VKTeams.ChangeChatPicture(Token, ChatID, FilePath); + + Result = OPI_VKTeams.ChangeChatPicture(Token, ChatID, FileBD); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Disapprove-pending.md b/docs/en/md/VKTeams/Chat-management/Disapprove-pending.md deleted file mode 100644 index fc11253397..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Disapprove-pending.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Disapprove pending - Rejects the user's request to join a private chat room - - - -`Function DisapprovePending(Val Token, Val ChatID, Val UserID = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | UserID | --userid | String, Number | User ID. For all active requests if not filled in | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - User = 1011987091; - - Result = OPI_VKTeams.DisapprovePending(Token, ChatID, User); - - Result = OPI_VKTeams.DisapprovePending(Token, ChatID); -``` - - - - -```json title="Result" -{ - "ok": false, - "description": "User is not pending or nobody in pending list" -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Disapprove-pending.mdx b/docs/en/md/VKTeams/Chat-management/Disapprove-pending.mdx new file mode 100644 index 0000000000..0a1fd6ace0 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Disapprove-pending.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Disapprove pending + Rejects the user's request to join a private chat room + + + +`Function DisapprovePending(Val Token, Val ChatID, Val UserID = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | UserID | --userid | String, Number | User ID. For all active requests if not filled in | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + User = 1011987091; + + Result = OPI_VKTeams.DisapprovePending(Token, ChatID, User); + + Result = OPI_VKTeams.DisapprovePending(Token, ChatID); +``` + + + + +```json title="Result" +{ + "ok": false, + "description": "User is not pending or nobody in pending list" +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-admins.md b/docs/en/md/VKTeams/Chat-management/Get-chat-admins.md deleted file mode 100644 index 5b7683848c..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Get-chat-admins.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get chat admins - Gets the list of chat administrators - - - -`Function GetChatAdmins(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /chats/getAdmins](https://teams.vk.com/botapi/#/chats/get_chats_getAdmins) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - - Result = OPI_VKTeams.GetChatAdmins(Token, ChatID); -``` - - - - -```json title="Result" -{ - "admins": [ - { - "userId": "1011893356" - }, - { - "creator": true, - "userId": "bayselonarrend@openintegrations.bizml.ru" - } - ], - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-admins.mdx b/docs/en/md/VKTeams/Chat-management/Get-chat-admins.mdx new file mode 100644 index 0000000000..e8d021b965 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Get-chat-admins.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get chat admins + Gets the list of chat administrators + + + +`Function GetChatAdmins(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /chats/getAdmins](https://teams.vk.com/botapi/#/chats/get_chats_getAdmins) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + + Result = OPI_VKTeams.GetChatAdmins(Token, ChatID); +``` + + + + +```json title="Result" +{ + "admins": [ + { + "userId": "1011893356" + }, + { + "creator": true, + "userId": "bayselonarrend@openintegrations.bizml.ru" + } + ], + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.md b/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.md deleted file mode 100644 index ded12e1210..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get chat blocked users - Gets the list of blocked chat users - - - -`Function GetChatBlockedUsers(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​/chats​/getBlockedUsers](https://teams.vk.com/botapi/#/chats/get_chats_getBlockedUsers) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - - Result = OPI_VKTeams.GetChatBlockedUsers(Token, ChatID); -``` - - - - -```json title="Result" -{ - "users": [], - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.mdx b/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.mdx new file mode 100644 index 0000000000..0df44eabe8 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get chat blocked users + Gets the list of blocked chat users + + + +`Function GetChatBlockedUsers(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​/chats​/getBlockedUsers](https://teams.vk.com/botapi/#/chats/get_chats_getBlockedUsers) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + + Result = OPI_VKTeams.GetChatBlockedUsers(Token, ChatID); +``` + + + + +```json title="Result" +{ + "users": [], + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-info.md b/docs/en/md/VKTeams/Chat-management/Get-chat-info.md deleted file mode 100644 index 02f2f8177d..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Get-chat-info.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get information about the chat room - Gets basic information about the chat - - - -`Function GetChatInfo(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /chats/getInfo](https://teams.vk.com/botapi/#/chats/get_chats_getInfo) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - - Result = OPI_VKTeams.GetChatInfo(Token, ChatID); -``` - - - - -```json title="Result" -{ - "inviteLink": "https://icq.com/chat/AoLI0egLWBSLR1Ngn2w", - "joinModeration": false, - "public": false, - "rules": "Это новые правила из CLI", - "title": "Тест2", - "type": "group", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-info.mdx b/docs/en/md/VKTeams/Chat-management/Get-chat-info.mdx new file mode 100644 index 0000000000..4014786621 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Get-chat-info.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get information about the chat room + Gets basic information about the chat + + + +`Function GetChatInfo(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /chats/getInfo](https://teams.vk.com/botapi/#/chats/get_chats_getInfo) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + + Result = OPI_VKTeams.GetChatInfo(Token, ChatID); +``` + + + + +```json title="Result" +{ + "inviteLink": "https://icq.com/chat/AoLI0egLWBSLR1Ngn2w", + "joinModeration": false, + "public": false, + "rules": "Это новые правила из CLI", + "title": "Тест2", + "type": "group", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-join-requests.md b/docs/en/md/VKTeams/Chat-management/Get-chat-join-requests.md deleted file mode 100644 index d1f0d55404..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Get-chat-join-requests.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Get chat join requests - Gets a list of requests to join the chat room - - - -`Function GetChatJoinRequests(Val Token, Val ChatID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats​/getPendingUsers](https://teams.vk.com/botapi/#/chats/get_chats_getPendingUsers) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - - Result = OPI_VKTeams.GetChatJoinRequests(Token, ChatID); -``` - - - - -```json title="Result" -{ - "users": [], - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-join-requests.mdx b/docs/en/md/VKTeams/Chat-management/Get-chat-join-requests.mdx new file mode 100644 index 0000000000..1c932b658c --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Get-chat-join-requests.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Get chat join requests + Gets a list of requests to join the chat room + + + +`Function GetChatJoinRequests(Val Token, Val ChatID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats​/getPendingUsers](https://teams.vk.com/botapi/#/chats/get_chats_getPendingUsers) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + + Result = OPI_VKTeams.GetChatJoinRequests(Token, ChatID); +``` + + + + +```json title="Result" +{ + "users": [], + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-members.md b/docs/en/md/VKTeams/Chat-management/Get-chat-members.md deleted file mode 100644 index 4ac903c264..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Get-chat-members.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get chat members - Gets the list of chat members - - - -`Function GetChatMembers(Val Token, Val ChatID, Val Cursor = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | Cursor | --cursor | String | Next page marker from the previous request | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /chats/getMembers](https://teams.vk.com/botapi/#/chats/get_chats_getMembers) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - - Result = OPI_VKTeams.GetChatMembers(Token, ChatID); -``` - - - - -```json title="Result" -{ - "members": [ - { - "admin": true, - "userId": "1011893356" - }, - { - "creator": true, - "userId": "bayselonarrend@openintegrations.bizml.ru" - }, - { - "userId": "1011987091" - } - ], - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Get-chat-members.mdx b/docs/en/md/VKTeams/Chat-management/Get-chat-members.mdx new file mode 100644 index 0000000000..ebc72ac376 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Get-chat-members.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get chat members + Gets the list of chat members + + + +`Function GetChatMembers(Val Token, Val ChatID, Val Cursor = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | Cursor | --cursor | String | Next page marker from the previous request | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /chats/getMembers](https://teams.vk.com/botapi/#/chats/get_chats_getMembers) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + + Result = OPI_VKTeams.GetChatMembers(Token, ChatID); +``` + + + + +```json title="Result" +{ + "members": [ + { + "admin": true, + "userId": "1011893356" + }, + { + "creator": true, + "userId": "bayselonarrend@openintegrations.bizml.ru" + }, + { + "userId": "1011987091" + } + ], + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md b/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md deleted file mode 100644 index 412b09bd54..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Remove chat members - Removes users from the chat - - - -`Function RemoveChatMembers(Val Token, Val ChatID, Val Users) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | Users | --members | String, Number, Array of String, Number | The member or members of the chat room to remove | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - User = 1011987091; - - Result = OPI_VKTeams.RemoveChatMembers(Token, ChatID, User); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Remove-chat-members.mdx b/docs/en/md/VKTeams/Chat-management/Remove-chat-members.mdx new file mode 100644 index 0000000000..0ff9312a58 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Remove-chat-members.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Remove chat members + Removes users from the chat + + + +`Function RemoveChatMembers(Val Token, Val ChatID, Val Users) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | Users | --members | String, Number, Array of String, Number | The member or members of the chat room to remove | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + User = 1011987091; + + Result = OPI_VKTeams.RemoveChatMembers(Token, ChatID, User); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Set-chat-description.md b/docs/en/md/VKTeams/Chat-management/Set-chat-description.md deleted file mode 100644 index 48e10a588e..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Set-chat-description.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Set chat description - Sets new chat description - - - -`Function SetChatDescription(Val Token, Val ChatID, Val Text) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | Text | --text | String | Description text | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats/setAbout](https://teams.vk.com/botapi/#/chats/get_chats_setAbout) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - Text = "New description"; - - Result = OPI_VKTeams.SetChatDescription(Token, ChatID, Text); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Set-chat-description.mdx b/docs/en/md/VKTeams/Chat-management/Set-chat-description.mdx new file mode 100644 index 0000000000..44840e1e55 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Set-chat-description.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Set chat description + Sets new chat description + + + +`Function SetChatDescription(Val Token, Val ChatID, Val Text) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | Text | --text | String | Description text | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats/setAbout](https://teams.vk.com/botapi/#/chats/get_chats_setAbout) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + Text = "New description"; + + Result = OPI_VKTeams.SetChatDescription(Token, ChatID, Text); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Set-chat-rules.md b/docs/en/md/VKTeams/Chat-management/Set-chat-rules.md deleted file mode 100644 index 6890a15ff4..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Set-chat-rules.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Set chat rules - Sets new chat rules - - - -`Function SetChatRules(Val Token, Val ChatID, Val Text) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | Text | --text | String | Rules Text | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET /chats/setRules](https://teams.vk.com/botapi/#/chats/get_chats_setRules) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - Text = "Text of the new rules"; - - Result = OPI_VKTeams.SetChatRules(Token, ChatID, Text); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Set-chat-rules.mdx b/docs/en/md/VKTeams/Chat-management/Set-chat-rules.mdx new file mode 100644 index 0000000000..2de48ea7dd --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Set-chat-rules.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Set chat rules + Sets new chat rules + + + +`Function SetChatRules(Val Token, Val ChatID, Val Text) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | Text | --text | String | Rules Text | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET /chats/setRules](https://teams.vk.com/botapi/#/chats/get_chats_setRules) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + Text = "Text of the new rules"; + + Result = OPI_VKTeams.SetChatRules(Token, ChatID, Text); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Set-chat-title.md b/docs/en/md/VKTeams/Chat-management/Set-chat-title.md deleted file mode 100644 index 421af76407..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Set-chat-title.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Set chat title - Sets new chat title - - - -`Function SetChatTitle(Val Token, Val ChatID, Val Text) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | Text | --text | String | Title text | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats/setTitle](https://teams.vk.com/botapi/#/chats/get_chats_setTitle) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - Text = "New title"; - - Result = OPI_VKTeams.SetChatTitle(Token, ChatID, Text); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Set-chat-title.mdx b/docs/en/md/VKTeams/Chat-management/Set-chat-title.mdx new file mode 100644 index 0000000000..f583f30e65 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Set-chat-title.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Set chat title + Sets new chat title + + + +`Function SetChatTitle(Val Token, Val ChatID, Val Text) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | Text | --text | String | Title text | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats/setTitle](https://teams.vk.com/botapi/#/chats/get_chats_setTitle) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + Text = "New title"; + + Result = OPI_VKTeams.SetChatTitle(Token, ChatID, Text); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Chat-management/Unblock-chat-user.md b/docs/en/md/VKTeams/Chat-management/Unblock-chat-user.md deleted file mode 100644 index ad7f6e3cf2..0000000000 --- a/docs/en/md/VKTeams/Chat-management/Unblock-chat-user.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Unblock chat user - Unblocks a previously blocked user in the chat room - - - -`Function UnblockChatUser(Val Token, Val ChatID, Val UserID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | UserID | --userid | String, Number | User ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room. - - Method at API documentation: [GET ​​/chats/unblockUser](https://teams.vk.com/botapi/#/chats/get_chats_unblockUser) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - User = 1011987091; - - Result = OPI_VKTeams.UnblockChatUser(Token, ChatID, User); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Chat-management/Unblock-chat-user.mdx b/docs/en/md/VKTeams/Chat-management/Unblock-chat-user.mdx new file mode 100644 index 0000000000..155de23027 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Unblock-chat-user.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Unblock chat user + Unblocks a previously blocked user in the chat room + + + +`Function UnblockChatUser(Val Token, Val ChatID, Val UserID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | UserID | --userid | String, Number | User ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room. + + Method at API documentation: [GET ​​/chats/unblockUser](https://teams.vk.com/botapi/#/chats/get_chats_unblockUser) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + User = 1011987091; + + Result = OPI_VKTeams.UnblockChatUser(Token, ChatID, User); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Common-methods/Check-token.md b/docs/en/md/VKTeams/Common-methods/Check-token.md deleted file mode 100644 index b7fcdacd68..0000000000 --- a/docs/en/md/VKTeams/Common-methods/Check-token.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Check token - Checks if the bot token is functional - - - -`Function CheckToken(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - Result = OPI_VKTeams.CheckToken(Token); -``` - - - - -```json title="Result" -{ - "userId": "1011893356", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Common-methods/Check-token.mdx b/docs/en/md/VKTeams/Common-methods/Check-token.mdx new file mode 100644 index 0000000000..fad459064c --- /dev/null +++ b/docs/en/md/VKTeams/Common-methods/Check-token.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Check token + Checks if the bot token is functional + + + +`Function CheckToken(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + Result = OPI_VKTeams.CheckToken(Token); +``` + + + + +```json title="Result" +{ + "userId": "1011893356", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Common-methods/Get-events.md b/docs/en/md/VKTeams/Common-methods/Get-events.md deleted file mode 100644 index 847fc2ec88..0000000000 --- a/docs/en/md/VKTeams/Common-methods/Get-events.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get events - Receives bot events in Polling mode - - - -`Function GetEvents(Val Token, Val LastID, Val Timeout = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | LastID | --last | String, Number | ID of the last event processed before this event | - | Timeout | --timeout | String, Number | Connection hold time for Long Polling | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - LastID = 0; - - For N = 1 To 5 Do // In real work - endless loop - - Result = OPI_VKTeams.GetEvents(Token, LastID, 3); - - Events = Result["events"]; - - // Event handling... - - If Not Events.Count() = 0 Then - - LastID = Events[Events.UBound()]["eventId"]; - - EndIf; - - EndDo; -``` - - - - -```json title="Result" -{ - "events": [], - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Common-methods/Get-events.mdx b/docs/en/md/VKTeams/Common-methods/Get-events.mdx new file mode 100644 index 0000000000..231d872e8d --- /dev/null +++ b/docs/en/md/VKTeams/Common-methods/Get-events.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get events + Receives bot events in Polling mode + + + +`Function GetEvents(Val Token, Val LastID, Val Timeout = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | LastID | --last | String, Number | ID of the last event processed before this event | + | Timeout | --timeout | String, Number | Connection hold time for Long Polling | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + LastID = 0; + + For N = 1 To 5 Do // In real work - endless loop + + Result = OPI_VKTeams.GetEvents(Token, LastID, 3); + + Events = Result["events"]; + + // Event handling... + + If Not Events.Count() = 0 Then + + LastID = Events[Events.UBound()]["eventId"]; + + EndIf; + + EndDo; +``` + + + + +```json title="Result" +{ + "events": [], + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Common-methods/Get-file-information.md b/docs/en/md/VKTeams/Common-methods/Get-file-information.md deleted file mode 100644 index 53b8e53d83..0000000000 --- a/docs/en/md/VKTeams/Common-methods/Get-file-information.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get information about file - Gets information about a file by ID - - - -`Function GetFileInformation(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String, Number | File ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - FileID = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; - - Result = OPI_VKTeams.GetFileInformation(Token, FileID); -``` - - - - -```json title="Result" -{ - "filename": "ImportantDocument.docx", - "size": 24071, - "type": "application", - "url": "https://ub.icq.net/files/get/UevBEtxoDvTP9STM9cQIqD3cQIsU2jgGpNtxbSBlFdSiwSsu7INUFnIi7yRznGcZOvYiRHvmcGjlSRRIBSLheI78aN9IU8MS2Gcl8eGiMBiIii9BTFH1d8iCYIsl8bhIP5PnwS47uAEIC9JZb18v40xImk9cQI/ImportantDocument.docx", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Common-methods/Get-file-information.mdx b/docs/en/md/VKTeams/Common-methods/Get-file-information.mdx new file mode 100644 index 0000000000..32644bce12 --- /dev/null +++ b/docs/en/md/VKTeams/Common-methods/Get-file-information.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get information about file + Gets information about a file by ID + + + +`Function GetFileInformation(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String, Number | File ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + FileID = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; + + Result = OPI_VKTeams.GetFileInformation(Token, FileID); +``` + + + + +```json title="Result" +{ + "filename": "ImportantDocument.docx", + "size": 24071, + "type": "application", + "url": "https://ub.icq.net/files/get/UevBEtxoDvTP9STM9cQIqD3cQIsU2jgGpNtxbSBlFdSiwSsu7INUFnIi7yRznGcZOvYiRHvmcGjlSRRIBSLheI78aN9IU8MS2Gcl8eGiMBiIii9BTFH1d8iCYIsl8bhIP5PnwS47uAEIC9JZb18v40xImk9cQI/ImportantDocument.docx", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Answer-button-event.md b/docs/en/md/VKTeams/Message-sending/Answer-button-event.md deleted file mode 100644 index 8f0fb8f05b..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Answer-button-event.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Answer button event - Returns a response to the user when a keyboard button is pressed - - - -`Function AnswerButtonEvent(Val Token, Val EventID, Val Text = "", Val URL = "", Val AsAlert = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | EventID | --queryid | String | Identifier of the callback query received by the bot | - | Text | --text | String | Answer text | - | URL | --url | String | URL to be opened by the client application | - | AsAlert | --showalert | Boolean | Display the answer as an alert) | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -This method call should be used in response to receiving a callbackQuery event - - Method at API documentation: [GET /messages/answerCallbackQuery](https://teams.vk.com/botapi/#/messages/get_messages_answerCallbackQuery) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - LastID = 0; - - For N = 1 To 5 Do - - Result = OPI_VKTeams.GetEvents(Token, LastID, 3); - Events = Result["events"]; - - If Not Events.Count() = 0 Then - - For Each Event In Events Do - - callbackData = Event["payload"]; - - If callbackData["callbackData"] = "ButtonEvent1" Then - - EventID = callbackData["queryId"]; - Result = OPI_VKTeams.AnswerButtonEvent(Token, EventID, "Get it!"); - - EndIf; - - EndDo; - - LastID = Events[Events.UBound()]["eventId"]; - - EndIf; - - EndDo; -``` - - - - -```json title="Result" - -``` diff --git a/docs/en/md/VKTeams/Message-sending/Answer-button-event.mdx b/docs/en/md/VKTeams/Message-sending/Answer-button-event.mdx new file mode 100644 index 0000000000..684577b096 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Answer-button-event.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Answer button event + Returns a response to the user when a keyboard button is pressed + + + +`Function AnswerButtonEvent(Val Token, Val EventID, Val Text = "", Val URL = "", Val AsAlert = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | EventID | --queryid | String | Identifier of the callback query received by the bot | + | Text | --text | String | Answer text | + | URL | --url | String | URL to be opened by the client application | + | AsAlert | --showalert | Boolean | Display the answer as an alert) | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +This method call should be used in response to receiving a callbackQuery event + + Method at API documentation: [GET /messages/answerCallbackQuery](https://teams.vk.com/botapi/#/messages/get_messages_answerCallbackQuery) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + LastID = 0; + + For N = 1 To 5 Do + + Result = OPI_VKTeams.GetEvents(Token, LastID, 3); + Events = Result["events"]; + + If Not Events.Count() = 0 Then + + For Each Event In Events Do + + callbackData = Event["payload"]; + + If callbackData["callbackData"] = "ButtonEvent1" Then + + EventID = callbackData["queryId"]; + Result = OPI_VKTeams.AnswerButtonEvent(Token, EventID, "Get it!"); + + EndIf; + + EndDo; + + LastID = Events[Events.UBound()]["eventId"]; + + EndIf; + + EndDo; +``` + + + + +```json title="Result" + +``` diff --git a/docs/en/md/VKTeams/Message-sending/Delete-message.md b/docs/en/md/VKTeams/Message-sending/Delete-message.md deleted file mode 100644 index 42bf0788e6..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Delete-message.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Delete message - Deletes a message by ID - - - -`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | MessageID | --messageid | String, Number | Message ID for editing | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - MessageID = "7425684917876428136"; - - Result = OPI_VKTeams.DeleteMessage(Token, ChatID, MessageID); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Delete-message.mdx b/docs/en/md/VKTeams/Message-sending/Delete-message.mdx new file mode 100644 index 0000000000..7d54d085dd --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Delete-message.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Delete message + Deletes a message by ID + + + +`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | MessageID | --messageid | String, Number | Message ID for editing | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + MessageID = "7425684917876428136"; + + Result = OPI_VKTeams.DeleteMessage(Token, ChatID, MessageID); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Edit-message-text.md b/docs/en/md/VKTeams/Message-sending/Edit-message-text.md deleted file mode 100644 index b0c02ccbea..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Edit-message-text.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Change the message text - Changes the text of an existing message - - - -`Function EditMessageText(Val Token, Val ChatID, Val MessageID, Val Text, Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | MessageID | --messageid | String, Number | Message ID for editing | - | Text | --text | String | New message text | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -You can mention a user by appending their userId to the text in the following format @[userId] - - Method at API documentation: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - MessageID = "7425684917876428136"; - Text = "New message text"; - - Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text); - - Text = "New bold message text"; - Markup = "HTML"; - - Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text, Markup); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Edit-message-text.mdx b/docs/en/md/VKTeams/Message-sending/Edit-message-text.mdx new file mode 100644 index 0000000000..da81058bd6 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Edit-message-text.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Change the message text + Changes the text of an existing message + + + +`Function EditMessageText(Val Token, Val ChatID, Val MessageID, Val Text, Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | MessageID | --messageid | String, Number | Message ID for editing | + | Text | --text | String | New message text | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +You can mention a user by appending their userId to the text in the following format @[userId] + + Method at API documentation: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + MessageID = "7425684917876428136"; + Text = "New message text"; + + Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text); + + Text = "New bold message text"; + Markup = "HTML"; + + Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text, Markup); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Forward-message.md b/docs/en/md/VKTeams/Message-sending/Forward-message.md deleted file mode 100644 index eafc3ba8a1..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Forward-message.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Forward message - Forwards an existing message to the current dialog box - - - -`Function ForwardMessage(Val Token, Val MessageID, Val FromChatID, Val ChatID, Val Text = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | MessageID | --messageid | String, Number | Original message ID | - | FromChatID | --fromid | String, Number | Source chat ID | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | Text | --text | String | Additional message text | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Only the chatId from events can be passed to the FromChatID (the code from the chat link is not suitable)) - - Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - FromChatID = "689203963@chat.agent"; - MessageID = "7425684917876428136"; - - Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID); - - Text = "Additional text"; - - Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID, Text); -``` - - - - -```json title="Result" -{ - "msgId": "7423657667542911288", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Forward-message.mdx b/docs/en/md/VKTeams/Message-sending/Forward-message.mdx new file mode 100644 index 0000000000..e037cd3f79 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Forward-message.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Forward message + Forwards an existing message to the current dialog box + + + +`Function ForwardMessage(Val Token, Val MessageID, Val FromChatID, Val ChatID, Val Text = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | MessageID | --messageid | String, Number | Original message ID | + | FromChatID | --fromid | String, Number | Source chat ID | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | Text | --text | String | Additional message text | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Only the chatId from events can be passed to the FromChatID (the code from the chat link is not suitable)) + + Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + FromChatID = "689203963@chat.agent"; + MessageID = "7425684917876428136"; + + Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID); + + Text = "Additional text"; + + Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID, Text); +``` + + + + +```json title="Result" +{ + "msgId": "7423657667542911288", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Make-action-button.md b/docs/en/md/VKTeams/Message-sending/Make-action-button.md deleted file mode 100644 index 712a4a720a..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Make-action-button.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Make action button - Forms an action button for the message keyboard (see SendTextMessage) - - - -`Function MakeActionButton(Val Text, Val Value = "", Val URL = "", Val Style = "base") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Text | --text | String | Button text | - | Value | --data | String | The value returned in the event. Only if the URL is not filled | - | URL | --url | String | URL to create the page open button. Only if the Value is not filled in | - | Style | --style | String | Button style: primary, attention or base | - - - Returns: Structure - Button for keyboard - -
- - - - -```bsl title="Code example" - Keyboard = New Array; - ButtonsLineArray = New Array; - - ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button1", "ButtonEvent1", , "attention")); - - ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button2", , "https://openintegrations.dev")); - - Keyboard.Add(ButtonsLineArray); - Keyboard.Add(ButtonsLineArray); -``` - - - - -```json title="Result" -[ - [ - { - "text": "Button1", - "callbackData": "ButtonEvent1", - "style": "attention" - }, - { - "text": "Button2", - "url": "https://openintegrations.dev", - "style": "base" - } - ], - [ - { - "text": "Button1", - "callbackData": "ButtonEvent1", - "style": "attention" - }, - { - "text": "Button2", - "url": "https://openintegrations.dev", - "style": "base" - } - ] -] -``` diff --git a/docs/en/md/VKTeams/Message-sending/Make-action-button.mdx b/docs/en/md/VKTeams/Message-sending/Make-action-button.mdx new file mode 100644 index 0000000000..ec137cbf66 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Make-action-button.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Make action button + Forms an action button for the message keyboard (see SendTextMessage) + + + +`Function MakeActionButton(Val Text, Val Value = "", Val URL = "", Val Style = "base") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Text | --text | String | Button text | + | Value | --data | String | The value returned in the event. Only if the URL is not filled | + | URL | --url | String | URL to create the page open button. Only if the Value is not filled in | + | Style | --style | String | Button style: primary, attention or base | + + + Returns: Structure - Button for keyboard + +
+ + + + +```bsl title="Code example" + Keyboard = New Array; + ButtonsLineArray = New Array; + + ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button1", "ButtonEvent1", , "attention")); + + ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button2", , "https://openintegrations.dev")); + + Keyboard.Add(ButtonsLineArray); + Keyboard.Add(ButtonsLineArray); +``` + + + + +```json title="Result" +[ + [ + { + "text": "Button1", + "callbackData": "ButtonEvent1", + "style": "attention" + }, + { + "text": "Button2", + "url": "https://openintegrations.dev", + "style": "base" + } + ], + [ + { + "text": "Button1", + "callbackData": "ButtonEvent1", + "style": "attention" + }, + { + "text": "Button2", + "url": "https://openintegrations.dev", + "style": "base" + } + ] +] +``` diff --git a/docs/en/md/VKTeams/Message-sending/Pin-message.md b/docs/en/md/VKTeams/Message-sending/Pin-message.md deleted file mode 100644 index a608ceb04e..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Pin-message.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Pin message - Pins the selected message in the chat room - - - -`Function PinMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | MessageID | --messageid | String, Number | ID of the message to be pinned | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room - - Method at API documentation: [GET /chats/pinMessage](https://teams.vk.com/botapi/#/chats/get_chats_pinMessage) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - MessageID = "7425684917876428136"; - - Result = OPI_VKTeams.PinMessage(Token, ChatID, MessageID); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Pin-message.mdx b/docs/en/md/VKTeams/Message-sending/Pin-message.mdx new file mode 100644 index 0000000000..11993a806c --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Pin-message.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Pin message + Pins the selected message in the chat room + + + +`Function PinMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | MessageID | --messageid | String, Number | ID of the message to be pinned | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room + + Method at API documentation: [GET /chats/pinMessage](https://teams.vk.com/botapi/#/chats/get_chats_pinMessage) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + MessageID = "7425684917876428136"; + + Result = OPI_VKTeams.PinMessage(Token, ChatID, MessageID); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Resend-file.md b/docs/en/md/VKTeams/Message-sending/Resend-file.md deleted file mode 100644 index 38a9606ebd..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Resend-file.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Resend file - Sends a previously uploaded file by ID - - - -`Function ResendFile(Val Token, Val ChatID, Val FileID, Val Text = "", Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | FileID | --fileid | String, Number | File ID to send | - | Text | --text | String | File caption | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - FileID = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; - Text = "File caption"; - - Result = OPI_VKTeams.ResendFile(Token, ChatID, FileID, Text); -``` - - - - -```json title="Result" -{ - "fileId": "UevBE3dRlqHftBiESLglDn670621531bd", - "msgId": "7423657697607682364", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Resend-file.mdx b/docs/en/md/VKTeams/Message-sending/Resend-file.mdx new file mode 100644 index 0000000000..7059a00e48 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Resend-file.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Resend file + Sends a previously uploaded file by ID + + + +`Function ResendFile(Val Token, Val ChatID, Val FileID, Val Text = "", Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | FileID | --fileid | String, Number | File ID to send | + | Text | --text | String | File caption | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + FileID = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; + Text = "File caption"; + + Result = OPI_VKTeams.ResendFile(Token, ChatID, FileID, Text); +``` + + + + +```json title="Result" +{ + "fileId": "UevBE3dRlqHftBiESLglDn670621531bd", + "msgId": "7423657697607682364", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Resend-voice.md b/docs/en/md/VKTeams/Message-sending/Resend-voice.md deleted file mode 100644 index 4d0bc77cb6..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Resend-voice.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Resend voice - Sends a previously uploaded voice message by ID - - - -`Function ResendVoice(Val Token, Val ChatID, Val FileID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | FileID | --fileid | String, Number | File ID of voice message | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - FileID = "I000bzdU0pRaLPRFQ42mv6670d55531bd"; - - Result = OPI_VKTeams.ResendVoice(Token, ChatID, FileID); -``` - - - - -```json title="Result" -{ - "fileId": "I000bPC37Th9syNcxyaG4r670621651bd", - "msgId": "7423657774917093693", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Resend-voice.mdx b/docs/en/md/VKTeams/Message-sending/Resend-voice.mdx new file mode 100644 index 0000000000..354c33ed76 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Resend-voice.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Resend voice + Sends a previously uploaded voice message by ID + + + +`Function ResendVoice(Val Token, Val ChatID, Val FileID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | FileID | --fileid | String, Number | File ID of voice message | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + FileID = "I000bzdU0pRaLPRFQ42mv6670d55531bd"; + + Result = OPI_VKTeams.ResendVoice(Token, ChatID, FileID); +``` + + + + +```json title="Result" +{ + "fileId": "I000bPC37Th9syNcxyaG4r670621651bd", + "msgId": "7423657774917093693", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Send-file.md b/docs/en/md/VKTeams/Message-sending/Send-file.md deleted file mode 100644 index 225f0826a7..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Send-file.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Send file - Sends the file to the chat - - - -`Function SendFile(Val Token, Val ChatID, Val File, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | File | --file | BinaryData, String | File for sending | - | Text | --text | String | File caption | - | FileName | --filename | String | Displayed file name | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - Text = "File caption"; - - File = "https://api.athenaeum.digital/test_data/document.docx"; // URL - FilePath = GetTempFileName("docx"); // Path - - CopyFile(File, FilePath); - - FileBD = New BinaryData(FilePath); // Binary - - Result = OPI_VKTeams.SendFile(Token, ChatID, File); - - Result = OPI_VKTeams.SendFile(Token, ChatID, FilePath, Text); - - Result = OPI_VKTeams.SendFile(Token, ChatID, FileBD, Text, "ImportantDocument.docx"); -``` - - - - -```json title="Result" -{ - "fileId": "UevBE3dRlqHftBiESLglDn670621531bd", - "msgId": "7423657676132845883", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Send-file.mdx b/docs/en/md/VKTeams/Message-sending/Send-file.mdx new file mode 100644 index 0000000000..76e8a8eb92 --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Send-file.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Send file + Sends the file to the chat + + + +`Function SendFile(Val Token, Val ChatID, Val File, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | File | --file | BinaryData, String | File for sending | + | Text | --text | String | File caption | + | FileName | --filename | String | Displayed file name | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + Text = "File caption"; + + File = "https://api.athenaeum.digital/test_data/document.docx"; // URL + FilePath = GetTempFileName("docx"); // Path + + CopyFile(File, FilePath); + + FileBD = New BinaryData(FilePath); // Binary + + Result = OPI_VKTeams.SendFile(Token, ChatID, File); + + Result = OPI_VKTeams.SendFile(Token, ChatID, FilePath, Text); + + Result = OPI_VKTeams.SendFile(Token, ChatID, FileBD, Text, "ImportantDocument.docx"); +``` + + + + +```json title="Result" +{ + "fileId": "UevBE3dRlqHftBiESLglDn670621531bd", + "msgId": "7423657676132845883", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Send-text-message.md b/docs/en/md/VKTeams/Message-sending/Send-text-message.md deleted file mode 100644 index d1f004056d..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Send-text-message.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Send text message - Sends a text message to a chat - - - -`Function SendTextMessage(Val Token, Val ChatID, Val Text, Val ReplyID = 0, Val Keyboard = "", Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | Text | --text | String | Message text | - | ReplyID | --reply | String, Number | Replying message id if necessary | - | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -You can mention a user by appending their userId to the text in the following format @[userId] - - Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - Text = "Message text"; - - Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text); - - ChatID = "689203963@chat.agent"; - ReplyID = "7425684917876428136"; - Text = "Bold text"; - Markup = "HTML"; - - Keyboard = New Array; - ButtonsLineArray = New Array; - - ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button1", "ButtonEvent1", , "attention")); - - ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button2", , "https://openintegrations.dev")); - - Keyboard.Add(ButtonsLineArray); - Keyboard.Add(ButtonsLineArray); - - Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text, ReplyID, Keyboard, Markup); -``` - - - - -```json title="Result" -{ - "msgId": "7423657487154285625", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Send-text-message.mdx b/docs/en/md/VKTeams/Message-sending/Send-text-message.mdx new file mode 100644 index 0000000000..47a902a9dd --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Send-text-message.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Send text message + Sends a text message to a chat + + + +`Function SendTextMessage(Val Token, Val ChatID, Val Text, Val ReplyID = 0, Val Keyboard = "", Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | Text | --text | String | Message text | + | ReplyID | --reply | String, Number | Replying message id if necessary | + | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +You can mention a user by appending their userId to the text in the following format @[userId] + + Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + Text = "Message text"; + + Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text); + + ChatID = "689203963@chat.agent"; + ReplyID = "7425684917876428136"; + Text = "Bold text"; + Markup = "HTML"; + + Keyboard = New Array; + ButtonsLineArray = New Array; + + ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button1", "ButtonEvent1", , "attention")); + + ButtonsLineArray.Add(OPI_VKTeams.MakeActionButton("Button2", , "https://openintegrations.dev")); + + Keyboard.Add(ButtonsLineArray); + Keyboard.Add(ButtonsLineArray); + + Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text, ReplyID, Keyboard, Markup); +``` + + + + +```json title="Result" +{ + "msgId": "7423657487154285625", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Send-voice.md b/docs/en/md/VKTeams/Message-sending/Send-voice.md deleted file mode 100644 index 80bc88ed2f..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Send-voice.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Send voice - Sends an audio file as a voice message - - - -`Function SendVoice(Val Token, Val ChatID, Val File, Val FileType = "m4a", Val ReplyID = 0, Val Keyboard = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | File | --file | BinaryData, String | File for sending | - | FileType | --type | String | Audio type: aac, ogg or m4a | - | ReplyID | --reply | String, Number | Replying message id if necessary | - | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -If you want the client to display this file as a playable voice message, it must be in aac, ogg, or m4a format - - Method at API documentation: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - ReplyID = "7425684917876428136"; - - File = "https://api.athenaeum.digital/test_data/song.m4a" ; // URL - FilePath = GetTempFileName("m4a"); // Path - - CopyFile(File, FilePath); - - FileBD = New BinaryData(FilePath); // Binary - - Result = OPI_VKTeams.SendVoice(Token, ChatID, File); - - Result = OPI_VKTeams.SendVoice(Token, ChatID, FilePath, ,ReplyID); - - Result = OPI_VKTeams.SendVoice(Token, ChatID, FileBD); -``` - - - - -```json title="Result" -{ - "fileId": "I000bPC37Th9syNcxyaG4r670621651bd", - "msgId": "7423657753442257991", - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Send-voice.mdx b/docs/en/md/VKTeams/Message-sending/Send-voice.mdx new file mode 100644 index 0000000000..158113ec8e --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Send-voice.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Send voice + Sends an audio file as a voice message + + + +`Function SendVoice(Val Token, Val ChatID, Val File, Val FileType = "m4a", Val ReplyID = 0, Val Keyboard = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | File | --file | BinaryData, String | File for sending | + | FileType | --type | String | Audio type: aac, ogg or m4a | + | ReplyID | --reply | String, Number | Replying message id if necessary | + | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +If you want the client to display this file as a playable voice message, it must be in aac, ogg, or m4a format + + Method at API documentation: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + ReplyID = "7425684917876428136"; + + File = "https://api.athenaeum.digital/test_data/song.m4a" ; // URL + FilePath = GetTempFileName("m4a"); // Path + + CopyFile(File, FilePath); + + FileBD = New BinaryData(FilePath); // Binary + + Result = OPI_VKTeams.SendVoice(Token, ChatID, File); + + Result = OPI_VKTeams.SendVoice(Token, ChatID, FilePath, ,ReplyID); + + Result = OPI_VKTeams.SendVoice(Token, ChatID, FileBD); +``` + + + + +```json title="Result" +{ + "fileId": "I000bPC37Th9syNcxyaG4r670621651bd", + "msgId": "7423657753442257991", + "ok": true +} +``` diff --git a/docs/en/md/VKTeams/Message-sending/Unpin-message.md b/docs/en/md/VKTeams/Message-sending/Unpin-message.md deleted file mode 100644 index 55c2eed2f3..0000000000 --- a/docs/en/md/VKTeams/Message-sending/Unpin-message.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Unpin message - Unpins a previously pinned chat message - - - -`Function UnpinMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID | - | MessageID | --messageid | String, Number | ID of the message to be unpinned | - - - Returns: Map Of KeyAndValue - serialized JSON response from VK Teams - -
- -:::tip -To call this method, the bot must be an administrator in the chat room - - Method at API documentation: [GET /chats/unpinMessage](https://teams.vk.com/botapi/#/chats/get_chats_unpinMessage) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - MessageID = "7425684917876428136"; - - Result = OPI_VKTeams.UnpinMessage(Token, ChatID, MessageID); -``` - - - - -```json title="Result" -{ - "ok": true -} -``` diff --git a/docs/en/md/VKTeams/Message-sending/Unpin-message.mdx b/docs/en/md/VKTeams/Message-sending/Unpin-message.mdx new file mode 100644 index 0000000000..7084406b5d --- /dev/null +++ b/docs/en/md/VKTeams/Message-sending/Unpin-message.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Unpin message + Unpins a previously pinned chat message + + + +`Function UnpinMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | MessageID | --messageid | String, Number | ID of the message to be unpinned | + + + Returns: Map Of KeyAndValue - serialized JSON response from VK Teams + +
+ +:::tip +To call this method, the bot must be an administrator in the chat room + + Method at API documentation: [GET /chats/unpinMessage](https://teams.vk.com/botapi/#/chats/get_chats_unpinMessage) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + MessageID = "7425684917876428136"; + + Result = OPI_VKTeams.UnpinMessage(Token, ChatID, MessageID); +``` + + + + +```json title="Result" +{ + "ok": true +} +``` diff --git a/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md b/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md deleted file mode 100644 index ae5c175d80..0000000000 --- a/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Create a keyboard from an array of buttons - Returns a keyboard structure for messages - - - -`Function CreateKeyboardFromArrayButton(Val ButtonArray, Val ButtonColor = "#2db9b9") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | ButtonArray | --buttons | Array of String | Array of buttons | - | ButtonColor | --color | String | HEX color of buttons with # at the beginning | - - - Returns: Structure - Create a keyboard from an array of buttons: - - -
- - - - -```bsl title="Code example" - ButtonArray = New Array; - ButtonArray.Add("Button 1"); - ButtonArray.Add("Button 2"); - ButtonArray.Add("Button 3"); - - Result = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); -``` - - - - -```json title="Result" -{ - "Buttons": [ - { - "ActionType": "reply", - "ActionBody": "Button 1", - "Text": "Button 1", - "BgColor": "#2db9b9", - "Coloumns": 3 - }, - { - "ActionType": "reply", - "ActionBody": "Button 2", - "Text": "Button 2", - "BgColor": "#2db9b9", - "Coloumns": 3 - }, - { - "ActionType": "reply", - "ActionBody": "Button 3", - "Text": "Button 3", - "BgColor": "#2db9b9", - "Coloumns": 3 - } - ], - "Type": "keyboard" -} -``` diff --git a/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.mdx b/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.mdx new file mode 100644 index 0000000000..682b7f3e4f --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Create a keyboard from an array of buttons + Returns a keyboard structure for messages + + + +`Function CreateKeyboardFromArrayButton(Val ButtonArray, Val ButtonColor = "#2db9b9") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | ButtonArray | --buttons | Array of String | Array of buttons | + | ButtonColor | --color | String | HEX color of buttons with # at the beginning | + + + Returns: Structure - Create a keyboard from an array of buttons: + + +
+ + + + +```bsl title="Code example" + ButtonArray = New Array; + ButtonArray.Add("Button 1"); + ButtonArray.Add("Button 2"); + ButtonArray.Add("Button 3"); + + Result = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); +``` + + + + +```json title="Result" +{ + "Buttons": [ + { + "ActionType": "reply", + "ActionBody": "Button 1", + "Text": "Button 1", + "BgColor": "#2db9b9", + "Coloumns": 3 + }, + { + "ActionType": "reply", + "ActionBody": "Button 2", + "Text": "Button 2", + "BgColor": "#2db9b9", + "Coloumns": 3 + }, + { + "ActionType": "reply", + "ActionBody": "Button 3", + "Text": "Button 3", + "BgColor": "#2db9b9", + "Coloumns": 3 + } + ], + "Type": "keyboard" +} +``` diff --git a/docs/en/md/Viber/Message-sending/Send-contact.md b/docs/en/md/Viber/Message-sending/Send-contact.md deleted file mode 100644 index 8bf37b1aac..0000000000 --- a/docs/en/md/Viber/Message-sending/Send-contact.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Send contact - Sends a contact with a phone number to a chat or channel - - - -`Function SendContact(Val Token, Val ContactName, Val PhoneNumber, Val UserID, Val SendingToChannel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | ContactName | --name | String | Contact name | - | PhoneNumber | --phone | String | Phone number | - | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | - | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Name = "Petr Petrov"; - Phone = "+123456789"; - - UserID = "d3jxe61Z4W73nmNkjYGgZg=="; - Token = "523b5b25ed27e6ec-fdf013e4..."; - SendingToChannel = False; - - Result = OPI_Viber.SendContact(Token, Name, Phone, UserID, SendingToChannel); - - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - Token = "523b58ba82afffaa-7ef3b426..."; - SendingToChannel = True; - - Result = OPI_Viber.SendContact(Token, Name, Phone, UserID, SendingToChannel); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024682590964173394, - "chat_hostname": "SN-CHAT-03_", - "billing_status": 3 -} -``` diff --git a/docs/en/md/Viber/Message-sending/Send-contact.mdx b/docs/en/md/Viber/Message-sending/Send-contact.mdx new file mode 100644 index 0000000000..2a0aed38e1 --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Send-contact.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Send contact + Sends a contact with a phone number to a chat or channel + + + +`Function SendContact(Val Token, Val ContactName, Val PhoneNumber, Val UserID, Val SendingToChannel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | ContactName | --name | String | Contact name | + | PhoneNumber | --phone | String | Phone number | + | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | + | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Name = "Petr Petrov"; + Phone = "+123456789"; + + UserID = "d3jxe61Z4W73nmNkjYGgZg=="; + Token = "523b5b25ed27e6ec-fdf013e4..."; + SendingToChannel = False; + + Result = OPI_Viber.SendContact(Token, Name, Phone, UserID, SendingToChannel); + + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + Token = "523b58ba82afffaa-7ef3b426..."; + SendingToChannel = True; + + Result = OPI_Viber.SendContact(Token, Name, Phone, UserID, SendingToChannel); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024682590964173394, + "chat_hostname": "SN-CHAT-03_", + "billing_status": 3 +} +``` diff --git a/docs/en/md/Viber/Message-sending/Send-file.md b/docs/en/md/Viber/Message-sending/Send-file.md deleted file mode 100644 index 552e175c9a..0000000000 --- a/docs/en/md/Viber/Message-sending/Send-file.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Send file - Sends a file (document) to a chat or channel - - - -`Function SendFile(Val Token, Val URL, Val UserID, Val SendingToChannel, Val Extension, Val Size = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --file | String | File URL | - | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | - | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | - | Extension | --ext | String | File extension | - | Size | --size | Number | File size. If not filled in > determined automatically by downloading the file | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Extension = "docx"; - URL = "https://api.athenaeum.digital/test_data/document.docx"; - - UserID = "d3jxe61Z4W73nmNkjYGgZg=="; - Token = "523b5b25ed27e6ec-fdf013e4..."; - SendingToChannel = False; - - Result = OPI_Viber.SendFile(Token, URL, UserID, SendingToChannel, Extension); - - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - Token = "523b58ba82afffaa-7ef3b426..."; - SendingToChannel = True; - - Result = OPI_Viber.SendFile(Token, URL, UserID, SendingToChannel, Extension); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024682567270547758, - "chat_hostname": "SN-CHAT-01_", - "billing_status": 3 -} -``` diff --git a/docs/en/md/Viber/Message-sending/Send-file.mdx b/docs/en/md/Viber/Message-sending/Send-file.mdx new file mode 100644 index 0000000000..acf7cf7560 --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Send-file.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Send file + Sends a file (document) to a chat or channel + + + +`Function SendFile(Val Token, Val URL, Val UserID, Val SendingToChannel, Val Extension, Val Size = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --file | String | File URL | + | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | + | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | + | Extension | --ext | String | File extension | + | Size | --size | Number | File size. If not filled in > determined automatically by downloading the file | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Extension = "docx"; + URL = "https://api.athenaeum.digital/test_data/document.docx"; + + UserID = "d3jxe61Z4W73nmNkjYGgZg=="; + Token = "523b5b25ed27e6ec-fdf013e4..."; + SendingToChannel = False; + + Result = OPI_Viber.SendFile(Token, URL, UserID, SendingToChannel, Extension); + + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + Token = "523b58ba82afffaa-7ef3b426..."; + SendingToChannel = True; + + Result = OPI_Viber.SendFile(Token, URL, UserID, SendingToChannel, Extension); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024682567270547758, + "chat_hostname": "SN-CHAT-01_", + "billing_status": 3 +} +``` diff --git a/docs/en/md/Viber/Message-sending/Send-image.md b/docs/en/md/Viber/Message-sending/Send-image.md deleted file mode 100644 index 74e82ad652..0000000000 --- a/docs/en/md/Viber/Message-sending/Send-image.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Send image - Sends an image to a chat or channel - - - -`Function SendImage(Val Token, Val URL, Val UserID, Val SendingToChannel, Val Description = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --picture | String | Image URL | - | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | - | SendingToChannel | --ischannel | boolean | Sending to channel or bot chat | - | Description | --description | String | Image annotation | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Description = "TestMessage"; - URL = "https://api.athenaeum.digital/test_data/picture.jpg"; - - UserID = "d3jxe61Z4W73nmNkjYGgZg=="; - Token = "523b5b25ed27e6ec-fdf013e4..."; - SendingToChannel = False; - - Result = OPI_Viber.SendImage(Token, URL, UserID, SendingToChannel, Description); - - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - Token = "523b58ba82afffaa-7ef3b426..."; - SendingToChannel = True; - - Result = OPI_Viber.SendImage(Token, URL, UserID, SendingToChannel, Description); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024682541026790805, - "chat_hostname": "SN-CHAT-04_", - "billing_status": 3 -} -``` diff --git a/docs/en/md/Viber/Message-sending/Send-image.mdx b/docs/en/md/Viber/Message-sending/Send-image.mdx new file mode 100644 index 0000000000..1fb5069e80 --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Send-image.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Send image + Sends an image to a chat or channel + + + +`Function SendImage(Val Token, Val URL, Val UserID, Val SendingToChannel, Val Description = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --picture | String | Image URL | + | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | + | SendingToChannel | --ischannel | boolean | Sending to channel or bot chat | + | Description | --description | String | Image annotation | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Description = "TestMessage"; + URL = "https://api.athenaeum.digital/test_data/picture.jpg"; + + UserID = "d3jxe61Z4W73nmNkjYGgZg=="; + Token = "523b5b25ed27e6ec-fdf013e4..."; + SendingToChannel = False; + + Result = OPI_Viber.SendImage(Token, URL, UserID, SendingToChannel, Description); + + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + Token = "523b58ba82afffaa-7ef3b426..."; + SendingToChannel = True; + + Result = OPI_Viber.SendImage(Token, URL, UserID, SendingToChannel, Description); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024682541026790805, + "chat_hostname": "SN-CHAT-04_", + "billing_status": 3 +} +``` diff --git a/docs/en/md/Viber/Message-sending/Send-link.md b/docs/en/md/Viber/Message-sending/Send-link.md deleted file mode 100644 index 69d2de6566..0000000000 --- a/docs/en/md/Viber/Message-sending/Send-link.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Send link - Sends a URL with a preview to a chat or channel - - - -`Function SendLink(Val Token, Val URL, Val UserID, Val SendingToChannel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --url | String | SentLink | - | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | - | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - UserID = "d3jxe61Z4W73nmNkjYGgZg=="; - Token = "523b5b25ed27e6ec-fdf013e4..."; - SendingToChannel = False; - - Result = OPI_Viber.SendLink(Token, URL, UserID, SendingToChannel); - - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - Token = "523b58ba82afffaa-7ef3b426..."; - SendingToChannel = True; - - Result = OPI_Viber.SendLink(Token, URL, UserID, SendingToChannel); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024682655669700844, - "chat_hostname": "SN-CHAT-03_", - "billing_status": 3 -} -``` diff --git a/docs/en/md/Viber/Message-sending/Send-link.mdx b/docs/en/md/Viber/Message-sending/Send-link.mdx new file mode 100644 index 0000000000..30c667a219 --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Send-link.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Send link + Sends a URL with a preview to a chat or channel + + + +`Function SendLink(Val Token, Val URL, Val UserID, Val SendingToChannel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --url | String | SentLink | + | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | + | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + UserID = "d3jxe61Z4W73nmNkjYGgZg=="; + Token = "523b5b25ed27e6ec-fdf013e4..."; + SendingToChannel = False; + + Result = OPI_Viber.SendLink(Token, URL, UserID, SendingToChannel); + + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + Token = "523b58ba82afffaa-7ef3b426..."; + SendingToChannel = True; + + Result = OPI_Viber.SendLink(Token, URL, UserID, SendingToChannel); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024682655669700844, + "chat_hostname": "SN-CHAT-03_", + "billing_status": 3 +} +``` diff --git a/docs/en/md/Viber/Message-sending/Send-location.md b/docs/en/md/Viber/Message-sending/Send-location.md deleted file mode 100644 index d8c6b7d903..0000000000 --- a/docs/en/md/Viber/Message-sending/Send-location.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Send location - Sends geographic coordinates to a chat or channel - - - -`Function SendLocation(Val Token, Val Latitude, Val Longitude, Val UserID, Val SendingToChannel) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Latitude | --lat | String, Number | Geographic latitude | - | Longitude | --long | String, Number | Geographic longitude | - | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | - | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Latitude = "48.87373649724122"; - Longitude = "2.2954639195323967"; - - UserID = "d3jxe61Z4W73nmNkjYGgZg=="; - Token = "523b5b25ed27e6ec-fdf013e4..."; - SendingToChannel = False; - - Result = OPI_Viber.SendLocation(Token, Latitude, Longitude, UserID, SendingToChannel); - - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - Token = "523b58ba82afffaa-7ef3b426..."; - SendingToChannel = True; - - Result = OPI_Viber.SendLocation(Token, Latitude, Longitude, UserID, SendingToChannel); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024682614229977927, - "chat_hostname": "SN-CHAT-03_", - "billing_status": 3 -} -``` diff --git a/docs/en/md/Viber/Message-sending/Send-location.mdx b/docs/en/md/Viber/Message-sending/Send-location.mdx new file mode 100644 index 0000000000..3160fb3ef4 --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Send-location.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Send location + Sends geographic coordinates to a chat or channel + + + +`Function SendLocation(Val Token, Val Latitude, Val Longitude, Val UserID, Val SendingToChannel) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Latitude | --lat | String, Number | Geographic latitude | + | Longitude | --long | String, Number | Geographic longitude | + | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | + | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Latitude = "48.87373649724122"; + Longitude = "2.2954639195323967"; + + UserID = "d3jxe61Z4W73nmNkjYGgZg=="; + Token = "523b5b25ed27e6ec-fdf013e4..."; + SendingToChannel = False; + + Result = OPI_Viber.SendLocation(Token, Latitude, Longitude, UserID, SendingToChannel); + + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + Token = "523b58ba82afffaa-7ef3b426..."; + SendingToChannel = True; + + Result = OPI_Viber.SendLocation(Token, Latitude, Longitude, UserID, SendingToChannel); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024682614229977927, + "chat_hostname": "SN-CHAT-03_", + "billing_status": 3 +} +``` diff --git a/docs/en/md/Viber/Message-sending/Send-text-message.md b/docs/en/md/Viber/Message-sending/Send-text-message.md deleted file mode 100644 index 3b1d74bd82..0000000000 --- a/docs/en/md/Viber/Message-sending/Send-text-message.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Send text message - Sends a text message to a chat or channel - - - -`Function SendTextMessage(Val Token, Val Text, Val UserID, Val SendingToChannel, Val Keyboard = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Text | --text | String | Message text | - | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | - | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | - | Keyboard | --keyboard | Structure Of String | See CreateKeyboardFromArrayButton | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Text = "TestMessage"; - - UserID = "d3jxe61Z4W73nmNkjYGgZg=="; - Token = "523b5b25ed27e6ec-fdf013e4..."; - SendingToChannel = False; - - ButtonArray = New Array; - ButtonArray.Add("Button 1"); - ButtonArray.Add("Button 2"); - ButtonArray.Add("Button 3"); - - Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); - - Result = OPI_Viber.SendTextMessage(Token, Text, UserID, SendingToChannel, Keyboard); - - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - Token = "523b58ba82afffaa-7ef3b426..."; - SendingToChannel = True; - - Result = OPI_Viber.SendTextMessage(Token, Text, UserID, SendingToChannel, Keyboard); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024682517702263447, - "chat_hostname": "SN-CHAT-01_", - "billing_status": 3 -} -``` diff --git a/docs/en/md/Viber/Message-sending/Send-text-message.mdx b/docs/en/md/Viber/Message-sending/Send-text-message.mdx new file mode 100644 index 0000000000..573475ae58 --- /dev/null +++ b/docs/en/md/Viber/Message-sending/Send-text-message.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Send text message + Sends a text message to a chat or channel + + + +`Function SendTextMessage(Val Token, Val Text, Val UserID, Val SendingToChannel, Val Keyboard = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Text | --text | String | Message text | + | UserID | --user | String, Number | User ID. For channel > administrator, for bot > recipient | + | SendingToChannel | --ischannel | Boolean | Sending to channel or bot chat | + | Keyboard | --keyboard | Structure Of String | See CreateKeyboardFromArrayButton | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Text = "TestMessage"; + + UserID = "d3jxe61Z4W73nmNkjYGgZg=="; + Token = "523b5b25ed27e6ec-fdf013e4..."; + SendingToChannel = False; + + ButtonArray = New Array; + ButtonArray.Add("Button 1"); + ButtonArray.Add("Button 2"); + ButtonArray.Add("Button 3"); + + Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); + + Result = OPI_Viber.SendTextMessage(Token, Text, UserID, SendingToChannel, Keyboard); + + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + Token = "523b58ba82afffaa-7ef3b426..."; + SendingToChannel = True; + + Result = OPI_Viber.SendTextMessage(Token, Text, UserID, SendingToChannel, Keyboard); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024682517702263447, + "chat_hostname": "SN-CHAT-01_", + "billing_status": 3 +} +``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-channel-information.md b/docs/en/md/Viber/Settings-and-information/Get-channel-information.md deleted file mode 100644 index a134fa96d6..0000000000 --- a/docs/en/md/Viber/Settings-and-information/Get-channel-information.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Get channel information -Here you can get the channel's user IDs. Bot IDs need to be obtained from the Webhook arrivals The user ID from channel information is not suitable for sending messages through the bot - they are different - - - -`Function GetChannelInformation(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Token = "523b58ba82afffaa-7ef3b426..."; - Result = OPI_Viber.GetChannelInformation(Token); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "id": "pa:5925427292815753130", - "chat_hostname": "SN-CHAT-08_", - "name": "1C Test", - "members": [ - { - "id": "tMNGhftyUPrB3r1lD+bT4g==", - "name": "John", - "role": "superadmin" - } - ] -} -``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-channel-information.mdx b/docs/en/md/Viber/Settings-and-information/Get-channel-information.mdx new file mode 100644 index 0000000000..2c7ef8ad0a --- /dev/null +++ b/docs/en/md/Viber/Settings-and-information/Get-channel-information.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Get channel information +Here you can get the channel's user IDs. Bot IDs need to be obtained from the Webhook arrivals The user ID from channel information is not suitable for sending messages through the bot - they are different + + + +`Function GetChannelInformation(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Token = "523b58ba82afffaa-7ef3b426..."; + Result = OPI_Viber.GetChannelInformation(Token); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "id": "pa:5925427292815753130", + "chat_hostname": "SN-CHAT-08_", + "name": "1C Test", + "members": [ + { + "id": "tMNGhftyUPrB3r1lD+bT4g==", + "name": "John", + "role": "superadmin" + } + ] +} +``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-online-users.md b/docs/en/md/Viber/Settings-and-information/Get-online-users.md deleted file mode 100644 index 8f6362e826..0000000000 --- a/docs/en/md/Viber/Settings-and-information/Get-online-users.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get online users - Gets the status of a user or multiple users by ID - - - -`Function GetOnlineUsers(Val Token, Val UserIDs) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Viber Token | - | UserIDs | --users | String,Number,Array of String,Number | Viber User(s) ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Token = "523b58ba82afffaa-7ef3b426..."; - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - - Result = OPI_Viber.GetOnlineUsers(Token, UserID); -``` - - - - -```json title="Result" -{ - "status": 0, - "status_message": "ok", - "users": [ - { - "id": "tMNGhftyUPrB3r1lD+bT4g==", - "online_status": 4, - "online_status_message": "unavailable", - "last_online": 0 - } - ] -} -``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-online-users.mdx b/docs/en/md/Viber/Settings-and-information/Get-online-users.mdx new file mode 100644 index 0000000000..85c0b8dfd6 --- /dev/null +++ b/docs/en/md/Viber/Settings-and-information/Get-online-users.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get online users + Gets the status of a user or multiple users by ID + + + +`Function GetOnlineUsers(Val Token, Val UserIDs) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Viber Token | + | UserIDs | --users | String,Number,Array of String,Number | Viber User(s) ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Token = "523b58ba82afffaa-7ef3b426..."; + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + + Result = OPI_Viber.GetOnlineUsers(Token, UserID); +``` + + + + +```json title="Result" +{ + "status": 0, + "status_message": "ok", + "users": [ + { + "id": "tMNGhftyUPrB3r1lD+bT4g==", + "online_status": 4, + "online_status_message": "unavailable", + "last_online": 0 + } + ] +} +``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-user-data.md b/docs/en/md/Viber/Settings-and-information/Get-user-data.md deleted file mode 100644 index e429a3f6d4..0000000000 --- a/docs/en/md/Viber/Settings-and-information/Get-user-data.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get user data - Gets user information by ID - - - -`Function GetUserData(Val Token, Val UserID) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | UserID | --user | String, Number | Viber User ID | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Token = "523b58ba82afffaa-7ef3b426..."; - UserID = "tMNGhftyUPrB3r1lD+bT4g=="; - - Result = OPI_Viber.GetUserData(Token, UserID); -``` - - - - -```json title="Result" -{ - "status": 6, - "status_message": "notSubscribed", - "chat_hostname": "SN-CHAT-04_" -} -``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-user-data.mdx b/docs/en/md/Viber/Settings-and-information/Get-user-data.mdx new file mode 100644 index 0000000000..729dfe3049 --- /dev/null +++ b/docs/en/md/Viber/Settings-and-information/Get-user-data.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get user data + Gets user information by ID + + + +`Function GetUserData(Val Token, Val UserID) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | UserID | --user | String, Number | Viber User ID | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Token = "523b58ba82afffaa-7ef3b426..."; + UserID = "tMNGhftyUPrB3r1lD+bT4g=="; + + Result = OPI_Viber.GetUserData(Token, UserID); +``` + + + + +```json title="Result" +{ + "status": 6, + "status_message": "notSubscribed", + "chat_hostname": "SN-CHAT-04_" +} +``` diff --git a/docs/en/md/Viber/Settings-and-information/Set-webhook.md b/docs/en/md/Viber/Settings-and-information/Set-webhook.md deleted file mode 100644 index 73310d89bb..0000000000 --- a/docs/en/md/Viber/Settings-and-information/Set-webhook.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Set Webhook -IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to have a free URL for this., which will return 200 and a genuine SSL certificate. If there is a certificate and the database is published on the server - you can use an HTTP service. Information about new messages will also be sent there Viber periodically knocks on the Webhook address, so if it is inactive, everything will stop working - - - -`Function SetWebhook(Val Token, Val URL) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Viber Token | - | URL | --url | String | URL for setting up Webhook | - - - Returns: Map Of KeyAndValue - serialized JSON response from Viber - -
- - - - -```bsl title="Code example" - Token = "523b58ba82afffaa-7ef3b426..."; - URL = "http://api.athenaeum.digital/hs/viber"; - - Result = OPI_Viber.SetWebhook(Token, URL); -``` - - - - -```json title="Result" -{ - "status": 1, - "status_message": "URL not valid or not HTTPS", - "chat_hostname": "SN-CHAT-03_" -} -``` diff --git a/docs/en/md/Viber/Settings-and-information/Set-webhook.mdx b/docs/en/md/Viber/Settings-and-information/Set-webhook.mdx new file mode 100644 index 0000000000..359dc2d1da --- /dev/null +++ b/docs/en/md/Viber/Settings-and-information/Set-webhook.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Set Webhook +IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to have a free URL for this., which will return 200 and a genuine SSL certificate. If there is a certificate and the database is published on the server - you can use an HTTP service. Information about new messages will also be sent there Viber periodically knocks on the Webhook address, so if it is inactive, everything will stop working + + + +`Function SetWebhook(Val Token, Val URL) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Viber Token | + | URL | --url | String | URL for setting up Webhook | + + + Returns: Map Of KeyAndValue - serialized JSON response from Viber + +
+ + + + +```bsl title="Code example" + Token = "523b58ba82afffaa-7ef3b426..."; + URL = "http://api.athenaeum.digital/hs/viber"; + + Result = OPI_Viber.SetWebhook(Token, URL); +``` + + + + +```json title="Result" +{ + "status": 1, + "status_message": "URL not valid or not HTTPS", + "chat_hostname": "SN-CHAT-03_" +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md deleted file mode 100644 index c0d46985d3..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create folder - Creates a directory on the disk - - - -`Function CreateFolder(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the created folder | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/" + String(New UUID); - - Result = OPI_YandexDisk.CreateFolder(Token, Path); -``` - - - - -```json title="Result" -{ - "_embedded": { - "sort": "", - "items": [], - "limit": 20, - "offset": 0, - "path": "disk:/81da8ff8-4975-43d1-aebc-dbffba560d71", - "total": 0 - }, - "name": "81da8ff8-4975-43d1-aebc-dbffba560d71", - "exif": {}, - "resource_id": "1573541518:f9053a23fcfa0c3d45a2c95c14f9afe70c7954cdbb35c58bf2f16a61ed289880", - "created": "2024-10-09T09:07:49+03:00", - "modified": "2024-10-09T09:07:49+03:00", - "path": "disk:/81da8ff8-4975-43d1-aebc-dbffba560d71", - "comment_ids": { - "private_resource": "1573541518:f9053a23fcfa0c3d45a2c95c14f9afe70c7954cdbb35c58bf2f16a61ed289880", - "public_resource": "1573541518:f9053a23fcfa0c3d45a2c95c14f9afe70c7954cdbb35c58bf2f16a61ed289880" - }, - "type": "dir", - "revision": 1728454069973169 -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.mdx new file mode 100644 index 0000000000..7f4d13c9e8 --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Create folder + Creates a directory on the disk + + + +`Function CreateFolder(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the created folder | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/" + String(New UUID); + + Result = OPI_YandexDisk.CreateFolder(Token, Path); +``` + + + + +```json title="Result" +{ + "_embedded": { + "sort": "", + "items": [], + "limit": 20, + "offset": 0, + "path": "disk:/81da8ff8-4975-43d1-aebc-dbffba560d71", + "total": 0 + }, + "name": "81da8ff8-4975-43d1-aebc-dbffba560d71", + "exif": {}, + "resource_id": "1573541518:f9053a23fcfa0c3d45a2c95c14f9afe70c7954cdbb35c58bf2f16a61ed289880", + "created": "2024-10-09T09:07:49+03:00", + "modified": "2024-10-09T09:07:49+03:00", + "path": "disk:/81da8ff8-4975-43d1-aebc-dbffba560d71", + "comment_ids": { + "private_resource": "1573541518:f9053a23fcfa0c3d45a2c95c14f9afe70c7954cdbb35c58bf2f16a61ed289880", + "public_resource": "1573541518:f9053a23fcfa0c3d45a2c95c14f9afe70c7954cdbb35c58bf2f16a61ed289880" + }, + "type": "dir", + "revision": 1728454069973169 +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md deleted file mode 100644 index 90d7b05d6a..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Create object copy - Creates a copy of the object at the specified path and path to the original - - - -`Function CreateObjectCopy(Val Token, Val Original, Val Path, Val Overwrite = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Original | --from | String | Path to the original file or directory | - | Path | --to | String | Destination path for the copy | - | Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Original = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - Path = "/" + String(New UUID) + ".png"; - - Result = OPI_YandexDisk.CreateObjectCopy(Token, Original, Path, True); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:6926f51536837394b524a917099c11217914ac43eecf41e7152d52b8e9a20362", - "public_resource": "1573541518:6926f51536837394b524a917099c11217914ac43eecf41e7152d52b8e9a20362" - }, - "name": "ed13b9fd-51cb-4857-b59d-d8f4fe448746.png", - "exif": {}, - "created": "2024-10-09T09:09:01+03:00", - "resource_id": "1573541518:6926f51536837394b524a917099c11217914ac43eecf41e7152d52b8e9a20362", - "modified": "2024-10-09T09:09:01+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/dc02f41a6c785082b3d549fecc0135f2724bd95aa23e7d01b871ce33be82a59a/6706563e/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=ed13b9fd-51cb-4857-b59d-d8f4fe448746.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/ed13b9fd-51cb-4857-b59d-d8f4fe448746.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728454141910980 -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.mdx new file mode 100644 index 0000000000..360381d2f9 --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Create object copy + Creates a copy of the object at the specified path and path to the original + + + +`Function CreateObjectCopy(Val Token, Val Original, Val Path, Val Overwrite = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Original | --from | String | Path to the original file or directory | + | Path | --to | String | Destination path for the copy | + | Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Original = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + Path = "/" + String(New UUID) + ".png"; + + Result = OPI_YandexDisk.CreateObjectCopy(Token, Original, Path, True); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:6926f51536837394b524a917099c11217914ac43eecf41e7152d52b8e9a20362", + "public_resource": "1573541518:6926f51536837394b524a917099c11217914ac43eecf41e7152d52b8e9a20362" + }, + "name": "ed13b9fd-51cb-4857-b59d-d8f4fe448746.png", + "exif": {}, + "created": "2024-10-09T09:09:01+03:00", + "resource_id": "1573541518:6926f51536837394b524a917099c11217914ac43eecf41e7152d52b8e9a20362", + "modified": "2024-10-09T09:09:01+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/dc02f41a6c785082b3d549fecc0135f2724bd95aa23e7d01b871ce33be82a59a/6706563e/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=ed13b9fd-51cb-4857-b59d-d8f4fe448746.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/ed13b9fd-51cb-4857-b59d-d8f4fe448746.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728454141910980 +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md deleted file mode 100644 index 7a9901fad0..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Delete object - Deletes an object at the specified path - - - -`Function DeleteObject(Val Token, Val Path, Val ToCart = True) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the folder or file to be deleted | - | ToCart | --can | Boolean | To cart | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/b3327332-137b-454c-be37-06cff128756c.png"; - - Result = OPI_YandexDisk.DeleteObject(Token, Path, False); -``` - - - - -```json title="Result" -null -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.mdx new file mode 100644 index 0000000000..50a43363bd --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.mdx @@ -0,0 +1,41 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Delete object + Deletes an object at the specified path + + + +`Function DeleteObject(Val Token, Val Path, Val ToCart = True) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the folder or file to be deleted | + | ToCart | --can | Boolean | To cart | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/b3327332-137b-454c-be37-06cff128756c.png"; + + Result = OPI_YandexDisk.DeleteObject(Token, Path, False); +``` + + + + +```json title="Result" +null +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md deleted file mode 100644 index 45278a7650..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Download file - Downloads a file at the specified path - - - -`Function DownloadFile(Val Token, Val Path, Val SavePath = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the file for downloading | - | SavePath | --out | String | File save path | - - - Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; - - Result = OPI_YandexDisk.DownloadFile(Token, Path); -``` - - - - -```json title="Result" -NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.mdx new file mode 100644 index 0000000000..f318e0f4dd --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.mdx @@ -0,0 +1,41 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Download file + Downloads a file at the specified path + + + +`Function DownloadFile(Val Token, Val Path, Val SavePath = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the file for downloading | + | SavePath | --out | String | File save path | + + + Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; + + Result = OPI_YandexDisk.DownloadFile(Token, Path); +``` + + + + +```json title="Result" +NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md deleted file mode 100644 index 4d8e92b0fa..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Get disk information - Gets information about the current disk - - - -`Function GetDiskInformation(Val Token) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Result = OPI_YandexDisk.GetDiskInformation(Token); -``` - - - - -```json title="Result" -{ - "max_file_size": 1073741824, - "paid_max_file_size": 53687091200, - "total_space": 5368709120, - "reg_time": "2024-02-01T15:13:41+03:00", - "trash_size": 0, - "is_paid": false, - "is_idm_managed_folder_address_access": false, - "used_space": 825948304, - "system_folders": { - "odnoklassniki": "disk:/Социальные сети/Одноклассники", - "google": "disk:/Социальные сети/Google+", - "instagram": "disk:/Социальные сети/Instagram", - "vkontakte": "disk:/Социальные сети/ВКонтакте", - "attach": "disk:/Почтовые вложения", - "mailru": "disk:/Социальные сети/Мой Мир", - "downloads": "disk:/Загрузки/", - "applications": "disk:/Приложения", - "facebook": "disk:/Социальные сети/Facebook", - "social": "disk:/Социальные сети/", - "messenger": "disk:/Файлы Мессенджера", - "calendar": "disk:/Материалы встреч", - "scans": "disk:/Сканы", - "screenshots": "disk:/Скриншоты/", - "photostream": "disk:/Фотокамера/" - }, - "user": { - "reg_time": "2024-02-01T15:13:41+03:00", - "display_name": "bayselonarrend", - "uid": "1573541518", - "country": "by", - "is_child": false, - "login": "bayselonarrend" - }, - "is_idm_managed_public_access": false, - "payment_flow": true, - "unlimited_autoupload_enabled": false, - "revision": 1728412127980782 -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.mdx new file mode 100644 index 0000000000..87d8a3cf58 --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Get disk information + Gets information about the current disk + + + +`Function GetDiskInformation(Val Token) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Result = OPI_YandexDisk.GetDiskInformation(Token); +``` + + + + +```json title="Result" +{ + "max_file_size": 1073741824, + "paid_max_file_size": 53687091200, + "total_space": 5368709120, + "reg_time": "2024-02-01T15:13:41+03:00", + "trash_size": 0, + "is_paid": false, + "is_idm_managed_folder_address_access": false, + "used_space": 825948304, + "system_folders": { + "odnoklassniki": "disk:/Социальные сети/Одноклассники", + "google": "disk:/Социальные сети/Google+", + "instagram": "disk:/Социальные сети/Instagram", + "vkontakte": "disk:/Социальные сети/ВКонтакте", + "attach": "disk:/Почтовые вложения", + "mailru": "disk:/Социальные сети/Мой Мир", + "downloads": "disk:/Загрузки/", + "applications": "disk:/Приложения", + "facebook": "disk:/Социальные сети/Facebook", + "social": "disk:/Социальные сети/", + "messenger": "disk:/Файлы Мессенджера", + "calendar": "disk:/Материалы встреч", + "scans": "disk:/Сканы", + "screenshots": "disk:/Скриншоты/", + "photostream": "disk:/Фотокамера/" + }, + "user": { + "reg_time": "2024-02-01T15:13:41+03:00", + "display_name": "bayselonarrend", + "uid": "1573541518", + "country": "by", + "is_child": false, + "login": "bayselonarrend" + }, + "is_idm_managed_public_access": false, + "payment_flow": true, + "unlimited_autoupload_enabled": false, + "revision": 1728412127980782 +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md deleted file mode 100644 index 305fe09800..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Get download link - Gets a download link for the file - - - -`Function GetDownloadLink(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the file for downloading | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; - - Result = OPI_YandexDisk.GetDownloadLink(Token, Path); -``` - - - - -```json title="Result" -{ - "href": "https://downloader.disk.yandex.ru/disk/b011a1b39b8fc28d9d8f678e0f0e1a8f83616cd74b0acf3d4f4fba8863bb2e82/67065663/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=b7cc5558-c4bc-4a1f-a2b9-0c087ad7c73d.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "method": "GET", - "templated": false -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.mdx new file mode 100644 index 0000000000..d565e0c609 --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Get download link + Gets a download link for the file + + + +`Function GetDownloadLink(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the file for downloading | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; + + Result = OPI_YandexDisk.GetDownloadLink(Token, Path); +``` + + + + +```json title="Result" +{ + "href": "https://downloader.disk.yandex.ru/disk/b011a1b39b8fc28d9d8f678e0f0e1a8f83616cd74b0acf3d4f4fba8863bb2e82/67065663/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=b7cc5558-c4bc-4a1f-a2b9-0c087ad7c73d.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "method": "GET", + "templated": false +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md deleted file mode 100644 index 0a72bf7c2f..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Get list of files -Gets a list of files with or without filtering by type List of available types: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, mage, settings, spreadsheet, text, unknown, video, web - - - -`Function GetFilesList(Val Token, Val Count = 0, Val OffsetFromStart = 0, Val FilterByType = "", Val SortByDate = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Count | --amount | Number, String | Number of returned objects | - | OffsetFromStart | --offset | Number | Offset for getting objects not from the beginning of the list | - | FilterByType | --type | String | Filter by file type | - | SortByDate | --datesort | Boolean | True > sort by date, False > alphabetically | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Count = 2; - OffsetFromStart = 1; - FilterByType = "image"; - - Result = OPI_YandexDisk.GetFilesList(Token, Count, OffsetFromStart, FilterByType); -``` - - - - -```json title="Result" -{ - "items": [ - { - "antivirus_status": "clean", - "size": 943229, - "comment_ids": { - "private_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", - "public_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2" - }, - "name": "3.png", - "exif": {}, - "created": "2024-02-10T13:58:14+03:00", - "resource_id": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", - "modified": "2024-02-10T13:58:14+03:00", - "mime_type": "multipart", - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/172878c50757310ef68efb6dfbe87df0ed6ee578216f4750f236eb37b4e05646/67065672/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/172878c50757310ef68efb6dfbe87df0ed6ee578216f4750f236eb37b4e05646/67065672/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/3.png", - "sha256": "7be951c04b6169d0cf9406dbbc916c8c77f2fc2ee3409f4c045098a1ae19e13a", - "type": "file", - "md5": "7036267356255aebb8af32adad2a1261", - "revision": 1707576606183957 - }, - { - "antivirus_status": "clean", - "size": 1555830, - "comment_ids": { - "private_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", - "public_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60" - }, - "name": "Мишки.jpg", - "exif": { - "date_time": "2014-12-13T17:29:24+03:00" - }, - "created": "2024-02-01T15:13:45+03:00", - "resource_id": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", - "modified": "2024-02-10T14:05:03+03:00", - "mime_type": "image/jpeg", - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/3c2d570490d35d7209453d295cc8897595d757a8cf889e65faa9a01a302b7c66/67065672/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/cb30f929d3a9dd3d75c17d74642eab5cd03f2e0c55b6e49e4f76d3a9ef213bde/67065672/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/Тестовая папка/Мишки.jpg", - "sha256": "d76ce57d8abf4e8eafbc7c85cec59a7a7f12b1d603d51e928be4a3fea0f6817c", - "type": "file", - "md5": "569a1c98696050439b5b2a1ecfa52d19", - "revision": 1707563104041868 - } - ], - "limit": 2, -... -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.mdx new file mode 100644 index 0000000000..bd2cb76dde --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.mdx @@ -0,0 +1,195 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Get list of files +Gets a list of files with or without filtering by type List of available types: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, mage, settings, spreadsheet, text, unknown, video, web + + + +`Function GetFilesList(Val Token, Val Count = 0, Val OffsetFromStart = 0, Val FilterByType = "", Val SortByDate = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Count | --amount | Number, String | Number of returned objects | + | OffsetFromStart | --offset | Number | Offset for getting objects not from the beginning of the list | + | FilterByType | --type | String | Filter by file type | + | SortByDate | --datesort | Boolean | True > sort by date, False > alphabetically | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Count = 2; + OffsetFromStart = 1; + FilterByType = "image"; + + Result = OPI_YandexDisk.GetFilesList(Token, Count, OffsetFromStart, FilterByType); +``` + + + + +```json title="Result" +{ + "items": [ + { + "antivirus_status": "clean", + "size": 943229, + "comment_ids": { + "private_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", + "public_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2" + }, + "name": "3.png", + "exif": {}, + "created": "2024-02-10T13:58:14+03:00", + "resource_id": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", + "modified": "2024-02-10T13:58:14+03:00", + "mime_type": "multipart", + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/172878c50757310ef68efb6dfbe87df0ed6ee578216f4750f236eb37b4e05646/67065672/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/172878c50757310ef68efb6dfbe87df0ed6ee578216f4750f236eb37b4e05646/67065672/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/3.png", + "sha256": "7be951c04b6169d0cf9406dbbc916c8c77f2fc2ee3409f4c045098a1ae19e13a", + "type": "file", + "md5": "7036267356255aebb8af32adad2a1261", + "revision": 1707576606183957 + }, + { + "antivirus_status": "clean", + "size": 1555830, + "comment_ids": { + "private_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", + "public_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60" + }, + "name": "Мишки.jpg", + "exif": { + "date_time": "2014-12-13T17:29:24+03:00" + }, + "created": "2024-02-01T15:13:45+03:00", + "resource_id": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", + "modified": "2024-02-10T14:05:03+03:00", + "mime_type": "image/jpeg", + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/3c2d570490d35d7209453d295cc8897595d757a8cf889e65faa9a01a302b7c66/67065672/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/cb30f929d3a9dd3d75c17d74642eab5cd03f2e0c55b6e49e4f76d3a9ef213bde/67065672/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/Тестовая папка/Мишки.jpg", + "sha256": "d76ce57d8abf4e8eafbc7c85cec59a7a7f12b1d603d51e928be4a3fea0f6817c", + "type": "file", + "md5": "569a1c98696050439b5b2a1ecfa52d19", + "revision": 1707563104041868 + } + ], + "limit": 2, +... +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md deleted file mode 100644 index 27dff74771..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get object - Gets information about a disk object at the specified path - - - -`Function GetObject(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to folder or file | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/b3327332-137b-454c-be37-06cff128756c.png"; - - Result = OPI_YandexDisk.GetObject(Token, Path); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:a08fb14f8be2310bdeb9137e587c97fd440f62116b0d5b062b23309128e8ea1c", - "public_resource": "1573541518:a08fb14f8be2310bdeb9137e587c97fd440f62116b0d5b062b23309128e8ea1c" - }, - "name": "ead71493-7bac-4495-8885-412ae1f2bb2f.png", - "exif": {}, - "created": "2024-10-09T09:08:01+03:00", - "resource_id": "1573541518:a08fb14f8be2310bdeb9137e587c97fd440f62116b0d5b062b23309128e8ea1c", - "modified": "2024-10-09T09:08:01+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/128447d518295b0fdf67c037329f3a846b7ac273d1c8c89e5e7e603994089df9/67065605/gwThwhLBKYvLhQCNnqAHij5hRQaUGDpwFbEzeIKiqA3i6iiJ6DTQ8YKof9wxzQAbxUj34HxpcU3N1SeCvBE7og%3D%3D?uid=1573541518&filename=ead71493-7bac-4495-8885-412ae1f2bb2f.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/ead71493-7bac-4495-8885-412ae1f2bb2f.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728454081912320 -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.mdx new file mode 100644 index 0000000000..2352805dfc --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get object + Gets information about a disk object at the specified path + + + +`Function GetObject(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to folder or file | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/b3327332-137b-454c-be37-06cff128756c.png"; + + Result = OPI_YandexDisk.GetObject(Token, Path); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:a08fb14f8be2310bdeb9137e587c97fd440f62116b0d5b062b23309128e8ea1c", + "public_resource": "1573541518:a08fb14f8be2310bdeb9137e587c97fd440f62116b0d5b062b23309128e8ea1c" + }, + "name": "ead71493-7bac-4495-8885-412ae1f2bb2f.png", + "exif": {}, + "created": "2024-10-09T09:08:01+03:00", + "resource_id": "1573541518:a08fb14f8be2310bdeb9137e587c97fd440f62116b0d5b062b23309128e8ea1c", + "modified": "2024-10-09T09:08:01+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/128447d518295b0fdf67c037329f3a846b7ac273d1c8c89e5e7e603994089df9/67065605/gwThwhLBKYvLhQCNnqAHij5hRQaUGDpwFbEzeIKiqA3i6iiJ6DTQ8YKof9wxzQAbxUj34HxpcU3N1SeCvBE7og%3D%3D?uid=1573541518&filename=ead71493-7bac-4495-8885-412ae1f2bb2f.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/ead71493-7bac-4495-8885-412ae1f2bb2f.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728454081912320 +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md deleted file mode 100644 index d8c83788b7..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Move object - Moves the object to the specified path and path to the original - - - -`Function MoveObject(Val Token, Val Original, Val Path, Val Overwrite = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Original | --from | String | Path to the original file or folder | - | Path | --to | String | Destination path for moving | - | Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Original = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - Path = "/" + String(New UUID) + ".png"; - - Result = OPI_YandexDisk.MoveObject(Token, Original, Path, True); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:513349b18480e51184e963f68f6d0e8f4173c06c4ab885b65f0eb797138892f3", - "public_resource": "1573541518:513349b18480e51184e963f68f6d0e8f4173c06c4ab885b65f0eb797138892f3" - }, - "name": "2a45ec48-94fd-4a39-a282-836b0177948a.png", - "exif": {}, - "created": "2024-10-09T09:10:03+03:00", - "resource_id": "1573541518:513349b18480e51184e963f68f6d0e8f4173c06c4ab885b65f0eb797138892f3", - "modified": "2024-10-09T09:10:27+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/a0b2187a8a78f1e08b108c712034d22c1c5b1f8b7d82f2b5d0c84af4e7ddf460/67065694/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=2a45ec48-94fd-4a39-a282-836b0177948a.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/2a45ec48-94fd-4a39-a282-836b0177948a.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728454227592125 -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.mdx new file mode 100644 index 0000000000..88022d96aa --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Move object + Moves the object to the specified path and path to the original + + + +`Function MoveObject(Val Token, Val Original, Val Path, Val Overwrite = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Original | --from | String | Path to the original file or folder | + | Path | --to | String | Destination path for moving | + | Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Original = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + Path = "/" + String(New UUID) + ".png"; + + Result = OPI_YandexDisk.MoveObject(Token, Original, Path, True); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:513349b18480e51184e963f68f6d0e8f4173c06c4ab885b65f0eb797138892f3", + "public_resource": "1573541518:513349b18480e51184e963f68f6d0e8f4173c06c4ab885b65f0eb797138892f3" + }, + "name": "2a45ec48-94fd-4a39-a282-836b0177948a.png", + "exif": {}, + "created": "2024-10-09T09:10:03+03:00", + "resource_id": "1573541518:513349b18480e51184e963f68f6d0e8f4173c06c4ab885b65f0eb797138892f3", + "modified": "2024-10-09T09:10:27+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/a0b2187a8a78f1e08b108c712034d22c1c5b1f8b7d82f2b5d0c84af4e7ddf460/67065694/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=2a45ec48-94fd-4a39-a282-836b0177948a.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/2a45ec48-94fd-4a39-a282-836b0177948a.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728454227592125 +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md deleted file mode 100644 index 9e69f4afdb..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Upload file by URL - Downloads a file to disk from the specified URL - - - -`Function UploadFileByURL(Val Token, Val Path, Val Address) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to place the downloaded file | - | Address | --url | String | File URL | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Address = "https://api.athenaeum.digital/test_data/picture.jpg"; - Path = "/" + String(New UUID) + ".png"; - - Result = OPI_YandexDisk.UploadFileByURL(Token, Path, Address); -``` - - - - -```json title="Result" -{ - "href": "https://cloud-api.yandex.net/v1/disk/operations/697adf5b5dc3bca81887972604246238630a88ddda323bb45dfa3d6182f88cfc", - "method": "GET", - "templated": false -} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.mdx new file mode 100644 index 0000000000..fc00aedc22 --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Upload file by URL + Downloads a file to disk from the specified URL + + + +`Function UploadFileByURL(Val Token, Val Path, Val Address) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to place the downloaded file | + | Address | --url | String | File URL | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Address = "https://api.athenaeum.digital/test_data/picture.jpg"; + Path = "/" + String(New UUID) + ".png"; + + Result = OPI_YandexDisk.UploadFileByURL(Token, Path, Address); +``` + + + + +```json title="Result" +{ + "href": "https://cloud-api.yandex.net/v1/disk/operations/697adf5b5dc3bca81887972604246238630a88ddda323bb45dfa3d6182f88cfc", + "method": "GET", + "templated": false +} +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md deleted file mode 100644 index 1d5223190c..0000000000 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Upload file - Uploads a file to disk at the specified path - - - -`Function UploadFile(Val Token, Val Path, Val File, Val Overwrite = False) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path for saving the file to disk | - | File | --file | String, BinaryData | File for upload | - | Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Path1 = "/" + String(New UUID) + ".png"; - Path2 = "/" + String(New UUID) + ".png"; - - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL - - TFN = GetTempFileName("png"); // Path - CopyFile(Image, TFN); - - Result = OPI_YandexDisk.UploadFile(Token, Path1, Image, True); - - Result = OPI_YandexDisk.UploadFile(Token, Path2, TFN, True); -``` - - - - -```json title="Result" -{} -``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.mdx b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.mdx new file mode 100644 index 0000000000..d9a79625fd --- /dev/null +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Upload file + Uploads a file to disk at the specified path + + + +`Function UploadFile(Val Token, Val Path, Val File, Val Overwrite = False) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path for saving the file to disk | + | File | --file | String, BinaryData | File for upload | + | Overwrite | --rewrite | Boolean | Overwrite if a file with the same name already exists | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Path1 = "/" + String(New UUID) + ".png"; + Path2 = "/" + String(New UUID) + ".png"; + + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL + + TFN = GetTempFileName("png"); // Path + CopyFile(Image, TFN); + + Result = OPI_YandexDisk.UploadFile(Token, Path1, Image, True); + + Result = OPI_YandexDisk.UploadFile(Token, Path2, TFN, True); +``` + + + + +```json title="Result" +{} +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md b/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md deleted file mode 100644 index 1a32fba192..0000000000 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Unpublish object - Unpublishes a previously published object - - - -`Function CancelObjectPublication(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the previously published object | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - - Result = OPI_YandexDisk.CancelObjectPublication(Token, Path); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", - "public_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715" - }, - "name": "c799f944-a1e1-460c-b167-369776aec80b.png", - "exif": {}, - "created": "2024-10-09T09:10:44+03:00", - "resource_id": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", - "modified": "2024-10-09T09:10:44+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/596acabc1f2313ca93c10b6ed762e2fa6fd47c0a0cae164b0d936e6ad7cbff0e/670656bc/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/c799f944-a1e1-460c-b167-369776aec80b.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728454267864175 -} -``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.mdx b/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.mdx new file mode 100644 index 0000000000..0a4971891d --- /dev/null +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Unpublish object + Unpublishes a previously published object + + + +`Function CancelObjectPublication(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the previously published object | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + + Result = OPI_YandexDisk.CancelObjectPublication(Token, Path); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", + "public_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715" + }, + "name": "c799f944-a1e1-460c-b167-369776aec80b.png", + "exif": {}, + "created": "2024-10-09T09:10:44+03:00", + "resource_id": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", + "modified": "2024-10-09T09:10:44+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/596acabc1f2313ca93c10b6ed762e2fa6fd47c0a0cae164b0d936e6ad7cbff0e/670656bc/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/c799f944-a1e1-460c-b167-369776aec80b.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728454267864175 +} +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md deleted file mode 100644 index cae5c89ad6..0000000000 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Get download link for public object - Gets a direct link to download the public object - - - -`Function GetDownloadLinkForPublicObject(Val Token, Val URL, Val Path = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --url | String | Object address | - | Path | --path | String | Path inside the object | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; - - Result = OPI_YandexDisk.GetDownloadLinkForPublicObject(Token, URL); -``` - - - - -```json title="Result" -{ - "href": "https://downloader.disk.yandex.ru/disk/0e40dbc4ff0f5e07b18180b444b5307ba65dceafeddc4290e7f0e2318a652ecc/670656b9/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=0&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=Zgug7716lOoPjW/yVHq7fCMf2VsHEqpvymRw7rxCkLG46AH97K0C1XZAECLVSaR1q/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2", - "method": "GET", - "templated": false -} -``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.mdx b/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.mdx new file mode 100644 index 0000000000..d68ebe1a35 --- /dev/null +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Get download link for public object + Gets a direct link to download the public object + + + +`Function GetDownloadLinkForPublicObject(Val Token, Val URL, Val Path = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --url | String | Object address | + | Path | --path | String | Path inside the object | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; + + Result = OPI_YandexDisk.GetDownloadLinkForPublicObject(Token, URL); +``` + + + + +```json title="Result" +{ + "href": "https://downloader.disk.yandex.ru/disk/0e40dbc4ff0f5e07b18180b444b5307ba65dceafeddc4290e7f0e2318a652ecc/670656b9/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=0&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=Zgug7716lOoPjW/yVHq7fCMf2VsHEqpvymRw7rxCkLG46AH97K0C1XZAECLVSaR1q/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2", + "method": "GET", + "templated": false +} +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md deleted file mode 100644 index 490d00b32b..0000000000 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Get public object - Gets information about the published object by its URL - - - -`Function GetPublicObject(Val Token, Val URL, Val Count = 0, Val OffsetFromStart = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --url | String | Object address | - | Count | --amount | Number | Number of returned nested objects (for catalog) | - | OffsetFromStart | --offset | Number | Offset for getting nested objects not from the beginning of the list | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; - - Result = OPI_YandexDisk.GetPublicObject(Token, URL); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "public_key": "Zgug7716lOoPjW/yVHq7fCMf2VsHEqpvymRw7rxCkLG46AH97K0C1XZAECLVSaR1q/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/d/p1LRMjbJRWmI6w", - "views_count": 0, - "exif": {}, - "created": "2024-10-09T09:10:44+03:00", - "type": "file", - "resource_id": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", - "modified": "2024-10-09T09:10:44+03:00", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", - "public_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715" - }, - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/fbda17d6fbea3f6b907b20696acaf01c59fab28ca9380c8546090b100a43bfcd/670656b9/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=0&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=0&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "/", - "owner": { - "login": "bayselonarrend", - "display_name": "bayselonarrend", - "uid": "1573541518" - }, - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "revision": 1728454264539399, - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "name": "c799f944-a1e1-460c-b167-369776aec80b.png" -} -``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.mdx b/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.mdx new file mode 100644 index 0000000000..ec826b850b --- /dev/null +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Get public object + Gets information about the published object by its URL + + + +`Function GetPublicObject(Val Token, Val URL, Val Count = 0, Val OffsetFromStart = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --url | String | Object address | + | Count | --amount | Number | Number of returned nested objects (for catalog) | + | OffsetFromStart | --offset | Number | Offset for getting nested objects not from the beginning of the list | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; + + Result = OPI_YandexDisk.GetPublicObject(Token, URL); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "public_key": "Zgug7716lOoPjW/yVHq7fCMf2VsHEqpvymRw7rxCkLG46AH97K0C1XZAECLVSaR1q/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/d/p1LRMjbJRWmI6w", + "views_count": 0, + "exif": {}, + "created": "2024-10-09T09:10:44+03:00", + "type": "file", + "resource_id": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", + "modified": "2024-10-09T09:10:44+03:00", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", + "public_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715" + }, + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/fbda17d6fbea3f6b907b20696acaf01c59fab28ca9380c8546090b100a43bfcd/670656b9/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=0&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=0&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "/", + "owner": { + "login": "bayselonarrend", + "display_name": "bayselonarrend", + "uid": "1573541518" + }, + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "revision": 1728454264539399, + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "name": "c799f944-a1e1-460c-b167-369776aec80b.png" +} +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md b/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md deleted file mode 100644 index ff04100995..0000000000 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Get list of published objects. - Gets a list of published objects - - - -`Function GetPublishedObjectsList(Val Token, Val Count = 0, Val OffsetFromStart = 0) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Count | --amount | Number | Number of returned objects | - | OffsetFromStart | --offset | Number | Offset for getting objects not from the beginning of the list | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Count = 2; - OffsetFromStart = 1; - - Result = OPI_YandexDisk.GetPublishedObjectsList(Token, Count, OffsetFromStart); -``` - - - - -```json title="Result" -{ - "items": [ - { - "antivirus_status": "clean", - "public_key": "lzUqwAcU+PlMrKbzcxhks09qmXiWowXTBvUgesT7NxgPfIAvkNlDx1N5dnN4RI6hq/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/i/Ato4XjVRIb4nVw", - "name": "0b5585af-2bca-43cf-9d3a-decc63db8821.png", - "exif": {}, - "created": "2024-06-02T16:49:58+03:00", - "size": 225883, - "resource_id": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", - "modified": "2024-06-02T16:49:58+03:00", - "mime_type": "image/png", - "comment_ids": { - "private_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", - "public_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f" - }, - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/bc49bb1f7effe30901e699dd768858235d36ef301089f79eaf069259175f2e01/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/ade0f6d8c2a248ac3af3f52d3ffded47ff56ed9fefb0773a428bc2549b3926c0/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/0b5585af-2bca-43cf-9d3a-decc63db8821.png", - "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", - "type": "file", - "md5": "403262e03464796e99ff362e913e9a4d", - "revision": 1717336203287577 - }, - { - "antivirus_status": "clean", - "public_key": "MSeNtB4sL4oM/DMiMUqGGdAxiEkFI7EStMcjgb9PMJR2xYUasH+IJFEqziFNXjfRq/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/i/LIWuPUAfQz2AAg", - "name": "0cd21557-08ba-496c-ba35-503833fa5bd6.png", - "exif": {}, - "created": "2024-06-01T19:54:41+03:00", - "size": 225883, - "resource_id": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", - "modified": "2024-06-01T19:54:41+03:00", - "mime_type": "image/png", - "comment_ids": { - "private_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", - "public_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275" - }, - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/dacf38e85ac3cc8e59cdd6ec7c3ced98d47601318672f40dddb215286b7c42a4/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/3ec0153e8a1b47823bcb6f3ec073cce37cd6c09c6e025a5426975a7b43a9dacd/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/0cd21557-08ba-496c-ba35-503833fa5bd6.png", - "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", - "type": "file", - "md5": "403262e03464796e99ff362e913e9a4d", - "revision": 1717260886231743 - } -... -``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.mdx b/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.mdx new file mode 100644 index 0000000000..e659a2db05 --- /dev/null +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Get list of published objects. + Gets a list of published objects + + + +`Function GetPublishedObjectsList(Val Token, Val Count = 0, Val OffsetFromStart = 0) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Count | --amount | Number | Number of returned objects | + | OffsetFromStart | --offset | Number | Offset for getting objects not from the beginning of the list | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Count = 2; + OffsetFromStart = 1; + + Result = OPI_YandexDisk.GetPublishedObjectsList(Token, Count, OffsetFromStart); +``` + + + + +```json title="Result" +{ + "items": [ + { + "antivirus_status": "clean", + "public_key": "lzUqwAcU+PlMrKbzcxhks09qmXiWowXTBvUgesT7NxgPfIAvkNlDx1N5dnN4RI6hq/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/i/Ato4XjVRIb4nVw", + "name": "0b5585af-2bca-43cf-9d3a-decc63db8821.png", + "exif": {}, + "created": "2024-06-02T16:49:58+03:00", + "size": 225883, + "resource_id": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", + "modified": "2024-06-02T16:49:58+03:00", + "mime_type": "image/png", + "comment_ids": { + "private_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", + "public_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f" + }, + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/bc49bb1f7effe30901e699dd768858235d36ef301089f79eaf069259175f2e01/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/ade0f6d8c2a248ac3af3f52d3ffded47ff56ed9fefb0773a428bc2549b3926c0/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/0b5585af-2bca-43cf-9d3a-decc63db8821.png", + "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", + "type": "file", + "md5": "403262e03464796e99ff362e913e9a4d", + "revision": 1717336203287577 + }, + { + "antivirus_status": "clean", + "public_key": "MSeNtB4sL4oM/DMiMUqGGdAxiEkFI7EStMcjgb9PMJR2xYUasH+IJFEqziFNXjfRq/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/i/LIWuPUAfQz2AAg", + "name": "0cd21557-08ba-496c-ba35-503833fa5bd6.png", + "exif": {}, + "created": "2024-06-01T19:54:41+03:00", + "size": 225883, + "resource_id": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", + "modified": "2024-06-01T19:54:41+03:00", + "mime_type": "image/png", + "comment_ids": { + "private_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", + "public_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275" + }, + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/dacf38e85ac3cc8e59cdd6ec7c3ced98d47601318672f40dddb215286b7c42a4/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/3ec0153e8a1b47823bcb6f3ec073cce37cd6c09c6e025a5426975a7b43a9dacd/670656c5/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/0cd21557-08ba-496c-ba35-503833fa5bd6.png", + "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", + "type": "file", + "md5": "403262e03464796e99ff362e913e9a4d", + "revision": 1717260886231743 + } +... +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md deleted file mode 100644 index 809c3146b1..0000000000 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Publish object - Publishes the disk object for public access - - - -`Function PublishObject(Val Token, Val Path) Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object to be published | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Path = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - - Result = OPI_YandexDisk.PublishObject(Token, Path); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "public_key": "Zgug7716lOoPjW/yVHq7fCMf2VsHEqpvymRw7rxCkLG46AH97K0C1XZAECLVSaR1q/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/d/p1LRMjbJRWmI6w", - "name": "c799f944-a1e1-460c-b167-369776aec80b.png", - "exif": {}, - "created": "2024-10-09T09:10:44+03:00", - "size": 2114023, - "resource_id": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", - "modified": "2024-10-09T09:10:44+03:00", - "comment_ids": { - "private_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", - "public_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715" - }, - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/56103cba7a5223058dc17dfaaa884c9cc2d8e1687e81c841f8a991f2781ac6c0/670656b8/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/c799f944-a1e1-460c-b167-369776aec80b.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728454264539399 -} -``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.mdx b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.mdx new file mode 100644 index 0000000000..ac857c5394 --- /dev/null +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Publish object + Publishes the disk object for public access + + + +`Function PublishObject(Val Token, Val Path) Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object to be published | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Path = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + + Result = OPI_YandexDisk.PublishObject(Token, Path); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "public_key": "Zgug7716lOoPjW/yVHq7fCMf2VsHEqpvymRw7rxCkLG46AH97K0C1XZAECLVSaR1q/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/d/p1LRMjbJRWmI6w", + "name": "c799f944-a1e1-460c-b167-369776aec80b.png", + "exif": {}, + "created": "2024-10-09T09:10:44+03:00", + "size": 2114023, + "resource_id": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", + "modified": "2024-10-09T09:10:44+03:00", + "comment_ids": { + "private_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715", + "public_resource": "1573541518:15116e358f7727f9590f66b5967cae42c4134b5e8dafc5a4acba41a51258d715" + }, + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/56103cba7a5223058dc17dfaaa884c9cc2d8e1687e81c841f8a991f2781ac6c0/670656b8/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/c799f944-a1e1-460c-b167-369776aec80b.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728454264539399 +} +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md b/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md deleted file mode 100644 index 34502501b8..0000000000 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Save public object to disk - Saves the public object to your disk - - - -`Function SavePublicObjectToDisk(Val Token, Val URL, From = "", Target = "") Export` - - | Parameter | CLI option | Type | Description | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --url | String | Object address | - | From | --from | String | Path within public catalog (folders only) | - | Target | --to | String | File save path | - - - Returns: Map Of KeyAndValue - serialized JSON response from Yandex - -
- - - - -```bsl title="Code example" - Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; - - Result = OPI_YandexDisk.SavePublicObjectToDisk(Token, URL); -``` - - - - -```json title="Result" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:a84e0728fb01f0027cf9c1d17f789835601fd460bf3ad4a1fb0fc8ddb4b6fd30", - "public_resource": "1573541518:a84e0728fb01f0027cf9c1d17f789835601fd460bf3ad4a1fb0fc8ddb4b6fd30" - }, - "name": "c799f944-a1e1-460c-b167-369776aec80b.png", - "exif": {}, - "created": "2024-10-09T09:11:06+03:00", - "resource_id": "1573541518:a84e0728fb01f0027cf9c1d17f789835601fd460bf3ad4a1fb0fc8ddb4b6fd30", - "modified": "2024-10-09T09:11:06+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/200b4338faaeba43248f9caf757082b27048ac80701312e53ac6eeac130e0205/670656bb/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/Загрузки/c799f944-a1e1-460c-b167-369776aec80b.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728454266449486 -} -``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.mdx b/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.mdx new file mode 100644 index 0000000000..61106a9aa9 --- /dev/null +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Save public object to disk + Saves the public object to your disk + + + +`Function SavePublicObjectToDisk(Val Token, Val URL, From = "", Target = "") Export` + + | Parameter | CLI option | Type | Description | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --url | String | Object address | + | From | --from | String | Path within public catalog (folders only) | + | Target | --to | String | File save path | + + + Returns: Map Of KeyAndValue - serialized JSON response from Yandex + +
+ + + + +```bsl title="Code example" + Token = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; + + Result = OPI_YandexDisk.SavePublicObjectToDisk(Token, URL); +``` + + + + +```json title="Result" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:a84e0728fb01f0027cf9c1d17f789835601fd460bf3ad4a1fb0fc8ddb4b6fd30", + "public_resource": "1573541518:a84e0728fb01f0027cf9c1d17f789835601fd460bf3ad4a1fb0fc8ddb4b6fd30" + }, + "name": "c799f944-a1e1-460c-b167-369776aec80b.png", + "exif": {}, + "created": "2024-10-09T09:11:06+03:00", + "resource_id": "1573541518:a84e0728fb01f0027cf9c1d17f789835601fd460bf3ad4a1fb0fc8ddb4b6fd30", + "modified": "2024-10-09T09:11:06+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/200b4338faaeba43248f9caf757082b27048ac80701312e53ac6eeac130e0205/670656bb/gwThwhLBKYvLhQCNnqAHikawF6ofeh69S2Q-9g1T5IGPQ-vmmg5ho0UNlym1cYvMYt55yWUwrNHLEwnJN27VGg%3D%3D?uid=1573541518&filename=c799f944-a1e1-460c-b167-369776aec80b.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/Загрузки/c799f944-a1e1-460c-b167-369776aec80b.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728454266449486 +} +``` diff --git a/docs/ru/md/Airtable/Comment-management/Create-comment.md b/docs/ru/md/Airtable/Comment-management/Create-comment.md deleted file mode 100644 index 11682ff647..0000000000 --- a/docs/ru/md/Airtable/Comment-management/Create-comment.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать комментарий - Создает комментарий к записи в таблице - - - -`Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Текст | --text | Строка | Текст комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Запись = "recHqUT4ruWn8KnYi"; - Текст = "Тестовый комментарий"; - - Результат = OPI_Airtable.СоздатьКомментарий(Токен, База, Таблица, Запись, Текст); -``` - - - - - - ```bash - oint airtable СоздатьКомментарий --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --record "rec6pv1dpsrdVxaD4" \ - --text "Тестовый комментарий" - ``` - - - - ```batch - oint airtable СоздатьКомментарий ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --record "rec6pv1dpsrdVxaD4" ^ - --text "Тестовый комментарий" - ``` - - - - -```json title="Результат" -{ - "id": "comtbulEbTtAISgHM", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Тестовый комментарий", - "createdTime": "2024-10-08T17:44:49.632Z", - "lastUpdatedTime": null -} -``` diff --git a/docs/ru/md/Airtable/Comment-management/Create-comment.mdx b/docs/ru/md/Airtable/Comment-management/Create-comment.mdx new file mode 100644 index 0000000000..557f9d32b4 --- /dev/null +++ b/docs/ru/md/Airtable/Comment-management/Create-comment.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать комментарий + Создает комментарий к записи в таблице + + + +`Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Текст | --text | Строка | Текст комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Запись = "recHqUT4ruWn8KnYi"; + Текст = "Тестовый комментарий"; + + Результат = OPI_Airtable.СоздатьКомментарий(Токен, База, Таблица, Запись, Текст); +``` + + + + + + ```bash + oint airtable СоздатьКомментарий --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --record "rec6pv1dpsrdVxaD4" \ + --text "Тестовый комментарий" + ``` + + + + ```batch + oint airtable СоздатьКомментарий ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --record "rec6pv1dpsrdVxaD4" ^ + --text "Тестовый комментарий" + ``` + + + + +```json title="Результат" +{ + "id": "comtbulEbTtAISgHM", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Тестовый комментарий", + "createdTime": "2024-10-08T17:44:49.632Z", + "lastUpdatedTime": null +} +``` diff --git a/docs/ru/md/Airtable/Comment-management/Delete-comment.md b/docs/ru/md/Airtable/Comment-management/Delete-comment.md deleted file mode 100644 index 8059184dbe..0000000000 --- a/docs/ru/md/Airtable/Comment-management/Delete-comment.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить комментарий - Удаляет комментарий к записи таблицы - - - -`Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Комментарий | --comment | Строка | Идентификатор комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Запись = "recHqUT4ruWn8KnYi"; - Комментарий = "comc3oQtvx4mn0pdu"; - - Результат = OPI_Airtable.УдалитьКомментарий(Токен, База, Таблица, Запись, Комментарий); -``` - - - - - - ```bash - oint airtable УдалитьКомментарий --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --record "rec6pv1dpsrdVxaD4" \ - --comment "comeCfbRggeCTqOZT" - ``` - - - - ```batch - oint airtable УдалитьКомментарий ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --record "rec6pv1dpsrdVxaD4" ^ - --comment "comeCfbRggeCTqOZT" - ``` - - - - -```json title="Результат" -{ - "id": "comtbulEbTtAISgHM", - "deleted": true -} -``` diff --git a/docs/ru/md/Airtable/Comment-management/Delete-comment.mdx b/docs/ru/md/Airtable/Comment-management/Delete-comment.mdx new file mode 100644 index 0000000000..43fc012d9b --- /dev/null +++ b/docs/ru/md/Airtable/Comment-management/Delete-comment.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить комментарий + Удаляет комментарий к записи таблицы + + + +`Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Комментарий | --comment | Строка | Идентификатор комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Запись = "recHqUT4ruWn8KnYi"; + Комментарий = "comc3oQtvx4mn0pdu"; + + Результат = OPI_Airtable.УдалитьКомментарий(Токен, База, Таблица, Запись, Комментарий); +``` + + + + + + ```bash + oint airtable УдалитьКомментарий --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --record "rec6pv1dpsrdVxaD4" \ + --comment "comeCfbRggeCTqOZT" + ``` + + + + ```batch + oint airtable УдалитьКомментарий ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --record "rec6pv1dpsrdVxaD4" ^ + --comment "comeCfbRggeCTqOZT" + ``` + + + + +```json title="Результат" +{ + "id": "comtbulEbTtAISgHM", + "deleted": true +} +``` diff --git a/docs/ru/md/Airtable/Comment-management/Edit-comment.md b/docs/ru/md/Airtable/Comment-management/Edit-comment.md deleted file mode 100644 index f224b0ad42..0000000000 --- a/docs/ru/md/Airtable/Comment-management/Edit-comment.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить комментарий - Изменяет текст существующего комментария - - - -`Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Комментарий | --comment | Строка | Идентификатор комментария | - | Текст | --text | Строка | Новый текст комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Запись = "recHqUT4ruWn8KnYi"; - Комментарий = "comc3oQtvx4mn0pdu"; - - Текст = "Тестовый комментарий (изм.)"; - Результат = OPI_Airtable.ИзменитьКомментарий(Токен, База, Таблица, Запись, Комментарий, Текст); - - OPI_ПолучениеДанныхТестов.Проверка_АТТекст(Результат, Текст); -``` - - - - - - ```bash - oint airtable ИзменитьКомментарий --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --record "rec6pv1dpsrdVxaD4" \ - --comment "comeCfbRggeCTqOZT" \ - --text "Тестовый комментарий (изм.)" - ``` - - - - ```batch - oint airtable ИзменитьКомментарий ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --record "rec6pv1dpsrdVxaD4" ^ - --comment "comeCfbRggeCTqOZT" ^ - --text "Тестовый комментарий (изм.)" - ``` - - - - -```json title="Результат" -{ - "id": "comtbulEbTtAISgHM", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Тестовый комментарий (изм.)", - "createdTime": "2024-10-08T17:44:50Z", - "lastUpdatedTime": "2024-10-08T17:44:50.09Z" -} -``` diff --git a/docs/ru/md/Airtable/Comment-management/Edit-comment.mdx b/docs/ru/md/Airtable/Comment-management/Edit-comment.mdx new file mode 100644 index 0000000000..ea483a4c4e --- /dev/null +++ b/docs/ru/md/Airtable/Comment-management/Edit-comment.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить комментарий + Изменяет текст существующего комментария + + + +`Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Комментарий | --comment | Строка | Идентификатор комментария | + | Текст | --text | Строка | Новый текст комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Запись = "recHqUT4ruWn8KnYi"; + Комментарий = "comc3oQtvx4mn0pdu"; + + Текст = "Тестовый комментарий (изм.)"; + Результат = OPI_Airtable.ИзменитьКомментарий(Токен, База, Таблица, Запись, Комментарий, Текст); + + OPI_ПолучениеДанныхТестов.Проверка_АТТекст(Результат, Текст); +``` + + + + + + ```bash + oint airtable ИзменитьКомментарий --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --record "rec6pv1dpsrdVxaD4" \ + --comment "comeCfbRggeCTqOZT" \ + --text "Тестовый комментарий (изм.)" + ``` + + + + ```batch + oint airtable ИзменитьКомментарий ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --record "rec6pv1dpsrdVxaD4" ^ + --comment "comeCfbRggeCTqOZT" ^ + --text "Тестовый комментарий (изм.)" + ``` + + + + +```json title="Результат" +{ + "id": "comtbulEbTtAISgHM", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Тестовый комментарий (изм.)", + "createdTime": "2024-10-08T17:44:50Z", + "lastUpdatedTime": "2024-10-08T17:44:50.09Z" +} +``` diff --git a/docs/ru/md/Airtable/Comment-management/Get-comments.md b/docs/ru/md/Airtable/Comment-management/Get-comments.md deleted file mode 100644 index 242df29078..0000000000 --- a/docs/ru/md/Airtable/Comment-management/Get-comments.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить комментарии - Получает список комментариев к записи в таблице - - - -`Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Запись = "recHqUT4ruWn8KnYi"; - - Результат = OPI_Airtable.ПолучитьКомментарии(Токен, База, Таблица, Запись); -``` - - - - - - ```bash - oint airtable ПолучитьКомментарии --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --record "rec6pv1dpsrdVxaD4" - ``` - - - - ```batch - oint airtable ПолучитьКомментарии ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --record "rec6pv1dpsrdVxaD4" - ``` - - - - -```json title="Результат" -{ - "comments": [ - { - "id": "comtbulEbTtAISgHM", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Тестовый комментарий (изм.)", - "createdTime": "2024-10-08T17:44:50Z", - "lastUpdatedTime": "2024-10-08T17:44:50Z" - } - ], - "offset": null -} -``` diff --git a/docs/ru/md/Airtable/Comment-management/Get-comments.mdx b/docs/ru/md/Airtable/Comment-management/Get-comments.mdx new file mode 100644 index 0000000000..22a661caaf --- /dev/null +++ b/docs/ru/md/Airtable/Comment-management/Get-comments.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить комментарии + Получает список комментариев к записи в таблице + + + +`Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Запись = "recHqUT4ruWn8KnYi"; + + Результат = OPI_Airtable.ПолучитьКомментарии(Токен, База, Таблица, Запись); +``` + + + + + + ```bash + oint airtable ПолучитьКомментарии --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --record "rec6pv1dpsrdVxaD4" + ``` + + + + ```batch + oint airtable ПолучитьКомментарии ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --record "rec6pv1dpsrdVxaD4" + ``` + + + + +```json title="Результат" +{ + "comments": [ + { + "id": "comtbulEbTtAISgHM", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Тестовый комментарий (изм.)", + "createdTime": "2024-10-08T17:44:50Z", + "lastUpdatedTime": "2024-10-08T17:44:50Z" + } + ], + "offset": null +} +``` diff --git a/docs/ru/md/Airtable/Record-management/Create-posts.md b/docs/ru/md/Airtable/Record-management/Create-posts.md deleted file mode 100644 index c202774dc5..0000000000 --- a/docs/ru/md/Airtable/Record-management/Create-posts.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать записи - Создает одну или массив записей по описанию или массиву описаний значений полей - - - -`Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Данные | --data | Структура, Массив из Структура | Набор или массив наборов пар Ключ : Значение > Поле : Показатель | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - - Номер = 10; - Строковое = "Привет"; - - ОписаниеСтроки1 = Новый Структура("Номер,Строковое", Номер, Строковое); - ОписаниеСтроки2 = Новый Структура("Номер,Строковое", Номер, Строковое); - - МассивОписаний = Новый Массив; - МассивОписаний.Добавить(ОписаниеСтроки1); - МассивОписаний.Добавить(ОписаниеСтроки2); - - Результат = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, МассивОписаний); -``` - - - - - - ```bash - oint airtable СоздатьЗаписи --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --data "{'Номер':10,'Строковое':'Привет'}" - ``` - - - - ```batch - oint airtable СоздатьЗаписи ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --data "{'Номер':10,'Строковое':'Привет'}" - ``` - - - - -```json title="Результат" -{ - "records": [ - { - "id": "recY8xFlFelA2CBmV", - "createdTime": "2024-10-08T17:44:48Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - }, - { - "id": "recR2uolW0zqWMsg7", - "createdTime": "2024-10-08T17:44:48Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Record-management/Create-posts.mdx b/docs/ru/md/Airtable/Record-management/Create-posts.mdx new file mode 100644 index 0000000000..c84b112f6e --- /dev/null +++ b/docs/ru/md/Airtable/Record-management/Create-posts.mdx @@ -0,0 +1,93 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать записи + Создает одну или массив записей по описанию или массиву описаний значений полей + + + +`Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Данные | --data | Структура, Массив из Структура | Набор или массив наборов пар Ключ : Значение > Поле : Показатель | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + + Номер = 10; + Строковое = "Привет"; + + ОписаниеСтроки1 = Новый Структура("Номер,Строковое", Номер, Строковое); + ОписаниеСтроки2 = Новый Структура("Номер,Строковое", Номер, Строковое); + + МассивОписаний = Новый Массив; + МассивОписаний.Добавить(ОписаниеСтроки1); + МассивОписаний.Добавить(ОписаниеСтроки2); + + Результат = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, МассивОписаний); +``` + + + + + + ```bash + oint airtable СоздатьЗаписи --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --data "{'Номер':10,'Строковое':'Привет'}" + ``` + + + + ```batch + oint airtable СоздатьЗаписи ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --data "{'Номер':10,'Строковое':'Привет'}" + ``` + + + + +```json title="Результат" +{ + "records": [ + { + "id": "recY8xFlFelA2CBmV", + "createdTime": "2024-10-08T17:44:48Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } + }, + { + "id": "recR2uolW0zqWMsg7", + "createdTime": "2024-10-08T17:44:48Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Record-management/Delete-posts.md b/docs/ru/md/Airtable/Record-management/Delete-posts.md deleted file mode 100644 index e91622c4f3..0000000000 --- a/docs/ru/md/Airtable/Record-management/Delete-posts.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить записи - Удаляет одну или массив записей по идентификаторам - - - -`Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Записи | --records | Строка, Массив из Строка | Идентификатор или массив индентификаторов записей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Запись = "recHqUT4ruWn8KnYi"; - - Результат = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Запись); -``` - - - - - - ```bash - oint airtable УдалитьЗаписи --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --records "rec6pv1dpsrdVxaD4" - ``` - - - - ```batch - oint airtable УдалитьЗаписи ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --records "rec6pv1dpsrdVxaD4" - ``` - - - - -```json title="Результат" -{ - "records": [ - { - "deleted": true, - "id": "rec9dR46CmDQMkUJ0" - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Record-management/Delete-posts.mdx b/docs/ru/md/Airtable/Record-management/Delete-posts.mdx new file mode 100644 index 0000000000..94c2a11d3c --- /dev/null +++ b/docs/ru/md/Airtable/Record-management/Delete-posts.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить записи + Удаляет одну или массив записей по идентификаторам + + + +`Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Записи | --records | Строка, Массив из Строка | Идентификатор или массив индентификаторов записей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Запись = "recHqUT4ruWn8KnYi"; + + Результат = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Запись); +``` + + + + + + ```bash + oint airtable УдалитьЗаписи --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --records "rec6pv1dpsrdVxaD4" + ``` + + + + ```batch + oint airtable УдалитьЗаписи ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --records "rec6pv1dpsrdVxaD4" + ``` + + + + +```json title="Результат" +{ + "records": [ + { + "deleted": true, + "id": "rec9dR46CmDQMkUJ0" + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Record-management/Get-list-of-records.md b/docs/ru/md/Airtable/Record-management/Get-list-of-records.md deleted file mode 100644 index 1b3c00d99b..0000000000 --- a/docs/ru/md/Airtable/Record-management/Get-list-of-records.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список записей - Получает список записей выбранной таблицы - - - -`Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - - Результат = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица); -``` - - - - - - ```bash - oint airtable ПолучитьСписокЗаписей --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" - ``` - - - - ```batch - oint airtable ПолучитьСписокЗаписей ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" - ``` - - - - -```json title="Результат" -{ - "records": [ - { - "id": "rec9dR46CmDQMkUJ0", - "createdTime": "2024-10-08T17:44:49Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Record-management/Get-list-of-records.mdx b/docs/ru/md/Airtable/Record-management/Get-list-of-records.mdx new file mode 100644 index 0000000000..3eb9aee82d --- /dev/null +++ b/docs/ru/md/Airtable/Record-management/Get-list-of-records.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список записей + Получает список записей выбранной таблицы + + + +`Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + + Результат = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица); +``` + + + + + + ```bash + oint airtable ПолучитьСписокЗаписей --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" + ``` + + + + ```batch + oint airtable ПолучитьСписокЗаписей ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" + ``` + + + + +```json title="Результат" +{ + "records": [ + { + "id": "rec9dR46CmDQMkUJ0", + "createdTime": "2024-10-08T17:44:49Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Record-management/Get-record.md b/docs/ru/md/Airtable/Record-management/Get-record.md deleted file mode 100644 index 0f7a426214..0000000000 --- a/docs/ru/md/Airtable/Record-management/Get-record.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить запись - Получает данные строки таблицы по идентификатору - - - -`Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Запись = "recHqUT4ruWn8KnYi"; - - Результат = OPI_Airtable.ПолучитьЗапись(Токен, База, Таблица, Запись); -``` - - - - - - ```bash - oint airtable ПолучитьЗапись --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --record "rec6pv1dpsrdVxaD4" - ``` - - - - ```batch - oint airtable ПолучитьЗапись ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --record "rec6pv1dpsrdVxaD4" - ``` - - - - -```json title="Результат" -{ - "id": "rec9dR46CmDQMkUJ0", - "createdTime": "2024-10-08T17:44:49Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } -} -``` diff --git a/docs/ru/md/Airtable/Record-management/Get-record.mdx b/docs/ru/md/Airtable/Record-management/Get-record.mdx new file mode 100644 index 0000000000..d908bd9b0c --- /dev/null +++ b/docs/ru/md/Airtable/Record-management/Get-record.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить запись + Получает данные строки таблицы по идентификатору + + + +`Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Запись = "recHqUT4ruWn8KnYi"; + + Результат = OPI_Airtable.ПолучитьЗапись(Токен, База, Таблица, Запись); +``` + + + + + + ```bash + oint airtable ПолучитьЗапись --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --record "rec6pv1dpsrdVxaD4" + ``` + + + + ```batch + oint airtable ПолучитьЗапись ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --record "rec6pv1dpsrdVxaD4" + ``` + + + + +```json title="Результат" +{ + "id": "rec9dR46CmDQMkUJ0", + "createdTime": "2024-10-08T17:44:49Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } +} +``` diff --git a/docs/ru/md/Airtable/Table-management/Create-table.md b/docs/ru/md/Airtable/Table-management/Create-table.md deleted file mode 100644 index 3eaaf54e3f..0000000000 --- a/docs/ru/md/Airtable/Table-management/Create-table.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать таблицу - Создает новую таблицу в базе - - - -`Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - | Наименование | --title | Строка | Наименование новой таблицы | - | МассивПолей | --fieldsdata | Массив Из Структура | Массив описаний полей | - | Описание | --description | Строка | Описание таблицы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - - МассивПолей = Новый Массив; - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеВложения("Вложение")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеФлажка("Флажок")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеДаты("Дата")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеТелефона("Телефон")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеПочты("Почта")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСсылки("Ссылка")); - - Наименование = "Тестовая таблица 2"; - Описание = "Новая таблица"; - - Результат = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание); -``` - - - - - - ```bash - oint airtable СоздатьТаблицу --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --title "Тестовая таблица 2" \ - --fieldsdata "[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'},{'name':'Вложение','type':'multipleAttachments'},{'name':'Флажок','type':'checkbox','options':{'icon':'check','color':'yellowBright'}},{'name':'Дата','type':'date','options':{'dateFormat':{'format':'YYYY-MM-DD','name':'iso'}}},{'name':'Телефон','type':'phoneNumber'},{'name':'Почта','type':'email'},{'name':'Ссылка','type':'url'}]" \ - --description "Новая таблица" - ``` - - - - ```batch - oint airtable СоздатьТаблицу ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --title "Тестовая таблица 2" ^ - --fieldsdata "[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'},{'name':'Вложение','type':'multipleAttachments'},{'name':'Флажок','type':'checkbox','options':{'icon':'check','color':'yellowBright'}},{'name':'Дата','type':'date','options':{'dateFormat':{'format':'YYYY-MM-DD','name':'iso'}}},{'name':'Телефон','type':'phoneNumber'},{'name':'Почта','type':'email'},{'name':'Ссылка','type':'url'}]" ^ - --description "Новая таблица" - ``` - - - - -```json title="Результат" -{ - "id": "tblhBYsKZ3w9qZzlj", - "name": "Тестовая таблица 2", - "description": "Новая таблица", - "primaryFieldId": "fld9iS1ofdALjC2yT", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld9iS1ofdALjC2yT", - "name": "Номер" - }, - { - "type": "richText", - "id": "fldcMrmBANDdi3wjL", - "name": "Строковое" - }, - { - "type": "multipleAttachments", - "options": { - "isReversed": false - }, - "id": "fldQlnMrCcjrKoGvN", - "name": "Вложение" - }, - { - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - }, - "id": "fldPKXJmkzAFRo41T", - "name": "Флажок" - }, - { - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - }, - "id": "fldvgGvcjT2zaVAoa", - "name": "Дата" - }, - { - "type": "phoneNumber", - "id": "fldxpWaIK8kfA0bdI", - "name": "Телефон" - }, - { - "type": "email", - "id": "fldSIeymPzrNvPv5E", - "name": "Почта" - }, - { - "type": "url", - "id": "fldFczkpBLZWvsRld", - "name": "Ссылка" - } - ], - "views": [ - { - "id": "viw1FaP6XyTzHPsAD", - "name": "Grid view", - "type": "grid" - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Table-management/Create-table.mdx b/docs/ru/md/Airtable/Table-management/Create-table.mdx new file mode 100644 index 0000000000..22a1c488a7 --- /dev/null +++ b/docs/ru/md/Airtable/Table-management/Create-table.mdx @@ -0,0 +1,149 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать таблицу + Создает новую таблицу в базе + + + +`Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Наименование | --title | Строка | Наименование новой таблицы | + | МассивПолей | --fieldsdata | Массив Из Структура | Массив описаний полей | + | Описание | --description | Строка | Описание таблицы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + + МассивПолей = Новый Массив; + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеВложения("Вложение")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеФлажка("Флажок")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеДаты("Дата")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеТелефона("Телефон")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеПочты("Почта")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСсылки("Ссылка")); + + Наименование = "Тестовая таблица 2"; + Описание = "Новая таблица"; + + Результат = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание); +``` + + + + + + ```bash + oint airtable СоздатьТаблицу --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --title "Тестовая таблица 2" \ + --fieldsdata "[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'},{'name':'Вложение','type':'multipleAttachments'},{'name':'Флажок','type':'checkbox','options':{'icon':'check','color':'yellowBright'}},{'name':'Дата','type':'date','options':{'dateFormat':{'format':'YYYY-MM-DD','name':'iso'}}},{'name':'Телефон','type':'phoneNumber'},{'name':'Почта','type':'email'},{'name':'Ссылка','type':'url'}]" \ + --description "Новая таблица" + ``` + + + + ```batch + oint airtable СоздатьТаблицу ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --title "Тестовая таблица 2" ^ + --fieldsdata "[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'},{'name':'Вложение','type':'multipleAttachments'},{'name':'Флажок','type':'checkbox','options':{'icon':'check','color':'yellowBright'}},{'name':'Дата','type':'date','options':{'dateFormat':{'format':'YYYY-MM-DD','name':'iso'}}},{'name':'Телефон','type':'phoneNumber'},{'name':'Почта','type':'email'},{'name':'Ссылка','type':'url'}]" ^ + --description "Новая таблица" + ``` + + + + +```json title="Результат" +{ + "id": "tblhBYsKZ3w9qZzlj", + "name": "Тестовая таблица 2", + "description": "Новая таблица", + "primaryFieldId": "fld9iS1ofdALjC2yT", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld9iS1ofdALjC2yT", + "name": "Номер" + }, + { + "type": "richText", + "id": "fldcMrmBANDdi3wjL", + "name": "Строковое" + }, + { + "type": "multipleAttachments", + "options": { + "isReversed": false + }, + "id": "fldQlnMrCcjrKoGvN", + "name": "Вложение" + }, + { + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + }, + "id": "fldPKXJmkzAFRo41T", + "name": "Флажок" + }, + { + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + }, + "id": "fldvgGvcjT2zaVAoa", + "name": "Дата" + }, + { + "type": "phoneNumber", + "id": "fldxpWaIK8kfA0bdI", + "name": "Телефон" + }, + { + "type": "email", + "id": "fldSIeymPzrNvPv5E", + "name": "Почта" + }, + { + "type": "url", + "id": "fldFczkpBLZWvsRld", + "name": "Ссылка" + } + ], + "views": [ + { + "id": "viw1FaP6XyTzHPsAD", + "name": "Grid view", + "type": "grid" + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Table-management/Modify-table.md b/docs/ru/md/Airtable/Table-management/Modify-table.md deleted file mode 100644 index a28ce7c91f..0000000000 --- a/docs/ru/md/Airtable/Table-management/Modify-table.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить таблицу - Изменяет наименование и|или описание базы - - - -`Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - | Таблица | --table | Строка | Идентификатор таблицы | - | Наименование | --title | Строка | Новое наименование | - | Описание | --description | Строка | Новое описание | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Наименование = "Тестовая таблица 2 (изм.)"; - Описание = "Новая таблица (изм.)"; - - Результат = OPI_Airtable.ИзменитьТаблицу(Токен, База, Таблица, Наименование, Описание); -``` - - - - - - ```bash - oint airtable ИзменитьТаблицу --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --title "Тестовая таблица 2 (изм.)" \ - --description "Новая таблица (изм.)" - ``` - - - - ```batch - oint airtable ИзменитьТаблицу ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --title "Тестовая таблица 2 (изм.)" ^ - --description "Новая таблица (изм.)" - ``` - - - - -```json title="Результат" -{ - "id": "tblhBYsKZ3w9qZzlj", - "name": "Тестовая таблица 2 (изм.)", - "description": "Новая таблица (изм.)", - "primaryFieldId": "fld9iS1ofdALjC2yT", - "fields": [ - { - "id": "fld9iS1ofdALjC2yT", - "name": "Номер", - "type": "number", - "options": { - "precision": 0 - } - }, - { - "id": "fldcMrmBANDdi3wjL", - "name": "Строковое", - "type": "richText" - }, - { - "id": "fldQlnMrCcjrKoGvN", - "name": "Вложение", - "type": "multipleAttachments", - "options": { - "isReversed": false - } - }, - { - "id": "fldPKXJmkzAFRo41T", - "name": "Флажок", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } - }, - { - "id": "fldvgGvcjT2zaVAoa", - "name": "Дата", - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - } - }, - { - "id": "fldxpWaIK8kfA0bdI", - "name": "Телефон", - "type": "phoneNumber" - }, - { - "id": "fldSIeymPzrNvPv5E", - "name": "Почта", - "type": "email" - }, - { - "id": "fldFczkpBLZWvsRld", - "name": "Ссылка", - "type": "url" - } - ], - "views": [ - { - "id": "viw1FaP6XyTzHPsAD", - "name": "Grid view", - "type": "grid" - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Table-management/Modify-table.mdx b/docs/ru/md/Airtable/Table-management/Modify-table.mdx new file mode 100644 index 0000000000..ecbeac2863 --- /dev/null +++ b/docs/ru/md/Airtable/Table-management/Modify-table.mdx @@ -0,0 +1,139 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить таблицу + Изменяет наименование и|или описание базы + + + +`Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Таблица | --table | Строка | Идентификатор таблицы | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Наименование = "Тестовая таблица 2 (изм.)"; + Описание = "Новая таблица (изм.)"; + + Результат = OPI_Airtable.ИзменитьТаблицу(Токен, База, Таблица, Наименование, Описание); +``` + + + + + + ```bash + oint airtable ИзменитьТаблицу --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --title "Тестовая таблица 2 (изм.)" \ + --description "Новая таблица (изм.)" + ``` + + + + ```batch + oint airtable ИзменитьТаблицу ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --title "Тестовая таблица 2 (изм.)" ^ + --description "Новая таблица (изм.)" + ``` + + + + +```json title="Результат" +{ + "id": "tblhBYsKZ3w9qZzlj", + "name": "Тестовая таблица 2 (изм.)", + "description": "Новая таблица (изм.)", + "primaryFieldId": "fld9iS1ofdALjC2yT", + "fields": [ + { + "id": "fld9iS1ofdALjC2yT", + "name": "Номер", + "type": "number", + "options": { + "precision": 0 + } + }, + { + "id": "fldcMrmBANDdi3wjL", + "name": "Строковое", + "type": "richText" + }, + { + "id": "fldQlnMrCcjrKoGvN", + "name": "Вложение", + "type": "multipleAttachments", + "options": { + "isReversed": false + } + }, + { + "id": "fldPKXJmkzAFRo41T", + "name": "Флажок", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } + }, + { + "id": "fldvgGvcjT2zaVAoa", + "name": "Дата", + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + } + }, + { + "id": "fldxpWaIK8kfA0bdI", + "name": "Телефон", + "type": "phoneNumber" + }, + { + "id": "fldSIeymPzrNvPv5E", + "name": "Почта", + "type": "email" + }, + { + "id": "fldFczkpBLZWvsRld", + "name": "Ссылка", + "type": "url" + } + ], + "views": [ + { + "id": "viw1FaP6XyTzHPsAD", + "name": "Grid view", + "type": "grid" + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Create-database.md b/docs/ru/md/Airtable/Working-with-databases/Create-database.md deleted file mode 100644 index c54a9d63d9..0000000000 --- a/docs/ru/md/Airtable/Working-with-databases/Create-database.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать базу - Создает новую базу данных - - - -`Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | РабочееПространство | --ws | Строка | Идентификатор рабочего пространства | - | Наименование | --title | Строка | Наименование новой базы | - | КоллекцияТаблиц | --tablesdata | Соответствие Из КлючИЗначение | Описание таблиц: Ключ > имя, Значение > массив полей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - Область = "wspdf8yl1yZz3PmWZ"; - Наименование = "Тестовая база"; - - МассивПолей = Новый Массив; - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); - - ИмяТаблицы = "Тестовая таблица"; - - СоответствиеТаблиц = Новый Соответствие; - СоответствиеТаблиц.Вставить(ИмяТаблицы, МассивПолей); - - Результат = OPI_Airtable.СоздатьБазу(Токен, Область, Наименование, СоответствиеТаблиц); -``` - - - - - - ```bash - oint airtable СоздатьБазу --token "***" \ - --ws "wspdf8yl1yZz3PmWZ" \ - --title "Тестовая база" \ - --tablesdata "{'Тестовая таблица':[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'}]}" - ``` - - - - ```batch - oint airtable СоздатьБазу ^ - --token "***" ^ - --ws "wspdf8yl1yZz3PmWZ" ^ - --title "Тестовая база" ^ - --tablesdata "{'Тестовая таблица':[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'}]}" - ``` - - - - -```json title="Результат" -{ - "id": "appye5JxQD6CEAVQ7", - "tables": [ - { - "id": "tblPK7iM6QVCGbral", - "name": "Тестовая таблица", - "primaryFieldId": "fldiLeIBGEKLvCGHn", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldiLeIBGEKLvCGHn", - "name": "Номер" - }, - { - "type": "richText", - "id": "flduxcmTlD7hCz9ZS", - "name": "Строковое" - } - ], - "views": [ - { - "id": "viw5lk0HjJwqDX1vM", - "name": "Grid view", - "type": "grid" - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Create-database.mdx b/docs/ru/md/Airtable/Working-with-databases/Create-database.mdx new file mode 100644 index 0000000000..2125dcd281 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-databases/Create-database.mdx @@ -0,0 +1,104 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать базу + Создает новую базу данных + + + +`Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | РабочееПространство | --ws | Строка | Идентификатор рабочего пространства | + | Наименование | --title | Строка | Наименование новой базы | + | КоллекцияТаблиц | --tablesdata | Соответствие Из КлючИЗначение | Описание таблиц: Ключ > имя, Значение > массив полей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + Область = "wspdf8yl1yZz3PmWZ"; + Наименование = "Тестовая база"; + + МассивПолей = Новый Массив; + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); + + ИмяТаблицы = "Тестовая таблица"; + + СоответствиеТаблиц = Новый Соответствие; + СоответствиеТаблиц.Вставить(ИмяТаблицы, МассивПолей); + + Результат = OPI_Airtable.СоздатьБазу(Токен, Область, Наименование, СоответствиеТаблиц); +``` + + + + + + ```bash + oint airtable СоздатьБазу --token "***" \ + --ws "wspdf8yl1yZz3PmWZ" \ + --title "Тестовая база" \ + --tablesdata "{'Тестовая таблица':[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'}]}" + ``` + + + + ```batch + oint airtable СоздатьБазу ^ + --token "***" ^ + --ws "wspdf8yl1yZz3PmWZ" ^ + --title "Тестовая база" ^ + --tablesdata "{'Тестовая таблица':[{'name':'Номер','type':'number','options':{'precision':0}},{'name':'Строковое','type':'richText'}]}" + ``` + + + + +```json title="Результат" +{ + "id": "appye5JxQD6CEAVQ7", + "tables": [ + { + "id": "tblPK7iM6QVCGbral", + "name": "Тестовая таблица", + "primaryFieldId": "fldiLeIBGEKLvCGHn", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldiLeIBGEKLvCGHn", + "name": "Номер" + }, + { + "type": "richText", + "id": "flduxcmTlD7hCz9ZS", + "name": "Строковое" + } + ], + "views": [ + { + "id": "viw5lk0HjJwqDX1vM", + "name": "Grid view", + "type": "grid" + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md b/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md deleted file mode 100644 index 74d3fedba6..0000000000 --- a/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить таблицы базы - Получает схему таблиц базы - - - -`Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - - Результат = OPI_Airtable.ПолучитьТаблицыБазы(Токен, База); -``` - - - - - - ```bash - oint airtable ПолучитьТаблицыБазы --token "***" \ - --base "app0r5m50QN7nWAAv" - ``` - - - - ```batch - oint airtable ПолучитьТаблицыБазы ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" - ``` - - - - -```json title="Результат" -{ - "tables": [ - { - "id": "tblPK7iM6QVCGbral", - "name": "Тестовая таблица", - "primaryFieldId": "fldiLeIBGEKLvCGHn", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldiLeIBGEKLvCGHn", - "name": "Номер" - }, - { - "type": "richText", - "id": "flduxcmTlD7hCz9ZS", - "name": "Строковое" - } - ], - "views": [ - { - "id": "viw5lk0HjJwqDX1vM", - "name": "Grid view", - "type": "grid" - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.mdx b/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.mdx new file mode 100644 index 0000000000..c84ff5526b --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить таблицы базы + Получает схему таблиц базы + + + +`Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + + Результат = OPI_Airtable.ПолучитьТаблицыБазы(Токен, База); +``` + + + + + + ```bash + oint airtable ПолучитьТаблицыБазы --token "***" \ + --base "app0r5m50QN7nWAAv" + ``` + + + + ```batch + oint airtable ПолучитьТаблицыБазы ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" + ``` + + + + +```json title="Результат" +{ + "tables": [ + { + "id": "tblPK7iM6QVCGbral", + "name": "Тестовая таблица", + "primaryFieldId": "fldiLeIBGEKLvCGHn", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldiLeIBGEKLvCGHn", + "name": "Номер" + }, + { + "type": "richText", + "id": "flduxcmTlD7hCz9ZS", + "name": "Строковое" + } + ], + "views": [ + { + "id": "viw5lk0HjJwqDX1vM", + "name": "Grid view", + "type": "grid" + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md deleted file mode 100644 index ffcff03c46..0000000000 --- a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список баз - Получает список доступных баз - - - -`Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Отступ | --offset | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - - Результат = OPI_Airtable.ПолучитьСписокБаз(Токен); -``` - - - - - - ```bash - oint airtable ПолучитьСписокБаз --token "***" - ``` - - - - ```batch - oint airtable ПолучитьСписокБаз ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "bases": [ - { - "id": "appGarzKZ0lu3gzoa", - "name": "Test", - "permissionLevel": "create" - }, - { - "id": "app9WRfJirwn3yXuG", - "name": "Product catalog", - "permissionLevel": "create" - }, - { - "id": "app6gigUYTzlDEq4X", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "app5hJGyK8asYYe1Q", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appRQ6VxxOZb40Uwi", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appM6FaGofV2XSfFA", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "apptm8Xqo7TwMaipQ", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appsyQyGrF8aVN2Wm", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "applEsyJmBRm12AuN", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appbh1wYGbZlmn3pN", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "apppkKYsw7O1Gqhxl", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appIHzEhKAimg9S2p", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "app5Zyj15QZisbqvA", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "app05ybJZ2aiF7jiV", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appKbK1rnu08kOueO", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appBTTgSQtzCkrp4V", - "name": "База из Оинт", - "permissionLevel": "create" - }, - { - "id": "appDtM9dK5yzXduUB", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appqyGu9Cdx9xWvEs", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appczCGkB55A13rQ2", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appxClK6G6i2DREOB", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appsYySkvo8kafUdd", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appw2EFeyyNgwmhP6", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appqEloLDyI7p6uzS", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appdTFa0GMiOdaxVp", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appuREJLUMSxU9Tww", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appQwerTglYZLYkLl", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "apptPCnUGDn0M76to", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appgg50vNZwX1aZmu", - "name": "Тестовая база", - "permissionLevel": "create" - }, - { - "id": "appHB3hm34ZkAjflT", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "appuHDfwXADAD5QDj", - "name": "TestDatabase", -... -``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.mdx b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.mdx new file mode 100644 index 0000000000..5cd39a8082 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.mdx @@ -0,0 +1,204 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список баз + Получает список доступных баз + + + +`Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Отступ | --offset | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + + Результат = OPI_Airtable.ПолучитьСписокБаз(Токен); +``` + + + + + + ```bash + oint airtable ПолучитьСписокБаз --token "***" + ``` + + + + ```batch + oint airtable ПолучитьСписокБаз ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "bases": [ + { + "id": "appGarzKZ0lu3gzoa", + "name": "Test", + "permissionLevel": "create" + }, + { + "id": "app9WRfJirwn3yXuG", + "name": "Product catalog", + "permissionLevel": "create" + }, + { + "id": "app6gigUYTzlDEq4X", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "app5hJGyK8asYYe1Q", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appRQ6VxxOZb40Uwi", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appM6FaGofV2XSfFA", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "apptm8Xqo7TwMaipQ", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appsyQyGrF8aVN2Wm", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "applEsyJmBRm12AuN", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appbh1wYGbZlmn3pN", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "apppkKYsw7O1Gqhxl", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appIHzEhKAimg9S2p", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "app5Zyj15QZisbqvA", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "app05ybJZ2aiF7jiV", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appKbK1rnu08kOueO", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appBTTgSQtzCkrp4V", + "name": "База из Оинт", + "permissionLevel": "create" + }, + { + "id": "appDtM9dK5yzXduUB", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appqyGu9Cdx9xWvEs", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appczCGkB55A13rQ2", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appxClK6G6i2DREOB", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appsYySkvo8kafUdd", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appw2EFeyyNgwmhP6", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appqEloLDyI7p6uzS", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appdTFa0GMiOdaxVp", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appuREJLUMSxU9Tww", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appQwerTglYZLYkLl", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "apptPCnUGDn0M76to", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appgg50vNZwX1aZmu", + "name": "Тестовая база", + "permissionLevel": "create" + }, + { + "id": "appHB3hm34ZkAjflT", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "appuHDfwXADAD5QDj", + "name": "TestDatabase", +... +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Create-field.md b/docs/ru/md/Airtable/Working-with-fields/Create-field.md deleted file mode 100644 index aeadbd0658..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Create-field.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать поле - Создет новое поле в таблице - - - -`Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - | Таблица | --table | Строка | Идентификатор таблицы | - | СтруктураПоля | --fielddata | Структура Из КлючИЗначение | Описание нового поля | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Имя = Строка(Новый УникальныйИдентификатор); - - Поле = OPI_Airtable.ПолучитьПолеНомера(Имя); - Результат = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, Поле); -``` - - - - - - ```bash - oint airtable СоздатьПоле --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" \ - --fielddata "{'name':'bf234b4a-f391-4950-8fd0-90e8817e19e4','type':'number','options':{'precision':0}}" - ``` - - - - ```batch - oint airtable СоздатьПоле ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" ^ - --fielddata "{'name':'bf234b4a-f391-4950-8fd0-90e8817e19e4','type':'number','options':{'precision':0}}" - ``` - - - - -```json title="Результат" -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldVcZeSTEx69J6u2", - "name": "55cedfa3-76e5-4d08-923e-99da5f14c9aa" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Create-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Create-field.mdx new file mode 100644 index 0000000000..ab3de44658 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Create-field.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать поле + Создет новое поле в таблице + + + +`Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Таблица | --table | Строка | Идентификатор таблицы | + | СтруктураПоля | --fielddata | Структура Из КлючИЗначение | Описание нового поля | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Имя = Строка(Новый УникальныйИдентификатор); + + Поле = OPI_Airtable.ПолучитьПолеНомера(Имя); + Результат = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, Поле); +``` + + + + + + ```bash + oint airtable СоздатьПоле --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" \ + --fielddata "{'name':'bf234b4a-f391-4950-8fd0-90e8817e19e4','type':'number','options':{'precision':0}}" + ``` + + + + ```batch + oint airtable СоздатьПоле ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" ^ + --fielddata "{'name':'bf234b4a-f391-4950-8fd0-90e8817e19e4','type':'number','options':{'precision':0}}" + ``` + + + + +```json title="Результат" +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldVcZeSTEx69J6u2", + "name": "55cedfa3-76e5-4d08-923e-99da5f14c9aa" +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md deleted file mode 100644 index 09f5b3fb4b..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить поле (файл) - Получает описание поля файлового типа - - - -`Функция ПолучитьПолеВложения(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеВложения("Вложение"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеВложения --title "Вложение" - ``` - - - - ```batch - oint airtable ПолучитьПолеВложения ^ - --title "Вложение" - ``` - - - - -```json title="Результат" -{ - "name": "Вложение", - "type": "multipleAttachments" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.mdx new file mode 100644 index 0000000000..2d66d89125 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить поле (файл) + Получает описание поля файлового типа + + + +`Функция ПолучитьПолеВложения(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеВложения("Вложение"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеВложения --title "Вложение" + ``` + + + + ```batch + oint airtable ПолучитьПолеВложения ^ + --title "Вложение" + ``` + + + + +```json title="Результат" +{ + "name": "Вложение", + "type": "multipleAttachments" +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md deleted file mode 100644 index 2028a52c79..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить поле (флажок) - Получает описание поля типа булево - - - -`Функция ПолучитьПолеФлажка(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеФлажка("Флажок"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеФлажка --title "Флажок" - ``` - - - - ```batch - oint airtable ПолучитьПолеФлажка ^ - --title "Флажок" - ``` - - - - -```json title="Результат" -{ - "name": "Флажок", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.mdx new file mode 100644 index 0000000000..e2c7755c47 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить поле (флажок) + Получает описание поля типа булево + + + +`Функция ПолучитьПолеФлажка(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеФлажка("Флажок"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеФлажка --title "Флажок" + ``` + + + + ```batch + oint airtable ПолучитьПолеФлажка ^ + --title "Флажок" + ``` + + + + +```json title="Результат" +{ + "name": "Флажок", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md deleted file mode 100644 index be540da5ac..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить поле (дата) - Получает описание поля типа дата - - - -`Функция ПолучитьПолеДаты(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеДаты("Дата"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеДаты --title "Дата" - ``` - - - - ```batch - oint airtable ПолучитьПолеДаты ^ - --title "Дата" - ``` - - - - -```json title="Результат" -{ - "name": "Дата", - "type": "date", - "options": { - "dateFormat": { - "format": "YYYY-MM-DD", - "name": "iso" - } - } -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-date-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-date-field.mdx new file mode 100644 index 0000000000..02d19c422e --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-date-field.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить поле (дата) + Получает описание поля типа дата + + + +`Функция ПолучитьПолеДаты(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеДаты("Дата"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеДаты --title "Дата" + ``` + + + + ```batch + oint airtable ПолучитьПолеДаты ^ + --title "Дата" + ``` + + + + +```json title="Результат" +{ + "name": "Дата", + "type": "date", + "options": { + "dateFormat": { + "format": "YYYY-MM-DD", + "name": "iso" + } + } +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md deleted file mode 100644 index 5c5d4f25f9..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить поле (email) - Получает описание поля с электронной почтой - - - -`Функция ПолучитьПолеПочты(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеПочты("Почта"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеПочты --title "Почта" - ``` - - - - ```batch - oint airtable ПолучитьПолеПочты ^ - --title "Почта" - ``` - - - - -```json title="Результат" -{ - "name": "Почта", - "type": "email" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-email-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-email-field.mdx new file mode 100644 index 0000000000..00bad8d2a2 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-email-field.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить поле (email) + Получает описание поля с электронной почтой + + + +`Функция ПолучитьПолеПочты(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеПочты("Почта"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеПочты --title "Почта" + ``` + + + + ```batch + oint airtable ПолучитьПолеПочты ^ + --title "Почта" + ``` + + + + +```json title="Результат" +{ + "name": "Почта", + "type": "email" +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md deleted file mode 100644 index c3c93a38ab..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Получить поле (url) - Получает описание поля с URL - - - -`Функция ПолучитьПолеСсылки(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеСсылки("Ссылка"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеСсылки --title "Ссылка" - ``` - - - - ```batch - oint airtable ПолучитьПолеСсылки ^ - --title "Ссылка" - ``` - - - - -```json title="Результат" -{ - "name": "Ссылка", - "type": "url" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-link-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-link-field.mdx new file mode 100644 index 0000000000..2de16700cc --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-link-field.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Получить поле (url) + Получает описание поля с URL + + + +`Функция ПолучитьПолеСсылки(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеСсылки("Ссылка"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеСсылки --title "Ссылка" + ``` + + + + ```batch + oint airtable ПолучитьПолеСсылки ^ + --title "Ссылка" + ``` + + + + +```json title="Результат" +{ + "name": "Ссылка", + "type": "url" +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md deleted file mode 100644 index fa063a9ab4..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить поле (числовое) - Получает описание поля числового типа - - - -`Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование нового поля | - | Точность | --precision | Число,Строка | Число знаков после запятой | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеНомера("Номер"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеНомера --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" - ``` - - - - ```batch - oint airtable ПолучитьПолеНомера ^ - --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" - ``` - - - - -```json title="Результат" -{ - "name": "Номер", - "type": "number", - "options": { - "precision": 0 - } -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-number-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-number-field.mdx new file mode 100644 index 0000000000..901ec4004c --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-number-field.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить поле (числовое) + Получает описание поля числового типа + + + +`Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование нового поля | + | Точность | --precision | Число,Строка | Число знаков после запятой | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеНомера("Номер"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеНомера --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" + ``` + + + + ```batch + oint airtable ПолучитьПолеНомера ^ + --title "bf234b4a-f391-4950-8fd0-90e8817e19e4" + ``` + + + + +```json title="Результат" +{ + "name": "Номер", + "type": "number", + "options": { + "precision": 0 + } +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md deleted file mode 100644 index f1cfdf5fa8..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Получить поле (телефон) - Получает описание поля с номером телефона - - - -`Функция ПолучитьПолеТелефона(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеТелефона("Телефон"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеТелефона --title "Телефон" - ``` - - - - ```batch - oint airtable ПолучитьПолеТелефона ^ - --title "Телефон" - ``` - - - - -```json title="Результат" -{ - "name": "Телефон", - "type": "phoneNumber" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.mdx new file mode 100644 index 0000000000..2ea188d897 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Получить поле (телефон) + Получает описание поля с номером телефона + + + +`Функция ПолучитьПолеТелефона(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеТелефона("Телефон"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеТелефона --title "Телефон" + ``` + + + + ```batch + oint airtable ПолучитьПолеТелефона ^ + --title "Телефон" + ``` + + + + +```json title="Результат" +{ + "name": "Телефон", + "type": "phoneNumber" +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md deleted file mode 100644 index 936775e96a..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить поле (строковое) - Получает описание поля строкового типа - - - -`Функция ПолучитьПолеСтроковое(Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование нового поля | - - - Возвращаемое значение: Структура - Описание поля - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Airtable.ПолучитьПолеСтроковое("Строковое"); -``` - - - - - - ```bash - oint airtable ПолучитьПолеСтроковое --title "Строковое" - ``` - - - - ```batch - oint airtable ПолучитьПолеСтроковое ^ - --title "Строковое" - ``` - - - - -```json title="Результат" -{ - "name": "Строковое", - "type": "richText" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-string-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Get-string-field.mdx new file mode 100644 index 0000000000..6d40efc6be --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Get-string-field.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить поле (строковое) + Получает описание поля строкового типа + + + +`Функция ПолучитьПолеСтроковое(Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование нового поля | + + + Возвращаемое значение: Структура - Описание поля + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Airtable.ПолучитьПолеСтроковое("Строковое"); +``` + + + + + + ```bash + oint airtable ПолучитьПолеСтроковое --title "Строковое" + ``` + + + + ```batch + oint airtable ПолучитьПолеСтроковое ^ + --title "Строковое" + ``` + + + + +```json title="Результат" +{ + "name": "Строковое", + "type": "richText" +} +``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Modify-field.md b/docs/ru/md/Airtable/Working-with-fields/Modify-field.md deleted file mode 100644 index c5f7b21ed8..0000000000 --- a/docs/ru/md/Airtable/Working-with-fields/Modify-field.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить поле - Изменяет имя и|или описание существующего поля таблицы - - - -`Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы База | - | Таблица | --table | Строка | Идентификатор таблицы | - | Поле | --field | Строка | Идентификатор поля | - | Наименование | --title | Строка | Новое наименование | - | Описание | --description | Строка | Новое описание | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -
- - - - -```bsl title="Пример кода" - Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; - База = "appESy99HYCLbuWlV"; - Таблица = "tbl5gZLQ8i5xKuVTy"; - Поле = "fldzPMAQ2obgGcvxG"; - - Имя = Строка(Новый УникальныйИдентификатор) + "(изм.)"; - Описание = "Новое описание"; - - Результат = OPI_Airtable.ИзменитьПоле(Токен, База, Таблица, Поле, Имя, Описание); -``` - - - - - - ```bash - oint airtable ИзменитьПоле --token "***" \ - --base "app0r5m50QN7nWAAv" \ - --table "tbl99eHW7uVpn8cdR" \ - --field "fld1Zk1Ge9yDx5iAq" \ - --title "02e54087-9009-41b8-a1cb-02fd47d372ef(изм.)" \ - --description "Новое описание" - ``` - - - - ```batch - oint airtable ИзменитьПоле ^ - --token "***" ^ - --base "app0r5m50QN7nWAAv" ^ - --table "tbl99eHW7uVpn8cdR" ^ - --field "fld1Zk1Ge9yDx5iAq" ^ - --title "02e54087-9009-41b8-a1cb-02fd47d372ef(изм.)" ^ - --description "Новое описание" - ``` - - - - -```json title="Результат" -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldVcZeSTEx69J6u2", - "name": "12ed7670-e343-4773-87b4-de3ff5855144(изм.)", - "description": "Новое описание" -} -``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Modify-field.mdx b/docs/ru/md/Airtable/Working-with-fields/Modify-field.mdx new file mode 100644 index 0000000000..b2f2739de2 --- /dev/null +++ b/docs/ru/md/Airtable/Working-with-fields/Modify-field.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить поле + Изменяет имя и|или описание существующего поля таблицы + + + +`Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы База | + | Таблица | --table | Строка | Идентификатор таблицы | + | Поле | --field | Строка | Идентификатор поля | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +
+ + + + +```bsl title="Пример кода" + Токен = "patNn4BXW66Yx3pdj.5b93c53cab554a8387de02d..."; + База = "appESy99HYCLbuWlV"; + Таблица = "tbl5gZLQ8i5xKuVTy"; + Поле = "fldzPMAQ2obgGcvxG"; + + Имя = Строка(Новый УникальныйИдентификатор) + "(изм.)"; + Описание = "Новое описание"; + + Результат = OPI_Airtable.ИзменитьПоле(Токен, База, Таблица, Поле, Имя, Описание); +``` + + + + + + ```bash + oint airtable ИзменитьПоле --token "***" \ + --base "app0r5m50QN7nWAAv" \ + --table "tbl99eHW7uVpn8cdR" \ + --field "fld1Zk1Ge9yDx5iAq" \ + --title "02e54087-9009-41b8-a1cb-02fd47d372ef(изм.)" \ + --description "Новое описание" + ``` + + + + ```batch + oint airtable ИзменитьПоле ^ + --token "***" ^ + --base "app0r5m50QN7nWAAv" ^ + --table "tbl99eHW7uVpn8cdR" ^ + --field "fld1Zk1Ge9yDx5iAq" ^ + --title "02e54087-9009-41b8-a1cb-02fd47d372ef(изм.)" ^ + --description "Новое описание" + ``` + + + + +```json title="Результат" +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldVcZeSTEx69J6u2", + "name": "12ed7670-e343-4773-87b4-de3ff5855144(изм.)", + "description": "Новое описание" +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md deleted file mode 100644 index 3529c620a5..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать подкаталог - Создает каталог внутри другого каталога - - - -`Функция СоздатьПодкаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога родителя | - | Наименование | --title | Строка | Наименование нового каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) -::: -
- - -```bsl title="Пример кода" - IDКаталога = "12882"; - Наименование = "Новый подкаталог"; - Наименование2 = "Новый подкаталог 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование2); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12466, - "NAME": "Новый подкаталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 12466, - "PARENT_ID": "12462", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-10-08T20:49:29+03:00", - "UPDATE_TIME": "2024-10-08T20:49:29+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" - }, - "time": { - "start": 1728409769.53947, - "finish": 1728409769.60822, - "duration": 0.0687508583068848, - "processing": 0.041658878326416, - "date_start": "2024-10-08T20:49:29+03:00", - "date_finish": "2024-10-08T20:49:29+03:00", - "operating_reset_at": 1728410369, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx new file mode 100644 index 0000000000..422eb2ee86 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать подкаталог + Создает каталог внутри другого каталога + + + +`Функция СоздатьПодкаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога родителя | + | Наименование | --title | Строка | Наименование нового каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) +::: +
+ + +```bsl title="Пример кода" + IDКаталога = "12882"; + Наименование = "Новый подкаталог"; + Наименование2 = "Новый подкаталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование2); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12466, + "NAME": "Новый подкаталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 12466, + "PARENT_ID": "12462", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-10-08T20:49:29+03:00", + "UPDATE_TIME": "2024-10-08T20:49:29+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" + }, + "time": { + "start": 1728409769.53947, + "finish": 1728409769.60822, + "duration": 0.0687508583068848, + "processing": 0.041658878326416, + "date_start": "2024-10-08T20:49:29+03:00", + "date_finish": "2024-10-08T20:49:29+03:00", + "operating_reset_at": 1728410369, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md deleted file mode 100644 index b9dbfddeba..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить каталог - Удаляет каталог с подкаталогами - - - -`Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор удаляемого каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКаталога = "12880"; - - Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDКаталога = "12882"; - - Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409774.76576, - "finish": 1728409774.84899, - "duration": 0.0832359790802002, - "processing": 0.0593221187591553, - "date_start": "2024-10-08T20:49:34+03:00", - "date_finish": "2024-10-08T20:49:34+03:00", - "operating_reset_at": 1728410374, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.mdx new file mode 100644 index 0000000000..ebffae6380 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить каталог + Удаляет каталог с подкаталогами + + + +`Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор удаляемого каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКаталога = "12880"; + + Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDКаталога = "12882"; + + Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409774.76576, + "finish": 1728409774.84899, + "duration": 0.0832359790802002, + "processing": 0.0593221187591553, + "date_start": "2024-10-08T20:49:34+03:00", + "date_finish": "2024-10-08T20:49:34+03:00", + "operating_reset_at": 1728410374, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md deleted file mode 100644 index 0c5d24796f..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить внешнюю ссылку каталога - Получает внешнюю ссылку для доступа к каталогу - - - -`Функция ПолучитьВнешнююСсылкуКаталога(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКаталога = "12882"; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога, Токен); -``` - - - - -```json title="Результат" -{ - "result": "https://b24-ar17wx.bitrix24.by/~zTBjd", - "time": { - "start": 1728409769.33304, - "finish": 1728409769.36881, - "duration": 0.0357630252838135, - "processing": 0.00747108459472656, - "date_start": "2024-10-08T20:49:29+03:00", - "date_finish": "2024-10-08T20:49:29+03:00", - "operating_reset_at": 1728410369, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.mdx new file mode 100644 index 0000000000..71af3144af --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить внешнюю ссылку каталога + Получает внешнюю ссылку для доступа к каталогу + + + +`Функция ПолучитьВнешнююСсылкуКаталога(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКаталога = "12882"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога, Токен); +``` + + + + +```json title="Результат" +{ + "result": "https://b24-ar17wx.bitrix24.by/~zTBjd", + "time": { + "start": 1728409769.33304, + "finish": 1728409769.36881, + "duration": 0.0357630252838135, + "processing": 0.00747108459472656, + "date_start": "2024-10-08T20:49:29+03:00", + "date_finish": "2024-10-08T20:49:29+03:00", + "operating_reset_at": 1728410369, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md deleted file mode 100644 index 9030d13e3b..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Получить структуру фильтра каталога - Возвращает структуру полей для фильтрации дочерних элементов каталога - - - -`Функция ПолучитьСтруктуруФильтраКаталога(Знач URL, Знач Пустая = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- -:::tip -Метод в документации API: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL, Истина, Токен); -``` - - - - -```json title="Результат" -{ - "ID": "", - "NAME": "", - "TYPE": "", - "CODE": "", - "STORAGE_ID": "", - "PARENT_ID": "", - "CREATE_TIME": "", - "UPDATE_TIME": "", - "DELETE_TIME": "", - "DELETED_TYPE": "" -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.mdx new file mode 100644 index 0000000000..824ab65228 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Получить структуру фильтра каталога + Возвращает структуру полей для фильтрации дочерних элементов каталога + + + +`Функция ПолучитьСтруктуруФильтраКаталога(Знач URL, Знач Пустая = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ +:::tip +Метод в документации API: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL, Истина, Токен); +``` + + + + +```json title="Результат" +{ + "ID": "", + "NAME": "", + "TYPE": "", + "CODE": "", + "STORAGE_ID": "", + "PARENT_ID": "", + "CREATE_TIME": "", + "UPDATE_TIME": "", + "DELETE_TIME": "", + "DELETED_TYPE": "" +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md deleted file mode 100644 index e0e0625165..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о каталоге - Получает информацию о каталоге - - - -`Функция ПолучитьИнформациюОКаталоге(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКаталога = "12882"; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12462", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12462", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-08T20:49:28+03:00", - "UPDATE_TIME": "2024-10-08T20:49:28+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1728409769.15226, - "finish": 1728409769.18372, - "duration": 0.0314629077911377, - "processing": 0.00575494766235352, - "date_start": "2024-10-08T20:49:29+03:00", - "date_finish": "2024-10-08T20:49:29+03:00", - "operating_reset_at": 1728410369, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.mdx new file mode 100644 index 0000000000..9502dfee21 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить информацию о каталоге + Получает информацию о каталоге + + + +`Функция ПолучитьИнформациюОКаталоге(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКаталога = "12882"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12462", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12462", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-08T20:49:28+03:00", + "UPDATE_TIME": "2024-10-08T20:49:28+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1728409769.15226, + "finish": 1728409769.18372, + "duration": 0.0314629077911377, + "processing": 0.00575494766235352, + "date_start": "2024-10-08T20:49:29+03:00", + "date_finish": "2024-10-08T20:49:29+03:00", + "operating_reset_at": 1728410369, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md deleted file mode 100644 index 168d6d6343..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить дочерние элементы каталога - Получает дочерние элементы каталога - - - -`Функция ПолучитьДочерниеЭлементыКаталога(Знач URL, Знач IDКаталога, Знач Фильтр = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Фильтр | --filter | Структура из КлючИЗначение | Отбор элементов (См. ПолучитьСтруктуруФильтраКаталога) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКаталога = "12882"; - - Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога, , Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "12464", - "NAME": "Новый подкаталог 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12464", - "PARENT_ID": "12462", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-08T20:49:29+03:00", - "UPDATE_TIME": "2024-10-08T20:49:29+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог 2" - }, - { - "ID": "12466", - "NAME": "Новый подкаталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12466", - "PARENT_ID": "12462", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-08T20:49:29+03:00", - "UPDATE_TIME": "2024-10-08T20:49:30+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" - }, - { - "ID": "12484", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "12462", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8598", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:33+03:00", - "UPDATE_TIME": "2024-10-08T20:49:33+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0ODQmXz13ZmZYeEVGUlYxMGZ3ZkFiRGRkNzMwaVdxemJZblVnYQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBPRFFtWHoxM1ptWlllRVZHVWxZeE1HWjNaa0ZpUkdSa056TXdhVmR4ZW1KWmJsVm5ZUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.B3XddP%2FBGE1sSooNNYv4OIYxMWO96RY5ZDzpO%2BF1FDw%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новое имя файла.jpg" - } - ], - "total": 3, - "time": { - "start": 1728409773.82779, - "finish": 1728409773.86297, - "duration": 0.0351810455322266, - "processing": 0.00868701934814453, - "date_start": "2024-10-08T20:49:33+03:00", - "date_finish": "2024-10-08T20:49:33+03:00", - "operating_reset_at": 1728410373, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx new file mode 100644 index 0000000000..d8e0db14ad --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.mdx @@ -0,0 +1,118 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить дочерние элементы каталога + Получает дочерние элементы каталога + + + +`Функция ПолучитьДочерниеЭлементыКаталога(Знач URL, Знач IDКаталога, Знач Фильтр = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Фильтр | --filter | Структура из КлючИЗначение | Отбор элементов (См. ПолучитьСтруктуруФильтраКаталога) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКаталога = "12882"; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога, , Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "12464", + "NAME": "Новый подкаталог 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12464", + "PARENT_ID": "12462", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-08T20:49:29+03:00", + "UPDATE_TIME": "2024-10-08T20:49:29+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог 2" + }, + { + "ID": "12466", + "NAME": "Новый подкаталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12466", + "PARENT_ID": "12462", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-08T20:49:29+03:00", + "UPDATE_TIME": "2024-10-08T20:49:30+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" + }, + { + "ID": "12484", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "12462", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8598", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:33+03:00", + "UPDATE_TIME": "2024-10-08T20:49:33+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0ODQmXz13ZmZYeEVGUlYxMGZ3ZkFiRGRkNzMwaVdxemJZblVnYQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBPRFFtWHoxM1ptWlllRVZHVWxZeE1HWjNaa0ZpUkdSa056TXdhVmR4ZW1KWmJsVm5ZUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.B3XddP%2FBGE1sSooNNYv4OIYxMWO96RY5ZDzpO%2BF1FDw%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новое имя файла.jpg" + } + ], + "total": 3, + "time": { + "start": 1728409773.82779, + "finish": 1728409773.86297, + "duration": 0.0351810455322266, + "processing": 0.00868701934814453, + "date_start": "2024-10-08T20:49:33+03:00", + "date_finish": "2024-10-08T20:49:33+03:00", + "operating_reset_at": 1728410373, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md deleted file mode 100644 index bb32d326c5..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Скопировать каталог - Копирует один каталог в другой - - - -`Функция СкопироватьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) -::: -
- - -```bsl title="Пример кода" - IDПриемника = "12884"; - IDКаталога = "12886"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника); - - IDПриемника = "12886"; - IDКаталога = "12884"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника, Токен); - - OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12472, - "NAME": "Новый подкаталог 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 12472, - "PARENT_ID": "12466", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-10-08T20:49:30+03:00", - "UPDATE_TIME": "2024-10-08T20:49:30+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог/Новый подкаталог 2" - }, - "time": { - "start": 1728409770.02789, - "finish": 1728409770.13494, - "duration": 0.10704517364502, - "processing": 0.0823779106140137, - "date_start": "2024-10-08T20:49:30+03:00", - "date_finish": "2024-10-08T20:49:30+03:00", - "operating_reset_at": 1728410370, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx new file mode 100644 index 0000000000..6cface55c1 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Скопировать каталог + Копирует один каталог в другой + + + +`Функция СкопироватьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) +::: +
+ + +```bsl title="Пример кода" + IDПриемника = "12884"; + IDКаталога = "12886"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника); + + IDПриемника = "12886"; + IDКаталога = "12884"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника, Токен); + + OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12472, + "NAME": "Новый подкаталог 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 12472, + "PARENT_ID": "12466", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-10-08T20:49:30+03:00", + "UPDATE_TIME": "2024-10-08T20:49:30+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог/Новый подкаталог 2" + }, + "time": { + "start": 1728409770.02789, + "finish": 1728409770.13494, + "duration": 0.10704517364502, + "processing": 0.0823779106140137, + "date_start": "2024-10-08T20:49:30+03:00", + "date_finish": "2024-10-08T20:49:30+03:00", + "operating_reset_at": 1728410370, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md deleted file mode 100644 index 00be0a4c30..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Поместить каталог в корзину - Перемещает каталог в корзину удаляемых файлов - - - -`Функция ПоместитьКаталогВКорзину(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКаталога = "12882"; - - Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12462", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12462", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "CREATE_TIME": "2024-10-08T20:49:28+03:00", - "UPDATE_TIME": "2024-10-08T20:49:33+03:00", - "DELETE_TIME": "2024-10-08T20:49:34+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1728409774.25205, - "finish": 1728409774.28336, - "duration": 0.0313057899475098, - "processing": 0.00595617294311524, - "date_start": "2024-10-08T20:49:34+03:00", - "date_finish": "2024-10-08T20:49:34+03:00", - "operating_reset_at": 1728410374, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.mdx new file mode 100644 index 0000000000..44d5ba8bc7 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Поместить каталог в корзину + Перемещает каталог в корзину удаляемых файлов + + + +`Функция ПоместитьКаталогВКорзину(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКаталога = "12882"; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12462", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12462", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "CREATE_TIME": "2024-10-08T20:49:28+03:00", + "UPDATE_TIME": "2024-10-08T20:49:33+03:00", + "DELETE_TIME": "2024-10-08T20:49:34+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1728409774.25205, + "finish": 1728409774.28336, + "duration": 0.0313057899475098, + "processing": 0.00595617294311524, + "date_start": "2024-10-08T20:49:34+03:00", + "date_finish": "2024-10-08T20:49:34+03:00", + "operating_reset_at": 1728410374, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md deleted file mode 100644 index 1054faea2c..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Переместить каталог - Перемещает один каталог внутрь другого - - - -`Функция ПереместитьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) -::: -
- - -```bsl title="Пример кода" - IDПриемника = "12880"; - IDКаталога = "12886"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника); - - IDКаталога = "12884"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника, Токен); - - OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12464", - "NAME": "Новый подкаталог 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12464", - "PARENT_ID": 12460, - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-08T20:49:29+03:00", - "UPDATE_TIME": "2024-10-08T20:49:29+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог 2/Новый подкаталог 2" - }, - "time": { - "start": 1728409774.02351, - "finish": 1728409774.07968, - "duration": 0.0561709403991699, - "processing": 0.0297579765319824, - "date_start": "2024-10-08T20:49:34+03:00", - "date_finish": "2024-10-08T20:49:34+03:00", - "operating_reset_at": 1728410374, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.mdx new file mode 100644 index 0000000000..951c623083 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Переместить каталог + Перемещает один каталог внутрь другого + + + +`Функция ПереместитьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) +::: +
+ + +```bsl title="Пример кода" + IDПриемника = "12880"; + IDКаталога = "12886"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника); + + IDКаталога = "12884"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника, Токен); + + OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12464", + "NAME": "Новый подкаталог 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12464", + "PARENT_ID": 12460, + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-08T20:49:29+03:00", + "UPDATE_TIME": "2024-10-08T20:49:29+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог 2/Новый подкаталог 2" + }, + "time": { + "start": 1728409774.02351, + "finish": 1728409774.07968, + "duration": 0.0561709403991699, + "processing": 0.0297579765319824, + "date_start": "2024-10-08T20:49:34+03:00", + "date_finish": "2024-10-08T20:49:34+03:00", + "operating_reset_at": 1728410374, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md deleted file mode 100644 index 49619818c9..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Переименовать каталог - Изменяет имя каталога - - - -`Функция ПереименоватьКаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Наименование | --title | Строка | Новое наименование каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новый каталог"; - Наименование2 = "Новый каталог 2"; - - IDКаталога2 = "12880"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога2, Наименование2); - - IDКаталога = "12882"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога, Наименование, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12462", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12462", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-08T20:49:28+03:00", - "UPDATE_TIME": "2024-10-08T20:49:28+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1728409768.98211, - "finish": 1728409769.01619, - "duration": 0.0340840816497803, - "processing": 0.00900101661682129, - "date_start": "2024-10-08T20:49:28+03:00", - "date_finish": "2024-10-08T20:49:29+03:00", - "operating_reset_at": 1728410369, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.mdx new file mode 100644 index 0000000000..c4f5422721 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Переименовать каталог + Изменяет имя каталога + + + +`Функция ПереименоватьКаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Наименование | --title | Строка | Новое наименование каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + IDКаталога2 = "12880"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога2, Наименование2); + + IDКаталога = "12882"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога, Наименование, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12462", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12462", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-08T20:49:28+03:00", + "UPDATE_TIME": "2024-10-08T20:49:28+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1728409768.98211, + "finish": 1728409769.01619, + "duration": 0.0340840816497803, + "processing": 0.00900101661682129, + "date_start": "2024-10-08T20:49:28+03:00", + "date_finish": "2024-10-08T20:49:29+03:00", + "operating_reset_at": 1728410369, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md deleted file mode 100644 index 7201789d9b..0000000000 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Восстановить каталог - Восстанавливает каталог из корзины - - - -`Функция ВосстановитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКаталога = "12882"; - - Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12462", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "12462", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-10-08T20:49:28+03:00", - "UPDATE_TIME": "2024-10-08T20:49:34+03:00", - "DELETE_TIME": "2024-10-08T20:49:34+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1728409774.45058, - "finish": 1728409774.48787, - "duration": 0.0372822284698486, - "processing": 0.0055229663848877, - "date_start": "2024-10-08T20:49:34+03:00", - "date_finish": "2024-10-08T20:49:34+03:00", - "operating_reset_at": 1728410374, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.mdx b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.mdx new file mode 100644 index 0000000000..dba72024c0 --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Восстановить каталог + Восстанавливает каталог из корзины + + + +`Функция ВосстановитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКаталога = "12882"; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12462", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "12462", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-10-08T20:49:28+03:00", + "UPDATE_TIME": "2024-10-08T20:49:34+03:00", + "DELETE_TIME": "2024-10-08T20:49:34+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1728409774.45058, + "finish": 1728409774.48787, + "duration": 0.0372822284698486, + "processing": 0.0055229663848877, + "date_start": "2024-10-08T20:49:34+03:00", + "date_finish": "2024-10-08T20:49:34+03:00", + "operating_reset_at": 1728410374, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md deleted file mode 100644 index a0830f1273..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Добавить пользователей в чат - Добавляет пользователей в чат по массиву ID - - - -`Функция ДобавитьПользователейВЧат(Знач URL, Знач IDЧата, Знач IDПользователей, Знач СкрытьИсторию = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDПользователей | --users | Массив из Строка, Число | ID пользователей для добавления | - | СкрытьИсторию | --hide | Булево | Скрыть старые сообщения от новых пользователей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - IDПользователей = Новый Массив; - IDПользователей.Добавить(10); - IDПользователей.Добавить(12); - - Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователей); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователя, Истина, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409816.58707, - "finish": 1728409816.66978, - "duration": 0.0827090740203858, - "processing": 0.0549631118774414, - "date_start": "2024-10-08T20:50:16+03:00", - "date_finish": "2024-10-08T20:50:16+03:00", - "operating_reset_at": 1728410416, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.mdx new file mode 100644 index 0000000000..1e3401c4fe --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Добавить пользователей в чат + Добавляет пользователей в чат по массиву ID + + + +`Функция ДобавитьПользователейВЧат(Знач URL, Знач IDЧата, Знач IDПользователей, Знач СкрытьИсторию = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователей | --users | Массив из Строка, Число | ID пользователей для добавления | + | СкрытьИсторию | --hide | Булево | Скрыть старые сообщения от новых пользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + IDПользователей = Новый Массив; + IDПользователей.Добавить(10); + IDПользователей.Добавить(12); + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователей); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователя, Истина, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409816.58707, + "finish": 1728409816.66978, + "duration": 0.0827090740203858, + "processing": 0.0549631118774414, + "date_start": "2024-10-08T20:50:16+03:00", + "date_finish": "2024-10-08T20:50:16+03:00", + "operating_reset_at": 1728410416, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md deleted file mode 100644 index 0cae7ed894..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Изменить цвет чата - Изменяет цвет чата для мобильного приложения - - - -`Функция ИзменитьЦветЧата(Знач URL, Знач IDЧата, Знач Цвет, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Цвет | --color | Строка | Новый цвет чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) - - Доступные цвета: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Цвет = "AZURE"; - - Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Цвет = "PURPLE"; - - Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409832.14471, - "finish": 1728409832.2332, - "duration": 0.0884890556335449, - "processing": 0.0611250400543213, - "date_start": "2024-10-08T20:50:32+03:00", - "date_finish": "2024-10-08T20:50:32+03:00", - "operating_reset_at": 1728410432, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.mdx new file mode 100644 index 0000000000..567c979a8e --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Изменить цвет чата + Изменяет цвет чата для мобильного приложения + + + +`Функция ИзменитьЦветЧата(Знач URL, Знач IDЧата, Знач Цвет, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Цвет | --color | Строка | Новый цвет чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) + + Доступные цвета: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Цвет = "AZURE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Цвет = "PURPLE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409832.14471, + "finish": 1728409832.2332, + "duration": 0.0884890556335449, + "processing": 0.0611250400543213, + "date_start": "2024-10-08T20:50:32+03:00", + "date_finish": "2024-10-08T20:50:32+03:00", + "operating_reset_at": 1728410432, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md deleted file mode 100644 index 2f7938bd74..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Сменить владельца чата - Изменяет пользователя владельца чата - - - -`Функция СменитьВладельцаЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDПользователя | --user | Строка, Число | ID пользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - IDПользователя = 10; - - Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409860.3686, - "finish": 1728409860.41054, - "duration": 0.0419361591339111, - "processing": 0.0139150619506836, - "date_start": "2024-10-08T20:51:00+03:00", - "date_finish": "2024-10-08T20:51:00+03:00", - "operating_reset_at": 1728410460, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.mdx new file mode 100644 index 0000000000..ca7526f8b0 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Сменить владельца чата + Изменяет пользователя владельца чата + + + +`Функция СменитьВладельцаЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователя | --user | Строка, Число | ID пользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409860.3686, + "finish": 1728409860.41054, + "duration": 0.0419361591339111, + "processing": 0.0139150619506836, + "date_start": "2024-10-08T20:51:00+03:00", + "date_finish": "2024-10-08T20:51:00+03:00", + "operating_reset_at": 1728410460, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md deleted file mode 100644 index c72ef661f5..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Изменить картинку чата - Устанавливает новую картинку чата - - - -`Функция ИзменитьКартинкуЧата(Знач URL, Знач IDЧата, Знач Картинка, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Картинка | --picture | Строка, ДвоичныеДанные | Данные файла картинки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Картинка = "https://api.athenaeum.digital/test_data/picture2.jpg"; - - Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409834.39311, - "finish": 1728409835.28099, - "duration": 0.887876033782959, - "processing": 0.862776041030884, - "date_start": "2024-10-08T20:50:34+03:00", - "date_finish": "2024-10-08T20:50:35+03:00", - "operating_reset_at": 1728410434, - "operating": 0.862759113311768 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.mdx new file mode 100644 index 0000000000..10823ed0bb --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Изменить картинку чата + Устанавливает новую картинку чата + + + +`Функция ИзменитьКартинкуЧата(Знач URL, Знач IDЧата, Знач Картинка, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Картинка | --picture | Строка, ДвоичныеДанные | Данные файла картинки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Картинка = "https://api.athenaeum.digital/test_data/picture2.jpg"; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409834.39311, + "finish": 1728409835.28099, + "duration": 0.887876033782959, + "processing": 0.862776041030884, + "date_start": "2024-10-08T20:50:34+03:00", + "date_finish": "2024-10-08T20:50:35+03:00", + "operating_reset_at": 1728410434, + "operating": 0.862759113311768 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md deleted file mode 100644 index a7811561e6..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Изменить заголовок чата - Изменяет текст заголовка чата - - - -`Функция ИзменитьЗаголовокЧата(Знач URL, Знач IDЧата, Знач Заголовок, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Заголовок | --title | Строка | Новый текст заголовка | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Заголовок = "Новый заголовок чата"; - - Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Заголовок = "Другой заголовок чата"; - - Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409816.8628, - "finish": 1728409816.94037, - "duration": 0.0775649547576904, - "processing": 0.0505979061126709, - "date_start": "2024-10-08T20:50:16+03:00", - "date_finish": "2024-10-08T20:50:16+03:00", - "operating_reset_at": 1728410416, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.mdx new file mode 100644 index 0000000000..4a6b800ee3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Изменить заголовок чата + Изменяет текст заголовка чата + + + +`Функция ИзменитьЗаголовокЧата(Знач URL, Знач IDЧата, Знач Заголовок, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Заголовок | --title | Строка | Новый текст заголовка | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Заголовок = "Новый заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Заголовок = "Другой заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409816.8628, + "finish": 1728409816.94037, + "duration": 0.0775649547576904, + "processing": 0.0505979061126709, + "date_start": "2024-10-08T20:50:16+03:00", + "date_finish": "2024-10-08T20:50:16+03:00", + "operating_reset_at": 1728410416, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md deleted file mode 100644 index d3c4c6ba86..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать чат - Создает новый чат на основе структуры полей - - - -`Функция СоздатьЧат(Знач URL, Знач СтруктураЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураЧата | --fields | Структура Из КлючИЗначение | Структура полей чата. См. ПолучитьСтруктуруЧата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) -::: -
- - -```bsl title="Пример кода" - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); - - B64Картинка = ПолучитьBase64СтрокуИзДвоичныхДанных(Картинка); - - МассивУчастников = Новый Массив; - МассивУчастников.Добавить(10); - МассивУчастников.Добавить(1); - - СтруктураЧата = Новый Структура; - СтруктураЧата.Вставить("TYPE" , "OPEN"); - СтруктураЧата.Вставить("TITLE" , "Новый чат"); - СтруктураЧата.Вставить("DESCRIPTION", "Это новый чат"); - СтруктураЧата.Вставить("COLOR" , "GREEN"); - СтруктураЧата.Вставить("MESSAGE" , "Добро пожаловать в новый чат"); - СтруктураЧата.Вставить("USERS" , МассивУчастников); - СтруктураЧата.Вставить("AVATAR" , B64Картинка); - СтруктураЧата.Вставить("OWNER_ID" , 1); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - СтруктураЧата = Новый Структура; - СтруктураЧата.Вставить("TYPE" , "CHAT"); - СтруктураЧата.Вставить("TITLE" , "Закрытый чат"); - СтруктураЧата.Вставить("USERS" , МассивУчастников); - - Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата, Токен); -``` - - - - -```json title="Результат" -{ - "result": 980, - "time": { - "start": 1728409810.7369, - "finish": 1728409810.85547, - "duration": 0.118574142456055, - "processing": 0.0917420387268066, - "date_start": "2024-10-08T20:50:10+03:00", - "date_finish": "2024-10-08T20:50:10+03:00", - "operating_reset_at": 1728410410, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.mdx new file mode 100644 index 0000000000..8eeb16b0ae --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать чат + Создает новый чат на основе структуры полей + + + +`Функция СоздатьЧат(Знач URL, Знач СтруктураЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураЧата | --fields | Структура Из КлючИЗначение | Структура полей чата. См. ПолучитьСтруктуруЧата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) +::: +
+ + +```bsl title="Пример кода" + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); + + B64Картинка = ПолучитьBase64СтрокуИзДвоичныхДанных(Картинка); + + МассивУчастников = Новый Массив; + МассивУчастников.Добавить(10); + МассивУчастников.Добавить(1); + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "OPEN"); + СтруктураЧата.Вставить("TITLE" , "Новый чат"); + СтруктураЧата.Вставить("DESCRIPTION", "Это новый чат"); + СтруктураЧата.Вставить("COLOR" , "GREEN"); + СтруктураЧата.Вставить("MESSAGE" , "Добро пожаловать в новый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + СтруктураЧата.Вставить("AVATAR" , B64Картинка); + СтруктураЧата.Вставить("OWNER_ID" , 1); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "CHAT"); + СтруктураЧата.Вставить("TITLE" , "Закрытый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата, Токен); +``` + + + + +```json title="Результат" +{ + "result": 980, + "time": { + "start": 1728409810.7369, + "finish": 1728409810.85547, + "duration": 0.118574142456055, + "processing": 0.0917420387268066, + "date_start": "2024-10-08T20:50:10+03:00", + "date_finish": "2024-10-08T20:50:10+03:00", + "operating_reset_at": 1728410410, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md deleted file mode 100644 index 9c6fcf163f..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Исключить пользователя из чата - Исключает выбранного пользователя из чата - - - -`Функция ИсключитьПользователяИзЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDПользователя | --user | Строка, Число | ID пользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - IDПользователя = 10; - - Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409816.28382, - "finish": 1728409816.37813, - "duration": 0.0943031311035156, - "processing": 0.0685210227966309, - "date_start": "2024-10-08T20:50:16+03:00", - "date_finish": "2024-10-08T20:50:16+03:00", - "operating_reset_at": 1728410416, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.mdx new file mode 100644 index 0000000000..3a43fcef7b --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Исключить пользователя из чата + Исключает выбранного пользователя из чата + + + +`Функция ИсключитьПользователяИзЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователя | --user | Строка, Число | ID пользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409816.28382, + "finish": 1728409816.37813, + "duration": 0.0943031311035156, + "processing": 0.0685210227966309, + "date_start": "2024-10-08T20:50:16+03:00", + "date_finish": "2024-10-08T20:50:16+03:00", + "operating_reset_at": 1728410416, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md deleted file mode 100644 index e04000ce2b..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Отключить уведомления чата - Отключает уведомлений чата - - - -`Функция ОтключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409835.44261, - "finish": 1728409835.48699, - "duration": 0.0443859100341797, - "processing": 0.0175070762634277, - "date_start": "2024-10-08T20:50:35+03:00", - "date_finish": "2024-10-08T20:50:35+03:00", - "operating_reset_at": 1728410435, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.mdx new file mode 100644 index 0000000000..5aa143f957 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Отключить уведомления чата + Отключает уведомлений чата + + + +`Функция ОтключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409835.44261, + "finish": 1728409835.48699, + "duration": 0.0443859100341797, + "processing": 0.0175070762634277, + "date_start": "2024-10-08T20:50:35+03:00", + "date_finish": "2024-10-08T20:50:35+03:00", + "operating_reset_at": 1728410435, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md deleted file mode 100644 index 6283520397..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Включить уведомления чата - Включает уведомления в чате - - - -`Функция ВключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409835.63256, - "finish": 1728409835.67734, - "duration": 0.0447759628295898, - "processing": 0.0186781883239746, - "date_start": "2024-10-08T20:50:35+03:00", - "date_finish": "2024-10-08T20:50:35+03:00", - "operating_reset_at": 1728410435, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.mdx new file mode 100644 index 0000000000..9826a62694 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Включить уведомления чата + Включает уведомления в чате + + + +`Функция ВключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409835.63256, + "finish": 1728409835.67734, + "duration": 0.0447759628295898, + "processing": 0.0186781883239746, + "date_start": "2024-10-08T20:50:35+03:00", + "date_finish": "2024-10-08T20:50:35+03:00", + "operating_reset_at": 1728410435, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md deleted file mode 100644 index 0eb9a9651a..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Получить каталог файлов чата - Получает каталог для хранения фйлов чата - - - -`Функция ПолучитьКаталогФайловЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12490 - }, - "time": { - "start": 1728409852.88543, - "finish": 1728409852.94853, - "duration": 0.0630941390991211, - "processing": 0.0362548828125, - "date_start": "2024-10-08T20:50:52+03:00", - "date_finish": "2024-10-08T20:50:52+03:00", - "operating_reset_at": 1728410452, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.mdx new file mode 100644 index 0000000000..3ea4c60ff3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 20 +--- + +# Получить каталог файлов чата + Получает каталог для хранения фйлов чата + + + +`Функция ПолучитьКаталогФайловЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12490 + }, + "time": { + "start": 1728409852.88543, + "finish": 1728409852.94853, + "duration": 0.0630941390991211, + "processing": 0.0362548828125, + "date_start": "2024-10-08T20:50:52+03:00", + "date_finish": "2024-10-08T20:50:52+03:00", + "operating_reset_at": 1728410452, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md deleted file mode 100644 index f264ae29fb..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -sidebar_position: 15 ---- - -# Получить список пользователей диалога - Получает список участников далога - - - -`Функция ПолучитьСписокПользователейДиалога(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat" + "1006"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T21:36:23+03:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1, - 264 - ], - "phones": false, - "bot_data": null - }, - { - "id": 1, - "active": true, - "name": "Антон Титовец", - "first_name": "Антон", - "last_name": "Титовец", - "work_position": null, - "color": "#df532d", - "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-09-17T21:21:49+03:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1, - 264 - ], - "phones": false, - "bot_data": null - } - ], - "total": 2, - "time": { - "start": 1728409846.62694, - "finish": 1728409846.66129, - "duration": 0.0343492031097412, - "processing": 0.0080409049987793, - "date_start": "2024-10-08T20:50:46+03:00", - "date_finish": "2024-10-08T20:50:46+03:00", - "operating_reset_at": 1728410446, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.mdx new file mode 100644 index 0000000000..7c297d8585 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.mdx @@ -0,0 +1,120 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 15 +--- + +# Получить список пользователей диалога + Получает список участников далога + + + +`Функция ПолучитьСписокПользователейДиалога(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat" + "1006"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T21:36:23+03:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1, + 264 + ], + "phones": false, + "bot_data": null + }, + { + "id": 1, + "active": true, + "name": "Антон Титовец", + "first_name": "Антон", + "last_name": "Титовец", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-09-17T21:21:49+03:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1, + 264 + ], + "phones": false, + "bot_data": null + } + ], + "total": 2, + "time": { + "start": 1728409846.62694, + "finish": 1728409846.66129, + "duration": 0.0343492031097412, + "processing": 0.0080409049987793, + "date_start": "2024-10-08T20:50:46+03:00", + "date_finish": "2024-10-08T20:50:46+03:00", + "operating_reset_at": 1728410446, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md deleted file mode 100644 index 02d3e05fab..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Получить список сообщений чата - Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего - - - -`Функция ПолучитьСписокСообщенийЧата(Знач URL, Знач IDЧата, Знач IDПоследнего = "", Знач IDПервого = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | IDПоследнего | --last | Строка, Число | ID последнего загруженного сообщения | - | IDПервого | --first | Строка, Число | ID первого загруженного сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat4"; - - Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "chat_id": 10, - "messages": [ - { - "id": 16, - "chat_id": 10, - "author_id": 0, - "date": "2024-06-15T19:48:49+03:00", - "text": "Я с вами в команде!", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "CODE": [ - "USER_JOIN" - ] - }, - "disappearing_date": null - }, - { - "id": 3808, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T17:45:29+03:00", - "text": "Сообщение для теста", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 3810, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T17:46:31+03:00", - "text": "Понял", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 3852, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T17:54:42+03:00", - "text": "Принял", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 3854, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T17:54:43+03:00", - "text": "Записал", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4286, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T19:06:51+03:00", - "text": "Текст сообщения", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4366, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T19:40:58+03:00", - "text": "Message text", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4406, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T22:57:33+03:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4446, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T23:21:27+03:00", - "text": "Текст сообщения", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4486, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T23:22:30+03:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4526, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T23:41:21+03:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4668, - "chat_id": 10, - "author_id": 1, -... -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.mdx new file mode 100644 index 0000000000..1aa94fde7e --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.mdx @@ -0,0 +1,202 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Получить список сообщений чата + Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего + + + +`Функция ПолучитьСписокСообщенийЧата(Знач URL, Знач IDЧата, Знач IDПоследнего = "", Знач IDПервого = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDПоследнего | --last | Строка, Число | ID последнего загруженного сообщения | + | IDПервого | --first | Строка, Число | ID первого загруженного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat4"; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "chat_id": 10, + "messages": [ + { + "id": 16, + "chat_id": 10, + "author_id": 0, + "date": "2024-06-15T19:48:49+03:00", + "text": "Я с вами в команде!", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "CODE": [ + "USER_JOIN" + ] + }, + "disappearing_date": null + }, + { + "id": 3808, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T17:45:29+03:00", + "text": "Сообщение для теста", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 3810, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T17:46:31+03:00", + "text": "Понял", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 3852, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T17:54:42+03:00", + "text": "Принял", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 3854, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T17:54:43+03:00", + "text": "Записал", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4286, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:06:51+03:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4366, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:40:58+03:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4406, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T22:57:33+03:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4446, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T23:21:27+03:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4486, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T23:22:30+03:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4526, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T23:41:21+03:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4668, + "chat_id": 10, + "author_id": 1, +... +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md deleted file mode 100644 index 36999406e3..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 21 ---- - -# Получить структуру чата - Получает структуру полей чата - - - -`Функция ПолучитьСтруктуруЧата(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Bitrix24.ПолучитьСтруктуруЧата(); -``` - - - - -```json title="Результат" -{ - "TYPE": "<Тип чата OPEN (публичный) | CHAT (по приглашениям)>", - "TITLE": "<Заголовок чата>", - "DESCRIPTION": "<Описание чата>", - "COLOR": "<Цвет чата: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, ...>", - "MESSAGE": "<Первое приветственное сообщение в чате>", - "USERS": "<Массив участников чата>", - "AVATAR": "<Аватар чата в base64 формате>", - "OWNER_ID": "<Идентификатор владельца чата. Текущий пользователь, если не указано>" -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.mdx new file mode 100644 index 0000000000..a9abfb2a0d --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 21 +--- + +# Получить структуру чата + Получает структуру полей чата + + + +`Функция ПолучитьСтруктуруЧата(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Bitrix24.ПолучитьСтруктуруЧата(); +``` + + + + +```json title="Результат" +{ + "TYPE": "<Тип чата OPEN (публичный) | CHAT (по приглашениям)>", + "TITLE": "<Заголовок чата>", + "DESCRIPTION": "<Описание чата>", + "COLOR": "<Цвет чата: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, ...>", + "MESSAGE": "<Первое приветственное сообщение в чате>", + "USERS": "<Массив участников чата>", + "AVATAR": "<Аватар чата в base64 формате>", + "OWNER_ID": "<Идентификатор владельца чата. Текущий пользователь, если не указано>" +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md deleted file mode 100644 index ee6d29fdcd..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список пользователей чата - Получает список пользователей чата по ID - - - -`Функция ПолучитьСписокПользователейЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - 1, - 10 - ], - "time": { - "start": 1728409816.01682, - "finish": 1728409816.04935, - "duration": 0.0325300693511963, - "processing": 0.00371098518371582, - "date_start": "2024-10-08T20:50:16+03:00", - "date_finish": "2024-10-08T20:50:16+03:00", - "operating_reset_at": 1728410416, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.mdx new file mode 100644 index 0000000000..62f18c8653 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список пользователей чата + Получает список пользователей чата по ID + + + +`Функция ПолучитьСписокПользователейЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + 1, + 10 + ], + "time": { + "start": 1728409816.01682, + "finish": 1728409816.04935, + "duration": 0.0325300693511963, + "processing": 0.00371098518371582, + "date_start": "2024-10-08T20:50:16+03:00", + "date_finish": "2024-10-08T20:50:16+03:00", + "operating_reset_at": 1728410416, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md deleted file mode 100644 index 323db8ed4e..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Получить диалог - Получает информацию о диалоге по ID - - - -`Функция ПолучитьДиалог(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat" + "1006"; - - Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "id": 10, - "parent_chat_id": 0, - "parent_message_id": 0, - "name": "", - "description": "", - "owner": 10, - "extranet": false, - "avatar": "", - "color": "#ab7761", - "type": "private", - "counter": 4, - "user_counter": 0, - "message_count": 185, - "unread_id": 16, - "restrictions": { - "avatar": true, - "rename": true, - "extend": true, - "call": true, - "mute": true, - "leave": true, - "leave_owner": true, - "send": true, - "user_list": true - }, - "last_message_id": 17538, - "last_id": 0, - "marked_id": 0, - "disk_folder_id": 0, - "entity_type": "", - "entity_id": "", - "entity_data_1": "", - "entity_data_2": "", - "entity_data_3": "", - "mute_list": [], - "date_create": "2024-06-15T19:48:49+03:00", - "message_type": "P", - "disappearing_time": 0, - "public": "", - "role": "member", - "entity_link": { - "type": "", - "url": "" - }, - "permissions": { - "manage_users_add": "member", - "manage_users_delete": "manager", - "manage_ui": "member", - "manage_settings": "owner", - "manage_messages": "member", - "can_post": "member" - }, - "is_new": false, - "readed_list": [ - { - "user_id": 10, - "user_name": "Techno Pizza", - "message_id": 3854, - "date": null - } - ], - "manager_list": [], - "last_message_views": { - "message_id": 17538, - "first_viewers": [], - "count_of_viewers": 0 - }, - "dialog_id": "10" - }, - "time": { - "start": 1728409841.43356, - "finish": 1728409841.48243, - "duration": 0.0488731861114502, - "processing": 0.0197949409484863, - "date_start": "2024-10-08T20:50:41+03:00", - "date_finish": "2024-10-08T20:50:41+03:00", - "operating_reset_at": 1728410441, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx new file mode 100644 index 0000000000..af81af8d66 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.mdx @@ -0,0 +1,131 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Получить диалог + Получает информацию о диалоге по ID + + + +`Функция ПолучитьДиалог(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat" + "1006"; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "id": 10, + "parent_chat_id": 0, + "parent_message_id": 0, + "name": "", + "description": "", + "owner": 10, + "extranet": false, + "avatar": "", + "color": "#ab7761", + "type": "private", + "counter": 4, + "user_counter": 0, + "message_count": 185, + "unread_id": 16, + "restrictions": { + "avatar": true, + "rename": true, + "extend": true, + "call": true, + "mute": true, + "leave": true, + "leave_owner": true, + "send": true, + "user_list": true + }, + "last_message_id": 17538, + "last_id": 0, + "marked_id": 0, + "disk_folder_id": 0, + "entity_type": "", + "entity_id": "", + "entity_data_1": "", + "entity_data_2": "", + "entity_data_3": "", + "mute_list": [], + "date_create": "2024-06-15T19:48:49+03:00", + "message_type": "P", + "disappearing_time": 0, + "public": "", + "role": "member", + "entity_link": { + "type": "", + "url": "" + }, + "permissions": { + "manage_users_add": "member", + "manage_users_delete": "manager", + "manage_ui": "member", + "manage_settings": "owner", + "manage_messages": "member", + "can_post": "member" + }, + "is_new": false, + "readed_list": [ + { + "user_id": 10, + "user_name": "Techno Pizza", + "message_id": 3854, + "date": null + } + ], + "manager_list": [], + "last_message_views": { + "message_id": 17538, + "first_viewers": [], + "count_of_viewers": 0 + }, + "dialog_id": "10" + }, + "time": { + "start": 1728409841.43356, + "finish": 1728409841.48243, + "duration": 0.0488731861114502, + "processing": 0.0197949409484863, + "date_start": "2024-10-08T20:50:41+03:00", + "date_finish": "2024-10-08T20:50:41+03:00", + "operating_reset_at": 1728410441, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md deleted file mode 100644 index 9abc3fb4da..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 17 ---- - -# Получить статус пользователя - Получает статус (онлайн) текущего пользователя - - - -`Функция ПолучитьСтатусПользователя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": "away", - "time": { - "start": 1728409785.3285, - "finish": 1728409785.35685, - "duration": 0.0283410549163818, - "processing": 0.000214099884033203, - "date_start": "2024-10-08T20:49:45+03:00", - "date_finish": "2024-10-08T20:49:45+03:00", - "operating_reset_at": 1728410385, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.mdx new file mode 100644 index 0000000000..b64c7ff342 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 17 +--- + +# Получить статус пользователя + Получает статус (онлайн) текущего пользователя + + + +`Функция ПолучитьСтатусПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": "away", + "time": { + "start": 1728409785.3285, + "finish": 1728409785.35685, + "duration": 0.0283410549163818, + "processing": 0.000214099884033203, + "date_start": "2024-10-08T20:49:45+03:00", + "date_finish": "2024-10-08T20:49:45+03:00", + "operating_reset_at": 1728410385, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md deleted file mode 100644 index d8243da6ae..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить пользователей - Получает информацию о пользователях для диалога - - - -`Функция ПолучитьПользователей(Знач URL, Знач IDПользователей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователей | --users | Массив Из Строка, Число | ID пользователя или нескольких пользователей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - МассивПользователей = Новый Массив; - - МассивПользователей.Добавить(1); - МассивПользователей.Добавить(10); - - Результат = OPI_Bitrix24.ПолучитьПользователей(URL, МассивПользователей); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователей = 10; - - Результат = OPI_Bitrix24.ПолучитьПользователей(URL, IDПользователей, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "10": { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T21:36:23+03:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1, - 264 - ], - "phones": false - } - }, - "time": { - "start": 1728409785.74518, - "finish": 1728409785.77345, - "duration": 0.0282700061798096, - "processing": 0.0025789737701416, - "date_start": "2024-10-08T20:49:45+03:00", - "date_finish": "2024-10-08T20:49:45+03:00", - "operating_reset_at": 1728410385, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.mdx new file mode 100644 index 0000000000..921213b79d --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.mdx @@ -0,0 +1,93 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить пользователей + Получает информацию о пользователях для диалога + + + +`Функция ПолучитьПользователей(Знач URL, Знач IDПользователей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователей | --users | Массив Из Строка, Число | ID пользователя или нескольких пользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + МассивПользователей = Новый Массив; + + МассивПользователей.Добавить(1); + МассивПользователей.Добавить(10); + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, МассивПользователей); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователей = 10; + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, IDПользователей, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "10": { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T21:36:23+03:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1, + 264 + ], + "phones": false + } + }, + "time": { + "start": 1728409785.74518, + "finish": 1728409785.77345, + "duration": 0.0282700061798096, + "processing": 0.0025789737701416, + "date_start": "2024-10-08T20:49:45+03:00", + "date_finish": "2024-10-08T20:49:45+03:00", + "operating_reset_at": 1728410385, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md deleted file mode 100644 index e67c4bfd50..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Покинуть чат - Исключает текущего пользователя из чата - - - -`Функция ПокинутьЧат(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - - Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409860.62434, - "finish": 1728409860.70563, - "duration": 0.0812890529632568, - "processing": 0.043381929397583, - "date_start": "2024-10-08T20:51:00+03:00", - "date_finish": "2024-10-08T20:51:00+03:00", - "operating_reset_at": 1728410460, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.mdx new file mode 100644 index 0000000000..41fc55b1ad --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Покинуть чат + Исключает текущего пользователя из чата + + + +`Функция ПокинутьЧат(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409860.62434, + "finish": 1728409860.70563, + "duration": 0.0812890529632568, + "processing": 0.043381929397583, + "date_start": "2024-10-08T20:51:00+03:00", + "date_finish": "2024-10-08T20:51:00+03:00", + "operating_reset_at": 1728410460, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md deleted file mode 100644 index b9aae4335f..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 19 ---- - -# Прочитать все - Отмечает все сообщения во всех доступных чатах как прочитанные - - - -`Функция ПрочитатьВсе(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПрочитатьВсе(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПрочитатьВсе(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409860.18988, - "finish": 1728409860.23074, - "duration": 0.0408561229705811, - "processing": 0.0140330791473389, - "date_start": "2024-10-08T20:51:00+03:00", - "date_finish": "2024-10-08T20:51:00+03:00", - "operating_reset_at": 1728410460, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.mdx new file mode 100644 index 0000000000..d12f35e8c4 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 19 +--- + +# Прочитать все + Отмечает все сообщения во всех доступных чатах как прочитанные + + + +`Функция ПрочитатьВсе(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409860.18988, + "finish": 1728409860.23074, + "duration": 0.0408561229705811, + "processing": 0.0140330791473389, + "date_start": "2024-10-08T20:51:00+03:00", + "date_finish": "2024-10-08T20:51:00+03:00", + "operating_reset_at": 1728410460, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md deleted file mode 100644 index 5bad962ee5..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 16 ---- - -# Отправить уведомление о вводе - Отправляет в чат статус Вам пишут... - - - -`Функция ОтправитьУведомлениеОВводе(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat" + "1006"; - - Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409846.78441, - "finish": 1728409846.81102, - "duration": 0.026602029800415, - "processing": 0.00112414360046387, - "date_start": "2024-10-08T20:50:46+03:00", - "date_finish": "2024-10-08T20:50:46+03:00", - "operating_reset_at": 1728410446, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.mdx new file mode 100644 index 0000000000..18b229b82e --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 16 +--- + +# Отправить уведомление о вводе + Отправляет в чат статус Вам пишут... + + + +`Функция ОтправитьУведомлениеОВводе(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat" + "1006"; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409846.78441, + "finish": 1728409846.81102, + "duration": 0.026602029800415, + "processing": 0.00112414360046387, + "date_start": "2024-10-08T20:50:46+03:00", + "date_finish": "2024-10-08T20:50:46+03:00", + "operating_reset_at": 1728410446, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md deleted file mode 100644 index 8df9e669ab..0000000000 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 18 ---- - -# Установить статус пользователя - Устанавливает статус (онлайн) текущего пользователя - - - -`Функция УстановитьСтатусПользователя(Знач URL, Знач Статус, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Статус | --status | Строка, Число | Статус пользователя: online, dnd, away | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Статус = "dnd"; - - Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - Статус = "away"; - - Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409785.50243, - "finish": 1728409785.53653, - "duration": 0.0340919494628906, - "processing": 0.00632810592651367, - "date_start": "2024-10-08T20:49:45+03:00", - "date_finish": "2024-10-08T20:49:45+03:00", - "operating_reset_at": 1728410385, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.mdx b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.mdx new file mode 100644 index 0000000000..b8de0788d2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 18 +--- + +# Установить статус пользователя + Устанавливает статус (онлайн) текущего пользователя + + + +`Функция УстановитьСтатусПользователя(Знач URL, Знач Статус, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Статус | --status | Строка, Число | Статус пользователя: online, dnd, away | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Статус = "dnd"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + Статус = "away"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409785.50243, + "finish": 1728409785.53653, + "duration": 0.0340919494628906, + "processing": 0.00632810592651367, + "date_start": "2024-10-08T20:49:45+03:00", + "date_finish": "2024-10-08T20:49:45+03:00", + "operating_reset_at": 1728410385, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md deleted file mode 100644 index 06f48b252d..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Добавить комментарий задачи - Создает комментарий к задаче - - - -`Функция ДобавитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2450"; - - Текст = "Задача невыполнима, расходимся"; - - Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Текст = "Задача выполнима, не расходимся"; - - Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст, Токен); -``` - - - - -```json title="Результат" -{ - "result": 5902, - "time": { - "start": 1728409738.85935, - "finish": 1728409739.03413, - "duration": 0.174774885177612, - "processing": 0.150223970413208, - "date_start": "2024-10-08T20:48:58+03:00", - "date_finish": "2024-10-08T20:48:59+03:00", - "operating_reset_at": 1728410338, - "operating": 0.150192975997925 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.mdx new file mode 100644 index 0000000000..a60dcdc9f1 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Добавить комментарий задачи + Создает комментарий к задаче + + + +`Функция ДобавитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2450"; + + Текст = "Задача невыполнима, расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Текст = "Задача выполнима, не расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст, Токен); +``` + + + + +```json title="Результат" +{ + "result": 5902, + "time": { + "start": 1728409738.85935, + "finish": 1728409739.03413, + "duration": 0.174774885177612, + "processing": 0.150223970413208, + "date_start": "2024-10-08T20:48:58+03:00", + "date_finish": "2024-10-08T20:48:59+03:00", + "operating_reset_at": 1728410338, + "operating": 0.150192975997925 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md deleted file mode 100644 index c42324c546..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Создать результат из комментария - Создает результат задачи из комментария - - - -`Функция СоздатьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКомментария = "6054"; - - Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDКомментария = "6056"; - - Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "id": 862, - "taskId": 2380, - "commentId": 5902, - "createdBy": 1, - "createdAt": "2024-10-08T20:48:58+03:00", - "updatedAt": "2024-10-08T20:48:58+03:00", - "status": 0, - "text": "Задача изменена, расходимся", - "formattedText": "Задача изменена, расходимся", - "files": null - }, - "time": { - "start": 1728409739.55726, - "finish": 1728409739.67597, - "duration": 0.118705987930298, - "processing": 0.0877728462219238, - "date_start": "2024-10-08T20:48:59+03:00", - "date_finish": "2024-10-08T20:48:59+03:00", - "operating_reset_at": 1728410339, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.mdx new file mode 100644 index 0000000000..4dcd9e91e1 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Создать результат из комментария + Создает результат задачи из комментария + + + +`Функция СоздатьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКомментария = "6054"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDКомментария = "6056"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "id": 862, + "taskId": 2380, + "commentId": 5902, + "createdBy": 1, + "createdAt": "2024-10-08T20:48:58+03:00", + "updatedAt": "2024-10-08T20:48:58+03:00", + "status": 0, + "text": "Задача изменена, расходимся", + "formattedText": "Задача изменена, расходимся", + "files": null + }, + "time": { + "start": 1728409739.55726, + "finish": 1728409739.67597, + "duration": 0.118705987930298, + "processing": 0.0877728462219238, + "date_start": "2024-10-08T20:48:59+03:00", + "date_finish": "2024-10-08T20:48:59+03:00", + "operating_reset_at": 1728410339, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md deleted file mode 100644 index c0f430b7c3..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Удалить результат из комментария - Удаляет ранее созданный результат из комментария - - - -`Функция УдалитьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКомментария = "6054"; - - Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDКомментария = "6056"; - - Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария, Токен); -``` - - - - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1728409740.0116, - "finish": 1728409740.07148, - "duration": 0.0598738193511963, - "processing": 0.0330147743225098, - "date_start": "2024-10-08T20:49:00+03:00", - "date_finish": "2024-10-08T20:49:00+03:00", - "operating_reset_at": 1728410340, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.mdx new file mode 100644 index 0000000000..88060d0261 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Удалить результат из комментария + Удаляет ранее созданный результат из комментария + + + +`Функция УдалитьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКомментария = "6054"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDКомментария = "6056"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария, Токен); +``` + + + + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1728409740.0116, + "finish": 1728409740.07148, + "duration": 0.0598738193511963, + "processing": 0.0330147743225098, + "date_start": "2024-10-08T20:49:00+03:00", + "date_finish": "2024-10-08T20:49:00+03:00", + "operating_reset_at": 1728410340, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md deleted file mode 100644 index 507f4b5e09..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить комментарий - Удаляет существующий комментарий задачи - - - -`Функция УдалитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDКомментария | --comment | Число, Строка | ID удаляемого комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2450"; - IDКомментария = "6054"; - - Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDКомментария = "6056"; - - Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409740.68946, - "finish": 1728409740.806, - "duration": 0.116537094116211, - "processing": 0.0893809795379639, - "date_start": "2024-10-08T20:49:00+03:00", - "date_finish": "2024-10-08T20:49:00+03:00", - "operating_reset_at": 1728410340, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.mdx new file mode 100644 index 0000000000..c47e00ac43 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить комментарий + Удаляет существующий комментарий задачи + + + +`Функция УдалитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID удаляемого комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2450"; + IDКомментария = "6054"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDКомментария = "6056"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409740.68946, + "finish": 1728409740.806, + "duration": 0.116537094116211, + "processing": 0.0893809795379639, + "date_start": "2024-10-08T20:49:00+03:00", + "date_finish": "2024-10-08T20:49:00+03:00", + "operating_reset_at": 1728410340, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md deleted file mode 100644 index ca66910dbd..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Получить структуру комментария - Получает структуру полей комментария - - - -`Функция ПолучитьСтруктуруКомментария(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Bitrix24.ПолучитьСтруктуруКомментария(); -``` - - - - -```json title="Результат" -{ - "AUTHOR_ID": "<идентификатор автора комментария>", - "AUTHOR_NAME": "<Имя пользователя (опционально)>", - "AUTHOR_EMAIL": "", - "USE_SMILES": "<(Y|N) - парсить или нет комментарии на наличие смайлов>", - "POST_MESSAGE": "<Текст сообщения>", - "UF_FORUM_MESSAGE_DOC": "<Массив файлов с диска для прикрепления>" -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.mdx new file mode 100644 index 0000000000..aad232aebc --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.mdx @@ -0,0 +1,43 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Получить структуру комментария + Получает структуру полей комментария + + + +`Функция ПолучитьСтруктуруКомментария(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Bitrix24.ПолучитьСтруктуруКомментария(); +``` + + + + +```json title="Результат" +{ + "AUTHOR_ID": "<идентификатор автора комментария>", + "AUTHOR_NAME": "<Имя пользователя (опционально)>", + "AUTHOR_EMAIL": "", + "USE_SMILES": "<(Y|N) - парсить или нет комментарии на наличие смайлов>", + "POST_MESSAGE": "<Текст сообщения>", + "UF_FORUM_MESSAGE_DOC": "<Массив файлов с диска для прикрепления>" +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md deleted file mode 100644 index ec357d4043..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить список результатов - Получает список результатов задачи - - - -`Функция ПолучитьСписокРезультатов(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2450"; - - Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "id": 862, - "taskId": 2380, - "commentId": 5902, - "createdBy": 1, - "createdAt": "2024-10-08T20:48:58+03:00", - "updatedAt": "2024-10-08T20:48:58+03:00", - "status": 0, - "text": "Задача изменена, расходимся", - "formattedText": "Задача изменена, расходимся", - "files": [] - }, - { - "id": 860, - "taskId": 2380, - "commentId": 5900, - "createdBy": 1, - "createdAt": "2024-10-08T20:48:58+03:00", - "updatedAt": "2024-10-08T20:48:58+03:00", - "status": 0, - "text": "Задача изменена, не расходимся", - "formattedText": "Задача изменена, не расходимся", - "files": [] - } - ], - "time": { - "start": 1728409739.81815, - "finish": 1728409739.85202, - "duration": 0.0338699817657471, - "processing": 0.00750207901000976, - "date_start": "2024-10-08T20:48:59+03:00", - "date_finish": "2024-10-08T20:48:59+03:00", - "operating_reset_at": 1728410339, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.mdx new file mode 100644 index 0000000000..76459673ab --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить список результатов + Получает список результатов задачи + + + +`Функция ПолучитьСписокРезультатов(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2450"; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "id": 862, + "taskId": 2380, + "commentId": 5902, + "createdBy": 1, + "createdAt": "2024-10-08T20:48:58+03:00", + "updatedAt": "2024-10-08T20:48:58+03:00", + "status": 0, + "text": "Задача изменена, расходимся", + "formattedText": "Задача изменена, расходимся", + "files": [] + }, + { + "id": 860, + "taskId": 2380, + "commentId": 5900, + "createdBy": 1, + "createdAt": "2024-10-08T20:48:58+03:00", + "updatedAt": "2024-10-08T20:48:58+03:00", + "status": 0, + "text": "Задача изменена, не расходимся", + "formattedText": "Задача изменена, не расходимся", + "files": [] + } + ], + "time": { + "start": 1728409739.81815, + "finish": 1728409739.85202, + "duration": 0.0338699817657471, + "processing": 0.00750207901000976, + "date_start": "2024-10-08T20:48:59+03:00", + "date_finish": "2024-10-08T20:48:59+03:00", + "operating_reset_at": 1728410339, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md deleted file mode 100644 index 4fe3583007..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить комменатрий задачи - Получает информацию о комментарии задачи по ID - - - -`Функция ПолучитьКомменатрийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDКомментария = "6054"; - IDЗадачи = "2450"; - - Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDКомментария = "6056"; - - Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "POST_MESSAGE_HTML": null, - "ID": "5902", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-10-08T20:48:58+03:00", - "POST_MESSAGE": "Задача изменена, расходимся" - }, - "time": { - "start": 1728409740.42144, - "finish": 1728409740.46887, - "duration": 0.0474271774291992, - "processing": 0.0224380493164062, - "date_start": "2024-10-08T20:49:00+03:00", - "date_finish": "2024-10-08T20:49:00+03:00", - "operating_reset_at": 1728410340, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.mdx new file mode 100644 index 0000000000..2beb5f4f76 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить комменатрий задачи + Получает информацию о комментарии задачи по ID + + + +`Функция ПолучитьКомменатрийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDКомментария = "6054"; + IDЗадачи = "2450"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDКомментария = "6056"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "POST_MESSAGE_HTML": null, + "ID": "5902", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-10-08T20:48:58+03:00", + "POST_MESSAGE": "Задача изменена, расходимся" + }, + "time": { + "start": 1728409740.42144, + "finish": 1728409740.46887, + "duration": 0.0474271774291992, + "processing": 0.0224380493164062, + "date_start": "2024-10-08T20:49:00+03:00", + "date_finish": "2024-10-08T20:49:00+03:00", + "operating_reset_at": 1728410340, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md deleted file mode 100644 index a3235c5bbd..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список комментариев задачи - Полчает список комментариев пользователей к задаче по ID - - - -`Функция ПолучитьСписокКомментариевЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2450"; - - Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "POST_MESSAGE_HTML": null, - "ID": "5900", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-10-08T20:48:58+03:00", - "POST_MESSAGE": "Задача изменена, не расходимся" - }, - { - "POST_MESSAGE_HTML": null, - "ID": "5902", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-10-08T20:48:58+03:00", - "POST_MESSAGE": "Задача изменена, расходимся" - } - ], - "time": { - "start": 1728409740.22109, - "finish": 1728409740.26842, - "duration": 0.0473270416259766, - "processing": 0.0240099430084228, - "date_start": "2024-10-08T20:49:00+03:00", - "date_finish": "2024-10-08T20:49:00+03:00", - "operating_reset_at": 1728410340, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.mdx new file mode 100644 index 0000000000..7592ef1c28 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список комментариев задачи + Полчает список комментариев пользователей к задаче по ID + + + +`Функция ПолучитьСписокКомментариевЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2450"; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "POST_MESSAGE_HTML": null, + "ID": "5900", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-10-08T20:48:58+03:00", + "POST_MESSAGE": "Задача изменена, не расходимся" + }, + { + "POST_MESSAGE_HTML": null, + "ID": "5902", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-10-08T20:48:58+03:00", + "POST_MESSAGE": "Задача изменена, расходимся" + } + ], + "time": { + "start": 1728409740.22109, + "finish": 1728409740.26842, + "duration": 0.0473270416259766, + "processing": 0.0240099430084228, + "date_start": "2024-10-08T20:49:00+03:00", + "date_finish": "2024-10-08T20:49:00+03:00", + "operating_reset_at": 1728410340, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md deleted file mode 100644 index 399cb7175d..0000000000 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Изменить комментарий задачи - Изменяет текст комментария задачи - - - -`Функция ИзменитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2450"; - IDКомментария = "6054"; - - Текст = "Задача изменена, не расходимся"; - - Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDКомментария = "6056"; - - Текст = "Задача изменена, расходимся"; - - Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409739.26822, - "finish": 1728409739.37989, - "duration": 0.111665964126587, - "processing": 0.0832171440124512, - "date_start": "2024-10-08T20:48:59+03:00", - "date_finish": "2024-10-08T20:48:59+03:00", - "operating_reset_at": 1728410339, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.mdx b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.mdx new file mode 100644 index 0000000000..4eebbdf1cd --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Изменить комментарий задачи + Изменяет текст комментария задачи + + + +`Функция ИзменитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2450"; + IDКомментария = "6054"; + + Текст = "Задача изменена, не расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDКомментария = "6056"; + + Текст = "Задача изменена, расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409739.26822, + "finish": 1728409739.37989, + "duration": 0.111665964126587, + "processing": 0.0832171440124512, + "date_start": "2024-10-08T20:48:59+03:00", + "date_finish": "2024-10-08T20:48:59+03:00", + "operating_reset_at": 1728410339, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md deleted file mode 100644 index ac0eba56a8..0000000000 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Добавить пользовательское поле задачи - Добавляет новое пользовательское поле для добавления в задачу - - - -`Функция ДобавитьПользовательскоеПолеЗадачи(Знач URL, Знач Тип, Знач Имя, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Тип | --type | Строка | Тип поля: string, double, date, boolean | - | Имя | --fieldname | Строка | Текстовый идентификатор (наименование) поля | - | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | - | Заголовок | --title | Строка | Заголовок поля | - | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Тип = "date"; - Имя = "BIRTHDAY_FIELD"; - - Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Тип = "string"; - Имя = "TEXT_FIELD"; - ВнешнийКод = "BITRIX_TEXT_FIELD"; - Заголовок = "Поле для текста"; - Подпись = Новый Структура("en,ru", "Some field", "Некоторое поле"); - - Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя, ВнешнийКод, Заголовок, Подпись, Токен); -``` - - - - -```json title="Результат" -{ - "result": 261, - "time": { - "start": 1722114794.52732, - "finish": 1722114794.59725, - "duration": 0.0699310302734375, - "processing": 0.0470340251922607, - "date_start": "2024-07-27T21:13:14+00:00", - "date_finish": "2024-07-27T21:13:14+00:00", - "operating_reset_at": 1722115394, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.mdx b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.mdx new file mode 100644 index 0000000000..e12a866384 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Добавить пользовательское поле задачи + Добавляет новое пользовательское поле для добавления в задачу + + + +`Функция ДобавитьПользовательскоеПолеЗадачи(Знач URL, Знач Тип, Знач Имя, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Тип | --type | Строка | Тип поля: string, double, date, boolean | + | Имя | --fieldname | Строка | Текстовый идентификатор (наименование) поля | + | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | + | Заголовок | --title | Строка | Заголовок поля | + | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Тип = "date"; + Имя = "BIRTHDAY_FIELD"; + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Тип = "string"; + Имя = "TEXT_FIELD"; + ВнешнийКод = "BITRIX_TEXT_FIELD"; + Заголовок = "Поле для текста"; + Подпись = Новый Структура("en,ru", "Some field", "Некоторое поле"); + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя, ВнешнийКод, Заголовок, Подпись, Токен); +``` + + + + +```json title="Результат" +{ + "result": 261, + "time": { + "start": 1722114794.52732, + "finish": 1722114794.59725, + "duration": 0.0699310302734375, + "processing": 0.0470340251922607, + "date_start": "2024-07-27T21:13:14+00:00", + "date_finish": "2024-07-27T21:13:14+00:00", + "operating_reset_at": 1722115394, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md deleted file mode 100644 index c9afc96cfa..0000000000 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить пользовательское поле задачи - Удаляет пользовательское поле задачи - - - -`Функция УдалитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПоля | --fieldid | Строка, Число | ID поля для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПоля = "255"; - - Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПоля = "257"; - - Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722114801.22925, - "finish": 1722114801.26696, - "duration": 0.0377130508422852, - "processing": 0.0185980796813965, - "date_start": "2024-07-27T21:13:21+00:00", - "date_finish": "2024-07-27T21:13:21+00:00", - "operating_reset_at": 1722115401, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.mdx b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.mdx new file mode 100644 index 0000000000..72266e63c9 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить пользовательское поле задачи + Удаляет пользовательское поле задачи + + + +`Функция УдалитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПоля = "255"; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПоля = "257"; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722114801.22925, + "finish": 1722114801.26696, + "duration": 0.0377130508422852, + "processing": 0.0185980796813965, + "date_start": "2024-07-27T21:13:21+00:00", + "date_finish": "2024-07-27T21:13:21+00:00", + "operating_reset_at": 1722115401, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md deleted file mode 100644 index f6c96fe254..0000000000 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить пользовательское поле задачи - Получает информацию о пользовательском поле задачи - - - -`Функция ПолучитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПоля | --fieldid | Строка, Число | ID поля для получения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПоля = "255"; - - Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПоля = "257"; - - Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - }, - "EDIT_FORM_LABEL": { - "ar": "", - "br": "", - "de": "", - "en": "Updated field", - "fr": "", - "id": "", - "it": "", - "ja": "", - "la": "", - "ms": "", - "pl": "", - "ru": "Измененное поле", - "sc": "", - "tc": "", - "th": "", - "tr": "", - "ua": "", - "vn": "" - }, - "LIST_COLUMN_LABEL": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - }, - "LIST_FILTER_LABEL": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - }, - "ERROR_MESSAGE": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - }, - "HELP_MESSAGE": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - } - }, - "total": 0, - "time": { - "start": 1722114797.9059, - "finish": 1722114797.92375, - "duration": 0.0178542137145996, - "processing": 0.000695943832397461, - "date_start": "2024-07-27T21:13:17+00:00", - "date_finish": "2024-07-27T21:13:17+00:00", - "operating_reset_at": 1722115397, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.mdx b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.mdx new file mode 100644 index 0000000000..1aac62fb4b --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.mdx @@ -0,0 +1,184 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить пользовательское поле задачи + Получает информацию о пользовательском поле задачи + + + +`Функция ПолучитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПоля = "255"; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПоля = "257"; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + }, + "EDIT_FORM_LABEL": { + "ar": "", + "br": "", + "de": "", + "en": "Updated field", + "fr": "", + "id": "", + "it": "", + "ja": "", + "la": "", + "ms": "", + "pl": "", + "ru": "Измененное поле", + "sc": "", + "tc": "", + "th": "", + "tr": "", + "ua": "", + "vn": "" + }, + "LIST_COLUMN_LABEL": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "LIST_FILTER_LABEL": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "ERROR_MESSAGE": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "HELP_MESSAGE": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + } + }, + "total": 0, + "time": { + "start": 1722114797.9059, + "finish": 1722114797.92375, + "duration": 0.0178542137145996, + "processing": 0.000695943832397461, + "date_start": "2024-07-27T21:13:17+00:00", + "date_finish": "2024-07-27T21:13:17+00:00", + "operating_reset_at": 1722115397, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md deleted file mode 100644 index 98e9bcf531..0000000000 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список пользовательских полей задачи - Получает список пользовательских полей для задач - - - -`Функция ПолучитьСписокПользовательскихПолейЗадачи(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "11", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_CRM_TASK", - "USER_TYPE_ID": "crm", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "LEAD": "Y", - "CONTACT": "Y", - "COMPANY": "Y", - "DEAL": "Y", - "ORDER": "Y", - "SMART_INVOICE": "Y" - } - }, - { - "ID": "101", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TASK_WEBDAV_FILES", - "USER_TYPE_ID": "disk_file", - "XML_ID": "TASK_WEBDAV_FILES", - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": [] - }, - { - "ID": "117", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_MAIL_MESSAGE", - "USER_TYPE_ID": "mail_message", - "XML_ID": "", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "N", - "IS_SEARCHABLE": "N", - "SETTINGS": [] - }, - { - "ID": "259", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_BIRTHDAY_FIELD", - "USER_TYPE_ID": "date", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "DEFAULT_VALUE": { - "TYPE": "NONE", - "VALUE": "" - } - } - }, - { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - } - } - ], - "total": 0, - "time": { - "start": 1722114799.57, - "finish": 1722114799.58769, - "duration": 0.0176839828491211, - "processing": 0.000379085540771484, - "date_start": "2024-07-27T21:13:19+00:00", - "date_finish": "2024-07-27T21:13:19+00:00", - "operating_reset_at": 1722115399, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.mdx b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.mdx new file mode 100644 index 0000000000..898df9e4f4 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.mdx @@ -0,0 +1,155 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список пользовательских полей задачи + Получает список пользовательских полей для задач + + + +`Функция ПолучитьСписокПользовательскихПолейЗадачи(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "11", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_CRM_TASK", + "USER_TYPE_ID": "crm", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "LEAD": "Y", + "CONTACT": "Y", + "COMPANY": "Y", + "DEAL": "Y", + "ORDER": "Y", + "SMART_INVOICE": "Y" + } + }, + { + "ID": "101", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TASK_WEBDAV_FILES", + "USER_TYPE_ID": "disk_file", + "XML_ID": "TASK_WEBDAV_FILES", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [] + }, + { + "ID": "117", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_MAIL_MESSAGE", + "USER_TYPE_ID": "mail_message", + "XML_ID": "", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "N", + "IS_SEARCHABLE": "N", + "SETTINGS": [] + }, + { + "ID": "259", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_BIRTHDAY_FIELD", + "USER_TYPE_ID": "date", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "DEFAULT_VALUE": { + "TYPE": "NONE", + "VALUE": "" + } + } + }, + { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + } + } + ], + "total": 0, + "time": { + "start": 1722114799.57, + "finish": 1722114799.58769, + "duration": 0.0176839828491211, + "processing": 0.000379085540771484, + "date_start": "2024-07-27T21:13:19+00:00", + "date_finish": "2024-07-27T21:13:19+00:00", + "operating_reset_at": 1722115399, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md deleted file mode 100644 index 5a661a9107..0000000000 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить пользовательское поле задачи - Изменяет пользовательское поле задачи - - - -`Функция ИзменитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПоля | --fieldid | Строка, Число | ID поля для изменения | - | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | - | Заголовок | --title | Строка | Заголовок поля | - | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - IDПоля = "255"; - Заголовок = "Новый заголовок"; - - Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, , Заголовок); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - IDПоля = "257"; - ВнешнийКод = "NEW_TEXT_FIELD"; - Подпись = Новый Структура("en,ru", "Updated field", "Измененное поле"); - - Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, ВнешнийКод, , Подпись, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722114796.23423, - "finish": 1722114796.26623, - "duration": 0.0319931507110596, - "processing": 0.0126721858978271, - "date_start": "2024-07-27T21:13:16+00:00", - "date_finish": "2024-07-27T21:13:16+00:00", - "operating_reset_at": 1722115396, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.mdx b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.mdx new file mode 100644 index 0000000000..73135b5d80 --- /dev/null +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить пользовательское поле задачи + Изменяет пользовательское поле задачи + + + +`Функция ИзменитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для изменения | + | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | + | Заголовок | --title | Строка | Заголовок поля | + | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + IDПоля = "255"; + Заголовок = "Новый заголовок"; + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, , Заголовок); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + IDПоля = "257"; + ВнешнийКод = "NEW_TEXT_FIELD"; + Подпись = Новый Структура("en,ru", "Updated field", "Измененное поле"); + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, ВнешнийКод, , Подпись, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722114796.23423, + "finish": 1722114796.26623, + "duration": 0.0319931507110596, + "processing": 0.0126721858978271, + "date_start": "2024-07-27T21:13:16+00:00", + "date_finish": "2024-07-27T21:13:16+00:00", + "operating_reset_at": 1722115396, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Create-deal.md b/docs/ru/md/Bitrix24/Deals-managment/Create-deal.md deleted file mode 100644 index 7fa42f04e9..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Create-deal.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать сделку - Создает новую сделку по структуре полей (см. ПолучитьСтруктуруСделки) - - - -`Функция СоздатьСделку(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей сделки (см. ПолучитьСтруктуруСделки) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.deal.add](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_add.php) -::: -
- - -```bsl title="Пример кода" - СтруктураПолей = Новый Структура; - СтруктураПолей.Вставить("TITLE" , "Плановая продажа"); - СтруктураПолей.Вставить("TYPE_ID" , "GOODS"); - СтруктураПолей.Вставить("STAGE_ID" , "NEW"); - СтруктураПолей.Вставить("COMPANY_ID" , 1); - СтруктураПолей.Вставить("CONTACT_ID" , 3); - СтруктураПолей.Вставить("OPENED" , "Y"); - СтруктураПолей.Вставить("ASSIGNED_BY_ID", 1); - СтруктураПолей.Вставить("PROBABILITY" , 30); - СтруктураПолей.Вставить("CURRENCY_ID" , "USD"); - СтруктураПолей.Вставить("OPPORTUNITY" , 5000); - СтруктураПолей.Вставить("CATEGORY_ID" , 5); - СтруктураПолей.Вставить("BEGINDATE" , "2024-01-01"); - СтруктураПолей.Вставить("CLOSEDATE" , "2030-01-01"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьСделку(URL, СтруктураПолей); - - СтруктураПолей.Вставить("TITLE" , "Другая сделка"); - СтруктураПолей.Вставить("CLOSEDATE", "2031-01-01"); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьСделку(URL, СтруктураПолей, Токен); -``` - - - - -```json title="Результат" -{ - "result": 758, - "time": { - "start": 1728409886.7795, - "finish": 1728409886.99568, - "duration": 0.216174840927124, - "processing": 0.191550970077515, - "date_start": "2024-10-08T20:51:26+03:00", - "date_finish": "2024-10-08T20:51:26+03:00", - "operating_reset_at": 1728410486, - "operating": 0.19153094291687 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Create-deal.mdx b/docs/ru/md/Bitrix24/Deals-managment/Create-deal.mdx new file mode 100644 index 0000000000..2424f277cb --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Create-deal.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать сделку + Создает новую сделку по структуре полей (см. ПолучитьСтруктуруСделки) + + + +`Функция СоздатьСделку(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей сделки (см. ПолучитьСтруктуруСделки) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.deal.add](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_add.php) +::: +
+ + +```bsl title="Пример кода" + СтруктураПолей = Новый Структура; + СтруктураПолей.Вставить("TITLE" , "Плановая продажа"); + СтруктураПолей.Вставить("TYPE_ID" , "GOODS"); + СтруктураПолей.Вставить("STAGE_ID" , "NEW"); + СтруктураПолей.Вставить("COMPANY_ID" , 1); + СтруктураПолей.Вставить("CONTACT_ID" , 3); + СтруктураПолей.Вставить("OPENED" , "Y"); + СтруктураПолей.Вставить("ASSIGNED_BY_ID", 1); + СтруктураПолей.Вставить("PROBABILITY" , 30); + СтруктураПолей.Вставить("CURRENCY_ID" , "USD"); + СтруктураПолей.Вставить("OPPORTUNITY" , 5000); + СтруктураПолей.Вставить("CATEGORY_ID" , 5); + СтруктураПолей.Вставить("BEGINDATE" , "2024-01-01"); + СтруктураПолей.Вставить("CLOSEDATE" , "2030-01-01"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьСделку(URL, СтруктураПолей); + + СтруктураПолей.Вставить("TITLE" , "Другая сделка"); + СтруктураПолей.Вставить("CLOSEDATE", "2031-01-01"); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьСделку(URL, СтруктураПолей, Токен); +``` + + + + +```json title="Результат" +{ + "result": 758, + "time": { + "start": 1728409886.7795, + "finish": 1728409886.99568, + "duration": 0.216174840927124, + "processing": 0.191550970077515, + "date_start": "2024-10-08T20:51:26+03:00", + "date_finish": "2024-10-08T20:51:26+03:00", + "operating_reset_at": 1728410486, + "operating": 0.19153094291687 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Delete-deal.md b/docs/ru/md/Bitrix24/Deals-managment/Delete-deal.md deleted file mode 100644 index b54da31019..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Delete-deal.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Удалить сделку - Удаляет сделку по ID - - - -`Функция УдалитьСделку(Знач URL, Знач IDСделки, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСделки | --deal | Число, Строка | ID сделки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.deal.delete](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDСделки = "812"; - - Результат = OPI_Bitrix24.УдалитьСделку(URL, IDСделки); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDСделки = "814"; - - Результат = OPI_Bitrix24.УдалитьСделку(URL, IDСделки, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409887.88138, - "finish": 1728409888.02052, - "duration": 0.139141082763672, - "processing": 0.111672163009644, - "date_start": "2024-10-08T20:51:27+03:00", - "date_finish": "2024-10-08T20:51:28+03:00", - "operating_reset_at": 1728410487, - "operating": 0.111652135848999 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Delete-deal.mdx b/docs/ru/md/Bitrix24/Deals-managment/Delete-deal.mdx new file mode 100644 index 0000000000..f71a72da7e --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Delete-deal.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Удалить сделку + Удаляет сделку по ID + + + +`Функция УдалитьСделку(Знач URL, Знач IDСделки, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСделки | --deal | Число, Строка | ID сделки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.deal.delete](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDСделки = "812"; + + Результат = OPI_Bitrix24.УдалитьСделку(URL, IDСделки); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDСделки = "814"; + + Результат = OPI_Bitrix24.УдалитьСделку(URL, IDСделки, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409887.88138, + "finish": 1728409888.02052, + "duration": 0.139141082763672, + "processing": 0.111672163009644, + "date_start": "2024-10-08T20:51:27+03:00", + "date_finish": "2024-10-08T20:51:28+03:00", + "operating_reset_at": 1728410487, + "operating": 0.111652135848999 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deal-structure.md b/docs/ru/md/Bitrix24/Deals-managment/Get-deal-structure.md deleted file mode 100644 index 6b1d91e7a3..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Get-deal-structure.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить структуру сделки - Получает структуру с описанием полей для создания сделки - - - -`Функция ПолучитьСтруктуруСделки(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.deal.fields](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_fields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруСделки(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруСделки(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": { - "type": "integer", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "ID" - }, - "TITLE": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Название" - }, - "TYPE_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "DEAL_TYPE", - "title": "Тип" - }, - "CATEGORY_ID": { - "type": "crm_category", - "isRequired": false, - "isReadOnly": false, - "isImmutable": true, - "isMultiple": false, - "isDynamic": false, - "title": "Воронка" - }, - "STAGE_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "DEAL_STAGE", - "title": "Стадия сделки" - }, - "STAGE_SEMANTIC_ID": { - "type": "string", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Группа стадии" - }, - "IS_NEW": { - "type": "char", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Новая сделка" - }, - "IS_RECURRING": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Регулярная сделка" - }, - "IS_RETURN_CUSTOMER": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Повторная сделка" - }, - "IS_REPEATED_APPROACH": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Повторное обращение" - }, - "PROBABILITY": { - "type": "integer", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Вероятность" - }, - "CURRENCY_ID": { - "type": "crm_currency", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Валюта" - }, - "OPPORTUNITY": { - "type": "double", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Сумма" - }, - "IS_MANUAL_OPPORTUNITY": { - "type": "char", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "IS_MANUAL_OPPORTUNITY" - }, - "TAX_VALUE": { - "type": "double", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Ставка налога" - }, - "COMPANY_ID": { - "type": "crm_company", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Компания", - "settings": { - "parentEntityTypeId": 4 - } -... -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deal-structure.mdx b/docs/ru/md/Bitrix24/Deals-managment/Get-deal-structure.mdx new file mode 100644 index 0000000000..44bb64a979 --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Get-deal-structure.mdx @@ -0,0 +1,197 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить структуру сделки + Получает структуру с описанием полей для создания сделки + + + +`Функция ПолучитьСтруктуруСделки(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.deal.fields](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_fields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруСделки(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруСделки(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": { + "type": "integer", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "ID" + }, + "TITLE": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Название" + }, + "TYPE_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "DEAL_TYPE", + "title": "Тип" + }, + "CATEGORY_ID": { + "type": "crm_category", + "isRequired": false, + "isReadOnly": false, + "isImmutable": true, + "isMultiple": false, + "isDynamic": false, + "title": "Воронка" + }, + "STAGE_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "DEAL_STAGE", + "title": "Стадия сделки" + }, + "STAGE_SEMANTIC_ID": { + "type": "string", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Группа стадии" + }, + "IS_NEW": { + "type": "char", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Новая сделка" + }, + "IS_RECURRING": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Регулярная сделка" + }, + "IS_RETURN_CUSTOMER": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Повторная сделка" + }, + "IS_REPEATED_APPROACH": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Повторное обращение" + }, + "PROBABILITY": { + "type": "integer", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Вероятность" + }, + "CURRENCY_ID": { + "type": "crm_currency", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Валюта" + }, + "OPPORTUNITY": { + "type": "double", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Сумма" + }, + "IS_MANUAL_OPPORTUNITY": { + "type": "char", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "IS_MANUAL_OPPORTUNITY" + }, + "TAX_VALUE": { + "type": "double", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Ставка налога" + }, + "COMPANY_ID": { + "type": "crm_company", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Компания", + "settings": { + "parentEntityTypeId": 4 + } +... +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deal.md b/docs/ru/md/Bitrix24/Deals-managment/Get-deal.md deleted file mode 100644 index 5cb0592c7e..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Get-deal.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить сделку - Получает сделку по ID - - - -`Функция ПолучитьСделку(Знач URL, Знач IDСделки, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСделки | --deal | Число,Строка | ID сделки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.deal.get](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDСделки = "812"; - - Результат = OPI_Bitrix24.ПолучитьСделку(URL, IDСделки); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDСделки = "812"; - - Результат = OPI_Bitrix24.ПолучитьСделку(URL, IDСделки, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "756", - "TITLE": "Плановая продажа", - "TYPE_ID": "GOODS", - "STAGE_ID": "NEW", - "PROBABILITY": "30", - "CURRENCY_ID": "USD", - "OPPORTUNITY": "5000.00", - "IS_MANUAL_OPPORTUNITY": "N", - "TAX_VALUE": null, - "LEAD_ID": null, - "COMPANY_ID": "1", - "CONTACT_ID": "3", - "QUOTE_ID": null, - "BEGINDATE": "2024-01-01T03:00:00+03:00", - "CLOSEDATE": "2030-01-01T03:00:00+03:00", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-10-08T20:51:26+03:00", - "DATE_MODIFY": "2024-10-08T20:51:26+03:00", - "OPENED": "Y", - "CLOSED": "N", - "COMMENTS": null, - "ADDITIONAL_INFO": null, - "LOCATION_ID": null, - "CATEGORY_ID": "0", - "STAGE_SEMANTIC_ID": "P", - "IS_NEW": "Y", - "IS_RECURRING": "N", - "IS_RETURN_CUSTOMER": "N", - "IS_REPEATED_APPROACH": "N", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-10-08T20:51:26+03:00", - "LAST_ACTIVITY_TIME": "2024-10-08T20:51:26+03:00", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1" - }, - "time": { - "start": 1728409887.14826, - "finish": 1728409887.19519, - "duration": 0.0469341278076172, - "processing": 0.0196211338043213, - "date_start": "2024-10-08T20:51:27+03:00", - "date_finish": "2024-10-08T20:51:27+03:00", - "operating_reset_at": 1728410487, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deal.mdx b/docs/ru/md/Bitrix24/Deals-managment/Get-deal.mdx new file mode 100644 index 0000000000..5636888430 --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Get-deal.mdx @@ -0,0 +1,107 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить сделку + Получает сделку по ID + + + +`Функция ПолучитьСделку(Знач URL, Знач IDСделки, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСделки | --deal | Число,Строка | ID сделки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.deal.get](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDСделки = "812"; + + Результат = OPI_Bitrix24.ПолучитьСделку(URL, IDСделки); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDСделки = "812"; + + Результат = OPI_Bitrix24.ПолучитьСделку(URL, IDСделки, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "756", + "TITLE": "Плановая продажа", + "TYPE_ID": "GOODS", + "STAGE_ID": "NEW", + "PROBABILITY": "30", + "CURRENCY_ID": "USD", + "OPPORTUNITY": "5000.00", + "IS_MANUAL_OPPORTUNITY": "N", + "TAX_VALUE": null, + "LEAD_ID": null, + "COMPANY_ID": "1", + "CONTACT_ID": "3", + "QUOTE_ID": null, + "BEGINDATE": "2024-01-01T03:00:00+03:00", + "CLOSEDATE": "2030-01-01T03:00:00+03:00", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-10-08T20:51:26+03:00", + "DATE_MODIFY": "2024-10-08T20:51:26+03:00", + "OPENED": "Y", + "CLOSED": "N", + "COMMENTS": null, + "ADDITIONAL_INFO": null, + "LOCATION_ID": null, + "CATEGORY_ID": "0", + "STAGE_SEMANTIC_ID": "P", + "IS_NEW": "Y", + "IS_RECURRING": "N", + "IS_RETURN_CUSTOMER": "N", + "IS_REPEATED_APPROACH": "N", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-10-08T20:51:26+03:00", + "LAST_ACTIVITY_TIME": "2024-10-08T20:51:26+03:00", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1" + }, + "time": { + "start": 1728409887.14826, + "finish": 1728409887.19519, + "duration": 0.0469341278076172, + "processing": 0.0196211338043213, + "date_start": "2024-10-08T20:51:27+03:00", + "date_finish": "2024-10-08T20:51:27+03:00", + "operating_reset_at": 1728410487, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deals-filter-structure.md b/docs/ru/md/Bitrix24/Deals-managment/Get-deals-filter-structure.md deleted file mode 100644 index 82c630b3f5..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Get-deals-filter-structure.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить структуру фильтра сделок - Возвращает структуру полей для фильтрации сделок в методе ПолучитьСписокСделок - - - -`Функция ПолучитьСтруктуруФильтраСделок(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраСделок(); -``` - - - - -```json title="Результат" -{ - "ID": "<идентификатор сделки>", - "ASSIGNED_BY_ID": "<идентификатор ответственного>", - "BEGINDATE": "<дата начала>", - "CATEGORY_ID": "<идентификатор направления>", - "CLOSEDATE": "<дата завершения>", - "COMPANY_ID": "<идентификатор компании>", - "CONTACT_ID": "<идентификатор контакта>", - "CREATED_BY_ID": "<идентификатор автора>", - "CURRENCY_ID": "<идентификатор валюты>", - "DATE_CREATE": "<дата создания>", - "DATE_MODIFY": "<дата изменения>", - "IS_NEW": "<признак новой сделки (Y|N)>", - "IS_RECURRING": "<признак шаблона (Y|N)>", - "IS_RETURN_CUSTOMER": "<признак повторного лида (Y|N)>", - "LEAD_ID": "<идентификатор привязанного лида>", - "MODIFY_BY_ID": "<идентификатор автора последнего изменения>", - "MOVED_BY_ID": "<идентификатор автора перемещения сделки на текущую стадию>", - "MOVED_TIME": "<дата перемещения сделки на текущую стадию>", - "OPENED": "<признак доступен для всех (Y|N)>", - "OPPORTUNITY": "<предполагаемая сумма>", - "PROBABILITY": "<вероятность>", - "REQUISITE_ID": "<идентификатор реквизита>", - "STAGE_ID": "<идентификатор стадии>", - "TITLE": "<название сделки (можно искать по шаблону [%_])>", - "TYPE_ID": "<тип сделки>" -} -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deals-filter-structure.mdx b/docs/ru/md/Bitrix24/Deals-managment/Get-deals-filter-structure.mdx new file mode 100644 index 0000000000..5994499fb8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Get-deals-filter-structure.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить структуру фильтра сделок + Возвращает структуру полей для фильтрации сделок в методе ПолучитьСписокСделок + + + +`Функция ПолучитьСтруктуруФильтраСделок(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраСделок(); +``` + + + + +```json title="Результат" +{ + "ID": "<идентификатор сделки>", + "ASSIGNED_BY_ID": "<идентификатор ответственного>", + "BEGINDATE": "<дата начала>", + "CATEGORY_ID": "<идентификатор направления>", + "CLOSEDATE": "<дата завершения>", + "COMPANY_ID": "<идентификатор компании>", + "CONTACT_ID": "<идентификатор контакта>", + "CREATED_BY_ID": "<идентификатор автора>", + "CURRENCY_ID": "<идентификатор валюты>", + "DATE_CREATE": "<дата создания>", + "DATE_MODIFY": "<дата изменения>", + "IS_NEW": "<признак новой сделки (Y|N)>", + "IS_RECURRING": "<признак шаблона (Y|N)>", + "IS_RETURN_CUSTOMER": "<признак повторного лида (Y|N)>", + "LEAD_ID": "<идентификатор привязанного лида>", + "MODIFY_BY_ID": "<идентификатор автора последнего изменения>", + "MOVED_BY_ID": "<идентификатор автора перемещения сделки на текущую стадию>", + "MOVED_TIME": "<дата перемещения сделки на текущую стадию>", + "OPENED": "<признак доступен для всех (Y|N)>", + "OPPORTUNITY": "<предполагаемая сумма>", + "PROBABILITY": "<вероятность>", + "REQUISITE_ID": "<идентификатор реквизита>", + "STAGE_ID": "<идентификатор стадии>", + "TITLE": "<название сделки (можно искать по шаблону [%_])>", + "TYPE_ID": "<тип сделки>" +} +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deals-list.md b/docs/ru/md/Bitrix24/Deals-managment/Get-deals-list.md deleted file mode 100644 index 456e19f8d9..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Get-deals-list.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить список сделок - Получает список сделок (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраСделок) - - - -`Функция ПолучитьСписокСделок(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора сделок (см. ПолучитьСтруктуруФильтраСделок) | - | Отступ | --offset | Число, Строка | Отступ от начала списка для получения сделок > 50 шт. рекурсивно | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.deal.list](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_list.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСписокСделок(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Фильтр = Новый Структура; - Фильтр.Вставить("TITLE" , "Продажа в RUB"); - Фильтр.Вставить("CURRENCY_ID", "RUB"); - - Результат = OPI_Bitrix24.ПолучитьСписокСделок(URL, Фильтр, , Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "52", - "TITLE": "Продажа в RUB", - "TYPE_ID": "GOODS", - "STAGE_ID": "NEW", - "PROBABILITY": "30", - "CURRENCY_ID": "RUB", - "OPPORTUNITY": "50000.00", - "IS_MANUAL_OPPORTUNITY": "N", - "TAX_VALUE": null, - "LEAD_ID": null, - "COMPANY_ID": "1", - "CONTACT_ID": "3", - "QUOTE_ID": null, - "BEGINDATE": "2024-01-01T03:00:00+03:00", - "CLOSEDATE": "2030-01-01T03:00:00+03:00", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-08-25T11:26:58+03:00", - "DATE_MODIFY": "2024-08-25T11:26:59+03:00", - "OPENED": "Y", - "CLOSED": "N", - "COMMENTS": null, - "ADDITIONAL_INFO": null, - "LOCATION_ID": null, - "CATEGORY_ID": "0", - "STAGE_SEMANTIC_ID": "P", - "IS_NEW": "Y", - "IS_RECURRING": "N", - "IS_RETURN_CUSTOMER": "N", - "IS_REPEATED_APPROACH": "N", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-08-25T11:26:58+03:00", - "LAST_ACTIVITY_TIME": "2024-08-25T11:26:58+03:00", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1" - } - ], - "total": 1, - "time": { - "start": 1728409888.78084, - "finish": 1728409888.8263, - "duration": 0.0454578399658203, - "processing": 0.0191719532012939, - "date_start": "2024-10-08T20:51:28+03:00", - "date_finish": "2024-10-08T20:51:28+03:00", - "operating_reset_at": 1728410488, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Get-deals-list.mdx b/docs/ru/md/Bitrix24/Deals-managment/Get-deals-list.mdx new file mode 100644 index 0000000000..3a1a32626e --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Get-deals-list.mdx @@ -0,0 +1,113 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить список сделок + Получает список сделок (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраСделок) + + + +`Функция ПолучитьСписокСделок(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора сделок (см. ПолучитьСтруктуруФильтраСделок) | + | Отступ | --offset | Число, Строка | Отступ от начала списка для получения сделок > 50 шт. рекурсивно | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.deal.list](https://dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_list.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСписокСделок(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Фильтр = Новый Структура; + Фильтр.Вставить("TITLE" , "Продажа в RUB"); + Фильтр.Вставить("CURRENCY_ID", "RUB"); + + Результат = OPI_Bitrix24.ПолучитьСписокСделок(URL, Фильтр, , Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "52", + "TITLE": "Продажа в RUB", + "TYPE_ID": "GOODS", + "STAGE_ID": "NEW", + "PROBABILITY": "30", + "CURRENCY_ID": "RUB", + "OPPORTUNITY": "50000.00", + "IS_MANUAL_OPPORTUNITY": "N", + "TAX_VALUE": null, + "LEAD_ID": null, + "COMPANY_ID": "1", + "CONTACT_ID": "3", + "QUOTE_ID": null, + "BEGINDATE": "2024-01-01T03:00:00+03:00", + "CLOSEDATE": "2030-01-01T03:00:00+03:00", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-08-25T11:26:58+03:00", + "DATE_MODIFY": "2024-08-25T11:26:59+03:00", + "OPENED": "Y", + "CLOSED": "N", + "COMMENTS": null, + "ADDITIONAL_INFO": null, + "LOCATION_ID": null, + "CATEGORY_ID": "0", + "STAGE_SEMANTIC_ID": "P", + "IS_NEW": "Y", + "IS_RECURRING": "N", + "IS_RETURN_CUSTOMER": "N", + "IS_REPEATED_APPROACH": "N", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-08-25T11:26:58+03:00", + "LAST_ACTIVITY_TIME": "2024-08-25T11:26:58+03:00", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1" + } + ], + "total": 1, + "time": { + "start": 1728409888.78084, + "finish": 1728409888.8263, + "duration": 0.0454578399658203, + "processing": 0.0191719532012939, + "date_start": "2024-10-08T20:51:28+03:00", + "date_finish": "2024-10-08T20:51:28+03:00", + "operating_reset_at": 1728410488, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Update-deal.md b/docs/ru/md/Bitrix24/Deals-managment/Update-deal.md deleted file mode 100644 index 8bdf9c4a9c..0000000000 --- a/docs/ru/md/Bitrix24/Deals-managment/Update-deal.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Изменить сделку - Изменяет существующую сделку - - - -`Функция ИзменитьСделку(Знач URL, Знач IDСделки, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСделки | --deal | Число, Строка | ID сделки | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей сделки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.deal.update](https://https: -dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_update.php) -::: -
- - -```bsl title="Пример кода" - СтруктураПолей = Новый Структура; - СтруктураПолей.Вставить("TITLE" , "Продажа в RUB"); - СтруктураПолей.Вставить("CURRENCY_ID" , "RUB"); - СтруктураПолей.Вставить("OPPORTUNITY" , 50000); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDСделки = "812"; - - Результат = OPI_Bitrix24.ИзменитьСделку(URL, IDСделки, СтруктураПолей); - - СтруктураПолей.Вставить("TITLE" , "Будущая сделка в RUB"); - СтруктураПолей.Вставить("BEGINDATE", "2025-01-01"); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDСделки = "814"; - - Результат = OPI_Bitrix24.ИзменитьСделку(URL, IDСделки, СтруктураПолей, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409887.45773, - "finish": 1728409887.62066, - "duration": 0.162928104400635, - "processing": 0.131488800048828, - "date_start": "2024-10-08T20:51:27+03:00", - "date_finish": "2024-10-08T20:51:27+03:00", - "operating_reset_at": 1728410487, - "operating": 0.131444931030273 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Deals-managment/Update-deal.mdx b/docs/ru/md/Bitrix24/Deals-managment/Update-deal.mdx new file mode 100644 index 0000000000..4abae064d6 --- /dev/null +++ b/docs/ru/md/Bitrix24/Deals-managment/Update-deal.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Изменить сделку + Изменяет существующую сделку + + + +`Функция ИзменитьСделку(Знач URL, Знач IDСделки, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСделки | --deal | Число, Строка | ID сделки | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей сделки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.deal.update](https://https: +dev.1c-bitrix.ru/rest_help/crm/cdeals/crm_deal_update.php) +::: +
+ + +```bsl title="Пример кода" + СтруктураПолей = Новый Структура; + СтруктураПолей.Вставить("TITLE" , "Продажа в RUB"); + СтруктураПолей.Вставить("CURRENCY_ID" , "RUB"); + СтруктураПолей.Вставить("OPPORTUNITY" , 50000); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDСделки = "812"; + + Результат = OPI_Bitrix24.ИзменитьСделку(URL, IDСделки, СтруктураПолей); + + СтруктураПолей.Вставить("TITLE" , "Будущая сделка в RUB"); + СтруктураПолей.Вставить("BEGINDATE", "2025-01-01"); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDСделки = "814"; + + Результат = OPI_Bitrix24.ИзменитьСделку(URL, IDСделки, СтруктураПолей, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409887.45773, + "finish": 1728409887.62066, + "duration": 0.162928104400635, + "processing": 0.131488800048828, + "date_start": "2024-10-08T20:51:27+03:00", + "date_finish": "2024-10-08T20:51:27+03:00", + "operating_reset_at": 1728410487, + "operating": 0.131444931030273 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Create-department.md b/docs/ru/md/Bitrix24/Departments-managment/Create-department.md deleted file mode 100644 index 1b3a11aca7..0000000000 --- a/docs/ru/md/Bitrix24/Departments-managment/Create-department.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать подразделение - Создает новое подразделение - - - -`Функция СоздатьПодразделение(Знач URL, Знач Наименование, Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование подразделения | - | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | - | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Наименование = "Главное подразделение"; - IDРодителя = 1; - - Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Наименование = "Подчиненное подразделение"; - IDРодителя = "612"; - IDРуководителя = 1; - - Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя, IDРуководителя, Токен); -``` - - - - -```json title="Результат" -{ - "result": 586, - "time": { - "start": 1728409868.79765, - "finish": 1728409868.93309, - "duration": 0.135439157485962, - "processing": 0.111549139022827, - "date_start": "2024-10-08T20:51:08+03:00", - "date_finish": "2024-10-08T20:51:08+03:00", - "operating_reset_at": 1728410468, - "operating": 0.111526012420654 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Create-department.mdx b/docs/ru/md/Bitrix24/Departments-managment/Create-department.mdx new file mode 100644 index 0000000000..c2249fb4e2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Create-department.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать подразделение + Создает новое подразделение + + + +`Функция СоздатьПодразделение(Знач URL, Знач Наименование, Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование подразделения | + | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | + | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Наименование = "Главное подразделение"; + IDРодителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Наименование = "Подчиненное подразделение"; + IDРодителя = "612"; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя, IDРуководителя, Токен); +``` + + + + +```json title="Результат" +{ + "result": 586, + "time": { + "start": 1728409868.79765, + "finish": 1728409868.93309, + "duration": 0.135439157485962, + "processing": 0.111549139022827, + "date_start": "2024-10-08T20:51:08+03:00", + "date_finish": "2024-10-08T20:51:08+03:00", + "operating_reset_at": 1728410468, + "operating": 0.111526012420654 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md deleted file mode 100644 index 6790730c45..0000000000 --- a/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить подразделение - Удаляет подразделение по ID - - - -`Функция УдалитьПодразделение(Знач URL, Знач IDПодразделения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПодразделения | --depid | Строка, Число | ID подразделения для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПодразделения = "614"; - - Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПодразделения = "612"; - - Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409869.74934, - "finish": 1728409869.84491, - "duration": 0.0955688953399658, - "processing": 0.0683050155639648, - "date_start": "2024-10-08T20:51:09+03:00", - "date_finish": "2024-10-08T20:51:09+03:00", - "operating_reset_at": 1728410469, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Delete-department.mdx b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.mdx new file mode 100644 index 0000000000..e515c7ed24 --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить подразделение + Удаляет подразделение по ID + + + +`Функция УдалитьПодразделение(Знач URL, Знач IDПодразделения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | ID подразделения для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПодразделения = "614"; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПодразделения = "612"; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409869.74934, + "finish": 1728409869.84491, + "duration": 0.0955688953399658, + "processing": 0.0683050155639648, + "date_start": "2024-10-08T20:51:09+03:00", + "date_finish": "2024-10-08T20:51:09+03:00", + "operating_reset_at": 1728410469, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md deleted file mode 100644 index db2b3ebfa3..0000000000 --- a/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить подразделения - Получает список подразделений по ID или фильтру - - - -`Функция ПолучитьПодразделения(Знач URL, Знач IDПодразделения = "", Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПодразделения | --depid | Строка, Число | Выбор по ID подразделения | - | Наименование | --title | Строка | Фильтр по наименованию | - | IDРодителя | --parentid | Строка, Число | Фильтр по родителю | - | IDРуководителя | --headid | Строка, Число | Фильтр по руководителю | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПодразделения = "614"; - - Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, IDПодразделения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDРуководителя = 1; - - Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, , , , IDРуководителя, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "586", - "NAME": "Подчиненное подразделение", - "SORT": 500, - "PARENT": "584", - "UF_HEAD": "1" - } - ], - "total": 1, - "time": { - "start": 1728409869.07511, - "finish": 1728409869.10647, - "duration": 0.031358003616333, - "processing": 0.00476694107055664, - "date_start": "2024-10-08T20:51:09+03:00", - "date_finish": "2024-10-08T20:51:09+03:00", - "operating_reset_at": 1728410469, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Get-departments.mdx b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.mdx new file mode 100644 index 0000000000..acedbd3b68 --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить подразделения + Получает список подразделений по ID или фильтру + + + +`Функция ПолучитьПодразделения(Знач URL, Знач IDПодразделения = "", Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | Выбор по ID подразделения | + | Наименование | --title | Строка | Фильтр по наименованию | + | IDРодителя | --parentid | Строка, Число | Фильтр по родителю | + | IDРуководителя | --headid | Строка, Число | Фильтр по руководителю | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПодразделения = "614"; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, IDПодразделения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, , , , IDРуководителя, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "586", + "NAME": "Подчиненное подразделение", + "SORT": 500, + "PARENT": "584", + "UF_HEAD": "1" + } + ], + "total": 1, + "time": { + "start": 1728409869.07511, + "finish": 1728409869.10647, + "duration": 0.031358003616333, + "processing": 0.00476694107055664, + "date_start": "2024-10-08T20:51:09+03:00", + "date_finish": "2024-10-08T20:51:09+03:00", + "operating_reset_at": 1728410469, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Update-department.md b/docs/ru/md/Bitrix24/Departments-managment/Update-department.md deleted file mode 100644 index 4bca9bcf30..0000000000 --- a/docs/ru/md/Bitrix24/Departments-managment/Update-department.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить подразделение - Изменяет существующее подразделение - - - -`Функция ИзменитьПодразделение(Знач URL, Знач IDПодразделения, Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПодразделения | --depid | Строка, Число | ID подразделения | - | Наименование | --title | Строка | Наименование подразделения | - | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | - | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - IDПодразделения = "612"; - IDРодителя = 7; - - Результат = OPI_Bitrix24.ИзменитьПодразделение(URL, IDПодразделения, , IDРодителя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - IDПодразделения = "614"; - Наименование = "Новое подразделение"; - IDРодителя = 1; - IDРуководителя = 10; - - Результат = OPI_Bitrix24.ИзменитьПодразделение(URL - , IDПодразделения - , Наименование - , IDРодителя - , IDРуководителя - , Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409869.34039, - "finish": 1728409869.50876, - "duration": 0.168374061584473, - "processing": 0.141968011856079, - "date_start": "2024-10-08T20:51:09+03:00", - "date_finish": "2024-10-08T20:51:09+03:00", - "operating_reset_at": 1728410469, - "operating": 0.141947031021118 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Update-department.mdx b/docs/ru/md/Bitrix24/Departments-managment/Update-department.mdx new file mode 100644 index 0000000000..83be829762 --- /dev/null +++ b/docs/ru/md/Bitrix24/Departments-managment/Update-department.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить подразделение + Изменяет существующее подразделение + + + +`Функция ИзменитьПодразделение(Знач URL, Знач IDПодразделения, Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | ID подразделения | + | Наименование | --title | Строка | Наименование подразделения | + | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | + | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + IDПодразделения = "612"; + IDРодителя = 7; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL, IDПодразделения, , IDРодителя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + IDПодразделения = "614"; + Наименование = "Новое подразделение"; + IDРодителя = 1; + IDРуководителя = 10; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL + , IDПодразделения + , Наименование + , IDРодителя + , IDРуководителя + , Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409869.34039, + "finish": 1728409869.50876, + "duration": 0.168374061584473, + "processing": 0.141968011856079, + "date_start": "2024-10-08T20:51:09+03:00", + "date_finish": "2024-10-08T20:51:09+03:00", + "operating_reset_at": 1728410469, + "operating": 0.141947031021118 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md deleted file mode 100644 index 72a69cc17e..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Добавить комментарий новости - Добавляет комментарий к новости - - - -`Функция ДобавитьКомментарийНовости(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID новости | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) -::: -
- - -```bsl title="Пример кода" - Текст = "Комментарий к новости"; - IDНовости = "970"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст); - - Текст = "Другой комментарий к новости"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст, Токен); -``` - - - - -```json title="Результат" -{ - "result": 868, - "time": { - "start": 1728409711.62932, - "finish": 1728409711.73762, - "duration": 0.108306884765625, - "processing": 0.0840291976928711, - "date_start": "2024-10-08T20:48:31+03:00", - "date_finish": "2024-10-08T20:48:31+03:00", - "operating_reset_at": 1728410311, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.mdx new file mode 100644 index 0000000000..b8a75d24f5 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Добавить комментарий новости + Добавляет комментарий к новости + + + +`Функция ДобавитьКомментарийНовости(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID новости | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) +::: +
+ + +```bsl title="Пример кода" + Текст = "Комментарий к новости"; + IDНовости = "970"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст); + + Текст = "Другой комментарий к новости"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст, Токен); +``` + + + + +```json title="Результат" +{ + "result": 868, + "time": { + "start": 1728409711.62932, + "finish": 1728409711.73762, + "duration": 0.108306884765625, + "processing": 0.0840291976928711, + "date_start": "2024-10-08T20:48:31+03:00", + "date_finish": "2024-10-08T20:48:31+03:00", + "operating_reset_at": 1728410311, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md deleted file mode 100644 index cf1e68a829..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Добавить получателей к новости - Добавляет новые группы или пользователей в получатели - - - -`Функция ДобавитьПолучателейКНовости(Знач URL, Знач IDНовости, Знач Видимость, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID новости | - | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogpost.share](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_share.php) -::: -
- - -```bsl title="Пример кода" - Видимость = "UA"; - IDНовости = "970"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409711.87262, - "finish": 1728409711.9056, - "duration": 0.0329840183258057, - "processing": 0.00516104698181152, - "date_start": "2024-10-08T20:48:31+03:00", - "date_finish": "2024-10-08T20:48:31+03:00", - "operating_reset_at": 1728410311, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.mdx new file mode 100644 index 0000000000..dec2ac9833 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Добавить получателей к новости + Добавляет новые группы или пользователей в получатели + + + +`Функция ДобавитьПолучателейКНовости(Знач URL, Знач IDНовости, Знач Видимость, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID новости | + | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogpost.share](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_share.php) +::: +
+ + +```bsl title="Пример кода" + Видимость = "UA"; + IDНовости = "970"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409711.87262, + "finish": 1728409711.9056, + "duration": 0.0329840183258057, + "processing": 0.00516104698181152, + "date_start": "2024-10-08T20:48:31+03:00", + "date_finish": "2024-10-08T20:48:31+03:00", + "operating_reset_at": 1728410311, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md deleted file mode 100644 index 0aa25e4792..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать новость - Создает новую новость в ленте - - - -`Функция СоздатьНовость(Знач URL, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Важное = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Текст | --text | Строка | Текст новости | - | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | - | Файлы | --files | Соответствие Из КлючИЗначение | Ключ > имя файла, значение > путь или двоичные данные | - | Заголовок | --title | Строка | Заголовок новости | - | Важное | --important | Булево | Помечает новость как важную | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) -::: -
- - -```bsl title="Пример кода" - Текст = "Текст новости"; - Заголовок = "Заголовок новости"; - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Путь или Двоичные данные - - Файлы = Новый Соответствие; - Файлы.Вставить("1.png", Картинка1); - Файлы.Вставить("2.png", Картинка2); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, , Токен); -``` - - - - -```json title="Результат" -{ - "result": 942, - "time": { - "start": 1728409707.59524, - "finish": 1728409708.32582, - "duration": 0.730581045150757, - "processing": 0.699767112731934, - "date_start": "2024-10-08T20:48:27+03:00", - "date_finish": "2024-10-08T20:48:28+03:00", - "operating_reset_at": 1728410307, - "operating": 0.699743986129761 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.mdx new file mode 100644 index 0000000000..14e4ad7633 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать новость + Создает новую новость в ленте + + + +`Функция СоздатьНовость(Знач URL, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Важное = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Текст | --text | Строка | Текст новости | + | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | + | Файлы | --files | Соответствие Из КлючИЗначение | Ключ > имя файла, значение > путь или двоичные данные | + | Заголовок | --title | Строка | Заголовок новости | + | Важное | --important | Булево | Помечает новость как важную | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) +::: +
+ + +```bsl title="Пример кода" + Текст = "Текст новости"; + Заголовок = "Заголовок новости"; + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Путь или Двоичные данные + + Файлы = Новый Соответствие; + Файлы.Вставить("1.png", Картинка1); + Файлы.Вставить("2.png", Картинка2); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, , Токен); +``` + + + + +```json title="Результат" +{ + "result": 942, + "time": { + "start": 1728409707.59524, + "finish": 1728409708.32582, + "duration": 0.730581045150757, + "processing": 0.699767112731934, + "date_start": "2024-10-08T20:48:27+03:00", + "date_finish": "2024-10-08T20:48:28+03:00", + "operating_reset_at": 1728410307, + "operating": 0.699743986129761 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md deleted file mode 100644 index 53cd281f04..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить новость - Удаляет новость из ленты по выбранному ID - - - -`Функция УдалитьНовость(Знач URL, Знач IDНовости, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID новости для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogpost.delete](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_delete.php) -::: -
- - -```bsl title="Пример кода" - IDНовости = "968"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.УдалитьНовость(URL, IDНовости); - - IDНовости = "970"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.УдалитьНовость(URL, IDНовости, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409712.2504, - "finish": 1728409712.53706, - "duration": 0.286668062210083, - "processing": 0.186323165893555, - "date_start": "2024-10-08T20:48:32+03:00", - "date_finish": "2024-10-08T20:48:32+03:00", - "operating_reset_at": 1728410312, - "operating": 0.186301946640015 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.mdx new file mode 100644 index 0000000000..bb74d5f56c --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить новость + Удаляет новость из ленты по выбранному ID + + + +`Функция УдалитьНовость(Знач URL, Знач IDНовости, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID новости для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogpost.delete](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_delete.php) +::: +
+ + +```bsl title="Пример кода" + IDНовости = "968"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.УдалитьНовость(URL, IDНовости); + + IDНовости = "970"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьНовость(URL, IDНовости, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409712.2504, + "finish": 1728409712.53706, + "duration": 0.286668062210083, + "processing": 0.186323165893555, + "date_start": "2024-10-08T20:48:32+03:00", + "date_finish": "2024-10-08T20:48:32+03:00", + "operating_reset_at": 1728410312, + "operating": 0.186301946640015 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md deleted file mode 100644 index 73cf399e24..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить список просмотревших важное - Возвращает список пользователей, просмотревших выбранное важное сообщение - - - -`Функция ПолучитьСписокПросмотревшихВажное(Знач URL, Знач IDНовости, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID важной новости | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogpost.getusers.important](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_getusers_important.php) -::: -
- - -```bsl title="Пример кода" - IDНовости = "968"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСписокПросмотревшихВажное(URL, IDНовости); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокПросмотревшихВажное(URL, IDНовости, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - "1" - ], - "time": { - "start": 1728409711.09877, - "finish": 1728409711.1301, - "duration": 0.0313289165496826, - "processing": 0.000207185745239258, - "date_start": "2024-10-08T20:48:31+03:00", - "date_finish": "2024-10-08T20:48:31+03:00", - "operating_reset_at": 1728410311, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.mdx new file mode 100644 index 0000000000..c5749be4e3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить список просмотревших важное + Возвращает список пользователей, просмотревших выбранное важное сообщение + + + +`Функция ПолучитьСписокПросмотревшихВажное(Знач URL, Знач IDНовости, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID важной новости | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogpost.getusers.important](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_getusers_important.php) +::: +
+ + +```bsl title="Пример кода" + IDНовости = "968"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСписокПросмотревшихВажное(URL, IDНовости); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокПросмотревшихВажное(URL, IDНовости, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + "1" + ], + "time": { + "start": 1728409711.09877, + "finish": 1728409711.1301, + "duration": 0.0313289165496826, + "processing": 0.000207185745239258, + "date_start": "2024-10-08T20:48:31+03:00", + "date_finish": "2024-10-08T20:48:31+03:00", + "operating_reset_at": 1728410311, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md deleted file mode 100644 index 9d83f043e4..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить новости - Получает нвости или одну новость с отобором по ID или доступности - - - -`Функция ПолучитьНовости(Знач URL, Знач IDНовости = "", Знач Отбор = "UA", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID важной новости | - | Отбор | --sel | Строка | Отбор новостей по доступу: UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogpost.get](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_get.php) -::: -
- - -```bsl title="Пример кода" - IDНовости = "970"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьНовости(URL, IDНовости); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьНовости(URL, IDНовости, , Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "942", - "BLOG_ID": "1", - "PUBLISH_STATUS": "P", - "TITLE": "Новый заголовок новости", - "AUTHOR_ID": "1", - "ENABLE_COMMENTS": "Y", - "NUM_COMMENTS": "0", - "CODE": null, - "MICRO": "N", - "DETAIL_TEXT": "Новый текст новости", - "DATE_PUBLISH": "2024-10-08T20:48:27+03:00", - "CATEGORY_ID": null, - "HAS_SOCNET_ALL": "N", - "HAS_TAGS": "N", - "HAS_IMAGES": "N", - "HAS_PROPS": "Y", - "HAS_COMMENT_IMAGES": null, - "UF_BLOG_POST_DOC": { - "ID": "1", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_BLOG_POST_DOC", - "USER_TYPE_ID": "file", - "XML_ID": "UF_BLOG_POST_DOC", - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": { - "SIZE": 20, - "LIST_WIDTH": 0, - "LIST_HEIGHT": 0, - "MAX_SHOW_SIZE": 0, - "MAX_ALLOWED_SIZE": 0, - "EXTENSIONS": [], - "TARGET_BLANK": "Y" - }, - "EDIT_FORM_LABEL": null, - "LIST_COLUMN_LABEL": null, - "LIST_FILTER_LABEL": null, - "ERROR_MESSAGE": null, - "HELP_MESSAGE": null, - "USER_TYPE": { - "USER_TYPE_ID": "file", - "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType", - "EDIT_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\FileType", - "renderEdit" - ], - "VIEW_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\FileType", - "renderView" - ], - "USE_FIELD_COMPONENT": true, - "DESCRIPTION": "Файл", - "BASE_TYPE": "file" - }, - "VALUE": false, - "ENTITY_VALUE_ID": 942, - "VALUE_EXISTS": true, - "VALUE_RAW": null, - "CUSTOM_DATA": [] - }, - "UF_BLOG_POST_URL_PRV": { - "ID": "5", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_BLOG_POST_URL_PRV", - "USER_TYPE_ID": "url_preview", - "XML_ID": "UF_BLOG_POST_URL_PRV", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": [], - "EDIT_FORM_LABEL": null, - "LIST_COLUMN_LABEL": null, - "LIST_FILTER_LABEL": null, - "ERROR_MESSAGE": null, - "HELP_MESSAGE": null, - "USER_TYPE": { - "USER_TYPE_ID": "url_preview", - "CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType", - "DESCRIPTION": "Содержимое ссылки", - "BASE_TYPE": "int" - }, - "VALUE": null, - "ENTITY_VALUE_ID": 942, - "VALUE_EXISTS": true, - "VALUE_RAW": null, - "CUSTOM_DATA": [] - }, - "UF_GRATITUDE": { - "ID": "9", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_GRATITUDE", - "USER_TYPE_ID": "integer", - "XML_ID": "UF_GRATITUDE", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "MIN_VALUE": 0, - "MAX_VALUE": 0, - "DEFAULT_VALUE": null - }, - "EDIT_FORM_LABEL": null, - "LIST_COLUMN_LABEL": null, - "LIST_FILTER_LABEL": null, - "ERROR_MESSAGE": null, - "HELP_MESSAGE": null, - "USER_TYPE": { - "USER_TYPE_ID": "integer", - "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType", - "EDIT_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\IntegerType", - "renderEdit" - ], - "VIEW_CALLBACK": [ - "Bitrix\\Main\\UserField\\Types\\IntegerType", - "renderView" - ], - "USE_FIELD_COMPONENT": true, - "DESCRIPTION": "Целое число", - "BASE_TYPE": "int" - }, - "VALUE": null, - "ENTITY_VALUE_ID": 942, - "VALUE_EXISTS": true, - "VALUE_RAW": null, - "CUSTOM_DATA": [] - }, - "UF_BLOG_POST_FILE": { - "ID": "19", - "ENTITY_ID": "BLOG_POST", - "FIELD_NAME": "UF_BLOG_POST_FILE", - "USER_TYPE_ID": "disk_file", - "XML_ID": "UF_BLOG_POST_FILE", -... -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.mdx new file mode 100644 index 0000000000..92bf6f54d2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить новости + Получает нвости или одну новость с отобором по ID или доступности + + + +`Функция ПолучитьНовости(Знач URL, Знач IDНовости = "", Знач Отбор = "UA", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID важной новости | + | Отбор | --sel | Строка | Отбор новостей по доступу: UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogpost.get](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_get.php) +::: +
+ + +```bsl title="Пример кода" + IDНовости = "970"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьНовости(URL, IDНовости); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьНовости(URL, IDНовости, , Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "942", + "BLOG_ID": "1", + "PUBLISH_STATUS": "P", + "TITLE": "Новый заголовок новости", + "AUTHOR_ID": "1", + "ENABLE_COMMENTS": "Y", + "NUM_COMMENTS": "0", + "CODE": null, + "MICRO": "N", + "DETAIL_TEXT": "Новый текст новости", + "DATE_PUBLISH": "2024-10-08T20:48:27+03:00", + "CATEGORY_ID": null, + "HAS_SOCNET_ALL": "N", + "HAS_TAGS": "N", + "HAS_IMAGES": "N", + "HAS_PROPS": "Y", + "HAS_COMMENT_IMAGES": null, + "UF_BLOG_POST_DOC": { + "ID": "1", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_DOC", + "USER_TYPE_ID": "file", + "XML_ID": "UF_BLOG_POST_DOC", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": { + "SIZE": 20, + "LIST_WIDTH": 0, + "LIST_HEIGHT": 0, + "MAX_SHOW_SIZE": 0, + "MAX_ALLOWED_SIZE": 0, + "EXTENSIONS": [], + "TARGET_BLANK": "Y" + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "file", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\FileType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\FileType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Файл", + "BASE_TYPE": "file" + }, + "VALUE": false, + "ENTITY_VALUE_ID": 942, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_URL_PRV": { + "ID": "5", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_URL_PRV", + "USER_TYPE_ID": "url_preview", + "XML_ID": "UF_BLOG_POST_URL_PRV", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [], + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "url_preview", + "CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType", + "DESCRIPTION": "Содержимое ссылки", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 942, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_GRATITUDE": { + "ID": "9", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_GRATITUDE", + "USER_TYPE_ID": "integer", + "XML_ID": "UF_GRATITUDE", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "MIN_VALUE": 0, + "MAX_VALUE": 0, + "DEFAULT_VALUE": null + }, + "EDIT_FORM_LABEL": null, + "LIST_COLUMN_LABEL": null, + "LIST_FILTER_LABEL": null, + "ERROR_MESSAGE": null, + "HELP_MESSAGE": null, + "USER_TYPE": { + "USER_TYPE_ID": "integer", + "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType", + "EDIT_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderEdit" + ], + "VIEW_CALLBACK": [ + "Bitrix\\Main\\UserField\\Types\\IntegerType", + "renderView" + ], + "USE_FIELD_COMPONENT": true, + "DESCRIPTION": "Целое число", + "BASE_TYPE": "int" + }, + "VALUE": null, + "ENTITY_VALUE_ID": 942, + "VALUE_EXISTS": true, + "VALUE_RAW": null, + "CUSTOM_DATA": [] + }, + "UF_BLOG_POST_FILE": { + "ID": "19", + "ENTITY_ID": "BLOG_POST", + "FIELD_NAME": "UF_BLOG_POST_FILE", + "USER_TYPE_ID": "disk_file", + "XML_ID": "UF_BLOG_POST_FILE", +... +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md deleted file mode 100644 index dee8e25cb1..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить новость - Изменяет новость в ленте - - - -`Функция ИзменитьНовость(Знач URL, Знач IDНовости, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID новости | - | Текст | --text | Строка | Текст новости | - | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | - | Файлы | --files | Соответствие Из КлючИЗначение | Ключ > имя файла, значение > путь или двоичные данные | - | Заголовок | --title | Строка | Заголовок новости | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php) -::: -
- - -```bsl title="Пример кода" - Текст = "Новый текст новости"; - Заголовок = "Новый заголовок новости"; - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные - IDНовости = "970"; - - Файлы = Новый Соответствие; - Файлы.Вставить("1.png", Картинка1); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ИзменитьНовость(URL, IDНовости, Текст, , Файлы, Заголовок); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDНовости = "968"; - - Результат = OPI_Bitrix24.ИзменитьНовость(URL, IDНовости, Текст, , Файлы, Заголовок, Токен); -``` - - - - -```json title="Результат" -{ - "result": 940, - "time": { - "start": 1728409710.59071, - "finish": 1728409710.95996, - "duration": 0.369251012802124, - "processing": 0.338684797286987, - "date_start": "2024-10-08T20:48:30+03:00", - "date_finish": "2024-10-08T20:48:30+03:00", - "operating_reset_at": 1728410310, - "operating": 0.338651895523071 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.mdx b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.mdx new file mode 100644 index 0000000000..e99209f073 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить новость + Изменяет новость в ленте + + + +`Функция ИзменитьНовость(Знач URL, Знач IDНовости, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID новости | + | Текст | --text | Строка | Текст новости | + | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | + | Файлы | --files | Соответствие Из КлючИЗначение | Ключ > имя файла, значение > путь или двоичные данные | + | Заголовок | --title | Строка | Заголовок новости | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogpost.update](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_update.php) +::: +
+ + +```bsl title="Пример кода" + Текст = "Новый текст новости"; + Заголовок = "Новый заголовок новости"; + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные + IDНовости = "970"; + + Файлы = Новый Соответствие; + Файлы.Вставить("1.png", Картинка1); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ИзменитьНовость(URL, IDНовости, Текст, , Файлы, Заголовок); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDНовости = "968"; + + Результат = OPI_Bitrix24.ИзменитьНовость(URL, IDНовости, Текст, , Файлы, Заголовок, Токен); +``` + + + + +```json title="Результат" +{ + "result": 940, + "time": { + "start": 1728409710.59071, + "finish": 1728409710.95996, + "duration": 0.369251012802124, + "processing": 0.338684797286987, + "date_start": "2024-10-08T20:48:30+03:00", + "date_finish": "2024-10-08T20:48:30+03:00", + "operating_reset_at": 1728410310, + "operating": 0.338651895523071 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Delete-file.md b/docs/ru/md/Bitrix24/File-managment/Delete-file.md deleted file mode 100644 index 7d3a281b79..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Delete-file.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить файл - Удаляет файл по ID - - - -`Функция УдалитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор удаляемого файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDФайла = "12874"; - - Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDФайла = "12876"; - - Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409773.45408, - "finish": 1728409773.51932, - "duration": 0.065234899520874, - "processing": 0.0413949489593506, - "date_start": "2024-10-08T20:49:33+03:00", - "date_finish": "2024-10-08T20:49:33+03:00", - "operating_reset_at": 1728410373, - "operating": 0.119391202926636 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Delete-file.mdx b/docs/ru/md/Bitrix24/File-managment/Delete-file.mdx new file mode 100644 index 0000000000..d834bc8543 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Delete-file.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить файл + Удаляет файл по ID + + + +`Функция УдалитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор удаляемого файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDФайла = "12874"; + + Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDФайла = "12876"; + + Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409773.45408, + "finish": 1728409773.51932, + "duration": 0.065234899520874, + "processing": 0.0413949489593506, + "date_start": "2024-10-08T20:49:33+03:00", + "date_finish": "2024-10-08T20:49:33+03:00", + "operating_reset_at": 1728410373, + "operating": 0.119391202926636 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md deleted file mode 100644 index 12d36fcc3b..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить внешнюю ссылку файла - Получает внешнюю ссылку для доступа к файлу - - - -`Функция ПолучитьВнешнююСсылкуФайла(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод внезавно исчез из API на облачном Bitrix24, где проводилось тестирование (09/24). Возможно, он все еще будет работать на других версиях, но это не гарантировано - - Метод в документации API: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDФайла = "12876"; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла, Токен); -``` - - - - -```json title="Результат" -{ - "error": "ERROR_METHOD_NOT_FOUND", - "error_description": "Method not found!" -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.mdx b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.mdx new file mode 100644 index 0000000000..5aaf527059 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить внешнюю ссылку файла + Получает внешнюю ссылку для доступа к файлу + + + +`Функция ПолучитьВнешнююСсылкуФайла(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод внезавно исчез из API на облачном Bitrix24, где проводилось тестирование (09/24). Возможно, он все еще будет работать на других версиях, но это не гарантировано + + Метод в документации API: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDФайла = "12876"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла, Токен); +``` + + + + +```json title="Результат" +{ + "error": "ERROR_METHOD_NOT_FOUND", + "error_description": "Method not found!" +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Get-file-information.md b/docs/ru/md/Bitrix24/File-managment/Get-file-information.md deleted file mode 100644 index 055ff6f04e..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Get-file-information.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию о файле - Получает информацию о файле по ID - - - -`Функция ПолучитьИнформациюОФайле(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDФайла = "12876"; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12456", - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8586", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:07+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1GaWVLYmdQTDFyNE5yV1Jwam1nWVI1TU9hWG5Ca3c1MQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxR2FXVkxZbWRRVERGeU5FNXlWMUp3YW0xbldWSTFUVTloV0c1Q2EzYzFNUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.Juyjsc7%2B%2F5AJwKcy5If%2BstgsXhWlnK9p43eTVjsbohM%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" - }, - "time": { - "start": 1728409747.75919, - "finish": 1728409747.79688, - "duration": 0.0376930236816406, - "processing": 0.00775599479675293, - "date_start": "2024-10-08T20:49:07+03:00", - "date_finish": "2024-10-08T20:49:07+03:00", - "operating_reset_at": 1728410347, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Get-file-information.mdx b/docs/ru/md/Bitrix24/File-managment/Get-file-information.mdx new file mode 100644 index 0000000000..5b365d5597 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Get-file-information.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить информацию о файле + Получает информацию о файле по ID + + + +`Функция ПолучитьИнформациюОФайле(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDФайла = "12876"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12456", + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8586", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:07+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1GaWVLYmdQTDFyNE5yV1Jwam1nWVI1TU9hWG5Ca3c1MQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxR2FXVkxZbWRRVERGeU5FNXlWMUp3YW0xbldWSTFUVTloV0c1Q2EzYzFNUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.Juyjsc7%2B%2F5AJwKcy5If%2BstgsXhWlnK9p43eTVjsbohM%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" + }, + "time": { + "start": 1728409747.75919, + "finish": 1728409747.79688, + "duration": 0.0376930236816406, + "processing": 0.00775599479675293, + "date_start": "2024-10-08T20:49:07+03:00", + "date_finish": "2024-10-08T20:49:07+03:00", + "operating_reset_at": 1728410347, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md deleted file mode 100644 index 8b40dccb85..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Скопировать файл - Копирует файл из одного расположения в другое - - - -`Функция СкопироватьФайл(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | ID файла для копирования | - | IDКаталога | --folderid | Строка, Число | ID каталога размещения копии | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) -::: -
- - -```bsl title="Пример кода" - IDКаталога = "12880"; - IDФайла = "12876"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога); - - IDКаталога = "12882"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога, Токен); - - OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12484, - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "12462", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 8598, - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:33+03:00", - "UPDATE_TIME": "2024-10-08T20:49:33+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0ODQmXz1uNkFDQjEzNnJuQmdUTTkxNlpZZzE4N1EyZUdYdE5JMg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBPRFFtWHoxdU5rRkRRakV6Tm5KdVFtZFVUVGt4TmxwWlp6RTROMUV5WlVkWWRFNUpNZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.ZeAHzFtTcRsIkgtqey2s0t5x8%2BFVRBLsOfNdWxq%2FnVs%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новое имя файла.jpg" - }, - "time": { - "start": 1728409773.21018, - "finish": 1728409773.28203, - "duration": 0.0718450546264648, - "processing": 0.0442309379577637, - "date_start": "2024-10-08T20:49:33+03:00", - "date_finish": "2024-10-08T20:49:33+03:00", - "operating_reset_at": 1728410373, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Make-file-copy.mdx b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.mdx new file mode 100644 index 0000000000..9b6361ba98 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Скопировать файл + Копирует файл из одного расположения в другое + + + +`Функция СкопироватьФайл(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | ID файла для копирования | + | IDКаталога | --folderid | Строка, Число | ID каталога размещения копии | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) +::: +
+ + +```bsl title="Пример кода" + IDКаталога = "12880"; + IDФайла = "12876"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога); + + IDКаталога = "12882"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога, Токен); + + OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12484, + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "12462", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 8598, + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:33+03:00", + "UPDATE_TIME": "2024-10-08T20:49:33+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0ODQmXz1uNkFDQjEzNnJuQmdUTTkxNlpZZzE4N1EyZUdYdE5JMg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBPRFFtWHoxdU5rRkRRakV6Tm5KdVFtZFVUVGt4TmxwWlp6RTROMUV5WlVkWWRFNUpNZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.ZeAHzFtTcRsIkgtqey2s0t5x8%2BFVRBLsOfNdWxq%2FnVs%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новое имя файла.jpg" + }, + "time": { + "start": 1728409773.21018, + "finish": 1728409773.28203, + "duration": 0.0718450546264648, + "processing": 0.0442309379577637, + "date_start": "2024-10-08T20:49:33+03:00", + "date_finish": "2024-10-08T20:49:33+03:00", + "operating_reset_at": 1728410373, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md deleted file mode 100644 index 1bac49e143..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Поместить файл в корзину - Перемещает файл в корзину удаляемых файлов - - - -`Функция ПоместитьФайлВКорзину(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDФайла = "12876"; - - Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12456", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8586", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:07+03:00", - "DELETE_TIME": "2024-10-08T20:49:28+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz04T2I1U2RlZE53Tm1nZm9TamwyRTd2NzdjcFY3ajgzcg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHowNFQySTFVMlJsWkU1M1RtMW5abTlUYW13eVJUZDJOemRqY0ZZM2FqZ3pjZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.vVEz60SE2QvLpyf8ltfwwpTVVTK8rjiPPIQjtZmmdAE%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpgi17284097682456i" - }, - "time": { - "start": 1728409768.3307, - "finish": 1728409768.37088, - "duration": 0.040179967880249, - "processing": 0.00736784934997559, - "date_start": "2024-10-08T20:49:28+03:00", - "date_finish": "2024-10-08T20:49:28+03:00", - "operating_reset_at": 1728410368, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.mdx b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.mdx new file mode 100644 index 0000000000..5e5dd7df03 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Поместить файл в корзину + Перемещает файл в корзину удаляемых файлов + + + +`Функция ПоместитьФайлВКорзину(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDФайла = "12876"; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12456", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8586", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:07+03:00", + "DELETE_TIME": "2024-10-08T20:49:28+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz04T2I1U2RlZE53Tm1nZm9TamwyRTd2NzdjcFY3ajgzcg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHowNFQySTFVMlJsWkU1M1RtMW5abTlUYW13eVJUZDJOemRqY0ZZM2FqZ3pjZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.vVEz60SE2QvLpyf8ltfwwpTVVTK8rjiPPIQjtZmmdAE%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpgi17284097682456i" + }, + "time": { + "start": 1728409768.3307, + "finish": 1728409768.37088, + "duration": 0.040179967880249, + "processing": 0.00736784934997559, + "date_start": "2024-10-08T20:49:28+03:00", + "date_finish": "2024-10-08T20:49:28+03:00", + "operating_reset_at": 1728410368, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md deleted file mode 100644 index d36bffc253..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Переместить файл - Перемещает файл из одного расположения в другое - - - -`Функция ПереместитьФайлВКаталог(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | ID файла для перемещения | - | IDКаталога | --folderid | Строка, Число | ID каталога нового размещения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) -::: -
- - -```bsl title="Пример кода" - IDКаталога = "12884"; - IDФайла = "12876"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога); - - IDКаталога = "12886"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога, Токен); - - OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12456", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": 12466, - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8586", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:28+03:00", - "DELETE_TIME": "2024-10-08T20:49:28+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1EcGRIOTBTaGdxYTVNUURBRXNwNmFINFF4NTZ4RGU0aA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxRWNHUklPVEJUYUdkeFlUVk5VVVJCUlhOd05tRklORkY0TlRaNFJHVTBhQT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.xYbPgrf3kn2WYT50V%2FRJnT%2FgvFMmujvaDOhMMLDQbdw%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новый подкаталог/Новое имя файла.jpg" - }, - "time": { - "start": 1728409769.77484, - "finish": 1728409769.82936, - "duration": 0.0545239448547363, - "processing": 0.0266618728637695, - "date_start": "2024-10-08T20:49:29+03:00", - "date_finish": "2024-10-08T20:49:29+03:00", - "operating_reset_at": 1728410369, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.mdx b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.mdx new file mode 100644 index 0000000000..53a29781b8 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Переместить файл + Перемещает файл из одного расположения в другое + + + +`Функция ПереместитьФайлВКаталог(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | ID файла для перемещения | + | IDКаталога | --folderid | Строка, Число | ID каталога нового размещения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) +::: +
+ + +```bsl title="Пример кода" + IDКаталога = "12884"; + IDФайла = "12876"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога); + + IDКаталога = "12886"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога, Токен); + + OPI_ПолучениеДанныхТестов.Проверка_БитриксОбъект(Результат); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12456", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": 12466, + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8586", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:28+03:00", + "DELETE_TIME": "2024-10-08T20:49:28+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1EcGRIOTBTaGdxYTVNUURBRXNwNmFINFF4NTZ4RGU0aA%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxRWNHUklPVEJUYUdkeFlUVk5VVVJCUlhOd05tRklORkY0TlRaNFJHVTBhQT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.xYbPgrf3kn2WYT50V%2FRJnT%2FgvFMmujvaDOhMMLDQbdw%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новый подкаталог/Новое имя файла.jpg" + }, + "time": { + "start": 1728409769.77484, + "finish": 1728409769.82936, + "duration": 0.0545239448547363, + "processing": 0.0266618728637695, + "date_start": "2024-10-08T20:49:29+03:00", + "date_finish": "2024-10-08T20:49:29+03:00", + "operating_reset_at": 1728410369, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Rename-file.md b/docs/ru/md/Bitrix24/File-managment/Rename-file.md deleted file mode 100644 index 2ca39b2adb..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Rename-file.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Переименовать файл - Изменяет имя существующего файла - - - -`Функция ПереименоватьФайл(Знач URL, Знач IDФайла, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Наименование | --title | Строка | Новое наименование каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новое имя файла.jpg"; - Наименование2 = "Новое имя файла 2.jpg"; - - IDФайла2 = "12874"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла2, Наименование2); - - IDФайла = "12876"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла, Наименование, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12456", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8586", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:07+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz0xZHBCejhXckNpOWU1ZG5jMkZxZjBVNk9SanZsUXdteg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoweFpIQkNlamhYY2tOcE9XVTFaRzVqTWtaeFpqQlZOazlTYW5ac1VYZHRlZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.yt63TwECmy6%2ByDHbR76o7wwehiKGWsmQvYN3lRJ%2BHjA%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" - }, - "time": { - "start": 1728409768.11715, - "finish": 1728409768.16173, - "duration": 0.0445799827575684, - "processing": 0.0160980224609375, - "date_start": "2024-10-08T20:49:28+03:00", - "date_finish": "2024-10-08T20:49:28+03:00", - "operating_reset_at": 1728410368, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Rename-file.mdx b/docs/ru/md/Bitrix24/File-managment/Rename-file.mdx new file mode 100644 index 0000000000..888ddf827f --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Rename-file.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Переименовать файл + Изменяет имя существующего файла + + + +`Функция ПереименоватьФайл(Знач URL, Знач IDФайла, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Наименование | --title | Строка | Новое наименование каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя файла.jpg"; + Наименование2 = "Новое имя файла 2.jpg"; + + IDФайла2 = "12874"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла2, Наименование2); + + IDФайла = "12876"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла, Наименование, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12456", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8586", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:07+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz0xZHBCejhXckNpOWU1ZG5jMkZxZjBVNk9SanZsUXdteg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoweFpIQkNlamhYY2tOcE9XVTFaRzVqTWtaeFpqQlZOazlTYW5ac1VYZHRlZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.yt63TwECmy6%2ByDHbR76o7wwehiKGWsmQvYN3lRJ%2BHjA%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" + }, + "time": { + "start": 1728409768.11715, + "finish": 1728409768.16173, + "duration": 0.0445799827575684, + "processing": 0.0160980224609375, + "date_start": "2024-10-08T20:49:28+03:00", + "date_finish": "2024-10-08T20:49:28+03:00", + "operating_reset_at": 1728410368, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Restore-file.md b/docs/ru/md/Bitrix24/File-managment/Restore-file.md deleted file mode 100644 index 4f9d461fc3..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Restore-file.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Восстановить файл - Восстанавливает файл из корзины - - - -`Функция ВосстановитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDФайла = "12876"; - - Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "12456", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8586", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:28+03:00", - "DELETE_TIME": "2024-10-08T20:49:28+03:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1ycDZnVGxLdGNDcnF6NVlpWjZuaTVYRExZTXBtaG9jMg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxeWNEWm5WR3hMZEdORGNuRjZOVmxwV2padWFUVllSRXhaVFhCdGFHOWpNZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.R0WVSCVWwkm2vgiKJ3MbzlBhaJF0LQ0n4T7SRsDodto%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" - }, - "time": { - "start": 1728409768.53563, - "finish": 1728409768.56288, - "duration": 0.0272550582885742, - "processing": 0.0047919750213623, - "date_start": "2024-10-08T20:49:28+03:00", - "date_finish": "2024-10-08T20:49:28+03:00", - "operating_reset_at": 1728410368, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Restore-file.mdx b/docs/ru/md/Bitrix24/File-managment/Restore-file.mdx new file mode 100644 index 0000000000..612a4afff5 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Restore-file.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Восстановить файл + Восстанавливает файл из корзины + + + +`Функция ВосстановитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDФайла = "12876"; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "12456", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8586", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:28+03:00", + "DELETE_TIME": "2024-10-08T20:49:28+03:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1ycDZnVGxLdGNDcnF6NVlpWjZuaTVYRExZTXBtaG9jMg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxeWNEWm5WR3hMZEdORGNuRjZOVmxwV2padWFUVllSRXhaVFhCdGFHOWpNZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.R0WVSCVWwkm2vgiKJ3MbzlBhaJF0LQ0n4T7SRsDodto%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" + }, + "time": { + "start": 1728409768.53563, + "finish": 1728409768.56288, + "duration": 0.0272550582885742, + "processing": 0.0047919750213623, + "date_start": "2024-10-08T20:49:28+03:00", + "date_finish": "2024-10-08T20:49:28+03:00", + "operating_reset_at": 1728410368, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md deleted file mode 100644 index 015193ff74..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Загрузить файл в каталог - Загружает переданный файл в каталог - - - -`Функция ЗагрузитьФайлВКаталог(Знач URL, Знач Наименование, Знач Файл, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование файла с расширением для сохранения | - | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | - | IDКаталога | --folderid | Строка | Идентификатор каталога для загрузки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) -::: -
- - -```bsl title="Пример кода" - Наименование2 = "Картинка2.jpg"; - Наименование = "Картинка1.jpg"; - - Картинка2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные - Картинка = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные - - IDПриемника = "12882"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование2, Картинка2, IDПриемника); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование, Картинка, IDПриемника, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12480, - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "12462", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 8594, - "SIZE": "805191", - "CREATE_TIME": "2024-10-08T20:49:32+03:00", - "UPDATE_TIME": "2024-10-08T20:49:32+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0ODAmXz14NDFwOTBFbFJlVmZzMUFwY3FGOHBNZVZJRk9pUTN4aw%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBPREFtWHoxNE5ERndPVEJGYkZKbFZtWnpNVUZ3WTNGR09IQk5aVlpKUms5cFVUTjRhdz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.evQcDrGBB9TOd%2FfnpIiw%2FXueoUXFgvrkfNi%2B%2FfsUnPg%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Картинка1.jpg" - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.mdx b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.mdx new file mode 100644 index 0000000000..15174de6b2 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Загрузить файл в каталог + Загружает переданный файл в каталог + + + +`Функция ЗагрузитьФайлВКаталог(Знач URL, Знач Наименование, Знач Файл, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование файла с расширением для сохранения | + | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | + | IDКаталога | --folderid | Строка | Идентификатор каталога для загрузки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) +::: +
+ + +```bsl title="Пример кода" + Наименование2 = "Картинка2.jpg"; + Наименование = "Картинка1.jpg"; + + Картинка2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные + Картинка = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные + + IDПриемника = "12882"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование2, Картинка2, IDПриемника); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование, Картинка, IDПриемника, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12480, + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "12462", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 8594, + "SIZE": "805191", + "CREATE_TIME": "2024-10-08T20:49:32+03:00", + "UPDATE_TIME": "2024-10-08T20:49:32+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0ODAmXz14NDFwOTBFbFJlVmZzMUFwY3FGOHBNZVZJRk9pUTN4aw%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBPREFtWHoxNE5ERndPVEJGYkZKbFZtWnpNVUZ3WTNGR09IQk5aVlpKUms5cFVUTjRhdz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.evQcDrGBB9TOd%2FfnpIiw%2FXueoUXFgvrkfNi%2B%2FfsUnPg%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Картинка1.jpg" + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md deleted file mode 100644 index 48ab3c4ae0..0000000000 --- a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Загрузить файл в хранилище - Загружает файл в выбранное хранилище - - - -`Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование файла с расширением для сохранения | - | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | - | IDХранилища | --storageid | Строка | Идентификатор хранилища для загрузки | - | Доступы | --rights | Строка | Массив доступов по задачам, если необходимо | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) -::: -
- - -```bsl title="Пример кода" - Наименование2 = "Картинка2.jpg"; - Наименование = "Картинка1.jpg"; - - Картинка2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные - Картинка = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные - - IDПриемника = 3; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование2, Картинка2, IDПриемника); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12456, - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 8586, - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:07+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz05NEdaNjZpM041T1Z4dm1SeFhVQlI3OHhnR1RMR3ozSg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHowNU5FZGFOalpwTTA0MVQxWjRkbTFTZUZoVlFsSTNPSGhuUjFSTVIzb3pTZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.s9pkpIJ48k8rPBfOQIES3q9ZfxktRUc3q4wy3eIxBxE%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" - }, - "time": { - "start": 1728409746.88092, - "finish": 1728409747.16894, - "duration": 0.28803014755249, - "processing": 0.261969089508057, - "date_start": "2024-10-08T20:49:06+03:00", - "date_finish": "2024-10-08T20:49:07+03:00", - "operating_reset_at": 1728410346, - "operating": 0.261944055557251 - } -} -``` diff --git a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.mdx b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.mdx new file mode 100644 index 0000000000..a6496ca561 --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.mdx @@ -0,0 +1,90 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Загрузить файл в хранилище + Загружает файл в выбранное хранилище + + + +`Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование файла с расширением для сохранения | + | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | + | IDХранилища | --storageid | Строка | Идентификатор хранилища для загрузки | + | Доступы | --rights | Строка | Массив доступов по задачам, если необходимо | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) +::: +
+ + +```bsl title="Пример кода" + Наименование2 = "Картинка2.jpg"; + Наименование = "Картинка1.jpg"; + + Картинка2 = "https://api.athenaeum.digital/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные + Картинка = "https://api.athenaeum.digital/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные + + IDПриемника = 3; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование2, Картинка2, IDПриемника); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12456, + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 8586, + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:07+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz05NEdaNjZpM041T1Z4dm1SeFhVQlI3OHhnR1RMR3ozSg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHowNU5FZGFOalpwTTA0MVQxWjRkbTFTZUZoVlFsSTNPSGhuUjFSTVIzb3pTZz09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.s9pkpIJ48k8rPBfOQIES3q9ZfxktRUc3q4wy3eIxBxE%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" + }, + "time": { + "start": 1728409746.88092, + "finish": 1728409747.16894, + "duration": 0.28803014755249, + "processing": 0.261969089508057, + "date_start": "2024-10-08T20:49:06+03:00", + "date_finish": "2024-10-08T20:49:07+03:00", + "operating_reset_at": 1728410346, + "operating": 0.261944055557251 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md deleted file mode 100644 index 78da51f1d5..0000000000 --- a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Добавить стадию канбана - Добавляет стабию канбана или Моего плана - - - -`Функция ДобавитьСтадиюКанбана(Знач URL, Знач Наименование, Знач Цвет = "FFD800", Знач IDПредыдущей = 0, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование новой стадии | - | Цвет | --color | Строка | HEX цвета новой стадии | - | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить новую (в начало по ум.) | - | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | - | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новая стадия"; - Цвет = "0026FF"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, 6); - - IDПредыдущей = Результат["result"]; - - Наименование = "Новая стадия 2"; - Цвет = "0026FF"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, IDПредыдущей, , Истина, Токен); -``` - - - - -```json title="Результат" -{ - "result": 838, - "time": { - "start": 1728409777.30527, - "finish": 1728409777.37198, - "duration": 0.0667068958282471, - "processing": 0.0408921241760254, - "date_start": "2024-10-08T20:49:37+03:00", - "date_finish": "2024-10-08T20:49:37+03:00", - "operating_reset_at": 1728410377, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.mdx b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.mdx new file mode 100644 index 0000000000..c35d9201c8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Добавить стадию канбана + Добавляет стабию канбана или Моего плана + + + +`Функция ДобавитьСтадиюКанбана(Знач URL, Знач Наименование, Знач Цвет = "FFD800", Знач IDПредыдущей = 0, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование новой стадии | + | Цвет | --color | Строка | HEX цвета новой стадии | + | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить новую (в начало по ум.) | + | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новая стадия"; + Цвет = "0026FF"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, 6); + + IDПредыдущей = Результат["result"]; + + Наименование = "Новая стадия 2"; + Цвет = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, IDПредыдущей, , Истина, Токен); +``` + + + + +```json title="Результат" +{ + "result": 838, + "time": { + "start": 1728409777.30527, + "finish": 1728409777.37198, + "duration": 0.0667068958282471, + "processing": 0.0408921241760254, + "date_start": "2024-10-08T20:49:37+03:00", + "date_finish": "2024-10-08T20:49:37+03:00", + "operating_reset_at": 1728410377, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md deleted file mode 100644 index f612ac1af6..0000000000 --- a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить стадию канбана - Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач - - - -`Функция УдалитьСтадиюКанбана(Знач URL, Знач IDСтадии, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСтадии | --stage | Строка, Число | ID стадии для удаления | - | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) -::: -
- - -```bsl title="Пример кода" - IDСтадии = "864"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, Истина); - - IDСтадии = "866"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, , Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409778.63212, - "finish": 1728409778.66649, - "duration": 0.0343680381774902, - "processing": 0.00638699531555176, - "date_start": "2024-10-08T20:49:38+03:00", - "date_finish": "2024-10-08T20:49:38+03:00", - "operating_reset_at": 1728410378, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.mdx b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.mdx new file mode 100644 index 0000000000..593ac4f10e --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить стадию канбана + Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач + + + +`Функция УдалитьСтадиюКанбана(Знач URL, Знач IDСтадии, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСтадии | --stage | Строка, Число | ID стадии для удаления | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) +::: +
+ + +```bsl title="Пример кода" + IDСтадии = "864"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, Истина); + + IDСтадии = "866"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, , Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409778.63212, + "finish": 1728409778.66649, + "duration": 0.0343680381774902, + "processing": 0.00638699531555176, + "date_start": "2024-10-08T20:49:38+03:00", + "date_finish": "2024-10-08T20:49:38+03:00", + "operating_reset_at": 1728410378, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md deleted file mode 100644 index 188105cf00..0000000000 --- a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить стадии канбана - Получает информацию о стадиях Канбана или Моего плана - - - -`Функция ПолучитьСтадииКанбана(Знач URL, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | - | КакАдминистратор | --admin | Булево | Позволяет получать стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , , Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "142": { - "ID": "142", - "TITLE": "Новое имя стадии стадии", - "SORT": "100", - "COLOR": "000000", - "SYSTEM_TYPE": "NEW", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "20": { - "ID": "20", - "TITLE": "Новая стадия", - "SORT": "200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "24": { - "ID": "24", - "TITLE": "Название", - "SORT": "300", - "COLOR": "75d900", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "16": { - "ID": "16", - "TITLE": "Новая стадия", - "SORT": "400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "18": { - "ID": "18", - "TITLE": "Новая стадия 2", - "SORT": "500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "12": { - "ID": "12", - "TITLE": "Новая стадия", - "SORT": "600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "14": { - "ID": "14", - "TITLE": "Новая стадия 2", - "SORT": "700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "8": { - "ID": "8", - "TITLE": "Новая стадия", - "SORT": "800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "10": { - "ID": "10", - "TITLE": "Новая стадия 2", - "SORT": "900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "6": { - "ID": "6", - "TITLE": "Новая стадия", - "SORT": "1000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "836": { - "ID": "836", - "TITLE": "Новая стадия", - "SORT": "1100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "838": { - "ID": "838", - "TITLE": "Новая стадия 2", - "SORT": "1200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "720": { - "ID": "720", - "TITLE": "Новая стадия", - "SORT": "1300", -... -``` diff --git a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.mdx b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.mdx new file mode 100644 index 0000000000..a0da096fd8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.mdx @@ -0,0 +1,199 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить стадии канбана + Получает информацию о стадиях Канбана или Моего плана + + + +`Функция ПолучитьСтадииКанбана(Знач URL, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | + | КакАдминистратор | --admin | Булево | Позволяет получать стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , , Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "142": { + "ID": "142", + "TITLE": "Новое имя стадии стадии", + "SORT": "100", + "COLOR": "000000", + "SYSTEM_TYPE": "NEW", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "20": { + "ID": "20", + "TITLE": "Новая стадия", + "SORT": "200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "24": { + "ID": "24", + "TITLE": "Название", + "SORT": "300", + "COLOR": "75d900", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "16": { + "ID": "16", + "TITLE": "Новая стадия", + "SORT": "400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "18": { + "ID": "18", + "TITLE": "Новая стадия 2", + "SORT": "500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "12": { + "ID": "12", + "TITLE": "Новая стадия", + "SORT": "600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "14": { + "ID": "14", + "TITLE": "Новая стадия 2", + "SORT": "700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "8": { + "ID": "8", + "TITLE": "Новая стадия", + "SORT": "800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "10": { + "ID": "10", + "TITLE": "Новая стадия 2", + "SORT": "900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "6": { + "ID": "6", + "TITLE": "Новая стадия", + "SORT": "1000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "836": { + "ID": "836", + "TITLE": "Новая стадия", + "SORT": "1100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "838": { + "ID": "838", + "TITLE": "Новая стадия 2", + "SORT": "1200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "720": { + "ID": "720", + "TITLE": "Новая стадия", + "SORT": "1300", +... +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md deleted file mode 100644 index 9b29d8af9c..0000000000 --- a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Перенести задачу в стадию канбана - Переносит задачу в выбранную стадию канбана - - - -`Функция ПеренестиЗадачуВСтадиюКанбана(Знач URL, Знач IDЗадачи, Знач IDСтадии, Знач Перед = 0, Знач После = 0, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи для переноса | - | IDСтадии | --stage | Строка, Число | ID стадии | - | Перед | --before | Строка, Число | ID задачи, перед которой надо поставить выбранную (если не заполнено После) | - | После | --after | Строка, Число | ID задачи, после которой надо поставить выбранную (если не заполнено Перед) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) -::: -
- - -```bsl title="Пример кода" - IDЗадачи = "2452"; - IDСтадии = "864"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии); - - IDСтадии = "866"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии, , , Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409777.84247, - "finish": 1728409777.88764, - "duration": 0.0451741218566894, - "processing": 0.0159571170806885, - "date_start": "2024-10-08T20:49:37+03:00", - "date_finish": "2024-10-08T20:49:37+03:00", - "operating_reset_at": 1728410377, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.mdx b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.mdx new file mode 100644 index 0000000000..12afc7b697 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Перенести задачу в стадию канбана + Переносит задачу в выбранную стадию канбана + + + +`Функция ПеренестиЗадачуВСтадиюКанбана(Знач URL, Знач IDЗадачи, Знач IDСтадии, Знач Перед = 0, Знач После = 0, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для переноса | + | IDСтадии | --stage | Строка, Число | ID стадии | + | Перед | --before | Строка, Число | ID задачи, перед которой надо поставить выбранную (если не заполнено После) | + | После | --after | Строка, Число | ID задачи, после которой надо поставить выбранную (если не заполнено Перед) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) +::: +
+ + +```bsl title="Пример кода" + IDЗадачи = "2452"; + IDСтадии = "864"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии); + + IDСтадии = "866"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии, , , Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409777.84247, + "finish": 1728409777.88764, + "duration": 0.0451741218566894, + "processing": 0.0159571170806885, + "date_start": "2024-10-08T20:49:37+03:00", + "date_finish": "2024-10-08T20:49:37+03:00", + "operating_reset_at": 1728410377, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md deleted file mode 100644 index 5e50338833..0000000000 --- a/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить стадию канбана - Изменяет свойства существующей стадии канбана или Моего плана - - - -`Функция ИзменитьСтадиюКанбана(Знач URL, Знач Наименование, Знач IDСтадии, Знач Цвет = "", Знач IDПредыдущей = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Новое наименование стадии | - | IDСтадии | --stage | Строка, Число | ID стадии для изменения | - | Цвет | --color | Строка | HEX нового цвета стадии | - | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить выбранную | - | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новое имя стадии стадии"; - Цвет = "000000"; - IDСтадии = "864"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет); - - Наименование = "Новое имя стадии стадии 2"; - Цвет = "000000"; - IDСтадии = "866"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет, 6, Истина, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409778.18036, - "finish": 1728409778.25574, - "duration": 0.0753860473632812, - "processing": 0.0437319278717041, - "date_start": "2024-10-08T20:49:38+03:00", - "date_finish": "2024-10-08T20:49:38+03:00", - "operating_reset_at": 1728410378, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.mdx b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.mdx new file mode 100644 index 0000000000..e9af2bc751 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить стадию канбана + Изменяет свойства существующей стадии канбана или Моего плана + + + +`Функция ИзменитьСтадиюКанбана(Знач URL, Знач Наименование, Знач IDСтадии, Знач Цвет = "", Знач IDПредыдущей = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Новое наименование стадии | + | IDСтадии | --stage | Строка, Число | ID стадии для изменения | + | Цвет | --color | Строка | HEX нового цвета стадии | + | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить выбранную | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя стадии стадии"; + Цвет = "000000"; + IDСтадии = "864"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет); + + Наименование = "Новое имя стадии стадии 2"; + Цвет = "000000"; + IDСтадии = "866"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет, 6, Истина, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409778.18036, + "finish": 1728409778.25574, + "duration": 0.0753860473632812, + "processing": 0.0437319278717041, + "date_start": "2024-10-08T20:49:38+03:00", + "date_finish": "2024-10-08T20:49:38+03:00", + "operating_reset_at": 1728410378, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Create-lead.md b/docs/ru/md/Bitrix24/Leads-managment/Create-lead.md deleted file mode 100644 index 89e7e5d273..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Create-lead.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать лид - Создает новый лид по структуре полей (см. ПолучитьСтруктуруЛида) - - - -`Функция СоздатьЛид(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей лида (см. ПолучитьСтруктуруЛида) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.lead.add](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_add.php) -::: -
- - -```bsl title="Пример кода" - МассивПочт = Новый Массив; - МассивПочт.Добавить(Новый Структура("VALUE,VALUE_TYPE", "yo@example.com", "HOME")); - МассивПочт.Добавить(Новый Структура("VALUE,VALUE_TYPE", "hi@example.com", "WORK")); - - МассивНомеров = Новый Массив; - МассивНомеров.Добавить(Новый Структура("VALUE,VALUE_TYPE", "88005553535", "WORK")); - - СтруктураПолей = Новый Структура; - СтруктураПолей.Вставить("ADDRESS" , "ул. Пушкина, д. 10"); - СтруктураПолей.Вставить("ADDRESS_COUNTRY", "Россия"); - СтруктураПолей.Вставить("EMAIL" , МассивПочт); - СтруктураПолей.Вставить("NAME" , "Петр"); - СтруктураПолей.Вставить("LAST_NAME" , "Петров"); - СтруктураПолей.Вставить("PHONE" , МассивНомеров); - СтруктураПолей.Вставить("TITLE" , "Мегаклиент"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьЛид(URL, СтруктураПолей); - - СтруктураПолей.Вставить("NAME" , "Иван"); - СтруктураПолей.Вставить("LAST_NAME" , "Иванов"); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьЛид(URL, СтруктураПолей, Токен); -``` - - - - -```json title="Результат" -{ - "result": 386, - "time": { - "start": 1728409882.43645, - "finish": 1728409882.94486, - "duration": 0.508409023284912, - "processing": 0.478672981262207, - "date_start": "2024-10-08T20:51:22+03:00", - "date_finish": "2024-10-08T20:51:22+03:00", - "operating_reset_at": 1728410482, - "operating": 0.47865104675293 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Create-lead.mdx b/docs/ru/md/Bitrix24/Leads-managment/Create-lead.mdx new file mode 100644 index 0000000000..84e4bdd35a --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Create-lead.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать лид + Создает новый лид по структуре полей (см. ПолучитьСтруктуруЛида) + + + +`Функция СоздатьЛид(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей лида (см. ПолучитьСтруктуруЛида) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.lead.add](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_add.php) +::: +
+ + +```bsl title="Пример кода" + МассивПочт = Новый Массив; + МассивПочт.Добавить(Новый Структура("VALUE,VALUE_TYPE", "yo@example.com", "HOME")); + МассивПочт.Добавить(Новый Структура("VALUE,VALUE_TYPE", "hi@example.com", "WORK")); + + МассивНомеров = Новый Массив; + МассивНомеров.Добавить(Новый Структура("VALUE,VALUE_TYPE", "88005553535", "WORK")); + + СтруктураПолей = Новый Структура; + СтруктураПолей.Вставить("ADDRESS" , "ул. Пушкина, д. 10"); + СтруктураПолей.Вставить("ADDRESS_COUNTRY", "Россия"); + СтруктураПолей.Вставить("EMAIL" , МассивПочт); + СтруктураПолей.Вставить("NAME" , "Петр"); + СтруктураПолей.Вставить("LAST_NAME" , "Петров"); + СтруктураПолей.Вставить("PHONE" , МассивНомеров); + СтруктураПолей.Вставить("TITLE" , "Мегаклиент"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьЛид(URL, СтруктураПолей); + + СтруктураПолей.Вставить("NAME" , "Иван"); + СтруктураПолей.Вставить("LAST_NAME" , "Иванов"); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьЛид(URL, СтруктураПолей, Токен); +``` + + + + +```json title="Результат" +{ + "result": 386, + "time": { + "start": 1728409882.43645, + "finish": 1728409882.94486, + "duration": 0.508409023284912, + "processing": 0.478672981262207, + "date_start": "2024-10-08T20:51:22+03:00", + "date_finish": "2024-10-08T20:51:22+03:00", + "operating_reset_at": 1728410482, + "operating": 0.47865104675293 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Delete-lead.md b/docs/ru/md/Bitrix24/Leads-managment/Delete-lead.md deleted file mode 100644 index 15cf581aeb..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Delete-lead.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Удалить лид - Удаляет лид по ID - - - -`Функция УдалитьЛид(Знач URL, Знач IDЛида, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЛида | --lead | Число, Строка | ID лида | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.lead.delete](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЛида = "412"; - - Результат = OPI_Bitrix24.УдалитьЛид(URL, IDЛида); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЛида = "414"; - - Результат = OPI_Bitrix24.УдалитьЛид(URL, IDЛида, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409883.85044, - "finish": 1728409883.9952, - "duration": 0.14475417137146, - "processing": 0.117740154266357, - "date_start": "2024-10-08T20:51:23+03:00", - "date_finish": "2024-10-08T20:51:23+03:00", - "operating_reset_at": 1728410483, - "operating": 0.117715835571289 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Delete-lead.mdx b/docs/ru/md/Bitrix24/Leads-managment/Delete-lead.mdx new file mode 100644 index 0000000000..fa8499195d --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Delete-lead.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Удалить лид + Удаляет лид по ID + + + +`Функция УдалитьЛид(Знач URL, Знач IDЛида, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЛида | --lead | Число, Строка | ID лида | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.lead.delete](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЛида = "412"; + + Результат = OPI_Bitrix24.УдалитьЛид(URL, IDЛида); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЛида = "414"; + + Результат = OPI_Bitrix24.УдалитьЛид(URL, IDЛида, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409883.85044, + "finish": 1728409883.9952, + "duration": 0.14475417137146, + "processing": 0.117740154266357, + "date_start": "2024-10-08T20:51:23+03:00", + "date_finish": "2024-10-08T20:51:23+03:00", + "operating_reset_at": 1728410483, + "operating": 0.117715835571289 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-lead-filter-structure.md b/docs/ru/md/Bitrix24/Leads-managment/Get-lead-filter-structure.md deleted file mode 100644 index e674cd983d..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Get-lead-filter-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить структуру фильтра лидов - Возвращает структуру полей для фильтрации лидов в методе ПолучитьСписокЛидов - - - -`Функция ПолучитьСтруктуруФильтраЛидов(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраЛидов(); -``` - - - - -```json title="Результат" -{ - "ID": "<идентификатор лида>", - "ASSIGNED_BY_ID": "<идентификатор ответственного>", - "COMPANY_ID": "<идентификатор компании>", - "COMPANY_TITLE": "<наименование компании>", - "CONTACT_ID": "<идентификатор контакта>", - "CREATED_BY_ID": "<идентификатор автора>", - "CURRENCY_ID": "<идентификатор валюты>", - "DATE_CLOSED": "<дата закрытия>", - "DATE_CREATE": "<дата создания>", - "DATE_MODIFY": "<дата изменения>", - "EMAIL": "<адрес электронной почты>", - "HAS_EMAIL": "<электронная почта заполнена (Y|N)>", - "HAS_PHONE": "<телефон заполнен (Y|N)>", - "IS_RETURN_CUSTOMER": "<признак повторного лида (Y|N)>", - "MODIFY_BY_ID": "<идентификатор автора последнего изменения>", - "MOVED_BY_ID": "<идентификатор автора перемещения лида на текущую стадию>", - "MOVED_TIME": "<дата перемещения лида на текущую стадию>", - "OPENED": "<признак доступен для всех (Y|N)>", - "OPPORTUNITY": "<предполагаемая сумма>", - "STATUS_ID": "<идентификатор статуса>", - "TITLE": "<название лида (можно искать по шаблону [%_])>" -} -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-lead-filter-structure.mdx b/docs/ru/md/Bitrix24/Leads-managment/Get-lead-filter-structure.mdx new file mode 100644 index 0000000000..418d4dc0de --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Get-lead-filter-structure.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить структуру фильтра лидов + Возвращает структуру полей для фильтрации лидов в методе ПолучитьСписокЛидов + + + +`Функция ПолучитьСтруктуруФильтраЛидов(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраЛидов(); +``` + + + + +```json title="Результат" +{ + "ID": "<идентификатор лида>", + "ASSIGNED_BY_ID": "<идентификатор ответственного>", + "COMPANY_ID": "<идентификатор компании>", + "COMPANY_TITLE": "<наименование компании>", + "CONTACT_ID": "<идентификатор контакта>", + "CREATED_BY_ID": "<идентификатор автора>", + "CURRENCY_ID": "<идентификатор валюты>", + "DATE_CLOSED": "<дата закрытия>", + "DATE_CREATE": "<дата создания>", + "DATE_MODIFY": "<дата изменения>", + "EMAIL": "<адрес электронной почты>", + "HAS_EMAIL": "<электронная почта заполнена (Y|N)>", + "HAS_PHONE": "<телефон заполнен (Y|N)>", + "IS_RETURN_CUSTOMER": "<признак повторного лида (Y|N)>", + "MODIFY_BY_ID": "<идентификатор автора последнего изменения>", + "MOVED_BY_ID": "<идентификатор автора перемещения лида на текущую стадию>", + "MOVED_TIME": "<дата перемещения лида на текущую стадию>", + "OPENED": "<признак доступен для всех (Y|N)>", + "OPPORTUNITY": "<предполагаемая сумма>", + "STATUS_ID": "<идентификатор статуса>", + "TITLE": "<название лида (можно искать по шаблону [%_])>" +} +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-lead-structure.md b/docs/ru/md/Bitrix24/Leads-managment/Get-lead-structure.md deleted file mode 100644 index 437c9a39e4..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Get-lead-structure.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить структуру лида - Получает структуру с описанием полей для создания лида - - - -`Функция ПолучитьСтруктуруЛида(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.lead.fields](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_fields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруЛида(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруЛида(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": { - "type": "integer", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "ID" - }, - "TITLE": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Название лида" - }, - "HONORIFIC": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "HONORIFIC", - "title": "Обращение" - }, - "NAME": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Имя" - }, - "SECOND_NAME": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Отчество" - }, - "LAST_NAME": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Фамилия" - }, - "BIRTHDATE": { - "type": "date", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Дата рождения" - }, - "COMPANY_TITLE": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Название компании" - }, - "SOURCE_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "SOURCE", - "title": "Источник" - }, - "SOURCE_DESCRIPTION": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Дополнительно об источнике" - }, - "STATUS_ID": { - "type": "crm_status", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "statusType": "STATUS", - "title": "Стадия" - }, - "STATUS_DESCRIPTION": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Дополнительно о стадии" - }, - "STATUS_SEMANTIC_ID": { - "type": "string", - "isRequired": false, - "isReadOnly": true, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Состояние статуса" - }, - "POST": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Должность" - }, - "ADDRESS": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Адрес" - }, - "ADDRESS_2": { - "type": "string", - "isRequired": false, - "isReadOnly": false, - "isImmutable": false, - "isMultiple": false, - "isDynamic": false, - "title": "Адрес (стр. 2)" - }, - "ADDRESS_CITY": { -... -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-lead-structure.mdx b/docs/ru/md/Bitrix24/Leads-managment/Get-lead-structure.mdx new file mode 100644 index 0000000000..6906b3221a --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Get-lead-structure.mdx @@ -0,0 +1,197 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить структуру лида + Получает структуру с описанием полей для создания лида + + + +`Функция ПолучитьСтруктуруЛида(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.lead.fields](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_fields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруЛида(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруЛида(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": { + "type": "integer", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "ID" + }, + "TITLE": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Название лида" + }, + "HONORIFIC": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "HONORIFIC", + "title": "Обращение" + }, + "NAME": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Имя" + }, + "SECOND_NAME": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Отчество" + }, + "LAST_NAME": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Фамилия" + }, + "BIRTHDATE": { + "type": "date", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Дата рождения" + }, + "COMPANY_TITLE": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Название компании" + }, + "SOURCE_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "SOURCE", + "title": "Источник" + }, + "SOURCE_DESCRIPTION": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Дополнительно об источнике" + }, + "STATUS_ID": { + "type": "crm_status", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "statusType": "STATUS", + "title": "Стадия" + }, + "STATUS_DESCRIPTION": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Дополнительно о стадии" + }, + "STATUS_SEMANTIC_ID": { + "type": "string", + "isRequired": false, + "isReadOnly": true, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Состояние статуса" + }, + "POST": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Должность" + }, + "ADDRESS": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Адрес" + }, + "ADDRESS_2": { + "type": "string", + "isRequired": false, + "isReadOnly": false, + "isImmutable": false, + "isMultiple": false, + "isDynamic": false, + "title": "Адрес (стр. 2)" + }, + "ADDRESS_CITY": { +... +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-lead.md b/docs/ru/md/Bitrix24/Leads-managment/Get-lead.md deleted file mode 100644 index b9a89ab8f9..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Get-lead.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить лид - Получает лид по ID - - - -`Функция ПолучитьЛид(Знач URL, Знач IDЛида, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЛида | --lead | Число,Строка | ID лида | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.lead.get](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЛида = "412"; - - Результат = OPI_Bitrix24.ПолучитьЛид(URL, IDЛида); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЛида = "414"; - - Результат = OPI_Bitrix24.ПолучитьЛид(URL, IDЛида, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "386", - "TITLE": "Мегаклиент", - "HONORIFIC": null, - "NAME": "Иван", - "SECOND_NAME": null, - "LAST_NAME": "Иванов", - "COMPANY_TITLE": null, - "COMPANY_ID": null, - "CONTACT_ID": "386", - "IS_RETURN_CUSTOMER": "N", - "BIRTHDATE": "", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "STATUS_ID": "CONVERTED", - "STATUS_DESCRIPTION": null, - "POST": null, - "COMMENTS": null, - "CURRENCY_ID": "BYN", - "OPPORTUNITY": "0.00", - "IS_MANUAL_OPPORTUNITY": "N", - "HAS_PHONE": "Y", - "HAS_EMAIL": "Y", - "HAS_IMOL": "N", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-10-08T20:51:22+03:00", - "DATE_MODIFY": "2024-10-08T20:51:22+03:00", - "DATE_CLOSED": "2024-10-08T20:51:22+03:00", - "STATUS_SEMANTIC_ID": "S", - "OPENED": "N", - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-10-08T20:51:22+03:00", - "ADDRESS": "ул. Пушкина, д. 10", - "ADDRESS_2": null, - "ADDRESS_CITY": null, - "ADDRESS_POSTAL_CODE": null, - "ADDRESS_REGION": null, - "ADDRESS_PROVINCE": null, - "ADDRESS_COUNTRY": "Россия", - "ADDRESS_COUNTRY_CODE": null, - "ADDRESS_LOC_ADDR_ID": "774", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1", - "LAST_ACTIVITY_TIME": "2024-10-08T20:51:22+03:00", - "EMAIL": [ - { - "ID": "2290", - "VALUE_TYPE": "HOME", - "VALUE": "yo@example.com", - "TYPE_ID": "EMAIL" - }, - { - "ID": "2292", - "VALUE_TYPE": "WORK", - "VALUE": "hi@example.com", - "TYPE_ID": "EMAIL" - } - ], - "PHONE": [ - { - "ID": "2294", - "VALUE_TYPE": "WORK", - "VALUE": "88005553535", - "TYPE_ID": "PHONE" - } - ] - }, - "time": { - "start": 1728409883.10739, - "finish": 1728409883.1573, - "duration": 0.0499157905578613, - "processing": 0.0190768241882324, - "date_start": "2024-10-08T20:51:23+03:00", - "date_finish": "2024-10-08T20:51:23+03:00", - "operating_reset_at": 1728410483, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-lead.mdx b/docs/ru/md/Bitrix24/Leads-managment/Get-lead.mdx new file mode 100644 index 0000000000..e3f9db67eb --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Get-lead.mdx @@ -0,0 +1,136 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить лид + Получает лид по ID + + + +`Функция ПолучитьЛид(Знач URL, Знач IDЛида, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЛида | --lead | Число,Строка | ID лида | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.lead.get](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЛида = "412"; + + Результат = OPI_Bitrix24.ПолучитьЛид(URL, IDЛида); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЛида = "414"; + + Результат = OPI_Bitrix24.ПолучитьЛид(URL, IDЛида, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "386", + "TITLE": "Мегаклиент", + "HONORIFIC": null, + "NAME": "Иван", + "SECOND_NAME": null, + "LAST_NAME": "Иванов", + "COMPANY_TITLE": null, + "COMPANY_ID": null, + "CONTACT_ID": "386", + "IS_RETURN_CUSTOMER": "N", + "BIRTHDATE": "", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "STATUS_ID": "CONVERTED", + "STATUS_DESCRIPTION": null, + "POST": null, + "COMMENTS": null, + "CURRENCY_ID": "BYN", + "OPPORTUNITY": "0.00", + "IS_MANUAL_OPPORTUNITY": "N", + "HAS_PHONE": "Y", + "HAS_EMAIL": "Y", + "HAS_IMOL": "N", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-10-08T20:51:22+03:00", + "DATE_MODIFY": "2024-10-08T20:51:22+03:00", + "DATE_CLOSED": "2024-10-08T20:51:22+03:00", + "STATUS_SEMANTIC_ID": "S", + "OPENED": "N", + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-10-08T20:51:22+03:00", + "ADDRESS": "ул. Пушкина, д. 10", + "ADDRESS_2": null, + "ADDRESS_CITY": null, + "ADDRESS_POSTAL_CODE": null, + "ADDRESS_REGION": null, + "ADDRESS_PROVINCE": null, + "ADDRESS_COUNTRY": "Россия", + "ADDRESS_COUNTRY_CODE": null, + "ADDRESS_LOC_ADDR_ID": "774", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1", + "LAST_ACTIVITY_TIME": "2024-10-08T20:51:22+03:00", + "EMAIL": [ + { + "ID": "2290", + "VALUE_TYPE": "HOME", + "VALUE": "yo@example.com", + "TYPE_ID": "EMAIL" + }, + { + "ID": "2292", + "VALUE_TYPE": "WORK", + "VALUE": "hi@example.com", + "TYPE_ID": "EMAIL" + } + ], + "PHONE": [ + { + "ID": "2294", + "VALUE_TYPE": "WORK", + "VALUE": "88005553535", + "TYPE_ID": "PHONE" + } + ] + }, + "time": { + "start": 1728409883.10739, + "finish": 1728409883.1573, + "duration": 0.0499157905578613, + "processing": 0.0190768241882324, + "date_start": "2024-10-08T20:51:23+03:00", + "date_finish": "2024-10-08T20:51:23+03:00", + "operating_reset_at": 1728410483, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-leads-list.md b/docs/ru/md/Bitrix24/Leads-managment/Get-leads-list.md deleted file mode 100644 index a867e51e22..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Get-leads-list.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить список лидов - Получает список лидов (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЛидов) - - - -`Функция ПолучитьСписокЛидов(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора лидов (см. ПолучитьСтруктуруФильтраЛидов) | - | Отступ | --offset | Число, Строка | Отступ от начала списка для получения лидов > 50 шт. рекурсивно | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.lead.list](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_list.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСписокЛидов(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Фильтр = Новый Структура; - Фильтр.Вставить("TITLE" , "Мегаклиент"); - Фильтр.Вставить("HAS_EMAIL", "Y"); - - Результат = OPI_Bitrix24.ПолучитьСписокЛидов(URL, Фильтр, , Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "8", - "TITLE": "Мегаклиент", - "HONORIFIC": null, - "NAME": "Петр", - "SECOND_NAME": null, - "LAST_NAME": "Петров", - "COMPANY_TITLE": null, - "COMPANY_ID": null, - "CONTACT_ID": "8", - "IS_RETURN_CUSTOMER": "N", - "BIRTHDATE": "", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "STATUS_ID": "CONVERTED", - "STATUS_DESCRIPTION": null, - "POST": null, - "COMMENTS": null, - "CURRENCY_ID": "BYN", - "OPPORTUNITY": "0.00", - "IS_MANUAL_OPPORTUNITY": "N", - "HAS_PHONE": "Y", - "HAS_EMAIL": "Y", - "HAS_IMOL": "N", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-08-22T19:48:12+03:00", - "DATE_MODIFY": "2024-08-22T19:48:12+03:00", - "DATE_CLOSED": "2024-08-22T19:48:12+03:00", - "STATUS_SEMANTIC_ID": "S", - "OPENED": "N", - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-08-22T19:48:12+03:00", - "ADDRESS": "ул. Пушкина, д. 10", - "ADDRESS_2": null, - "ADDRESS_CITY": null, - "ADDRESS_POSTAL_CODE": null, - "ADDRESS_REGION": null, - "ADDRESS_PROVINCE": null, - "ADDRESS_COUNTRY": "Россия", - "ADDRESS_COUNTRY_CODE": null, - "ADDRESS_LOC_ADDR_ID": "14", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1", - "LAST_ACTIVITY_TIME": "2024-08-22T19:48:12+03:00" - }, - { - "ID": "10", - "TITLE": "Мегаклиент", - "HONORIFIC": null, - "NAME": "Иван", - "SECOND_NAME": null, - "LAST_NAME": "Иванов", - "COMPANY_TITLE": null, - "COMPANY_ID": null, - "CONTACT_ID": "10", - "IS_RETURN_CUSTOMER": "N", - "BIRTHDATE": "", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "STATUS_ID": "CONVERTED", - "STATUS_DESCRIPTION": null, - "POST": null, - "COMMENTS": null, - "CURRENCY_ID": "BYN", - "OPPORTUNITY": "0.00", - "IS_MANUAL_OPPORTUNITY": "N", - "HAS_PHONE": "Y", - "HAS_EMAIL": "Y", - "HAS_IMOL": "N", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-08-22T19:48:13+03:00", - "DATE_MODIFY": "2024-08-22T19:48:13+03:00", - "DATE_CLOSED": "2024-08-22T19:48:13+03:00", - "STATUS_SEMANTIC_ID": "S", - "OPENED": "N", - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-08-22T19:48:13+03:00", - "ADDRESS": "ул. Пушкина, д. 10", - "ADDRESS_2": null, - "ADDRESS_CITY": null, - "ADDRESS_POSTAL_CODE": null, - "ADDRESS_REGION": null, - "ADDRESS_PROVINCE": null, - "ADDRESS_COUNTRY": "Россия", - "ADDRESS_COUNTRY_CODE": null, - "ADDRESS_LOC_ADDR_ID": "18", - "UTM_SOURCE": null, - "UTM_MEDIUM": null, - "UTM_CAMPAIGN": null, - "UTM_CONTENT": null, - "UTM_TERM": null, - "LAST_ACTIVITY_BY": "1", - "LAST_ACTIVITY_TIME": "2024-08-22T19:48:13+03:00" - }, - { - "ID": "12", - "TITLE": "Мегаклиент", - "HONORIFIC": null, - "NAME": "Петр", - "SECOND_NAME": null, - "LAST_NAME": "Петров", - "COMPANY_TITLE": null, - "COMPANY_ID": null, - "CONTACT_ID": "12", - "IS_RETURN_CUSTOMER": "N", - "BIRTHDATE": "", - "SOURCE_ID": null, - "SOURCE_DESCRIPTION": null, - "STATUS_ID": "CONVERTED", - "STATUS_DESCRIPTION": null, - "POST": null, - "COMMENTS": null, - "CURRENCY_ID": "BYN", - "OPPORTUNITY": "0.00", - "IS_MANUAL_OPPORTUNITY": "N", - "HAS_PHONE": "Y", - "HAS_EMAIL": "Y", - "HAS_IMOL": "N", - "ASSIGNED_BY_ID": "1", - "CREATED_BY_ID": "1", - "MODIFY_BY_ID": "1", - "DATE_CREATE": "2024-08-22T20:00:19+03:00", - "DATE_MODIFY": "2024-08-22T20:00:20+03:00", - "DATE_CLOSED": "2024-08-22T20:00:20+03:00", - "STATUS_SEMANTIC_ID": "S", - "OPENED": "N", - "ORIGINATOR_ID": null, - "ORIGIN_ID": null, - "MOVED_BY_ID": "1", - "MOVED_TIME": "2024-08-22T20:00:20+03:00", - "ADDRESS": "ул. Пушкина, д. 10", - "ADDRESS_2": null, - "ADDRESS_CITY": null, - "ADDRESS_POSTAL_CODE": null, - "ADDRESS_REGION": null, - "ADDRESS_PROVINCE": null, -... -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Get-leads-list.mdx b/docs/ru/md/Bitrix24/Leads-managment/Get-leads-list.mdx new file mode 100644 index 0000000000..1d011075c3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Get-leads-list.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить список лидов + Получает список лидов (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЛидов) + + + +`Функция ПолучитьСписокЛидов(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора лидов (см. ПолучитьСтруктуруФильтраЛидов) | + | Отступ | --offset | Число, Строка | Отступ от начала списка для получения лидов > 50 шт. рекурсивно | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.lead.list](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_list.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСписокЛидов(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Фильтр = Новый Структура; + Фильтр.Вставить("TITLE" , "Мегаклиент"); + Фильтр.Вставить("HAS_EMAIL", "Y"); + + Результат = OPI_Bitrix24.ПолучитьСписокЛидов(URL, Фильтр, , Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "8", + "TITLE": "Мегаклиент", + "HONORIFIC": null, + "NAME": "Петр", + "SECOND_NAME": null, + "LAST_NAME": "Петров", + "COMPANY_TITLE": null, + "COMPANY_ID": null, + "CONTACT_ID": "8", + "IS_RETURN_CUSTOMER": "N", + "BIRTHDATE": "", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "STATUS_ID": "CONVERTED", + "STATUS_DESCRIPTION": null, + "POST": null, + "COMMENTS": null, + "CURRENCY_ID": "BYN", + "OPPORTUNITY": "0.00", + "IS_MANUAL_OPPORTUNITY": "N", + "HAS_PHONE": "Y", + "HAS_EMAIL": "Y", + "HAS_IMOL": "N", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-08-22T19:48:12+03:00", + "DATE_MODIFY": "2024-08-22T19:48:12+03:00", + "DATE_CLOSED": "2024-08-22T19:48:12+03:00", + "STATUS_SEMANTIC_ID": "S", + "OPENED": "N", + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-08-22T19:48:12+03:00", + "ADDRESS": "ул. Пушкина, д. 10", + "ADDRESS_2": null, + "ADDRESS_CITY": null, + "ADDRESS_POSTAL_CODE": null, + "ADDRESS_REGION": null, + "ADDRESS_PROVINCE": null, + "ADDRESS_COUNTRY": "Россия", + "ADDRESS_COUNTRY_CODE": null, + "ADDRESS_LOC_ADDR_ID": "14", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1", + "LAST_ACTIVITY_TIME": "2024-08-22T19:48:12+03:00" + }, + { + "ID": "10", + "TITLE": "Мегаклиент", + "HONORIFIC": null, + "NAME": "Иван", + "SECOND_NAME": null, + "LAST_NAME": "Иванов", + "COMPANY_TITLE": null, + "COMPANY_ID": null, + "CONTACT_ID": "10", + "IS_RETURN_CUSTOMER": "N", + "BIRTHDATE": "", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "STATUS_ID": "CONVERTED", + "STATUS_DESCRIPTION": null, + "POST": null, + "COMMENTS": null, + "CURRENCY_ID": "BYN", + "OPPORTUNITY": "0.00", + "IS_MANUAL_OPPORTUNITY": "N", + "HAS_PHONE": "Y", + "HAS_EMAIL": "Y", + "HAS_IMOL": "N", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-08-22T19:48:13+03:00", + "DATE_MODIFY": "2024-08-22T19:48:13+03:00", + "DATE_CLOSED": "2024-08-22T19:48:13+03:00", + "STATUS_SEMANTIC_ID": "S", + "OPENED": "N", + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-08-22T19:48:13+03:00", + "ADDRESS": "ул. Пушкина, д. 10", + "ADDRESS_2": null, + "ADDRESS_CITY": null, + "ADDRESS_POSTAL_CODE": null, + "ADDRESS_REGION": null, + "ADDRESS_PROVINCE": null, + "ADDRESS_COUNTRY": "Россия", + "ADDRESS_COUNTRY_CODE": null, + "ADDRESS_LOC_ADDR_ID": "18", + "UTM_SOURCE": null, + "UTM_MEDIUM": null, + "UTM_CAMPAIGN": null, + "UTM_CONTENT": null, + "UTM_TERM": null, + "LAST_ACTIVITY_BY": "1", + "LAST_ACTIVITY_TIME": "2024-08-22T19:48:13+03:00" + }, + { + "ID": "12", + "TITLE": "Мегаклиент", + "HONORIFIC": null, + "NAME": "Петр", + "SECOND_NAME": null, + "LAST_NAME": "Петров", + "COMPANY_TITLE": null, + "COMPANY_ID": null, + "CONTACT_ID": "12", + "IS_RETURN_CUSTOMER": "N", + "BIRTHDATE": "", + "SOURCE_ID": null, + "SOURCE_DESCRIPTION": null, + "STATUS_ID": "CONVERTED", + "STATUS_DESCRIPTION": null, + "POST": null, + "COMMENTS": null, + "CURRENCY_ID": "BYN", + "OPPORTUNITY": "0.00", + "IS_MANUAL_OPPORTUNITY": "N", + "HAS_PHONE": "Y", + "HAS_EMAIL": "Y", + "HAS_IMOL": "N", + "ASSIGNED_BY_ID": "1", + "CREATED_BY_ID": "1", + "MODIFY_BY_ID": "1", + "DATE_CREATE": "2024-08-22T20:00:19+03:00", + "DATE_MODIFY": "2024-08-22T20:00:20+03:00", + "DATE_CLOSED": "2024-08-22T20:00:20+03:00", + "STATUS_SEMANTIC_ID": "S", + "OPENED": "N", + "ORIGINATOR_ID": null, + "ORIGIN_ID": null, + "MOVED_BY_ID": "1", + "MOVED_TIME": "2024-08-22T20:00:20+03:00", + "ADDRESS": "ул. Пушкина, д. 10", + "ADDRESS_2": null, + "ADDRESS_CITY": null, + "ADDRESS_POSTAL_CODE": null, + "ADDRESS_REGION": null, + "ADDRESS_PROVINCE": null, +... +``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Update-lead.md b/docs/ru/md/Bitrix24/Leads-managment/Update-lead.md deleted file mode 100644 index d5dbc4907a..0000000000 --- a/docs/ru/md/Bitrix24/Leads-managment/Update-lead.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Изменить лид - Изменяет существующий лид - - - -`Функция ИзменитьЛид(Знач URL, Знач IDЛида, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЛида | --lead | Число, Строка | ID лида | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей лида | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 - -
- -:::tip -Метод в документации API: [crm.lead.update](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_update.php) -::: -
- - -```bsl title="Пример кода" - СтруктураПолей = Новый Структура; - СтруктураПолей.Вставить("ADDRESS" , "ул. Лермонтова, д. 20"); - СтруктураПолей.Вставить("ADDRESS_COUNTRY", "Беларусь"); - СтруктураПолей.Вставить("TITLE" , "Суперклиент"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЛида = "412"; - - Результат = OPI_Bitrix24.ИзменитьЛид(URL, IDЛида, СтруктураПолей); - - СтруктураПолей.Вставить("NAME" , "Евгений"); - СтруктураПолей.Вставить("LAST_NAME" , "Евгеньев"); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЛида = "414"; - - Результат = OPI_Bitrix24.ИзменитьЛид(URL, IDЛида, СтруктураПолей, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409883.41199, - "finish": 1728409883.55397, - "duration": 0.141980171203613, - "processing": 0.114175081253052, - "date_start": "2024-10-08T20:51:23+03:00", - "date_finish": "2024-10-08T20:51:23+03:00", - "operating_reset_at": 1728410483, - "operating": 0.114147901535034 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Leads-managment/Update-lead.mdx b/docs/ru/md/Bitrix24/Leads-managment/Update-lead.mdx new file mode 100644 index 0000000000..f2b37fde72 --- /dev/null +++ b/docs/ru/md/Bitrix24/Leads-managment/Update-lead.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Изменить лид + Изменяет существующий лид + + + +`Функция ИзменитьЛид(Знач URL, Знач IDЛида, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЛида | --lead | Число, Строка | ID лида | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей лида | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24 + +
+ +:::tip +Метод в документации API: [crm.lead.update](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_update.php) +::: +
+ + +```bsl title="Пример кода" + СтруктураПолей = Новый Структура; + СтруктураПолей.Вставить("ADDRESS" , "ул. Лермонтова, д. 20"); + СтруктураПолей.Вставить("ADDRESS_COUNTRY", "Беларусь"); + СтруктураПолей.Вставить("TITLE" , "Суперклиент"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЛида = "412"; + + Результат = OPI_Bitrix24.ИзменитьЛид(URL, IDЛида, СтруктураПолей); + + СтруктураПолей.Вставить("NAME" , "Евгений"); + СтруктураПолей.Вставить("LAST_NAME" , "Евгеньев"); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЛида = "414"; + + Результат = OPI_Bitrix24.ИзменитьЛид(URL, IDЛида, СтруктураПолей, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409883.41199, + "finish": 1728409883.55397, + "duration": 0.141980171203613, + "processing": 0.114175081253052, + "date_start": "2024-10-08T20:51:23+03:00", + "date_finish": "2024-10-08T20:51:23+03:00", + "operating_reset_at": 1728410483, + "operating": 0.114147901535034 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Delete-message.md b/docs/ru/md/Bitrix24/Message-management/Delete-message.md deleted file mode 100644 index 3226e7c595..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Delete-message.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить сообщение - Удаляет сообщение в диалоге - - - -`Функция УдалитьСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСообщения | --message | Строка, Число | ID сообщения для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDСообщения = "18126"; - - Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDСообщения = "18128"; - - Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409852.65806, - "finish": 1728409852.70749, - "duration": 0.0494339466094971, - "processing": 0.0221900939941406, - "date_start": "2024-10-08T20:50:52+03:00", - "date_finish": "2024-10-08T20:50:52+03:00", - "operating_reset_at": 1728410452, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Delete-message.mdx b/docs/ru/md/Bitrix24/Message-management/Delete-message.mdx new file mode 100644 index 0000000000..e0f915e219 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Delete-message.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить сообщение + Удаляет сообщение в диалоге + + + +`Функция УдалитьСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDСообщения = "18126"; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDСообщения = "18128"; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409852.65806, + "finish": 1728409852.70749, + "duration": 0.0494339466094971, + "processing": 0.0221900939941406, + "date_start": "2024-10-08T20:50:52+03:00", + "date_finish": "2024-10-08T20:50:52+03:00", + "operating_reset_at": 1728410452, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Edit-message.md b/docs/ru/md/Bitrix24/Message-management/Edit-message.md deleted file mode 100644 index d988e7f344..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Edit-message.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить сообщение - Изменяет сообщение в диалоге - - - -`Функция ИзменитьСообщение(Знач URL, Знач IDСообщения, Знач Текст = "", Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСообщения | --message | Строка, Число | ID сообщения для изменения | - | Текст | --text | Строка | Новый текст сообщения | - | Вложения | --blocks | Массив из Структура | Новый массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDСообщения = "18126"; - - Текст = "Новый текст сообщения"; - - Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDСообщения = "18128"; - - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст, Вложения, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409847.24148, - "finish": 1728409847.29817, - "duration": 0.0566887855529785, - "processing": 0.0310389995574951, - "date_start": "2024-10-08T20:50:47+03:00", - "date_finish": "2024-10-08T20:50:47+03:00", - "operating_reset_at": 1728410447, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Edit-message.mdx b/docs/ru/md/Bitrix24/Message-management/Edit-message.mdx new file mode 100644 index 0000000000..4e835db032 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Edit-message.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить сообщение + Изменяет сообщение в диалоге + + + +`Функция ИзменитьСообщение(Знач URL, Знач IDСообщения, Знач Текст = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения для изменения | + | Текст | --text | Строка | Новый текст сообщения | + | Вложения | --blocks | Массив из Структура | Новый массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDСообщения = "18126"; + + Текст = "Новый текст сообщения"; + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDСообщения = "18128"; + + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст, Вложения, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409847.24148, + "finish": 1728409847.29817, + "duration": 0.0566887855529785, + "processing": 0.0310389995574951, + "date_start": "2024-10-08T20:50:47+03:00", + "date_finish": "2024-10-08T20:50:47+03:00", + "operating_reset_at": 1728410447, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Get-file-block.md b/docs/ru/md/Bitrix24/Message-management/Get-file-block.md deleted file mode 100644 index b540157c11..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Get-file-block.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Получить блок файла - Формирует блок файла для отправки в функции ОтправитьСообщение - - - -`Функция ПолучитьБлокФайла(Знач Наименование, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование картинки | - | URL | --url | Строка | URL файла для отправки | - - - Возвращаемое значение: Структура - Блок с файлом - -
- -:::tip -Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - -```bsl title="Пример кода" - Наименование = "Картинка"; - URL = "https://api.athenaeum.digital/test_data/document.docx"; - - Результат = OPI_Bitrix24.ПолучитьБлокФайла(Наименование, URL); -``` - - - - -```json title="Результат" -{ - "FILE": { - "NAME": "Картинка", - "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Get-file-block.mdx b/docs/ru/md/Bitrix24/Message-management/Get-file-block.mdx new file mode 100644 index 0000000000..1baaa31edf --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Get-file-block.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Получить блок файла + Формирует блок файла для отправки в функции ОтправитьСообщение + + + +`Функция ПолучитьБлокФайла(Знач Наименование, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование картинки | + | URL | --url | Строка | URL файла для отправки | + + + Возвращаемое значение: Структура - Блок с файлом + +
+ +:::tip +Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Картинка"; + URL = "https://api.athenaeum.digital/test_data/document.docx"; + + Результат = OPI_Bitrix24.ПолучитьБлокФайла(Наименование, URL); +``` + + + + +```json title="Результат" +{ + "FILE": { + "NAME": "Картинка", + "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md deleted file mode 100644 index 1a629574f1..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить блок картинки - Формирует картинку для отправки в функции ОтправитьСообщение - - - -`Функция ПолучитьБлокКартинки(Знач Наименование, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование картинки | - | URL | --url | Строка | URL картинки для отправки | - - - Возвращаемое значение: Структура - Блок с картинкой - -
- -:::tip -Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - -```bsl title="Пример кода" - Наименование = "Картинка"; - URL = "https://api.athenaeum.digital/test_data/picture.jpg"; - - Результат = OPI_Bitrix24.ПолучитьБлокКартинки(Наименование, URL); -``` - - - - -```json title="Результат" -{ - "IMAGE": { - "NAME": "Картинка", - "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Get-picture-block.mdx b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.mdx new file mode 100644 index 0000000000..f4964c0d29 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить блок картинки + Формирует картинку для отправки в функции ОтправитьСообщение + + + +`Функция ПолучитьБлокКартинки(Знач Наименование, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование картинки | + | URL | --url | Строка | URL картинки для отправки | + + + Возвращаемое значение: Структура - Блок с картинкой + +
+ +:::tip +Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Картинка"; + URL = "https://api.athenaeum.digital/test_data/picture.jpg"; + + Результат = OPI_Bitrix24.ПолучитьБлокКартинки(Наименование, URL); +``` + + + + +```json title="Результат" +{ + "IMAGE": { + "NAME": "Картинка", + "LINK": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md deleted file mode 100644 index 31f01a7eaa..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Отметить сообщение как прочитанное - Отмечает выбранное сообщение и все сообщения до него как прочитанные - - - -`Функция ОтметитьСообщениеКакПрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | IDСообщения | --message | Строка, Число | ID последнего прочитанного сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat" + "1006"; - IDСообщения = "18126"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDЧата, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - IDСообщения = "18128"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDПользователя, IDСообщения, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "dialogId": 10, - "chatId": 10, - "lastId": 17538, - "counter": 0 - }, - "time": { - "start": 1728409841.01595, - "finish": 1728409841.06124, - "duration": 0.0452930927276611, - "processing": 0.0184299945831299, - "date_start": "2024-10-08T20:50:41+03:00", - "date_finish": "2024-10-08T20:50:41+03:00", - "operating_reset_at": 1728410441, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.mdx b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.mdx new file mode 100644 index 0000000000..7879115cd3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Отметить сообщение как прочитанное + Отмечает выбранное сообщение и все сообщения до него как прочитанные + + + +`Функция ОтметитьСообщениеКакПрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDСообщения | --message | Строка, Число | ID последнего прочитанного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat" + "1006"; + IDСообщения = "18126"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDЧата, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + IDСообщения = "18128"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDПользователя, IDСообщения, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "dialogId": 10, + "chatId": 10, + "lastId": 17538, + "counter": 0 + }, + "time": { + "start": 1728409841.01595, + "finish": 1728409841.06124, + "duration": 0.0452930927276611, + "processing": 0.0184299945831299, + "date_start": "2024-10-08T20:50:41+03:00", + "date_finish": "2024-10-08T20:50:41+03:00", + "operating_reset_at": 1728410441, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md deleted file mode 100644 index 5054df88f2..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Отметить сообщение как непрочитанное - Отмечает выбранное сообщение и все сообщения после него как непрочитанные - - - -`Функция ОтметитьСообщениеКакНепрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | IDСообщения | --message | Строка, Число | ID послднего непрочитанного сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat" + "1006"; - IDСообщения = "18126"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDЧата, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - IDСообщения = "18128"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDПользователя, IDСообщения, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409841.21042, - "finish": 1728409841.28342, - "duration": 0.0729920864105225, - "processing": 0.046436071395874, - "date_start": "2024-10-08T20:50:41+03:00", - "date_finish": "2024-10-08T20:50:41+03:00", - "operating_reset_at": 1728410441, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.mdx b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.mdx new file mode 100644 index 0000000000..e833f376bc --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Отметить сообщение как непрочитанное + Отмечает выбранное сообщение и все сообщения после него как непрочитанные + + + +`Функция ОтметитьСообщениеКакНепрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDСообщения | --message | Строка, Число | ID послднего непрочитанного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat" + "1006"; + IDСообщения = "18126"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDЧата, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + IDСообщения = "18128"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDПользователя, IDСообщения, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409841.21042, + "finish": 1728409841.28342, + "duration": 0.0729920864105225, + "processing": 0.046436071395874, + "date_start": "2024-10-08T20:50:41+03:00", + "date_finish": "2024-10-08T20:50:41+03:00", + "operating_reset_at": 1728410441, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-file.md b/docs/ru/md/Bitrix24/Message-management/Send-file.md deleted file mode 100644 index bc41ebf217..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Send-file.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Отправить файл - Отправляет файл диска в чат по ID - - - -`Функция ОтправитьФайл(Знач URL, Знач IDЧата, Знач IDФайла, Знач Описание = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDФайла | --fileid | Строка, Число | ID файла, загруженного при помощи ЗагрузитьФайлВКаталог | - | Описание | --description | Строка | Описание файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "1006"; - Файл = "https://api.athenaeum.digital/test_data/document.docx"; // Двоичные данные, URL или путь к файлу - Описание = "Очень важный файл"; - - Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); - IDКаталога = Каталог["result"]["ID"]; - - ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога); - IDФайла = ЗагруженныйФайл["result"]["ID"]; - - Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЧата = "1008"; - - Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); - IDКаталога = Каталог["result"]["ID"]; - - ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога, Токен); - IDФайла = ЗагруженныйФайл["result"]["ID"]; - - Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "FILES": { - "upload12494": { - "id": 12494, - "chatId": 980, - "date": {}, - "type": "file", - "name": "Важный документ.docx", - "extension": "docx", - "size": 24071, - "image": false, - "status": "done", - "progress": 100, - "authorId": 1, - "authorName": "Антон Титовец", - "urlPreview": "", - "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12494&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12494&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "viewerAttrs": { - "viewer": null, - "viewerType": "cloud-document", - "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12494&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", - "viewerSeparateItem": true, - "viewerExtension": "im.integration.viewer", - "objectId": "12494", - "imChatId": 980, - "title": "Важный документ.docx", - "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"12494\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" - } - } - }, - "DISK_ID": [ - "12494" - ], - "FILE_MODELS": { - "upload12494": { - "id": 12494, - "name": "Важный документ.docx", - "createTime": {}, - "updateTime": {}, - "deleteTime": null, - "code": null, - "xmlId": null, - "storageId": 6, - "realObjectId": 12494, - "parentId": 12490, - "deletedType": 0, - "createdBy": "1", - "updatedBy": "1", - "deletedBy": "0", - "typeFile": 4, - "globalContentVersion": 2, - "fileId": 8608, - "size": 24071, - "etag": "2b187abc4e0ad8f0dddca6137313bc3f", - "links": { - "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=12494", - "showInGrid": "/bitrix/tools/disk/focus.php?objectId=12494&action=showObjectInGrid&ncc=1" - } - } - }, - "MESSAGE_ID": 17618 - }, - "time": { - "start": 1728409854.91573, - "finish": 1728409855.01136, - "duration": 0.0956261157989502, - "processing": 0.0702199935913086, - "date_start": "2024-10-08T20:50:54+03:00", - "date_finish": "2024-10-08T20:50:55+03:00", - "operating_reset_at": 1728410454, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-file.mdx b/docs/ru/md/Bitrix24/Message-management/Send-file.mdx new file mode 100644 index 0000000000..8f4c8317d3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Send-file.mdx @@ -0,0 +1,141 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Отправить файл + Отправляет файл диска в чат по ID + + + +`Функция ОтправитьФайл(Знач URL, Знач IDЧата, Знач IDФайла, Знач Описание = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDФайла | --fileid | Строка, Число | ID файла, загруженного при помощи ЗагрузитьФайлВКаталог | + | Описание | --description | Строка | Описание файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "1006"; + Файл = "https://api.athenaeum.digital/test_data/document.docx"; // Двоичные данные, URL или путь к файлу + Описание = "Очень важный файл"; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЧата = "1008"; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога, Токен); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "FILES": { + "upload12494": { + "id": 12494, + "chatId": 980, + "date": {}, + "type": "file", + "name": "Важный документ.docx", + "extension": "docx", + "size": 24071, + "image": false, + "status": "done", + "progress": 100, + "authorId": 1, + "authorName": "Антон Титовец", + "urlPreview": "", + "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12494&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12494&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerAttrs": { + "viewer": null, + "viewerType": "cloud-document", + "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=12494&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", + "viewerSeparateItem": true, + "viewerExtension": "im.integration.viewer", + "objectId": "12494", + "imChatId": 980, + "title": "Важный документ.docx", + "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"12494\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" + } + } + }, + "DISK_ID": [ + "12494" + ], + "FILE_MODELS": { + "upload12494": { + "id": 12494, + "name": "Важный документ.docx", + "createTime": {}, + "updateTime": {}, + "deleteTime": null, + "code": null, + "xmlId": null, + "storageId": 6, + "realObjectId": 12494, + "parentId": 12490, + "deletedType": 0, + "createdBy": "1", + "updatedBy": "1", + "deletedBy": "0", + "typeFile": 4, + "globalContentVersion": 2, + "fileId": 8608, + "size": 24071, + "etag": "2b187abc4e0ad8f0dddca6137313bc3f", + "links": { + "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=12494", + "showInGrid": "/bitrix/tools/disk/focus.php?objectId=12494&action=showObjectInGrid&ncc=1" + } + } + }, + "MESSAGE_ID": 17618 + }, + "time": { + "start": 1728409854.91573, + "finish": 1728409855.01136, + "duration": 0.0956261157989502, + "processing": 0.0702199935913086, + "date_start": "2024-10-08T20:50:54+03:00", + "date_finish": "2024-10-08T20:50:55+03:00", + "operating_reset_at": 1728410454, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-message.md b/docs/ru/md/Bitrix24/Message-management/Send-message.md deleted file mode 100644 index c8d335f480..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Send-message.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Отправить сообщение - Отправляет сообщение в диалог - - - -`Функция ОтправитьСообщение(Знач URL, Знач IDЧата, Знач Текст, Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Текст | --text | Строка | Текст сообщения | - | Вложения | --blocks | Массив из Структура | Массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЧата = "chat" + "1006"; - Текст = "Текст сообщения"; - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDЧата, Текст, Вложения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDПользователя, Текст, , Токен); -``` - - - - -```json title="Результат" -{ - "result": 17614, - "time": { - "start": 1728409846.99786, - "finish": 1728409847.08639, - "duration": 0.0885319709777832, - "processing": 0.0592019557952881, - "date_start": "2024-10-08T20:50:46+03:00", - "date_finish": "2024-10-08T20:50:47+03:00", - "operating_reset_at": 1728410447, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-message.mdx b/docs/ru/md/Bitrix24/Message-management/Send-message.mdx new file mode 100644 index 0000000000..86c81fb2ce --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Send-message.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Отправить сообщение + Отправляет сообщение в диалог + + + +`Функция ОтправитьСообщение(Знач URL, Знач IDЧата, Знач Текст, Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Текст | --text | Строка | Текст сообщения | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЧата = "chat" + "1006"; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDЧата, Текст, Вложения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDПользователя, Текст, , Токен); +``` + + + + +```json title="Результат" +{ + "result": 17614, + "time": { + "start": 1728409846.99786, + "finish": 1728409847.08639, + "duration": 0.0885319709777832, + "processing": 0.0592019557952881, + "date_start": "2024-10-08T20:50:46+03:00", + "date_finish": "2024-10-08T20:50:47+03:00", + "operating_reset_at": 1728410447, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md deleted file mode 100644 index e51f192e00..0000000000 --- a/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Установить реакцию на сообщение - Устанавливает или снимает реакцию на сообщение - - - -`Функция УстановитьРеакциюНаСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСообщения | --message | Строка, Число | ID сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDСообщения = "18126"; - - Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDСообщения = "18128"; - - Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409852.4642, - "finish": 1728409852.51029, - "duration": 0.0460889339447022, - "processing": 0.0185801982879639, - "date_start": "2024-10-08T20:50:52+03:00", - "date_finish": "2024-10-08T20:50:52+03:00", - "operating_reset_at": 1728410452, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.mdx b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.mdx new file mode 100644 index 0000000000..8b84659aff --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Установить реакцию на сообщение + Устанавливает или снимает реакцию на сообщение + + + +`Функция УстановитьРеакциюНаСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDСообщения = "18126"; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDСообщения = "18128"; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409852.4642, + "finish": 1728409852.51029, + "duration": 0.0460889339447022, + "processing": 0.0185801982879639, + "date_start": "2024-10-08T20:50:52+03:00", + "date_finish": "2024-10-08T20:50:52+03:00", + "operating_reset_at": 1728410452, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md deleted file mode 100644 index 98258f6624..0000000000 --- a/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать персональное уведомление - Создает персональное уведомление пользователю - - - -`Функция СоздатьПерсональноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | - | Текст | --text | Строка | Текст уведомления | - | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | - | Вложения | --blocks | Массив из Структура | Массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) -::: -
- - -```bsl title="Пример кода" - IDПользователя = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Текст = "Текст сообщения"; - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, ,Вложения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - Тег = "Новый"; - IDПользователя = 10; - - Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); -``` - - - - -```json title="Результат" -{ - "result": 17622, - "time": { - "start": 1728409862.98483, - "finish": 1728409863.04925, - "duration": 0.0644199848175049, - "processing": 0.0390210151672363, - "date_start": "2024-10-08T20:51:02+03:00", - "date_finish": "2024-10-08T20:51:03+03:00", - "operating_reset_at": 1728410463, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.mdx b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.mdx new file mode 100644 index 0000000000..c5326499bd --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать персональное уведомление + Создает персональное уведомление пользователю + + + +`Функция СоздатьПерсональноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | + | Текст | --text | Строка | Текст уведомления | + | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) +::: +
+ + +```bsl title="Пример кода" + IDПользователя = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); +``` + + + + +```json title="Результат" +{ + "result": 17622, + "time": { + "start": 1728409862.98483, + "finish": 1728409863.04925, + "duration": 0.0644199848175049, + "processing": 0.0390210151672363, + "date_start": "2024-10-08T20:51:02+03:00", + "date_finish": "2024-10-08T20:51:03+03:00", + "operating_reset_at": 1728410463, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md deleted file mode 100644 index 2b91cebe75..0000000000 --- a/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать системное уведомление - Создает системное уведомление пользователю - - - -`Функция СоздатьСистемноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | - | Текст | --text | Строка | Текст уведомления | - | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | - | Вложения | --blocks | Массив из Структура | Массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) -::: -
- - -```bsl title="Пример кода" - IDПользователя = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Текст = "Текст сообщения"; - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, ,Вложения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - Тег = "Новый"; - IDПользователя = 10; - - Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); -``` - - - - -```json title="Результат" -{ - "result": 17626, - "time": { - "start": 1728409863.20741, - "finish": 1728409863.2602, - "duration": 0.052786111831665, - "processing": 0.0277860164642334, - "date_start": "2024-10-08T20:51:03+03:00", - "date_finish": "2024-10-08T20:51:03+03:00", - "operating_reset_at": 1728410463, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.mdx b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.mdx new file mode 100644 index 0000000000..93258740db --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать системное уведомление + Создает системное уведомление пользователю + + + +`Функция СоздатьСистемноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | + | Текст | --text | Строка | Текст уведомления | + | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) +::: +
+ + +```bsl title="Пример кода" + IDПользователя = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); +``` + + + + +```json title="Результат" +{ + "result": 17626, + "time": { + "start": 1728409863.20741, + "finish": 1728409863.2602, + "duration": 0.052786111831665, + "processing": 0.0277860164642334, + "date_start": "2024-10-08T20:51:03+03:00", + "date_finish": "2024-10-08T20:51:03+03:00", + "operating_reset_at": 1728410463, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md deleted file mode 100644 index 017e91385e..0000000000 --- a/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить уведомление - Удаляет уведомление по ID - - - -`Функция УдалитьУведомление(Знач URL, Знач IDУведомления, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDУведомления | --notif | Строка, Число | ID уведомления для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDУведомления = "18134"; - - Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDУведомления = "18136"; - - Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409863.31584, - "finish": 1728409863.36028, - "duration": 0.0444409847259522, - "processing": 0.016265869140625, - "date_start": "2024-10-08T20:51:03+03:00", - "date_finish": "2024-10-08T20:51:03+03:00", - "operating_reset_at": 1728410463, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.mdx b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.mdx new file mode 100644 index 0000000000..75ca660dc1 --- /dev/null +++ b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить уведомление + Удаляет уведомление по ID + + + +`Функция УдалитьУведомление(Знач URL, Знач IDУведомления, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDУведомления | --notif | Строка, Число | ID уведомления для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDУведомления = "18134"; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDУведомления = "18136"; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409863.31584, + "finish": 1728409863.36028, + "duration": 0.0444409847259522, + "processing": 0.016265869140625, + "date_start": "2024-10-08T20:51:03+03:00", + "date_finish": "2024-10-08T20:51:03+03:00", + "operating_reset_at": 1728410463, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md deleted file mode 100644 index 72aed42e9d..0000000000 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить ссылку авторизации приложения - Формирует ссылку для авторизации через браузер - - - -`Функция ПолучитьСсылкуАвторизацииПриложения(Знач Домен, Знач ClientID) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Домен | --domain | Строка | Адрес битрикс вида portal.bitrix24.com | - | ClientID | --clientid | Строка | Client ID из настроек приложения | - - - Возвращаемое значение: Строка - URL для перехода в браузере - -
- - - - -```bsl title="Пример кода" - Домен = "b24-ar17wx.bitrix24.by"; - ClientID = "local.6667fc928a50a9.70414732"; - - Результат = OPI_Bitrix24.ПолучитьСсылкуАвторизацииПриложения(Домен, ClientID); -``` - - - - -```json title="Результат" -"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" -``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.mdx b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.mdx new file mode 100644 index 0000000000..bfeb4ad7b0 --- /dev/null +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.mdx @@ -0,0 +1,40 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить ссылку авторизации приложения + Формирует ссылку для авторизации через браузер + + + +`Функция ПолучитьСсылкуАвторизацииПриложения(Знач Домен, Знач ClientID) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Домен | --domain | Строка | Адрес битрикс вида portal.bitrix24.com | + | ClientID | --clientid | Строка | Client ID из настроек приложения | + + + Возвращаемое значение: Строка - URL для перехода в браузере + +
+ + + + +```bsl title="Пример кода" + Домен = "b24-ar17wx.bitrix24.by"; + ClientID = "local.6667fc928a50a9.70414732"; + + Результат = OPI_Bitrix24.ПолучитьСсылкуАвторизацииПриложения(Домен, ClientID); +``` + + + + +```json title="Результат" +"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" +``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md deleted file mode 100644 index f94a73503b..0000000000 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить токен - Получает токен по коду авторизации - - - -`Функция ПолучитьТокен(Знач ClientID, Знач ClientSecret, Знач Code) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | ClientID | --clientid | Строка | Client ID из настроек приложения | - | ClientSecret | --clientsecret | Строка | Client secret из настроек приложения | - | Code | --code | Строка | Code из авторизации через браузер | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - ClientID = "local.6667fc928a50a9.70414732"; - ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; - Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; - - Результат = OPI_Bitrix24.ПолучитьТокен(ClientID, ClientSecret, Code); -``` - - - - -```json title="Результат" -{ - "error": "expired_token", - "error_description": "The authorization token provided has expired." -} -``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.mdx b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.mdx new file mode 100644 index 0000000000..6e95c06692 --- /dev/null +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить токен + Получает токен по коду авторизации + + + +`Функция ПолучитьТокен(Знач ClientID, Знач ClientSecret, Знач Code) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ClientID | --clientid | Строка | Client ID из настроек приложения | + | ClientSecret | --clientsecret | Строка | Client secret из настроек приложения | + | Code | --code | Строка | Code из авторизации через браузер | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ + + + +```bsl title="Пример кода" + ClientID = "local.6667fc928a50a9.70414732"; + ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; + Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; + + Результат = OPI_Bitrix24.ПолучитьТокен(ClientID, ClientSecret, Code); +``` + + + + +```json title="Результат" +{ + "error": "expired_token", + "error_description": "The authorization token provided has expired." +} +``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md deleted file mode 100644 index 31f9fb07eb..0000000000 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Обновить токен - Обновляет токен по Refresh токену - - - -`Функция ОбновитьТокен(Знач ClientID, Знач ClientSecret, Знач Refresh) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | ClientID | --clientid | Строка | Client ID из настроек приложения | - | ClientSecret | --clientsecret | Строка | Client secret из настроек приложения | - | Refresh | --refresh | Строка | Refresh токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - ClientID = "local.6667fc928a50a9.70414732"; - ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; - Refresh = "11f43167006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ОбновитьТокен(ClientID, ClientSecret, Refresh); -``` - - - - -```json title="Результат" -{ - "access_token": "717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2", - "expires": 1728413297, - "expires_in": 3600, - "scope": "app", - "domain": "oauth.bitrix.info", - "server_endpoint": "https://oauth.bitrix.info/rest/", - "status": "L", - "client_endpoint": "https://b24-ar17wx.bitrix24.by/rest/", - "member_id": "00168f0dd11ff00b4aeb8ce5befaa139", - "user_id": 1, - "refresh_token": "61fd2c67006e9f06006b12e4000000010000070914b54013c4e30eb73b4c6524c61989" -} -``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.mdx b/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.mdx new file mode 100644 index 0000000000..f2c2730c4f --- /dev/null +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.mdx @@ -0,0 +1,54 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Обновить токен + Обновляет токен по Refresh токену + + + +`Функция ОбновитьТокен(Знач ClientID, Знач ClientSecret, Знач Refresh) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ClientID | --clientid | Строка | Client ID из настроек приложения | + | ClientSecret | --clientsecret | Строка | Client secret из настроек приложения | + | Refresh | --refresh | Строка | Refresh токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ + + + +```bsl title="Пример кода" + ClientID = "local.6667fc928a50a9.70414732"; + ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; + Refresh = "11f43167006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ОбновитьТокен(ClientID, ClientSecret, Refresh); +``` + + + + +```json title="Результат" +{ + "access_token": "717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2", + "expires": 1728413297, + "expires_in": 3600, + "scope": "app", + "domain": "oauth.bitrix.info", + "server_endpoint": "https://oauth.bitrix.info/rest/", + "status": "L", + "client_endpoint": "https://b24-ar17wx.bitrix24.by/rest/", + "member_id": "00168f0dd11ff00b4aeb8ce5befaa139", + "user_id": 1, + "refresh_token": "61fd2c67006e9f06006b12e4000000010000070914b54013c4e30eb73b4c6524c61989" +} +``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md deleted file mode 100644 index 033db6ad79..0000000000 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Серверное время - Получает текущее серверное время - - - -`Функция СерверноеВремя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [server_time](https://dev.1c-bitrix.ru/rest_help/general/server_time.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СерверноеВремя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СерверноеВремя(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": "2024-10-08T20:48:19+03:00", - "time": { - "start": 1728409699.74915, - "finish": 1728409699.94481, - "duration": 0.19566011428833, - "processing": 0.0000319480895996094, - "date_start": "2024-10-08T20:48:19+03:00", - "date_finish": "2024-10-08T20:48:19+03:00", - "operating_reset_at": 1728410299, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.mdx b/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.mdx new file mode 100644 index 0000000000..deda87fbb2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Серверное время + Получает текущее серверное время + + + +`Функция СерверноеВремя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [server_time](https://dev.1c-bitrix.ru/rest_help/general/server_time.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СерверноеВремя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СерверноеВремя(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": "2024-10-08T20:48:19+03:00", + "time": { + "start": 1728409699.74915, + "finish": 1728409699.94481, + "duration": 0.19566011428833, + "processing": 0.0000319480895996094, + "date_start": "2024-10-08T20:48:19+03:00", + "date_finish": "2024-10-08T20:48:19+03:00", + "operating_reset_at": 1728410299, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md deleted file mode 100644 index a806bec1ff..0000000000 --- a/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Создать каталог в хранилище - Создает пустой каталог в хранилище - - - -`Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка | Идентификатор хранилища | - | Наименование | --title | Строка | Имя каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) -::: -
- - -```bsl title="Пример кода" - IDХранилища = 3; - Наименование = "Новый каталог"; - Наименование2 = "Новый каталог 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование2); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": 12462, - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 12462, - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-10-08T20:49:28+03:00", - "UPDATE_TIME": "2024-10-08T20:49:28+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1728409768.77754, - "finish": 1728409768.84057, - "duration": 0.0630321502685547, - "processing": 0.030372142791748, - "date_start": "2024-10-08T20:49:28+03:00", - "date_finish": "2024-10-08T20:49:28+03:00", - "operating_reset_at": 1728410368, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.mdx b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.mdx new file mode 100644 index 0000000000..94d8244cec --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Создать каталог в хранилище + Создает пустой каталог в хранилище + + + +`Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка | Идентификатор хранилища | + | Наименование | --title | Строка | Имя каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) +::: +
+ + +```bsl title="Пример кода" + IDХранилища = 3; + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование2); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": 12462, + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 12462, + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-10-08T20:49:28+03:00", + "UPDATE_TIME": "2024-10-08T20:49:28+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1728409768.77754, + "finish": 1728409768.84057, + "duration": 0.0630321502685547, + "processing": 0.030372142791748, + "date_start": "2024-10-08T20:49:28+03:00", + "date_finish": "2024-10-08T20:49:28+03:00", + "operating_reset_at": 1728410368, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md deleted file mode 100644 index c8542a7782..0000000000 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить хранилище приложения - Получает информацию о хранилище с которым может работать приложение для хранения своих данных - - - -`Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) -::: -
- - -```bsl title="Пример кода" - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "18", - "NAME": "New storage name", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1728409743.54306, - "finish": 1728409743.5729, - "duration": 0.0298421382904053, - "processing": 0.00386214256286621, - "date_start": "2024-10-08T20:49:03+03:00", - "date_finish": "2024-10-08T20:49:03+03:00", - "operating_reset_at": 1728410343, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.mdx b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.mdx new file mode 100644 index 0000000000..c76d9ab3b7 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить хранилище приложения + Получает информацию о хранилище с которым может работать приложение для хранения своих данных + + + +`Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) +::: +
+ + +```bsl title="Пример кода" + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1728409743.54306, + "finish": 1728409743.5729, + "duration": 0.0298421382904053, + "processing": 0.00386214256286621, + "date_start": "2024-10-08T20:49:03+03:00", + "date_finish": "2024-10-08T20:49:03+03:00", + "operating_reset_at": 1728410343, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md deleted file mode 100644 index ae92a9b6f6..0000000000 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить содержимое хранилища - Получает список файлов и каталогов, находящихся в корне хранилища - - - -`Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDХранилища = 3; - - Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "12454", - "NAME": "Картинка2.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8584", - "SIZE": "2114023", - "CREATE_TIME": "2024-10-08T20:49:06+03:00", - "UPDATE_TIME": "2024-10-08T20:49:06+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTQmXz13cDFHZ3VVa2swSXdEaVZaUTA5bm5weUFUOUUweDh1MQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFFtWHoxM2NERkhaM1ZWYTJzd1NYZEVhVlphVVRBNWJtNXdlVUZVT1VVd2VEaDFNUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.nYp1CIjeSiI5YNQDlYbJpHMmsF2YjJHNb1paDeyzHx8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка2.jpg" - }, - { - "ID": "12456", - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "8586", - "SIZE": "805189", - "CREATE_TIME": "2024-10-08T20:49:07+03:00", - "UPDATE_TIME": "2024-10-08T20:49:07+03:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1aVHBETW5qekN0UDBDUmM1VTVaUzZrVjZIelNPdDNwQQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxYVZIQkVUVzVxZWtOMFVEQkRVbU0xVlRWYVV6WnJWalpJZWxOUGRETndRUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.UslW%2Bs0zN%2Fskr0FM3NVEPJ5i2cHyrfQial9zoNq7Bls%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" - } - ], - "total": 2, - "time": { - "start": 1728409747.58537, - "finish": 1728409747.61628, - "duration": 0.0309140682220459, - "processing": 0.00680708885192871, - "date_start": "2024-10-08T20:49:07+03:00", - "date_finish": "2024-10-08T20:49:07+03:00", - "operating_reset_at": 1728410347, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.mdx b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.mdx new file mode 100644 index 0000000000..bb962bc8b3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.mdx @@ -0,0 +1,103 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить содержимое хранилища + Получает список файлов и каталогов, находящихся в корне хранилища + + + +`Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDХранилища = 3; + + Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "12454", + "NAME": "Картинка2.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8584", + "SIZE": "2114023", + "CREATE_TIME": "2024-10-08T20:49:06+03:00", + "UPDATE_TIME": "2024-10-08T20:49:06+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTQmXz13cDFHZ3VVa2swSXdEaVZaUTA5bm5weUFUOUUweDh1MQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFFtWHoxM2NERkhaM1ZWYTJzd1NYZEVhVlphVVRBNWJtNXdlVUZVT1VVd2VEaDFNUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.nYp1CIjeSiI5YNQDlYbJpHMmsF2YjJHNb1paDeyzHx8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка2.jpg" + }, + { + "ID": "12456", + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "8586", + "SIZE": "805189", + "CREATE_TIME": "2024-10-08T20:49:07+03:00", + "UPDATE_TIME": "2024-10-08T20:49:07+03:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=717e0567006e9f06006b12e400000001000007c2ebc8f80264531d4fc09a27052a7fe2&token=disk%7CaWQ9MTI0NTYmXz1aVHBETW5qekN0UDBDUmM1VTVaUzZrVjZIelNPdDNwQQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU1USTBOVFltWHoxYVZIQkVUVzVxZWtOMFVEQkRVbU0xVlRWYVV6WnJWalpJZWxOUGRETndRUT09fDcxN2UwNTY3MDA2ZTlmMDYwMDZiMTJlNDAwMDAwMDAxMDAwMDA3YzJlYmM4ZjgwMjY0NTMxZDRmYzA5YTI3MDUyYTdmZTIi.UslW%2Bs0zN%2Fskr0FM3NVEPJ5i2cHyrfQial9zoNq7Bls%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" + } + ], + "total": 2, + "time": { + "start": 1728409747.58537, + "finish": 1728409747.61628, + "duration": 0.0309140682220459, + "processing": 0.00680708885192871, + "date_start": "2024-10-08T20:49:07+03:00", + "date_finish": "2024-10-08T20:49:07+03:00", + "operating_reset_at": 1728410347, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md deleted file mode 100644 index 5941056e76..0000000000 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить хранилище - Получает информацию о хранилище по ID - - - -`Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDХранилища = 3; - - Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - "time": { - "start": 1728409743.81538, - "finish": 1728409743.84621, - "duration": 0.0308351516723633, - "processing": 0.0042569637298584, - "date_start": "2024-10-08T20:49:03+03:00", - "date_finish": "2024-10-08T20:49:03+03:00", - "operating_reset_at": 1728410343, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storage.mdx b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.mdx new file mode 100644 index 0000000000..cda8fef900 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить хранилище + Получает информацию о хранилище по ID + + + +`Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDХранилища = 3; + + Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + "time": { + "start": 1728409743.81538, + "finish": 1728409743.84621, + "duration": 0.0308351516723633, + "processing": 0.0042569637298584, + "date_start": "2024-10-08T20:49:03+03:00", + "date_finish": "2024-10-08T20:49:03+03:00", + "operating_reset_at": 1728410343, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md deleted file mode 100644 index 21346ccbd8..0000000000 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список хранилищ - Получает список доступных хранилищ файлов - - - -`Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "1", - "NAME": "Антон Титовец", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "1", - "ROOT_OBJECT_ID": "1" - }, - { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - { - "ID": "4", - "NAME": "Payment Processing Customer Support", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "4" - }, - { - "ID": "10", - "NAME": "CoPilot", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "4", - "ROOT_OBJECT_ID": "52" - }, - { - "ID": "12", - "NAME": "Поддержка Битрикс24", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "6", - "ROOT_OBJECT_ID": "70" - }, - { - "ID": "14", - "NAME": "Марта", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "8", - "ROOT_OBJECT_ID": "72" - }, - { - "ID": "16", - "NAME": "iscript13@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "10", - "ROOT_OBJECT_ID": "270" - }, - { - "ID": "20", - "NAME": "oarismos@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "12", - "ROOT_OBJECT_ID": "2810" - }, - { - "ID": "26", - "NAME": "yo@exepmple.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "18", - "ROOT_OBJECT_ID": "4602" - }, - { - "ID": "42", - "NAME": "f9535def-46c6-44af-950c-6f3f7767f5d2@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "34", - "ROOT_OBJECT_ID": "4618" - }, - { - "ID": "44", - "NAME": "Олег Лама", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "36", - "ROOT_OBJECT_ID": "4620" - }, - { - "ID": "46", - "NAME": "d95a9fe7-48e3-406c-ae52-62c4f4a55a10@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "38", - "ROOT_OBJECT_ID": "4622" - }, - { - "ID": "48", - "NAME": "Олег Лама", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "40", - "ROOT_OBJECT_ID": "4624" - }, - { - "ID": "50", - "NAME": "5565fd7a-6cbc-4e3b-ad9a-07ed12dc1c60@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "42", - "ROOT_OBJECT_ID": "4626" - }, - { - "ID": "52", - "NAME": "Олег Лама", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "44", - "ROOT_OBJECT_ID": "4628" - }, - { - "ID": "54", - "NAME": "6f72690f-e2b8-4437-87e5-38c1411dd757@exepmple.org", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "46", - "ROOT_OBJECT_ID": "4630" - }, - { - "ID": "56", - "NAME": "Олег Лама", - "CODE": null, -... -``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.mdx b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.mdx new file mode 100644 index 0000000000..8fa2cb24e1 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.mdx @@ -0,0 +1,196 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список хранилищ + Получает список доступных хранилищ файлов + + + +`Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "1", + "NAME": "Антон Титовец", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "1", + "ROOT_OBJECT_ID": "1" + }, + { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + { + "ID": "4", + "NAME": "Payment Processing Customer Support", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "4" + }, + { + "ID": "10", + "NAME": "CoPilot", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "4", + "ROOT_OBJECT_ID": "52" + }, + { + "ID": "12", + "NAME": "Поддержка Битрикс24", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "6", + "ROOT_OBJECT_ID": "70" + }, + { + "ID": "14", + "NAME": "Марта", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "8", + "ROOT_OBJECT_ID": "72" + }, + { + "ID": "16", + "NAME": "iscript13@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "10", + "ROOT_OBJECT_ID": "270" + }, + { + "ID": "20", + "NAME": "oarismos@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "12", + "ROOT_OBJECT_ID": "2810" + }, + { + "ID": "26", + "NAME": "yo@exepmple.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "18", + "ROOT_OBJECT_ID": "4602" + }, + { + "ID": "42", + "NAME": "f9535def-46c6-44af-950c-6f3f7767f5d2@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "34", + "ROOT_OBJECT_ID": "4618" + }, + { + "ID": "44", + "NAME": "Олег Лама", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "36", + "ROOT_OBJECT_ID": "4620" + }, + { + "ID": "46", + "NAME": "d95a9fe7-48e3-406c-ae52-62c4f4a55a10@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "38", + "ROOT_OBJECT_ID": "4622" + }, + { + "ID": "48", + "NAME": "Олег Лама", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "40", + "ROOT_OBJECT_ID": "4624" + }, + { + "ID": "50", + "NAME": "5565fd7a-6cbc-4e3b-ad9a-07ed12dc1c60@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "42", + "ROOT_OBJECT_ID": "4626" + }, + { + "ID": "52", + "NAME": "Олег Лама", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "44", + "ROOT_OBJECT_ID": "4628" + }, + { + "ID": "54", + "NAME": "6f72690f-e2b8-4437-87e5-38c1411dd757@exepmple.org", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "46", + "ROOT_OBJECT_ID": "4630" + }, + { + "ID": "56", + "NAME": "Олег Лама", + "CODE": null, +... +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md deleted file mode 100644 index 32872cafcf..0000000000 --- a/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Переименовать хранилище - Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) - - - -`Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Наименование | --title | Строка | Новое наименование хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новое имя хранилища"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDХранилища = "18"; - - Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "18", - "NAME": "Новое имя хранилища", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1728409743.63424, - "finish": 1728409743.67089, - "duration": 0.0366499423980713, - "processing": 0.00913906097412109, - "date_start": "2024-10-08T20:49:03+03:00", - "date_finish": "2024-10-08T20:49:03+03:00", - "operating_reset_at": 1728410343, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.mdx b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.mdx new file mode 100644 index 0000000000..0d2bb29b98 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Переименовать хранилище + Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) + + + +`Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Наименование | --title | Строка | Новое наименование хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя хранилища"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDХранилища = "18"; + + Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "18", + "NAME": "Новое имя хранилища", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1728409743.63424, + "finish": 1728409743.67089, + "duration": 0.0366499423980713, + "processing": 0.00913906097412109, + "date_start": "2024-10-08T20:49:03+03:00", + "date_finish": "2024-10-08T20:49:03+03:00", + "operating_reset_at": 1728410343, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md deleted file mode 100644 index 2833c2bd7f..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Добавить элемент чеклиста задачи - Добавляет новый элемент чеклиста задачи - - - -`Функция ДобавитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Выполнен = Ложь, Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Текст | --text | Строка | Текст (заголовок) пункта чек листа | - | Выполнен | --complete | Булево | Отметить пункт как выполненный | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Текст = "Пункт чек-листа"; - - Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, , Токен); -``` - - - - -```json title="Результат" -{ - "result": 1444, - "time": { - "start": 1728409731.33322, - "finish": 1728409731.39828, - "duration": 0.0650589466094971, - "processing": 0.0409841537475586, - "date_start": "2024-10-08T20:48:51+03:00", - "date_finish": "2024-10-08T20:48:51+03:00", - "operating_reset_at": 1728410331, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.mdx new file mode 100644 index 0000000000..bcdaf3b647 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Добавить элемент чеклиста задачи + Добавляет новый элемент чеклиста задачи + + + +`Функция ДобавитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Выполнен = Ложь, Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Текст | --text | Строка | Текст (заголовок) пункта чек листа | + | Выполнен | --complete | Булево | Отметить пункт как выполненный | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Текст = "Пункт чек-листа"; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, , Токен); +``` + + + + +```json title="Результат" +{ + "result": 1444, + "time": { + "start": 1728409731.33322, + "finish": 1728409731.39828, + "duration": 0.0650589466094971, + "processing": 0.0409841537475586, + "date_start": "2024-10-08T20:48:51+03:00", + "date_finish": "2024-10-08T20:48:51+03:00", + "operating_reset_at": 1728410331, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md deleted file mode 100644 index 74295eae3d..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Выполнить элемент чеклиста задачи - Помечает элемент чеклиста задачи как выполненный - - - -`Функция ВыполнитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDЭлемента = "1496"; - - Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "2448"; - IDЭлемента = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409732.20665, - "finish": 1728409732.26204, - "duration": 0.0553958415985107, - "processing": 0.0293397903442383, - "date_start": "2024-10-08T20:48:52+03:00", - "date_finish": "2024-10-08T20:48:52+03:00", - "operating_reset_at": 1728410332, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.mdx new file mode 100644 index 0000000000..87c43e2223 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Выполнить элемент чеклиста задачи + Помечает элемент чеклиста задачи как выполненный + + + +`Функция ВыполнитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDЭлемента = "1496"; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "2448"; + IDЭлемента = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409732.20665, + "finish": 1728409732.26204, + "duration": 0.0553958415985107, + "processing": 0.0293397903442383, + "date_start": "2024-10-08T20:48:52+03:00", + "date_finish": "2024-10-08T20:48:52+03:00", + "operating_reset_at": 1728410332, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md deleted file mode 100644 index 1735a24172..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить элемент чеклиста задачи - Удаляет элемент из чеклиста задачи - - - -`Функция УдалитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDЭлемента = "1496"; - - Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "2448"; - IDЭлемента = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409732.65437, - "finish": 1728409732.71569, - "duration": 0.0613141059875488, - "processing": 0.0355100631713867, - "date_start": "2024-10-08T20:48:52+03:00", - "date_finish": "2024-10-08T20:48:52+03:00", - "operating_reset_at": 1728410332, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.mdx new file mode 100644 index 0000000000..6829680080 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить элемент чеклиста задачи + Удаляет элемент из чеклиста задачи + + + +`Функция УдалитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDЭлемента = "1496"; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "2448"; + IDЭлемента = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409732.65437, + "finish": 1728409732.71569, + "duration": 0.0613141059875488, + "processing": 0.0355100631713867, + "date_start": "2024-10-08T20:48:52+03:00", + "date_finish": "2024-10-08T20:48:52+03:00", + "operating_reset_at": 1728410332, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md deleted file mode 100644 index 8a5b80931e..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить элемент чеклиста задачи - Получить элемент чеклиста задачи по ID - - - -`Функция ПолучитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента для получения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDЭлемента = "1496"; - - Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "2448"; - IDЭлемента = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "1444", - "TASK_ID": "2378", - "PARENT_ID": "1442", - "CREATED_BY": "1", - "TITLE": "Новый текст пункта чек-листа", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - "time": { - "start": 1728409731.99901, - "finish": 1728409732.05083, - "duration": 0.051814079284668, - "processing": 0.0249829292297363, - "date_start": "2024-10-08T20:48:51+03:00", - "date_finish": "2024-10-08T20:48:52+03:00", - "operating_reset_at": 1728410332, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.mdx new file mode 100644 index 0000000000..6b86607381 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить элемент чеклиста задачи + Получить элемент чеклиста задачи по ID + + + +`Функция ПолучитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDЭлемента = "1496"; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "2448"; + IDЭлемента = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "1444", + "TASK_ID": "2378", + "PARENT_ID": "1442", + "CREATED_BY": "1", + "TITLE": "Новый текст пункта чек-листа", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + "time": { + "start": 1728409731.99901, + "finish": 1728409732.05083, + "duration": 0.051814079284668, + "processing": 0.0249829292297363, + "date_start": "2024-10-08T20:48:51+03:00", + "date_finish": "2024-10-08T20:48:52+03:00", + "operating_reset_at": 1728410332, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md deleted file mode 100644 index c828f2a7ea..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить чеклист задачи - Получает список элементов чеклиста задачи - - - -`Функция ПолучитьЧеклистЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "1442", - "TASK_ID": "2378", - "PARENT_ID": 0, - "CREATED_BY": "1", - "TITLE": "BX_CHECKLIST_1", - "SORT_INDEX": "0", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - { - "ID": "1444", - "TASK_ID": "2378", - "PARENT_ID": "1442", - "CREATED_BY": "1", - "TITLE": "Новый текст пункта чек-листа", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - } - ], - "time": { - "start": 1728409731.79594, - "finish": 1728409731.84521, - "duration": 0.0492649078369141, - "processing": 0.0217220783233643, - "date_start": "2024-10-08T20:48:51+03:00", - "date_finish": "2024-10-08T20:48:51+03:00", - "operating_reset_at": 1728410331, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.mdx new file mode 100644 index 0000000000..66a8e2995b --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.mdx @@ -0,0 +1,91 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить чеклист задачи + Получает список элементов чеклиста задачи + + + +`Функция ПолучитьЧеклистЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "1442", + "TASK_ID": "2378", + "PARENT_ID": 0, + "CREATED_BY": "1", + "TITLE": "BX_CHECKLIST_1", + "SORT_INDEX": "0", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + { + "ID": "1444", + "TASK_ID": "2378", + "PARENT_ID": "1442", + "CREATED_BY": "1", + "TITLE": "Новый текст пункта чек-листа", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + } + ], + "time": { + "start": 1728409731.79594, + "finish": 1728409731.84521, + "duration": 0.0492649078369141, + "processing": 0.0217220783233643, + "date_start": "2024-10-08T20:48:51+03:00", + "date_finish": "2024-10-08T20:48:51+03:00", + "operating_reset_at": 1728410331, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md deleted file mode 100644 index 05ecb5693a..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Возобновить элемент чеклиста задачи - Снимает пометку элемента как выполненного - - - -`Функция ВозобновитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDЭлемента = "1496"; - - Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "2448"; - IDЭлемента = "1500"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409732.42239, - "finish": 1728409732.47585, - "duration": 0.0534610748291016, - "processing": 0.0276179313659668, - "date_start": "2024-10-08T20:48:52+03:00", - "date_finish": "2024-10-08T20:48:52+03:00", - "operating_reset_at": 1728410332, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.mdx new file mode 100644 index 0000000000..94bc9b03c8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Возобновить элемент чеклиста задачи + Снимает пометку элемента как выполненного + + + +`Функция ВозобновитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDЭлемента = "1496"; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "2448"; + IDЭлемента = "1500"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409732.42239, + "finish": 1728409732.47585, + "duration": 0.0534610748291016, + "processing": 0.0276179313659668, + "date_start": "2024-10-08T20:48:52+03:00", + "date_finish": "2024-10-08T20:48:52+03:00", + "operating_reset_at": 1728410332, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md deleted file mode 100644 index a46331a16e..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить элемент чеклиста задачи - Изменяет текст элемента чеклиста задачи - - - -`Функция ИзменитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента чеклиста | - | Текст | --text | Строка | Текст (заголовок) пункта чек листа | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDЭлемента = "1496"; - - Текст = "Новый текст пункта чек-листа"; - - Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - IDЭлемента = "1500"; - - Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст, Токен); -``` - - - - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1728409731.55086, - "finish": 1728409731.60578, - "duration": 0.0549211502075195, - "processing": 0.0286209583282471, - "date_start": "2024-10-08T20:48:51+03:00", - "date_finish": "2024-10-08T20:48:51+03:00", - "operating_reset_at": 1728410331, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.mdx b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.mdx new file mode 100644 index 0000000000..109e7b7064 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить элемент чеклиста задачи + Изменяет текст элемента чеклиста задачи + + + +`Функция ИзменитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента чеклиста | + | Текст | --text | Строка | Текст (заголовок) пункта чек листа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDЭлемента = "1496"; + + Текст = "Новый текст пункта чек-листа"; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + IDЭлемента = "1500"; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст, Токен); +``` + + + + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1728409731.55086, + "finish": 1728409731.60578, + "duration": 0.0549211502075195, + "processing": 0.0286209583282471, + "date_start": "2024-10-08T20:48:51+03:00", + "date_finish": "2024-10-08T20:48:51+03:00", + "operating_reset_at": 1728410331, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md b/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md deleted file mode 100644 index d7f29ab40d..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 17 ---- - -# Добавить задачу в избранное - Добавляет задачу в список избранного - - - -`Функция ДобавитьЗадачуВИзбранное(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.favorite.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ДобавитьЗадачуВИзбранное(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ДобавитьЗадачуВИзбранное(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409723.23986, - "finish": 1728409723.29084, - "duration": 0.0509860515594482, - "processing": 0.0091090202331543, - "date_start": "2024-10-08T20:48:43+03:00", - "date_finish": "2024-10-08T20:48:43+03:00", - "operating_reset_at": 1728410323, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.mdx new file mode 100644 index 0000000000..9f51bfd3ca --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 17 +--- + +# Добавить задачу в избранное + Добавляет задачу в список избранного + + + +`Функция ДобавитьЗадачуВИзбранное(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.favorite.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ДобавитьЗадачуВИзбранное(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ДобавитьЗадачуВИзбранное(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409723.23986, + "finish": 1728409723.29084, + "duration": 0.0509860515594482, + "processing": 0.0091090202331543, + "date_start": "2024-10-08T20:48:43+03:00", + "date_finish": "2024-10-08T20:48:43+03:00", + "operating_reset_at": 1728410323, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md deleted file mode 100644 index e9c680e537..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Принять задачу - Принимает задачу по ID - - - -`Функция ПринятьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.approve](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_approve.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПринятьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПринятьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "descriptionInBbcode": "Y", - "declineReason": "", - "priority": "1", - "notViewed": "N", - "statusComplete": "2", - "multitask": "N", - "stageId": "0", - "responsibleId": "594", - "responsibleName": "Oleg", - "responsibleLastName": "Lama", - "responsibleSecondName": null, - "responsibleLogin": "584b160c-03dc-4548-a898-282d95334643@exepmple.org", - "responsibleWorkPosition": null, - "responsiblePhoto": null, - "dateStart": null, - "durationFact": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "replicate": "N", - "deadline": "2024-10-09T23:48:00+03:00", - "deadlineOrig": "09.10.2024 23:48:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "createdBy": "1", - "createdByName": "Антон", - "createdByLastName": "Титовец", - "createdBySecondName": null, - "createdByLogin": "VKuser657846756", - "createdByWorkPosition": null, - "createdByPhoto": "30", - "createdDate": "2024-10-08T20:48:35+03:00", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:45+03:00", - "statusChangedBy": "1", - "closedBy": "1", - "closedDate": "2024-10-08T20:48:45+03:00", - "activityDate": "2024-10-08T20:48:45+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "mark": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "matchWorkTime": "N", - "taskControl": "N", - "addInReport": "N", - "forumTopicId": "1652", - "parentId": null, - "commentsCount": "2", - "serviceCommentsCount": "2", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "6", - "viewedDate": "2024-10-08T20:48:45+03:00", - "deadlineCounted": "0", - "forkedByTemplateId": null, - "sorting": null, - "durationPlanSeconds": null, - "durationTypeAll": "days", - "scenarioName": [ - "default" - ], - "isRegular": "N", - "flowId": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "ufCrmTask": false, - "ufTaskWebdavFiles": false, - "ufMailMessage": null, - "status": "5", - "statusChangedDate": "2024-10-08T20:48:45+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "tags": [], - "checklist": [], - "files": [], - "dependsOn": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": false, - "approve": false, - "disapprove": false, - "start": false, - "pause": false, - "delegate": false, - "remove": true, - "edit": true, - "defer": false, - "renew": true, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, -... -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.mdx new file mode 100644 index 0000000000..3f6f2392df --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Принять задачу + Принимает задачу по ID + + + +`Функция ПринятьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.approve](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_approve.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПринятьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПринятьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "descriptionInBbcode": "Y", + "declineReason": "", + "priority": "1", + "notViewed": "N", + "statusComplete": "2", + "multitask": "N", + "stageId": "0", + "responsibleId": "594", + "responsibleName": "Oleg", + "responsibleLastName": "Lama", + "responsibleSecondName": null, + "responsibleLogin": "584b160c-03dc-4548-a898-282d95334643@exepmple.org", + "responsibleWorkPosition": null, + "responsiblePhoto": null, + "dateStart": null, + "durationFact": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "replicate": "N", + "deadline": "2024-10-09T23:48:00+03:00", + "deadlineOrig": "09.10.2024 23:48:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "createdBy": "1", + "createdByName": "Антон", + "createdByLastName": "Титовец", + "createdBySecondName": null, + "createdByLogin": "VKuser657846756", + "createdByWorkPosition": null, + "createdByPhoto": "30", + "createdDate": "2024-10-08T20:48:35+03:00", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:45+03:00", + "statusChangedBy": "1", + "closedBy": "1", + "closedDate": "2024-10-08T20:48:45+03:00", + "activityDate": "2024-10-08T20:48:45+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "mark": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "matchWorkTime": "N", + "taskControl": "N", + "addInReport": "N", + "forumTopicId": "1652", + "parentId": null, + "commentsCount": "2", + "serviceCommentsCount": "2", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "6", + "viewedDate": "2024-10-08T20:48:45+03:00", + "deadlineCounted": "0", + "forkedByTemplateId": null, + "sorting": null, + "durationPlanSeconds": null, + "durationTypeAll": "days", + "scenarioName": [ + "default" + ], + "isRegular": "N", + "flowId": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "ufCrmTask": false, + "ufTaskWebdavFiles": false, + "ufMailMessage": null, + "status": "5", + "statusChangedDate": "2024-10-08T20:48:45+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "tags": [], + "checklist": [], + "files": [], + "dependsOn": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": false, + "approve": false, + "disapprove": false, + "start": false, + "pause": false, + "delegate": false, + "remove": true, + "edit": true, + "defer": false, + "renew": true, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, +... +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md deleted file mode 100644 index 6cc75098e7..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Добавить файл в задачу - Прикрепляет файл к выбранной задаче - - - -`Функция ДобавитьФайлВЗадачу(Знач URL, Знач IDЗадачи, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDФайла | --fileid | Число, Строка | ID Файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDФайла = "12872"; - - Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "attachmentId": 3574 - }, - "time": { - "start": 1728409735.33635, - "finish": 1728409735.39912, - "duration": 0.0627679824829102, - "processing": 0.0372891426086426, - "date_start": "2024-10-08T20:48:55+03:00", - "date_finish": "2024-10-08T20:48:55+03:00", - "operating_reset_at": 1728410335, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.mdx new file mode 100644 index 0000000000..99b1894be1 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Добавить файл в задачу + Прикрепляет файл к выбранной задаче + + + +`Функция ДобавитьФайлВЗадачу(Знач URL, Знач IDЗадачи, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDФайла | --fileid | Число, Строка | ID Файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDФайла = "12872"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "attachmentId": 3574 + }, + "time": { + "start": 1728409735.33635, + "finish": 1728409735.39912, + "duration": 0.0627679824829102, + "processing": 0.0372891426086426, + "date_start": "2024-10-08T20:48:55+03:00", + "date_finish": "2024-10-08T20:48:55+03:00", + "operating_reset_at": 1728410335, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md deleted file mode 100644 index 15f3c4c675..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Проверить доступ к задаче - Проверяет доступность задачи для пользователей - - - -`Функция ПроверитьДоступКЗадаче(Знач URL, Знач IDЗадачи, Знач Пользователи = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Пользователи | --users | Массив из Строка | ID пользователей для проверки доступа | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) -::: -
- - -```bsl title="Пример кода" - МассивПользователей = Новый Массив; - МассивПользователей.Добавить("1"); - МассивПользователей.Добавить("10"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "allowedActions": { - "1": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": true, - "APPROVE": false, - "DISAPPROVE": false, - "START": true, - "PAUSE": false, - "DELEGATE": true, - "REMOVE": true, - "EDIT": true, - "DEFER": true, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": true, - "CHECKLIST_ADD_ITEMS": true, - "ADD_FAVORITE": true, - "DELETE_FAVORITE": false, - "RATE": true, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": true, - "ELAPSEDTIME.ADD": true, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": true, - "CHECKLIST.ADD": true, - "FAVORITE.ADD": true, - "FAVORITE.DELETE": false - }, - "10": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": false, - "APPROVE": false, - "DISAPPROVE": false, - "START": false, - "PAUSE": false, - "DELEGATE": false, - "REMOVE": false, - "EDIT": false, - "DEFER": false, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": false, - "CHECKLIST_ADD_ITEMS": false, - "ADD_FAVORITE": false, - "DELETE_FAVORITE": false, - "RATE": false, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": false, - "ELAPSEDTIME.ADD": false, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": false, - "CHECKLIST.ADD": false, - "FAVORITE.ADD": false, - "FAVORITE.DELETE": false - } - } - }, - "time": { - "start": 1728409731.09459, - "finish": 1728409731.14691, - "duration": 0.052325963973999, - "processing": 0.0272109508514404, - "date_start": "2024-10-08T20:48:51+03:00", - "date_finish": "2024-10-08T20:48:51+03:00", - "operating_reset_at": 1728410331, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.mdx new file mode 100644 index 0000000000..84d26b5976 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.mdx @@ -0,0 +1,126 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 20 +--- + +# Проверить доступ к задаче + Проверяет доступность задачи для пользователей + + + +`Функция ПроверитьДоступКЗадаче(Знач URL, Знач IDЗадачи, Знач Пользователи = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Пользователи | --users | Массив из Строка | ID пользователей для проверки доступа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) +::: +
+ + +```bsl title="Пример кода" + МассивПользователей = Новый Массив; + МассивПользователей.Добавить("1"); + МассивПользователей.Добавить("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "allowedActions": { + "1": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": true, + "APPROVE": false, + "DISAPPROVE": false, + "START": true, + "PAUSE": false, + "DELEGATE": true, + "REMOVE": true, + "EDIT": true, + "DEFER": true, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": true, + "CHECKLIST_ADD_ITEMS": true, + "ADD_FAVORITE": true, + "DELETE_FAVORITE": false, + "RATE": true, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": true, + "ELAPSEDTIME.ADD": true, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": true, + "CHECKLIST.ADD": true, + "FAVORITE.ADD": true, + "FAVORITE.DELETE": false + }, + "10": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": false, + "APPROVE": false, + "DISAPPROVE": false, + "START": false, + "PAUSE": false, + "DELEGATE": false, + "REMOVE": false, + "EDIT": false, + "DEFER": false, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": false, + "CHECKLIST_ADD_ITEMS": false, + "ADD_FAVORITE": false, + "DELETE_FAVORITE": false, + "RATE": false, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": false, + "ELAPSEDTIME.ADD": false, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": false, + "CHECKLIST.ADD": false, + "FAVORITE.ADD": false, + "FAVORITE.DELETE": false + } + } + }, + "time": { + "start": 1728409731.09459, + "finish": 1728409731.14691, + "duration": 0.052325963973999, + "processing": 0.0272109508514404, + "date_start": "2024-10-08T20:48:51+03:00", + "date_finish": "2024-10-08T20:48:51+03:00", + "operating_reset_at": 1728410331, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md deleted file mode 100644 index 8406bc36d2..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Завершить задачу - Завершает задачу по ID - - - -`Функция ЗавершитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_complete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ЗавершитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ЗавершитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:45+03:00", - "statusChangedBy": "1", - "closedBy": "1", - "closedDate": "2024-10-08T20:48:45+03:00", - "activityDate": "2024-10-08T20:48:45+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "2", - "serviceCommentsCount": "2", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "6", - "viewedDate": "2024-10-08T20:48:45+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "5", - "statusChangedDate": "2024-10-08T20:48:45+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": false, - "approve": false, - "disapprove": false, - "start": false, - "pause": false, - "delegate": false, - "remove": true, - "edit": true, - "defer": false, - "renew": true, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409725.56009, - "finish": 1728409725.94625, - "duration": 0.386157989501953, - "processing": 0.35835599899292, - "date_start": "2024-10-08T20:48:45+03:00", - "date_finish": "2024-10-08T20:48:45+03:00", - "operating_reset_at": 1728410325, - "operating": 0.358325958251953 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.mdx new file mode 100644 index 0000000000..c27edb7184 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Завершить задачу + Завершает задачу по ID + + + +`Функция ЗавершитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_complete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ЗавершитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ЗавершитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:45+03:00", + "statusChangedBy": "1", + "closedBy": "1", + "closedDate": "2024-10-08T20:48:45+03:00", + "activityDate": "2024-10-08T20:48:45+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "2", + "serviceCommentsCount": "2", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "6", + "viewedDate": "2024-10-08T20:48:45+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "5", + "statusChangedDate": "2024-10-08T20:48:45+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": false, + "approve": false, + "disapprove": false, + "start": false, + "pause": false, + "delegate": false, + "remove": true, + "edit": true, + "defer": false, + "renew": true, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409725.56009, + "finish": 1728409725.94625, + "duration": 0.386157989501953, + "processing": 0.35835599899292, + "date_start": "2024-10-08T20:48:45+03:00", + "date_finish": "2024-10-08T20:48:45+03:00", + "operating_reset_at": 1728410325, + "operating": 0.358325958251953 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md deleted file mode 100644 index 9a23ecdf3f..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать задачу - Создает новую задачу по структуре полей (см. ПолучитьСтруктуруЗадачи) - - - -`Функция СоздатьЗадачу(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей задачи (см. ПолучитьСтруктуруЗадачи) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_add.php) -::: -
- - -```bsl title="Пример кода" - // Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи() - - ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); - Час = 3600; - Сутки = 24; - Исполнитель = 1; - - СтруктураЗадачи = Новый Структура; - СтруктураЗадачи.Вставить("TITLE" , "Новая задача"); - СтруктураЗадачи.Вставить("DESCRIPTION" , "Новое описание задачи"); - СтруктураЗадачи.Вставить("PRIORITY" , "2"); - СтруктураЗадачи.Вставить("DEADLINE" , ТекущаяДата + Час * Сутки); - СтруктураЗадачи.Вставить("RESPONSIBLE_ID", Исполнитель); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьЗадачу(URL, СтруктураЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьЗадачу(URL, СтруктураЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Новая задача", - "description": "Новое описание задачи", - "mark": null, - "priority": "2", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:35+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-08T20:48:35+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "1", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:35+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409715.35686, - "finish": 1728409715.50661, - "duration": 0.149749994277954, - "processing": 0.121814012527466, - "date_start": "2024-10-08T20:48:35+03:00", - "date_finish": "2024-10-08T20:48:35+03:00", - "operating_reset_at": 1728410315, - "operating": 0.121784925460815 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.mdx new file mode 100644 index 0000000000..d94279b577 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.mdx @@ -0,0 +1,204 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать задачу + Создает новую задачу по структуре полей (см. ПолучитьСтруктуруЗадачи) + + + +`Функция СоздатьЗадачу(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей задачи (см. ПолучитьСтруктуруЗадачи) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_add.php) +::: +
+ + +```bsl title="Пример кода" + // Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи() + + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + Час = 3600; + Сутки = 24; + Исполнитель = 1; + + СтруктураЗадачи = Новый Структура; + СтруктураЗадачи.Вставить("TITLE" , "Новая задача"); + СтруктураЗадачи.Вставить("DESCRIPTION" , "Новое описание задачи"); + СтруктураЗадачи.Вставить("PRIORITY" , "2"); + СтруктураЗадачи.Вставить("DEADLINE" , ТекущаяДата + Час * Сутки); + СтруктураЗадачи.Вставить("RESPONSIBLE_ID", Исполнитель); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьЗадачу(URL, СтруктураЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьЗадачу(URL, СтруктураЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Новая задача", + "description": "Новое описание задачи", + "mark": null, + "priority": "2", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:35+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-08T20:48:35+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "1", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:35+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409715.35686, + "finish": 1728409715.50661, + "duration": 0.149749994277954, + "processing": 0.121814012527466, + "date_start": "2024-10-08T20:48:35+03:00", + "date_finish": "2024-10-08T20:48:35+03:00", + "operating_reset_at": 1728410315, + "operating": 0.121784925460815 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md deleted file mode 100644 index 9e353ddbc6..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 23 ---- - -# Создать зависимость задач - Создает зависимость одной задачи от другой - - - -`Функция СоздатьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | - | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | - | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) -::: -
- - -```bsl title="Пример кода" - IDИсточника = "2446"; - IDПриемника = "2448"; - ТипСвязи = 0; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); - - IDИсточника = "2448"; - IDПриемника = "2446"; - ТипСвязи = 2; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); -``` - - - - -```json title="Результат" -{ - "result": [], - "time": { - "start": 1728409721.19468, - "finish": 1728409721.28053, - "duration": 0.0858538150787354, - "processing": 0.0514581203460693, - "date_start": "2024-10-08T20:48:41+03:00", - "date_finish": "2024-10-08T20:48:41+03:00", - "operating_reset_at": 1728410321, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.mdx new file mode 100644 index 0000000000..71d23962ec --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 23 +--- + +# Создать зависимость задач + Создает зависимость одной задачи от другой + + + +`Функция СоздатьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | + | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | + | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) +::: +
+ + +```bsl title="Пример кода" + IDИсточника = "2446"; + IDПриемника = "2448"; + ТипСвязи = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); + + IDИсточника = "2448"; + IDПриемника = "2446"; + ТипСвязи = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); +``` + + + + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1728409721.19468, + "finish": 1728409721.28053, + "duration": 0.0858538150787354, + "processing": 0.0514581203460693, + "date_start": "2024-10-08T20:48:41+03:00", + "date_finish": "2024-10-08T20:48:41+03:00", + "operating_reset_at": 1728410321, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md deleted file mode 100644 index a84b1c69ca..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Отложить задачу - Откладывает задачу по ID - - - -`Функция ОтложитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.defer](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_defer.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ОтложитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ОтложитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:44+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-08T20:48:44+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "1", - "serviceCommentsCount": "1", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "5", - "viewedDate": "2024-10-08T20:48:44+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "6", - "statusChangedDate": "2024-10-08T20:48:44+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": true, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409724.86505, - "finish": 1728409725.08507, - "duration": 0.220017194747925, - "processing": 0.193571090698242, - "date_start": "2024-10-08T20:48:44+03:00", - "date_finish": "2024-10-08T20:48:45+03:00", - "operating_reset_at": 1728410324, - "operating": 0.193549871444702 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.mdx new file mode 100644 index 0000000000..ed7d1abe88 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Отложить задачу + Откладывает задачу по ID + + + +`Функция ОтложитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.defer](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_defer.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ОтложитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ОтложитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:44+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-08T20:48:44+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "1", + "serviceCommentsCount": "1", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "5", + "viewedDate": "2024-10-08T20:48:44+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "6", + "statusChangedDate": "2024-10-08T20:48:44+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": true, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409724.86505, + "finish": 1728409725.08507, + "duration": 0.220017194747925, + "processing": 0.193571090698242, + "date_start": "2024-10-08T20:48:44+03:00", + "date_finish": "2024-10-08T20:48:45+03:00", + "operating_reset_at": 1728410324, + "operating": 0.193549871444702 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md deleted file mode 100644 index 7bb4521c88..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -sidebar_position: 16 ---- - -# Делегировать задачу - Делегирует задачу на другого пользователя - - - -`Функция ДелегироватьЗадачу(Знач URL, Знач IDЗадачи, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | IDПользователя | --user | Число,Строка | ID пользователя исполнителя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.delegate](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delegate.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - IDПользователя = "626"; - - Результат = OPI_Bitrix24.ДелегироватьЗадачу(URL, IDЗадачи, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ДелегироватьЗадачу(URL, IDЗадачи, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:44+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-08T20:48:44+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "1", - "serviceCommentsCount": "1", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "4", - "viewedDate": "2024-10-08T20:48:44+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:44+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409724.02098, - "finish": 1728409724.5298, - "duration": 0.508816003799438, - "processing": 0.481902122497559, - "date_start": "2024-10-08T20:48:44+03:00", - "date_finish": "2024-10-08T20:48:44+03:00", - "operating_reset_at": 1728410324, - "operating": 0.481879949569702 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.mdx new file mode 100644 index 0000000000..bfff76ac65 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.mdx @@ -0,0 +1,194 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 16 +--- + +# Делегировать задачу + Делегирует задачу на другого пользователя + + + +`Функция ДелегироватьЗадачу(Знач URL, Знач IDЗадачи, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | IDПользователя | --user | Число,Строка | ID пользователя исполнителя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.delegate](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delegate.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + IDПользователя = "626"; + + Результат = OPI_Bitrix24.ДелегироватьЗадачу(URL, IDЗадачи, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ДелегироватьЗадачу(URL, IDЗадачи, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:44+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-08T20:48:44+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "1", + "serviceCommentsCount": "1", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "4", + "viewedDate": "2024-10-08T20:48:44+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:44+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409724.02098, + "finish": 1728409724.5298, + "duration": 0.508816003799438, + "processing": 0.481902122497559, + "date_start": "2024-10-08T20:48:44+03:00", + "date_finish": "2024-10-08T20:48:44+03:00", + "operating_reset_at": 1728410324, + "operating": 0.481879949569702 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md deleted file mode 100644 index 231f85cd5f..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить задачу - Удаляет задачу по ID - - - -`Функция УдалитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.УдалитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.УдалитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": true - }, - "time": { - "start": 1728409735.94584, - "finish": 1728409736.14546, - "duration": 0.19961404800415, - "processing": 0.17368483543396, - "date_start": "2024-10-08T20:48:55+03:00", - "date_finish": "2024-10-08T20:48:56+03:00", - "operating_reset_at": 1728410335, - "operating": 0.173669099807739 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.mdx new file mode 100644 index 0000000000..629e0dc122 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить задачу + Удаляет задачу по ID + + + +`Функция УдалитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.УдалитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.УдалитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": true + }, + "time": { + "start": 1728409735.94584, + "finish": 1728409736.14546, + "duration": 0.19961404800415, + "processing": 0.17368483543396, + "date_start": "2024-10-08T20:48:55+03:00", + "date_finish": "2024-10-08T20:48:56+03:00", + "operating_reset_at": 1728410335, + "operating": 0.173669099807739 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md deleted file mode 100644 index 95c2683c3a..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 24 ---- - -# Удалить зависимость задач - Удаляет зависимость одной задачи от другой - - - -`Функция УдалитьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | - | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | - | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) -::: -
- - -```bsl title="Пример кода" - IDИсточника = "2446"; - IDПриемника = "2448"; - ТипСвязи = 0; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.УдалитьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); - - IDИсточника = "2448"; - IDПриемника = "2446"; - ТипСвязи = 2; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.УдалитьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); -``` - - - - -```json title="Результат" -{ - "result": [], - "time": { - "start": 1728409721.77045, - "finish": 1728409721.80527, - "duration": 0.034818172454834, - "processing": 0.00769495964050293, - "date_start": "2024-10-08T20:48:41+03:00", - "date_finish": "2024-10-08T20:48:41+03:00", - "operating_reset_at": 1728410321, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.mdx new file mode 100644 index 0000000000..9b3f6ba42a --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 24 +--- + +# Удалить зависимость задач + Удаляет зависимость одной задачи от другой + + + +`Функция УдалитьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | + | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | + | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) +::: +
+ + +```bsl title="Пример кода" + IDИсточника = "2446"; + IDПриемника = "2448"; + ТипСвязи = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.УдалитьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); + + IDИсточника = "2448"; + IDПриемника = "2446"; + ТипСвязи = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); +``` + + + + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1728409721.77045, + "finish": 1728409721.80527, + "duration": 0.034818172454834, + "processing": 0.00769495964050293, + "date_start": "2024-10-08T20:48:41+03:00", + "date_finish": "2024-10-08T20:48:41+03:00", + "operating_reset_at": 1728410321, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md deleted file mode 100644 index 6e597e984d..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Отклонить задачу - Отклоняет задачу по ID - - - -`Функция ОтклонитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.disapprove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_disapprove.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ОтклонитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ОтклонитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "error": 1048582, - "error_description": "Действие над задачей не разрешено" -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.mdx new file mode 100644 index 0000000000..39181138df --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Отклонить задачу + Отклоняет задачу по ID + + + +`Функция ОтклонитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.disapprove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_disapprove.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ОтклонитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ОтклонитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "error": 1048582, + "error_description": "Действие над задачей не разрешено" +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md deleted file mode 100644 index 9c25c34c11..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 25 ---- - -# Получить план задач на день - Получает план задач на день текущего пользователя - - - -`Функция ПолучитьПланЗадачНаДень(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": [], - "time": { - "start": 1728409732.84496, - "finish": 1728409732.86991, - "duration": 0.0249559879302978, - "processing": 0.000316143035888672, - "date_start": "2024-10-08T20:48:52+03:00", - "date_finish": "2024-10-08T20:48:52+03:00", - "operating_reset_at": 1728410332, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.mdx new file mode 100644 index 0000000000..ba26921cdc --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 25 +--- + +# Получить план задач на день + Получает план задач на день текущего пользователя + + + +`Функция ПолучитьПланЗадачНаДень(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1728409732.84496, + "finish": 1728409732.86991, + "duration": 0.0249559879302978, + "processing": 0.000316143035888672, + "date_start": "2024-10-08T20:48:52+03:00", + "date_finish": "2024-10-08T20:48:52+03:00", + "operating_reset_at": 1728410332, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md deleted file mode 100644 index fabe447c4f..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_position: 26 ---- - -# Получить структуру задачи - Получает структуру с описанем полей для создания задачи - - - -`Функция ПолучитьСтруктуруЗадачи(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруЗадачи(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруЗадачи(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "fields": { - "ID": { - "title": "ID", - "type": "integer", - "primary": true - }, - "PARENT_ID": { - "title": "ID базовой задачи", - "type": "integer", - "default": 0 - }, - "TITLE": { - "title": "Название", - "type": "string", - "required": true - }, - "DESCRIPTION": { - "title": "Описание", - "type": "string" - }, - "MARK": { - "title": "Оценка", - "type": "enum", - "values": { - "N": "Отрицательная", - "P": "Положительная" - }, - "default": null - }, - "PRIORITY": { - "title": "Приоритет", - "type": "enum", - "values": { - "2": "Высокий", - "1": "Средний", - "0": "Низкий" - }, - "default": 1 - }, - "STATUS": { - "title": "Статус", - "type": "enum", - "values": { - "2": "Ждёт выполнения", - "3": "Выполняется", - "4": "Ожидает контроля", - "5": "Завершена", - "6": "Отложена" - }, - "default": 2 - }, - "MULTITASK": { - "title": "Множественная задача", - "type": "enum", - "values": { - "Y": "Да", - "N": "Нет" - }, - "default": "N" - }, - "NOT_VIEWED": { - "title": null, - "type": "enum", - "values": { - "Y": "Да", - "N": "Нет" - }, - "default": "N" - }, - "REPLICATE": { - "title": "Повторяемая задача", - "type": "enum", - "values": { - "Y": "Да", - "N": "Нет" - }, - "default": "N" - }, - "GROUP_ID": { - "title": "Проект", - "type": "integer", - "default": 0 - }, - "STAGE_ID": { - "title": "Стадия", - "type": "integer", - "default": 0 - }, - "CREATED_BY": { - "title": "Постановщик", - "type": "integer", - "required": true - }, - "CREATED_DATE": { - "title": null, - "type": "datetime" - }, - "RESPONSIBLE_ID": { - "title": "Исполнитель", - "type": "integer", - "required": true - }, - "ACCOMPLICES": { - "title": null, - "type": "array" - }, - "AUDITORS": { - "title": null, - "type": "array" - }, - "CHANGED_BY": { - "title": "Изменил", - "type": "integer" - }, - "CHANGED_DATE": { - "title": "Дата изменения", - "type": "datetime" - }, - "STATUS_CHANGED_BY": { - "title": "Изменил статус", - "type": "integer" - }, - "STATUS_CHANGED_DATE": { - "title": "Дата изменения статуса", - "type": "datetime" - }, - "CLOSED_BY": { - "title": "Закрыл задачу", - "type": "integer", - "default": null - }, - "CLOSED_DATE": { - "title": "Дата закрытия", - "type": "datetime", - "default": null - }, - "ACTIVITY_DATE": { - "title": null, - "type": "datetime", - "default": null - }, - "DATE_START": { - "title": "Дата начала", - "type": "datetime", - "default": null - }, - "DEADLINE": { - "title": "Крайний срок", -... -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.mdx new file mode 100644 index 0000000000..b9ef8d3619 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.mdx @@ -0,0 +1,197 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 26 +--- + +# Получить структуру задачи + Получает структуру с описанем полей для создания задачи + + + +`Функция ПолучитьСтруктуруЗадачи(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруЗадачи(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруЗадачи(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "fields": { + "ID": { + "title": "ID", + "type": "integer", + "primary": true + }, + "PARENT_ID": { + "title": "ID базовой задачи", + "type": "integer", + "default": 0 + }, + "TITLE": { + "title": "Название", + "type": "string", + "required": true + }, + "DESCRIPTION": { + "title": "Описание", + "type": "string" + }, + "MARK": { + "title": "Оценка", + "type": "enum", + "values": { + "N": "Отрицательная", + "P": "Положительная" + }, + "default": null + }, + "PRIORITY": { + "title": "Приоритет", + "type": "enum", + "values": { + "2": "Высокий", + "1": "Средний", + "0": "Низкий" + }, + "default": 1 + }, + "STATUS": { + "title": "Статус", + "type": "enum", + "values": { + "2": "Ждёт выполнения", + "3": "Выполняется", + "4": "Ожидает контроля", + "5": "Завершена", + "6": "Отложена" + }, + "default": 2 + }, + "MULTITASK": { + "title": "Множественная задача", + "type": "enum", + "values": { + "Y": "Да", + "N": "Нет" + }, + "default": "N" + }, + "NOT_VIEWED": { + "title": null, + "type": "enum", + "values": { + "Y": "Да", + "N": "Нет" + }, + "default": "N" + }, + "REPLICATE": { + "title": "Повторяемая задача", + "type": "enum", + "values": { + "Y": "Да", + "N": "Нет" + }, + "default": "N" + }, + "GROUP_ID": { + "title": "Проект", + "type": "integer", + "default": 0 + }, + "STAGE_ID": { + "title": "Стадия", + "type": "integer", + "default": 0 + }, + "CREATED_BY": { + "title": "Постановщик", + "type": "integer", + "required": true + }, + "CREATED_DATE": { + "title": null, + "type": "datetime" + }, + "RESPONSIBLE_ID": { + "title": "Исполнитель", + "type": "integer", + "required": true + }, + "ACCOMPLICES": { + "title": null, + "type": "array" + }, + "AUDITORS": { + "title": null, + "type": "array" + }, + "CHANGED_BY": { + "title": "Изменил", + "type": "integer" + }, + "CHANGED_DATE": { + "title": "Дата изменения", + "type": "datetime" + }, + "STATUS_CHANGED_BY": { + "title": "Изменил статус", + "type": "integer" + }, + "STATUS_CHANGED_DATE": { + "title": "Дата изменения статуса", + "type": "datetime" + }, + "CLOSED_BY": { + "title": "Закрыл задачу", + "type": "integer", + "default": null + }, + "CLOSED_DATE": { + "title": "Дата закрытия", + "type": "datetime", + "default": null + }, + "ACTIVITY_DATE": { + "title": null, + "type": "datetime", + "default": null + }, + "DATE_START": { + "title": "Дата начала", + "type": "datetime", + "default": null + }, + "DEADLINE": { + "title": "Крайний срок", +... +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md deleted file mode 100644 index bc0edaf42a..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 19 ---- - -# Получить историю задачи - Получает историю изменений задачи - - - -`Функция ПолучитьИсториюЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.history.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_history_list.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПолучитьИсториюЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПолучитьИсториюЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "list": [ - { - "id": "29674", - "createdDate": "08.10.2024 20:48:35", - "field": "NEW", - "value": { - "from": null, - "to": null - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29676", - "createdDate": "08.10.2024 20:48:40", - "field": "START_DATE_PLAN", - "value": { - "from": "", - "to": "1728409715" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29678", - "createdDate": "08.10.2024 20:48:40", - "field": "END_DATE_PLAN", - "value": { - "from": "", - "to": "1728421200" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29680", - "createdDate": "08.10.2024 20:48:40", - "field": "DURATION_PLAN_SECONDS", - "value": { - "from": "", - "to": "11485" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29694", - "createdDate": "08.10.2024 20:48:42", - "field": "TITLE", - "value": { - "from": "Новая задача", - "to": "Другой заголовок задачи" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29696", - "createdDate": "08.10.2024 20:48:42", - "field": "DESCRIPTION", - "value": { - "from": "", - "to": "" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29698", - "createdDate": "08.10.2024 20:48:42", - "field": "PRIORITY", - "value": { - "from": "2", - "to": "1" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29704", - "createdDate": "08.10.2024 20:48:44", - "field": "RESPONSIBLE_ID", - "value": { - "from": "1", - "to": "594" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29706", - "createdDate": "08.10.2024 20:48:44", - "field": "COMMENT", - "value": { - "from": null, - "to": "5888" - }, - "user": { - "id": "1", - "name": "Антон", - "lastName": "Титовец", - "secondName": null, - "login": "VKuser657846756" - } - }, - { - "id": "29710", - "createdDate": "08.10.2024 20:48:44", -... -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.mdx new file mode 100644 index 0000000000..8e106e56c9 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 19 +--- + +# Получить историю задачи + Получает историю изменений задачи + + + +`Функция ПолучитьИсториюЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.history.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_history_list.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПолучитьИсториюЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПолучитьИсториюЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "list": [ + { + "id": "29674", + "createdDate": "08.10.2024 20:48:35", + "field": "NEW", + "value": { + "from": null, + "to": null + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29676", + "createdDate": "08.10.2024 20:48:40", + "field": "START_DATE_PLAN", + "value": { + "from": "", + "to": "1728409715" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29678", + "createdDate": "08.10.2024 20:48:40", + "field": "END_DATE_PLAN", + "value": { + "from": "", + "to": "1728421200" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29680", + "createdDate": "08.10.2024 20:48:40", + "field": "DURATION_PLAN_SECONDS", + "value": { + "from": "", + "to": "11485" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29694", + "createdDate": "08.10.2024 20:48:42", + "field": "TITLE", + "value": { + "from": "Новая задача", + "to": "Другой заголовок задачи" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29696", + "createdDate": "08.10.2024 20:48:42", + "field": "DESCRIPTION", + "value": { + "from": "", + "to": "" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29698", + "createdDate": "08.10.2024 20:48:42", + "field": "PRIORITY", + "value": { + "from": "2", + "to": "1" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29704", + "createdDate": "08.10.2024 20:48:44", + "field": "RESPONSIBLE_ID", + "value": { + "from": "1", + "to": "594" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29706", + "createdDate": "08.10.2024 20:48:44", + "field": "COMMENT", + "value": { + "from": null, + "to": "5888" + }, + "user": { + "id": "1", + "name": "Антон", + "lastName": "Титовец", + "secondName": null, + "login": "VKuser657846756" + } + }, + { + "id": "29710", + "createdDate": "08.10.2024 20:48:44", +... +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md deleted file mode 100644 index 7ce6f6963c..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить задачу - Получает задачу по ID - - - -`Функция ПолучитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПолучитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПолучитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:42+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-08T20:48:35+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409722.57843, - "finish": 1728409722.63479, - "duration": 0.0563559532165527, - "processing": 0.0293068885803223, - "date_start": "2024-10-08T20:48:42+03:00", - "date_finish": "2024-10-08T20:48:42+03:00", - "operating_reset_at": 1728410322, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.mdx new file mode 100644 index 0000000000..9aa8a1aa3e --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить задачу + Получает задачу по ID + + + +`Функция ПолучитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПолучитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПолучитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:42+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-08T20:48:35+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409722.57843, + "finish": 1728409722.63479, + "duration": 0.0563559532165527, + "processing": 0.0293068885803223, + "date_start": "2024-10-08T20:48:42+03:00", + "date_finish": "2024-10-08T20:48:42+03:00", + "operating_reset_at": 1728410322, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md deleted file mode 100644 index f735f0d2c6..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 27 ---- - -# Получить структуру фильтра задач - Возвращает структуру полей для фильтрации задач в методе ПолучитьСписокЗадач - - - -`Функция ПолучитьСтруктуруФильтраЗадач(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраЗадач(); -``` - - - - -```json title="Результат" -{ - "ID": "<идентификатор задачи>", - "PARENT_ID": "<идентификатор родительской задачи>", - "GROUP_ID": "<идентификатор рабочей группы>", - "CREATED_BY": "<постановщик>", - "STATUS_CHANGED_BY": "<пользователь, последним изменивший статус задачи>", - "PRIORITY": "<приоритет>", - "FORUM_TOPIC_ID": "<идентификатор темы форума>", - "RESPONSIBLE_ID": "<исполнитель>", - "TITLE": "<название задачи (можно искать по шаблону [%_])>", - "TAG": "<тэг>", - "REAL_STATUS": "<статус задачи>", - "MARK": "<оценка>", - "SITE_ID": "<идентификатор сайта>", - "ADD_IN_REPORT": "<задача в отчете (Y|N)>", - "DATE_START": "<дата начала выполнения>", - "DEADLINE": "<крайний срок>", - "CREATED_DATE": "<дата создания>", - "CLOSED_DATE": "<дата завершения>", - "CHANGED_DATE": "<дата последнего изменения>", - "ACCOMPLICE": "<идентификатор соисполнителя>", - "AUDITOR": "<идентификатор наблюдателя>", - "DEPENDS_ON": "<идентификатор предыдущей задачи>", - "ONLY_ROOT_TASKS": "<только задачи, которые не являются подзадачами (Y|N)>", - "STAGE_ID": "<стадия>", - "UF_CRM_TASK": "<элементы CRM>", - "STATUS": "<статус для сортировки. Аналогичен REAL_STATUS, но имеет дополнительно три мета-статуса>" -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.mdx new file mode 100644 index 0000000000..2a03f97712 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 27 +--- + +# Получить структуру фильтра задач + Возвращает структуру полей для фильтрации задач в методе ПолучитьСписокЗадач + + + +`Функция ПолучитьСтруктуруФильтраЗадач(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраЗадач(); +``` + + + + +```json title="Результат" +{ + "ID": "<идентификатор задачи>", + "PARENT_ID": "<идентификатор родительской задачи>", + "GROUP_ID": "<идентификатор рабочей группы>", + "CREATED_BY": "<постановщик>", + "STATUS_CHANGED_BY": "<пользователь, последним изменивший статус задачи>", + "PRIORITY": "<приоритет>", + "FORUM_TOPIC_ID": "<идентификатор темы форума>", + "RESPONSIBLE_ID": "<исполнитель>", + "TITLE": "<название задачи (можно искать по шаблону [%_])>", + "TAG": "<тэг>", + "REAL_STATUS": "<статус задачи>", + "MARK": "<оценка>", + "SITE_ID": "<идентификатор сайта>", + "ADD_IN_REPORT": "<задача в отчете (Y|N)>", + "DATE_START": "<дата начала выполнения>", + "DEADLINE": "<крайний срок>", + "CREATED_DATE": "<дата создания>", + "CLOSED_DATE": "<дата завершения>", + "CHANGED_DATE": "<дата последнего изменения>", + "ACCOMPLICE": "<идентификатор соисполнителя>", + "AUDITOR": "<идентификатор наблюдателя>", + "DEPENDS_ON": "<идентификатор предыдущей задачи>", + "ONLY_ROOT_TASKS": "<только задачи, которые не являются подзадачами (Y|N)>", + "STAGE_ID": "<стадия>", + "UF_CRM_TASK": "<элементы CRM>", + "STATUS": "<статус для сортировки. Аналогичен REAL_STATUS, но имеет дополнительно три мета-статуса>" +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md deleted file mode 100644 index 7e6994297f..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список задач - Получает список задач (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЗадач) - - - -`Функция ПолучитьСписокЗадач(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора задач (см. ПолучитьСтруктуруФильтраЗадач) | - | Отступ | --offset | Число, Строка | Отступ от начала списка для полчения задач > 50 шт. рекурсивно | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php) -::: -
- - -```bsl title="Пример кода" - // Полную структуру фильтра можно найти в функции ПолучитьСтруктуруФильтраЗадач - Фильтр = Новый Структура; - Фильтр.Вставить("CREATED_BY" , 1); - Фильтр.Вставить("RESPONSIBLE_ID", 10); - - Отступ = 1; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСписокЗадач(URL, Фильтр); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокЗадач(URL, , Отступ, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "tasks": [ - { - "id": "268", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T16:21:01+03:00", - "responsibleId": "10", - "changedBy": "1", - "changedDate": "2024-07-03T16:21:14+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-07-04T20:03:10+03:00", - "dateStart": "2024-07-03T16:21:12+03:00", - "deadline": "2024-07-04T16:21:00+03:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{29e9893d-226b-43a1-80bb-60af6434070f}", - "xmlId": null, - "commentsCount": "4", - "serviceCommentsCount": "4", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "258", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-07-04T20:03:10+03:00", - "sorting": "1024.0000000", - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T16:21:14+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "newCommentsCount": 0, - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "10", - "name": "Techno Pizza", - "link": "/company/personal/user/10/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "subStatus": "-1" - }, - { - "id": "270", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T16:21:02+03:00", - "responsibleId": "10", - "changedBy": "1", - "changedDate": "2024-07-03T16:21:14+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-07-04T20:03:10+03:00", - "dateStart": "2024-07-03T16:21:13+03:00", - "deadline": "2024-07-04T16:21:00+03:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{c8004012-7ca9-42da-b985-a1c0e90a285a}", - "xmlId": null, - "commentsCount": "4", - "serviceCommentsCount": "4", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "260", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-07-04T20:03:10+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T16:21:14+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "newCommentsCount": 0, - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, -... -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.mdx new file mode 100644 index 0000000000..d7138b8146 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.mdx @@ -0,0 +1,205 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список задач + Получает список задач (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЗадач) + + + +`Функция ПолучитьСписокЗадач(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора задач (см. ПолучитьСтруктуруФильтраЗадач) | + | Отступ | --offset | Число, Строка | Отступ от начала списка для полчения задач > 50 шт. рекурсивно | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php) +::: +
+ + +```bsl title="Пример кода" + // Полную структуру фильтра можно найти в функции ПолучитьСтруктуруФильтраЗадач + Фильтр = Новый Структура; + Фильтр.Вставить("CREATED_BY" , 1); + Фильтр.Вставить("RESPONSIBLE_ID", 10); + + Отступ = 1; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСписокЗадач(URL, Фильтр); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокЗадач(URL, , Отступ, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "tasks": [ + { + "id": "268", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T16:21:01+03:00", + "responsibleId": "10", + "changedBy": "1", + "changedDate": "2024-07-03T16:21:14+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-07-04T20:03:10+03:00", + "dateStart": "2024-07-03T16:21:12+03:00", + "deadline": "2024-07-04T16:21:00+03:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{29e9893d-226b-43a1-80bb-60af6434070f}", + "xmlId": null, + "commentsCount": "4", + "serviceCommentsCount": "4", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "258", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-07-04T20:03:10+03:00", + "sorting": "1024.0000000", + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T16:21:14+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "newCommentsCount": 0, + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "10", + "name": "Techno Pizza", + "link": "/company/personal/user/10/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "subStatus": "-1" + }, + { + "id": "270", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T16:21:02+03:00", + "responsibleId": "10", + "changedBy": "1", + "changedDate": "2024-07-03T16:21:14+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-07-04T20:03:10+03:00", + "dateStart": "2024-07-03T16:21:13+03:00", + "deadline": "2024-07-04T16:21:00+03:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{c8004012-7ca9-42da-b985-a1c0e90a285a}", + "xmlId": null, + "commentsCount": "4", + "serviceCommentsCount": "4", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "260", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-07-04T20:03:10+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T16:21:14+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "newCommentsCount": 0, + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, +... +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md deleted file mode 100644 index 4471b5651b..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 21 ---- - -# Отключить звук задачи - Устанавливает режим Без звука для задачи - - - -`Функция ОтключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:42+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-08T20:48:35+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "Y", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409722.80511, - "finish": 1728409722.86168, - "duration": 0.0565609931945801, - "processing": 0.0318589210510254, - "date_start": "2024-10-08T20:48:42+03:00", - "date_finish": "2024-10-08T20:48:42+03:00", - "operating_reset_at": 1728410322, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.mdx new file mode 100644 index 0000000000..4da07cfc9e --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 21 +--- + +# Отключить звук задачи + Устанавливает режим Без звука для задачи + + + +`Функция ОтключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:42+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-08T20:48:35+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "Y", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409722.80511, + "finish": 1728409722.86168, + "duration": 0.0565609931945801, + "processing": 0.0318589210510254, + "date_start": "2024-10-08T20:48:42+03:00", + "date_finish": "2024-10-08T20:48:42+03:00", + "operating_reset_at": 1728410322, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md deleted file mode 100644 index 3aa7170a29..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Приостановить задачу - Приостанавливает задачу по ID - - - -`Функция ПриостановитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.pause](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_pause.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПриостановитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПриостановитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:48+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-08T20:48:47+03:00", - "dateStart": "2024-10-08T20:48:47+03:00", - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "10", - "viewedDate": "2024-10-08T20:48:47+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:48+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409728.89053, - "finish": 1728409729.10249, - "duration": 0.211966991424561, - "processing": 0.18712306022644, - "date_start": "2024-10-08T20:48:48+03:00", - "date_finish": "2024-10-08T20:48:49+03:00", - "operating_reset_at": 1728410328, - "operating": 0.1871018409729 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.mdx new file mode 100644 index 0000000000..3ab45360d5 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Приостановить задачу + Приостанавливает задачу по ID + + + +`Функция ПриостановитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.pause](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_pause.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПриостановитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПриостановитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:48+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-08T20:48:47+03:00", + "dateStart": "2024-10-08T20:48:47+03:00", + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "10", + "viewedDate": "2024-10-08T20:48:47+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:48+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409728.89053, + "finish": 1728409729.10249, + "duration": 0.211966991424561, + "processing": 0.18712306022644, + "date_start": "2024-10-08T20:48:48+03:00", + "date_finish": "2024-10-08T20:48:49+03:00", + "operating_reset_at": 1728410328, + "operating": 0.1871018409729 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md b/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md deleted file mode 100644 index 9d2d426a05..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 18 ---- - -# Убрать задачу из избранного - Удаляет задачу из списка избранного - - - -`Функция УбратьЗадачуИзИзбранного(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.favorite.remove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_remove.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.УбратьЗадачуИзИзбранного(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.УбратьЗадачуИзИзбранного(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409723.44027, - "finish": 1728409723.47719, - "duration": 0.0369260311126709, - "processing": 0.0120358467102051, - "date_start": "2024-10-08T20:48:43+03:00", - "date_finish": "2024-10-08T20:48:43+03:00", - "operating_reset_at": 1728410323, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.mdx new file mode 100644 index 0000000000..d519064b55 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 18 +--- + +# Убрать задачу из избранного + Удаляет задачу из списка избранного + + + +`Функция УбратьЗадачуИзИзбранного(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.favorite.remove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_remove.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.УбратьЗадачуИзИзбранного(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.УбратьЗадачуИзИзбранного(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409723.44027, + "finish": 1728409723.47719, + "duration": 0.0369260311126709, + "processing": 0.0120358467102051, + "date_start": "2024-10-08T20:48:43+03:00", + "date_finish": "2024-10-08T20:48:43+03:00", + "operating_reset_at": 1728410323, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md deleted file mode 100644 index 83c21f8b35..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Возобновить задачу - Возвращает в работу задачу по ID - - - -`Функция ВозобновитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_renew.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ВозобновитьЗадачу(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ВозобновитьЗадачу(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:46+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-08T20:48:47+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "7", - "viewedDate": "2024-10-08T20:48:47+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:46+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409726.87713, - "finish": 1728409727.23097, - "duration": 0.353838920593262, - "processing": 0.323814153671265, - "date_start": "2024-10-08T20:48:46+03:00", - "date_finish": "2024-10-08T20:48:47+03:00", - "operating_reset_at": 1728410326, - "operating": 0.32378888130188 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.mdx new file mode 100644 index 0000000000..9764d9a686 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Возобновить задачу + Возвращает в работу задачу по ID + + + +`Функция ВозобновитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_renew.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ВозобновитьЗадачу(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ВозобновитьЗадачу(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:46+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-08T20:48:47+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "7", + "viewedDate": "2024-10-08T20:48:47+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:46+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409726.87713, + "finish": 1728409727.23097, + "duration": 0.353838920593262, + "processing": 0.323814153671265, + "date_start": "2024-10-08T20:48:46+03:00", + "date_finish": "2024-10-08T20:48:47+03:00", + "operating_reset_at": 1728410326, + "operating": 0.32378888130188 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md deleted file mode 100644 index 9541f0e187..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Начать выполнение задачи - Начинает выполнение задачи по ID - - - -`Функция НачатьВыполнениеЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.start](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_start.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.НачатьВыполнениеЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.НачатьВыполнениеЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:47+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-08T20:48:47+03:00", - "dateStart": "2024-10-08T20:48:47+03:00", - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "8", - "viewedDate": "2024-10-08T20:48:47+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "3", - "statusChangedDate": "2024-10-08T20:48:47+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": true, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409727.60206, - "finish": 1728409727.8295, - "duration": 0.227440118789673, - "processing": 0.20234203338623, - "date_start": "2024-10-08T20:48:47+03:00", - "date_finish": "2024-10-08T20:48:47+03:00", - "operating_reset_at": 1728410327, - "operating": 0.202322006225586 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.mdx new file mode 100644 index 0000000000..7fd8f27943 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Начать выполнение задачи + Начинает выполнение задачи по ID + + + +`Функция НачатьВыполнениеЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.start](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_start.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.НачатьВыполнениеЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.НачатьВыполнениеЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:47+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-08T20:48:47+03:00", + "dateStart": "2024-10-08T20:48:47+03:00", + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "8", + "viewedDate": "2024-10-08T20:48:47+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "3", + "statusChangedDate": "2024-10-08T20:48:47+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": true, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409727.60206, + "finish": 1728409727.8295, + "duration": 0.227440118789673, + "processing": 0.20234203338623, + "date_start": "2024-10-08T20:48:47+03:00", + "date_finish": "2024-10-08T20:48:47+03:00", + "operating_reset_at": 1728410327, + "operating": 0.202322006225586 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md deleted file mode 100644 index 100fd5e706..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Начать наблюдать за задачей - Начинает наблюдение за задачей по ID - - - -`Функция НачатьНаблюдатьЗаЗадачей(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.startwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_startwatch.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.НачатьНаблюдатьЗаЗадачей(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.НачатьНаблюдатьЗаЗадачей(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "594", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:48+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-08T20:48:47+03:00", - "dateStart": "2024-10-08T20:48:47+03:00", - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": "1652", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-10-08T20:48:47+03:00", - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "3", - "statusChangedDate": "2024-10-08T20:48:47+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": true, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409728.13472, - "finish": 1728409728.33456, - "duration": 0.199834108352661, - "processing": 0.173263072967529, - "date_start": "2024-10-08T20:48:48+03:00", - "date_finish": "2024-10-08T20:48:48+03:00", - "operating_reset_at": 1728410328, - "operating": 0.173232078552246 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.mdx new file mode 100644 index 0000000000..b85a3bfb21 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Начать наблюдать за задачей + Начинает наблюдение за задачей по ID + + + +`Функция НачатьНаблюдатьЗаЗадачей(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.startwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_startwatch.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.НачатьНаблюдатьЗаЗадачей(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.НачатьНаблюдатьЗаЗадачей(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "594", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:48+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-08T20:48:47+03:00", + "dateStart": "2024-10-08T20:48:47+03:00", + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": "1652", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-10-08T20:48:47+03:00", + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "3", + "statusChangedDate": "2024-10-08T20:48:47+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": true, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409728.13472, + "finish": 1728409728.33456, + "duration": 0.199834108352661, + "processing": 0.173263072967529, + "date_start": "2024-10-08T20:48:48+03:00", + "date_finish": "2024-10-08T20:48:48+03:00", + "operating_reset_at": 1728410328, + "operating": 0.173232078552246 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md deleted file mode 100644 index 91178a4686..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 15 ---- - -# Прекратить наблюдать за задачей - Прекращает наблюдение за задчей по ID - - - -`Функция ПрекратитьНаблюдатьЗаЗадачей(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.stopwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_stopwatch.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ПрекратитьНаблюдатьЗаЗадачей(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ПрекратитьНаблюдатьЗаЗадачей(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "descriptionInBbcode": "Y", - "declineReason": "", - "priority": "1", - "notViewed": "N", - "statusComplete": "1", - "multitask": "N", - "stageId": "0", - "responsibleId": "594", - "responsibleName": "Oleg", - "responsibleLastName": "Lama", - "responsibleSecondName": null, - "responsibleLogin": "584b160c-03dc-4548-a898-282d95334643@exepmple.org", - "responsibleWorkPosition": null, - "responsiblePhoto": null, - "dateStart": "2024-10-08T20:48:47+03:00", - "durationFact": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "replicate": "N", - "deadline": "2024-10-09T23:48:00+03:00", - "deadlineOrig": "09.10.2024 23:48:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "createdBy": "1", - "createdByName": "Антон", - "createdByLastName": "Титовец", - "createdBySecondName": null, - "createdByLogin": "VKuser657846756", - "createdByWorkPosition": null, - "createdByPhoto": "30", - "createdDate": "2024-10-08T20:48:35+03:00", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:48+03:00", - "statusChangedBy": "1", - "closedBy": "0", - "closedDate": null, - "activityDate": "2024-10-08T20:48:47+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "mark": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "matchWorkTime": "N", - "taskControl": "N", - "addInReport": "N", - "forumTopicId": "1652", - "parentId": null, - "commentsCount": "3", - "serviceCommentsCount": "3", - "forumId": "11", - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "9", - "viewedDate": "2024-10-08T20:48:47+03:00", - "deadlineCounted": "0", - "forkedByTemplateId": null, - "sorting": null, - "durationPlanSeconds": null, - "durationTypeAll": "days", - "scenarioName": [ - "default" - ], - "isRegular": "N", - "flowId": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "ufCrmTask": false, - "ufTaskWebdavFiles": false, - "ufMailMessage": null, - "status": "3", - "statusChangedDate": "2024-10-08T20:48:47+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "tags": [], - "checklist": [], - "files": [], - "dependsOn": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "594", - "name": "Oleg Lama", - "link": "/company/personal/user/594/", - "icon": "/bitrix/images/tasks/default_avatar.png", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": false, - "pause": true, - "delegate": true, - "remove": true, - "edit": true, - "defer": false, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, -... -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.mdx new file mode 100644 index 0000000000..2800b1ea81 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 15 +--- + +# Прекратить наблюдать за задачей + Прекращает наблюдение за задчей по ID + + + +`Функция ПрекратитьНаблюдатьЗаЗадачей(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.stopwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_stopwatch.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ПрекратитьНаблюдатьЗаЗадачей(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ПрекратитьНаблюдатьЗаЗадачей(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "descriptionInBbcode": "Y", + "declineReason": "", + "priority": "1", + "notViewed": "N", + "statusComplete": "1", + "multitask": "N", + "stageId": "0", + "responsibleId": "594", + "responsibleName": "Oleg", + "responsibleLastName": "Lama", + "responsibleSecondName": null, + "responsibleLogin": "584b160c-03dc-4548-a898-282d95334643@exepmple.org", + "responsibleWorkPosition": null, + "responsiblePhoto": null, + "dateStart": "2024-10-08T20:48:47+03:00", + "durationFact": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "replicate": "N", + "deadline": "2024-10-09T23:48:00+03:00", + "deadlineOrig": "09.10.2024 23:48:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "createdBy": "1", + "createdByName": "Антон", + "createdByLastName": "Титовец", + "createdBySecondName": null, + "createdByLogin": "VKuser657846756", + "createdByWorkPosition": null, + "createdByPhoto": "30", + "createdDate": "2024-10-08T20:48:35+03:00", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:48+03:00", + "statusChangedBy": "1", + "closedBy": "0", + "closedDate": null, + "activityDate": "2024-10-08T20:48:47+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "mark": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "matchWorkTime": "N", + "taskControl": "N", + "addInReport": "N", + "forumTopicId": "1652", + "parentId": null, + "commentsCount": "3", + "serviceCommentsCount": "3", + "forumId": "11", + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "9", + "viewedDate": "2024-10-08T20:48:47+03:00", + "deadlineCounted": "0", + "forkedByTemplateId": null, + "sorting": null, + "durationPlanSeconds": null, + "durationTypeAll": "days", + "scenarioName": [ + "default" + ], + "isRegular": "N", + "flowId": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "ufCrmTask": false, + "ufTaskWebdavFiles": false, + "ufMailMessage": null, + "status": "3", + "statusChangedDate": "2024-10-08T20:48:47+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "tags": [], + "checklist": [], + "files": [], + "dependsOn": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "594", + "name": "Oleg Lama", + "link": "/company/personal/user/594/", + "icon": "/bitrix/images/tasks/default_avatar.png", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": false, + "pause": true, + "delegate": true, + "remove": true, + "edit": true, + "defer": false, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, +... +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md deleted file mode 100644 index 7da609cfca..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -sidebar_position: 22 ---- - -# Включить звук задачи - Отключает режим Без звука для задачи - - - -`Функция ВключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:42+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-08T20:48:35+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409723.03621, - "finish": 1728409723.10396, - "duration": 0.0677478313446045, - "processing": 0.0383040904998779, - "date_start": "2024-10-08T20:48:43+03:00", - "date_finish": "2024-10-08T20:48:43+03:00", - "operating_reset_at": 1728410323, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.mdx new file mode 100644 index 0000000000..350c591b95 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.mdx @@ -0,0 +1,192 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 22 +--- + +# Включить звук задачи + Отключает режим Без звука для задачи + + + +`Функция ВключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:42+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-08T20:48:35+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409723.03621, + "finish": 1728409723.10396, + "duration": 0.0677478313446045, + "processing": 0.0383040904998779, + "date_start": "2024-10-08T20:48:43+03:00", + "date_finish": "2024-10-08T20:48:43+03:00", + "operating_reset_at": 1728410323, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md deleted file mode 100644 index 0a1666019a..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Изменить задачу - Изменяет существующую задачу - - - -`Функция ИзменитьЗадачу(Знач URL, Знач IDЗадачи, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_update.php) -::: -
- - -```bsl title="Пример кода" - // Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи() - - СтруктураЗадачи = Новый Структура; - СтруктураЗадачи.Вставить("TITLE" , "Другой заголовок задачи"); - СтруктураЗадачи.Вставить("DESCRIPTION", "Другое описание задачи"); - СтруктураЗадачи.Вставить("PRIORITY" , "1"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2446"; - - Результат = OPI_Bitrix24.ИзменитьЗадачу(URL, IDЗадачи, СтруктураЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗадачи = "2448"; - - Результат = OPI_Bitrix24.ИзменитьЗадачу(URL, IDЗадачи, СтруктураЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "task": { - "id": "2378", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-10-08T20:48:35+03:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-10-08T20:48:42+03:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-10-08T20:48:35+03:00", - "dateStart": null, - "deadline": "2024-10-09T23:48:00+03:00", - "startDatePlan": "2024-10-08T20:48:35+03:00", - "endDatePlan": "2024-10-09T00:00:00+03:00", - "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "3", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-10-08T20:48:42+03:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1728409722.12946, - "finish": 1728409722.41218, - "duration": 0.282722949981689, - "processing": 0.254257917404175, - "date_start": "2024-10-08T20:48:42+03:00", - "date_finish": "2024-10-08T20:48:42+03:00", - "operating_reset_at": 1728410322, - "operating": 0.254235982894897 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Update-task.mdx b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.mdx new file mode 100644 index 0000000000..0255490355 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Изменить задачу + Изменяет существующую задачу + + + +`Функция ИзменитьЗадачу(Знач URL, Знач IDЗадачи, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_update.php) +::: +
+ + +```bsl title="Пример кода" + // Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи() + + СтруктураЗадачи = Новый Структура; + СтруктураЗадачи.Вставить("TITLE" , "Другой заголовок задачи"); + СтруктураЗадачи.Вставить("DESCRIPTION", "Другое описание задачи"); + СтруктураЗадачи.Вставить("PRIORITY" , "1"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2446"; + + Результат = OPI_Bitrix24.ИзменитьЗадачу(URL, IDЗадачи, СтруктураЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗадачи = "2448"; + + Результат = OPI_Bitrix24.ИзменитьЗадачу(URL, IDЗадачи, СтруктураЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "task": { + "id": "2378", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-10-08T20:48:35+03:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-10-08T20:48:42+03:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-10-08T20:48:35+03:00", + "dateStart": null, + "deadline": "2024-10-09T23:48:00+03:00", + "startDatePlan": "2024-10-08T20:48:35+03:00", + "endDatePlan": "2024-10-09T00:00:00+03:00", + "guid": "{037d66b0-f11d-4d50-bf02-0491fe52bea7}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "3", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-10-08T20:48:42+03:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1728409722.12946, + "finish": 1728409722.41218, + "duration": 0.282722949981689, + "processing": 0.254257917404175, + "date_start": "2024-10-08T20:48:42+03:00", + "date_finish": "2024-10-08T20:48:42+03:00", + "operating_reset_at": 1728410322, + "operating": 0.254235982894897 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md deleted file mode 100644 index 75bcc4f901..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Добавить трудозатраты задачи - Добавляет информацию о затраченном времени пользователя в задачу - - - -`Функция ДобавитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач Время, Знач IDПользователя = "", Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | - | Время | --amount | Строка, Число | Затраченное время в секундах | - | IDПользователя | --user | Строка, Число | ID пользователя, затратившего время | - | Текст | --text | Строка | Текст комментария трудозатраты | - | ДатаУстановки | --date | Строка | Дата установки трудозатрат | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2454"; - - Время = 3600; - - Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL, IDЗадачи, Время); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Текст = "Трудозатраты по обработке"; - IDПользователя = 10; - Время = 7200; - ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); - - Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL - , IDЗадачи - , Время - , IDПользователя - , Текст - , ДатаУстановки - , Токен); -``` - - - - -```json title="Результат" -{ - "result": 822, - "time": { - "start": 1728409781.22363, - "finish": 1728409781.28562, - "duration": 0.0619890689849854, - "processing": 0.0340280532836914, - "date_start": "2024-10-08T20:49:41+03:00", - "date_finish": "2024-10-08T20:49:41+03:00", - "operating_reset_at": 1728410381, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.mdx b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.mdx new file mode 100644 index 0000000000..f39edf0541 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Добавить трудозатраты задачи + Добавляет информацию о затраченном времени пользователя в задачу + + + +`Функция ДобавитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач Время, Знач IDПользователя = "", Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | + | Время | --amount | Строка, Число | Затраченное время в секундах | + | IDПользователя | --user | Строка, Число | ID пользователя, затратившего время | + | Текст | --text | Строка | Текст комментария трудозатраты | + | ДатаУстановки | --date | Строка | Дата установки трудозатрат | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2454"; + + Время = 3600; + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL, IDЗадачи, Время); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Текст = "Трудозатраты по обработке"; + IDПользователя = 10; + Время = 7200; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL + , IDЗадачи + , Время + , IDПользователя + , Текст + , ДатаУстановки + , Токен); +``` + + + + +```json title="Результат" +{ + "result": 822, + "time": { + "start": 1728409781.22363, + "finish": 1728409781.28562, + "duration": 0.0619890689849854, + "processing": 0.0340280532836914, + "date_start": "2024-10-08T20:49:41+03:00", + "date_finish": "2024-10-08T20:49:41+03:00", + "operating_reset_at": 1728410381, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md deleted file mode 100644 index f9898e12d0..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Удалить трудозатраты задачи - Удаляет запись о трудозатратах из задачи - - - -`Функция УдалитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | - | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2454"; - IDЗаписи = "848"; - - Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗаписи = "850"; - - Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); -``` - - - - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1728409782.15329, - "finish": 1728409782.22571, - "duration": 0.0724129676818848, - "processing": 0.0359148979187012, - "date_start": "2024-10-08T20:49:42+03:00", - "date_finish": "2024-10-08T20:49:42+03:00", - "operating_reset_at": 1728410382, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.mdx b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.mdx new file mode 100644 index 0000000000..f717946e0e --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Удалить трудозатраты задачи + Удаляет запись о трудозатратах из задачи + + + +`Функция УдалитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2454"; + IDЗаписи = "848"; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗаписи = "850"; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); +``` + + + + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1728409782.15329, + "finish": 1728409782.22571, + "duration": 0.0724129676818848, + "processing": 0.0359148979187012, + "date_start": "2024-10-08T20:49:42+03:00", + "date_finish": "2024-10-08T20:49:42+03:00", + "operating_reset_at": 1728410382, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md deleted file mode 100644 index ae8b29c5b8..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить список трудозатрат задачи - Получает список записей о трудозатратах задачи - - - -`Функция ПолучитьСписокТрудозатратЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2454"; - - Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "820", - "TASK_ID": "2384", - "USER_ID": "1", - "COMMENT_TEXT": "", - "SECONDS": "3600", - "MINUTES": "60", - "SOURCE": "2", - "CREATED_DATE": "2024-10-08T20:49:41+03:00", - "DATE_START": "2024-10-08T20:49:41+03:00", - "DATE_STOP": "2024-10-08T20:49:41+03:00" - }, - { - "ID": "822", - "TASK_ID": "2384", - "USER_ID": "10", - "COMMENT_TEXT": "Трудозатраты по обработке", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-09-08T20:49:41+03:00", - "DATE_START": "2024-10-08T20:49:41+03:00", - "DATE_STOP": "2024-10-08T20:49:41+03:00" - } - ], - "total": 2, - "time": { - "start": 1728409781.69063, - "finish": 1728409781.73788, - "duration": 0.0472440719604492, - "processing": 0.0214691162109375, - "date_start": "2024-10-08T20:49:41+03:00", - "date_finish": "2024-10-08T20:49:41+03:00", - "operating_reset_at": 1728410381, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.mdx b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.mdx new file mode 100644 index 0000000000..27aee3e422 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить список трудозатрат задачи + Получает список записей о трудозатратах задачи + + + +`Функция ПолучитьСписокТрудозатратЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2454"; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "820", + "TASK_ID": "2384", + "USER_ID": "1", + "COMMENT_TEXT": "", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-10-08T20:49:41+03:00", + "DATE_START": "2024-10-08T20:49:41+03:00", + "DATE_STOP": "2024-10-08T20:49:41+03:00" + }, + { + "ID": "822", + "TASK_ID": "2384", + "USER_ID": "10", + "COMMENT_TEXT": "Трудозатраты по обработке", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-09-08T20:49:41+03:00", + "DATE_START": "2024-10-08T20:49:41+03:00", + "DATE_STOP": "2024-10-08T20:49:41+03:00" + } + ], + "total": 2, + "time": { + "start": 1728409781.69063, + "finish": 1728409781.73788, + "duration": 0.0472440719604492, + "processing": 0.0214691162109375, + "date_start": "2024-10-08T20:49:41+03:00", + "date_finish": "2024-10-08T20:49:41+03:00", + "operating_reset_at": 1728410381, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md deleted file mode 100644 index 679c2dcd0d..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить трудозатраты задачи - Получает информацию о записи трудозатрат задачи по ID - - - -`Функция ПолучитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи | - | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2454"; - IDЗаписи = "848"; - - Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗаписи = "850"; - - Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "822", - "TASK_ID": "2384", - "USER_ID": "10", - "COMMENT_TEXT": "Трудозатраты по обработке", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-09-08T20:49:41+03:00", - "DATE_START": "2024-10-08T20:49:41+03:00", - "DATE_STOP": "2024-10-08T20:49:41+03:00" - }, - "time": { - "start": 1728409781.46135, - "finish": 1728409781.51527, - "duration": 0.0539231300354004, - "processing": 0.0240540504455566, - "date_start": "2024-10-08T20:49:41+03:00", - "date_finish": "2024-10-08T20:49:41+03:00", - "operating_reset_at": 1728410381, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.mdx b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.mdx new file mode 100644 index 0000000000..ac57a5f414 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить трудозатраты задачи + Получает информацию о записи трудозатрат задачи по ID + + + +`Функция ПолучитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2454"; + IDЗаписи = "848"; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗаписи = "850"; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "822", + "TASK_ID": "2384", + "USER_ID": "10", + "COMMENT_TEXT": "Трудозатраты по обработке", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-09-08T20:49:41+03:00", + "DATE_START": "2024-10-08T20:49:41+03:00", + "DATE_STOP": "2024-10-08T20:49:41+03:00" + }, + "time": { + "start": 1728409781.46135, + "finish": 1728409781.51527, + "duration": 0.0539231300354004, + "processing": 0.0240540504455566, + "date_start": "2024-10-08T20:49:41+03:00", + "date_finish": "2024-10-08T20:49:41+03:00", + "operating_reset_at": 1728410381, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md deleted file mode 100644 index 2b42a0ae06..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Получить настройки учета времени - Получает настройки учета времени пользователя - - - -`Функция ПолучитьНастройкиУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 1; - - Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "UF_TIMEMAN": true, - "UF_TM_FREE": false, - "UF_TM_MAX_START": "09:15:00", - "UF_TM_MIN_FINISH": "17:45:00", - "UF_TM_MIN_DURATION": "08:00:00", - "UF_TM_ALLOWED_DELTA": "00:15:00", - "ADMIN": true - }, - "time": { - "start": 1722332243.86487, - "finish": 1722332243.88732, - "duration": 0.0224521160125732, - "processing": 0.00417494773864746, - "date_start": "2024-07-30T09:37:23+00:00", - "date_finish": "2024-07-30T09:37:23+00:00", - "operating_reset_at": 1722332843, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.mdx b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.mdx new file mode 100644 index 0000000000..341b37ad20 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Получить настройки учета времени + Получает настройки учета времени пользователя + + + +`Функция ПолучитьНастройкиУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "UF_TIMEMAN": true, + "UF_TM_FREE": false, + "UF_TM_MAX_START": "09:15:00", + "UF_TM_MIN_FINISH": "17:45:00", + "UF_TM_MIN_DURATION": "08:00:00", + "UF_TM_ALLOWED_DELTA": "00:15:00", + "ADMIN": true + }, + "time": { + "start": 1722332243.86487, + "finish": 1722332243.88732, + "duration": 0.0224521160125732, + "processing": 0.00417494773864746, + "date_start": "2024-07-30T09:37:23+00:00", + "date_finish": "2024-07-30T09:37:23+00:00", + "operating_reset_at": 1722332843, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md deleted file mode 100644 index 466b04eeeb..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Получить статус учета времени - Получает статус учета времени пользователя - - - -`Функция ПолучитьСтатусУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 1; - - Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328322.65261, - "finish": 1722328322.6837, - "duration": 0.0310959815979004, - "processing": 0.00899505615234375, - "date_start": "2024-07-30T08:32:02+00:00", - "date_finish": "2024-07-30T08:32:02+00:00", - "operating_reset_at": 1722328922, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.mdx b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.mdx new file mode 100644 index 0000000000..b714157575 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Получить статус учета времени + Получает статус учета времени пользователя + + + +`Функция ПолучитьСтатусУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328322.65261, + "finish": 1722328322.6837, + "duration": 0.0310959815979004, + "processing": 0.00899505615234375, + "date_start": "2024-07-30T08:32:02+00:00", + "date_finish": "2024-07-30T08:32:02+00:00", + "operating_reset_at": 1722328922, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md deleted file mode 100644 index e6cb03b1d6..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Приостановить учет времени - Приостанавливает учет времени пользователя - - - -`Функция ПриостановитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 1; - - Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328320.91942, - "finish": 1722328320.98461, - "duration": 0.0651938915252686, - "processing": 0.0352118015289307, - "date_start": "2024-07-30T08:32:00+00:00", - "date_finish": "2024-07-30T08:32:00+00:00", - "operating_reset_at": 1722328920, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.mdx b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.mdx new file mode 100644 index 0000000000..edca0f2dd7 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Приостановить учет времени + Приостанавливает учет времени пользователя + + + +`Функция ПриостановитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328320.91942, + "finish": 1722328320.98461, + "duration": 0.0651938915252686, + "processing": 0.0352118015289307, + "date_start": "2024-07-30T08:32:00+00:00", + "date_finish": "2024-07-30T08:32:00+00:00", + "operating_reset_at": 1722328920, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md deleted file mode 100644 index 7b802cb691..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Начать учет времени - Начинает учет времени пользователя - - - -`Функция НачатьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Время | --time | Дата | Время начала учета. Дата должна совпадать с текущей. Текущее время по ум. | - | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.НачатьУчетВремени(URL); - - Час = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 1; - Время = OPI_Инструменты.ПолучитьТекущуюДату() - Час; - Отчет = "Опоздание"; - - Результат = OPI_Bitrix24.НачатьУчетВремени(URL, IDПользователя, Время, Отчет, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "STATUS": "OPENED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": null, - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "93.125.42.204", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328319.21856, - "finish": 1722328319.25781, - "duration": 0.0392520427703857, - "processing": 0.014214038848877, - "date_start": "2024-07-30T08:31:59+00:00", - "date_finish": "2024-07-30T08:31:59+00:00", - "operating_reset_at": 1722328919, - "operating": 0.181692123413086 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.mdx b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.mdx new file mode 100644 index 0000000000..2359c7d6c3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Начать учет времени + Начинает учет времени пользователя + + + +`Функция НачатьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Время | --time | Дата | Время начала учета. Дата должна совпадать с текущей. Текущее время по ум. | + | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL); + + Час = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату() - Час; + Отчет = "Опоздание"; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL, IDПользователя, Время, Отчет, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "STATUS": "OPENED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": null, + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "93.125.42.204", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328319.21856, + "finish": 1722328319.25781, + "duration": 0.0392520427703857, + "processing": 0.014214038848877, + "date_start": "2024-07-30T08:31:59+00:00", + "date_finish": "2024-07-30T08:31:59+00:00", + "operating_reset_at": 1722328919, + "operating": 0.181692123413086 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md deleted file mode 100644 index c2394b209a..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Завершить учет времени - Завершает учет времени пользователя - - - -`Функция ЗавершитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Время | --time | Дата | Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум. | - | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = 1; - Время = OPI_Инструменты.ПолучитьТекущуюДату(); - Отчет = "Отгул"; - - Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL, IDПользователя, Время, Отчет, Токен); -``` - - - - -```json title="Результат" -{ - "error": "WRONG_DATETIME_FORMAT", - "error_description": "Wrong datetime format" -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.mdx b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.mdx new file mode 100644 index 0000000000..9a098a161a --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Завершить учет времени + Завершает учет времени пользователя + + + +`Функция ЗавершитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Время | --time | Дата | Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум. | + | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату(); + Отчет = "Отгул"; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL, IDПользователя, Время, Отчет, Токен); +``` + + + + +```json title="Результат" +{ + "error": "WRONG_DATETIME_FORMAT", + "error_description": "Wrong datetime format" +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md deleted file mode 100644 index e4d4f247c8..0000000000 --- a/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Изменить трудозатраты задачи - Изменяет данные записи о трудозатратах задачи - - - -`Функция ИзменитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Время, Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи | - | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | - | Время | --amount | Строка, Число | Затраченное время в секундах | - | Текст | --text | Строка | Текст комментария трудозатраты | - | ДатаУстановки | --date | Строка | Дата установки трудозатрат | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDЗадачи = "2454"; - IDЗаписи = "848"; - - Текст = "Забытый в прошлый раз текст"; - Время = 4800; - - Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Время, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDЗаписи = "850"; - - Текст = "Новые трудозатраты по обработке"; - Время = 4800; - ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); - - Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL - , IDЗадачи - , IDЗаписи - , Время - , Текст - , ДатаУстановки - , Токен); -``` - - - - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1728409781.9122, - "finish": 1728409781.96697, - "duration": 0.0547609329223633, - "processing": 0.0281291007995605, - "date_start": "2024-10-08T20:49:41+03:00", - "date_finish": "2024-10-08T20:49:41+03:00", - "operating_reset_at": 1728410381, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.mdx b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.mdx new file mode 100644 index 0000000000..5d4539c128 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Изменить трудозатраты задачи + Изменяет данные записи о трудозатратах задачи + + + +`Функция ИзменитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Время, Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Время | --amount | Строка, Число | Затраченное время в секундах | + | Текст | --text | Строка | Текст комментария трудозатраты | + | ДатаУстановки | --date | Строка | Дата установки трудозатрат | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDЗадачи = "2454"; + IDЗаписи = "848"; + + Текст = "Забытый в прошлый раз текст"; + Время = 4800; + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Время, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDЗаписи = "850"; + + Текст = "Новые трудозатраты по обработке"; + Время = 4800; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL + , IDЗадачи + , IDЗаписи + , Время + , Текст + , ДатаУстановки + , Токен); +``` + + + + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1728409781.9122, + "finish": 1728409781.96697, + "duration": 0.0547609329223633, + "processing": 0.0281291007995605, + "date_start": "2024-10-08T20:49:41+03:00", + "date_finish": "2024-10-08T20:49:41+03:00", + "operating_reset_at": 1728410381, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md deleted file mode 100644 index 430f7f0ff5..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Изменить статус пользователя - Активирует или деактивирует (увольняет) выбранного пользователя - - - -`Функция ИзменитьСтатусПользователя(Знач URL, Знач IDПользователя, Знач Уволить = Истина, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | - | Уволить | --fire | Булево | Истина > Деактивация, Ложь > Активация | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПользователя = "624"; - - Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = "626"; - - Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409878.24276, - "finish": 1728409878.484, - "duration": 0.241237878799438, - "processing": 0.21386194229126, - "date_start": "2024-10-08T20:51:18+03:00", - "date_finish": "2024-10-08T20:51:18+03:00", - "operating_reset_at": 1728410478, - "operating": 0.48527193069458 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Change-user-status.mdx b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.mdx new file mode 100644 index 0000000000..53ac7d6f5d --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Изменить статус пользователя + Активирует или деактивирует (увольняет) выбранного пользователя + + + +`Функция ИзменитьСтатусПользователя(Знач URL, Знач IDПользователя, Знач Уволить = Истина, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | + | Уволить | --fire | Булево | Истина > Деактивация, Ложь > Активация | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ + + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПользователя = "624"; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = "626"; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409878.24276, + "finish": 1728409878.484, + "duration": 0.241237878799438, + "processing": 0.21386194229126, + "date_start": "2024-10-08T20:51:18+03:00", + "date_finish": "2024-10-08T20:51:18+03:00", + "operating_reset_at": 1728410478, + "operating": 0.48527193069458 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Create-user.md b/docs/ru/md/Bitrix24/Users-managment/Create-user.md deleted file mode 100644 index bc220eaa05..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Create-user.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать пользователя - Создает нового пользователя по структуре полей - - - -`Функция СоздатьПользователя(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) - - Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID: [...] - - Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT: [...] -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("UF_DEPARTMENT", 7); - - Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("NAME" , "Виталий"); - СтруктураПользователя.Вставить("LAST_NAME" , "Альпака"); - СтруктураПользователя.Вставить("PERSONAL_MOBILE", "88003553535"); - СтруктураПользователя.Вставить("UF_DEPARTMENT" , 1); - - Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": 598, - "time": { - "start": 1728409874.69828, - "finish": 1728409876.61938, - "duration": 1.92110395431519, - "processing": 1.89232087135315, - "date_start": "2024-10-08T20:51:14+03:00", - "date_finish": "2024-10-08T20:51:16+03:00", - "operating_reset_at": 1728410474, - "operating": 1.89229583740234 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Create-user.mdx b/docs/ru/md/Bitrix24/Users-managment/Create-user.mdx new file mode 100644 index 0000000000..0d51b00c55 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Create-user.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать пользователя + Создает нового пользователя по структуре полей + + + +`Функция СоздатьПользователя(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) + + Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID: [...] + + Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT: [...] +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 7); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Виталий"); + СтруктураПользователя.Вставить("LAST_NAME" , "Альпака"); + СтруктураПользователя.Вставить("PERSONAL_MOBILE", "88003553535"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 1); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": 598, + "time": { + "start": 1728409874.69828, + "finish": 1728409876.61938, + "duration": 1.92110395431519, + "processing": 1.89232087135315, + "date_start": "2024-10-08T20:51:14+03:00", + "date_finish": "2024-10-08T20:51:16+03:00", + "operating_reset_at": 1728410474, + "operating": 1.89229583740234 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Find-users.md b/docs/ru/md/Bitrix24/Users-managment/Find-users.md deleted file mode 100644 index 692aa11873..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Find-users.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Найти пользователей - Получает список пользователей по заданному фильтру - - - -`Функция НайтиПользователей(Знач URL, Знач СтруктураФильтра, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураФильтра | --filter | Структура Из КлючИЗначение | Фильтр. См. ПолучитьСтруктуруФильтраПользователей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - СтруктураФильтра = Новый Структура; - СтруктураФильтра.Вставить("NAME" , "Виталий"); - СтруктураФильтра.Вставить("LAST_NAME" , "Альпака"); - СтруктураФильтра.Вставить("WORK_POSITION" , "DevOps инженер"); - СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Отдел маркетинга"); - СтруктураФильтра.Вставить("USER_TYPE" , "employee"); - - Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - СтруктураФильтра = Новый Структура; - СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Битрикс"); - - Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "12", - "XML_ID": "56479740", - "ACTIVE": true, - "NAME": "Bay", - "LAST_NAME": "Selonarrend", - "EMAIL": "oarismos@gmail.com", - "LAST_LOGIN": "2024-07-13T10:17:17+03:00", - "DATE_REGISTER": "2024-07-13T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "18", - "XML_ID": "56701916", - "ACTIVE": true, - "EMAIL": "hey@exepmple.com", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "34", - "XML_ID": "56702240", - "ACTIVE": false, - "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "38", - "XML_ID": "56702244", - "ACTIVE": false, - "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "42", - "XML_ID": "56702314", - "ACTIVE": true, - "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "46", - "XML_ID": "56702336", - "ACTIVE": false, - "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "50", - "XML_ID": "56702654", - "ACTIVE": false, - "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "54", - "XML_ID": "56721830", - "ACTIVE": false, - "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-29T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "58", - "XML_ID": "56731228", - "ACTIVE": false, - "EMAIL": "60de8e25-7175-44a5-9cdb-cd1fd6ac1e3b@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-30T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, -... -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Find-users.mdx b/docs/ru/md/Bitrix24/Users-managment/Find-users.mdx new file mode 100644 index 0000000000..a755fe7797 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Find-users.mdx @@ -0,0 +1,208 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Найти пользователей + Получает список пользователей по заданному фильтру + + + +`Функция НайтиПользователей(Знач URL, Знач СтруктураФильтра, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураФильтра | --filter | Структура Из КлючИЗначение | Фильтр. См. ПолучитьСтруктуруФильтраПользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("NAME" , "Виталий"); + СтруктураФильтра.Вставить("LAST_NAME" , "Альпака"); + СтруктураФильтра.Вставить("WORK_POSITION" , "DevOps инженер"); + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Отдел маркетинга"); + СтруктураФильтра.Вставить("USER_TYPE" , "employee"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Битрикс"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "12", + "XML_ID": "56479740", + "ACTIVE": true, + "NAME": "Bay", + "LAST_NAME": "Selonarrend", + "EMAIL": "oarismos@gmail.com", + "LAST_LOGIN": "2024-07-13T10:17:17+03:00", + "DATE_REGISTER": "2024-07-13T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "18", + "XML_ID": "56701916", + "ACTIVE": true, + "EMAIL": "hey@exepmple.com", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "34", + "XML_ID": "56702240", + "ACTIVE": false, + "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "38", + "XML_ID": "56702244", + "ACTIVE": false, + "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "42", + "XML_ID": "56702314", + "ACTIVE": true, + "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "46", + "XML_ID": "56702336", + "ACTIVE": false, + "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "50", + "XML_ID": "56702654", + "ACTIVE": false, + "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "54", + "XML_ID": "56721830", + "ACTIVE": false, + "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-29T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "58", + "XML_ID": "56731228", + "ACTIVE": false, + "EMAIL": "60de8e25-7175-44a5-9cdb-cd1fd6ac1e3b@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-30T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, +... +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md deleted file mode 100644 index e94af2ee78..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить текущего пользователя - Получает информацию о текущем пользователе - - - -`Функция ПолучитьТекущегоПользователя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "1", - "XML_ID": "53818298", - "ACTIVE": true, - "NAME": "Антон", - "LAST_NAME": "Титовец", - "EMAIL": "no-reply@bitrix24.com", - "LAST_LOGIN": "2024-09-17T21:21:38+03:00", - "DATE_REGISTER": "2024-02-10T03:00:00+03:00", - "IS_ONLINE": "N", - "TIME_ZONE_OFFSET": "0", - "TIMESTAMP_X": "29.08.2024 10:12:45", - "LAST_ACTIVITY_DATE": "2024-09-17 21:21:49", - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 264 - ] - }, - "time": { - "start": 1728409872.17317, - "finish": 1728409872.20787, - "duration": 0.0346920490264893, - "processing": 0.00322484970092773, - "date_start": "2024-10-08T20:51:12+03:00", - "date_finish": "2024-10-08T20:51:12+03:00", - "operating_reset_at": 1728410472, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-current-user.mdx b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.mdx new file mode 100644 index 0000000000..c02ad54fca --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить текущего пользователя + Получает информацию о текущем пользователе + + + +`Функция ПолучитьТекущегоПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Антон", + "LAST_NAME": "Титовец", + "EMAIL": "no-reply@bitrix24.com", + "LAST_LOGIN": "2024-09-17T21:21:38+03:00", + "DATE_REGISTER": "2024-02-10T03:00:00+03:00", + "IS_ONLINE": "N", + "TIME_ZONE_OFFSET": "0", + "TIMESTAMP_X": "29.08.2024 10:12:45", + "LAST_ACTIVITY_DATE": "2024-09-17 21:21:49", + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 264 + ] + }, + "time": { + "start": 1728409872.17317, + "finish": 1728409872.20787, + "duration": 0.0346920490264893, + "processing": 0.00322484970092773, + "date_start": "2024-10-08T20:51:12+03:00", + "date_finish": "2024-10-08T20:51:12+03:00", + "operating_reset_at": 1728410472, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md deleted file mode 100644 index 51d0b9526e..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить стурктуру пользователя - Получает структурау полей для создания или изменения пользователя - - - -`Функция ПолучитьСтурктуруПользователя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - - Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL, Токен); -``` - - - - -```json title="Результат" -{ - "result": { - "ID": "ID", - "XML_ID": "Внешний код", - "ACTIVE": "Активность", - "NAME": "Имя", - "LAST_NAME": "Фамилия", - "SECOND_NAME": "Отчество", - "TITLE": "Список пользователей", - "EMAIL": "E-Mail", - "LAST_LOGIN": "Последняя авторизация", - "DATE_REGISTER": "Дата регистрации", - "TIME_ZONE": "TIME_ZONE", - "IS_ONLINE": "IS_ONLINE", - "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", - "TIMESTAMP_X": "TIMESTAMP_X", - "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", - "PERSONAL_GENDER": "Пол", - "PERSONAL_PROFESSION": "Профессия", - "PERSONAL_WWW": "Домашняя страничка", - "PERSONAL_BIRTHDAY": "Дата рождения", - "PERSONAL_PHOTO": "Фотография", - "PERSONAL_ICQ": "ICQ", - "PERSONAL_PHONE": "Личный телефон", - "PERSONAL_FAX": "Факс", - "PERSONAL_MOBILE": "Личный мобильный", - "PERSONAL_PAGER": "Пейджер", - "PERSONAL_STREET": "Улица проживания", - "PERSONAL_CITY": "Город проживания", - "PERSONAL_STATE": "Область / край", - "PERSONAL_ZIP": "Почтовый индекс", - "PERSONAL_COUNTRY": "Страна", - "PERSONAL_MAILBOX": "Почтовый ящик", - "PERSONAL_NOTES": "Дополнительные заметки", - "WORK_PHONE": "Телефон компании", - "WORK_COMPANY": "Компания", - "WORK_POSITION": "Должность", - "WORK_DEPARTMENT": "Отдел", - "WORK_WWW": "Сайт компании", - "WORK_FAX": "WORK_FAX", - "WORK_PAGER": "WORK_PAGER", - "WORK_STREET": "WORK_STREET", - "WORK_MAILBOX": "WORK_MAILBOX", - "WORK_CITY": "Город работы", - "WORK_STATE": "WORK_STATE", - "WORK_ZIP": "WORK_ZIP", - "WORK_COUNTRY": "WORK_COUNTRY", - "WORK_PROFILE": "WORK_PROFILE", - "WORK_LOGO": "WORK_LOGO", - "WORK_NOTES": "WORK_NOTES", - "UF_SKYPE_LINK": "Ссылка на чат в Skype", - "UF_ZOOM": "Zoom", - "UF_EMPLOYMENT_DATE": "Дата принятия на работу", - "UF_TIMEMAN": "Учет рабочего времени", - "UF_DEPARTMENT": "Подразделения", - "UF_INTERESTS": "Интересы", - "UF_SKILLS": "Навыки", - "UF_WEB_SITES": "Другие сайты", - "UF_XING": "Xing", - "UF_LINKEDIN": "LinkedIn", - "UF_FACEBOOK": "Facebook", - "UF_TWITTER": "Twitter", - "UF_SKYPE": "Skype", - "UF_DISTRICT": "Район", - "UF_PHONE_INNER": "Внутренний телефон", - "USER_TYPE": "USER_TYPE" - }, - "time": { - "start": 1728409872.34177, - "finish": 1728409872.36962, - "duration": 0.0278530120849609, - "processing": 0.000756978988647461, - "date_start": "2024-10-08T20:51:12+03:00", - "date_finish": "2024-10-08T20:51:12+03:00", - "operating_reset_at": 1728410472, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.mdx b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.mdx new file mode 100644 index 0000000000..77942414f0 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.mdx @@ -0,0 +1,124 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить стурктуру пользователя + Получает структурау полей для создания или изменения пользователя + + + +`Функция ПолучитьСтурктуруПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL, Токен); +``` + + + + +```json title="Результат" +{ + "result": { + "ID": "ID", + "XML_ID": "Внешний код", + "ACTIVE": "Активность", + "NAME": "Имя", + "LAST_NAME": "Фамилия", + "SECOND_NAME": "Отчество", + "TITLE": "Список пользователей", + "EMAIL": "E-Mail", + "LAST_LOGIN": "Последняя авторизация", + "DATE_REGISTER": "Дата регистрации", + "TIME_ZONE": "TIME_ZONE", + "IS_ONLINE": "IS_ONLINE", + "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", + "TIMESTAMP_X": "TIMESTAMP_X", + "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", + "PERSONAL_GENDER": "Пол", + "PERSONAL_PROFESSION": "Профессия", + "PERSONAL_WWW": "Домашняя страничка", + "PERSONAL_BIRTHDAY": "Дата рождения", + "PERSONAL_PHOTO": "Фотография", + "PERSONAL_ICQ": "ICQ", + "PERSONAL_PHONE": "Личный телефон", + "PERSONAL_FAX": "Факс", + "PERSONAL_MOBILE": "Личный мобильный", + "PERSONAL_PAGER": "Пейджер", + "PERSONAL_STREET": "Улица проживания", + "PERSONAL_CITY": "Город проживания", + "PERSONAL_STATE": "Область / край", + "PERSONAL_ZIP": "Почтовый индекс", + "PERSONAL_COUNTRY": "Страна", + "PERSONAL_MAILBOX": "Почтовый ящик", + "PERSONAL_NOTES": "Дополнительные заметки", + "WORK_PHONE": "Телефон компании", + "WORK_COMPANY": "Компания", + "WORK_POSITION": "Должность", + "WORK_DEPARTMENT": "Отдел", + "WORK_WWW": "Сайт компании", + "WORK_FAX": "WORK_FAX", + "WORK_PAGER": "WORK_PAGER", + "WORK_STREET": "WORK_STREET", + "WORK_MAILBOX": "WORK_MAILBOX", + "WORK_CITY": "Город работы", + "WORK_STATE": "WORK_STATE", + "WORK_ZIP": "WORK_ZIP", + "WORK_COUNTRY": "WORK_COUNTRY", + "WORK_PROFILE": "WORK_PROFILE", + "WORK_LOGO": "WORK_LOGO", + "WORK_NOTES": "WORK_NOTES", + "UF_SKYPE_LINK": "Ссылка на чат в Skype", + "UF_ZOOM": "Zoom", + "UF_EMPLOYMENT_DATE": "Дата принятия на работу", + "UF_TIMEMAN": "Учет рабочего времени", + "UF_DEPARTMENT": "Подразделения", + "UF_INTERESTS": "Интересы", + "UF_SKILLS": "Навыки", + "UF_WEB_SITES": "Другие сайты", + "UF_XING": "Xing", + "UF_LINKEDIN": "LinkedIn", + "UF_FACEBOOK": "Facebook", + "UF_TWITTER": "Twitter", + "UF_SKYPE": "Skype", + "UF_DISTRICT": "Район", + "UF_PHONE_INNER": "Внутренний телефон", + "USER_TYPE": "USER_TYPE" + }, + "time": { + "start": 1728409872.34177, + "finish": 1728409872.36962, + "duration": 0.0278530120849609, + "processing": 0.000756978988647461, + "date_start": "2024-10-08T20:51:12+03:00", + "date_finish": "2024-10-08T20:51:12+03:00", + "operating_reset_at": 1728410472, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md deleted file mode 100644 index d3b560a7a4..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить структуру фильтра пользователей - Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей - - - -`Функция ПолучитьСтруктуруФильтраПользователей(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраПользователей(); -``` - - - - -```json title="Результат" -{ - "NAME": "<имя>", - "LAST_NAME": "<фамилия>", - "WORK_POSITION": "<должность>", - "UF_DEPARTMENT_NAME": "<название подразделения>", - "USER_TYPE": "<тип: employee, extranet, email>" -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.mdx b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.mdx new file mode 100644 index 0000000000..68f886808c --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить структуру фильтра пользователей + Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей + + + +`Функция ПолучитьСтруктуруФильтраПользователей(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраПользователей(); +``` + + + + +```json title="Результат" +{ + "NAME": "<имя>", + "LAST_NAME": "<фамилия>", + "WORK_POSITION": "<должность>", + "UF_DEPARTMENT_NAME": "<название подразделения>", + "USER_TYPE": "<тип: employee, extranet, email>" +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user.md b/docs/ru/md/Bitrix24/Users-managment/Get-user.md deleted file mode 100644 index d3acee43f7..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Get-user.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить пользователя - Получает информацию о пользователе по ID - - - -`Функция ПолучитьПользователя(Знач URL, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для получения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПользователя = "624"; - - Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = "626"; - - Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "ID": "598", - "XML_ID": "57973380", - "ACTIVE": true, - "NAME": "Олег", - "LAST_NAME": "Лама", - "EMAIL": "0ed2b5a4-59af-48aa-9083-2bb35cd4b32b@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-10-08T03:00:00+03:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_MOBILE": "88003553535", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 7 - ], - "USER_TYPE": "employee" - } - ], - "total": 1, - "time": { - "start": 1728409877.83328, - "finish": 1728409877.86985, - "duration": 0.0365738868713379, - "processing": 0.00977706909179688, - "date_start": "2024-10-08T20:51:17+03:00", - "date_finish": "2024-10-08T20:51:17+03:00", - "operating_reset_at": 1728410477, - "operating": 0 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user.mdx b/docs/ru/md/Bitrix24/Users-managment/Get-user.mdx new file mode 100644 index 0000000000..8dcbdc28be --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить пользователя + Получает информацию о пользователе по ID + + + +`Функция ПолучитьПользователя(Знач URL, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПользователя = "624"; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = "626"; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "ID": "598", + "XML_ID": "57973380", + "ACTIVE": true, + "NAME": "Олег", + "LAST_NAME": "Лама", + "EMAIL": "0ed2b5a4-59af-48aa-9083-2bb35cd4b32b@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-10-08T03:00:00+03:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_MOBILE": "88003553535", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 7 + ], + "USER_TYPE": "employee" + } + ], + "total": 1, + "time": { + "start": 1728409877.83328, + "finish": 1728409877.86985, + "duration": 0.0365738868713379, + "processing": 0.00977706909179688, + "date_start": "2024-10-08T20:51:17+03:00", + "date_finish": "2024-10-08T20:51:17+03:00", + "operating_reset_at": 1728410477, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Update-user.md b/docs/ru/md/Bitrix24/Users-managment/Update-user.md deleted file mode 100644 index befd69a377..0000000000 --- a/docs/ru/md/Bitrix24/Users-managment/Update-user.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Изменить пользователя - Изменяет данные пользователя - - - -`Функция ИзменитьПользователя(Знач URL, Знач IDПользователя, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; - IDПользователя = "624"; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - - // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("UF_DEPARTMENT", 1); - - Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "21750a67006e9f06006b12e400000001000..."; - IDПользователя = "626"; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("NAME" , "Олег"); - СтруктураПользователя.Вставить("LAST_NAME" , "Лама"); - СтруктураПользователя.Вставить("UF_DEPARTMENT" , 7); - - Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя, Токен); -``` - - - - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1728409877.3911, - "finish": 1728409877.68765, - "duration": 0.296542167663574, - "processing": 0.271466016769409, - "date_start": "2024-10-08T20:51:17+03:00", - "date_finish": "2024-10-08T20:51:17+03:00", - "operating_reset_at": 1728410477, - "operating": 0.271438837051392 - } -} -``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Update-user.mdx b/docs/ru/md/Bitrix24/Users-managment/Update-user.mdx new file mode 100644 index 0000000000..ffe6b1cd74 --- /dev/null +++ b/docs/ru/md/Bitrix24/Users-managment/Update-user.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Изменить пользователя + Изменяет данные пользователя + + + +`Функция ИзменитьПользователя(Знач URL, Знач IDПользователя, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2..."; + IDПользователя = "624"; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 1); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "21750a67006e9f06006b12e400000001000..."; + IDПользователя = "626"; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Олег"); + СтруктураПользователя.Вставить("LAST_NAME" , "Лама"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 7); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя, Токен); +``` + + + + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1728409877.3911, + "finish": 1728409877.68765, + "duration": 0.296542167663574, + "processing": 0.271466016769409, + "date_start": "2024-10-08T20:51:17+03:00", + "date_finish": "2024-10-08T20:51:17+03:00", + "operating_reset_at": 1728410477, + "operating": 0.271438837051392 + } +} +``` diff --git a/docs/ru/md/CDEK/Common-methods/Get-token.md b/docs/ru/md/CDEK/Common-methods/Get-token.md deleted file mode 100644 index 155212a43a..0000000000 --- a/docs/ru/md/CDEK/Common-methods/Get-token.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить токен - Получает токен на основе идентификатора аккаунта и пароля - - - -`Функция ПолучитьТокен(Знач Аккаунт, Знач Пароль, ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Аккаунт | --account | Строка | Идентификатор клиента (Account) | - | Пароль | --pass | Строка | Секретный ключ (Password) | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Авторизация клиентов](https://api-docs.cdek.ru/29923918.html) -::: -
- - -```bsl title="Пример кода" - Аккаунт = "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP"; - Пароль = "RmAmgvSgSl..."; - - Результат = OPI_CDEK.ПолучитьТокен(Аккаунт, Пароль, Истина); -``` - - - - -```json title="Результат" -{ - "error": "unauthorized", - "error_description": "Full authentication is required to access this resource" -} -``` diff --git a/docs/ru/md/CDEK/Common-methods/Get-token.mdx b/docs/ru/md/CDEK/Common-methods/Get-token.mdx new file mode 100644 index 0000000000..d2daf8ae1c --- /dev/null +++ b/docs/ru/md/CDEK/Common-methods/Get-token.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить токен + Получает токен на основе идентификатора аккаунта и пароля + + + +`Функция ПолучитьТокен(Знач Аккаунт, Знач Пароль, ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Аккаунт | --account | Строка | Идентификатор клиента (Account) | + | Пароль | --pass | Строка | Секретный ключ (Password) | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Авторизация клиентов](https://api-docs.cdek.ru/29923918.html) +::: +
+ + +```bsl title="Пример кода" + Аккаунт = "wqGwiQx0gg8mLtiEKsUinjVSICCjtTEP"; + Пароль = "RmAmgvSgSl..."; + + Результат = OPI_CDEK.ПолучитьТокен(Аккаунт, Пароль, Истина); +``` + + + + +```json title="Результат" +{ + "error": "unauthorized", + "error_description": "Full authentication is required to access this resource" +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Create-customer-refund.md b/docs/ru/md/CDEK/Orders-managment/Create-customer-refund.md deleted file mode 100644 index 1fb3303e6a..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Create-customer-refund.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Оформить клиентский возврат - Оформляет клиентский возврат для заказа интернет магазина - - - -`Функция ОформитьКлиентскийВозврат(Знач Токен, Знач UUID, Знач Тариф, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | UUID | --uuid | Строка | UUID заказа | - | Тариф | --tariff | Число | Код тарифа (из доступных по договору) | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Этот метод используется в случае, если прямой заказ доставлялся СДЭК и получатель хочет вернуть его полностью - - Если заказ доставлялся другой службой, либо нужно вернуть не все товары, то необходимо использовать метод СоздатьЗаказ с is_client_return = true - - Метод в документации API: [Клиентские возвраты](https://api-docs.cdek.ru/122762174.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - Тариф = 139; - - Результат = OPI_CDEK.ОформитьКлиентскийВозврат(Токен, UUID, Тариф, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" - }, - "requests": [ - { - "request_uuid": "208237e4-76ef-4d3e-84b5-f6009d0af12d", - "type": "CREATE_CLIENT_RETURN", - "date_time": "2024-10-12T17:43:55+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Create-customer-refund.mdx b/docs/ru/md/CDEK/Orders-managment/Create-customer-refund.mdx new file mode 100644 index 0000000000..d0bc2ff567 --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Create-customer-refund.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Оформить клиентский возврат + Оформляет клиентский возврат для заказа интернет магазина + + + +`Функция ОформитьКлиентскийВозврат(Знач Токен, Знач UUID, Знач Тариф, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | UUID | --uuid | Строка | UUID заказа | + | Тариф | --tariff | Число | Код тарифа (из доступных по договору) | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Этот метод используется в случае, если прямой заказ доставлялся СДЭК и получатель хочет вернуть его полностью + + Если заказ доставлялся другой службой, либо нужно вернуть не все товары, то необходимо использовать метод СоздатьЗаказ с is_client_return = true + + Метод в документации API: [Клиентские возвраты](https://api-docs.cdek.ru/122762174.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + Тариф = 139; + + Результат = OPI_CDEK.ОформитьКлиентскийВозврат(Токен, UUID, Тариф, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" + }, + "requests": [ + { + "request_uuid": "208237e4-76ef-4d3e-84b5-f6009d0af12d", + "type": "CREATE_CLIENT_RETURN", + "date_time": "2024-10-12T17:43:55+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Create-order.md b/docs/ru/md/CDEK/Orders-managment/Create-order.md deleted file mode 100644 index 00f5107503..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Create-order.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать заказ - Создает заказ по описанию полей - - - -`Функция СоздатьЗаказ(Знач Токен, Знач ОписаниеЗаказа, Знач ИнтернетМагазин = Ложь, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | ОписаниеЗаказа | --order | Структура Из КлючИЗначение | Набор полей заказа. См. ПолучитьОписаниеЗаказа | - | ИнтернетМагазин | --ostore | Булево | Признак типа заказа Интернет магазин | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Регистрация заказа](https://api-docs.cdek.ru/29923926.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - - ОписаниеЗаказа = Новый Структура; - - ЛокацияОтправления = Новый Структура; - ЛокацияОтправления.Вставить("code" , "44"); - ЛокацияОтправления.Вставить("city" , "Москва"); - ЛокацияОтправления.Вставить("address", "пр. Ленинградский, д.4"); - - ЛокацияНазначения = Новый Структура; - ЛокацияНазначения.Вставить("code" , "270"); - ЛокацияНазначения.Вставить("city" , "Новосибирск"); - ЛокацияНазначения.Вставить("address", "ул. Блюхера, 32"); - - Получатель = Новый Структура; - - Телефоны = Новый Массив; - Телефоны.Добавить(Новый Структура("number", "+79134637228")); - - Получатель.Вставить("phones", Телефоны); - Получатель.Вставить("name" , "Иванов Иван"); - - Отправитель = Новый Структура("name", "Петров Петр"); - - Услуги = Новый Массив; - - Услуга = Новый Структура; - Услуга.Вставить("code" , "SECURE_PACKAGE_A2"); - Услуга.Вставить("parameter", 10); - - Услуги.Добавить(Услуга); - - Пакеты = Новый Массив; - - Пакет = Новый Структура; - - Позиции = Новый Массив; - - Позиция = Новый Структура; - - Оплата = Новый Структура; - Оплата.Вставить("value", 3000); - - Позиция.Вставить("payment" , Оплата); - Позиция.Вставить("ware_key", "00055"); - Позиция.Вставить("name" , "Товар"); - Позиция.Вставить("cost" , 300); - Позиция.Вставить("amount" , 2); - Позиция.Вставить("weight" , 700); - Позиция.Вставить("url" , "www.item.ru"); - - Позиции.Добавить(Позиция); - - Пакет.Вставить("items" , Позиции); - Пакет.Вставить("number" , "bar-001"); - Пакет.Вставить("comment", "Упаковка"); - Пакет.Вставить("height" , 10); - Пакет.Вставить("length" , 10); - Пакет.Вставить("weight" , "4000"); - Пакет.Вставить("width" , 10); - - Пакеты.Добавить(Пакет); - - ОписаниеЗаказа.Вставить("from_location", ЛокацияОтправления); - ОписаниеЗаказа.Вставить("to_location" , ЛокацияНазначения); - ОписаниеЗаказа.Вставить("packages" , Пакеты); - ОписаниеЗаказа.Вставить("recipient" , Получатель); - ОписаниеЗаказа.Вставить("sender" , Отправитель); - ОписаниеЗаказа.Вставить("services" , Услуги); - - ОписаниеЗаказа.Вставить("number" , "ddOererre7450813980068"); - ОписаниеЗаказа.Вставить("comment" , "Новый заказ"); - ОписаниеЗаказа.Вставить("tariff_code", 139); - - ОписаниеЗаказа.Вставить("delivery_recipient_cost" , Новый Структура("value" , 50)); - ОписаниеЗаказа.Вставить("delivery_recipient_cost_adv", Новый Структура("sum,threshold", 3000, 200)); - - Результат = OPI_CDEK.СоздатьЗаказ(Токен, ОписаниеЗаказа, Истина, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" - }, - "requests": [ - { - "request_uuid": "8f4e5a29-7954-4f53-9b87-f8fe7573345e", - "type": "CREATE", - "date_time": "2024-10-12T17:43:53+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Create-order.mdx b/docs/ru/md/CDEK/Orders-managment/Create-order.mdx new file mode 100644 index 0000000000..c58f5ff5ff --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Create-order.mdx @@ -0,0 +1,132 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать заказ + Создает заказ по описанию полей + + + +`Функция СоздатьЗаказ(Знач Токен, Знач ОписаниеЗаказа, Знач ИнтернетМагазин = Ложь, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | ОписаниеЗаказа | --order | Структура Из КлючИЗначение | Набор полей заказа. См. ПолучитьОписаниеЗаказа | + | ИнтернетМагазин | --ostore | Булево | Признак типа заказа Интернет магазин | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Регистрация заказа](https://api-docs.cdek.ru/29923926.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + + ОписаниеЗаказа = Новый Структура; + + ЛокацияОтправления = Новый Структура; + ЛокацияОтправления.Вставить("code" , "44"); + ЛокацияОтправления.Вставить("city" , "Москва"); + ЛокацияОтправления.Вставить("address", "пр. Ленинградский, д.4"); + + ЛокацияНазначения = Новый Структура; + ЛокацияНазначения.Вставить("code" , "270"); + ЛокацияНазначения.Вставить("city" , "Новосибирск"); + ЛокацияНазначения.Вставить("address", "ул. Блюхера, 32"); + + Получатель = Новый Структура; + + Телефоны = Новый Массив; + Телефоны.Добавить(Новый Структура("number", "+79134637228")); + + Получатель.Вставить("phones", Телефоны); + Получатель.Вставить("name" , "Иванов Иван"); + + Отправитель = Новый Структура("name", "Петров Петр"); + + Услуги = Новый Массив; + + Услуга = Новый Структура; + Услуга.Вставить("code" , "SECURE_PACKAGE_A2"); + Услуга.Вставить("parameter", 10); + + Услуги.Добавить(Услуга); + + Пакеты = Новый Массив; + + Пакет = Новый Структура; + + Позиции = Новый Массив; + + Позиция = Новый Структура; + + Оплата = Новый Структура; + Оплата.Вставить("value", 3000); + + Позиция.Вставить("payment" , Оплата); + Позиция.Вставить("ware_key", "00055"); + Позиция.Вставить("name" , "Товар"); + Позиция.Вставить("cost" , 300); + Позиция.Вставить("amount" , 2); + Позиция.Вставить("weight" , 700); + Позиция.Вставить("url" , "www.item.ru"); + + Позиции.Добавить(Позиция); + + Пакет.Вставить("items" , Позиции); + Пакет.Вставить("number" , "bar-001"); + Пакет.Вставить("comment", "Упаковка"); + Пакет.Вставить("height" , 10); + Пакет.Вставить("length" , 10); + Пакет.Вставить("weight" , "4000"); + Пакет.Вставить("width" , 10); + + Пакеты.Добавить(Пакет); + + ОписаниеЗаказа.Вставить("from_location", ЛокацияОтправления); + ОписаниеЗаказа.Вставить("to_location" , ЛокацияНазначения); + ОписаниеЗаказа.Вставить("packages" , Пакеты); + ОписаниеЗаказа.Вставить("recipient" , Получатель); + ОписаниеЗаказа.Вставить("sender" , Отправитель); + ОписаниеЗаказа.Вставить("services" , Услуги); + + ОписаниеЗаказа.Вставить("number" , "ddOererre7450813980068"); + ОписаниеЗаказа.Вставить("comment" , "Новый заказ"); + ОписаниеЗаказа.Вставить("tariff_code", 139); + + ОписаниеЗаказа.Вставить("delivery_recipient_cost" , Новый Структура("value" , 50)); + ОписаниеЗаказа.Вставить("delivery_recipient_cost_adv", Новый Структура("sum,threshold", 3000, 200)); + + Результат = OPI_CDEK.СоздатьЗаказ(Токен, ОписаниеЗаказа, Истина, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" + }, + "requests": [ + { + "request_uuid": "8f4e5a29-7954-4f53-9b87-f8fe7573345e", + "type": "CREATE", + "date_time": "2024-10-12T17:43:53+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Create-refusal.md b/docs/ru/md/CDEK/Orders-managment/Create-refusal.md deleted file mode 100644 index e1cf195ac0..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Create-refusal.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Создать отказ - Создает отказ по заказу для возврата в интернет магазин - - - -`Функция СоздатьОтказ(Знач Токен, Знач UUID, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | UUID | --uuid | Строка | UUID заказа | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Регистрация отказа](https://api-docs.cdek.ru/55327658.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - Результат = OPI_CDEK.СоздатьОтказ(Токен, UUID, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" - }, - "requests": [ - { - "request_uuid": "c70f239c-26a1-4835-9a21-b52b322671cb", - "type": "CREATE_REFUSAL", - "date_time": "2024-10-12T17:43:55+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Create-refusal.mdx b/docs/ru/md/CDEK/Orders-managment/Create-refusal.mdx new file mode 100644 index 0000000000..38ac4f4f6e --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Create-refusal.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Создать отказ + Создает отказ по заказу для возврата в интернет магазин + + + +`Функция СоздатьОтказ(Знач Токен, Знач UUID, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | UUID | --uuid | Строка | UUID заказа | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Регистрация отказа](https://api-docs.cdek.ru/55327658.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + Результат = OPI_CDEK.СоздатьОтказ(Токен, UUID, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" + }, + "requests": [ + { + "request_uuid": "c70f239c-26a1-4835-9a21-b52b322671cb", + "type": "CREATE_REFUSAL", + "date_time": "2024-10-12T17:43:55+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Delete-order.md b/docs/ru/md/CDEK/Orders-managment/Delete-order.md deleted file mode 100644 index 5280177bd3..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Delete-order.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить заказ - Удаляет заказ по UUID - - - -`Функция УдалитьЗаказ(Знач Токен, Знач UUID, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | UUID | --uuid | Строка | UUID заказа для удаления | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Удаление заказа](https://api-docs.cdek.ru/29924487.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - Результат = OPI_CDEK.УдалитьЗаказ(Токен, UUID, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" - }, - "requests": [ - { - "request_uuid": "b3fbf492-88b0-4cfe-8537-5958cfe0589d", - "type": "DELETE", - "date_time": "2024-10-12T17:43:55+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Delete-order.mdx b/docs/ru/md/CDEK/Orders-managment/Delete-order.mdx new file mode 100644 index 0000000000..9b4d9d1e14 --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Delete-order.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить заказ + Удаляет заказ по UUID + + + +`Функция УдалитьЗаказ(Знач Токен, Знач UUID, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | UUID | --uuid | Строка | UUID заказа для удаления | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Удаление заказа](https://api-docs.cdek.ru/29924487.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + Результат = OPI_CDEK.УдалитьЗаказ(Токен, UUID, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" + }, + "requests": [ + { + "request_uuid": "b3fbf492-88b0-4cfe-8537-5958cfe0589d", + "type": "DELETE", + "date_time": "2024-10-12T17:43:55+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Get-order-by-number.md b/docs/ru/md/CDEK/Orders-managment/Get-order-by-number.md deleted file mode 100644 index 947b375c12..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Get-order-by-number.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить заказ по номеру - Получает заказ по номеру СДЭК или внутреннему номеру клиента - - - -`Функция ПолучитьЗаказПоНомеру(Знач Токен, Знач НомерЗаказа, Знач Внутренний = Ложь, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | НомерЗаказа | --number | Строка | Номер заказа | - | Внутренний | --internal | Булево | Вид номера заказа. Истина > номер в базе клиента, Ложь > номер СДЭК | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Информация о заказе](https://api-docs.cdek.ru/29923975.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - - НомерЗаказа = "ddOererre7450813980068"; - Результат = OPI_CDEK.ПолучитьЗаказПоНомеру(Токен, НомерЗаказа, Истина, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f", - "type": 1, - "is_return": false, - "is_reverse": false, - "number": "ddOererre7450813980068", - "tariff_code": 139, - "comment": "Новый заказ", - "delivery_recipient_cost": { - "value": 50 - }, - "delivery_recipient_cost_adv": [ - { - "threshold": 200, - "sum": 3000 - } - ], - "sender": { - "name": "Петров Петр", - "passport_requirements_satisfied": false - }, - "seller": { - "name": "Тестирование Интеграции ИМ" - }, - "recipient": { - "name": "Иванов Иван", - "phones": [ - { - "number": "+79134637228" - } - ], - "passport_requirements_satisfied": false - }, - "from_location": { - "code": 44, - "city_uuid": "7e8f36ba-d937-4ce4-8d53-e44177db6469", - "city": "Москва", - "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", - "kladr_code": "7700000000000", - "country_code": "RU", - "country": "Россия", - "region": "Москва", - "region_code": 81, - "sub_region": "Москва", - "longitude": 37.61556, - "latitude": 55.75222, - "address": "пр. Ленинградский, д.4" - }, - "to_location": { - "code": 270, - "city_uuid": "4e938d63-e189-454d-bb5c-54bfb2f1e4e2", - "city": "Новосибирск", - "kladr_code": "5400000100000", - "country_code": "RU", - "country": "Россия", - "region": "Новосибирская область", - "region_code": 23, - "sub_region": "городской округ Новосибирск", - "longitude": 82.906928, - "latitude": 55.028739, - "address": "ул. Блюхера, 32" - }, - "services": [ - { - "code": "SECURE_PACKAGE_A2", - "parameter": "10" - } - ], - "packages": [ - { - "number": "bar-001", - "weight": 4000, - "length": 10, - "width": 10, - "height": 10, - "comment": "Упаковка", - "items": [ - { - "name": "Товар", - "ware_key": "00055", - "payment": { - "value": 3000 - }, - "weight": 700, - "amount": 2, - "url": "www.item.ru", - "return_item_detail": {}, - "excise": false, - "cost": 300 - } - ] - } - ], - "statuses": [ - { - "code": "ACCEPTED", - "name": "Принят", - "date_time": "2024-10-12T17:43:53+03:00", - "city": "Офис СДЭК" - } - ], - "is_client_return": false, - "delivery_detail": { - "total_sum": 0, - "payment_info": [] - }, - "calls": {} - }, - "requests": [ - { - "request_uuid": "8f4e5a29-7954-4f53-9b87-f8fe7573345e", - "type": "CREATE", - "date_time": "2024-10-12T17:43:53+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Get-order-by-number.mdx b/docs/ru/md/CDEK/Orders-managment/Get-order-by-number.mdx new file mode 100644 index 0000000000..9ec099d57d --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Get-order-by-number.mdx @@ -0,0 +1,163 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить заказ по номеру + Получает заказ по номеру СДЭК или внутреннему номеру клиента + + + +`Функция ПолучитьЗаказПоНомеру(Знач Токен, Знач НомерЗаказа, Знач Внутренний = Ложь, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | НомерЗаказа | --number | Строка | Номер заказа | + | Внутренний | --internal | Булево | Вид номера заказа. Истина > номер в базе клиента, Ложь > номер СДЭК | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Информация о заказе](https://api-docs.cdek.ru/29923975.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + + НомерЗаказа = "ddOererre7450813980068"; + Результат = OPI_CDEK.ПолучитьЗаказПоНомеру(Токен, НомерЗаказа, Истина, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f", + "type": 1, + "is_return": false, + "is_reverse": false, + "number": "ddOererre7450813980068", + "tariff_code": 139, + "comment": "Новый заказ", + "delivery_recipient_cost": { + "value": 50 + }, + "delivery_recipient_cost_adv": [ + { + "threshold": 200, + "sum": 3000 + } + ], + "sender": { + "name": "Петров Петр", + "passport_requirements_satisfied": false + }, + "seller": { + "name": "Тестирование Интеграции ИМ" + }, + "recipient": { + "name": "Иванов Иван", + "phones": [ + { + "number": "+79134637228" + } + ], + "passport_requirements_satisfied": false + }, + "from_location": { + "code": 44, + "city_uuid": "7e8f36ba-d937-4ce4-8d53-e44177db6469", + "city": "Москва", + "fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", + "kladr_code": "7700000000000", + "country_code": "RU", + "country": "Россия", + "region": "Москва", + "region_code": 81, + "sub_region": "Москва", + "longitude": 37.61556, + "latitude": 55.75222, + "address": "пр. Ленинградский, д.4" + }, + "to_location": { + "code": 270, + "city_uuid": "4e938d63-e189-454d-bb5c-54bfb2f1e4e2", + "city": "Новосибирск", + "kladr_code": "5400000100000", + "country_code": "RU", + "country": "Россия", + "region": "Новосибирская область", + "region_code": 23, + "sub_region": "городской округ Новосибирск", + "longitude": 82.906928, + "latitude": 55.028739, + "address": "ул. Блюхера, 32" + }, + "services": [ + { + "code": "SECURE_PACKAGE_A2", + "parameter": "10" + } + ], + "packages": [ + { + "number": "bar-001", + "weight": 4000, + "length": 10, + "width": 10, + "height": 10, + "comment": "Упаковка", + "items": [ + { + "name": "Товар", + "ware_key": "00055", + "payment": { + "value": 3000 + }, + "weight": 700, + "amount": 2, + "url": "www.item.ru", + "return_item_detail": {}, + "excise": false, + "cost": 300 + } + ] + } + ], + "statuses": [ + { + "code": "ACCEPTED", + "name": "Принят", + "date_time": "2024-10-12T17:43:53+03:00", + "city": "Офис СДЭК" + } + ], + "is_client_return": false, + "delivery_detail": { + "total_sum": 0, + "payment_info": [] + }, + "calls": {} + }, + "requests": [ + { + "request_uuid": "8f4e5a29-7954-4f53-9b87-f8fe7573345e", + "type": "CREATE", + "date_time": "2024-10-12T17:43:53+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Get-order-description.md b/docs/ru/md/CDEK/Orders-managment/Get-order-description.md deleted file mode 100644 index a216a88ef0..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Get-order-description.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить описание заказа - Получает макет для создания заказа в функции СоздатьЗаказ - - - -`Функция ПолучитьОписаниеЗаказа(Знач Пустая = Ложь, Знач ТолькоОбязательные = Ложь, Знач ИнтернетМагазин = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - | ТолькоОбязательные | --required | Булево | Истина > в макете будут только обязательные поля | - | ИнтернетМагазин | --ostore | Булево | Признак включения в макет полей исключительно для заказо Интернет магазина | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- -:::tip -Обязательность реквизитов может зависить от типа зказа или вложенности. Обязательно ознакомьтесь с документацией CDEK - - Описания полей в документации: [Регистрация заказа](https://api-docs.cdek.ru/29923926.html) -::: -
- - -```bsl title="Пример кода" - Результат = OPI_CDEK.ПолучитьОписаниеЗаказа(); -``` - - - - -```json title="Результат" -{ - "tariff_code": "<Код тарифа (подробнее см. приложение 1)>", - "recipient": { - "company": "<Название компании>", - "name": "<ФИО контактного лица>", - "passport_series": "<Серия паспорта>", - "passport_number": "<Номер паспорта>", - "passport_date_of_issue": "<Дата выдачи паспорта>", - "passport_organization": "<Орган выдачи паспорта>", - "tin": "<ИНН>", - "passport_date_of_birth": "<Дата рождения>", - "email": "", - "contragent_type": "<Тип отправителя: LEGAL_ENTITY, INDIVIDUAL >", - "phones": [ - { - "number": "<Номер телефона>", - "additional": "<Дополнительная информация (добавочный номер)>" - } - ] - }, - "packages": [ - { - "number": "<Номер упаковки>", - "weight": "<Общий вес (в граммах)>", - "length": "<Габариты упаковки. Длина (в сантиметрах)>", - "width": "<Габариты упаковки. Ширина (в сантиметрах)>", - "height": "<Габариты упаковки. Высота (в сантиметрах)>", - "comment": "<Комментарий к упаковке>", - "items": [ - { - "name": "<Наименование товара>", - "ware_key": "<Идентификатор/артикул товара>", - "marking": "<Маркировка товара>", - "payment": { - "value": "<Сумма наложенного платежа, в том числе и НДС>", - "vat_sum": "<Сумма НДС>", - "vat_rate": "<Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС)>" - }, - "cost": "<Объявленная стоимость товара>", - "weight": "<Вес (за единицу товара, в граммах)>", - "weight_gross": "<Вес брутто>", - "amount": "<Количество единиц товара (в штуках)>", - "name_i18n": "<Наименование на иностранном языке>", - "brand": "<Бренд на иностранном языке>", - "country_code": "<Код страны производителя товара ISO_3166-1_alpha-2>", - "material": "<Код материала>", - "wifi_gsm": "<Содержит wifi или gsm>", - "url": "<Ссылка на сайт интернет-магазина с описанием товара>" - } - ] - } - ], - "additional_order_types": "<Дополнительный тип заказа>", - "comment": "<Комментарий к заказу>", - "developer_key": "<Ключ разработчика (для разработчиков модулей)>", - "shipment_point": "<Код ПВЗ СДЭК для самостоятельного привоза клиентом>", - "delivery_point": "<Код офиса СДЭК, на который будет доставлена посылка>", - "date_invoice": "<Дата инвойса>", - "shipper_name": "<Грузоотправитель>", - "shipper_address": "<Адрес грузоотправителя>", - "sender": { - "company": "<Название компании>", - "name": "<ФИО контактного лица>", - "email": "", - "passport_series": "<Серия паспорта>", - "passport_number": "<Номер паспорта>", - "passport_date_of_issue": "<Дата выдачи паспорта>", - "passport_organization": "<Орган выдачи паспорта>", - "tin": "<ИНН>", - "passport_date_of_birth": "<Дата рождения>", - "contragent_type": "<Тип отправителя: LEGAL_ENTITY, INDIVIDUAL >", - "phones": [ - { - "number": "<Номер телефона>", - "additional": "<Дополнительная информация (добавочный номер)>" - } - ] - }, - "from_location": { - "code": "<Код населенного пункта СДЭК>", - "fias_guid": "<Уникальный идентификатор ФИАС>", - "postal_code": "<Почтовый индекс>", - "longitude": "<Долгота>", - "latitude": "<Широта>", - "country_code": "<Код страны в формате ISO_3166-1_alpha-2>", - "region": "<Название региона, уточняющий параметр для поля city>", - "region_code": "<Код региона СДЭК, уточняющий параметр для поля city>", - "sub_region": "<Название района региона, уточняющий параметр для поля region>", - "city": "<Название города, уточняющий параметр для postal_code>", - "kladr_code": "<Код КЛАДР>", - "address": "<Строка адреса >" - }, - "to_location": { - "code": "<Код населенного пункта СДЭК>", - "fias_guid": "<Уникальный идентификатор ФИАС>", - "postal_code": "<Почтовый индекс>", - "longitude": "<Долгота>", - "latitude": "<Широта>", - "country_code": "<Код страны в формате ISO_3166-1_alpha-2>", - "region": "<Название региона, уточняющий параметр для поля city>", - "region_code": "<Код региона СДЭК, уточняющий параметр для поля city>", - "sub_region": "<Название района региона, уточняющий параметр для поля region>", - "city": "<Название города, уточняющий параметр для postal_code>", - "kladr_code": "<Код КЛАДР>", - "address": "<Строка адреса >" - }, - "services": { - "code": "<Тип дополнительной услуги>", - "parameter": "<Параметр дополнительной услуги>" - }, - "print": "<Необходимость сформировать печатную форму>", - "is_client_return": "<Клиентский возврат>", - "accompanying_number": "<Номер сопроводительной накладной>", - "widget_token": "<Токен, полученный от widget.cdek.ru>" -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Get-order-description.mdx b/docs/ru/md/CDEK/Orders-managment/Get-order-description.mdx new file mode 100644 index 0000000000..8cc3117160 --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Get-order-description.mdx @@ -0,0 +1,157 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить описание заказа + Получает макет для создания заказа в функции СоздатьЗаказ + + + +`Функция ПолучитьОписаниеЗаказа(Знач Пустая = Ложь, Знач ТолькоОбязательные = Ложь, Знач ИнтернетМагазин = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + | ТолькоОбязательные | --required | Булево | Истина > в макете будут только обязательные поля | + | ИнтернетМагазин | --ostore | Булево | Признак включения в макет полей исключительно для заказо Интернет магазина | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ +:::tip +Обязательность реквизитов может зависить от типа зказа или вложенности. Обязательно ознакомьтесь с документацией CDEK + + Описания полей в документации: [Регистрация заказа](https://api-docs.cdek.ru/29923926.html) +::: +
+ + +```bsl title="Пример кода" + Результат = OPI_CDEK.ПолучитьОписаниеЗаказа(); +``` + + + + +```json title="Результат" +{ + "tariff_code": "<Код тарифа (подробнее см. приложение 1)>", + "recipient": { + "company": "<Название компании>", + "name": "<ФИО контактного лица>", + "passport_series": "<Серия паспорта>", + "passport_number": "<Номер паспорта>", + "passport_date_of_issue": "<Дата выдачи паспорта>", + "passport_organization": "<Орган выдачи паспорта>", + "tin": "<ИНН>", + "passport_date_of_birth": "<Дата рождения>", + "email": "", + "contragent_type": "<Тип отправителя: LEGAL_ENTITY, INDIVIDUAL >", + "phones": [ + { + "number": "<Номер телефона>", + "additional": "<Дополнительная информация (добавочный номер)>" + } + ] + }, + "packages": [ + { + "number": "<Номер упаковки>", + "weight": "<Общий вес (в граммах)>", + "length": "<Габариты упаковки. Длина (в сантиметрах)>", + "width": "<Габариты упаковки. Ширина (в сантиметрах)>", + "height": "<Габариты упаковки. Высота (в сантиметрах)>", + "comment": "<Комментарий к упаковке>", + "items": [ + { + "name": "<Наименование товара>", + "ware_key": "<Идентификатор/артикул товара>", + "marking": "<Маркировка товара>", + "payment": { + "value": "<Сумма наложенного платежа, в том числе и НДС>", + "vat_sum": "<Сумма НДС>", + "vat_rate": "<Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС)>" + }, + "cost": "<Объявленная стоимость товара>", + "weight": "<Вес (за единицу товара, в граммах)>", + "weight_gross": "<Вес брутто>", + "amount": "<Количество единиц товара (в штуках)>", + "name_i18n": "<Наименование на иностранном языке>", + "brand": "<Бренд на иностранном языке>", + "country_code": "<Код страны производителя товара ISO_3166-1_alpha-2>", + "material": "<Код материала>", + "wifi_gsm": "<Содержит wifi или gsm>", + "url": "<Ссылка на сайт интернет-магазина с описанием товара>" + } + ] + } + ], + "additional_order_types": "<Дополнительный тип заказа>", + "comment": "<Комментарий к заказу>", + "developer_key": "<Ключ разработчика (для разработчиков модулей)>", + "shipment_point": "<Код ПВЗ СДЭК для самостоятельного привоза клиентом>", + "delivery_point": "<Код офиса СДЭК, на который будет доставлена посылка>", + "date_invoice": "<Дата инвойса>", + "shipper_name": "<Грузоотправитель>", + "shipper_address": "<Адрес грузоотправителя>", + "sender": { + "company": "<Название компании>", + "name": "<ФИО контактного лица>", + "email": "", + "passport_series": "<Серия паспорта>", + "passport_number": "<Номер паспорта>", + "passport_date_of_issue": "<Дата выдачи паспорта>", + "passport_organization": "<Орган выдачи паспорта>", + "tin": "<ИНН>", + "passport_date_of_birth": "<Дата рождения>", + "contragent_type": "<Тип отправителя: LEGAL_ENTITY, INDIVIDUAL >", + "phones": [ + { + "number": "<Номер телефона>", + "additional": "<Дополнительная информация (добавочный номер)>" + } + ] + }, + "from_location": { + "code": "<Код населенного пункта СДЭК>", + "fias_guid": "<Уникальный идентификатор ФИАС>", + "postal_code": "<Почтовый индекс>", + "longitude": "<Долгота>", + "latitude": "<Широта>", + "country_code": "<Код страны в формате ISO_3166-1_alpha-2>", + "region": "<Название региона, уточняющий параметр для поля city>", + "region_code": "<Код региона СДЭК, уточняющий параметр для поля city>", + "sub_region": "<Название района региона, уточняющий параметр для поля region>", + "city": "<Название города, уточняющий параметр для postal_code>", + "kladr_code": "<Код КЛАДР>", + "address": "<Строка адреса >" + }, + "to_location": { + "code": "<Код населенного пункта СДЭК>", + "fias_guid": "<Уникальный идентификатор ФИАС>", + "postal_code": "<Почтовый индекс>", + "longitude": "<Долгота>", + "latitude": "<Широта>", + "country_code": "<Код страны в формате ISO_3166-1_alpha-2>", + "region": "<Название региона, уточняющий параметр для поля city>", + "region_code": "<Код региона СДЭК, уточняющий параметр для поля city>", + "sub_region": "<Название района региона, уточняющий параметр для поля region>", + "city": "<Название города, уточняющий параметр для postal_code>", + "kladr_code": "<Код КЛАДР>", + "address": "<Строка адреса >" + }, + "services": { + "code": "<Тип дополнительной услуги>", + "parameter": "<Параметр дополнительной услуги>" + }, + "print": "<Необходимость сформировать печатную форму>", + "is_client_return": "<Клиентский возврат>", + "accompanying_number": "<Номер сопроводительной накладной>", + "widget_token": "<Токен, полученный от widget.cdek.ru>" +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Get-order.md b/docs/ru/md/CDEK/Orders-managment/Get-order.md deleted file mode 100644 index a4d452ead0..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Get-order.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить заказ - Получает заказ по UUID - - - -`Функция ПолучитьЗаказ(Знач Токен, Знач UUID, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | UUID | --uuid | Строка | UUID заказа | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Информация о заказе](https://api-docs.cdek.ru/29923975.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - Результат = OPI_CDEK.ПолучитьЗаказ(Токен, UUID, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f", - "type": 1, - "number": "ddOererre7450813980068", - "tariff_code": 139, - "comment": "Новый заказ", - "delivery_recipient_cost": { - "value": 50 - }, - "delivery_recipient_cost_adv": [ - { - "threshold": 200, - "sum": 3000 - } - ], - "sender": { - "name": "Петров Петр" - }, - "recipient": { - "name": "Иванов Иван", - "phones": [ - { - "number": "+79134637228" - } - ] - }, - "from_location": { - "code": 44, - "city": "Москва", - "address": "пр. Ленинградский, д.4" - }, - "to_location": { - "code": 270, - "city": "Новосибирск", - "address": "ул. Блюхера, 32" - }, - "services": [ - { - "code": "SECURE_PACKAGE_A2", - "parameter": "10" - } - ], - "packages": [ - { - "number": "bar-001", - "weight": 4000, - "length": 10, - "width": 10, - "height": 10, - "comment": "Упаковка", - "items": [ - { - "name": "Товар", - "ware_key": "00055", - "payment": { - "value": 3000 - }, - "weight": 700, - "amount": 2, - "url": "www.item.ru", - "cost": 300 - } - ] - } - ], - "statuses": [ - { - "code": "ACCEPTED", - "name": "Принят", - "date_time": "2024-10-12T17:43:53+03:00", - "city": "Офис СДЭК" - } - ] - }, - "requests": [ - { - "request_uuid": "8f4e5a29-7954-4f53-9b87-f8fe7573345e", - "type": "CREATE", - "date_time": "2024-10-12T17:43:53+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Get-order.mdx b/docs/ru/md/CDEK/Orders-managment/Get-order.mdx new file mode 100644 index 0000000000..eebddc40a8 --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Get-order.mdx @@ -0,0 +1,128 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить заказ + Получает заказ по UUID + + + +`Функция ПолучитьЗаказ(Знач Токен, Знач UUID, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | UUID | --uuid | Строка | UUID заказа | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Информация о заказе](https://api-docs.cdek.ru/29923975.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + Результат = OPI_CDEK.ПолучитьЗаказ(Токен, UUID, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f", + "type": 1, + "number": "ddOererre7450813980068", + "tariff_code": 139, + "comment": "Новый заказ", + "delivery_recipient_cost": { + "value": 50 + }, + "delivery_recipient_cost_adv": [ + { + "threshold": 200, + "sum": 3000 + } + ], + "sender": { + "name": "Петров Петр" + }, + "recipient": { + "name": "Иванов Иван", + "phones": [ + { + "number": "+79134637228" + } + ] + }, + "from_location": { + "code": 44, + "city": "Москва", + "address": "пр. Ленинградский, д.4" + }, + "to_location": { + "code": 270, + "city": "Новосибирск", + "address": "ул. Блюхера, 32" + }, + "services": [ + { + "code": "SECURE_PACKAGE_A2", + "parameter": "10" + } + ], + "packages": [ + { + "number": "bar-001", + "weight": 4000, + "length": 10, + "width": 10, + "height": 10, + "comment": "Упаковка", + "items": [ + { + "name": "Товар", + "ware_key": "00055", + "payment": { + "value": 3000 + }, + "weight": 700, + "amount": 2, + "url": "www.item.ru", + "cost": 300 + } + ] + } + ], + "statuses": [ + { + "code": "ACCEPTED", + "name": "Принят", + "date_time": "2024-10-12T17:43:53+03:00", + "city": "Офис СДЭК" + } + ] + }, + "requests": [ + { + "request_uuid": "8f4e5a29-7954-4f53-9b87-f8fe7573345e", + "type": "CREATE", + "date_time": "2024-10-12T17:43:53+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/CDEK/Orders-managment/Update-order.md b/docs/ru/md/CDEK/Orders-managment/Update-order.md deleted file mode 100644 index 2d2d22b3db..0000000000 --- a/docs/ru/md/CDEK/Orders-managment/Update-order.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить заказ - Изменяет значения полей выбранного заказа - - - -`Функция ИзменитьЗаказ(Знач Токен, Знач UUID, Знач ОписаниеЗаказа, Знач ТестовыйAPI = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | UUID | --uuid | Строка | UUID заказа для изменение | - | ОписаниеЗаказа | --order | Структура Из КлючИЗначение | Набор изменяемых полей заказа | - | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK - -
- -:::tip -Метод в документации API: [Изменение заказа](https://api-docs.cdek.ru/36981178.html) -::: -
- - -```bsl title="Пример кода" - Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; - UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; - - ОписаниеЗаказа = Новый Структура("comment", "Новый комментарий"); - - Результат = OPI_CDEK.ИзменитьЗаказ(Токен, UUID, ОписаниеЗаказа, Истина); -``` - - - - -```json title="Результат" -{ - "entity": { - "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" - }, - "requests": [ - { - "request_uuid": "299b308b-47dd-44f8-857c-9d561fd5c59f", - "type": "UPDATE", - "date_time": "2024-10-12T17:43:54+03:00", - "state": "ACCEPTED" - } - ], - "related_entities": [] -} -``` diff --git a/docs/ru/md/CDEK/Orders-managment/Update-order.mdx b/docs/ru/md/CDEK/Orders-managment/Update-order.mdx new file mode 100644 index 0000000000..4598ee6f66 --- /dev/null +++ b/docs/ru/md/CDEK/Orders-managment/Update-order.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить заказ + Изменяет значения полей выбранного заказа + + + +`Функция ИзменитьЗаказ(Знач Токен, Знач UUID, Знач ОписаниеЗаказа, Знач ТестовыйAPI = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | UUID | --uuid | Строка | UUID заказа для изменение | + | ОписаниеЗаказа | --order | Структура Из КлючИЗначение | Набор изменяемых полей заказа | + | ТестовыйAPI | --testapi | Булево | Флаг использования API для тестовых запросов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от CDEK + +
+ +:::tip +Метод в документации API: [Изменение заказа](https://api-docs.cdek.ru/36981178.html) +::: +
+ + +```bsl title="Пример кода" + Токен = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJsb2NhdGlvbjphbGwiLCJvcmRlcjphbGwiLCJwYXltZW50OmFsbCJdLCJleHAiOjE3Mjg3MzkwMDYsImF1dGhvcml0aWVzIjpbInNoYXJkLWlkOnJ1LTAxIiwiY2xpZW50LWNpdHk60J3QvtCy0L7RgdC40LHQuNGA0YHQuiwg0J3QvtCy0L7RgdC40LHQuNGA0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwiLCJjb250cmFjdDrQmNCcLdCg0KQt0JPQm9CTLTIyIiwiYWNjb3VudC1sYW5nOnJ1cyIsImFjY291bnQtdXVpZDplOTI1YmQwZi0wNWE2LTRjNTYtYjczNy00Yjk5YzE0ZjY2OWEiLCJhcGktdmVyc2lvbjoxLjEiLCJjbGllbnQtaWQtZWM1OmVkNzVlY2Y0LTMwZWQtNDE1My1hZmU5LWViODBiYjUxMmYyMiIsImNvbnRyYWN0LWlkOmRlNDJjYjcxLTZjOGMtNGNmNS04MjIyLWNmYjY2MDQ0ZThkZiIsImNsaWVudC1pZC1lYzQ6MTQzNDgyMzEiLCJjb250cmFnZW50L..."; + UUID = "48763bae-2d8e-4521-9052-01377017fbe7"; + + ОписаниеЗаказа = Новый Структура("comment", "Новый комментарий"); + + Результат = OPI_CDEK.ИзменитьЗаказ(Токен, UUID, ОписаниеЗаказа, Истина); +``` + + + + +```json title="Результат" +{ + "entity": { + "uuid": "0c6b403d-000a-4d64-a282-798607b5e01f" + }, + "requests": [ + { + "request_uuid": "299b308b-47dd-44f8-857c-9d561fd5c59f", + "type": "UPDATE", + "date_time": "2024-10-12T17:43:54+03:00", + "state": "ACCEPTED" + } + ], + "related_entities": [] +} +``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md deleted file mode 100644 index fdf1304e80..0000000000 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить информацию об аккаунте - Получает информацию об аккаунте - - - -`Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Аккаунт | --account | Строка | ID аккаунта. Текущий аккаунт токена, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен); -``` - - - - - - ```bash - oint dropbox ПолучитьИнформациюОбАккаунте --token "***" \ - --account "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE" - ``` - - - - ```batch - oint dropbox ПолучитьИнформациюОбАккаунте ^ - --token "***" ^ - --account "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE" - ``` - - - - -```json title="Результат" -{ - "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", - "name": { - "given_name": "Антон", - "surname": "Титовец", - "familiar_name": "Антон", - "display_name": "Антон Титовец", - "abbreviated_name": "АТ" - }, - "email": "bayselonarrend@gmail.com", - "email_verified": true, - "disabled": false, - "country": "BY", - "locale": "en", - "referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483", - "is_paired": false, - "account_type": { - ".tag": "basic" - }, - "root_info": { - ".tag": "user", - "root_namespace_id": "3179550035", - "home_namespace_id": "3179550035" - } -} -``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.mdx b/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.mdx new file mode 100644 index 0000000000..98019b38ce --- /dev/null +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить информацию об аккаунте + Получает информацию об аккаунте + + + +`Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Аккаунт | --account | Строка | ID аккаунта. Текущий аккаунт токена, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен); +``` + + + + + + ```bash + oint dropbox ПолучитьИнформациюОбАккаунте --token "***" \ + --account "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE" + ``` + + + + ```batch + oint dropbox ПолучитьИнформациюОбАккаунте ^ + --token "***" ^ + --account "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE" + ``` + + + + +```json title="Результат" +{ + "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", + "name": { + "given_name": "Антон", + "surname": "Титовец", + "familiar_name": "Антон", + "display_name": "Антон Титовец", + "abbreviated_name": "АТ" + }, + "email": "bayselonarrend@gmail.com", + "email_verified": true, + "disabled": false, + "country": "BY", + "locale": "en", + "referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483", + "is_paired": false, + "account_type": { + ".tag": "basic" + }, + "root_info": { + ".tag": "user", + "root_namespace_id": "3179550035", + "home_namespace_id": "3179550035" + } +} +``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md deleted file mode 100644 index 61f02a4794..0000000000 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить ссылку авторизации - Генерирует ссылку авторизации для перехода в браузере - - - -`Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | КлючПриложения | --appkey | Строка | Ключ приложения | - - - Возвращаемое значение: Строка - URL для перехода в браузере - -
- - - - -```bsl title="Пример кода" - КлючПриложения = "oynqxds..."; - Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(КлючПриложения); -``` - - - - - - ```bash - oint dropbox ПолучитьСсылкуАвторизации --appkey "***" - ``` - - - - ```batch - oint dropbox ПолучитьСсылкуАвторизации ^ - --appkey "***" - ``` - - - - -```json title="Результат" -"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" -``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.mdx b/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.mdx new file mode 100644 index 0000000000..c0ba6e9803 --- /dev/null +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить ссылку авторизации + Генерирует ссылку авторизации для перехода в браузере + + + +`Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + + + Возвращаемое значение: Строка - URL для перехода в браузере + +
+ + + + +```bsl title="Пример кода" + КлючПриложения = "oynqxds..."; + Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(КлючПриложения); +``` + + + + + + ```bash + oint dropbox ПолучитьСсылкуАвторизации --appkey "***" + ``` + + + + ```batch + oint dropbox ПолучитьСсылкуАвторизации ^ + --appkey "***" + ``` + + + + +```json title="Результат" +"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" +``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md deleted file mode 100644 index 1587de4690..0000000000 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить данные использования пространства - Получает информацию о количестве использованного дискового пространства - - - -`Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен); -``` - - - - - - ```bash - oint dropbox ПолучитьДанныеИспользованияПространства --token "***" - ``` - - - - ```batch - oint dropbox ПолучитьДанныеИспользованияПространства ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "used": 1477704605, - "allocation": { - ".tag": "individual", - "allocated": 2147483648 - } -} -``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.mdx b/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.mdx new file mode 100644 index 0000000000..995af7c6c5 --- /dev/null +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить данные использования пространства + Получает информацию о количестве использованного дискового пространства + + + +`Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен); +``` + + + + + + ```bash + oint dropbox ПолучитьДанныеИспользованияПространства --token "***" + ``` + + + + ```batch + oint dropbox ПолучитьДанныеИспользованияПространства ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "used": 1477704605, + "allocation": { + ".tag": "individual", + "allocated": 2147483648 + } +} +``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md deleted file mode 100644 index 39d03ace0c..0000000000 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить токен - Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации - - - -`Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | КлючПриложения | --appkey | Строка | Ключ приложения | - | СекретПриложения | --appsecret | Строка | Секрет приложения | - | Код | --code | Строка | Код со страницы авторизации | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - КлючПриложения = "oynqxds..."; - СекретПриложения = "tk2oewn..."; - Код = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; - - Результат = OPI_Dropbox.ПолучитьТокен(КлючПриложения, СекретПриложения, Код); -``` - - - - - - ```bash - oint dropbox ПолучитьТокен --appkey "***" \ - --appsecret "***" \ - --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" - ``` - - - - ```batch - oint dropbox ПолучитьТокен ^ - --appkey "***" ^ - --appsecret "***" ^ - --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" - ``` - - - - -```json title="Результат" -{ - "error": "invalid_grant", - "error_description": "code doesn't exist or has expired" -} -``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-token.mdx b/docs/ru/md/Dropbox/Account-and-authorization/Get-token.mdx new file mode 100644 index 0000000000..4953ed1675 --- /dev/null +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-token.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить токен + Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации + + + +`Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + | СекретПриложения | --appsecret | Строка | Секрет приложения | + | Код | --code | Строка | Код со страницы авторизации | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + КлючПриложения = "oynqxds..."; + СекретПриложения = "tk2oewn..."; + Код = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; + + Результат = OPI_Dropbox.ПолучитьТокен(КлючПриложения, СекретПриложения, Код); +``` + + + + + + ```bash + oint dropbox ПолучитьТокен --appkey "***" \ + --appsecret "***" \ + --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" + ``` + + + + ```batch + oint dropbox ПолучитьТокен ^ + --appkey "***" ^ + --appsecret "***" ^ + --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" + ``` + + + + +```json title="Результат" +{ + "error": "invalid_grant", + "error_description": "code doesn't exist or has expired" +} +``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md b/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md deleted file mode 100644 index 2d9c4793b4..0000000000 --- a/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Обновить токен - Получает новый токен на основе рефреш токена - - - -`Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | КлючПриложения | --appkey | Строка | Ключ приложения | - | СекретПриложения | --appsecret | Строка | Секрет приложения | - | РефрешТокен | --refresh | Строка | Рефреш токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - КлючПриложения = "oynqxds..."; - СекретПриложения = "tk2oewn..."; - РефрешТокен = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; - - Результат = OPI_Dropbox.ОбновитьТокен(КлючПриложения, СекретПриложения, РефрешТокен); -``` - - - - - - ```bash - oint dropbox ОбновитьТокен --appkey "***" \ - --appsecret "***" \ - --refresh "***" - ``` - - - - ```batch - oint dropbox ОбновитьТокен ^ - --appkey "***" ^ - --appsecret "***" ^ - --refresh "***" - ``` - - - - -```json title="Результат" -{ - "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", - "token_type": "bearer", - "expires_in": 14400 -} -``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.mdx b/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.mdx new file mode 100644 index 0000000000..d64b68eb87 --- /dev/null +++ b/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Обновить токен + Получает новый токен на основе рефреш токена + + + +`Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + | СекретПриложения | --appsecret | Строка | Секрет приложения | + | РефрешТокен | --refresh | Строка | Рефреш токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + КлючПриложения = "oynqxds..."; + СекретПриложения = "tk2oewn..."; + РефрешТокен = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; + + Результат = OPI_Dropbox.ОбновитьТокен(КлючПриложения, СекретПриложения, РефрешТокен); +``` + + + + + + ```bash + oint dropbox ОбновитьТокен --appkey "***" \ + --appsecret "***" \ + --refresh "***" + ``` + + + + ```batch + oint dropbox ОбновитьТокен ^ + --appkey "***" ^ + --appsecret "***" ^ + --refresh "***" + ``` + + + + +```json title="Результат" +{ + "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", + "token_type": "bearer", + "expires_in": 14400 +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md b/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md deleted file mode 100644 index d9acd4288a..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Копировать объект - Копирует файл или каталог по выбранному пути - - - -`Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Откуда | --from | Строка | Путь к объекту оригинала | - | Куда | --to | Строка | Целевой путь для нового объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Оригинал = "/New/pic.png"; - Копия = "/New/pic_copy.png"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия); -``` - - - - - - ```bash - oint dropbox КопироватьОбъект --token "***" \ - --from "/New/pic.png" \ - --to "/New/pic_copy.png" - ``` - - - - ```batch - oint dropbox КопироватьОбъект ^ - --token "***" ^ - --from "/New/pic.png" ^ - --to "/New/pic_copy.png" - ``` - - - - -```json title="Результат" -{ - "metadata": { - ".tag": "file", - "name": "pic_copy.png", - "path_lower": "/new/pic_copy.png", - "path_display": "/New/pic_copy.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWw", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:45:45Z", - "rev": "623fab4f5ea7dbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.mdx new file mode 100644 index 0000000000..2b0e7255a2 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Копировать объект + Копирует файл или каталог по выбранному пути + + + +`Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --from | Строка | Путь к объекту оригинала | + | Куда | --to | Строка | Целевой путь для нового объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Оригинал = "/New/pic.png"; + Копия = "/New/pic_copy.png"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия); +``` + + + + + + ```bash + oint dropbox КопироватьОбъект --token "***" \ + --from "/New/pic.png" \ + --to "/New/pic_copy.png" + ``` + + + + ```batch + oint dropbox КопироватьОбъект ^ + --token "***" ^ + --from "/New/pic.png" ^ + --to "/New/pic_copy.png" + ``` + + + + +```json title="Результат" +{ + "metadata": { + ".tag": "file", + "name": "pic_copy.png", + "path_lower": "/new/pic_copy.png", + "path_display": "/New/pic_copy.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWw", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:45:45Z", + "rev": "623fab4f5ea7dbd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md b/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md deleted file mode 100644 index e82babb4a7..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Создать папку - Создает пустой каталог по выбранному пути - - - -`Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Целевой путь создания каталога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/Новый каталог"; - - Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь); -``` - - - - - - ```bash - oint dropbox СоздатьПапку --token "***" \ - --path "/Новый каталог" - ``` - - - - ```batch - oint dropbox СоздатьПапку ^ - --token "***" ^ - --path "/Новый каталог" - ``` - - - - -```json title="Результат" -{ - "metadata": { - "name": "Новый каталог", - "path_lower": "/новый каталог", - "path_display": "/Новый каталог", - "id": "id:kJU6-a-pT48AAAAAAAAcXQ" - } -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.mdx new file mode 100644 index 0000000000..65c37a9124 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Создать папку + Создает пустой каталог по выбранному пути + + + +`Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Целевой путь создания каталога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/Новый каталог"; + + Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь); +``` + + + + + + ```bash + oint dropbox СоздатьПапку --token "***" \ + --path "/Новый каталог" + ``` + + + + ```batch + oint dropbox СоздатьПапку ^ + --token "***" ^ + --path "/Новый каталог" + ``` + + + + +```json title="Результат" +{ + "metadata": { + "name": "Новый каталог", + "path_lower": "/новый каталог", + "path_display": "/Новый каталог", + "id": "id:kJU6-a-pT48AAAAAAAAcXQ" + } +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md b/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md deleted file mode 100644 index bf9c926ab0..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Удалить объект - Удаляет объект с облачного диска - - - -`Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту удаления | - | БезВозвратно | --permanently | Строка | Удалить объект без возможности востановления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Путь = "/New/pic.png"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь); -``` - - - - - - ```bash - oint dropbox УдалитьОбъект --token "***" \ - --path "/Новый каталог" - ``` - - - - ```batch - oint dropbox УдалитьОбъект ^ - --token "***" ^ - --path "/Новый каталог" - ``` - - - - -```json title="Результат" -{ - "metadata": { - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWQ", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:45:38Z", - "rev": "623fab496638abd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.mdx new file mode 100644 index 0000000000..19df5e4440 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Удалить объект + Удаляет объект с облачного диска + + + +`Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту удаления | + | БезВозвратно | --permanently | Строка | Удалить объект без возможности востановления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Путь = "/New/pic.png"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь); +``` + + + + + + ```bash + oint dropbox УдалитьОбъект --token "***" \ + --path "/Новый каталог" + ``` + + + + ```batch + oint dropbox УдалитьОбъект ^ + --token "***" ^ + --path "/Новый каталог" + ``` + + + + +```json title="Результат" +{ + "metadata": { + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWQ", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:45:38Z", + "rev": "623fab496638abd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md b/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md deleted file mode 100644 index 8e5b28e1b6..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Скачать файл - Скачивает файл по указанному пути или ID - - - -`Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь или ID файла | - - - Возвращаемое значение: ДвоичныеДанные - двоичные данные файла - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New/pic.png"; - - Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь); -``` - - - - - - ```bash - oint dropbox СкачатьФайл --token "***" \ - --path "/New/pic.png" - ``` - - - - ```batch - oint dropbox СкачатьФайл ^ - --token "***" ^ - --path "/New/pic.png" - ``` - - - - -```json title="Результат" -НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Download-file.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Download-file.mdx new file mode 100644 index 0000000000..5f23243758 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Download-file.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Скачать файл + Скачивает файл по указанному пути или ID + + + +`Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь или ID файла | + + + Возвращаемое значение: ДвоичныеДанные - двоичные данные файла + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь); +``` + + + + + + ```bash + oint dropbox СкачатьФайл --token "***" \ + --path "/New/pic.png" + ``` + + + + ```batch + oint dropbox СкачатьФайл ^ + --token "***" ^ + --path "/New/pic.png" + ``` + + + + +```json title="Результат" +НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md b/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md deleted file mode 100644 index 4d17600249..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Скачать папку - Скачивает zip архив с содержимым указанного каталога - - - -`Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь или ID каталога | - - - Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New"; - - Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь); -``` - - - - - - ```bash - oint dropbox СкачатьПапку --token "***" \ - --path "/New" - ``` - - - - ```batch - oint dropbox СкачатьПапку ^ - --token "***" ^ - --path "/New" - ``` - - - - -```json title="Результат" -НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 F2 9A 47 59 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 38 35 04 67 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.mdx new file mode 100644 index 0000000000..1ea49d2b15 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Скачать папку + Скачивает zip архив с содержимым указанного каталога + + + +`Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь или ID каталога | + + + Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New"; + + Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь); +``` + + + + + + ```bash + oint dropbox СкачатьПапку --token "***" \ + --path "/New" + ``` + + + + ```batch + oint dropbox СкачатьПапку ^ + --token "***" ^ + --path "/New" + ``` + + + + +```json title="Результат" +НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 F2 9A 47 59 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 38 35 04 67 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md deleted file mode 100644 index d2ca1f6e93..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список файлов папки - Получает список первых файлов каталога или продолжает получение следующих при указании курсора - - - -`Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к каталогу. Необязателен, если указан курсор | - | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | - | Курсор | --cursor | Строка | Курсор из предыдущего запроса для получения следующего набора файлов | - - - Возвращаемое значение: HTTPОтвет - Получить список файлов папки - -
- - - - -```bsl title="Пример кода" - Путь = "/New"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина); -``` - - - - - - ```bash - oint dropbox ПолучитьСписокФайловПапки --token "***" \ - --path "/New" - ``` - - - - ```batch - oint dropbox ПолучитьСписокФайловПапки ^ - --token "***" ^ - --path "/New" - ``` - - - - -```json title="Результат" -{ - "entries": [ - { - ".tag": "file", - "name": "Dogs.mp3", - "path_lower": "/new/dogs.mp3", - "path_display": "/New/Dogs.mp3", - "id": "id:kJU6-a-pT48AAAAAAAAACA", - "client_modified": "2024-05-15T16:58:30Z", - "server_modified": "2024-10-08T17:47:30Z", - "rev": "623fabb409e5dbd841553", - "size": 9229352, - "is_downloadable": true, - "content_hash": "376f728ef041d9cef08406f16debc12de89d83130e69c66a817fd834d2d82dc2" - }, - { - ".tag": "file", - "name": "url_doc (1).docx", - "path_lower": "/new/url_doc (1).docx", - "path_display": "/New/url_doc (1).docx", - "id": "id:kJU6-a-pT48AAAAAAAALvg", - "client_modified": "2024-07-15T17:40:28Z", - "server_modified": "2024-10-08T17:47:30Z", - "rev": "623fabb409e5ebd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" - }, - { - ".tag": "file", - "name": "mydoc.docx", - "path_lower": "/new/mydoc.docx", - "path_display": "/New/mydoc.docx", - "id": "id:kJU6-a-pT48AAAAAAAAABw", - "client_modified": "2024-05-14T16:49:41Z", - "server_modified": "2024-10-08T17:47:30Z", - "rev": "623fabb409e5fbd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" - } - ], - "cursor": "AAEHgD-G1mXhR8y9urKUn3Mw8U9BjlpLpPfpOSKR5BaWAXcUCX5o-fKNCNnkih1Bc_wgf9yMO8m6G19YSU4E2NhfuNZwdjCv5arowPnRKefKW_LRL9rHJTlqXCnNrpbZKPifJ-_QDqgxqj8wNzKSJv7fXCjYAmZOw_ZPTxunwJAayYW671V_R91M0WmKP_dhOFJrQr4zoSr_NkGPnuICKAiU", - "has_more": false -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.mdx new file mode 100644 index 0000000000..16c3a92ec5 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.mdx @@ -0,0 +1,103 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список файлов папки + Получает список первых файлов каталога или продолжает получение следующих при указании курсора + + + +`Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к каталогу. Необязателен, если указан курсор | + | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | + | Курсор | --cursor | Строка | Курсор из предыдущего запроса для получения следующего набора файлов | + + + Возвращаемое значение: HTTPОтвет - Получить список файлов папки + +
+ + + + +```bsl title="Пример кода" + Путь = "/New"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина); +``` + + + + + + ```bash + oint dropbox ПолучитьСписокФайловПапки --token "***" \ + --path "/New" + ``` + + + + ```batch + oint dropbox ПолучитьСписокФайловПапки ^ + --token "***" ^ + --path "/New" + ``` + + + + +```json title="Результат" +{ + "entries": [ + { + ".tag": "file", + "name": "Dogs.mp3", + "path_lower": "/new/dogs.mp3", + "path_display": "/New/Dogs.mp3", + "id": "id:kJU6-a-pT48AAAAAAAAACA", + "client_modified": "2024-05-15T16:58:30Z", + "server_modified": "2024-10-08T17:47:30Z", + "rev": "623fabb409e5dbd841553", + "size": 9229352, + "is_downloadable": true, + "content_hash": "376f728ef041d9cef08406f16debc12de89d83130e69c66a817fd834d2d82dc2" + }, + { + ".tag": "file", + "name": "url_doc (1).docx", + "path_lower": "/new/url_doc (1).docx", + "path_display": "/New/url_doc (1).docx", + "id": "id:kJU6-a-pT48AAAAAAAALvg", + "client_modified": "2024-07-15T17:40:28Z", + "server_modified": "2024-10-08T17:47:30Z", + "rev": "623fabb409e5ebd841553", + "size": 24069, + "is_downloadable": true, + "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" + }, + { + ".tag": "file", + "name": "mydoc.docx", + "path_lower": "/new/mydoc.docx", + "path_display": "/New/mydoc.docx", + "id": "id:kJU6-a-pT48AAAAAAAAABw", + "client_modified": "2024-05-14T16:49:41Z", + "server_modified": "2024-10-08T17:47:30Z", + "rev": "623fabb409e5fbd841553", + "size": 24069, + "is_downloadable": true, + "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" + } + ], + "cursor": "AAEHgD-G1mXhR8y9urKUn3Mw8U9BjlpLpPfpOSKR5BaWAXcUCX5o-fKNCNnkih1Bc_wgf9yMO8m6G19YSU4E2NhfuNZwdjCv5arowPnRKefKW_LRL9rHJTlqXCnNrpbZKPifJ-_QDqgxqj8wNzKSJv7fXCjYAmZOw_ZPTxunwJAayYW671V_R91M0WmKP_dhOFJrQr4zoSr_NkGPnuICKAiU", + "has_more": false +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md deleted file mode 100644 index 014678a70e..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию об объекте - Получает информацию о файле или каталоге - - - -`Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Путь = "/New/pic.png"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина); -``` - - - - - - ```bash - oint dropbox ПолучитьИнформациюОбОбъекте --token "***" \ - --path "/New/pic.png" \ - --detail true - ``` - - - - ```batch - oint dropbox ПолучитьИнформациюОбОбъекте ^ - --token "***" ^ - --path "/New/pic.png" ^ - --detail true - ``` - - - - -```json title="Результат" -{ - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWQ", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:44:59Z", - "rev": "623fab23a7559bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.mdx new file mode 100644 index 0000000000..730b1f771f --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить информацию об объекте + Получает информацию о файле или каталоге + + + +`Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Путь = "/New/pic.png"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина); +``` + + + + + + ```bash + oint dropbox ПолучитьИнформациюОбОбъекте --token "***" \ + --path "/New/pic.png" \ + --detail true + ``` + + + + ```batch + oint dropbox ПолучитьИнформациюОбОбъекте ^ + --token "***" ^ + --path "/New/pic.png" ^ + --detail true + ``` + + + + +```json title="Результат" +{ + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWQ", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:44:59Z", + "rev": "623fab23a7559bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md deleted file mode 100644 index ba5ddf68a3..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Получить список версий объекта - Получает список версий (ревизий) объекта - - - -`Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - | Количество | --amount | Строка, Число | Число последних версий объекта для отображения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New/pic.png"; - - Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1); -``` - - - - - - ```bash - oint dropbox ПолучитьСписокВерсийОбъекта --token "***" \ - --path "/New/pic.png" \ - --amount 1 - ``` - - - - ```batch - oint dropbox ПолучитьСписокВерсийОбъекта ^ - --token "***" ^ - --path "/New/pic.png" ^ - --amount 1 - ``` - - - - -```json title="Результат" -{ - "is_deleted": false, - "entries": [ - { - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWQ", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:44:59Z", - "rev": "623fab23a7559bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } - ] -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.mdx new file mode 100644 index 0000000000..d769234ec7 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Получить список версий объекта + Получает список версий (ревизий) объекта + + + +`Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Количество | --amount | Строка, Число | Число последних версий объекта для отображения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1); +``` + + + + + + ```bash + oint dropbox ПолучитьСписокВерсийОбъекта --token "***" \ + --path "/New/pic.png" \ + --amount 1 + ``` + + + + ```batch + oint dropbox ПолучитьСписокВерсийОбъекта ^ + --token "***" ^ + --path "/New/pic.png" ^ + --amount 1 + ``` + + + + +```json title="Результат" +{ + "is_deleted": false, + "entries": [ + { + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWQ", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:44:59Z", + "rev": "623fab23a7559bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } + ] +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md deleted file mode 100644 index 5f9201a23d..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить превью - Получает PDF или HTML превью объекта (только для токументов) - - - -`Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - - - Возвращаемое значение: ДвоичныеДанные - превью документа - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New/mydoc.docx"; - - Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь); -``` - - - - - - ```bash - oint dropbox ПолучитьПревью --token "***" \ - --path "/New/mydoc.docx" - ``` - - - - ```batch - oint dropbox ПолучитьПревью ^ - --token "***" ^ - --path "/New/mydoc.docx" - ``` - - - - -```json title="Результат" -НЕ JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.mdx new file mode 100644 index 0000000000..1bf9110769 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить превью + Получает PDF или HTML превью объекта (только для токументов) + + + +`Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + + + Возвращаемое значение: ДвоичныеДанные - превью документа + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь); +``` + + + + + + ```bash + oint dropbox ПолучитьПревью --token "***" \ + --path "/New/mydoc.docx" + ``` + + + + ```batch + oint dropbox ПолучитьПревью ^ + --token "***" ^ + --path "/New/mydoc.docx" + ``` + + + + +```json title="Результат" +НЕ JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md deleted file mode 100644 index b729afeca1..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить статус загрузки по URL - Получает статус загрузки файла по URL - - - -`Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDРаботы | --job | Строка | ID асинхронной работы из ответа ЗагрузитьФайлПоURL | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - ИДРаботы = "4SQ3zikww9gAAAAAAAAAAQ"; - Статус = "in_progress"; - - Пока Статус = "in_progress" Цикл - - Результат = OPI_Dropbox.ПолучитьСтатусЗагрузкиПоURL(Токен, ИДРаботы); - Статус = Результат[".tag"]; - - OPI_Инструменты.Пауза(5); - - КонецЦикла; -``` - - - - - - ```bash - oint dropbox ПолучитьСтатусЗагрузкиПоURL --token "***" \ - --job "RFGLw9RumQQAAAAAAAAAAQ" - ``` - - - - ```batch - oint dropbox ПолучитьСтатусЗагрузкиПоURL ^ - --token "***" ^ - --job "RFGLw9RumQQAAAAAAAAAAQ" - ``` - - - - -```json title="Результат" -{ - ".tag": "complete", - "name": "url_doc.docx", - "path_lower": "/new/url_doc.docx", - "path_display": "/New/url_doc.docx", - "id": "id:kJU6-a-pT48AAAAAAAAcXA", - "client_modified": "2024-10-08T17:46:00Z", - "server_modified": "2024-10-08T17:46:01Z", - "rev": "623fab5ed0205bd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.mdx new file mode 100644 index 0000000000..196c53dcfd --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить статус загрузки по URL + Получает статус загрузки файла по URL + + + +`Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDРаботы | --job | Строка | ID асинхронной работы из ответа ЗагрузитьФайлПоURL | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + ИДРаботы = "4SQ3zikww9gAAAAAAAAAAQ"; + Статус = "in_progress"; + + Пока Статус = "in_progress" Цикл + + Результат = OPI_Dropbox.ПолучитьСтатусЗагрузкиПоURL(Токен, ИДРаботы); + Статус = Результат[".tag"]; + + OPI_Инструменты.Пауза(5); + + КонецЦикла; +``` + + + + + + ```bash + oint dropbox ПолучитьСтатусЗагрузкиПоURL --token "***" \ + --job "RFGLw9RumQQAAAAAAAAAAQ" + ``` + + + + ```batch + oint dropbox ПолучитьСтатусЗагрузкиПоURL ^ + --token "***" ^ + --job "RFGLw9RumQQAAAAAAAAAAQ" + ``` + + + + +```json title="Результат" +{ + ".tag": "complete", + "name": "url_doc.docx", + "path_lower": "/new/url_doc.docx", + "path_display": "/New/url_doc.docx", + "id": "id:kJU6-a-pT48AAAAAAAAcXA", + "client_modified": "2024-10-08T17:46:00Z", + "server_modified": "2024-10-08T17:46:01Z", + "rev": "623fab5ed0205bd841553", + "size": 24069, + "is_downloadable": true, + "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md b/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md deleted file mode 100644 index 1639b3cf20..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Переместить объект - Перемещает объект по выбранному пути - - - -`Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Откуда | --from | Строка | Путь к объекту оригинала | - | Куда | --to | Строка | Целевой путь для нового объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - ОригиналныйПуть = "/New/pic.png"; - ЦелевойПуть = "/pic.png"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть); -``` - - - - - - ```bash - oint dropbox ПереместитьОбъект --token "***" \ - --from "/pic.png" \ - --to "/New/pic.png" - ``` - - - - ```batch - oint dropbox ПереместитьОбъект ^ - --token "***" ^ - --from "/pic.png" ^ - --to "/New/pic.png" - ``` - - - - -```json title="Результат" -{ - "metadata": { - ".tag": "file", - "name": "pic.png", - "path_lower": "/pic.png", - "path_display": "/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWQ", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:45:37Z", - "rev": "623fab47c7ce8bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Move-object.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Move-object.mdx new file mode 100644 index 0000000000..6f3494104c --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Move-object.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Переместить объект + Перемещает объект по выбранному пути + + + +`Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --from | Строка | Путь к объекту оригинала | + | Куда | --to | Строка | Целевой путь для нового объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + ОригиналныйПуть = "/New/pic.png"; + ЦелевойПуть = "/pic.png"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть); +``` + + + + + + ```bash + oint dropbox ПереместитьОбъект --token "***" \ + --from "/pic.png" \ + --to "/New/pic.png" + ``` + + + + ```batch + oint dropbox ПереместитьОбъект ^ + --token "***" ^ + --from "/pic.png" ^ + --to "/New/pic.png" + ``` + + + + +```json title="Результат" +{ + "metadata": { + ".tag": "file", + "name": "pic.png", + "path_lower": "/pic.png", + "path_display": "/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWQ", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:45:37Z", + "rev": "623fab47c7ce8bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" + } +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md b/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md deleted file mode 100644 index 252124a645..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Восстановить объект к версии - Восстанавливает состояние объекта к необходимой версии (ревизии) - - - -`Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - | Версия | --rev | Строка | ID версии (ревизии) для востановления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Версия = "6246a08b887a8bd841553"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New/pic.png"; - - Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия); -``` - - - - - - ```bash - oint dropbox ВосстановитьОбъектКВерсии --token "***" \ - --path "/New/pic.png" \ - --rev "62475a95a622dbd841553" - ``` - - - - ```batch - oint dropbox ВосстановитьОбъектКВерсии ^ - --token "***" ^ - --path "/New/pic.png" ^ - --rev "62475a95a622dbd841553" - ``` - - - - -```json title="Результат" -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWQ", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:44:59Z", - "rev": "623fab23a7559bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.mdx new file mode 100644 index 0000000000..f1507d53f5 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Восстановить объект к версии + Восстанавливает состояние объекта к необходимой версии (ревизии) + + + +`Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Версия | --rev | Строка | ID версии (ревизии) для востановления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Версия = "6246a08b887a8bd841553"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия); +``` + + + + + + ```bash + oint dropbox ВосстановитьОбъектКВерсии --token "***" \ + --path "/New/pic.png" \ + --rev "62475a95a622dbd841553" + ``` + + + + ```batch + oint dropbox ВосстановитьОбъектКВерсии ^ + --token "***" ^ + --path "/New/pic.png" ^ + --rev "62475a95a622dbd841553" + ``` + + + + +```json title="Результат" +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWQ", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:44:59Z", + "rev": "623fab23a7559bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md deleted file mode 100644 index 59157ac78f..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Загрузить файл по URL - Загружает файл на облачный диск, получая его по указанному URL - - - -`Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URLФайла | --url | Строка | URL источник файла | - | Путь | --path | Строка | Путь сохранения на Dropbox | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Путь = "/New/url_doc.docx"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - URL = "https://api.athenaeum.digital/test_data/document.docx"; - - Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь); -``` - - - - - - ```bash - oint dropbox ЗагрузитьФайлПоURL --token "***" \ - --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ - --path "/New/url_doc.docx" - ``` - - - - ```batch - oint dropbox ЗагрузитьФайлПоURL ^ - --token "***" ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ - --path "/New/url_doc.docx" - ``` - - - - -```json title="Результат" -{ - ".tag": "async_job_id", - "async_job_id": "4Z3HR2PdMNAAAAAAAAAAAQ" -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.mdx new file mode 100644 index 0000000000..d514aa71f4 --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Загрузить файл по URL + Загружает файл на облачный диск, получая его по указанному URL + + + +`Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URLФайла | --url | Строка | URL источник файла | + | Путь | --path | Строка | Путь сохранения на Dropbox | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Путь = "/New/url_doc.docx"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + URL = "https://api.athenaeum.digital/test_data/document.docx"; + + Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь); +``` + + + + + + ```bash + oint dropbox ЗагрузитьФайлПоURL --token "***" \ + --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ + --path "/New/url_doc.docx" + ``` + + + + ```batch + oint dropbox ЗагрузитьФайлПоURL ^ + --token "***" ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ + --path "/New/url_doc.docx" + ``` + + + + +```json title="Результат" +{ + ".tag": "async_job_id", + "async_job_id": "4Z3HR2PdMNAAAAAAAAAAAQ" +} +``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md deleted file mode 100644 index 497ee106f6..0000000000 --- a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Загрузить файл - Загружает файл на облачный диск - - - -`Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Файл | --file | Строка, ДвоичныеДанные | Данные файл для загрузки | - | Путь | --path | Строка | Путь сохранения на Dropbox | - | Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Путь = "/New/pic.png"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - - КартинкаПуть = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, КартинкаПуть); - - Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина); -``` - - - - - - ```bash - oint dropbox ЗагрузитьФайл --token "***" \ - --file "C:\Users\Administrator\AppData\Local\Temp\junte55oyqj.png" \ - --path "/New/pic.png" \ - --overwrite true - ``` - - - - ```batch - oint dropbox ЗагрузитьФайл ^ - --token "***" ^ - --file "C:\Users\Administrator\AppData\Local\Temp\junte55oyqj.png" ^ - --path "/New/pic.png" ^ - --overwrite true - ``` - - - - -```json title="Результат" -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAAcWQ", - "client_modified": "2024-10-08T17:44:58Z", - "server_modified": "2024-10-08T17:44:59Z", - "rev": "623fab23a7559bd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} -``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.mdx b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.mdx new file mode 100644 index 0000000000..65dac6a23f --- /dev/null +++ b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Загрузить файл + Загружает файл на облачный диск + + + +`Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Файл | --file | Строка, ДвоичныеДанные | Данные файл для загрузки | + | Путь | --path | Строка | Путь сохранения на Dropbox | + | Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Путь = "/New/pic.png"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + + КартинкаПуть = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, КартинкаПуть); + + Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина); +``` + + + + + + ```bash + oint dropbox ЗагрузитьФайл --token "***" \ + --file "C:\Users\Administrator\AppData\Local\Temp\junte55oyqj.png" \ + --path "/New/pic.png" \ + --overwrite true + ``` + + + + ```batch + oint dropbox ЗагрузитьФайл ^ + --token "***" ^ + --file "C:\Users\Administrator\AppData\Local\Temp\junte55oyqj.png" ^ + --path "/New/pic.png" ^ + --overwrite true + ``` + + + + +```json title="Результат" +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAAcWQ", + "client_modified": "2024-10-08T17:44:58Z", + "server_modified": "2024-10-08T17:44:59Z", + "rev": "623fab23a7559bd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md deleted file mode 100644 index 484c918ce0..0000000000 --- a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Добавить пользователей к файлу - Определяет доступ к файлу для сторонних пользователей - - - -`Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | - | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | - | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Почта = "h5bk6ft62s@privaterelay.appleid.com"; - Файл = "kJU6-a-pT48AAAAAAAAABw"; - - Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь); -``` - - - - - - ```bash - oint dropbox ДобавитьПользователейКФайлу --token "***" \ - --fileid "kJU6-a-pT48AAAAAAAAABw" \ - --emails "['h5bk6ft62s@privaterelay.appleid.com']" \ - --readonly true - ``` - - - - ```batch - oint dropbox ДобавитьПользователейКФайлу ^ - --token "***" ^ - --fileid "kJU6-a-pT48AAAAAAAAABw" ^ - --emails "['h5bk6ft62s@privaterelay.appleid.com']" ^ - --readonly true - ``` - - - - -```json title="Результат" -[ - { - "member": { - ".tag": "email", - "email": "h5bk6ft62s@privaterelay.appleid.com" - }, - "result": { - ".tag": "success", - "success": { - ".tag": "editor" - } - }, - "sckey_sha1": "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4", - "invitation_signature": [ - "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4:ed7721b375882c806612d4056dad9f317cc98a22" - ] - } -] -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.mdx b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.mdx new file mode 100644 index 0000000000..a39ca1dc51 --- /dev/null +++ b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.mdx @@ -0,0 +1,81 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Добавить пользователей к файлу + Определяет доступ к файлу для сторонних пользователей + + + +`Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | + | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | + | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Почта = "h5bk6ft62s@privaterelay.appleid.com"; + Файл = "kJU6-a-pT48AAAAAAAAABw"; + + Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь); +``` + + + + + + ```bash + oint dropbox ДобавитьПользователейКФайлу --token "***" \ + --fileid "kJU6-a-pT48AAAAAAAAABw" \ + --emails "['h5bk6ft62s@privaterelay.appleid.com']" \ + --readonly true + ``` + + + + ```batch + oint dropbox ДобавитьПользователейКФайлу ^ + --token "***" ^ + --fileid "kJU6-a-pT48AAAAAAAAABw" ^ + --emails "['h5bk6ft62s@privaterelay.appleid.com']" ^ + --readonly true + ``` + + + + +```json title="Результат" +[ + { + "member": { + ".tag": "email", + "email": "h5bk6ft62s@privaterelay.appleid.com" + }, + "result": { + ".tag": "success", + "success": { + ".tag": "editor" + } + }, + "sckey_sha1": "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4", + "invitation_signature": [ + "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4:ed7721b375882c806612d4056dad9f317cc98a22" + ] + } +] +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md deleted file mode 100644 index 891d9fe4cb..0000000000 --- a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Добавить пользователей к папке - Предоставляет стороннии пользователям доступ к каталогу - - - -`Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | - | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | - | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | - - - Возвращаемое значение: Неопределено - пустой ответ - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Почта = "h5bk6ft62s@privaterelay.appleid.com"; - Папка = "11727195745"; // shared_folder_id - - Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь); -``` - - - - - - ```bash - oint dropbox ДобавитьПользователейКПапке --token "***" \ - --folder "11741910385" \ - --emails "['h5bk6ft62s@privaterelay.appleid.com']" \ - --readonly true - ``` - - - - ```batch - oint dropbox ДобавитьПользователейКПапке ^ - --token "***" ^ - --folder "11741910385" ^ - --emails "['h5bk6ft62s@privaterelay.appleid.com']" ^ - --readonly true - ``` - - - - -```json title="Результат" -{} -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.mdx b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.mdx new file mode 100644 index 0000000000..857286069d --- /dev/null +++ b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Добавить пользователей к папке + Предоставляет стороннии пользователям доступ к каталогу + + + +`Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | + | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | + | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | + + + Возвращаемое значение: Неопределено - пустой ответ + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Почта = "h5bk6ft62s@privaterelay.appleid.com"; + Папка = "11727195745"; // shared_folder_id + + Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь); +``` + + + + + + ```bash + oint dropbox ДобавитьПользователейКПапке --token "***" \ + --folder "11741910385" \ + --emails "['h5bk6ft62s@privaterelay.appleid.com']" \ + --readonly true + ``` + + + + ```batch + oint dropbox ДобавитьПользователейКПапке ^ + --token "***" ^ + --folder "11741910385" ^ + --emails "['h5bk6ft62s@privaterelay.appleid.com']" ^ + --readonly true + ``` + + + + +```json title="Результат" +{} +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md deleted file mode 100644 index 9014ecb321..0000000000 --- a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Отменить публикацию файла - Запрещает доступ к файлу для внешних пользователей - - - -`Функция ОтменитьПубликациюФайла(Знач Токен, Знач IDФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Файл = "kJU6-a-pT48AAAAAAAAABw"; - - Результат = OPI_Dropbox.ОтменитьПубликациюФайла(Токен, Файл); -``` - - - - - - ```bash - oint dropbox ОтменитьПубликациюФайла --token "***" \ - --fileid "kJU6-a-pT48AAAAAAAAABw" - ``` - - - - ```batch - oint dropbox ОтменитьПубликациюФайла ^ - --token "***" ^ - --fileid "kJU6-a-pT48AAAAAAAAABw" - ``` - - - - -```json title="Результат" -{} -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.mdx b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.mdx new file mode 100644 index 0000000000..7bd9957462 --- /dev/null +++ b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Отменить публикацию файла + Запрещает доступ к файлу для внешних пользователей + + + +`Функция ОтменитьПубликациюФайла(Знач Токен, Знач IDФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Файл = "kJU6-a-pT48AAAAAAAAABw"; + + Результат = OPI_Dropbox.ОтменитьПубликациюФайла(Токен, Файл); +``` + + + + + + ```bash + oint dropbox ОтменитьПубликациюФайла --token "***" \ + --fileid "kJU6-a-pT48AAAAAAAAABw" + ``` + + + + ```batch + oint dropbox ОтменитьПубликациюФайла ^ + --token "***" ^ + --fileid "kJU6-a-pT48AAAAAAAAABw" + ``` + + + + +```json title="Результат" +{} +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md deleted file mode 100644 index d444fb25b5..0000000000 --- a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Отменить публикацию папки - Отменяет режим общего доступа для каталога - - - -`Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Папка = "11727195745"; - - Результат = OPI_Dropbox.ОтменитьПубликациюПапки(Токен, Папка); -``` - - - - - - ```bash - oint dropbox ОтменитьПубликациюПапки --token "***" \ - --folder "11741910385" - ``` - - - - ```batch - oint dropbox ОтменитьПубликациюПапки ^ - --token "***" ^ - --folder "11741910385" - ``` - - - - -```json title="Результат" -{ - ".tag": "async_job_id", - "async_job_id": "dbjid:AADtwNfCN9W_5zHUPzHqUjDmmt1pFYi933Ij6TGpKSjgMzZpJsSyyGwalhvYCzHMZeCmjajZBlgvLOqk0jscPd5m" -} -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.mdx b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.mdx new file mode 100644 index 0000000000..c8c06e91d6 --- /dev/null +++ b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Отменить публикацию папки + Отменяет режим общего доступа для каталога + + + +`Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Папка = "11727195745"; + + Результат = OPI_Dropbox.ОтменитьПубликациюПапки(Токен, Папка); +``` + + + + + + ```bash + oint dropbox ОтменитьПубликациюПапки --token "***" \ + --folder "11741910385" + ``` + + + + ```batch + oint dropbox ОтменитьПубликациюПапки ^ + --token "***" ^ + --folder "11741910385" + ``` + + + + +```json title="Результат" +{ + ".tag": "async_job_id", + "async_job_id": "dbjid:AADtwNfCN9W_5zHUPzHqUjDmmt1pFYi933Ij6TGpKSjgMzZpJsSyyGwalhvYCzHMZeCmjajZBlgvLOqk0jscPd5m" +} +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md b/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md deleted file mode 100644 index aa2d97358d..0000000000 --- a/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить статус асинхронного изменения - Получает статус асинхронной работы по изменению доступов - - - -`Функция ПолучитьСтатусАсинхронногоИзменения(Знач Токен, Знач IDРаботы) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDРаботы | --job | Строка | ID асинхронной работы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - IDРаботы = "dbjid:AACP-Bd0jYrnvlGEezhk65FDN-1sAlXg1FmEfjWibO2qt3sc3Yca2HQhzQuHu7aSqBCdN2pmgpS2ZUd8RkM2Yu8J"; - - Результат = OPI_Dropbox.ПолучитьСтатусАсинхронногоИзменения(Токен, IDРаботы); -``` - - - - - - ```bash - oint dropbox ПолучитьСтатусАсинхронногоИзменения --token "***" \ - --job "dbjid:AAAIJ7t1xyhVC8tWH4ww87h6Tvea-NtCVPY9eTDkdmcnLwYZJrUuC7YhYymd6W4jQTwW-V--hjFbraM1tMNhzIw0" - ``` - - - - ```batch - oint dropbox ПолучитьСтатусАсинхронногоИзменения ^ - --token "***" ^ - --job "dbjid:AAAIJ7t1xyhVC8tWH4ww87h6Tvea-NtCVPY9eTDkdmcnLwYZJrUuC7YhYymd6W4jQTwW-V--hjFbraM1tMNhzIw0" - ``` - - - - -```json title="Результат" -{ - ".tag": "complete" -} -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.mdx b/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.mdx new file mode 100644 index 0000000000..3e0272a945 --- /dev/null +++ b/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить статус асинхронного изменения + Получает статус асинхронной работы по изменению доступов + + + +`Функция ПолучитьСтатусАсинхронногоИзменения(Знач Токен, Знач IDРаботы) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDРаботы | --job | Строка | ID асинхронной работы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + IDРаботы = "dbjid:AACP-Bd0jYrnvlGEezhk65FDN-1sAlXg1FmEfjWibO2qt3sc3Yca2HQhzQuHu7aSqBCdN2pmgpS2ZUd8RkM2Yu8J"; + + Результат = OPI_Dropbox.ПолучитьСтатусАсинхронногоИзменения(Токен, IDРаботы); +``` + + + + + + ```bash + oint dropbox ПолучитьСтатусАсинхронногоИзменения --token "***" \ + --job "dbjid:AAAIJ7t1xyhVC8tWH4ww87h6Tvea-NtCVPY9eTDkdmcnLwYZJrUuC7YhYymd6W4jQTwW-V--hjFbraM1tMNhzIw0" + ``` + + + + ```batch + oint dropbox ПолучитьСтатусАсинхронногоИзменения ^ + --token "***" ^ + --job "dbjid:AAAIJ7t1xyhVC8tWH4ww87h6Tvea-NtCVPY9eTDkdmcnLwYZJrUuC7YhYymd6W4jQTwW-V--hjFbraM1tMNhzIw0" + ``` + + + + +```json title="Результат" +{ + ".tag": "complete" +} +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md deleted file mode 100644 index 83411ad113..0000000000 --- a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Опубликовать папку - Переводит каталог в режим публичного доступа - - - -`Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к целевому каталогу | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New"; - - Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь); -``` - - - - - - ```bash - oint dropbox ОпубликоватьПапку --token "***" \ - --path "/New" - ``` - - - - ```batch - oint dropbox ОпубликоватьПапку ^ - --token "***" ^ - --path "/New" - ``` - - - - -```json title="Результат" -{ - ".tag": "complete", - "access_type": { - ".tag": "owner" - }, - "is_inside_team_folder": false, - "is_team_folder": false, - "path_display": "/New", - "path_lower": "/new", - "name": "New", - "policy": { - "acl_update_policy": { - ".tag": "editors" - }, - "shared_link_policy": { - ".tag": "anyone" - }, - "viewer_info_policy": { - ".tag": "enabled" - } - }, - "preview_url": "https://www.dropbox.com/scl/fo/5smnsl41asw9myx8vr3c3/h?dl=0", - "shared_folder_id": "11680513169", - "time_invited": "2024-10-08T17:47:13Z", - "access_inheritance": { - ".tag": "inherit" - }, - "folder_id": "id:kJU6-a-pT48AAAAAAAAcVw" -} -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.mdx b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.mdx new file mode 100644 index 0000000000..c38494aa73 --- /dev/null +++ b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.mdx @@ -0,0 +1,85 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Опубликовать папку + Переводит каталог в режим публичного доступа + + + +`Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к целевому каталогу | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New"; + + Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь); +``` + + + + + + ```bash + oint dropbox ОпубликоватьПапку --token "***" \ + --path "/New" + ``` + + + + ```batch + oint dropbox ОпубликоватьПапку ^ + --token "***" ^ + --path "/New" + ``` + + + + +```json title="Результат" +{ + ".tag": "complete", + "access_type": { + ".tag": "owner" + }, + "is_inside_team_folder": false, + "is_team_folder": false, + "path_display": "/New", + "path_lower": "/new", + "name": "New", + "policy": { + "acl_update_policy": { + ".tag": "editors" + }, + "shared_link_policy": { + ".tag": "anyone" + }, + "viewer_info_policy": { + ".tag": "enabled" + } + }, + "preview_url": "https://www.dropbox.com/scl/fo/5smnsl41asw9myx8vr3c3/h?dl=0", + "shared_folder_id": "11680513169", + "time_invited": "2024-10-08T17:47:13Z", + "access_inheritance": { + ".tag": "inherit" + }, + "folder_id": "id:kJU6-a-pT48AAAAAAAAcVw" +} +``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Add-tag.md b/docs/ru/md/Dropbox/Tags-managment/Add-tag.md deleted file mode 100644 index a3eb35537d..0000000000 --- a/docs/ru/md/Dropbox/Tags-managment/Add-tag.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Добавить тег - Добавляет новый текстовый тег к файлу или каталогу - - - -`Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту, для которого необходимо создать тег | - | Тег | --tag | Строка | Текст тега | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Тег = "Важное"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New/mydoc.docx"; - - Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег); -``` - - - - - - ```bash - oint dropbox ДобавитьТег --token "***" \ - --path "/New/mydoc.docx" \ - --tag "Важное" - ``` - - - - ```batch - oint dropbox ДобавитьТег ^ - --token "***" ^ - --path "/New/mydoc.docx" ^ - --tag "Важное" - ``` - - - - -```json title="Результат" -{} -``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Add-tag.mdx b/docs/ru/md/Dropbox/Tags-managment/Add-tag.mdx new file mode 100644 index 0000000000..ea11ed947e --- /dev/null +++ b/docs/ru/md/Dropbox/Tags-managment/Add-tag.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Добавить тег + Добавляет новый текстовый тег к файлу или каталогу + + + +`Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту, для которого необходимо создать тег | + | Тег | --tag | Строка | Текст тега | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Тег = "Важное"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег); +``` + + + + + + ```bash + oint dropbox ДобавитьТег --token "***" \ + --path "/New/mydoc.docx" \ + --tag "Важное" + ``` + + + + ```batch + oint dropbox ДобавитьТег ^ + --token "***" ^ + --path "/New/mydoc.docx" ^ + --tag "Важное" + ``` + + + + +```json title="Результат" +{} +``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md b/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md deleted file mode 100644 index 9b5f561cae..0000000000 --- a/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить тег - Удаляет текстовый тег файла или каталога - - - -`Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту, тег которого необходимо удалить | - | Тег | --tag | Строка | Текст тега | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Тег = "Важное"; - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - Путь = "/New/mydoc.docx"; - - Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег); -``` - - - - -```json title="Результат" -{} -``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Delete-tag.mdx b/docs/ru/md/Dropbox/Tags-managment/Delete-tag.mdx new file mode 100644 index 0000000000..294a31a26e --- /dev/null +++ b/docs/ru/md/Dropbox/Tags-managment/Delete-tag.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить тег + Удаляет текстовый тег файла или каталога + + + +`Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту, тег которого необходимо удалить | + | Тег | --tag | Строка | Текст тега | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Тег = "Важное"; + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег); +``` + + + + +```json title="Результат" +{} +``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md b/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md deleted file mode 100644 index b08864bec0..0000000000 --- a/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список тегов - Получает список тегов выбранных файлов - - - -`Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Пути | --paths | Строка, Массив Из Строка | Путь или набору путей к файлам | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -
- - - - -```bsl title="Пример кода" - Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; - - МассивПутей = Новый Массив; - МассивПутей.Добавить("/New/Dogs.mp3"); - МассивПутей.Добавить("/New/mydoc.docx"); - - Результат = OPI_Dropbox.ПолучитьСписокТегов(Токен, МассивПутей); -``` - - - - - - ```bash - oint dropbox ПолучитьСписокТегов --token "***" \ - --paths "/New/mydoc.docx" - ``` - - - - ```batch - oint dropbox ПолучитьСписокТегов ^ - --token "***" ^ - --paths "/New/mydoc.docx" - ``` - - - - -```json title="Результат" -{ - "paths_to_tags": [ - { - "path": "/New/Dogs.mp3", - "tags": [] - }, - { - "path": "/New/mydoc.docx", - "tags": [ - { - ".tag": "user_generated_tag", - "tag_text": "важное" - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.mdx b/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.mdx new file mode 100644 index 0000000000..cfb018132e --- /dev/null +++ b/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список тегов + Получает список тегов выбранных файлов + + + +`Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Пути | --paths | Строка, Массив Из Строка | Путь или набору путей к файлам | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +
+ + + + +```bsl title="Пример кода" + Токен = "sl.B-uquz3utwEHepKzyqLBfnFvmY1EWTYDus5LDjT5ux5srp9PJRtr7CvMv20nVl2rRGC3K4J_X5..."; + + МассивПутей = Новый Массив; + МассивПутей.Добавить("/New/Dogs.mp3"); + МассивПутей.Добавить("/New/mydoc.docx"); + + Результат = OPI_Dropbox.ПолучитьСписокТегов(Токен, МассивПутей); +``` + + + + + + ```bash + oint dropbox ПолучитьСписокТегов --token "***" \ + --paths "/New/mydoc.docx" + ``` + + + + ```batch + oint dropbox ПолучитьСписокТегов ^ + --token "***" ^ + --paths "/New/mydoc.docx" + ``` + + + + +```json title="Результат" +{ + "paths_to_tags": [ + { + "path": "/New/Dogs.mp3", + "tags": [] + }, + { + "path": "/New/mydoc.docx", + "tags": [ + { + ".tag": "user_generated_tag", + "tag_text": "важное" + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md deleted file mode 100644 index aebdd73a6b..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Добавить календарь в список - Добавляет существующий календарь в список пользователя - - - -`Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Результат = OPI_GoogleCalendar.ДобавитьКалендарьВСписок(Токен, Календарь); -``` - - - - - - ```bash - oint gcalendar ДобавитьКалендарьВСписок --token "***" \ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - ```batch - oint gcalendar ДобавитьКалендарьВСписок ^ - --token "***" ^ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#calendarListEntry", - "etag": "\"1728409243618000\"", - "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", - "summary": "Новое наименование", - "description": "Новое описание", - "timeZone": "Europe/Moscow", - "colorId": "4", - "backgroundColor": "#fa573c", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.mdx b/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.mdx new file mode 100644 index 0000000000..5bd3adbf50 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Добавить календарь в список + Добавляет существующий календарь в список пользователя + + + +`Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Результат = OPI_GoogleCalendar.ДобавитьКалендарьВСписок(Токен, Календарь); +``` + + + + + + ```bash + oint gcalendar ДобавитьКалендарьВСписок --token "***" \ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + ```batch + oint gcalendar ДобавитьКалендарьВСписок ^ + --token "***" ^ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#calendarListEntry", + "etag": "\"1728409243618000\"", + "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", + "summary": "Новое наименование", + "description": "Новое описание", + "timeZone": "Europe/Moscow", + "colorId": "4", + "backgroundColor": "#fa573c", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md deleted file mode 100644 index 492457295b..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить календарь из списка - Удаляет календарь из списка пользователя - - - -`Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Результат = OPI_GoogleCalendar.УдалитьКалендарьИзСписка(Токен, Календарь); -``` - - - - - - ```bash - oint gcalendar УдалитьКалендарьИзСписка --token "***" \ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - ```batch - oint gcalendar УдалитьКалендарьИзСписка ^ - --token "***" ^ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.mdx b/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.mdx new file mode 100644 index 0000000000..064bbc6b6d --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить календарь из списка + Удаляет календарь из списка пользователя + + + +`Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Результат = OPI_GoogleCalendar.УдалитьКалендарьИзСписка(Токен, Календарь); +``` + + + + + + ```bash + oint gcalendar УдалитьКалендарьИзСписка --token "***" \ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + ```batch + oint gcalendar УдалитьКалендарьИзСписка ^ + --token "***" ^ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md deleted file mode 100644 index cec478037c..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Изменить календарь списка - Изменяет свойства календаря из списка пользователей - - - -`Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | ОсновнойЦвет | --primary | Строка | HEX основного цвета (#ffffff) | - | ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (#ffffff) | - | Скрытый | --hidden | Булево | Скрытый календарь | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - ОсновнойЦвет = "#000000"; - ДополнительныйЦвет = "#ffd800"; - Скрытый = Ложь; - - Результат = OPI_GoogleCalendar.ИзменитьКалендарьСписка(Токен - , Календарь - , ОсновнойЦвет - , ДополнительныйЦвет - , Скрытый); -``` - - - - - - ```bash - oint gcalendar ИзменитьКалендарьСписка --token "***" \ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" \ - --primary "#000000" \ - --secondary "#ffd800" \ - --hidden false - ``` - - - - ```batch - oint gcalendar ИзменитьКалендарьСписка ^ - --token "***" ^ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" ^ - --primary "#000000" ^ - --secondary "#ffd800" ^ - --hidden false - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#calendarListEntry", - "etag": "\"1728409243961000\"", - "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", - "summary": "Новое наименование", - "description": "Новое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.mdx b/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.mdx new file mode 100644 index 0000000000..8db2666c12 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.mdx @@ -0,0 +1,90 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Изменить календарь списка + Изменяет свойства календаря из списка пользователей + + + +`Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОсновнойЦвет | --primary | Строка | HEX основного цвета (#ffffff) | + | ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (#ffffff) | + | Скрытый | --hidden | Булево | Скрытый календарь | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + ОсновнойЦвет = "#000000"; + ДополнительныйЦвет = "#ffd800"; + Скрытый = Ложь; + + Результат = OPI_GoogleCalendar.ИзменитьКалендарьСписка(Токен + , Календарь + , ОсновнойЦвет + , ДополнительныйЦвет + , Скрытый); +``` + + + + + + ```bash + oint gcalendar ИзменитьКалендарьСписка --token "***" \ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" \ + --primary "#000000" \ + --secondary "#ffd800" \ + --hidden false + ``` + + + + ```batch + oint gcalendar ИзменитьКалендарьСписка ^ + --token "***" ^ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" ^ + --primary "#000000" ^ + --secondary "#ffd800" ^ + --hidden false + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#calendarListEntry", + "etag": "\"1728409243961000\"", + "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", + "summary": "Новое наименование", + "description": "Новое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md deleted file mode 100644 index 9f67d7032e..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список календарей - Получает массив календарей аккаунта - - - -`Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Результат = OPI_GoogleCalendar.ПолучитьСписокКалендарей(Токен); -``` - - - - - - ```bash - oint gcalendar ПолучитьСписокКалендарей --token "***" - ``` - - - - ```batch - oint gcalendar ПолучитьСписокКалендарей ^ - --token "***" - ``` - - - - -```json title="Результат" -[ - { - "kind": "calendar#calendarListEntry", - "etag": "\"1713008096300000\"", - "id": "bayselonarrend@gmail.com", - "summary": "Тестовый календарь (изм.)", - "description": "ТестовоеОписание", - "timeZone": "Europe/Minsk", - "colorId": "19", - "backgroundColor": "#fffff0", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "notificationSettings": { - "notifications": [ - { - "type": "eventCreation", - "method": "email" - }, - { - "type": "eventChange", - "method": "email" - }, - { - "type": "eventCancellation", - "method": "email" - }, - { - "type": "eventResponse", - "method": "email" - } - ] - }, - "primary": true, - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626834830000\"", - "id": "ab71c432a2cd06ecad2f5c517b3540f04d56df7aadb6df1d7b001ea4d6ac4398@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835116000\"", - "id": "c1aa2a1fe0ac12393b65eab12294daf3a09c12d5b7e54571774ddc001c4de938@group.calendar.google.com", - "summary": "\\u0422\\u0435\\u0441\\u0442\\u043e\\u0432\\u044b\\u0439 \\u043a\\u0430\\u043b\\u0435\\u043d\\u0434\\u0430\\u0440\\u044c", - "timeZone": "Europe/Moscow", - "colorId": "5", - "backgroundColor": "#ff7537", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835376000\"", - "id": "ru.by#holiday@group.v.calendar.google.com", - "summary": "Праздники Беларуси", - "description": "Праздники и памятные даты Беларуси", - "timeZone": "Europe/Minsk", - "colorId": "8", - "backgroundColor": "#16a765", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "reader", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835701000\"", - "id": "b0b7ceee4056c516b0718eed0a1e4ad8694259935a6d2ffc056325df06232841@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626835924000\"", - "id": "25f80e38669312d27a9c7441f065887c6beaacf63af84ea67ebd9251a6b5f32b@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, - { - "kind": "calendar#calendarListEntry", - "etag": "\"1720626836240000\"", - "id": "36c14edd62c430b5646cbcaecfc67ee7fe7252d1d315ba3b099efca66084f7ff@group.calendar.google.com", - "summary": "Тестовый календарь (изм.)", - "description": "Тестовое описание", - "timeZone": "Europe/Moscow", - "colorId": "11", - "backgroundColor": "#fbe983", - "foregroundColor": "#000000", - "selected": true, - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } - }, -... -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.mdx b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.mdx new file mode 100644 index 0000000000..ab3a45e74a --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.mdx @@ -0,0 +1,202 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список календарей + Получает массив календарей аккаунта + + + +`Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Результат = OPI_GoogleCalendar.ПолучитьСписокКалендарей(Токен); +``` + + + + + + ```bash + oint gcalendar ПолучитьСписокКалендарей --token "***" + ``` + + + + ```batch + oint gcalendar ПолучитьСписокКалендарей ^ + --token "***" + ``` + + + + +```json title="Результат" +[ + { + "kind": "calendar#calendarListEntry", + "etag": "\"1713008096300000\"", + "id": "bayselonarrend@gmail.com", + "summary": "Тестовый календарь (изм.)", + "description": "ТестовоеОписание", + "timeZone": "Europe/Minsk", + "colorId": "19", + "backgroundColor": "#fffff0", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "notificationSettings": { + "notifications": [ + { + "type": "eventCreation", + "method": "email" + }, + { + "type": "eventChange", + "method": "email" + }, + { + "type": "eventCancellation", + "method": "email" + }, + { + "type": "eventResponse", + "method": "email" + } + ] + }, + "primary": true, + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626834830000\"", + "id": "ab71c432a2cd06ecad2f5c517b3540f04d56df7aadb6df1d7b001ea4d6ac4398@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835116000\"", + "id": "c1aa2a1fe0ac12393b65eab12294daf3a09c12d5b7e54571774ddc001c4de938@group.calendar.google.com", + "summary": "\\u0422\\u0435\\u0441\\u0442\\u043e\\u0432\\u044b\\u0439 \\u043a\\u0430\\u043b\\u0435\\u043d\\u0434\\u0430\\u0440\\u044c", + "timeZone": "Europe/Moscow", + "colorId": "5", + "backgroundColor": "#ff7537", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835376000\"", + "id": "ru.by#holiday@group.v.calendar.google.com", + "summary": "Праздники Беларуси", + "description": "Праздники и памятные даты Беларуси", + "timeZone": "Europe/Minsk", + "colorId": "8", + "backgroundColor": "#16a765", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "reader", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835701000\"", + "id": "b0b7ceee4056c516b0718eed0a1e4ad8694259935a6d2ffc056325df06232841@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626835924000\"", + "id": "25f80e38669312d27a9c7441f065887c6beaacf63af84ea67ebd9251a6b5f32b@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, + { + "kind": "calendar#calendarListEntry", + "etag": "\"1720626836240000\"", + "id": "36c14edd62c430b5646cbcaecfc67ee7fe7252d1d315ba3b099efca66084f7ff@group.calendar.google.com", + "summary": "Тестовый календарь (изм.)", + "description": "Тестовое описание", + "timeZone": "Europe/Moscow", + "colorId": "11", + "backgroundColor": "#fbe983", + "foregroundColor": "#000000", + "selected": true, + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } + }, +... +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md deleted file mode 100644 index 3448980ef8..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить календарь списка - Получает календарь из списка пользователя по ID - - - -`Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Результат = OPI_GoogleCalendar.ПолучитьКалендарьСписка(Токен, Календарь); -``` - - - - - - ```bash - oint gcalendar ПолучитьКалендарьСписка --token "***" \ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - ```batch - oint gcalendar ПолучитьКалендарьСписка ^ - --token "***" ^ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#calendarListEntry", - "etag": "\"1728409243961000\"", - "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", - "summary": "Новое наименование", - "description": "Новое описание", - "timeZone": "Europe/Moscow", - "colorId": "6", - "backgroundColor": "#ffd800", - "foregroundColor": "#000000", - "accessRole": "owner", - "defaultReminders": [], - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.mdx b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.mdx new file mode 100644 index 0000000000..e67d7ea5a2 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить календарь списка + Получает календарь из списка пользователя по ID + + + +`Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Результат = OPI_GoogleCalendar.ПолучитьКалендарьСписка(Токен, Календарь); +``` + + + + + + ```bash + oint gcalendar ПолучитьКалендарьСписка --token "***" \ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + ```batch + oint gcalendar ПолучитьКалендарьСписка ^ + --token "***" ^ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#calendarListEntry", + "etag": "\"1728409243961000\"", + "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", + "summary": "Новое наименование", + "description": "Новое описание", + "timeZone": "Europe/Moscow", + "colorId": "6", + "backgroundColor": "#ffd800", + "foregroundColor": "#000000", + "accessRole": "owner", + "defaultReminders": [], + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md deleted file mode 100644 index 9d93502f4f..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Очистить основной календарь - Очищает список событий основного календаря - - - -`Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - - Результат = OPI_GoogleCalendar.ОчиститьОсновнойКалендарь(Токен); -``` - - - - - - ```bash - oint gcalendar ОчиститьОсновнойКалендарь --token "***" - ``` - - - - ```batch - oint gcalendar ОчиститьОсновнойКалендарь ^ - --token "***" - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.mdx b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.mdx new file mode 100644 index 0000000000..1fc9e6dd31 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Очистить основной календарь + Очищает список событий основного календаря + + + +`Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + + Результат = OPI_GoogleCalendar.ОчиститьОсновнойКалендарь(Токен); +``` + + + + + + ```bash + oint gcalendar ОчиститьОсновнойКалендарь --token "***" + ``` + + + + ```batch + oint gcalendar ОчиститьОсновнойКалендарь ^ + --token "***" + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md deleted file mode 100644 index 48e08569ca..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать календарь - Создает пустой календарь - - - -`Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Наименование | --title | Строка | Наименование создаваемого календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Наименование = "Тестовый календарь"; - - Результат = OPI_GoogleCalendar.СоздатьКалендарь(Токен, Наименование); -``` - - - - - - ```bash - oint gcalendar СоздатьКалендарь --token "***" \ - --title "Тестовый календарь" - ``` - - - - ```batch - oint gcalendar СоздатьКалендарь ^ - --token "***" ^ - --title "Тестовый календарь" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#calendar", - "etag": "\"3HshD0LA889W8w5lSPGvE18X3Co\"", - "id": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", - "summary": "Тестовый календарь", - "timeZone": "Europe/Moscow", - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.mdx b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.mdx new file mode 100644 index 0000000000..2195e27e9c --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать календарь + Создает пустой календарь + + + +`Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Наименование | --title | Строка | Наименование создаваемого календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Наименование = "Тестовый календарь"; + + Результат = OPI_GoogleCalendar.СоздатьКалендарь(Токен, Наименование); +``` + + + + + + ```bash + oint gcalendar СоздатьКалендарь --token "***" \ + --title "Тестовый календарь" + ``` + + + + ```batch + oint gcalendar СоздатьКалендарь ^ + --token "***" ^ + --title "Тестовый календарь" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#calendar", + "etag": "\"3HshD0LA889W8w5lSPGvE18X3Co\"", + "id": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", + "summary": "Тестовый календарь", + "timeZone": "Europe/Moscow", + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md deleted file mode 100644 index c8e219ff19..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить календарь - Удаляет календарь по ID - - - -`Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Результат = OPI_GoogleCalendar.УдалитьКалендарь(Токен, Календарь); -``` - - - - - - ```bash - oint gcalendar УдалитьКалендарь --token "***" \ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" - ``` - - - - ```batch - oint gcalendar УдалитьКалендарь ^ - --token "***" ^ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.mdx b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.mdx new file mode 100644 index 0000000000..ebc9290f41 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить календарь + Удаляет календарь по ID + + + +`Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Результат = OPI_GoogleCalendar.УдалитьКалендарь(Токен, Календарь); +``` + + + + + + ```bash + oint gcalendar УдалитьКалендарь --token "***" \ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" + ``` + + + + ```batch + oint gcalendar УдалитьКалендарь ^ + --token "***" ^ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md deleted file mode 100644 index 64bb081914..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить календарь - Изменяет свойства существуещего календаря - - - -`Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | Наименование | --title | Строка | Новое наименование | - | Описание | --description | Строка | Новое описание календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Наименование = "Новое наименование"; - Описание = "Новое описание"; - - Результат = OPI_GoogleCalendar.ИзменитьМетаданныеКалендаря(Токен, Календарь, Наименование, Описание); -``` - - - - - - ```bash - oint gcalendar ИзменитьМетаданныеКалендаря --token "***" \ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" \ - --title "Новое наименование" \ - --description "Новое описание" - ``` - - - - ```batch - oint gcalendar ИзменитьМетаданныеКалендаря ^ - --token "***" ^ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" ^ - --title "Новое наименование" ^ - --description "Новое описание" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#calendar", - "etag": "\"-qYh74xTwKSw29QLKr4MJFvKBgU\"", - "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", - "summary": "Новое наименование", - "description": "Новое описание", - "timeZone": "Europe/Moscow", - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.mdx b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.mdx new file mode 100644 index 0000000000..ec41a4c8d7 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить календарь + Изменяет свойства существуещего календаря + + + +`Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Наименование = "Новое наименование"; + Описание = "Новое описание"; + + Результат = OPI_GoogleCalendar.ИзменитьМетаданныеКалендаря(Токен, Календарь, Наименование, Описание); +``` + + + + + + ```bash + oint gcalendar ИзменитьМетаданныеКалендаря --token "***" \ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" \ + --title "Новое наименование" \ + --description "Новое описание" + ``` + + + + ```batch + oint gcalendar ИзменитьМетаданныеКалендаря ^ + --token "***" ^ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" ^ + --title "Новое наименование" ^ + --description "Новое описание" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#calendar", + "etag": "\"-qYh74xTwKSw29QLKr4MJFvKBgU\"", + "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", + "summary": "Новое наименование", + "description": "Новое описание", + "timeZone": "Europe/Moscow", + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md deleted file mode 100644 index 817207df15..0000000000 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить календарь - Получает информацию о календаре по ID - - - -`Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Результат = OPI_GoogleCalendar.ПолучитьМетаданныеКалендаря(Токен, Календарь); -``` - - - - - - ```bash - oint gcalendar ПолучитьМетаданныеКалендаря --token "***" \ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - ```batch - oint gcalendar ПолучитьМетаданныеКалендаря ^ - --token "***" ^ - --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#calendar", - "etag": "\"-qYh74xTwKSw29QLKr4MJFvKBgU\"", - "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", - "summary": "Новое наименование", - "description": "Новое описание", - "timeZone": "Europe/Moscow", - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - } -} -``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.mdx b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.mdx new file mode 100644 index 0000000000..c906006e90 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить календарь + Получает информацию о календаре по ID + + + +`Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Результат = OPI_GoogleCalendar.ПолучитьМетаданныеКалендаря(Токен, Календарь); +``` + + + + + + ```bash + oint gcalendar ПолучитьМетаданныеКалендаря --token "***" \ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + ```batch + oint gcalendar ПолучитьМетаданныеКалендаря ^ + --token "***" ^ + --calendar "f2a98bd1d17474fbd6db370f9759c6ab51d226bdb04aebf6eb683160c8361192@group.calendar.google.com" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#calendar", + "etag": "\"-qYh74xTwKSw29QLKr4MJFvKBgU\"", + "id": "cc92fd648db664e3e2fcd62db4c9fd9f458cc49bbc6382560c48f59105aede70@group.calendar.google.com", + "summary": "Новое наименование", + "description": "Новое описание", + "timeZone": "Europe/Moscow", + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + } +} +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Create-event.md b/docs/ru/md/Google_Calendar/Event-management/Create-event.md deleted file mode 100644 index 5d84b2e02f..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Create-event.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Создать событие - Создает новое событие - - - -`Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | ОписаниеСобытия | --props | Соответствие Из КлючИЗначение | Описание события | - - - Возвращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google - -
- - - - -```bsl title="Пример кода" - ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Наименование = "Новое событие"; - Описание = "Описание тестового события"; - Час = 3600; - - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные или Путь к файлу - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные или Путь к файлу - Вложения = Новый Соответствие; - - Вложения.Вставить("Картинка1", Картинка1); - Вложения.Вставить("Картинка2", Картинка2); - - ОписаниеСобытия = Новый Соответствие; - ОписаниеСобытия.Вставить("Описание" , Описание); - ОписаниеСобытия.Вставить("Заголовок" , Наименование); - ОписаниеСобытия.Вставить("МестоПроведения" , "В офисе"); - ОписаниеСобытия.Вставить("ДатаНачала" , ТекущаяДата); - ОписаниеСобытия.Вставить("ДатаОкончания" , ОписаниеСобытия["ДатаНачала"] + Час); - ОписаниеСобытия.Вставить("МассивURLФайловВложений" , Вложения); - ОписаниеСобытия.Вставить("ОтправлятьУведомления" , Истина); - - Результат = OPI_GoogleCalendar.СоздатьСобытие(Токен, Календарь, ОписаниеСобытия); -``` - - - - - - ```bash - oint gcalendar СоздатьСобытие --token "***" \ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ - --props "{'Описание':'Описание тестового события','Заголовок':'Новое событие','МестоПроведения':'В офисе','ДатаНачала':'2024-10-15T09:13:26.4387614Z','ДатаОкончания':'2024-10-15T10:13:26.4387614Z','МассивURLФайловВложений':{'Картинка1':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','Картинка2':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'},'ОтправлятьУведомления':true}" - ``` - - - - ```batch - oint gcalendar СоздатьСобытие ^ - --token "***" ^ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ - --props "{'Описание':'Описание тестового события','Заголовок':'Новое событие','МестоПроведения':'В офисе','ДатаНачала':'2024-10-15T09:13:26.4387614Z','ДатаОкончания':'2024-10-15T10:13:26.4387614Z','МассивURLФайловВложений':{'Картинка1':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','Картинка2':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'},'ОтправлятьУведомления':true}" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#event", - "etag": "\"3456818523024000\"", - "id": "ukaeqabapn045fr78jnkr0m6dk", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", - "created": "2024-10-08T17:41:01Z", - "updated": "2024-10-08T17:41:01.512Z", - "summary": "Новое событие", - "description": "Описание тестового события", - "location": "В офисе", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", - "displayName": "Тестовый календарь", - "self": true - }, - "start": { - "dateTime": "2024-10-08T23:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T00:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Картинка1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Картинка2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Create-event.mdx b/docs/ru/md/Google_Calendar/Event-management/Create-event.mdx new file mode 100644 index 0000000000..f2a373f7c2 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Create-event.mdx @@ -0,0 +1,125 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Создать событие + Создает новое событие + + + +`Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОписаниеСобытия | --props | Соответствие Из КлючИЗначение | Описание события | + + + Возвращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google + +
+ + + + +```bsl title="Пример кода" + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Наименование = "Новое событие"; + Описание = "Описание тестового события"; + Час = 3600; + + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные или Путь к файлу + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные или Путь к файлу + Вложения = Новый Соответствие; + + Вложения.Вставить("Картинка1", Картинка1); + Вложения.Вставить("Картинка2", Картинка2); + + ОписаниеСобытия = Новый Соответствие; + ОписаниеСобытия.Вставить("Описание" , Описание); + ОписаниеСобытия.Вставить("Заголовок" , Наименование); + ОписаниеСобытия.Вставить("МестоПроведения" , "В офисе"); + ОписаниеСобытия.Вставить("ДатаНачала" , ТекущаяДата); + ОписаниеСобытия.Вставить("ДатаОкончания" , ОписаниеСобытия["ДатаНачала"] + Час); + ОписаниеСобытия.Вставить("МассивURLФайловВложений" , Вложения); + ОписаниеСобытия.Вставить("ОтправлятьУведомления" , Истина); + + Результат = OPI_GoogleCalendar.СоздатьСобытие(Токен, Календарь, ОписаниеСобытия); +``` + + + + + + ```bash + oint gcalendar СоздатьСобытие --token "***" \ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ + --props "{'Описание':'Описание тестового события','Заголовок':'Новое событие','МестоПроведения':'В офисе','ДатаНачала':'2024-10-15T09:13:26.4387614Z','ДатаОкончания':'2024-10-15T10:13:26.4387614Z','МассивURLФайловВложений':{'Картинка1':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','Картинка2':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'},'ОтправлятьУведомления':true}" + ``` + + + + ```batch + oint gcalendar СоздатьСобытие ^ + --token "***" ^ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ + --props "{'Описание':'Описание тестового события','Заголовок':'Новое событие','МестоПроведения':'В офисе','ДатаНачала':'2024-10-15T09:13:26.4387614Z','ДатаОкончания':'2024-10-15T10:13:26.4387614Z','МассивURLФайловВложений':{'Картинка1':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','Картинка2':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'},'ОтправлятьУведомления':true}" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#event", + "etag": "\"3456818523024000\"", + "id": "ukaeqabapn045fr78jnkr0m6dk", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", + "created": "2024-10-08T17:41:01Z", + "updated": "2024-10-08T17:41:01.512Z", + "summary": "Новое событие", + "description": "Описание тестового события", + "location": "В офисе", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", + "displayName": "Тестовый календарь", + "self": true + }, + "start": { + "dateTime": "2024-10-08T23:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T00:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Картинка1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Картинка2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Delete-event.md b/docs/ru/md/Google_Calendar/Event-management/Delete-event.md deleted file mode 100644 index 36bcf25b20..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Delete-event.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Удалить событие - Удаляет событие по ID - - - -`Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | Событие | --event | Строка | ID события | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Событие = "33cn8ioc097i92k9i37mvpbj50"; - - Результат = OPI_GoogleCalendar.УдалитьСобытие(Токен, Календарь, Событие); -``` - - - - - - ```bash - oint gcalendar УдалитьСобытие --token "***" \ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - ```batch - oint gcalendar УдалитьСобытие ^ - --token "***" ^ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Delete-event.mdx b/docs/ru/md/Google_Calendar/Event-management/Delete-event.mdx new file mode 100644 index 0000000000..c2d41e9220 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Delete-event.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Удалить событие + Удаляет событие по ID + + + +`Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Событие | --event | Строка | ID события | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Событие = "33cn8ioc097i92k9i37mvpbj50"; + + Результат = OPI_GoogleCalendar.УдалитьСобытие(Токен, Календарь, Событие); +``` + + + + + + ```bash + oint gcalendar УдалитьСобытие --token "***" \ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + ```batch + oint gcalendar УдалитьСобытие ^ + --token "***" ^ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Edit-event.md b/docs/ru/md/Google_Calendar/Event-management/Edit-event.md deleted file mode 100644 index 4dcc7836a2..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Edit-event.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Изменить событие - Изменяет существующее событие - - - -`Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | ОписаниеСобытия | --props | Строка | Новое описание события | - | Событие | --event | Строка | ID события | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Событие = "33cn8ioc097i92k9i37mvpbj50"; - Описание = "Новое описание события"; - - ОписаниеСобытия = Новый Соответствие; - ОписаниеСобытия.Вставить("Описание", Описание); - - Результат = OPI_GoogleCalendar.ИзменитьСобытие(Токен, Календарь, ОписаниеСобытия, Событие); -``` - - - - - - ```bash - oint gcalendar ИзменитьСобытие --token "***" \ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ - --props "{'Описание':'Новое описание события'}" \ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - ```batch - oint gcalendar ИзменитьСобытие ^ - --token "***" ^ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ - --props "{'Описание':'Новое описание события'}" ^ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#event", - "etag": "\"3456818524660000\"", - "id": "ukaeqabapn045fr78jnkr0m6dk", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", - "created": "2024-10-08T17:41:01Z", - "updated": "2024-10-08T17:41:02.33Z", - "summary": "Новое событие", - "description": "Новое описание события", - "location": "В офисе", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", - "displayName": "Тестовый календарь", - "self": true - }, - "start": { - "dateTime": "2024-10-08T23:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T00:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Картинка1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Картинка2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Edit-event.mdx b/docs/ru/md/Google_Calendar/Event-management/Edit-event.mdx new file mode 100644 index 0000000000..a82b990272 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Edit-event.mdx @@ -0,0 +1,113 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Изменить событие + Изменяет существующее событие + + + +`Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОписаниеСобытия | --props | Строка | Новое описание события | + | Событие | --event | Строка | ID события | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Событие = "33cn8ioc097i92k9i37mvpbj50"; + Описание = "Новое описание события"; + + ОписаниеСобытия = Новый Соответствие; + ОписаниеСобытия.Вставить("Описание", Описание); + + Результат = OPI_GoogleCalendar.ИзменитьСобытие(Токен, Календарь, ОписаниеСобытия, Событие); +``` + + + + + + ```bash + oint gcalendar ИзменитьСобытие --token "***" \ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ + --props "{'Описание':'Новое описание события'}" \ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + ```batch + oint gcalendar ИзменитьСобытие ^ + --token "***" ^ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ + --props "{'Описание':'Новое описание события'}" ^ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#event", + "etag": "\"3456818524660000\"", + "id": "ukaeqabapn045fr78jnkr0m6dk", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", + "created": "2024-10-08T17:41:01Z", + "updated": "2024-10-08T17:41:02.33Z", + "summary": "Новое событие", + "description": "Новое описание события", + "location": "В офисе", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", + "displayName": "Тестовый календарь", + "self": true + }, + "start": { + "dateTime": "2024-10-08T23:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T00:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Картинка1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Картинка2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md b/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md deleted file mode 100644 index 91c3aea10d..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить описание события - Получает пустой макет для создания события - - - -`Функция ПолучитьОписаниеСобытия(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события - -
- - - - -```bsl title="Пример кода" - Результат = OPI_GoogleCalendar.ПолучитьОписаниеСобытия(); -``` - - - - - - ```bash - oint gcalendar ПолучитьОписаниеСобытия --empty false - ``` - - - - ```batch - oint gcalendar ПолучитьОписаниеСобытия ^ - --empty false - ``` - - - - -```json title="Результат" -{ - "Описание": "", - "Заголовок": "Новое событие", - "МестоПроведения": "", - "ДатаНачала": "2024-10-08T20:41:05.7690472Z", - "ДатаОкончания": "2024-10-08T21:41:05.7690472Z", - "МассивURLФайловВложений": {}, - "ОтправлятьУведомления": true -} -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event-description.mdx b/docs/ru/md/Google_Calendar/Event-management/Get-event-description.mdx new file mode 100644 index 0000000000..c7065062b2 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event-description.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить описание события + Получает пустой макет для создания события + + + +`Функция ПолучитьОписаниеСобытия(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_GoogleCalendar.ПолучитьОписаниеСобытия(); +``` + + + + + + ```bash + oint gcalendar ПолучитьОписаниеСобытия --empty false + ``` + + + + ```batch + oint gcalendar ПолучитьОписаниеСобытия ^ + --empty false + ``` + + + + +```json title="Результат" +{ + "Описание": "", + "Заголовок": "Новое событие", + "МестоПроведения": "", + "ДатаНачала": "2024-10-08T20:41:05.7690472Z", + "ДатаОкончания": "2024-10-08T21:41:05.7690472Z", + "МассивURLФайловВложений": {}, + "ОтправлятьУведомления": true +} +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md b/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md deleted file mode 100644 index 757a596183..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список событий - Получает список всех событий календаря - - - -`Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - - Результат = OPI_GoogleCalendar.ПолучитьСписокСобытий(Токен, Календарь); -``` - - - - - - ```bash - oint gcalendar ПолучитьСписокСобытий --token "***" \ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" - ``` - - - - ```batch - oint gcalendar ПолучитьСписокСобытий ^ - --token "***" ^ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" - ``` - - - - -```json title="Результат" -[ - { - "kind": "calendar#event", - "etag": "\"3456818530772000\"", - "id": "ukaeqabapn045fr78jnkr0m6dk", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", - "created": "2024-10-08T17:41:01Z", - "updated": "2024-10-08T17:41:05.386Z", - "summary": "Новое событие", - "description": "Новое описание события", - "location": "В офисе", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", - "displayName": "Тестовый календарь", - "self": true - }, - "start": { - "dateTime": "2024-10-08T23:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T00:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Картинка1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Картинка2", - "iconLink": "" - } - ], - "eventType": "default" - } -] -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event-list.mdx b/docs/ru/md/Google_Calendar/Event-management/Get-event-list.mdx new file mode 100644 index 0000000000..10c44f0f88 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event-list.mdx @@ -0,0 +1,104 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список событий + Получает список всех событий календаря + + + +`Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + + Результат = OPI_GoogleCalendar.ПолучитьСписокСобытий(Токен, Календарь); +``` + + + + + + ```bash + oint gcalendar ПолучитьСписокСобытий --token "***" \ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" + ``` + + + + ```batch + oint gcalendar ПолучитьСписокСобытий ^ + --token "***" ^ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" + ``` + + + + +```json title="Результат" +[ + { + "kind": "calendar#event", + "etag": "\"3456818530772000\"", + "id": "ukaeqabapn045fr78jnkr0m6dk", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", + "created": "2024-10-08T17:41:01Z", + "updated": "2024-10-08T17:41:05.386Z", + "summary": "Новое событие", + "description": "Новое описание события", + "location": "В офисе", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", + "displayName": "Тестовый календарь", + "self": true + }, + "start": { + "dateTime": "2024-10-08T23:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T00:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Картинка1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Картинка2", + "iconLink": "" + } + ], + "eventType": "default" + } +] +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event.md b/docs/ru/md/Google_Calendar/Event-management/Get-event.md deleted file mode 100644 index 8177eb746d..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить событие - Получает событие по ID - - - -`Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | Событие | --event | Строка | ID события | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - Событие = "33cn8ioc097i92k9i37mvpbj50"; - - Результат = OPI_GoogleCalendar.ПолучитьСобытие(Токен, Календарь, Событие); -``` - - - - - - ```bash - oint gcalendar ПолучитьСобытие --token "***" \ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - ```batch - oint gcalendar ПолучитьСобытие ^ - --token "***" ^ - --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#event", - "etag": "\"3456818524660000\"", - "id": "ukaeqabapn045fr78jnkr0m6dk", - "status": "confirmed", - "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", - "created": "2024-10-08T17:41:01Z", - "updated": "2024-10-08T17:41:02.33Z", - "summary": "Новое событие", - "description": "Новое описание события", - "location": "В офисе", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", - "displayName": "Тестовый календарь", - "self": true - }, - "start": { - "dateTime": "2024-10-08T23:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T00:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Картинка1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Картинка2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event.mdx b/docs/ru/md/Google_Calendar/Event-management/Get-event.mdx new file mode 100644 index 0000000000..dbf0f9dad1 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event.mdx @@ -0,0 +1,106 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить событие + Получает событие по ID + + + +`Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Событие | --event | Строка | ID события | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Календарь = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + Событие = "33cn8ioc097i92k9i37mvpbj50"; + + Результат = OPI_GoogleCalendar.ПолучитьСобытие(Токен, Календарь, Событие); +``` + + + + + + ```bash + oint gcalendar ПолучитьСобытие --token "***" \ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + ```batch + oint gcalendar ПолучитьСобытие ^ + --token "***" ^ + --calendar "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#event", + "etag": "\"3456818524660000\"", + "id": "ukaeqabapn045fr78jnkr0m6dk", + "status": "confirmed", + "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", + "created": "2024-10-08T17:41:01Z", + "updated": "2024-10-08T17:41:02.33Z", + "summary": "Новое событие", + "description": "Новое описание события", + "location": "В офисе", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "f8cb253516cc990d1f36a7d15cdb825ffdc15c6ceeaa25ef78924de9beea3a56@group.calendar.google.com", + "displayName": "Тестовый календарь", + "self": true + }, + "start": { + "dateTime": "2024-10-08T23:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T00:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Картинка1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Картинка2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Move-event.md b/docs/ru/md/Google_Calendar/Event-management/Move-event.md deleted file mode 100644 index 9e890646c7..0000000000 --- a/docs/ru/md/Google_Calendar/Event-management/Move-event.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Переместить событие - Перемещает событие в другой календарь - - - -`Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | КалендарьИсточник | --from | Строка | ID календаря источника | - | КалендарьПриемник | --to | Строка | ID календаря приемника | - | Событие | --event | Строка | ID события календаря источника | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Событие = "33cn8ioc097i92k9i37mvpbj50"; - - КалендарьИсточник = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; - КалендарьПриемник = "bayselonarrend@gmail.com"; - - Результат = OPI_GoogleCalendar.ПереместитьСобытие(Токен, КалендарьИсточник, КалендарьПриемник, Событие); -``` - - - - - - ```bash - oint gcalendar ПереместитьСобытие --token "***" \ - --from "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ - --to "bayselonarrend@gmail.com" \ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - ```batch - oint gcalendar ПереместитьСобытие ^ - --token "***" ^ - --from "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ - --to "bayselonarrend@gmail.com" ^ - --event "5e58j0l1rk57vsa1jr7sbqjq70" - ``` - - - - -```json title="Результат" -{ - "kind": "calendar#event", - "etag": "\"3456818524660000\"", - "id": "ukaeqabapn045fr78jnkr0m6dk", - "status": "cancelled", - "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", - "created": "2024-10-08T17:41:01Z", - "updated": "2024-10-08T17:41:02.33Z", - "summary": "Новое событие", - "description": "Новое описание события", - "location": "В офисе", - "creator": { - "email": "bayselonarrend@gmail.com" - }, - "organizer": { - "email": "bayselonarrend@gmail.com" - }, - "start": { - "dateTime": "2024-10-08T23:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "end": { - "dateTime": "2024-10-09T00:41:01+03:00", - "timeZone": "Europe/Moscow" - }, - "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", - "sequence": 0, - "reminders": { - "useDefault": true - }, - "attachments": [ - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "title": "Картинка1", - "iconLink": "" - }, - { - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "title": "Картинка2", - "iconLink": "" - } - ], - "eventType": "default" -} -``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Move-event.mdx b/docs/ru/md/Google_Calendar/Event-management/Move-event.mdx new file mode 100644 index 0000000000..4ff2291711 --- /dev/null +++ b/docs/ru/md/Google_Calendar/Event-management/Move-event.mdx @@ -0,0 +1,109 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Переместить событие + Перемещает событие в другой календарь + + + +`Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | КалендарьИсточник | --from | Строка | ID календаря источника | + | КалендарьПриемник | --to | Строка | ID календаря приемника | + | Событие | --event | Строка | ID события календаря источника | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Событие = "33cn8ioc097i92k9i37mvpbj50"; + + КалендарьИсточник = "2cd4d2b5dc7a898d4f1d65956b5ccca32841aff4a1603b373ff14db442ac9fab@group.calendar.google.com"; + КалендарьПриемник = "bayselonarrend@gmail.com"; + + Результат = OPI_GoogleCalendar.ПереместитьСобытие(Токен, КалендарьИсточник, КалендарьПриемник, Событие); +``` + + + + + + ```bash + oint gcalendar ПереместитьСобытие --token "***" \ + --from "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" \ + --to "bayselonarrend@gmail.com" \ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + ```batch + oint gcalendar ПереместитьСобытие ^ + --token "***" ^ + --from "95bed4847e3734e9f1e6513c9eb637e885c5996c77711c19a10348453ecb11fe@group.calendar.google.com" ^ + --to "bayselonarrend@gmail.com" ^ + --event "5e58j0l1rk57vsa1jr7sbqjq70" + ``` + + + + +```json title="Результат" +{ + "kind": "calendar#event", + "etag": "\"3456818524660000\"", + "id": "ukaeqabapn045fr78jnkr0m6dk", + "status": "cancelled", + "htmlLink": "https://www.google.com/calendar/event?eid=dWthZXFhYmFwbjA0NWZyNzhqbmtyMG02ZGsgZjhjYjI1MzUxNmNjOTkwZDFmMzZhN2QxNWNkYjgyNWZmZGMxNWM2Y2VlYWEyNWVmNzg5MjRkZTliZWVhM2E1NkBn", + "created": "2024-10-08T17:41:01Z", + "updated": "2024-10-08T17:41:02.33Z", + "summary": "Новое событие", + "description": "Новое описание события", + "location": "В офисе", + "creator": { + "email": "bayselonarrend@gmail.com" + }, + "organizer": { + "email": "bayselonarrend@gmail.com" + }, + "start": { + "dateTime": "2024-10-08T23:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "end": { + "dateTime": "2024-10-09T00:41:01+03:00", + "timeZone": "Europe/Moscow" + }, + "iCalUID": "ukaeqabapn045fr78jnkr0m6dk@google.com", + "sequence": 0, + "reminders": { + "useDefault": true + }, + "attachments": [ + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "title": "Картинка1", + "iconLink": "" + }, + { + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "title": "Картинка2", + "iconLink": "" + } + ], + "eventType": "default" +} +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Create-comment.md b/docs/ru/md/Google_Drive/Comment-management/Create-comment.md deleted file mode 100644 index 8968f11889..0000000000 --- a/docs/ru/md/Google_Drive/Comment-management/Create-comment.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать комментарий - Создает комментарий к файлу или каталогу - - - -`Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор объекта, для которого необходим комментарий | - | Комментарий | --text | Строка | Текст комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - Комментарий = "Текст комментария"; - - Результат = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий); -``` - - - - - - ```bash - oint gdrive СоздатьКомментарий --token "***" \ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" \ - --text "Текст комментария" - ``` - - - - ```batch - oint gdrive СоздатьКомментарий ^ - --token "***" ^ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" ^ - --text "Текст комментария" - ``` - - - - -```json title="Результат" -{ - "id": "AAABW19Pq0I", - "kind": "drive#comment", - "createdTime": "2024-10-08T17:42:33.807Z", - "modifiedTime": "2024-10-08T17:42:33.807Z", - "replies": [], - "author": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" - }, - "deleted": false, - "htmlContent": "Текст комментария", - "content": "Текст комментария" -} -``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Create-comment.mdx b/docs/ru/md/Google_Drive/Comment-management/Create-comment.mdx new file mode 100644 index 0000000000..1b22b180c3 --- /dev/null +++ b/docs/ru/md/Google_Drive/Comment-management/Create-comment.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать комментарий + Создает комментарий к файлу или каталогу + + + +`Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта, для которого необходим комментарий | + | Комментарий | --text | Строка | Текст комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + Комментарий = "Текст комментария"; + + Результат = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий); +``` + + + + + + ```bash + oint gdrive СоздатьКомментарий --token "***" \ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" \ + --text "Текст комментария" + ``` + + + + ```batch + oint gdrive СоздатьКомментарий ^ + --token "***" ^ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" ^ + --text "Текст комментария" + ``` + + + + +```json title="Результат" +{ + "id": "AAABW19Pq0I", + "kind": "drive#comment", + "createdTime": "2024-10-08T17:42:33.807Z", + "modifiedTime": "2024-10-08T17:42:33.807Z", + "replies": [], + "author": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" + }, + "deleted": false, + "htmlContent": "Текст комментария", + "content": "Текст комментария" +} +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md deleted file mode 100644 index 1893c38203..0000000000 --- a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить комментарий - Удаляет комментарий по ID - - - -`Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | - | ИДКомментария | --comment | Строка | Идентификатор комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - ИДКомментария = "AAABXOyqKNE"; - - Результат = OPI_GoogleDrive.УдалитьКомментарий(Токен, Идентификатор, ИДКомментария); -``` - - - - - - ```bash - oint gdrive УдалитьКомментарий --token "***" \ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" \ - --comment "AAABRYiX070" - ``` - - - - ```batch - oint gdrive УдалитьКомментарий ^ - --token "***" ^ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" ^ - --comment "AAABRYiX070" - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.mdx b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.mdx new file mode 100644 index 0000000000..d182dfde50 --- /dev/null +++ b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить комментарий + Удаляет комментарий по ID + + + +`Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | + | ИДКомментария | --comment | Строка | Идентификатор комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + ИДКомментария = "AAABXOyqKNE"; + + Результат = OPI_GoogleDrive.УдалитьКомментарий(Токен, Идентификатор, ИДКомментария); +``` + + + + + + ```bash + oint gdrive УдалитьКомментарий --token "***" \ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" \ + --comment "AAABRYiX070" + ``` + + + + ```batch + oint gdrive УдалитьКомментарий ^ + --token "***" ^ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" ^ + --comment "AAABRYiX070" + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md b/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md deleted file mode 100644 index 410643503b..0000000000 --- a/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить список комментариев - Получает список всех комментариев объекта - - - -`Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДОбъекта | --object | Строка | Идентификатор объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - - Результат = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, Идентификатор); -``` - - - - - - ```bash - oint gdrive ПолучитьСписокКомментариев --token "***" \ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" - ``` - - - - ```batch - oint gdrive ПолучитьСписокКомментариев ^ - --token "***" ^ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" - ``` - - - - -```json title="Результат" -{ - "kind": "drive#commentList", - "comments": [ - { - "id": "AAABW19Pq0I", - "kind": "drive#comment", - "createdTime": "2024-10-08T17:42:33.807Z", - "modifiedTime": "2024-10-08T17:42:33.807Z", - "replies": [], - "author": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" - }, - "deleted": false, - "htmlContent": "Текст комментария", - "content": "Текст комментария" - } - ] -} -``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.mdx b/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.mdx new file mode 100644 index 0000000000..96f8dafafa --- /dev/null +++ b/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить список комментариев + Получает список всех комментариев объекта + + + +`Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + + Результат = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, Идентификатор); +``` + + + + + + ```bash + oint gdrive ПолучитьСписокКомментариев --token "***" \ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" + ``` + + + + ```batch + oint gdrive ПолучитьСписокКомментариев ^ + --token "***" ^ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" + ``` + + + + +```json title="Результат" +{ + "kind": "drive#commentList", + "comments": [ + { + "id": "AAABW19Pq0I", + "kind": "drive#comment", + "createdTime": "2024-10-08T17:42:33.807Z", + "modifiedTime": "2024-10-08T17:42:33.807Z", + "replies": [], + "author": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" + }, + "deleted": false, + "htmlContent": "Текст комментария", + "content": "Текст комментария" + } + ] +} +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment.md b/docs/ru/md/Google_Drive/Comment-management/Get-comment.md deleted file mode 100644 index 400f2916ac..0000000000 --- a/docs/ru/md/Google_Drive/Comment-management/Get-comment.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить комментарий - Получает комментарий по ID - - - -`Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | - | ИДКомментария | --comment | Строка | Идентификатор комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - ИДКомментария = "AAABXOyqKNE"; - - Результат = OPI_GoogleDrive.ПолучитьКомментарий(Токен, Идентификатор, ИДКомментария); -``` - - - - - - ```bash - oint gdrive ПолучитьКомментарий --token "***" \ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" \ - --comment "AAABRYiX070" - ``` - - - - ```batch - oint gdrive ПолучитьКомментарий ^ - --token "***" ^ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" ^ - --comment "AAABRYiX070" - ``` - - - - -```json title="Результат" -{ - "id": "AAABW19Pq0I", - "kind": "drive#comment", - "createdTime": "2024-10-08T17:42:33.807Z", - "modifiedTime": "2024-10-08T17:42:33.807Z", - "replies": [], - "author": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" - }, - "deleted": false, - "htmlContent": "Текст комментария", - "content": "Текст комментария" -} -``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment.mdx b/docs/ru/md/Google_Drive/Comment-management/Get-comment.mdx new file mode 100644 index 0000000000..e77d09a142 --- /dev/null +++ b/docs/ru/md/Google_Drive/Comment-management/Get-comment.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить комментарий + Получает комментарий по ID + + + +`Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | + | ИДКомментария | --comment | Строка | Идентификатор комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + ИДКомментария = "AAABXOyqKNE"; + + Результат = OPI_GoogleDrive.ПолучитьКомментарий(Токен, Идентификатор, ИДКомментария); +``` + + + + + + ```bash + oint gdrive ПолучитьКомментарий --token "***" \ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" \ + --comment "AAABRYiX070" + ``` + + + + ```batch + oint gdrive ПолучитьКомментарий ^ + --token "***" ^ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" ^ + --comment "AAABRYiX070" + ``` + + + + +```json title="Результат" +{ + "id": "AAABW19Pq0I", + "kind": "drive#comment", + "createdTime": "2024-10-08T17:42:33.807Z", + "modifiedTime": "2024-10-08T17:42:33.807Z", + "replies": [], + "author": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s50-c-k-no" + }, + "deleted": false, + "htmlContent": "Текст комментария", + "content": "Текст комментария" +} +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md b/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md deleted file mode 100644 index 730cb7b553..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Скоприровать объект - Копирует файл или каталог - - - -`Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор объекта | - | НовоеИмя | --title | Строка | Новое имя объекта | - | НовыйРодитель | --catalog | Строка | Новый каталог размещения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - НовоеИмя = "Скопированный файл.jpeg"; - НовыйРодитель = "root"; - - Результат = OPI_GoogleDrive.СкопироватьОбъект(Токен, Идентификатор, НовоеИмя, НовыйРодитель); -``` - - - - - - ```bash - oint gdrive СкопироватьОбъект --token "***" \ - --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" \ - --title "Скопированный файл.jpeg" \ - --catalog "root" - ``` - - - - ```batch - oint gdrive СкопироватьОбъект ^ - --token "***" ^ - --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" ^ - --title "Скопированный файл.jpeg" ^ - --catalog "root" - ``` - - - - -```json title="Результат" -{ - "kind": "drive#file", - "id": "1P8WK9Wn2710HiQYkKzYMFso2FmFenV6d", - "name": "Скопированный файл.jpeg", - "mimeType": "image/jpeg" -} -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.mdx new file mode 100644 index 0000000000..26a649af6a --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Скоприровать объект + Копирует файл или каталог + + + +`Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта | + | НовоеИмя | --title | Строка | Новое имя объекта | + | НовыйРодитель | --catalog | Строка | Новый каталог размещения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + НовоеИмя = "Скопированный файл.jpeg"; + НовыйРодитель = "root"; + + Результат = OPI_GoogleDrive.СкопироватьОбъект(Токен, Идентификатор, НовоеИмя, НовыйРодитель); +``` + + + + + + ```bash + oint gdrive СкопироватьОбъект --token "***" \ + --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" \ + --title "Скопированный файл.jpeg" \ + --catalog "root" + ``` + + + + ```batch + oint gdrive СкопироватьОбъект ^ + --token "***" ^ + --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" ^ + --title "Скопированный файл.jpeg" ^ + --catalog "root" + ``` + + + + +```json title="Результат" +{ + "kind": "drive#file", + "id": "1P8WK9Wn2710HiQYkKzYMFso2FmFenV6d", + "name": "Скопированный файл.jpeg", + "mimeType": "image/jpeg" +} +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md b/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md deleted file mode 100644 index 25cd5ae229..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Создать папку - Создает пустой каталог на диске - - - -`Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Имя | --title | Строка | Имя папки | - | Родитель | --catalog | Строка | Родитель | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Каталог = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; - Имя = "Тестовая папка"; - - Результат = OPI_GoogleDrive.СоздатьПапку(Токен, Имя, Каталог); -``` - - - - - - ```bash - oint gdrive СоздатьПапку --token "***" \ - --title "Тестовая папка" - ``` - - - - ```batch - oint gdrive СоздатьПапку ^ - --token "***" ^ - --title "Тестовая папка" - ``` - - - - -```json title="Результат" -{ - "kind": "drive#file", - "id": "1aLLPD2uD3xht-PmNHlZt-OIBzFd5qHgg", - "name": "Тестовая папка", - "mimeType": "application/vnd.google-apps.folder" -} -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.mdx new file mode 100644 index 0000000000..a9b8d490a9 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Создать папку + Создает пустой каталог на диске + + + +`Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Имя | --title | Строка | Имя папки | + | Родитель | --catalog | Строка | Родитель | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Каталог = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; + Имя = "Тестовая папка"; + + Результат = OPI_GoogleDrive.СоздатьПапку(Токен, Имя, Каталог); +``` + + + + + + ```bash + oint gdrive СоздатьПапку --token "***" \ + --title "Тестовая папка" + ``` + + + + ```batch + oint gdrive СоздатьПапку ^ + --token "***" ^ + --title "Тестовая папка" + ``` + + + + +```json title="Результат" +{ + "kind": "drive#file", + "id": "1aLLPD2uD3xht-PmNHlZt-OIBzFd5qHgg", + "name": "Тестовая папка", + "mimeType": "application/vnd.google-apps.folder" +} +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md b/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md deleted file mode 100644 index ce3f518a00..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Удалить объект - Удаляет файл или каталог по ID - - - -`Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор объекта для удаления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - - Результат = OPI_GoogleDrive.УдалитьОбъект(Токен, Идентификатор); -``` - - - - - - ```bash - oint gdrive УдалитьОбъект --token "***" \ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" - ``` - - - - ```batch - oint gdrive УдалитьОбъект ^ - --token "***" ^ - --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.mdx new file mode 100644 index 0000000000..8ccc15f7d1 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Удалить объект + Удаляет файл или каталог по ID + + + +`Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта для удаления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + + Результат = OPI_GoogleDrive.УдалитьОбъект(Токен, Идентификатор); +``` + + + + + + ```bash + oint gdrive УдалитьОбъект --token "***" \ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" + ``` + + + + ```batch + oint gdrive УдалитьОбъект ^ + --token "***" ^ + --object "1MfKvl7trDfRoyFRzXV_ZaCEbx6SQWq49" + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md b/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md deleted file mode 100644 index 10d04d42bd..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Скачать файл - Получает файл по ID - - - -`Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор файла | - | ПутьСохранения | --out | Строка | Путь сохранения файла | - - - Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - - Результат = OPI_GoogleDrive.СкачатьФайл(Токен, Идентификатор); -``` - - - - - - ```bash - oint gdrive СкачатьФайл --token "***" \ - --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" - ``` - - - - ```batch - oint gdrive СкачатьФайл ^ - --token "***" ^ - --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" - ``` - - - - -```json title="Результат" -НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.mdx new file mode 100644 index 0000000000..5a48db95d8 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Скачать файл + Получает файл по ID + + + +`Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор файла | + | ПутьСохранения | --out | Строка | Путь сохранения файла | + + + Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + + Результат = OPI_GoogleDrive.СкачатьФайл(Токен, Идентификатор); +``` + + + + + + ```bash + oint gdrive СкачатьФайл --token "***" \ + --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" + ``` + + + + ```batch + oint gdrive СкачатьФайл ^ + --token "***" ^ + --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" + ``` + + + + +```json title="Результат" +НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md deleted file mode 100644 index 76aeb50633..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список каталогов - Получает список каталогов диска - - - -`Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИмяСодержит | --querry | Строка | Отбор по имени | - | Подробно | --depth | Булево | Добавляет список файлов к полям каталога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов - -
- - - - -```bsl title="Пример кода" - Имя = "Тестовая папка"; - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - - Результат = OPI_GoogleDrive.ПолучитьСписокКаталогов(Токен, Имя, Истина); -``` - - - - - - ```bash - oint gdrive ПолучитьСписокКаталогов --token "***" \ - --querry "Тестовая папка" - ``` - - - - ```batch - oint gdrive ПолучитьСписокКаталогов ^ - --token "***" ^ - --querry "Тестовая папка" - ``` - - - - -```json title="Результат" -[ - { - "kind": "drive#file", - "copyRequiresWriterPermission": false, - "writersCanShare": true, - "viewedByMe": true, - "mimeType": "application/vnd.google-apps.folder", - "parents": [ - "0AN2vrbrhqfJrUk9PVA" - ], - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "shared": false, - "lastModifyingUser": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - }, - "owners": [ - { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - } - ], - "webViewLink": "https://drive.google.com/drive/folders/191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", - "viewersCanCopyContent": true, - "permissions": [ - { - "id": "07468399490707249352", - "displayName": "Антон Титовец", - "type": "user", - "kind": "drive#permission", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", - "deleted": false, - "pendingOwner": false - } - ], - "hasThumbnail": false, - "spaces": [ - "drive" - ], - "folderColorRgb": "#8f8f8f", - "id": "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", - "name": "Тестовая папка", - "starred": false, - "trashed": false, - "explicitlyTrashed": false, - "createdTime": "2024-05-30T07:31:43.495Z", - "modifiedTime": "2024-05-30T07:31:44.676Z", - "modifiedByMeTime": "2024-05-30T07:31:44.676Z", - "viewedByMeTime": "2024-05-30T07:31:43.495Z", - "quotaBytesUsed": "0", - "version": "1", - "ownedByMe": true, - "isAppAuthorized": false, - "capabilities": { - "canChangeViewersCanCopyContent": false, - "canEdit": true, - "canCopy": false, - "canComment": true, - "canAddChildren": true, - "canDelete": true, - "canDownload": true, - "canListChildren": true, - "canRemoveChildren": true, - "canRename": true, - "canTrash": true, - "canReadRevisions": false, - "canChangeCopyRequiresWriterPermission": false, - "canMoveItemIntoTeamDrive": true, - "canUntrash": true, - "canModifyContent": true, - "canMoveItemOutOfDrive": true, - "canAddMyDriveParent": false, - "canRemoveMyDriveParent": true, - "canMoveItemWithinDrive": true, - "canShare": true, - "canMoveChildrenWithinDrive": true, - "canModifyContentRestriction": false, - "canChangeSecurityUpdateEnabled": false, - "canAcceptOwnership": false, - "canReadLabels": false, - "canModifyLabels": false, - "canModifyEditorContentRestriction": false, - "canModifyOwnerContentRestriction": false, - "canRemoveContentRestriction": false - }, - "thumbnailVersion": "0", - "modifiedByMe": true, - "permissionIds": [ - "07468399490707249352" - ], - "linkShareMetadata": { - "securityUpdateEligible": false, - "securityUpdateEnabled": true - }, - "files": [ - { - "kind": "drive#file", - "fileExtension": "jpg", - "copyRequiresWriterPermission": false, - "md5Checksum": "5a4b7be6d3fade1faa7afc1641d8e5ac", - "writersCanShare": true, - "viewedByMe": false, - "mimeType": "image/jpeg", - "parents": [ - "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM" - ], - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", - "shared": false, - "lastModifyingUser": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - }, - "owners": [ - { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - } - ], - "headRevisionId": "0B92vrbrhqfJrbWRlRDBkU1BIaW9yUjIxRnc1cnBMQjBaNUpnPQ", - "webViewLink": "https://drive.google.com/file/d/1Hb0ObC9XXwF_9EzMB1JsNQiyqhqUV153/view?usp=drivesdk", - "webContentLink": "https://drive.google.com/uc?id=1Hb0ObC9XXwF_9EzMB1JsNQiyqhqUV153&export=download", - "size": "427", - "viewersCanCopyContent": true, - "permissions": [ - { - "id": "07468399490707249352", - "displayName": "Антон Титовец", - "type": "user", - "kind": "drive#permission", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", -... -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.mdx new file mode 100644 index 0000000000..23cc98bd98 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.mdx @@ -0,0 +1,208 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список каталогов + Получает список каталогов диска + + + +`Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяСодержит | --querry | Строка | Отбор по имени | + | Подробно | --depth | Булево | Добавляет список файлов к полям каталога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов + +
+ + + + +```bsl title="Пример кода" + Имя = "Тестовая папка"; + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + + Результат = OPI_GoogleDrive.ПолучитьСписокКаталогов(Токен, Имя, Истина); +``` + + + + + + ```bash + oint gdrive ПолучитьСписокКаталогов --token "***" \ + --querry "Тестовая папка" + ``` + + + + ```batch + oint gdrive ПолучитьСписокКаталогов ^ + --token "***" ^ + --querry "Тестовая папка" + ``` + + + + +```json title="Результат" +[ + { + "kind": "drive#file", + "copyRequiresWriterPermission": false, + "writersCanShare": true, + "viewedByMe": true, + "mimeType": "application/vnd.google-apps.folder", + "parents": [ + "0AN2vrbrhqfJrUk9PVA" + ], + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "shared": false, + "lastModifyingUser": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + }, + "owners": [ + { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + } + ], + "webViewLink": "https://drive.google.com/drive/folders/191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", + "viewersCanCopyContent": true, + "permissions": [ + { + "id": "07468399490707249352", + "displayName": "Антон Титовец", + "type": "user", + "kind": "drive#permission", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", + "deleted": false, + "pendingOwner": false + } + ], + "hasThumbnail": false, + "spaces": [ + "drive" + ], + "folderColorRgb": "#8f8f8f", + "id": "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", + "name": "Тестовая папка", + "starred": false, + "trashed": false, + "explicitlyTrashed": false, + "createdTime": "2024-05-30T07:31:43.495Z", + "modifiedTime": "2024-05-30T07:31:44.676Z", + "modifiedByMeTime": "2024-05-30T07:31:44.676Z", + "viewedByMeTime": "2024-05-30T07:31:43.495Z", + "quotaBytesUsed": "0", + "version": "1", + "ownedByMe": true, + "isAppAuthorized": false, + "capabilities": { + "canChangeViewersCanCopyContent": false, + "canEdit": true, + "canCopy": false, + "canComment": true, + "canAddChildren": true, + "canDelete": true, + "canDownload": true, + "canListChildren": true, + "canRemoveChildren": true, + "canRename": true, + "canTrash": true, + "canReadRevisions": false, + "canChangeCopyRequiresWriterPermission": false, + "canMoveItemIntoTeamDrive": true, + "canUntrash": true, + "canModifyContent": true, + "canMoveItemOutOfDrive": true, + "canAddMyDriveParent": false, + "canRemoveMyDriveParent": true, + "canMoveItemWithinDrive": true, + "canShare": true, + "canMoveChildrenWithinDrive": true, + "canModifyContentRestriction": false, + "canChangeSecurityUpdateEnabled": false, + "canAcceptOwnership": false, + "canReadLabels": false, + "canModifyLabels": false, + "canModifyEditorContentRestriction": false, + "canModifyOwnerContentRestriction": false, + "canRemoveContentRestriction": false + }, + "thumbnailVersion": "0", + "modifiedByMe": true, + "permissionIds": [ + "07468399490707249352" + ], + "linkShareMetadata": { + "securityUpdateEligible": false, + "securityUpdateEnabled": true + }, + "files": [ + { + "kind": "drive#file", + "fileExtension": "jpg", + "copyRequiresWriterPermission": false, + "md5Checksum": "5a4b7be6d3fade1faa7afc1641d8e5ac", + "writersCanShare": true, + "viewedByMe": false, + "mimeType": "image/jpeg", + "parents": [ + "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM" + ], + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", + "shared": false, + "lastModifyingUser": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + }, + "owners": [ + { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + } + ], + "headRevisionId": "0B92vrbrhqfJrbWRlRDBkU1BIaW9yUjIxRnc1cnBMQjBaNUpnPQ", + "webViewLink": "https://drive.google.com/file/d/1Hb0ObC9XXwF_9EzMB1JsNQiyqhqUV153/view?usp=drivesdk", + "webContentLink": "https://drive.google.com/uc?id=1Hb0ObC9XXwF_9EzMB1JsNQiyqhqUV153&export=download", + "size": "427", + "viewersCanCopyContent": true, + "permissions": [ + { + "id": "07468399490707249352", + "displayName": "Антон Титовец", + "type": "user", + "kind": "drive#permission", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", +... +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md deleted file mode 100644 index d757aeae87..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Получить описание файла - Получает шаблон пустого описания для загрузки файла - - - -`Функция ПолучитьОписаниеФайла(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Описание файла - -
- - - - -```bsl title="Пример кода" - Результат = OPI_GoogleDrive.ПолучитьОписаниеФайла(); -``` - - - - - - ```bash - oint gdrive ПолучитьОписаниеФайла --empty false - ``` - - - - ```batch - oint gdrive ПолучитьОписаниеФайла ^ - --empty false - ``` - - - - -```json title="Результат" -{ - "MIME": "image/jpeg", - "Имя": "Новый файл.jpg", - "Описание": "Это новый файл", - "Родитель": "root" -} -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.mdx new file mode 100644 index 0000000000..2ed1e64c01 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Получить описание файла + Получает шаблон пустого описания для загрузки файла + + + +`Функция ПолучитьОписаниеФайла(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Описание файла + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_GoogleDrive.ПолучитьОписаниеФайла(); +``` + + + + + + ```bash + oint gdrive ПолучитьОписаниеФайла --empty false + ``` + + + + ```batch + oint gdrive ПолучитьОписаниеФайла ^ + --empty false + ``` + + + + +```json title="Результат" +{ + "MIME": "image/jpeg", + "Имя": "Новый файл.jpg", + "Описание": "Это новый файл", + "Родитель": "root" +} +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md deleted file mode 100644 index cb2ebb0f73..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить список файлов - Получает список файлов - - - -`Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИмяСодержит | --querry | Строка | Отбор по имени | - | Каталог | --catalog | Строка | Отбор по ID каталога родителя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Каталог = "root"; - ИмяСодержит = "data"; - - Результат = OPI_GoogleDrive.ПолучитьСписокФайлов(Токен, ИмяСодержит, Каталог); -``` - - - - - - ```bash - oint gdrive ПолучитьСписокФайлов --token "***" \ - --querry "data" \ - --catalog "root" - ``` - - - - ```batch - oint gdrive ПолучитьСписокФайлов ^ - --token "***" ^ - --querry "data" ^ - --catalog "root" - ``` - - - - -```json title="Результат" -[ - { - "kind": "drive#file", - "fileExtension": "json", - "copyRequiresWriterPermission": false, - "md5Checksum": "cf83e956f3cddf775f02ff1955954efd", - "writersCanShare": true, - "viewedByMe": true, - "mimeType": "application/json", - "parents": [ - "0AN2vrbrhqfJrUk9PVA" - ], - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/json", - "shared": false, - "lastModifyingUser": { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - }, - "owners": [ - { - "displayName": "Антон Титовец", - "kind": "drive#user", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" - } - ], - "headRevisionId": "0B92vrbrhqfJrYWlNZXZQbXhaZm84c2xqVzdIYzM4N2luVkV3PQ", - "webViewLink": "https://drive.google.com/file/d/1NKMmj4SJh3WUw74nhLuMofW7dfpUR520/view?usp=drivesdk", - "webContentLink": "https://drive.google.com/uc?id=1NKMmj4SJh3WUw74nhLuMofW7dfpUR520&export=download", - "size": "10577", - "viewersCanCopyContent": true, - "permissions": [ - { - "id": "07468399490707249352", - "displayName": "Антон Титовец", - "type": "user", - "kind": "drive#permission", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", - "deleted": false, - "pendingOwner": false - } - ], - "hasThumbnail": false, - "spaces": [ - "drive" - ], - "id": "1NKMmj4SJh3WUw74nhLuMofW7dfpUR520", - "name": "data.json", - "starred": false, - "trashed": false, - "explicitlyTrashed": false, - "createdTime": "2024-02-29T19:22:49.616Z", - "modifiedTime": "2024-10-08T17:03:36.717Z", - "modifiedByMeTime": "2024-10-08T17:03:36.717Z", - "viewedByMeTime": "2024-10-08T17:03:36.717Z", - "quotaBytesUsed": "10577", - "version": "5878", - "originalFilename": "data.json", - "ownedByMe": true, - "fullFileExtension": "json", - "isAppAuthorized": false, - "capabilities": { - "canChangeViewersCanCopyContent": true, - "canEdit": true, - "canCopy": true, - "canComment": true, - "canAddChildren": false, - "canDelete": true, - "canDownload": true, - "canListChildren": false, - "canRemoveChildren": false, - "canRename": true, - "canTrash": true, - "canReadRevisions": true, - "canChangeCopyRequiresWriterPermission": true, - "canMoveItemIntoTeamDrive": true, - "canUntrash": true, - "canModifyContent": true, - "canMoveItemOutOfDrive": true, - "canAddMyDriveParent": false, - "canRemoveMyDriveParent": true, - "canMoveItemWithinDrive": true, - "canShare": true, - "canMoveChildrenWithinDrive": false, - "canModifyContentRestriction": true, - "canChangeSecurityUpdateEnabled": false, - "canAcceptOwnership": false, - "canReadLabels": false, - "canModifyLabels": false, - "canModifyEditorContentRestriction": true, - "canModifyOwnerContentRestriction": true, - "canRemoveContentRestriction": false - }, - "thumbnailVersion": "0", - "modifiedByMe": true, - "permissionIds": [ - "07468399490707249352" - ], - "linkShareMetadata": { - "securityUpdateEligible": false, - "securityUpdateEnabled": true - }, - "sha1Checksum": "f2d5069322045898ea4932524eb2450b0ef1fdd5", - "sha256Checksum": "2353109234e9285120e08407374b196bf640ef55adfb6923da467a52d9b28084" - } -] -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.mdx new file mode 100644 index 0000000000..b957be157b --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.mdx @@ -0,0 +1,174 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить список файлов + Получает список файлов + + + +`Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяСодержит | --querry | Строка | Отбор по имени | + | Каталог | --catalog | Строка | Отбор по ID каталога родителя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Каталог = "root"; + ИмяСодержит = "data"; + + Результат = OPI_GoogleDrive.ПолучитьСписокФайлов(Токен, ИмяСодержит, Каталог); +``` + + + + + + ```bash + oint gdrive ПолучитьСписокФайлов --token "***" \ + --querry "data" \ + --catalog "root" + ``` + + + + ```batch + oint gdrive ПолучитьСписокФайлов ^ + --token "***" ^ + --querry "data" ^ + --catalog "root" + ``` + + + + +```json title="Результат" +[ + { + "kind": "drive#file", + "fileExtension": "json", + "copyRequiresWriterPermission": false, + "md5Checksum": "cf83e956f3cddf775f02ff1955954efd", + "writersCanShare": true, + "viewedByMe": true, + "mimeType": "application/json", + "parents": [ + "0AN2vrbrhqfJrUk9PVA" + ], + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/json", + "shared": false, + "lastModifyingUser": { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + }, + "owners": [ + { + "displayName": "Антон Титовец", + "kind": "drive#user", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64" + } + ], + "headRevisionId": "0B92vrbrhqfJrYWlNZXZQbXhaZm84c2xqVzdIYzM4N2luVkV3PQ", + "webViewLink": "https://drive.google.com/file/d/1NKMmj4SJh3WUw74nhLuMofW7dfpUR520/view?usp=drivesdk", + "webContentLink": "https://drive.google.com/uc?id=1NKMmj4SJh3WUw74nhLuMofW7dfpUR520&export=download", + "size": "10577", + "viewersCanCopyContent": true, + "permissions": [ + { + "id": "07468399490707249352", + "displayName": "Антон Титовец", + "type": "user", + "kind": "drive#permission", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", + "deleted": false, + "pendingOwner": false + } + ], + "hasThumbnail": false, + "spaces": [ + "drive" + ], + "id": "1NKMmj4SJh3WUw74nhLuMofW7dfpUR520", + "name": "data.json", + "starred": false, + "trashed": false, + "explicitlyTrashed": false, + "createdTime": "2024-02-29T19:22:49.616Z", + "modifiedTime": "2024-10-08T17:03:36.717Z", + "modifiedByMeTime": "2024-10-08T17:03:36.717Z", + "viewedByMeTime": "2024-10-08T17:03:36.717Z", + "quotaBytesUsed": "10577", + "version": "5878", + "originalFilename": "data.json", + "ownedByMe": true, + "fullFileExtension": "json", + "isAppAuthorized": false, + "capabilities": { + "canChangeViewersCanCopyContent": true, + "canEdit": true, + "canCopy": true, + "canComment": true, + "canAddChildren": false, + "canDelete": true, + "canDownload": true, + "canListChildren": false, + "canRemoveChildren": false, + "canRename": true, + "canTrash": true, + "canReadRevisions": true, + "canChangeCopyRequiresWriterPermission": true, + "canMoveItemIntoTeamDrive": true, + "canUntrash": true, + "canModifyContent": true, + "canMoveItemOutOfDrive": true, + "canAddMyDriveParent": false, + "canRemoveMyDriveParent": true, + "canMoveItemWithinDrive": true, + "canShare": true, + "canMoveChildrenWithinDrive": false, + "canModifyContentRestriction": true, + "canChangeSecurityUpdateEnabled": false, + "canAcceptOwnership": false, + "canReadLabels": false, + "canModifyLabels": false, + "canModifyEditorContentRestriction": true, + "canModifyOwnerContentRestriction": true, + "canRemoveContentRestriction": false + }, + "thumbnailVersion": "0", + "modifiedByMe": true, + "permissionIds": [ + "07468399490707249352" + ], + "linkShareMetadata": { + "securityUpdateEligible": false, + "securityUpdateEnabled": true + }, + "sha1Checksum": "f2d5069322045898ea4932524eb2450b0ef1fdd5", + "sha256Checksum": "2353109234e9285120e08407374b196bf640ef55adfb6923da467a52d9b28084" + } +] +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md deleted file mode 100644 index 4be5a962b9..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию об объекте - Получает информацию о папке или файле по ID - - - -`Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор файла или каталога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; - - Результат = OPI_GoogleDrive.ПолучитьИнформациюОбОбъекте(Токен, Идентификатор); -``` - - - - - - ```bash - oint gdrive ПолучитьИнформациюОбОбъекте --token "***" \ - --object "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM" - ``` - - - - ```batch - oint gdrive ПолучитьИнформациюОбОбъекте ^ - --token "***" ^ - --object "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM" - ``` - - - - -```json title="Результат" -{ - "kind": "drive#file", - "id": "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", - "name": "Тестовая папка", - "mimeType": "application/vnd.google-apps.folder", - "starred": false, - "trashed": false, - "explicitlyTrashed": false, - "parents": [ - "0AN2vrbrhqfJrUk9PVA" - ], - "spaces": [ - "drive" - ], - "version": "1", - "webViewLink": "https://drive.google.com/drive/folders/191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "hasThumbnail": false, - "thumbnailVersion": "0", - "viewedByMe": true, - "viewedByMeTime": "2024-05-30T07:31:43.495Z", - "createdTime": "2024-05-30T07:31:43.495Z", - "modifiedTime": "2024-05-30T07:31:44.676Z", - "modifiedByMeTime": "2024-05-30T07:31:44.676Z", - "modifiedByMe": true, - "owners": [ - { - "kind": "drive#user", - "displayName": "Антон Титовец", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com" - } - ], - "lastModifyingUser": { - "kind": "drive#user", - "displayName": "Антон Титовец", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "me": true, - "permissionId": "07468399490707249352", - "emailAddress": "bayselonarrend@gmail.com" - }, - "shared": false, - "ownedByMe": true, - "capabilities": { - "canAcceptOwnership": false, - "canAddChildren": true, - "canAddMyDriveParent": false, - "canChangeCopyRequiresWriterPermission": false, - "canChangeSecurityUpdateEnabled": false, - "canChangeViewersCanCopyContent": false, - "canComment": true, - "canCopy": false, - "canDelete": true, - "canDownload": true, - "canEdit": true, - "canListChildren": true, - "canModifyContent": true, - "canModifyContentRestriction": false, - "canModifyEditorContentRestriction": false, - "canModifyOwnerContentRestriction": false, - "canModifyLabels": false, - "canMoveChildrenWithinDrive": true, - "canMoveItemIntoTeamDrive": true, - "canMoveItemOutOfDrive": true, - "canMoveItemWithinDrive": true, - "canReadLabels": false, - "canReadRevisions": false, - "canRemoveChildren": true, - "canRemoveContentRestriction": false, - "canRemoveMyDriveParent": true, - "canRename": true, - "canShare": true, - "canTrash": true, - "canUntrash": true - }, - "viewersCanCopyContent": true, - "copyRequiresWriterPermission": false, - "writersCanShare": true, - "permissions": [ - { - "kind": "drive#permission", - "id": "07468399490707249352", - "type": "user", - "emailAddress": "bayselonarrend@gmail.com", - "role": "owner", - "displayName": "Антон Титовец", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", - "deleted": false, - "pendingOwner": false - } - ], - "permissionIds": [ - "07468399490707249352" - ], - "folderColorRgb": "#8f8f8f", - "quotaBytesUsed": "0", - "isAppAuthorized": false, - "linkShareMetadata": { - "securityUpdateEligible": false, - "securityUpdateEnabled": true - } -} -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.mdx new file mode 100644 index 0000000000..c361734c39 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.mdx @@ -0,0 +1,160 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить информацию об объекте + Получает информацию о папке или файле по ID + + + +`Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор файла или каталога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; + + Результат = OPI_GoogleDrive.ПолучитьИнформациюОбОбъекте(Токен, Идентификатор); +``` + + + + + + ```bash + oint gdrive ПолучитьИнформациюОбОбъекте --token "***" \ + --object "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM" + ``` + + + + ```batch + oint gdrive ПолучитьИнформациюОбОбъекте ^ + --token "***" ^ + --object "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM" + ``` + + + + +```json title="Результат" +{ + "kind": "drive#file", + "id": "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", + "name": "Тестовая папка", + "mimeType": "application/vnd.google-apps.folder", + "starred": false, + "trashed": false, + "explicitlyTrashed": false, + "parents": [ + "0AN2vrbrhqfJrUk9PVA" + ], + "spaces": [ + "drive" + ], + "version": "1", + "webViewLink": "https://drive.google.com/drive/folders/191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM", + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "hasThumbnail": false, + "thumbnailVersion": "0", + "viewedByMe": true, + "viewedByMeTime": "2024-05-30T07:31:43.495Z", + "createdTime": "2024-05-30T07:31:43.495Z", + "modifiedTime": "2024-05-30T07:31:44.676Z", + "modifiedByMeTime": "2024-05-30T07:31:44.676Z", + "modifiedByMe": true, + "owners": [ + { + "kind": "drive#user", + "displayName": "Антон Титовец", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com" + } + ], + "lastModifyingUser": { + "kind": "drive#user", + "displayName": "Антон Титовец", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "me": true, + "permissionId": "07468399490707249352", + "emailAddress": "bayselonarrend@gmail.com" + }, + "shared": false, + "ownedByMe": true, + "capabilities": { + "canAcceptOwnership": false, + "canAddChildren": true, + "canAddMyDriveParent": false, + "canChangeCopyRequiresWriterPermission": false, + "canChangeSecurityUpdateEnabled": false, + "canChangeViewersCanCopyContent": false, + "canComment": true, + "canCopy": false, + "canDelete": true, + "canDownload": true, + "canEdit": true, + "canListChildren": true, + "canModifyContent": true, + "canModifyContentRestriction": false, + "canModifyEditorContentRestriction": false, + "canModifyOwnerContentRestriction": false, + "canModifyLabels": false, + "canMoveChildrenWithinDrive": true, + "canMoveItemIntoTeamDrive": true, + "canMoveItemOutOfDrive": true, + "canMoveItemWithinDrive": true, + "canReadLabels": false, + "canReadRevisions": false, + "canRemoveChildren": true, + "canRemoveContentRestriction": false, + "canRemoveMyDriveParent": true, + "canRename": true, + "canShare": true, + "canTrash": true, + "canUntrash": true + }, + "viewersCanCopyContent": true, + "copyRequiresWriterPermission": false, + "writersCanShare": true, + "permissions": [ + { + "kind": "drive#permission", + "id": "07468399490707249352", + "type": "user", + "emailAddress": "bayselonarrend@gmail.com", + "role": "owner", + "displayName": "Антон Титовец", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocKYttNv2CZ-cTTuE90Zmht_PwnGc0YnjM1IUllXsTVORfZFVPU=s64", + "deleted": false, + "pendingOwner": false + } + ], + "permissionIds": [ + "07468399490707249352" + ], + "folderColorRgb": "#8f8f8f", + "quotaBytesUsed": "0", + "isAppAuthorized": false, + "linkShareMetadata": { + "securityUpdateEligible": false, + "securityUpdateEnabled": true + } +} +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md b/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md deleted file mode 100644 index 2efb596b64..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Обновить файл - Обновляет двоичные данные файла - - - -`Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор обновляемого объекта | - | Файл | --file | ДвоичныеДанные,Строка | Файл источник обновления | - | НовоеИмя | --title | Строка | Новое имя файла (если необходимо) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - НовоеИмя = "Обновленный файл.jpg"; - Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; - Файл = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные данные или Путь к файлу - - Результат = OPI_GoogleDrive.ОбновитьФайл(Токен, Идентификатор, Файл, НовоеИмя); -``` - - - - - - ```bash - oint gdrive ОбновитьФайл --token "***" \ - --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" \ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" \ - --title "Обновленный файл.jpg" - ``` - - - - ```batch - oint gdrive ОбновитьФайл ^ - --token "***" ^ - --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" ^ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" ^ - --title "Обновленный файл.jpg" - ``` - - - - -```json title="Результат" -{ - "kind": "drive#file", - "id": "1M4vzYf2dCgd0n5Ex4Yt-AhzjhZyr13Rr", - "name": "Обновленный файл.jpg", - "mimeType": "image/jpeg" -} -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.mdx new file mode 100644 index 0000000000..4ec04816f5 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Обновить файл + Обновляет двоичные данные файла + + + +`Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор обновляемого объекта | + | Файл | --file | ДвоичныеДанные,Строка | Файл источник обновления | + | НовоеИмя | --title | Строка | Новое имя файла (если необходимо) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + НовоеИмя = "Обновленный файл.jpg"; + Идентификатор = "14hysfOxsStktI4JZEXRiSZ9Rl69wNJwX"; + Файл = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные данные или Путь к файлу + + Результат = OPI_GoogleDrive.ОбновитьФайл(Токен, Идентификатор, Файл, НовоеИмя); +``` + + + + + + ```bash + oint gdrive ОбновитьФайл --token "***" \ + --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" \ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" \ + --title "Обновленный файл.jpg" + ``` + + + + ```batch + oint gdrive ОбновитьФайл ^ + --token "***" ^ + --object "10MDksSJHfiN5TdiC9iG66f-BjZRTn_s6" ^ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" ^ + --title "Обновленный файл.jpg" + ``` + + + + +```json title="Результат" +{ + "kind": "drive#file", + "id": "1M4vzYf2dCgd0n5Ex4Yt-AhzjhZyr13Rr", + "name": "Обновленный файл.jpg", + "mimeType": "image/jpeg" +} +``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md b/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md deleted file mode 100644 index ac9cd7f5d8..0000000000 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Загрузить файл - Загружает файл на диск - - - -`Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Файл | --file | ДвоичныеДанные,Строка | Загружаемый файл | - | Описание | --props | Соответствие Из КлючИЗначение | JSON описания или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - Каталог = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; - - Описание = OPI_GoogleDrive.ПолучитьОписаниеФайла(); - Описание.Вставить("Родитель", Каталог); - - Результат = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Картинка, Описание); -``` - - - - - - ```bash - oint gdrive ЗагрузитьФайл --token "***" \ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --props "{'MIME':'image/jpeg','Имя':'Новый файл.jpg','Описание':'Это новый файл','Родитель':'191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM'}" - ``` - - - - ```batch - oint gdrive ЗагрузитьФайл ^ - --token "***" ^ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --props "{'MIME':'image/jpeg','Имя':'Новый файл.jpg','Описание':'Это новый файл','Родитель':'191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM'}" - ``` - - - - -```json title="Результат" -{ - "kind": "drive#file", - "id": "1T0kBmfSFAMKbZsYxP0PZtbjs_leFF6nR", - "name": "Новый файл.jpg", - "mimeType": "image/jpeg" -} -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.mdx b/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.mdx new file mode 100644 index 0000000000..3ab50f8f38 --- /dev/null +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Загрузить файл + Загружает файл на диск + + + +`Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Файл | --file | ДвоичныеДанные,Строка | Загружаемый файл | + | Описание | --props | Соответствие Из КлючИЗначение | JSON описания или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + Каталог = "191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM"; + + Описание = OPI_GoogleDrive.ПолучитьОписаниеФайла(); + Описание.Вставить("Родитель", Каталог); + + Результат = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Картинка, Описание); +``` + + + + + + ```bash + oint gdrive ЗагрузитьФайл --token "***" \ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --props "{'MIME':'image/jpeg','Имя':'Новый файл.jpg','Описание':'Это новый файл','Родитель':'191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM'}" + ``` + + + + ```batch + oint gdrive ЗагрузитьФайл ^ + --token "***" ^ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --props "{'MIME':'image/jpeg','Имя':'Новый файл.jpg','Описание':'Это новый файл','Родитель':'191iyaa6-2BCNRPOF0F8mQ0TuNWPNesdM'}" + ``` + + + + +```json title="Результат" +{ + "kind": "drive#file", + "id": "1T0kBmfSFAMKbZsYxP0PZtbjs_leFF6nR", + "name": "Новый файл.jpg", + "mimeType": "image/jpeg" +} +``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md b/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md deleted file mode 100644 index b137b67529..0000000000 --- a/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Очистить ячейки - Очищает значение в ячейках - - - -`Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для очистки | - | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Лист = "Лист2"; - - МассивЯчеек = Новый Массив; - МассивЯчеек.Добавить("B2"); - МассивЯчеек.Добавить("A3"); - МассивЯчеек.Добавить("B4"); - - Результат = OPI_GoogleSheets.ОчиститьЯчейки(Токен, Книга, МассивЯчеек, Лист); -``` - - - - - - ```bash - oint gsheets ОчиститьЯчейки --token "***" \ - --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" \ - --cells "['B2','A3','B4']" \ - --sheetname "Лист2" - ``` - - - - ```batch - oint gsheets ОчиститьЯчейки ^ - --token "***" ^ - --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" ^ - --cells "['B2','A3','B4']" ^ - --sheetname "Лист2" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "clearedRanges": [ - "'Лист2'!B2", - "'Лист2'!A3", - "'Лист2'!B4" - ] -} -``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.mdx b/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.mdx new file mode 100644 index 0000000000..39d44d7279 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Очистить ячейки + Очищает значение в ячейках + + + +`Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для очистки | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Лист = "Лист2"; + + МассивЯчеек = Новый Массив; + МассивЯчеек.Добавить("B2"); + МассивЯчеек.Добавить("A3"); + МассивЯчеек.Добавить("B4"); + + Результат = OPI_GoogleSheets.ОчиститьЯчейки(Токен, Книга, МассивЯчеек, Лист); +``` + + + + + + ```bash + oint gsheets ОчиститьЯчейки --token "***" \ + --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" \ + --cells "['B2','A3','B4']" \ + --sheetname "Лист2" + ``` + + + + ```batch + oint gsheets ОчиститьЯчейки ^ + --token "***" ^ + --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" ^ + --cells "['B2','A3','B4']" ^ + --sheetname "Лист2" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "clearedRanges": [ + "'Лист2'!B2", + "'Лист2'!A3", + "'Лист2'!B4" + ] +} +``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md b/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md deleted file mode 100644 index 6a989dfcf8..0000000000 --- a/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить значения ячеек - Получает значения ячеек таблицы - - - -`Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для получения (весь лист, если не заполнено) | - | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Лист = "Лист2"; - - МассивЯчеек = Новый Массив; - МассивЯчеек.Добавить("B2"); - МассивЯчеек.Добавить("A3"); - МассивЯчеек.Добавить("B4"); - - Результат = OPI_GoogleSheets.ПолучитьЗначенияЯчеек(Токен, Книга, МассивЯчеек, Лист); -``` - - - - - - ```bash - oint gsheets ПолучитьЗначенияЯчеек --token "***" \ - --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" \ - --sheetname "Лист2" - ``` - - - - ```batch - oint gsheets ПолучитьЗначенияЯчеек ^ - --token "***" ^ - --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" ^ - --sheetname "Лист2" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "valueRanges": [ - { - "range": "'Лист2'!B2", - "majorDimension": "ROWS", - "values": [ - [ - "Это B2" - ] - ] - }, - { - "range": "'Лист2'!A3", - "majorDimension": "ROWS", - "values": [ - [ - "Это A3" - ] - ] - }, - { - "range": "'Лист2'!B4", - "majorDimension": "ROWS", - "values": [ - [ - "Это B4" - ] - ] - } - ] -} -``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.mdx b/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.mdx new file mode 100644 index 0000000000..0c1e1b2c59 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.mdx @@ -0,0 +1,98 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить значения ячеек + Получает значения ячеек таблицы + + + +`Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для получения (весь лист, если не заполнено) | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Лист = "Лист2"; + + МассивЯчеек = Новый Массив; + МассивЯчеек.Добавить("B2"); + МассивЯчеек.Добавить("A3"); + МассивЯчеек.Добавить("B4"); + + Результат = OPI_GoogleSheets.ПолучитьЗначенияЯчеек(Токен, Книга, МассивЯчеек, Лист); +``` + + + + + + ```bash + oint gsheets ПолучитьЗначенияЯчеек --token "***" \ + --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" \ + --sheetname "Лист2" + ``` + + + + ```batch + oint gsheets ПолучитьЗначенияЯчеек ^ + --token "***" ^ + --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" ^ + --sheetname "Лист2" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "valueRanges": [ + { + "range": "'Лист2'!B2", + "majorDimension": "ROWS", + "values": [ + [ + "Это B2" + ] + ] + }, + { + "range": "'Лист2'!A3", + "majorDimension": "ROWS", + "values": [ + [ + "Это A3" + ] + ] + }, + { + "range": "'Лист2'!B4", + "majorDimension": "ROWS", + "values": [ + [ + "Это B4" + ] + ] + } + ] +} +``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md b/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md deleted file mode 100644 index 744b2ae589..0000000000 --- a/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Установить значения ячеек - Устанавливает значения ячеек листа - - - -`Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | СоответствиеЗначений | --data | Соответствие Из КлючИЗначение | Данные заполнения, где ключ это имя ячейки вида A1 | - | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | - | ОсновноеИзмерение | --dim | Строка | Основное измерение при заполнении диапазона массивом | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Лист = "Лист2"; - - СоответствиеЗначений = Новый Соответствие; - СоответствиеЗначений.Вставить("A1", "Это A1"); - СоответствиеЗначений.Вставить("A2", "Это A2"); - СоответствиеЗначений.Вставить("B2", "Это B2"); - СоответствиеЗначений.Вставить("B3", "Это B3"); - СоответствиеЗначений.Вставить("A3", "Это A3"); - СоответствиеЗначений.Вставить("A4", "Это A4"); - СоответствиеЗначений.Вставить("B1", "Это B1"); - СоответствиеЗначений.Вставить("B4", "Это B4"); - - Результат = OPI_GoogleSheets.УстановитьЗначенияЯчеек(Токен, Книга, СоответствиеЗначений, Лист); -``` - - - - - - ```bash - oint gsheets УстановитьЗначенияЯчеек --token "***" \ - --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" \ - --data "{'A1':'Это A1','A2':'Это A2','B2':'Это B2','B3':'Это B3','A3':'Это A3','A4':'Это A4','B1':'Это B1','B4':'Это B4'}" \ - --sheetname "Лист2" - ``` - - - - ```batch - oint gsheets УстановитьЗначенияЯчеек ^ - --token "***" ^ - --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" ^ - --data "{'A1':'Это A1','A2':'Это A2','B2':'Это B2','B3':'Это B3','A3':'Это A3','A4':'Это A4','B1':'Это B1','B4':'Это B4'}" ^ - --sheetname "Лист2" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "totalUpdatedRows": 4, - "totalUpdatedColumns": 2, - "totalUpdatedCells": 8, - "totalUpdatedSheets": 1, - "responses": [ - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!A1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!A2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!B2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!B3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!A3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!A4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!B1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "updatedRange": "'Лист2'!B4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - } - ] -} -``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.mdx b/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.mdx new file mode 100644 index 0000000000..2b20a2dd3b --- /dev/null +++ b/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.mdx @@ -0,0 +1,139 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Установить значения ячеек + Устанавливает значения ячеек листа + + + +`Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | СоответствиеЗначений | --data | Соответствие Из КлючИЗначение | Данные заполнения, где ключ это имя ячейки вида A1 | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + | ОсновноеИзмерение | --dim | Строка | Основное измерение при заполнении диапазона массивом | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Лист = "Лист2"; + + СоответствиеЗначений = Новый Соответствие; + СоответствиеЗначений.Вставить("A1", "Это A1"); + СоответствиеЗначений.Вставить("A2", "Это A2"); + СоответствиеЗначений.Вставить("B2", "Это B2"); + СоответствиеЗначений.Вставить("B3", "Это B3"); + СоответствиеЗначений.Вставить("A3", "Это A3"); + СоответствиеЗначений.Вставить("A4", "Это A4"); + СоответствиеЗначений.Вставить("B1", "Это B1"); + СоответствиеЗначений.Вставить("B4", "Это B4"); + + Результат = OPI_GoogleSheets.УстановитьЗначенияЯчеек(Токен, Книга, СоответствиеЗначений, Лист); +``` + + + + + + ```bash + oint gsheets УстановитьЗначенияЯчеек --token "***" \ + --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" \ + --data "{'A1':'Это A1','A2':'Это A2','B2':'Это B2','B3':'Это B3','A3':'Это A3','A4':'Это A4','B1':'Это B1','B4':'Это B4'}" \ + --sheetname "Лист2" + ``` + + + + ```batch + oint gsheets УстановитьЗначенияЯчеек ^ + --token "***" ^ + --spreadsheet "1uEI_ZOtSAh0GjXirtipg57MUMetFmf1OUElyN8o-UPg" ^ + --data "{'A1':'Это A1','A2':'Это A2','B2':'Это B2','B3':'Это B3','A3':'Это A3','A4':'Это A4','B1':'Это B1','B4':'Это B4'}" ^ + --sheetname "Лист2" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "totalUpdatedRows": 4, + "totalUpdatedColumns": 2, + "totalUpdatedCells": 8, + "totalUpdatedSheets": 1, + "responses": [ + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!A1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!A2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!B2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!B3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!A3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!A4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!B1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "updatedRange": "'Лист2'!B4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + } + ] +} +``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md deleted file mode 100644 index 890428bdbf..0000000000 --- a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать книгу - Создает новую книгу - - - -`Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Наименование | --title | Строка | Наименование | - | МассивИменЛистов | --sheets | Массив из Строка | Массив имен для добавления новых листов в книгу | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Наименование = "Тестовая таблица"; - - МассивЛистов = Новый Массив; - МассивЛистов.Добавить("Лист1"); - МассивЛистов.Добавить("Лист2"); - - Результат = OPI_GoogleSheets.СоздатьКнигу(Токен, Наименование, МассивЛистов); -``` - - - - - - ```bash - oint gsheets СоздатьКнигу --token "***" \ - --title "Тестовая таблица (доп.)" \ - --sheets "['Лист1','Лист2']" - ``` - - - - ```batch - oint gsheets СоздатьКнигу ^ - --token "***" ^ - --title "Тестовая таблица (доп.)" ^ - --sheets "['Лист1','Лист2']" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", - "properties": { - "title": "Тестовая таблица", - "locale": "ru_RU", - "autoRecalc": "ON_CHANGE", - "timeZone": "Etc/GMT", - "defaultFormat": { - "backgroundColor": { - "red": 1, - "green": 1, - "blue": 1 - }, - "padding": { - "top": 2, - "right": 3, - "bottom": 2, - "left": 3 - }, - "verticalAlignment": "BOTTOM", - "wrapStrategy": "OVERFLOW_CELL", - "textFormat": { - "foregroundColor": {}, - "fontFamily": "arial,sans,sans-serif", - "fontSize": 10, - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "foregroundColorStyle": { - "rgbColor": {} - } - }, - "backgroundColorStyle": { - "rgbColor": { - "red": 1, - "green": 1, - "blue": 1 - } - } - }, - "spreadsheetTheme": { - "primaryFontFamily": "Arial", - "themeColors": [ - { - "colorType": "TEXT", - "color": { - "rgbColor": {} - } - }, - { - "colorType": "BACKGROUND", - "color": { - "rgbColor": { - "red": 1, - "green": 1, - "blue": 1 - } - } - }, - { - "colorType": "ACCENT1", - "color": { - "rgbColor": { - "red": 0.25882354, - "green": 0.52156866, - "blue": 0.95686275 - } - } - }, - { - "colorType": "ACCENT2", - "color": { - "rgbColor": { - "red": 0.91764706, - "green": 0.2627451, - "blue": 0.20784314 - } - } - }, - { - "colorType": "ACCENT3", - "color": { - "rgbColor": { - "red": 0.9843137, - "green": 0.7372549, - "blue": 0.015686275 - } - } - }, - { - "colorType": "ACCENT4", - "color": { - "rgbColor": { - "red": 0.20392157, - "green": 0.65882355, - "blue": 0.3254902 - } - } - }, - { - "colorType": "ACCENT5", - "color": { - "rgbColor": { - "red": 1, - "green": 0.42745098, - "blue": 0.003921569 - } - } - }, - { - "colorType": "ACCENT6", - "color": { - "rgbColor": { - "red": 0.27450982, - "green": 0.7411765, - "blue": 0.7764706 - } - } - }, - { - "colorType": "LINK", - "color": { - "rgbColor": { - "red": 0.06666667, - "green": 0.33333334, - "blue": 0.8 - } - } - } - ] - } - }, - "sheets": [ - { - "properties": { - "sheetId": 1395695777, - "title": "Лист1", - "index": 0, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - }, - { - "properties": { - "sheetId": 1235785423, - "title": "Лист2", -... -``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.mdx b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.mdx new file mode 100644 index 0000000000..dda6648c99 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.mdx @@ -0,0 +1,214 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать книгу + Создает новую книгу + + + +`Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Наименование | --title | Строка | Наименование | + | МассивИменЛистов | --sheets | Массив из Строка | Массив имен для добавления новых листов в книгу | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Наименование = "Тестовая таблица"; + + МассивЛистов = Новый Массив; + МассивЛистов.Добавить("Лист1"); + МассивЛистов.Добавить("Лист2"); + + Результат = OPI_GoogleSheets.СоздатьКнигу(Токен, Наименование, МассивЛистов); +``` + + + + + + ```bash + oint gsheets СоздатьКнигу --token "***" \ + --title "Тестовая таблица (доп.)" \ + --sheets "['Лист1','Лист2']" + ``` + + + + ```batch + oint gsheets СоздатьКнигу ^ + --token "***" ^ + --title "Тестовая таблица (доп.)" ^ + --sheets "['Лист1','Лист2']" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1DOVr33ZTV_T3AroyEg7gHrpCYHIpV52K_TmXdgpDwgM", + "properties": { + "title": "Тестовая таблица", + "locale": "ru_RU", + "autoRecalc": "ON_CHANGE", + "timeZone": "Etc/GMT", + "defaultFormat": { + "backgroundColor": { + "red": 1, + "green": 1, + "blue": 1 + }, + "padding": { + "top": 2, + "right": 3, + "bottom": 2, + "left": 3 + }, + "verticalAlignment": "BOTTOM", + "wrapStrategy": "OVERFLOW_CELL", + "textFormat": { + "foregroundColor": {}, + "fontFamily": "arial,sans,sans-serif", + "fontSize": 10, + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "foregroundColorStyle": { + "rgbColor": {} + } + }, + "backgroundColorStyle": { + "rgbColor": { + "red": 1, + "green": 1, + "blue": 1 + } + } + }, + "spreadsheetTheme": { + "primaryFontFamily": "Arial", + "themeColors": [ + { + "colorType": "TEXT", + "color": { + "rgbColor": {} + } + }, + { + "colorType": "BACKGROUND", + "color": { + "rgbColor": { + "red": 1, + "green": 1, + "blue": 1 + } + } + }, + { + "colorType": "ACCENT1", + "color": { + "rgbColor": { + "red": 0.25882354, + "green": 0.52156866, + "blue": 0.95686275 + } + } + }, + { + "colorType": "ACCENT2", + "color": { + "rgbColor": { + "red": 0.91764706, + "green": 0.2627451, + "blue": 0.20784314 + } + } + }, + { + "colorType": "ACCENT3", + "color": { + "rgbColor": { + "red": 0.9843137, + "green": 0.7372549, + "blue": 0.015686275 + } + } + }, + { + "colorType": "ACCENT4", + "color": { + "rgbColor": { + "red": 0.20392157, + "green": 0.65882355, + "blue": 0.3254902 + } + } + }, + { + "colorType": "ACCENT5", + "color": { + "rgbColor": { + "red": 1, + "green": 0.42745098, + "blue": 0.003921569 + } + } + }, + { + "colorType": "ACCENT6", + "color": { + "rgbColor": { + "red": 0.27450982, + "green": 0.7411765, + "blue": 0.7764706 + } + } + }, + { + "colorType": "LINK", + "color": { + "rgbColor": { + "red": 0.06666667, + "green": 0.33333334, + "blue": 0.8 + } + } + } + ] + } + }, + "sheets": [ + { + "properties": { + "sheetId": 1395695777, + "title": "Лист1", + "index": 0, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + }, + { + "properties": { + "sheetId": 1235785423, + "title": "Лист2", +... +``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md deleted file mode 100644 index ec889164ca..0000000000 --- a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить наименование книги - Изменяет наименование существующей книги - - - -`Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | Наименование | --title | Строка | Новое наименование | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Наименование = "Тестовая таблица (изм.)"; - - Результат = OPI_GoogleSheets.ИзменитьНаименованиеКниги(Токен, Книга, Наименование); -``` - - - - - - ```bash - oint gsheets ИзменитьНаименованиеКниги --token "***" \ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ - --title "Тестовая таблица (изм.)" - ``` - - - - ```batch - oint gsheets ИзменитьНаименованиеКниги ^ - --token "***" ^ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ - --title "Тестовая таблица (изм.)" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1NH03Re5tvG0eZ8H3qgzKAMok6gim33SHvV4cRTHqlac", - "replies": [ - {} - ] -} -``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.mdx b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.mdx new file mode 100644 index 0000000000..94bf4a47e1 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить наименование книги + Изменяет наименование существующей книги + + + +`Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | Наименование | --title | Строка | Новое наименование | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Наименование = "Тестовая таблица (изм.)"; + + Результат = OPI_GoogleSheets.ИзменитьНаименованиеКниги(Токен, Книга, Наименование); +``` + + + + + + ```bash + oint gsheets ИзменитьНаименованиеКниги --token "***" \ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ + --title "Тестовая таблица (изм.)" + ``` + + + + ```batch + oint gsheets ИзменитьНаименованиеКниги ^ + --token "***" ^ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ + --title "Тестовая таблица (изм.)" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1NH03Re5tvG0eZ8H3qgzKAMok6gim33SHvV4cRTHqlac", + "replies": [ + {} + ] +} +``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md deleted file mode 100644 index 19082136f3..0000000000 --- a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить книгу - Получает информацию о книге по ID - - - -`Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --spreadsheet | Строка | Идентификатор книги | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Идентификатор = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - - Результат = OPI_GoogleSheets.ПолучитьКнигу(Токен, Идентификатор); -``` - - - - - - ```bash - oint gsheets ПолучитьКнигу --token "***" \ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" - ``` - - - - ```batch - oint gsheets ПолучитьКнигу ^ - --token "***" ^ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" - ``` - - - - -```json title="Результат" - -``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.mdx b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.mdx new file mode 100644 index 0000000000..689c54e254 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.mdx @@ -0,0 +1,57 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить книгу + Получает информацию о книге по ID + + + +`Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --spreadsheet | Строка | Идентификатор книги | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Идентификатор = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + + Результат = OPI_GoogleSheets.ПолучитьКнигу(Токен, Идентификатор); +``` + + + + + + ```bash + oint gsheets ПолучитьКнигу --token "***" \ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" + ``` + + + + ```batch + oint gsheets ПолучитьКнигу ^ + --token "***" ^ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" + ``` + + + + +```json title="Результат" + +``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md b/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md deleted file mode 100644 index 60afc989dd..0000000000 --- a/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Добавить лист - Добавляет новый лист в книгу - - - -`Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | Идентификатор книги | - | Наименование | --title | Строка | Наименование нового листа | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Наименование = "Тестовый лист"; - - Результат = OPI_GoogleSheets.ДобавитьЛист(Токен, Книга, Наименование); -``` - - - - - - ```bash - oint gsheets ДобавитьЛист --token "***" \ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ - --title "Тестовый лист" - ``` - - - - ```batch - oint gsheets ДобавитьЛист ^ - --token "***" ^ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ - --title "Тестовый лист" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1NH03Re5tvG0eZ8H3qgzKAMok6gim33SHvV4cRTHqlac", - "replies": [ - { - "addSheet": { - "properties": { - "sheetId": 2055557456, - "title": "Тестовый лист", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - } - ] -} -``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.mdx b/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.mdx new file mode 100644 index 0000000000..16c01920d0 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Добавить лист + Добавляет новый лист в книгу + + + +`Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | Идентификатор книги | + | Наименование | --title | Строка | Наименование нового листа | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Наименование = "Тестовый лист"; + + Результат = OPI_GoogleSheets.ДобавитьЛист(Токен, Книга, Наименование); +``` + + + + + + ```bash + oint gsheets ДобавитьЛист --token "***" \ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ + --title "Тестовый лист" + ``` + + + + ```batch + oint gsheets ДобавитьЛист ^ + --token "***" ^ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ + --title "Тестовый лист" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1NH03Re5tvG0eZ8H3qgzKAMok6gim33SHvV4cRTHqlac", + "replies": [ + { + "addSheet": { + "properties": { + "sheetId": 2055557456, + "title": "Тестовый лист", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + } + ] +} +``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md b/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md deleted file mode 100644 index d8d0d7cc3f..0000000000 --- a/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Копировать лист - Копирует лист из одной книги в другую - - - -`Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Откуда | --from | Строка | ID книги источника | - | Куда | --to | Строка | ID книги приемника | - | Лист | --sheet | Строка | ID копируемого листа | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Откуда = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Куда = "1WBgDTXbFwMmu1pOOxkej3eD-fx3KQ9kiQ0Np5B2oeMY"; - Лист = "1710472523"; - - Результат = OPI_GoogleSheets.КопироватьЛист(Токен, Откуда, Куда, Лист); -``` - - - - - - ```bash - oint gsheets КопироватьЛист --token "***" \ - --from "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ - --to "1-KNA3DAeS60iWjWATJCZSpuBLGuOOjFRj65wHWXtzrU" \ - --sheet "616761557" - ``` - - - - ```batch - oint gsheets КопироватьЛист ^ - --token "***" ^ - --from "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ - --to "1-KNA3DAeS60iWjWATJCZSpuBLGuOOjFRj65wHWXtzrU" ^ - --sheet "616761557" - ``` - - - - -```json title="Результат" -{ - "sheetId": 2030603781, - "title": "Лист1 (копия)", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } -} -``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.mdx b/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.mdx new file mode 100644 index 0000000000..2acb2c1322 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Копировать лист + Копирует лист из одной книги в другую + + + +`Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --from | Строка | ID книги источника | + | Куда | --to | Строка | ID книги приемника | + | Лист | --sheet | Строка | ID копируемого листа | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Откуда = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Куда = "1WBgDTXbFwMmu1pOOxkej3eD-fx3KQ9kiQ0Np5B2oeMY"; + Лист = "1710472523"; + + Результат = OPI_GoogleSheets.КопироватьЛист(Токен, Откуда, Куда, Лист); +``` + + + + + + ```bash + oint gsheets КопироватьЛист --token "***" \ + --from "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ + --to "1-KNA3DAeS60iWjWATJCZSpuBLGuOOjFRj65wHWXtzrU" \ + --sheet "616761557" + ``` + + + + ```batch + oint gsheets КопироватьЛист ^ + --token "***" ^ + --from "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ + --to "1-KNA3DAeS60iWjWATJCZSpuBLGuOOjFRj65wHWXtzrU" ^ + --sheet "616761557" + ``` + + + + +```json title="Результат" +{ + "sheetId": 2030603781, + "title": "Лист1 (копия)", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } +} +``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md b/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md deleted file mode 100644 index 377d118d1c..0000000000 --- a/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Удалить лист - Удаляет лист из книги - - - -`Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | Идентификатор книги | - | Лист | --sheet | Строка | Идентификатор удаляемого листа | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -
- - - - -```bsl title="Пример кода" - Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; - Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; - Лист = "1710472523"; - - Результат = OPI_GoogleSheets.УдалитьЛист(Токен, Книга, Лист); -``` - - - - - - ```bash - oint gsheets УдалитьЛист --token "***" \ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ - --sheet "616761557" - ``` - - - - ```batch - oint gsheets УдалитьЛист ^ - --token "***" ^ - --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ - --sheet "616761557" - ``` - - - - -```json title="Результат" -{ - "spreadsheetId": "1NH03Re5tvG0eZ8H3qgzKAMok6gim33SHvV4cRTHqlac", - "replies": [ - {} - ] -} -``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.mdx b/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.mdx new file mode 100644 index 0000000000..c5866acc38 --- /dev/null +++ b/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Удалить лист + Удаляет лист из книги + + + +`Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | Идентификатор книги | + | Лист | --sheet | Строка | Идентификатор удаляемого листа | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +
+ + + + +```bsl title="Пример кода" + Токен = "ya29.a0AcM612zdAe2M8Ywdxt7xmK1VAAj2m3yjTdP1Ap8cFmqbE8lVngjIAujPtjc_c94MCuKNLfn7MSssBd6NfMXDQDrHMUv7Fgjp7cjuXk68n..."; + Книга = "1ybexzLz6S_cthsQNdMkNbOlAD3yjFzdArRm_589T_FQ"; + Лист = "1710472523"; + + Результат = OPI_GoogleSheets.УдалитьЛист(Токен, Книга, Лист); +``` + + + + + + ```bash + oint gsheets УдалитьЛист --token "***" \ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" \ + --sheet "616761557" + ``` + + + + ```batch + oint gsheets УдалитьЛист ^ + --token "***" ^ + --spreadsheet "1ZUsPnNQMNtLS0RGKFegPvF2jwU4xJp8AhmpgFNTq-98" ^ + --sheet "616761557" + ``` + + + + +```json title="Результат" +{ + "spreadsheetId": "1NH03Re5tvG0eZ8H3qgzKAMok6gim33SHvV4cRTHqlac", + "replies": [ + {} + ] +} +``` diff --git a/docs/ru/md/Neocities/Data-retrieving/Get-site-data.md b/docs/ru/md/Neocities/Data-retrieving/Get-site-data.md deleted file mode 100644 index 8a76c904f1..0000000000 --- a/docs/ru/md/Neocities/Data-retrieving/Get-site-data.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить данные о сайте - Получает информацию о сайте по его имени или токену - - - -`Функция ПолучитьДанныеОСайте(Знач Токен, Знач Сайт = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | Сайт | --sitename | Строка | Имя сайта (логин) для получения информации. Текущий, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Пример кода" - Токен = "7419cd51de4037f7..."; - Сайт = "2athenaeum"; - - Результат = OPI_Neocities.ПолучитьДанныеОСайте(Токен); - - Результат = OPI_Neocities.ПолучитьДанныеОСайте(Токен, Сайт); -``` - - - - -```json title="Результат" -{ - "result": "success", - "info": { - "sitename": "opi-test", - "views": 9066, - "hits": 17052, - "created_at": "Thu, 20 Jun 2024 07:28:29 -0000", - "last_updated": "Tue, 08 Oct 2024 17:56:42 -0000", - "domain": null, - "tags": [] - } -} -``` diff --git a/docs/ru/md/Neocities/Data-retrieving/Get-site-data.mdx b/docs/ru/md/Neocities/Data-retrieving/Get-site-data.mdx new file mode 100644 index 0000000000..0ac95b62a1 --- /dev/null +++ b/docs/ru/md/Neocities/Data-retrieving/Get-site-data.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить данные о сайте + Получает информацию о сайте по его имени или токену + + + +`Функция ПолучитьДанныеОСайте(Знач Токен, Знач Сайт = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | Сайт | --sitename | Строка | Имя сайта (логин) для получения информации. Текущий, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Пример кода" + Токен = "7419cd51de4037f7..."; + Сайт = "2athenaeum"; + + Результат = OPI_Neocities.ПолучитьДанныеОСайте(Токен); + + Результат = OPI_Neocities.ПолучитьДанныеОСайте(Токен, Сайт); +``` + + + + +```json title="Результат" +{ + "result": "success", + "info": { + "sitename": "opi-test", + "views": 9066, + "hits": 17052, + "created_at": "Thu, 20 Jun 2024 07:28:29 -0000", + "last_updated": "Tue, 08 Oct 2024 17:56:42 -0000", + "domain": null, + "tags": [] + } +} +``` diff --git a/docs/ru/md/Neocities/Data-retrieving/Get-token.md b/docs/ru/md/Neocities/Data-retrieving/Get-token.md deleted file mode 100644 index dd760288e1..0000000000 --- a/docs/ru/md/Neocities/Data-retrieving/Get-token.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить токен - Получает токен авторизации по логину и паролю - - - -`Функция ПолучитьТокен(Знач Логин, Знач Пароль) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Логин | --login | Строка | Логин пользователя | - | Пароль | --password | Строка | Пароль пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Пример кода" - Логин = "2athenaeum"; - Пароль = "Rit..."; - - Результат = OPI_Neocities.ПолучитьТокен(Логин, Пароль); -``` - - - - -```json title="Результат" -{ - "result": "success", - "api_key": "***" -} -``` diff --git a/docs/ru/md/Neocities/Data-retrieving/Get-token.mdx b/docs/ru/md/Neocities/Data-retrieving/Get-token.mdx new file mode 100644 index 0000000000..294082e69a --- /dev/null +++ b/docs/ru/md/Neocities/Data-retrieving/Get-token.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить токен + Получает токен авторизации по логину и паролю + + + +`Функция ПолучитьТокен(Знач Логин, Знач Пароль) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Логин | --login | Строка | Логин пользователя | + | Пароль | --password | Строка | Пароль пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Пример кода" + Логин = "2athenaeum"; + Пароль = "Rit..."; + + Результат = OPI_Neocities.ПолучитьТокен(Логин, Пароль); +``` + + + + +```json title="Результат" +{ + "result": "success", + "api_key": "***" +} +``` diff --git a/docs/ru/md/Neocities/File-managment/Delete-selected-files.md b/docs/ru/md/Neocities/File-managment/Delete-selected-files.md deleted file mode 100644 index 36d518b2d6..0000000000 --- a/docs/ru/md/Neocities/File-managment/Delete-selected-files.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить выбранные файлы - Удаляет файл или несколько файлов с сервера Neocities - - - -`Функция УдалитьВыбранныеФайлы(Знач Токен, Знач Пути) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | Пути | --paths | Строка, Массив Из Строка | Путь или несколько путей удаляемых файлов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Пример кода" - Токен = "7419cd51de4037f7..."; - - Пути = Новый Массив; - Пути.Добавить("/test/pic1.png"); - Пути.Добавить("/test/gif.gif"); - Пути.Добавить("/pic2.png"); - - Результат = OPI_Neocities.УдалитьВыбранныеФайлы(Токен, Пути); -``` - - - - -```json title="Результат" -{ - "result": "success", - "message": "file(s) have been deleted" -} -``` diff --git a/docs/ru/md/Neocities/File-managment/Delete-selected-files.mdx b/docs/ru/md/Neocities/File-managment/Delete-selected-files.mdx new file mode 100644 index 0000000000..c9a2f2fc33 --- /dev/null +++ b/docs/ru/md/Neocities/File-managment/Delete-selected-files.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить выбранные файлы + Удаляет файл или несколько файлов с сервера Neocities + + + +`Функция УдалитьВыбранныеФайлы(Знач Токен, Знач Пути) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | Пути | --paths | Строка, Массив Из Строка | Путь или несколько путей удаляемых файлов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Пример кода" + Токен = "7419cd51de4037f7..."; + + Пути = Новый Массив; + Пути.Добавить("/test/pic1.png"); + Пути.Добавить("/test/gif.gif"); + Пути.Добавить("/pic2.png"); + + Результат = OPI_Neocities.УдалитьВыбранныеФайлы(Токен, Пути); +``` + + + + +```json title="Результат" +{ + "result": "success", + "message": "file(s) have been deleted" +} +``` diff --git a/docs/ru/md/Neocities/File-managment/Get-files-list.md b/docs/ru/md/Neocities/File-managment/Get-files-list.md deleted file mode 100644 index b661d3f0be..0000000000 --- a/docs/ru/md/Neocities/File-managment/Get-files-list.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить список файлов - Получает список файлов с отбором каталога или без - - - -`Функция ПолучитьСписокФайлов(Знач Токен, Знач Путь = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | Путь | --path | Строка | Отбор файлов по каталогу. Все, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Пример кода" - Токен = "7419cd51de4037f7..."; - Путь = "test"; - - Результат = OPI_Neocities.ПолучитьСписокФайлов(Токен, Путь); - - Результат = OPI_Neocities.ПолучитьСписокФайлов(Токен); -``` - - - - -```json title="Результат" -{ - "result": "success", - "files": [ - { - "path": "test/gif.gif", - "is_directory": false, - "size": 805189, - "created_at": "Tue, 08 Oct 2024 17:56:42 -0000", - "updated_at": "Tue, 08 Oct 2024 17:56:42 -0000", - "sha1_hash": null - }, - { - "path": "test/pic1.png", - "is_directory": false, - "size": 2114023, - "created_at": "Tue, 08 Oct 2024 17:56:42 -0000", - "updated_at": "Tue, 08 Oct 2024 17:56:42 -0000", - "sha1_hash": null - } - ] -} -``` diff --git a/docs/ru/md/Neocities/File-managment/Get-files-list.mdx b/docs/ru/md/Neocities/File-managment/Get-files-list.mdx new file mode 100644 index 0000000000..4cebe6ca88 --- /dev/null +++ b/docs/ru/md/Neocities/File-managment/Get-files-list.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить список файлов + Получает список файлов с отбором каталога или без + + + +`Функция ПолучитьСписокФайлов(Знач Токен, Знач Путь = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | Путь | --path | Строка | Отбор файлов по каталогу. Все, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Пример кода" + Токен = "7419cd51de4037f7..."; + Путь = "test"; + + Результат = OPI_Neocities.ПолучитьСписокФайлов(Токен, Путь); + + Результат = OPI_Neocities.ПолучитьСписокФайлов(Токен); +``` + + + + +```json title="Результат" +{ + "result": "success", + "files": [ + { + "path": "test/gif.gif", + "is_directory": false, + "size": 805189, + "created_at": "Tue, 08 Oct 2024 17:56:42 -0000", + "updated_at": "Tue, 08 Oct 2024 17:56:42 -0000", + "sha1_hash": null + }, + { + "path": "test/pic1.png", + "is_directory": false, + "size": 2114023, + "created_at": "Tue, 08 Oct 2024 17:56:42 -0000", + "updated_at": "Tue, 08 Oct 2024 17:56:42 -0000", + "sha1_hash": null + } + ] +} +``` diff --git a/docs/ru/md/Neocities/File-managment/Synchronize-folders.md b/docs/ru/md/Neocities/File-managment/Synchronize-folders.md deleted file mode 100644 index 4c21b934af..0000000000 --- a/docs/ru/md/Neocities/File-managment/Synchronize-folders.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Синхронизировать каталоги - Создает копию локального каталога по выбранному пути на сервере - - - -`Функция СинхронизироватьКаталоги(Знач Токен, Знач ЛокальныйКаталог, Знач УдаленныйКаталог = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | ЛокальныйКаталог | --local | Строка | Локальный каталог источник | - | УдаленныйКаталог | --remote | Строка | Удаленный каталог приемника. Корень, если не заполнено | - - - Возвращаемое значение: Структура Из КлючИЗначение - информация об ошибках синхронизации - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) - - Метод удаляет файлы на сервере, если они отсутствуют в локальном каталоге -::: -
- - -```bsl title="Пример кода" - Токен = "7419cd51de4037f7..."; - - ЛокальныйКаталог = "C:\test_site"; - УдаленныйКаталог = "test_sync"; - - Результат = OPI_Neocities.СинхронизироватьКаталоги(Токен, ЛокальныйКаталог, УдаленныйКаталог); -``` - - - - -```json title="Результат" -{ - "errors": 0, - "items": [] -} -``` diff --git a/docs/ru/md/Neocities/File-managment/Synchronize-folders.mdx b/docs/ru/md/Neocities/File-managment/Synchronize-folders.mdx new file mode 100644 index 0000000000..2d4e84dc67 --- /dev/null +++ b/docs/ru/md/Neocities/File-managment/Synchronize-folders.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Синхронизировать каталоги + Создает копию локального каталога по выбранному пути на сервере + + + +`Функция СинхронизироватьКаталоги(Знач Токен, Знач ЛокальныйКаталог, Знач УдаленныйКаталог = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | ЛокальныйКаталог | --local | Строка | Локальный каталог источник | + | УдаленныйКаталог | --remote | Строка | Удаленный каталог приемника. Корень, если не заполнено | + + + Возвращаемое значение: Структура Из КлючИЗначение - информация об ошибках синхронизации + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) + + Метод удаляет файлы на сервере, если они отсутствуют в локальном каталоге +::: +
+ + +```bsl title="Пример кода" + Токен = "7419cd51de4037f7..."; + + ЛокальныйКаталог = "C:\test_site"; + УдаленныйКаталог = "test_sync"; + + Результат = OPI_Neocities.СинхронизироватьКаталоги(Токен, ЛокальныйКаталог, УдаленныйКаталог); +``` + + + + +```json title="Результат" +{ + "errors": 0, + "items": [] +} +``` diff --git a/docs/ru/md/Neocities/File-managment/Upload-file.md b/docs/ru/md/Neocities/File-managment/Upload-file.md deleted file mode 100644 index 503512e890..0000000000 --- a/docs/ru/md/Neocities/File-managment/Upload-file.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Загрузить файл - Загружает одиночный файл на сервер Neocities - - - -`Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Данные) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | Путь | --path | Строка | Целевой путь файла на Neocities | - | Данные | --file | Строка, ДвоичныеДанные | URL, путь или данные файла для загрузки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Пример кода" - Токен = "7419cd51de4037f7..."; - Данные = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Путь = "testfolder/test_pic.png"; - - Результат = OPI_Neocities.ЗагрузитьФайл(Токен, Путь, Данные); -``` - - - - -```json title="Результат" -{ - "result": "success", - "message": "your file(s) have been successfully uploaded" -} -``` diff --git a/docs/ru/md/Neocities/File-managment/Upload-file.mdx b/docs/ru/md/Neocities/File-managment/Upload-file.mdx new file mode 100644 index 0000000000..40ed88e600 --- /dev/null +++ b/docs/ru/md/Neocities/File-managment/Upload-file.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Загрузить файл + Загружает одиночный файл на сервер Neocities + + + +`Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Данные) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | Путь | --path | Строка | Целевой путь файла на Neocities | + | Данные | --file | Строка, ДвоичныеДанные | URL, путь или данные файла для загрузки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Пример кода" + Токен = "7419cd51de4037f7..."; + Данные = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Путь = "testfolder/test_pic.png"; + + Результат = OPI_Neocities.ЗагрузитьФайл(Токен, Путь, Данные); +``` + + + + +```json title="Результат" +{ + "result": "success", + "message": "your file(s) have been successfully uploaded" +} +``` diff --git a/docs/ru/md/Neocities/File-managment/Upload-files.md b/docs/ru/md/Neocities/File-managment/Upload-files.md deleted file mode 100644 index 78051e389a..0000000000 --- a/docs/ru/md/Neocities/File-managment/Upload-files.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Загрузить файлы - Загружает несколько файлов на сервер Neocities - - - -`Функция ЗагрузитьФайлы(Знач Токен, Знач СоответствиеФайлов, Знач ПоОдному = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен авторизации | - | СоответствиеФайлов | --files | Соответствие Из КлючИЗначение | Файлы для загрузки: Ключ > путь на NC, Значение > Файл | - | ПоОдному | --singly | Булево | Истина > отправляет файлы отдельными запросами | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities - -
- -:::tip -Документация Neocities API: [neocities.org/api](https://neocities.org/api) -::: -
- - -```bsl title="Пример кода" - Токен = "7419cd51de4037f7..."; - - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Путь или Двоичные данные - Гифка = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Путь или Двоичные данные - - СоответствиеФайлов = Новый Соответствие; - СоответствиеФайлов.Вставить("test/pic1.png", Картинка1); - СоответствиеФайлов.Вставить("test/gif.gif" , Картинка2); - СоответствиеФайлов.Вставить("pic2.png" , Гифка); - - Результат = OPI_Neocities.ЗагрузитьФайлы(Токен, СоответствиеФайлов); -``` - - - - -```json title="Результат" -{ - "result": "success", - "message": "your file(s) have been successfully uploaded" -} -``` diff --git a/docs/ru/md/Neocities/File-managment/Upload-files.mdx b/docs/ru/md/Neocities/File-managment/Upload-files.mdx new file mode 100644 index 0000000000..6892176ff7 --- /dev/null +++ b/docs/ru/md/Neocities/File-managment/Upload-files.mdx @@ -0,0 +1,55 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Загрузить файлы + Загружает несколько файлов на сервер Neocities + + + +`Функция ЗагрузитьФайлы(Знач Токен, Знач СоответствиеФайлов, Знач ПоОдному = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен авторизации | + | СоответствиеФайлов | --files | Соответствие Из КлючИЗначение | Файлы для загрузки: Ключ > путь на NC, Значение > Файл | + | ПоОдному | --singly | Булево | Истина > отправляет файлы отдельными запросами | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Neocities + +
+ +:::tip +Документация Neocities API: [neocities.org/api](https://neocities.org/api) +::: +
+ + +```bsl title="Пример кода" + Токен = "7419cd51de4037f7..."; + + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Путь или Двоичные данные + Гифка = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Путь или Двоичные данные + + СоответствиеФайлов = Новый Соответствие; + СоответствиеФайлов.Вставить("test/pic1.png", Картинка1); + СоответствиеФайлов.Вставить("test/gif.gif" , Картинка2); + СоответствиеФайлов.Вставить("pic2.png" , Гифка); + + Результат = OPI_Neocities.ЗагрузитьФайлы(Токен, СоответствиеФайлов); +``` + + + + +```json title="Результат" +{ + "result": "success", + "message": "your file(s) have been successfully uploaded" +} +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Create-block.md b/docs/ru/md/Notion/Blocks-managment/Create-block.md deleted file mode 100644 index 3e4a35716a..0000000000 --- a/docs/ru/md/Notion/Blocks-managment/Create-block.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать блок - Создает новый блок на основе существующего блока - - - -`Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --page | Строка | ID родительского блока или страницы | - | Блок | --block | Строка,Соответствие Из КлючИЗначение | ID блока или сам блок образец | - | ВставитьПосле | --prev | Строка | ID блока, после которого необходимо встаивть новый | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff986b7511c0779f77"; - Блок = "d7021bdd15b944ababcb02bd2b1a5f6a"; - - ДанныеБлока = OPI_Notion.ВернутьБлок(Токен, Блок); - Результат = OPI_Notion.СоздатьБлок(Токен, Родитель, ДанныеБлока); -``` - - - - - - ```bash - oint notion СоздатьБлок --token "***" \ - --page "5dd94c34fab04bff986b7511c0779f77" \ - --block "{'object':'block','parent':{'type':'page_id','page_id':'5dd94c34-fab0-4bff-986b-7511c0779f77'},'in_trash':true,'type':'to_do','to_do':{'rich_text':[{'type':'text','text':{'content':'YoYO','link':null},'annotations':{'bold':false,'italic':false,'strikethrough':false,'underline':false,'code':false,'color':'default'},'plain_text':'YoYO','href':null}],'checked':false,'color':'default'}}" - ``` - - - - ```batch - oint notion СоздатьБлок ^ - --token "***" ^ - --page "5dd94c34fab04bff986b7511c0779f77" ^ - --block "{'object':'block','parent':{'type':'page_id','page_id':'5dd94c34-fab0-4bff-986b-7511c0779f77'},'in_trash':true,'type':'to_do','to_do':{'rich_text':[{'type':'text','text':{'content':'YoYO','link':null},'annotations':{'bold':false,'italic':false,'strikethrough':false,'underline':false,'code':false,'color':'default'},'plain_text':'YoYO','href':null}],'checked':false,'color':'default'}}" - ``` - - - - -```json title="Результат" -{ - "object": "list", - "results": [ - { - "object": "block", - "id": "11982aa7-fc4e-8129-b28d-c507d3204b30", - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "created_time": "2024-10-08T17:43:00Z", - "last_edited_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "has_children": false, - "archived": false, - "in_trash": false, - "type": "to_do", - "to_do": { - "rich_text": [ - { - "type": "text", - "text": { - "content": "YoYO", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "YoYO", - "href": null - } - ], - "checked": false, - "color": "default" - } - } - ], - "next_cursor": null, - "has_more": false, - "type": "block", - "block": {}, - "request_id": "fa8a45d9-69b9-48c6-a1f4-b4f17f623de6" -} -``` diff --git a/docs/ru/md/Notion/Blocks-managment/Create-block.mdx b/docs/ru/md/Notion/Blocks-managment/Create-block.mdx new file mode 100644 index 0000000000..d4147455ea --- /dev/null +++ b/docs/ru/md/Notion/Blocks-managment/Create-block.mdx @@ -0,0 +1,117 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать блок + Создает новый блок на основе существующего блока + + + +`Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID родительского блока или страницы | + | Блок | --block | Строка,Соответствие Из КлючИЗначение | ID блока или сам блок образец | + | ВставитьПосле | --prev | Строка | ID блока, после которого необходимо встаивть новый | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff986b7511c0779f77"; + Блок = "d7021bdd15b944ababcb02bd2b1a5f6a"; + + ДанныеБлока = OPI_Notion.ВернутьБлок(Токен, Блок); + Результат = OPI_Notion.СоздатьБлок(Токен, Родитель, ДанныеБлока); +``` + + + + + + ```bash + oint notion СоздатьБлок --token "***" \ + --page "5dd94c34fab04bff986b7511c0779f77" \ + --block "{'object':'block','parent':{'type':'page_id','page_id':'5dd94c34-fab0-4bff-986b-7511c0779f77'},'in_trash':true,'type':'to_do','to_do':{'rich_text':[{'type':'text','text':{'content':'YoYO','link':null},'annotations':{'bold':false,'italic':false,'strikethrough':false,'underline':false,'code':false,'color':'default'},'plain_text':'YoYO','href':null}],'checked':false,'color':'default'}}" + ``` + + + + ```batch + oint notion СоздатьБлок ^ + --token "***" ^ + --page "5dd94c34fab04bff986b7511c0779f77" ^ + --block "{'object':'block','parent':{'type':'page_id','page_id':'5dd94c34-fab0-4bff-986b-7511c0779f77'},'in_trash':true,'type':'to_do','to_do':{'rich_text':[{'type':'text','text':{'content':'YoYO','link':null},'annotations':{'bold':false,'italic':false,'strikethrough':false,'underline':false,'code':false,'color':'default'},'plain_text':'YoYO','href':null}],'checked':false,'color':'default'}}" + ``` + + + + +```json title="Результат" +{ + "object": "list", + "results": [ + { + "object": "block", + "id": "11982aa7-fc4e-8129-b28d-c507d3204b30", + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "created_time": "2024-10-08T17:43:00Z", + "last_edited_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "has_children": false, + "archived": false, + "in_trash": false, + "type": "to_do", + "to_do": { + "rich_text": [ + { + "type": "text", + "text": { + "content": "YoYO", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "YoYO", + "href": null + } + ], + "checked": false, + "color": "default" + } + } + ], + "next_cursor": null, + "has_more": false, + "type": "block", + "block": {}, + "request_id": "fa8a45d9-69b9-48c6-a1f4-b4f17f623de6" +} +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Delete-block.md b/docs/ru/md/Notion/Blocks-managment/Delete-block.md deleted file mode 100644 index 70aa4ad22a..0000000000 --- a/docs/ru/md/Notion/Blocks-managment/Delete-block.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить блок - Удаляет блок по ID - - - -`Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДБлока | --block | Строка | ID блока | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Блок = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; - - Результат = OPI_Notion.УдалитьБлок(Токен, Блок); -``` - - - - - - ```bash - oint notion УдалитьБлок --token "***" \ - --block "12082aa7-fc4e-8136-917c-e838f972af74" - ``` - - - - ```batch - oint notion УдалитьБлок ^ - --token "***" ^ - --block "12082aa7-fc4e-8136-917c-e838f972af74" - ``` - - - - -```json title="Результат" -{ - "object": "block", - "id": "11982aa7-fc4e-8129-b28d-c507d3204b30", - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "created_time": "2024-10-08T17:43:00Z", - "last_edited_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "has_children": false, - "archived": true, - "in_trash": true, - "type": "to_do", - "to_do": { - "rich_text": [ - { - "type": "text", - "text": { - "content": "YoYO", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "YoYO", - "href": null - } - ], - "checked": false, - "color": "default" - }, - "request_id": "d4032af8-2d35-439a-85be-c9d1a3f8c52e" -} -``` diff --git a/docs/ru/md/Notion/Blocks-managment/Delete-block.mdx b/docs/ru/md/Notion/Blocks-managment/Delete-block.mdx new file mode 100644 index 0000000000..367a8ef9f3 --- /dev/null +++ b/docs/ru/md/Notion/Blocks-managment/Delete-block.mdx @@ -0,0 +1,102 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить блок + Удаляет блок по ID + + + +`Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Блок = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; + + Результат = OPI_Notion.УдалитьБлок(Токен, Блок); +``` + + + + + + ```bash + oint notion УдалитьБлок --token "***" \ + --block "12082aa7-fc4e-8136-917c-e838f972af74" + ``` + + + + ```batch + oint notion УдалитьБлок ^ + --token "***" ^ + --block "12082aa7-fc4e-8136-917c-e838f972af74" + ``` + + + + +```json title="Результат" +{ + "object": "block", + "id": "11982aa7-fc4e-8129-b28d-c507d3204b30", + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "created_time": "2024-10-08T17:43:00Z", + "last_edited_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "has_children": false, + "archived": true, + "in_trash": true, + "type": "to_do", + "to_do": { + "rich_text": [ + { + "type": "text", + "text": { + "content": "YoYO", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "YoYO", + "href": null + } + ], + "checked": false, + "color": "default" + }, + "request_id": "d4032af8-2d35-439a-85be-c9d1a3f8c52e" +} +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-block.md b/docs/ru/md/Notion/Blocks-managment/Return-block.md deleted file mode 100644 index a193120999..0000000000 --- a/docs/ru/md/Notion/Blocks-managment/Return-block.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Вернуть блок - Возвращает структуру блока по ID - - - -`Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДБлока | --block | Строка | ID блока | - | ТолькоОснова | --core | Булево | Истина > служебные поля удаляются, остается только сам блок | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Блок = "d7021bdd15b944ababcb02bd2b1a5f6a"; - - Результат = OPI_Notion.ВернутьБлок(Токен, Блок); -``` - - - - - - ```bash - oint notion ВернутьБлок --token "***" \ - --block "d7021bdd15b944ababcb02bd2b1a5f6a" - ``` - - - - ```batch - oint notion ВернутьБлок ^ - --token "***" ^ - --block "d7021bdd15b944ababcb02bd2b1a5f6a" - ``` - - - - -```json title="Результат" -{ - "object": "block", - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "in_trash": true, - "type": "to_do", - "to_do": { - "rich_text": [ - { - "type": "text", - "text": { - "content": "YoYO", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "YoYO", - "href": null - } - ], - "checked": false, - "color": "default" - } -} -``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-block.mdx b/docs/ru/md/Notion/Blocks-managment/Return-block.mdx new file mode 100644 index 0000000000..6e2ffe6e2c --- /dev/null +++ b/docs/ru/md/Notion/Blocks-managment/Return-block.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Вернуть блок + Возвращает структуру блока по ID + + + +`Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока | + | ТолькоОснова | --core | Булево | Истина > служебные поля удаляются, остается только сам блок | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Блок = "d7021bdd15b944ababcb02bd2b1a5f6a"; + + Результат = OPI_Notion.ВернутьБлок(Токен, Блок); +``` + + + + + + ```bash + oint notion ВернутьБлок --token "***" \ + --block "d7021bdd15b944ababcb02bd2b1a5f6a" + ``` + + + + ```batch + oint notion ВернутьБлок ^ + --token "***" ^ + --block "d7021bdd15b944ababcb02bd2b1a5f6a" + ``` + + + + +```json title="Результат" +{ + "object": "block", + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "in_trash": true, + "type": "to_do", + "to_do": { + "rich_text": [ + { + "type": "text", + "text": { + "content": "YoYO", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "YoYO", + "href": null + } + ], + "checked": false, + "color": "default" + } +} +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md deleted file mode 100644 index 31475cb847..0000000000 --- a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Вернуть дочерние блоки - Созвращает список дочерних блоков блока-родителя - - - -`Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДБлока | --block | Строка | ID блока родителя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Блок = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; - - Результат = OPI_Notion.ВернутьДочерниеБлоки(Токен, Блок); -``` - - - - - - ```bash - oint notion ВернутьДочерниеБлоки --token "***" \ - --block "12082aa7-fc4e-8136-917c-e838f972af74" - ``` - - - - ```batch - oint notion ВернутьДочерниеБлоки ^ - --token "***" ^ - --block "12082aa7-fc4e-8136-917c-e838f972af74" - ``` - - - - -```json title="Результат" -{ - "object": "list", - "results": [], - "next_cursor": null, - "has_more": false, - "type": "block", - "block": {}, - "request_id": "29c8abb1-7a13-448b-82ef-449646b1ae63" -} -``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.mdx b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.mdx new file mode 100644 index 0000000000..62cc5eef8f --- /dev/null +++ b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Вернуть дочерние блоки + Созвращает список дочерних блоков блока-родителя + + + +`Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока родителя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Блок = "11e82aa7-fc4e-81a6-964e-e3689f51bcbf"; + + Результат = OPI_Notion.ВернутьДочерниеБлоки(Токен, Блок); +``` + + + + + + ```bash + oint notion ВернутьДочерниеБлоки --token "***" \ + --block "12082aa7-fc4e-8136-917c-e838f972af74" + ``` + + + + ```batch + oint notion ВернутьДочерниеБлоки ^ + --token "***" ^ + --block "12082aa7-fc4e-8136-917c-e838f972af74" + ``` + + + + +```json title="Результат" +{ + "object": "list", + "results": [], + "next_cursor": null, + "has_more": false, + "type": "block", + "block": {}, + "request_id": "29c8abb1-7a13-448b-82ef-449646b1ae63" +} +``` diff --git a/docs/ru/md/Notion/Database-management/Create-database.md b/docs/ru/md/Notion/Database-management/Create-database.md deleted file mode 100644 index 4502f5f848..0000000000 --- a/docs/ru/md/Notion/Database-management/Create-database.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать базу данных - Создает базу данных - - - -`Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --page | Строка | ID страницы родителя | - | Заголовок | --title | Строка | Заголовок базы данных | - | Свойства | --props | Структура Из Строка | Свойства базы данных | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff986b7511c0779f77"; - Заголовок = "Тестовый заголовок"; - - Свойства = Новый Соответствие; - Свойства.Вставить("Имя" , "title"); - Свойства.Вставить("Описание" , "rich_text"); - Свойства.Вставить("Номер" , "number"); - Свойства.Вставить("Статус" , "status"); - Свойства.Вставить("Дата создания" , "date"); - Свойства.Вставить("Картинка" , "files"); - Свойства.Вставить("Активен" , "checkbox"); - Свойства.Вставить("Сайт" , "url"); - Свойства.Вставить("Почта" , "email"); - Свойства.Вставить("Телефон" , "phone_number"); - Свойства.Вставить("Пользователь" , "people"); - - ВыборЗначения = Новый Соответствие; - ВыборЗначения.Вставить("Новый" , "green"); - ВыборЗначения.Вставить("В работе" , "yellow"); - ВыборЗначения.Вставить("Удаленный", "red"); - - Свойства.Вставить("Статус", ВыборЗначения); - - Результат = OPI_Notion.СоздатьБазуДанных(Токен, Родитель, Заголовок, Свойства); -``` - - - - - - ```bash - oint notion СоздатьБазуДанных --token "***" \ - --page "5dd94c34fab04bff986b7511c0779f77" \ - --title "Тестовый заголовок" \ - --props "{'Имя':'title','Описание':'rich_text','Номер':'number','Статус':{'Новый':'green','В работе':'yellow','Удаленный':'red'},'Дата создания':'date','Картинка':'files','Активен':'checkbox','Сайт':'url','Почта':'email','Телефон':'phone_number','Пользователь':'people'}" - ``` - - - - ```batch - oint notion СоздатьБазуДанных ^ - --token "***" ^ - --page "5dd94c34fab04bff986b7511c0779f77" ^ - --title "Тестовый заголовок" ^ - --props "{'Имя':'title','Описание':'rich_text','Номер':'number','Статус':{'Новый':'green','В работе':'yellow','Удаленный':'red'},'Дата создания':'date','Картинка':'files','Активен':'checkbox','Сайт':'url','Почта':'email','Телефон':'phone_number','Пользователь':'people'}" - ``` - - - - -```json title="Результат" -{ - "object": "database", - "id": "11982aa7-fc4e-817b-8882-f2ec929e9249", - "cover": null, - "icon": null, - "created_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_time": "2024-10-08T17:43:00Z", - "title": [ - { - "type": "text", - "text": { - "content": "Тестовый заголовок", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовый заголовок", - "href": null - } - ], - "description": [], - "is_inline": false, - "properties": { - "Картинка": { - "id": "GwHP", - "name": "Картинка", - "type": "files", - "files": {} - }, - "Активен": { - "id": "I%5Cit", - "name": "Активен", - "type": "checkbox", - "checkbox": {} - }, - "Номер": { - "id": "LYhy", - "name": "Номер", - "type": "number", - "number": { - "format": "number" - } - }, - "Телефон": { - "id": "N%3A%60j", - "name": "Телефон", - "type": "phone_number", - "phone_number": {} - }, - "Почта": { - "id": "_GzL", - "name": "Почта", - "type": "email", - "email": {} - }, - "Пользователь": { - "id": "fqnB", - "name": "Пользователь", - "type": "people", - "people": {} - }, - "Статус": { - "id": "k_dl", - "name": "Статус", - "type": "select", - "select": { - "options": [ - { - "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", - "name": "Новый", - "color": "green", - "description": null - }, - { - "id": "bb54e060-bb63-4529-a3e2-f3908ecefd15", - "name": "В работе", - "color": "yellow", - "description": null - }, - { - "id": "9b82a353-458a-415b-9c4f-2caf681c3a13", - "name": "Удаленный", - "color": "red", - "description": null - } - ] - } - }, - "Дата создания": { - "id": "lFrr", - "name": "Дата создания", - "type": "date", - "date": {} - }, - "Сайт": { - "id": "wD%5Cz", - "name": "Сайт", - "type": "url", - "url": {} - }, - "Описание": { - "id": "zAM%7D", - "name": "Описание", - "type": "rich_text", - "rich_text": {} - }, - "Имя": { - "id": "title", - "name": "Имя", - "type": "title", - "title": {} - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "url": "https://www.notion.so/11982aa7fc4e817b8882f2ec929e9249", - "public_url": null, - "archived": false, - "in_trash": false, - "request_id": "4c5c3faf-690d-4768-9949-2f176f02a2fe" -} -``` diff --git a/docs/ru/md/Notion/Database-management/Create-database.mdx b/docs/ru/md/Notion/Database-management/Create-database.mdx new file mode 100644 index 0000000000..e077a42d0f --- /dev/null +++ b/docs/ru/md/Notion/Database-management/Create-database.mdx @@ -0,0 +1,220 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать базу данных + Создает базу данных + + + +`Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID страницы родителя | + | Заголовок | --title | Строка | Заголовок базы данных | + | Свойства | --props | Структура Из Строка | Свойства базы данных | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff986b7511c0779f77"; + Заголовок = "Тестовый заголовок"; + + Свойства = Новый Соответствие; + Свойства.Вставить("Имя" , "title"); + Свойства.Вставить("Описание" , "rich_text"); + Свойства.Вставить("Номер" , "number"); + Свойства.Вставить("Статус" , "status"); + Свойства.Вставить("Дата создания" , "date"); + Свойства.Вставить("Картинка" , "files"); + Свойства.Вставить("Активен" , "checkbox"); + Свойства.Вставить("Сайт" , "url"); + Свойства.Вставить("Почта" , "email"); + Свойства.Вставить("Телефон" , "phone_number"); + Свойства.Вставить("Пользователь" , "people"); + + ВыборЗначения = Новый Соответствие; + ВыборЗначения.Вставить("Новый" , "green"); + ВыборЗначения.Вставить("В работе" , "yellow"); + ВыборЗначения.Вставить("Удаленный", "red"); + + Свойства.Вставить("Статус", ВыборЗначения); + + Результат = OPI_Notion.СоздатьБазуДанных(Токен, Родитель, Заголовок, Свойства); +``` + + + + + + ```bash + oint notion СоздатьБазуДанных --token "***" \ + --page "5dd94c34fab04bff986b7511c0779f77" \ + --title "Тестовый заголовок" \ + --props "{'Имя':'title','Описание':'rich_text','Номер':'number','Статус':{'Новый':'green','В работе':'yellow','Удаленный':'red'},'Дата создания':'date','Картинка':'files','Активен':'checkbox','Сайт':'url','Почта':'email','Телефон':'phone_number','Пользователь':'people'}" + ``` + + + + ```batch + oint notion СоздатьБазуДанных ^ + --token "***" ^ + --page "5dd94c34fab04bff986b7511c0779f77" ^ + --title "Тестовый заголовок" ^ + --props "{'Имя':'title','Описание':'rich_text','Номер':'number','Статус':{'Новый':'green','В работе':'yellow','Удаленный':'red'},'Дата создания':'date','Картинка':'files','Активен':'checkbox','Сайт':'url','Почта':'email','Телефон':'phone_number','Пользователь':'people'}" + ``` + + + + +```json title="Результат" +{ + "object": "database", + "id": "11982aa7-fc4e-817b-8882-f2ec929e9249", + "cover": null, + "icon": null, + "created_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_time": "2024-10-08T17:43:00Z", + "title": [ + { + "type": "text", + "text": { + "content": "Тестовый заголовок", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовый заголовок", + "href": null + } + ], + "description": [], + "is_inline": false, + "properties": { + "Картинка": { + "id": "GwHP", + "name": "Картинка", + "type": "files", + "files": {} + }, + "Активен": { + "id": "I%5Cit", + "name": "Активен", + "type": "checkbox", + "checkbox": {} + }, + "Номер": { + "id": "LYhy", + "name": "Номер", + "type": "number", + "number": { + "format": "number" + } + }, + "Телефон": { + "id": "N%3A%60j", + "name": "Телефон", + "type": "phone_number", + "phone_number": {} + }, + "Почта": { + "id": "_GzL", + "name": "Почта", + "type": "email", + "email": {} + }, + "Пользователь": { + "id": "fqnB", + "name": "Пользователь", + "type": "people", + "people": {} + }, + "Статус": { + "id": "k_dl", + "name": "Статус", + "type": "select", + "select": { + "options": [ + { + "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", + "name": "Новый", + "color": "green", + "description": null + }, + { + "id": "bb54e060-bb63-4529-a3e2-f3908ecefd15", + "name": "В работе", + "color": "yellow", + "description": null + }, + { + "id": "9b82a353-458a-415b-9c4f-2caf681c3a13", + "name": "Удаленный", + "color": "red", + "description": null + } + ] + } + }, + "Дата создания": { + "id": "lFrr", + "name": "Дата создания", + "type": "date", + "date": {} + }, + "Сайт": { + "id": "wD%5Cz", + "name": "Сайт", + "type": "url", + "url": {} + }, + "Описание": { + "id": "zAM%7D", + "name": "Описание", + "type": "rich_text", + "rich_text": {} + }, + "Имя": { + "id": "title", + "name": "Имя", + "type": "title", + "title": {} + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "url": "https://www.notion.so/11982aa7fc4e817b8882f2ec929e9249", + "public_url": null, + "archived": false, + "in_trash": false, + "request_id": "4c5c3faf-690d-4768-9949-2f176f02a2fe" +} +``` diff --git a/docs/ru/md/Notion/Database-management/Edit-database-properties.md b/docs/ru/md/Notion/Database-management/Edit-database-properties.md deleted file mode 100644 index 3eba2cae7a..0000000000 --- a/docs/ru/md/Notion/Database-management/Edit-database-properties.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить свойства базы - Изменяет свойства существующей базы - - - -`Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | ID целевой базы | - | Свойства | --props | Соответствие из КлючИЗначение | Новые или изменяемые свойства базы данных | - | Заголовок | --title | Строка | Новый заголовок базы | - | Описание | --description | Строка | Новое описание базы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - База = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; - - Заголовок = "Тестовый заголовок"; - Описание = "Тестовое описание"; - - Свойства = Новый Соответствие; - Свойства.Вставить("Почта", "rich_text"); // Тип поля "Почта" будет изменен с email на текст - Свойства.Вставить("Сайт"); // Поле "Сайт" будет удалено - - Результат = OPI_Notion.ИзменитьСвойстваБазы(Токен, База, Свойства, Заголовок, Описание); -``` - - - - - - ```bash - oint notion ИзменитьСвойстваБазы --token "***" \ - --base "12082aa7-fc4e-81e4-a694-ecc74712d756" \ - --props "{'Почта':'rich_text','Сайт':null}" \ - --title "Тестовый заголовок" \ - --description "Тестовое описание" - ``` - - - - ```batch - oint notion ИзменитьСвойстваБазы ^ - --token "***" ^ - --base "12082aa7-fc4e-81e4-a694-ecc74712d756" ^ - --props "{'Почта':'rich_text','Сайт':null}" ^ - --title "Тестовый заголовок" ^ - --description "Тестовое описание" - ``` - - - - -```json title="Результат" -{ - "object": "database", - "id": "11982aa7-fc4e-817b-8882-f2ec929e9249", - "cover": null, - "icon": null, - "created_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_time": "2024-10-08T17:43:00Z", - "title": [ - { - "type": "text", - "text": { - "content": "Тестовый заголовок", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовый заголовок", - "href": null - } - ], - "description": [ - { - "type": "text", - "text": { - "content": "Тестовое описание", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовое описание", - "href": null - } - ], - "is_inline": false, - "properties": { - "Картинка": { - "id": "GwHP", - "name": "Картинка", - "type": "files", - "files": {} - }, - "Активен": { - "id": "I%5Cit", - "name": "Активен", - "type": "checkbox", - "checkbox": {} - }, - "Номер": { - "id": "LYhy", - "name": "Номер", - "type": "number", - "number": { - "format": "number" - } - }, - "Телефон": { - "id": "N%3A%60j", - "name": "Телефон", - "type": "phone_number", - "phone_number": {} - }, - "Почта": { - "id": "_GzL", - "name": "Почта", - "type": "rich_text", - "rich_text": {} - }, - "Пользователь": { - "id": "fqnB", - "name": "Пользователь", - "type": "people", - "people": {} - }, - "Статус": { - "id": "k_dl", - "name": "Статус", - "type": "select", - "select": { - "options": [ - { - "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", - "name": "Новый", - "color": "green", - "description": null - }, - { - "id": "bb54e060-bb63-4529-a3e2-f3908ecefd15", - "name": "В работе", - "color": "yellow", - "description": null - }, - { - "id": "9b82a353-458a-415b-9c4f-2caf681c3a13", - "name": "Удаленный", - "color": "red", - "description": null - } - ] - } - }, - "Дата создания": { - "id": "lFrr", - "name": "Дата создания", - "type": "date", - "date": {} - }, - "Описание": { - "id": "zAM%7D", - "name": "Описание", - "type": "rich_text", - "rich_text": {} - }, - "Имя": { - "id": "title", - "name": "Имя", - "type": "title", - "title": {} - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "url": "https://www.notion.so/11982aa7fc4e817b8882f2ec929e9249", - "public_url": null, - "archived": false, - "in_trash": false, - "request_id": "4bb4498e-c32c-491c-9da1-e1c82c99ba88" -} -``` diff --git a/docs/ru/md/Notion/Database-management/Edit-database-properties.mdx b/docs/ru/md/Notion/Database-management/Edit-database-properties.mdx new file mode 100644 index 0000000000..e03a4594fb --- /dev/null +++ b/docs/ru/md/Notion/Database-management/Edit-database-properties.mdx @@ -0,0 +1,221 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить свойства базы + Изменяет свойства существующей базы + + + +`Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | ID целевой базы | + | Свойства | --props | Соответствие из КлючИЗначение | Новые или изменяемые свойства базы данных | + | Заголовок | --title | Строка | Новый заголовок базы | + | Описание | --description | Строка | Новое описание базы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + База = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; + + Заголовок = "Тестовый заголовок"; + Описание = "Тестовое описание"; + + Свойства = Новый Соответствие; + Свойства.Вставить("Почта", "rich_text"); // Тип поля "Почта" будет изменен с email на текст + Свойства.Вставить("Сайт"); // Поле "Сайт" будет удалено + + Результат = OPI_Notion.ИзменитьСвойстваБазы(Токен, База, Свойства, Заголовок, Описание); +``` + + + + + + ```bash + oint notion ИзменитьСвойстваБазы --token "***" \ + --base "12082aa7-fc4e-81e4-a694-ecc74712d756" \ + --props "{'Почта':'rich_text','Сайт':null}" \ + --title "Тестовый заголовок" \ + --description "Тестовое описание" + ``` + + + + ```batch + oint notion ИзменитьСвойстваБазы ^ + --token "***" ^ + --base "12082aa7-fc4e-81e4-a694-ecc74712d756" ^ + --props "{'Почта':'rich_text','Сайт':null}" ^ + --title "Тестовый заголовок" ^ + --description "Тестовое описание" + ``` + + + + +```json title="Результат" +{ + "object": "database", + "id": "11982aa7-fc4e-817b-8882-f2ec929e9249", + "cover": null, + "icon": null, + "created_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_time": "2024-10-08T17:43:00Z", + "title": [ + { + "type": "text", + "text": { + "content": "Тестовый заголовок", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовый заголовок", + "href": null + } + ], + "description": [ + { + "type": "text", + "text": { + "content": "Тестовое описание", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовое описание", + "href": null + } + ], + "is_inline": false, + "properties": { + "Картинка": { + "id": "GwHP", + "name": "Картинка", + "type": "files", + "files": {} + }, + "Активен": { + "id": "I%5Cit", + "name": "Активен", + "type": "checkbox", + "checkbox": {} + }, + "Номер": { + "id": "LYhy", + "name": "Номер", + "type": "number", + "number": { + "format": "number" + } + }, + "Телефон": { + "id": "N%3A%60j", + "name": "Телефон", + "type": "phone_number", + "phone_number": {} + }, + "Почта": { + "id": "_GzL", + "name": "Почта", + "type": "rich_text", + "rich_text": {} + }, + "Пользователь": { + "id": "fqnB", + "name": "Пользователь", + "type": "people", + "people": {} + }, + "Статус": { + "id": "k_dl", + "name": "Статус", + "type": "select", + "select": { + "options": [ + { + "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", + "name": "Новый", + "color": "green", + "description": null + }, + { + "id": "bb54e060-bb63-4529-a3e2-f3908ecefd15", + "name": "В работе", + "color": "yellow", + "description": null + }, + { + "id": "9b82a353-458a-415b-9c4f-2caf681c3a13", + "name": "Удаленный", + "color": "red", + "description": null + } + ] + } + }, + "Дата создания": { + "id": "lFrr", + "name": "Дата создания", + "type": "date", + "date": {} + }, + "Описание": { + "id": "zAM%7D", + "name": "Описание", + "type": "rich_text", + "rich_text": {} + }, + "Имя": { + "id": "title", + "name": "Имя", + "type": "title", + "title": {} + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "url": "https://www.notion.so/11982aa7fc4e817b8882f2ec929e9249", + "public_url": null, + "archived": false, + "in_trash": false, + "request_id": "4bb4498e-c32c-491c-9da1-e1c82c99ba88" +} +``` diff --git a/docs/ru/md/Notion/Database-management/Get-database.md b/docs/ru/md/Notion/Database-management/Get-database.md deleted file mode 100644 index 792d618ad9..0000000000 --- a/docs/ru/md/Notion/Database-management/Get-database.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить базу данных - Получить данные о базе данных - - - -`Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | ID базы данных | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - База = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; - - Результат = OPI_Notion.ПолучитьБазуДанных(Токен, База); -``` - - - - - - ```bash - oint notion ПолучитьБазуДанных --token "***" \ - --base "12082aa7-fc4e-81e4-a694-ecc74712d756" - ``` - - - - ```batch - oint notion ПолучитьБазуДанных ^ - --token "***" ^ - --base "12082aa7-fc4e-81e4-a694-ecc74712d756" - ``` - - - - -```json title="Результат" -{ - "object": "database", - "id": "11982aa7-fc4e-817b-8882-f2ec929e9249", - "cover": null, - "icon": null, - "created_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_time": "2024-10-08T17:43:00Z", - "title": [ - { - "type": "text", - "text": { - "content": "Тестовый заголовок", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовый заголовок", - "href": null - } - ], - "description": [ - { - "type": "text", - "text": { - "content": "Тестовое описание", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовое описание", - "href": null - } - ], - "is_inline": false, - "properties": { - "Картинка": { - "id": "GwHP", - "name": "Картинка", - "type": "files", - "files": {} - }, - "Активен": { - "id": "I%5Cit", - "name": "Активен", - "type": "checkbox", - "checkbox": {} - }, - "Номер": { - "id": "LYhy", - "name": "Номер", - "type": "number", - "number": { - "format": "number" - } - }, - "Телефон": { - "id": "N%3A%60j", - "name": "Телефон", - "type": "phone_number", - "phone_number": {} - }, - "Почта": { - "id": "_GzL", - "name": "Почта", - "type": "rich_text", - "rich_text": {} - }, - "Пользователь": { - "id": "fqnB", - "name": "Пользователь", - "type": "people", - "people": {} - }, - "Статус": { - "id": "k_dl", - "name": "Статус", - "type": "select", - "select": { - "options": [ - { - "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", - "name": "Новый", - "color": "green", - "description": null - }, - { - "id": "bb54e060-bb63-4529-a3e2-f3908ecefd15", - "name": "В работе", - "color": "yellow", - "description": null - }, - { - "id": "9b82a353-458a-415b-9c4f-2caf681c3a13", - "name": "Удаленный", - "color": "red", - "description": null - } - ] - } - }, - "Дата создания": { - "id": "lFrr", - "name": "Дата создания", - "type": "date", - "date": {} - }, - "Описание": { - "id": "zAM%7D", - "name": "Описание", - "type": "rich_text", - "rich_text": {} - }, - "Имя": { - "id": "title", - "name": "Имя", - "type": "title", - "title": {} - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "url": "https://www.notion.so/11982aa7fc4e817b8882f2ec929e9249", - "public_url": null, - "archived": false, - "in_trash": false, - "request_id": "0e42d5d3-ddf5-4727-b0fb-94d77962df3d" -} -``` diff --git a/docs/ru/md/Notion/Database-management/Get-database.mdx b/docs/ru/md/Notion/Database-management/Get-database.mdx new file mode 100644 index 0000000000..d20b62f83f --- /dev/null +++ b/docs/ru/md/Notion/Database-management/Get-database.mdx @@ -0,0 +1,205 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить базу данных + Получить данные о базе данных + + + +`Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | ID базы данных | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + База = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; + + Результат = OPI_Notion.ПолучитьБазуДанных(Токен, База); +``` + + + + + + ```bash + oint notion ПолучитьБазуДанных --token "***" \ + --base "12082aa7-fc4e-81e4-a694-ecc74712d756" + ``` + + + + ```batch + oint notion ПолучитьБазуДанных ^ + --token "***" ^ + --base "12082aa7-fc4e-81e4-a694-ecc74712d756" + ``` + + + + +```json title="Результат" +{ + "object": "database", + "id": "11982aa7-fc4e-817b-8882-f2ec929e9249", + "cover": null, + "icon": null, + "created_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_time": "2024-10-08T17:43:00Z", + "title": [ + { + "type": "text", + "text": { + "content": "Тестовый заголовок", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовый заголовок", + "href": null + } + ], + "description": [ + { + "type": "text", + "text": { + "content": "Тестовое описание", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовое описание", + "href": null + } + ], + "is_inline": false, + "properties": { + "Картинка": { + "id": "GwHP", + "name": "Картинка", + "type": "files", + "files": {} + }, + "Активен": { + "id": "I%5Cit", + "name": "Активен", + "type": "checkbox", + "checkbox": {} + }, + "Номер": { + "id": "LYhy", + "name": "Номер", + "type": "number", + "number": { + "format": "number" + } + }, + "Телефон": { + "id": "N%3A%60j", + "name": "Телефон", + "type": "phone_number", + "phone_number": {} + }, + "Почта": { + "id": "_GzL", + "name": "Почта", + "type": "rich_text", + "rich_text": {} + }, + "Пользователь": { + "id": "fqnB", + "name": "Пользователь", + "type": "people", + "people": {} + }, + "Статус": { + "id": "k_dl", + "name": "Статус", + "type": "select", + "select": { + "options": [ + { + "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", + "name": "Новый", + "color": "green", + "description": null + }, + { + "id": "bb54e060-bb63-4529-a3e2-f3908ecefd15", + "name": "В работе", + "color": "yellow", + "description": null + }, + { + "id": "9b82a353-458a-415b-9c4f-2caf681c3a13", + "name": "Удаленный", + "color": "red", + "description": null + } + ] + } + }, + "Дата создания": { + "id": "lFrr", + "name": "Дата создания", + "type": "date", + "date": {} + }, + "Описание": { + "id": "zAM%7D", + "name": "Описание", + "type": "rich_text", + "rich_text": {} + }, + "Имя": { + "id": "title", + "name": "Имя", + "type": "title", + "title": {} + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "url": "https://www.notion.so/11982aa7fc4e817b8882f2ec929e9249", + "public_url": null, + "archived": false, + "in_trash": false, + "request_id": "0e42d5d3-ddf5-4727-b0fb-94d77962df3d" +} +``` diff --git a/docs/ru/md/Notion/Page-management/Create-page-in-database.md b/docs/ru/md/Notion/Page-management/Create-page-in-database.md deleted file mode 100644 index 177d836acd..0000000000 --- a/docs/ru/md/Notion/Page-management/Create-page-in-database.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать страницу в базу - Создает страницу в базе-родителе - - - -`Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --base | Строка | ID родительской базы | - | Данные | --data | Соответствие Из КлючИЗначение | Соответствие свойств | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - База = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; - Картинка_ = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу - - Картинка = Новый Соответствие; - Картинка.Вставить("Лого", Картинка_); - - Свойства = Новый Соответствие; - Свойства.Вставить("Имя" , "ООО Вектор"); - Свойства.Вставить("Описание" , "Наш первый клиент"); - Свойства.Вставить("Номер" , 1); - Свойства.Вставить("Статус" , "Обычный"); - Свойства.Вставить("Дата создания" , OPI_Инструменты.ПолучитьТекущуюДату()); - Свойства.Вставить("Картинка" , Картинка); - Свойства.Вставить("Активен" , Истина); - Свойства.Вставить("Сайт" , "https://vector.ru"); - Свойства.Вставить("Почта" , "mail@vector.ru"); - Свойства.Вставить("Телефон" , "88005553535"); - Свойства.Вставить("Статус" , "Новый"); - - Результат = OPI_Notion.СоздатьСтраницуВБазу(Токен, База, Свойства); -``` - - - - - - ```bash - oint notion СоздатьСтраницуВБазу --token "***" \ - --base "12082aa7-fc4e-81e4-a694-ecc74712d756" \ - --data "{'Имя':'ООО Вектор','Описание':'Наш первый клиент','Номер':1,'Статус':'Новый','Дата создания':'2024-10-15T09:17:08.4353796Z','Картинка':{'Лого':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg'},'Активен':true,'Сайт':'https://vector.ru','Почта':'mail@vector.ru','Телефон':'88005553535'}" - ``` - - - - ```batch - oint notion СоздатьСтраницуВБазу ^ - --token "***" ^ - --base "12082aa7-fc4e-81e4-a694-ecc74712d756" ^ - --data "{'Имя':'ООО Вектор','Описание':'Наш первый клиент','Номер':1,'Статус':'Новый','Дата создания':'2024-10-15T09:17:08.4353796Z','Картинка':{'Лого':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg'},'Активен':true,'Сайт':'https://vector.ru','Почта':'mail@vector.ru','Телефон':'88005553535'}" - ``` - - - - -```json title="Результат" -{ - "object": "page", - "id": "11982aa7-fc4e-817a-a22e-c303e89630e4", - "created_time": "2024-10-08T17:43:00Z", - "last_edited_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": null, - "icon": null, - "parent": { - "type": "database_id", - "database_id": "11982aa7-fc4e-817b-8882-f2ec929e9249" - }, - "archived": false, - "in_trash": false, - "properties": { - "Картинка": { - "id": "GwHP", - "type": "files", - "files": [ - { - "name": "Лого", - "type": "external", - "external": { - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - } - } - ] - }, - "Активен": { - "id": "I%5Cit", - "type": "checkbox", - "checkbox": true - }, - "Номер": { - "id": "LYhy", - "type": "number", - "number": 1 - }, - "Телефон": { - "id": "N%3A%60j", - "type": "phone_number", - "phone_number": "88005553535" - }, - "Почта": { - "id": "_GzL", - "type": "rich_text", - "rich_text": [ - { - "type": "text", - "text": { - "content": "mail@vector.ru", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "mail@vector.ru", - "href": null - } - ] - }, - "Пользователь": { - "id": "fqnB", - "type": "people", - "people": [] - }, - "Статус": { - "id": "k_dl", - "type": "select", - "select": { - "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", - "name": "Новый", - "color": "green" - } - }, - "Дата создания": { - "id": "lFrr", - "type": "date", - "date": { - "start": "2024-10-08T11:43:00+03:00", - "end": null, - "time_zone": null - } - }, - "Описание": { - "id": "zAM%7D", - "type": "rich_text", - "rich_text": [ - { - "type": "text", - "text": { - "content": "Наш первый клиент", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Наш первый клиент", - "href": null - } - ] - }, - "Имя": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "ООО Вектор", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "ООО Вектор", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/11982aa7fc4e817aa22ec303e89630e4", - "public_url": null, - "request_id": "a0eef4c4-d384-4f73-89d9-5fbb2a90d644" -} -``` diff --git a/docs/ru/md/Notion/Page-management/Create-page-in-database.mdx b/docs/ru/md/Notion/Page-management/Create-page-in-database.mdx new file mode 100644 index 0000000000..1fb08ebc31 --- /dev/null +++ b/docs/ru/md/Notion/Page-management/Create-page-in-database.mdx @@ -0,0 +1,223 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать страницу в базу + Создает страницу в базе-родителе + + + +`Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --base | Строка | ID родительской базы | + | Данные | --data | Соответствие Из КлючИЗначение | Соответствие свойств | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + База = "11e82aa7-fc4e-816a-9812-fcc332821c4a"; + Картинка_ = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу + + Картинка = Новый Соответствие; + Картинка.Вставить("Лого", Картинка_); + + Свойства = Новый Соответствие; + Свойства.Вставить("Имя" , "ООО Вектор"); + Свойства.Вставить("Описание" , "Наш первый клиент"); + Свойства.Вставить("Номер" , 1); + Свойства.Вставить("Статус" , "Обычный"); + Свойства.Вставить("Дата создания" , OPI_Инструменты.ПолучитьТекущуюДату()); + Свойства.Вставить("Картинка" , Картинка); + Свойства.Вставить("Активен" , Истина); + Свойства.Вставить("Сайт" , "https://vector.ru"); + Свойства.Вставить("Почта" , "mail@vector.ru"); + Свойства.Вставить("Телефон" , "88005553535"); + Свойства.Вставить("Статус" , "Новый"); + + Результат = OPI_Notion.СоздатьСтраницуВБазу(Токен, База, Свойства); +``` + + + + + + ```bash + oint notion СоздатьСтраницуВБазу --token "***" \ + --base "12082aa7-fc4e-81e4-a694-ecc74712d756" \ + --data "{'Имя':'ООО Вектор','Описание':'Наш первый клиент','Номер':1,'Статус':'Новый','Дата создания':'2024-10-15T09:17:08.4353796Z','Картинка':{'Лого':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg'},'Активен':true,'Сайт':'https://vector.ru','Почта':'mail@vector.ru','Телефон':'88005553535'}" + ``` + + + + ```batch + oint notion СоздатьСтраницуВБазу ^ + --token "***" ^ + --base "12082aa7-fc4e-81e4-a694-ecc74712d756" ^ + --data "{'Имя':'ООО Вектор','Описание':'Наш первый клиент','Номер':1,'Статус':'Новый','Дата создания':'2024-10-15T09:17:08.4353796Z','Картинка':{'Лого':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg'},'Активен':true,'Сайт':'https://vector.ru','Почта':'mail@vector.ru','Телефон':'88005553535'}" + ``` + + + + +```json title="Результат" +{ + "object": "page", + "id": "11982aa7-fc4e-817a-a22e-c303e89630e4", + "created_time": "2024-10-08T17:43:00Z", + "last_edited_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": null, + "icon": null, + "parent": { + "type": "database_id", + "database_id": "11982aa7-fc4e-817b-8882-f2ec929e9249" + }, + "archived": false, + "in_trash": false, + "properties": { + "Картинка": { + "id": "GwHP", + "type": "files", + "files": [ + { + "name": "Лого", + "type": "external", + "external": { + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + } + } + ] + }, + "Активен": { + "id": "I%5Cit", + "type": "checkbox", + "checkbox": true + }, + "Номер": { + "id": "LYhy", + "type": "number", + "number": 1 + }, + "Телефон": { + "id": "N%3A%60j", + "type": "phone_number", + "phone_number": "88005553535" + }, + "Почта": { + "id": "_GzL", + "type": "rich_text", + "rich_text": [ + { + "type": "text", + "text": { + "content": "mail@vector.ru", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "mail@vector.ru", + "href": null + } + ] + }, + "Пользователь": { + "id": "fqnB", + "type": "people", + "people": [] + }, + "Статус": { + "id": "k_dl", + "type": "select", + "select": { + "id": "6d76ff5e-d6d1-4266-b808-5372ec81a8da", + "name": "Новый", + "color": "green" + } + }, + "Дата создания": { + "id": "lFrr", + "type": "date", + "date": { + "start": "2024-10-08T11:43:00+03:00", + "end": null, + "time_zone": null + } + }, + "Описание": { + "id": "zAM%7D", + "type": "rich_text", + "rich_text": [ + { + "type": "text", + "text": { + "content": "Наш первый клиент", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Наш первый клиент", + "href": null + } + ] + }, + "Имя": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "ООО Вектор", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "ООО Вектор", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/11982aa7fc4e817aa22ec303e89630e4", + "public_url": null, + "request_id": "a0eef4c4-d384-4f73-89d9-5fbb2a90d644" +} +``` diff --git a/docs/ru/md/Notion/Page-management/Create-page.md b/docs/ru/md/Notion/Page-management/Create-page.md deleted file mode 100644 index f1594df48c..0000000000 --- a/docs/ru/md/Notion/Page-management/Create-page.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать страницу - Создает дочернюю страницу над другой страницей-родителем - - - -`Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --page | Строка | ID Родителя | - | Заголовок | --title | Строка | Заголовок страницы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff986b7511c0779f77"; - Заголовок = "Тестовый заголовок"; - - Результат = OPI_Notion.СоздатьСтраницу(Токен, Родитель, Заголовок); -``` - - - - - - ```bash - oint notion СоздатьСтраницу --token "***" \ - --page "5dd94c34fab04bff986b7511c0779f77" \ - --title "Тестовый заголовок" - ``` - - - - ```batch - oint notion СоздатьСтраницу ^ - --token "***" ^ - --page "5dd94c34fab04bff986b7511c0779f77" ^ - --title "Тестовый заголовок" - ``` - - - - -```json title="Результат" -{ - "object": "page", - "id": "11982aa7-fc4e-8159-8536-cc666fcb1367", - "created_time": "2024-10-08T17:43:00Z", - "last_edited_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": null, - "icon": null, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "archived": false, - "in_trash": false, - "properties": { - "title": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "Тестовый заголовок", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовый заголовок", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/11982aa7fc4e81598536cc666fcb1367", - "public_url": null, - "request_id": "48015b1d-6c9b-4bae-8967-9f0dc3a67131" -} -``` diff --git a/docs/ru/md/Notion/Page-management/Create-page.mdx b/docs/ru/md/Notion/Page-management/Create-page.mdx new file mode 100644 index 0000000000..9df384f779 --- /dev/null +++ b/docs/ru/md/Notion/Page-management/Create-page.mdx @@ -0,0 +1,110 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать страницу + Создает дочернюю страницу над другой страницей-родителем + + + +`Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID Родителя | + | Заголовок | --title | Строка | Заголовок страницы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff986b7511c0779f77"; + Заголовок = "Тестовый заголовок"; + + Результат = OPI_Notion.СоздатьСтраницу(Токен, Родитель, Заголовок); +``` + + + + + + ```bash + oint notion СоздатьСтраницу --token "***" \ + --page "5dd94c34fab04bff986b7511c0779f77" \ + --title "Тестовый заголовок" + ``` + + + + ```batch + oint notion СоздатьСтраницу ^ + --token "***" ^ + --page "5dd94c34fab04bff986b7511c0779f77" ^ + --title "Тестовый заголовок" + ``` + + + + +```json title="Результат" +{ + "object": "page", + "id": "11982aa7-fc4e-8159-8536-cc666fcb1367", + "created_time": "2024-10-08T17:43:00Z", + "last_edited_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": null, + "icon": null, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "archived": false, + "in_trash": false, + "properties": { + "title": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "Тестовый заголовок", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовый заголовок", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/11982aa7fc4e81598536cc666fcb1367", + "public_url": null, + "request_id": "48015b1d-6c9b-4bae-8967-9f0dc3a67131" +} +``` diff --git a/docs/ru/md/Notion/Page-management/Edit-page-properties.md b/docs/ru/md/Notion/Page-management/Edit-page-properties.md deleted file mode 100644 index 8a5b08417f..0000000000 --- a/docs/ru/md/Notion/Page-management/Edit-page-properties.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Изменить свойства страницы - Изменяет свойства существующей страницы - - - -`Функция ИзменитьСвойстваСтраницы(Знач Токен, Знач Страница, Знач Данные = "", Знач Иконка = "", Знач Обложка = "", Знач Архивирована = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Страница | --page | Строка | ID изменяемой страницы | - | Данные | --data | Соответствие Из КлючИЗначение | Соответствие изменяемых параметров | - | Иконка | --icon | Строка | URL картинки иконки страницы | - | Обложка | --cover | Строка | URL картинки обложки страницы | - | Архивирована | --archive | Булево | Архивировать страницу или нет (булево) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Страница = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; - Иконка = "https://api.athenaeum.digital/test_data/picture.jpg"; - Обложка = "https://api.athenaeum.digital/test_data/picture2.jpg"; - Архивировать = Ложь; - - Свойства = Новый Соответствие; - Свойства.Вставить("Активен" , Ложь); - Свойства.Вставить("Почта" , "vector@mail.ru"); - - Результат = OPI_Notion.ИзменитьСвойстваСтраницы(Токен - , Страница - , Свойства - , Иконка - , Обложка - , Архивировать); -``` - - - - - - ```bash - oint notion ИзменитьСвойстваСтраницы --token "***" \ - --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" \ - --data "{'Активен':false,'Почта':'vector@mail.ru'}" \ - --icon "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --cover "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" \ - --archive false - ``` - - - - ```batch - oint notion ИзменитьСвойстваСтраницы ^ - --token "***" ^ - --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" ^ - --data "{'Активен':false,'Почта':'vector@mail.ru'}" ^ - --icon "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --cover "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" ^ - --archive false - ``` - - - - -```json title="Результат" -{ - "object": "page", - "id": "11982aa7-fc4e-8159-8536-cc666fcb1367", - "created_time": "2024-10-08T17:43:00Z", - "last_edited_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": { - "type": "external", - "external": { - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" - } - }, - "icon": { - "type": "external", - "external": { - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - } - }, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "archived": false, - "in_trash": false, - "properties": { - "title": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "Тестовый заголовок", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовый заголовок", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/11982aa7fc4e81598536cc666fcb1367", - "public_url": null, - "request_id": "4ca0c7ae-1dbc-41a1-9de3-91f2138862a4" -} -``` diff --git a/docs/ru/md/Notion/Page-management/Edit-page-properties.mdx b/docs/ru/md/Notion/Page-management/Edit-page-properties.mdx new file mode 100644 index 0000000000..b48ceec054 --- /dev/null +++ b/docs/ru/md/Notion/Page-management/Edit-page-properties.mdx @@ -0,0 +1,140 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Изменить свойства страницы + Изменяет свойства существующей страницы + + + +`Функция ИзменитьСвойстваСтраницы(Знач Токен, Знач Страница, Знач Данные = "", Знач Иконка = "", Знач Обложка = "", Знач Архивирована = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Страница | --page | Строка | ID изменяемой страницы | + | Данные | --data | Соответствие Из КлючИЗначение | Соответствие изменяемых параметров | + | Иконка | --icon | Строка | URL картинки иконки страницы | + | Обложка | --cover | Строка | URL картинки обложки страницы | + | Архивирована | --archive | Булево | Архивировать страницу или нет (булево) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Страница = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; + Иконка = "https://api.athenaeum.digital/test_data/picture.jpg"; + Обложка = "https://api.athenaeum.digital/test_data/picture2.jpg"; + Архивировать = Ложь; + + Свойства = Новый Соответствие; + Свойства.Вставить("Активен" , Ложь); + Свойства.Вставить("Почта" , "vector@mail.ru"); + + Результат = OPI_Notion.ИзменитьСвойстваСтраницы(Токен + , Страница + , Свойства + , Иконка + , Обложка + , Архивировать); +``` + + + + + + ```bash + oint notion ИзменитьСвойстваСтраницы --token "***" \ + --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" \ + --data "{'Активен':false,'Почта':'vector@mail.ru'}" \ + --icon "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --cover "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" \ + --archive false + ``` + + + + ```batch + oint notion ИзменитьСвойстваСтраницы ^ + --token "***" ^ + --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" ^ + --data "{'Активен':false,'Почта':'vector@mail.ru'}" ^ + --icon "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --cover "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" ^ + --archive false + ``` + + + + +```json title="Результат" +{ + "object": "page", + "id": "11982aa7-fc4e-8159-8536-cc666fcb1367", + "created_time": "2024-10-08T17:43:00Z", + "last_edited_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": { + "type": "external", + "external": { + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" + } + }, + "icon": { + "type": "external", + "external": { + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + } + }, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "archived": false, + "in_trash": false, + "properties": { + "title": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "Тестовый заголовок", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовый заголовок", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/11982aa7fc4e81598536cc666fcb1367", + "public_url": null, + "request_id": "4ca0c7ae-1dbc-41a1-9de3-91f2138862a4" +} +``` diff --git a/docs/ru/md/Notion/Page-management/Get-page.md b/docs/ru/md/Notion/Page-management/Get-page.md deleted file mode 100644 index 90c10d1651..0000000000 --- a/docs/ru/md/Notion/Page-management/Get-page.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить страницу - Получает информацию о странице по ID - - - -`Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Страница | --page | Строка | ID страницы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Страница = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; - - Результат = OPI_Notion.ПолучитьСтраницу(Токен, Страница); -``` - - - - - - ```bash - oint notion ПолучитьСтраницу --token "***" \ - --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" - ``` - - - - ```batch - oint notion ПолучитьСтраницу ^ - --token "***" ^ - --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" - ``` - - - - -```json title="Результат" -{ - "object": "page", - "id": "11982aa7-fc4e-8159-8536-cc666fcb1367", - "created_time": "2024-10-08T17:43:00Z", - "last_edited_time": "2024-10-08T17:43:00Z", - "created_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "last_edited_by": { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" - }, - "cover": null, - "icon": null, - "parent": { - "type": "page_id", - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" - }, - "archived": false, - "in_trash": false, - "properties": { - "title": { - "id": "title", - "type": "title", - "title": [ - { - "type": "text", - "text": { - "content": "Тестовый заголовок", - "link": null - }, - "annotations": { - "bold": false, - "italic": false, - "strikethrough": false, - "underline": false, - "code": false, - "color": "default" - }, - "plain_text": "Тестовый заголовок", - "href": null - } - ] - } - }, - "url": "https://www.notion.so/11982aa7fc4e81598536cc666fcb1367", - "public_url": null, - "request_id": "82600cae-f3d4-4575-a0ec-76c03d210446" -} -``` diff --git a/docs/ru/md/Notion/Page-management/Get-page.mdx b/docs/ru/md/Notion/Page-management/Get-page.mdx new file mode 100644 index 0000000000..7543e180cf --- /dev/null +++ b/docs/ru/md/Notion/Page-management/Get-page.mdx @@ -0,0 +1,106 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить страницу + Получает информацию о странице по ID + + + +`Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Страница | --page | Строка | ID страницы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Страница = "11e82aa7-fc4e-81be-a17f-c8f8ec9b863d"; + + Результат = OPI_Notion.ПолучитьСтраницу(Токен, Страница); +``` + + + + + + ```bash + oint notion ПолучитьСтраницу --token "***" \ + --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" + ``` + + + + ```batch + oint notion ПолучитьСтраницу ^ + --token "***" ^ + --page "12082aa7-fc4e-811e-a159-da2bd70e7c7d" + ``` + + + + +```json title="Результат" +{ + "object": "page", + "id": "11982aa7-fc4e-8159-8536-cc666fcb1367", + "created_time": "2024-10-08T17:43:00Z", + "last_edited_time": "2024-10-08T17:43:00Z", + "created_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "last_edited_by": { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0" + }, + "cover": null, + "icon": null, + "parent": { + "type": "page_id", + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77" + }, + "archived": false, + "in_trash": false, + "properties": { + "title": { + "id": "title", + "type": "title", + "title": [ + { + "type": "text", + "text": { + "content": "Тестовый заголовок", + "link": null + }, + "annotations": { + "bold": false, + "italic": false, + "strikethrough": false, + "underline": false, + "code": false, + "color": "default" + }, + "plain_text": "Тестовый заголовок", + "href": null + } + ] + } + }, + "url": "https://www.notion.so/11982aa7fc4e81598536cc666fcb1367", + "public_url": null, + "request_id": "82600cae-f3d4-4575-a0ec-76c03d210446" +} +``` diff --git a/docs/ru/md/Notion/Users/Get-user-data.md b/docs/ru/md/Notion/Users/Get-user-data.md deleted file mode 100644 index 7cdce50e9f..0000000000 --- a/docs/ru/md/Notion/Users/Get-user-data.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить данные пользователя - Получает данные пользователя по ID - - - -`Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДПользователя | --user | Строка | ID целевого пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Пользователь = "ed71865a-9891-46bc-86cd-a92aa499cfdb"; - - Результат = OPI_Notion.ПолучитьДанныеПользователя(Токен, Пользователь); -``` - - - - - - ```bash - oint notion ПолучитьДанныеПользователя --token "***" \ - --user "ed71865a-9891-46bc-86cd-a92aa499cfdb" - ``` - - - - ```batch - oint notion ПолучитьДанныеПользователя ^ - --token "***" ^ - --user "ed71865a-9891-46bc-86cd-a92aa499cfdb" - ``` - - - - -```json title="Результат" -{ - "object": "user", - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "name": "Techno Pizza", - "avatar_url": null, - "type": "person", - "person": { - "email": "iscript13@gmail.com" - }, - "request_id": "a5fcc2a8-295e-4b00-bcc2-00a38a2bd63e" -} -``` diff --git a/docs/ru/md/Notion/Users/Get-user-data.mdx b/docs/ru/md/Notion/Users/Get-user-data.mdx new file mode 100644 index 0000000000..81b2512672 --- /dev/null +++ b/docs/ru/md/Notion/Users/Get-user-data.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить данные пользователя + Получает данные пользователя по ID + + + +`Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДПользователя | --user | Строка | ID целевого пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Пользователь = "ed71865a-9891-46bc-86cd-a92aa499cfdb"; + + Результат = OPI_Notion.ПолучитьДанныеПользователя(Токен, Пользователь); +``` + + + + + + ```bash + oint notion ПолучитьДанныеПользователя --token "***" \ + --user "ed71865a-9891-46bc-86cd-a92aa499cfdb" + ``` + + + + ```batch + oint notion ПолучитьДанныеПользователя ^ + --token "***" ^ + --user "ed71865a-9891-46bc-86cd-a92aa499cfdb" + ``` + + + + +```json title="Результат" +{ + "object": "user", + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "name": "Techno Pizza", + "avatar_url": null, + "type": "person", + "person": { + "email": "iscript13@gmail.com" + }, + "request_id": "a5fcc2a8-295e-4b00-bcc2-00a38a2bd63e" +} +``` diff --git a/docs/ru/md/Notion/Users/User-list.md b/docs/ru/md/Notion/Users/User-list.md deleted file mode 100644 index 493073f6f7..0000000000 --- a/docs/ru/md/Notion/Users/User-list.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Список пользователей - Возвращает список пользователей рабочего пространства - - - -`Функция СписокПользователей(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -
- - - - -```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - - Результат = OPI_Notion.СписокПользователей(Токен); -``` - - - - - - ```bash - oint notion СписокПользователей --token "***" - ``` - - - - ```batch - oint notion СписокПользователей ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "object": "list", - "results": [ - { - "object": "user", - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "name": "Techno Pizza", - "avatar_url": null, - "type": "person", - "person": { - "email": "iscript13@gmail.com" - } - }, - { - "object": "user", - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "name": "1C Integration", - "avatar_url": null, - "type": "bot", - "bot": { - "owner": { - "type": "workspace", - "workspace": true - }, - "workspace_name": "Bayselonarrends Notion" - } - } - ], - "next_cursor": null, - "has_more": false, - "type": "user", - "user": {}, - "request_id": "1918c0b8-859f-4adc-ab9c-15df111d1b26" -} -``` diff --git a/docs/ru/md/Notion/Users/User-list.mdx b/docs/ru/md/Notion/Users/User-list.mdx new file mode 100644 index 0000000000..93bbddfc2d --- /dev/null +++ b/docs/ru/md/Notion/Users/User-list.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Список пользователей + Возвращает список пользователей рабочего пространства + + + +`Функция СписокПользователей(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +
+ + + + +```bsl title="Пример кода" + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + + Результат = OPI_Notion.СписокПользователей(Токен); +``` + + + + + + ```bash + oint notion СписокПользователей --token "***" + ``` + + + + ```batch + oint notion СписокПользователей ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "object": "list", + "results": [ + { + "object": "user", + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "name": "Techno Pizza", + "avatar_url": null, + "type": "person", + "person": { + "email": "iscript13@gmail.com" + } + }, + { + "object": "user", + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "name": "1C Integration", + "avatar_url": null, + "type": "bot", + "bot": { + "owner": { + "type": "workspace", + "workspace": true + }, + "workspace_name": "Bayselonarrends Notion" + } + } + ], + "next_cursor": null, + "has_more": false, + "type": "user", + "user": {}, + "request_id": "1918c0b8-859f-4adc-ab9c-15df111d1b26" +} +``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-attribute-values.md b/docs/ru/md/Ozon/Attributes-and-features/Get-attribute-values.md deleted file mode 100644 index 6d5f0d06e6..0000000000 --- a/docs/ru/md/Ozon/Attributes-and-features/Get-attribute-values.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить значения характеристики - Получает список доступных значений характеристики - - - -`Функция ПолучитьЗначенияХарактеристики(Знач IDКлиента, Знач КлючAPI, Знач IDКатегории, Знач IDТипа, Знач IDХарактеристики, Знач IDСправочника = 1, Знач Язык = "DEFAULT") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDКатегории | --categoryid | Строка, Число | Идентификатор категории | - | IDТипа | --typeid | Строка, Число | Идентификатор типа товара | - | IDХарактеристики | --attributeid | Строка, Число | ID характеристики для получения значений | - | IDСправочника | --start | Строка, Число | ID первого справочника в ответе | - | Язык | --lang | Строка | Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Узнать, есть ли вложенный справочник, можно через метод ПолучитьХарактеристикиКатегории() - - Метод в документации API: [post /v1/description-category/attribute/values](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributeValues) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDКатегории = 17054869; - IDТипа = 97311; - IDХарактеристики = 85; - - Результат = OPI_Ozon.ПолучитьЗначенияХарактеристики(IDКлиента, КлючAPI, IDКатегории, IDТипа, IDХарактеристики); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "id": 5056737, - "value": "Essence", - "info": "Красота и здоровье", - "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6088253599.jpg" - }, - { - "id": 5057962, - "value": "Hot", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6011312389.jpg" - }, - { - "id": 5058518, - "value": "CS", - "info": "", - "picture": "" - }, - { - "id": 5059837, - "value": "Каскад", - "info": "Зоотовары", - "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6027361156.jpg" - }, - { - "id": 5062537, - "value": "Enigma", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-5/6427347617.jpg" - }, - { - "id": 5062790, - "value": "Kitfort", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-6/6737348550.jpg" - }, - { - "id": 5064843, - "value": "Parlux", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6011101280.jpg" - }, - { - "id": 5065236, - "value": "Сателлит", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6010470136.jpg" - }, - { - "id": 5066816, - "value": "Carioca", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-8/6063013796.jpg" - }, - { - "id": 5068632, - "value": "Bawi", - "info": "", - "picture": "" - }, - { - "id": 5069237, - "value": "Kodak", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-m/6011062066.jpg" - }, - { - "id": 5069442, - "value": "Mattel", - "info": "Детские игрушки", - "picture": "https://cdn1.ozone.ru/multimedia/1013076413.jpg" - }, - { - "id": 5071003, - "value": "Ivo", - "info": "", - "picture": "" - }, - { - "id": 5071289, - "value": "HTC", - "info": "", - "picture": "https://cdn1.ozone.ru/multimedia/1011058578.jpg" - }, - { - "id": 5073069, - "value": "Ghost", - "info": "", - "picture": "" - }, - { - "id": 5073089, - "value": "Oleg Cassini", - "info": "", - "picture": "" - }, - { - "id": 5073356, - "value": "Ritzenhoff & Breker", - "info": "", - "picture": "" - }, - { - "id": 5073389, - "value": "William Levene", - "info": "", - "picture": "" - }, - { - "id": 5074417, - "value": "KEF", - "info": "", - "picture": "" - }, - { - "id": 5074684, - "value": "Cutipol", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-o/6011755428.jpg" - }, - { - "id": 5075889, - "value": "Jacob Zeidler & Co", - "info": "", - "picture": "" - }, - { - "id": 5076255, - "value": "The Original Book Works Limited", - "info": "", - "picture": "" - }, - { - "id": 5076787, - "value": "Ocean Extreme", - "info": "", - "picture": "" - }, - { - "id": 5077287, - "value": "Народное искусство", - "info": "", - "picture": "" - }, - { - "id": 5077379, - "value": "Zyliss", - "info": "", -... -``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-attribute-values.mdx b/docs/ru/md/Ozon/Attributes-and-features/Get-attribute-values.mdx new file mode 100644 index 0000000000..3489c435a0 --- /dev/null +++ b/docs/ru/md/Ozon/Attributes-and-features/Get-attribute-values.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить значения характеристики + Получает список доступных значений характеристики + + + +`Функция ПолучитьЗначенияХарактеристики(Знач IDКлиента, Знач КлючAPI, Знач IDКатегории, Знач IDТипа, Знач IDХарактеристики, Знач IDСправочника = 1, Знач Язык = "DEFAULT") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDКатегории | --categoryid | Строка, Число | Идентификатор категории | + | IDТипа | --typeid | Строка, Число | Идентификатор типа товара | + | IDХарактеристики | --attributeid | Строка, Число | ID характеристики для получения значений | + | IDСправочника | --start | Строка, Число | ID первого справочника в ответе | + | Язык | --lang | Строка | Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Узнать, есть ли вложенный справочник, можно через метод ПолучитьХарактеристикиКатегории() + + Метод в документации API: [post /v1/description-category/attribute/values](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributeValues) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDКатегории = 17054869; + IDТипа = 97311; + IDХарактеристики = 85; + + Результат = OPI_Ozon.ПолучитьЗначенияХарактеристики(IDКлиента, КлючAPI, IDКатегории, IDТипа, IDХарактеристики); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "id": 5056737, + "value": "Essence", + "info": "Красота и здоровье", + "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6088253599.jpg" + }, + { + "id": 5057962, + "value": "Hot", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6011312389.jpg" + }, + { + "id": 5058518, + "value": "CS", + "info": "", + "picture": "" + }, + { + "id": 5059837, + "value": "Каскад", + "info": "Зоотовары", + "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6027361156.jpg" + }, + { + "id": 5062537, + "value": "Enigma", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-5/6427347617.jpg" + }, + { + "id": 5062790, + "value": "Kitfort", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-6/6737348550.jpg" + }, + { + "id": 5064843, + "value": "Parlux", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6011101280.jpg" + }, + { + "id": 5065236, + "value": "Сателлит", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6010470136.jpg" + }, + { + "id": 5066816, + "value": "Carioca", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-8/6063013796.jpg" + }, + { + "id": 5068632, + "value": "Bawi", + "info": "", + "picture": "" + }, + { + "id": 5069237, + "value": "Kodak", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-m/6011062066.jpg" + }, + { + "id": 5069442, + "value": "Mattel", + "info": "Детские игрушки", + "picture": "https://cdn1.ozone.ru/multimedia/1013076413.jpg" + }, + { + "id": 5071003, + "value": "Ivo", + "info": "", + "picture": "" + }, + { + "id": 5071289, + "value": "HTC", + "info": "", + "picture": "https://cdn1.ozone.ru/multimedia/1011058578.jpg" + }, + { + "id": 5073069, + "value": "Ghost", + "info": "", + "picture": "" + }, + { + "id": 5073089, + "value": "Oleg Cassini", + "info": "", + "picture": "" + }, + { + "id": 5073356, + "value": "Ritzenhoff & Breker", + "info": "", + "picture": "" + }, + { + "id": 5073389, + "value": "William Levene", + "info": "", + "picture": "" + }, + { + "id": 5074417, + "value": "KEF", + "info": "", + "picture": "" + }, + { + "id": 5074684, + "value": "Cutipol", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-o/6011755428.jpg" + }, + { + "id": 5075889, + "value": "Jacob Zeidler & Co", + "info": "", + "picture": "" + }, + { + "id": 5076255, + "value": "The Original Book Works Limited", + "info": "", + "picture": "" + }, + { + "id": 5076787, + "value": "Ocean Extreme", + "info": "", + "picture": "" + }, + { + "id": 5077287, + "value": "Народное искусство", + "info": "", + "picture": "" + }, + { + "id": 5077379, + "value": "Zyliss", + "info": "", +... +``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.md b/docs/ru/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.md deleted file mode 100644 index b1d60298f2..0000000000 --- a/docs/ru/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить дерево категорий и типов товаров - Возвращает категории и типы для товаров в виде дерева - - - -`Функция ПолучитьДеревоКатегорийИТиповТоваров(Знач IDКлиента, Знач КлючAPI, Знач Язык = "DEFAULT") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Язык | --lang | Строка | Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Создание товаров доступно только в категориях последнего уровня, сравните именно их с категориями на своей площадке. Категории не создаются по запросу пользователя - - Внимательно выбирайте категорию для товара: для разных категорий применяется разный размер комиссии. - - Метод в документации API: [post /v1/description-category/tree](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetTree) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - Результат = OPI_Ozon.ПолучитьДеревоКатегорийИТиповТоваров(IDКлиента, КлючAPI, "EN"); - - Результат = OPI_Ozon.ПолучитьДеревоКатегорийИТиповТоваров(IDКлиента, КлючAPI); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "description_category_id": 200001506, - "category_name": "Товары для курения и аксессуары", - "disabled": false, - "children": [ - { - "description_category_id": 200001034, - "category_name": "Товары для курения", - "disabled": false, - "children": [ - { - "type_name": "Аксессуар для трубки", - "type_id": 971425815, - "disabled": false, - "children": [] - }, - { - "type_name": "Аксессуар для сигар", - "type_id": 971425003, - "disabled": false, - "children": [] - }, - { - "type_name": "Аксессуар для самокрутки", - "type_id": 971423253, - "disabled": false, - "children": [] - }, - { - "type_name": "Аксессуар для хранения табака", - "type_id": 971405141, - "disabled": false, - "children": [] - }, - { - "type_name": "Увлажнитель для хьюмидора", - "type_id": 971000539, - "disabled": false, - "children": [] - }, - { - "type_name": "Подарочный набор для курения", - "type_id": 970801168, - "disabled": true, - "children": [] - }, - { - "type_name": "Пепельница", - "type_id": 91975, - "disabled": false, - "children": [] - } - ] - }, - { - "description_category_id": 200001032, - "category_name": "Аксессуары и комплектующие для кальянов", - "disabled": false, - "children": [ - { - "type_name": "Подсветка для кальяна", - "type_id": 970684772, - "disabled": false, - "children": [] - }, - { - "type_name": "Столик для кальяна", - "type_id": 971079775, - "disabled": false, - "children": [] - }, - { - "type_name": "Комплектующие для кальяна", - "type_id": 971412757, - "disabled": false, - "children": [] - }, - { - "type_name": "Аксессуары для кальяна", - "type_id": 971412759, - "disabled": false, - "children": [] - }, - { - "type_name": "Уголь для кальяна", - "type_id": 970637384, - "disabled": false, - "children": [] - }, - { - "type_name": "Подставка для кальяна", - "type_id": 970807581, - "disabled": false, - "children": [] - }, - { - "type_name": "Корзина для переноски и розжига", - "type_id": 970637390, - "disabled": false, - "children": [] - }, - { - "type_name": "Розжиг для кальяна", - "type_id": 971437043, - "disabled": false, - "children": [] - }, - { - "type_name": "Плитка электрическая", - "type_id": 970637389, - "disabled": false, - "children": [] - } - ] - }, - { - "description_category_id": 200000977, - "category_name": "Курительные принадлежности", - "disabled": true, - "children": [ - { - "type_name": "Проволока для вейпа", - "type_id": 971412762, - "disabled": true, - "children": [] - }, - { - "type_name": "Паста для кальяна", - "type_id": 970737147, - "disabled": true, - "children": [] - }, - { - "type_name": "Комплектующее для бонга", - "type_id": 970801167, - "disabled": true, - "children": [] - }, - { - "type_name": "Дрипка-бак (RDTA)", - "type_id": 96743, - "disabled": true, - "children": [] - }, - { - "type_name": "Дрипка (RDA)", - "type_id": 96742, - "disabled": true, -... -``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.mdx b/docs/ru/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.mdx new file mode 100644 index 0000000000..8d82e0657a --- /dev/null +++ b/docs/ru/md/Ozon/Attributes-and-features/Get-categories-and-product-types-tree.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить дерево категорий и типов товаров + Возвращает категории и типы для товаров в виде дерева + + + +`Функция ПолучитьДеревоКатегорийИТиповТоваров(Знач IDКлиента, Знач КлючAPI, Знач Язык = "DEFAULT") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Язык | --lang | Строка | Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Создание товаров доступно только в категориях последнего уровня, сравните именно их с категориями на своей площадке. Категории не создаются по запросу пользователя + + Внимательно выбирайте категорию для товара: для разных категорий применяется разный размер комиссии. + + Метод в документации API: [post /v1/description-category/tree](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetTree) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + Результат = OPI_Ozon.ПолучитьДеревоКатегорийИТиповТоваров(IDКлиента, КлючAPI, "EN"); + + Результат = OPI_Ozon.ПолучитьДеревоКатегорийИТиповТоваров(IDКлиента, КлючAPI); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "description_category_id": 200001506, + "category_name": "Товары для курения и аксессуары", + "disabled": false, + "children": [ + { + "description_category_id": 200001034, + "category_name": "Товары для курения", + "disabled": false, + "children": [ + { + "type_name": "Аксессуар для трубки", + "type_id": 971425815, + "disabled": false, + "children": [] + }, + { + "type_name": "Аксессуар для сигар", + "type_id": 971425003, + "disabled": false, + "children": [] + }, + { + "type_name": "Аксессуар для самокрутки", + "type_id": 971423253, + "disabled": false, + "children": [] + }, + { + "type_name": "Аксессуар для хранения табака", + "type_id": 971405141, + "disabled": false, + "children": [] + }, + { + "type_name": "Увлажнитель для хьюмидора", + "type_id": 971000539, + "disabled": false, + "children": [] + }, + { + "type_name": "Подарочный набор для курения", + "type_id": 970801168, + "disabled": true, + "children": [] + }, + { + "type_name": "Пепельница", + "type_id": 91975, + "disabled": false, + "children": [] + } + ] + }, + { + "description_category_id": 200001032, + "category_name": "Аксессуары и комплектующие для кальянов", + "disabled": false, + "children": [ + { + "type_name": "Подсветка для кальяна", + "type_id": 970684772, + "disabled": false, + "children": [] + }, + { + "type_name": "Столик для кальяна", + "type_id": 971079775, + "disabled": false, + "children": [] + }, + { + "type_name": "Комплектующие для кальяна", + "type_id": 971412757, + "disabled": false, + "children": [] + }, + { + "type_name": "Аксессуары для кальяна", + "type_id": 971412759, + "disabled": false, + "children": [] + }, + { + "type_name": "Уголь для кальяна", + "type_id": 970637384, + "disabled": false, + "children": [] + }, + { + "type_name": "Подставка для кальяна", + "type_id": 970807581, + "disabled": false, + "children": [] + }, + { + "type_name": "Корзина для переноски и розжига", + "type_id": 970637390, + "disabled": false, + "children": [] + }, + { + "type_name": "Розжиг для кальяна", + "type_id": 971437043, + "disabled": false, + "children": [] + }, + { + "type_name": "Плитка электрическая", + "type_id": 970637389, + "disabled": false, + "children": [] + } + ] + }, + { + "description_category_id": 200000977, + "category_name": "Курительные принадлежности", + "disabled": true, + "children": [ + { + "type_name": "Проволока для вейпа", + "type_id": 971412762, + "disabled": true, + "children": [] + }, + { + "type_name": "Паста для кальяна", + "type_id": 970737147, + "disabled": true, + "children": [] + }, + { + "type_name": "Комплектующее для бонга", + "type_id": 970801167, + "disabled": true, + "children": [] + }, + { + "type_name": "Дрипка-бак (RDTA)", + "type_id": 96743, + "disabled": true, + "children": [] + }, + { + "type_name": "Дрипка (RDA)", + "type_id": 96742, + "disabled": true, +... +``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-category-attributes.md b/docs/ru/md/Ozon/Attributes-and-features/Get-category-attributes.md deleted file mode 100644 index 83b79a16b3..0000000000 --- a/docs/ru/md/Ozon/Attributes-and-features/Get-category-attributes.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить характеристики категории - Получает характеристики для указанной категории и типа товара - - - -`Функция ПолучитьХарактеристикиКатегории(Знач IDКлиента, Знач КлючAPI, Знач IDКатегории, Знач IDТипа, Знач Язык = "DEFAULT") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDКатегории | --categoryid | Строка, Число | Идентификатор категории | - | IDТипа | --typeid | Строка, Число | Идентификатор типа товара | - | Язык | --lang | Строка | Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Если у dictionary_id значение 0, у атрибута нет вложенных справочников. Если значение другое, то справочники есть. Получить их можно методом ПолучитьЗначенияХарактеристик() - - Метод в документации API: [post /v1/description-category/attribute](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributes) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDКатегории = 17029016; - IDТипа = 970778135; - - Результат = OPI_Ozon.ПолучитьХарактеристикиКатегории(IDКлиента, КлючAPI, IDКатегории, IDТипа); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "id": 85, - "attribute_complex_id": 0, - "name": "Бренд", - "description": "Укажите наименование бренда, под которым произведен товар. Если товар не имеет бренда, используйте значение \"Нет бренда\".", - "type": "String", - "is_collection": false, - "is_required": true, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 28732849, - "category_dependent": true - }, - { - "id": 4080, - "attribute_complex_id": 0, - "name": "3D-изображение", - "description": "Укажите ссылки на фото, через запятую, которые показывает товар под разными равными углами. В серии фото важно соблюдать последовательность, чтобы ракурс каждого следующего фото отличался от предыдущего на равный угол. Из этих фотографий на сайте автоматически сформируется 3D-модель товара. Минимальное рекомендованное количество - 15 штук.", - "type": "URL", - "is_collection": true, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4180, - "attribute_complex_id": 0, - "name": "Название", - "description": "Название пишется по принципу:\nТип + Бренд + Модель (серия + пояснение) + Артикул производителя + , (запятая) + Атрибут\nНазвание не пишется большими буквами (не используем caps lock).\nПеред атрибутом ставится запятая. Если атрибутов несколько, они так же разделяются запятыми.\nЕсли какой-то составной части названия нет - пропускаем её.\nАтрибутом может быть: цвет, вес, объём, количество штук в упаковке и т.д.\nЦвет пишется с маленькой буквы, в мужском роде, единственном числе.\nСлово цвет в названии не пишем.\nТочка в конце не ставится.\nНикаких знаков препинания, кроме запятой, не используем.\nКавычки используем только для названий на русском языке.\nПримеры корректных названий:\nСмартфон Apple iPhone XS MT572RU/A, space black \nКеды Dr. Martens Киноклассика, бело-черные, размер 43\nСтиральный порошок Ariel Магия белого с мерной ложкой, 15 кг\nСоус Heinz Xtreme Tabasco суперострый, 10 мл\nИгрушка для животных Четыре лапы \"Бегающая мышка\" БММ, белый", - "type": "String", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4191, - "attribute_complex_id": 0, - "name": "Аннотация", - "description": "Описание товара, маркетинговый текст. Необходимо заполнять на русском языке.", - "type": "multiline", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4385, - "attribute_complex_id": 0, - "name": "Гарантийный срок", - "description": "Укажите гарантийный срок. Гарантийный срок – это период, в течение которого изготовитель гарантирует качество товара и обязуется принять данный товар у потребителя для проведения проверки качества (экспертизы) и выполнения предусмотренных законом требований.", - "type": "String", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, - "category_dependent": false - }, - { - "id": 4389, - "attribute_complex_id": 0, - "name": "Страна-изготовитель", - "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", - "type": "String", - "is_collection": true, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1935, - "category_dependent": false - }, - { - "id": 6548, - "attribute_complex_id": 0, - "name": "Материал", - "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", - "type": "String", - "is_collection": true, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1503, - "category_dependent": true - }, - { - "id": 8229, - "attribute_complex_id": 0, - "name": "Тип", - "description": "Выберите наиболее подходящий тип товара. По типам товары распределяются по категориям на сайте Ozon. Если тип указан неправильно, товар попадет в неверную категорию. Чтобы правильно указать тип, найдите на сайте Ozon товары, похожие на ваш, и посмотрите, какой тип у них указан.", - "type": "String", - "is_collection": false, - "is_required": true, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1960, - "category_dependent": true - }, - { - "id": 8245, - "attribute_complex_id": 0, - "name": "Число строк", - "description": "Выберите из списка. Можно указать только одно значение.", - "type": "String", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 1324, - "category_dependent": true - }, - { - "id": 8249, - "attribute_complex_id": 0, - "name": "Число знаков шрифта для выделения", - "description": "Можно указать только целое число.", - "type": "Integer", - "is_collection": false, - "is_required": false, - "is_aspect": false, - "max_value_count": 0, - "group_name": "", - "group_id": 0, - "dictionary_id": 0, -... -``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-category-attributes.mdx b/docs/ru/md/Ozon/Attributes-and-features/Get-category-attributes.mdx new file mode 100644 index 0000000000..46c61429e4 --- /dev/null +++ b/docs/ru/md/Ozon/Attributes-and-features/Get-category-attributes.mdx @@ -0,0 +1,200 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить характеристики категории + Получает характеристики для указанной категории и типа товара + + + +`Функция ПолучитьХарактеристикиКатегории(Знач IDКлиента, Знач КлючAPI, Знач IDКатегории, Знач IDТипа, Знач Язык = "DEFAULT") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDКатегории | --categoryid | Строка, Число | Идентификатор категории | + | IDТипа | --typeid | Строка, Число | Идентификатор типа товара | + | Язык | --lang | Строка | Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Если у dictionary_id значение 0, у атрибута нет вложенных справочников. Если значение другое, то справочники есть. Получить их можно методом ПолучитьЗначенияХарактеристик() + + Метод в документации API: [post /v1/description-category/attribute](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_GetAttributes) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDКатегории = 17029016; + IDТипа = 970778135; + + Результат = OPI_Ozon.ПолучитьХарактеристикиКатегории(IDКлиента, КлючAPI, IDКатегории, IDТипа); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "id": 85, + "attribute_complex_id": 0, + "name": "Бренд", + "description": "Укажите наименование бренда, под которым произведен товар. Если товар не имеет бренда, используйте значение \"Нет бренда\".", + "type": "String", + "is_collection": false, + "is_required": true, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 28732849, + "category_dependent": true + }, + { + "id": 4080, + "attribute_complex_id": 0, + "name": "3D-изображение", + "description": "Укажите ссылки на фото, через запятую, которые показывает товар под разными равными углами. В серии фото важно соблюдать последовательность, чтобы ракурс каждого следующего фото отличался от предыдущего на равный угол. Из этих фотографий на сайте автоматически сформируется 3D-модель товара. Минимальное рекомендованное количество - 15 штук.", + "type": "URL", + "is_collection": true, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4180, + "attribute_complex_id": 0, + "name": "Название", + "description": "Название пишется по принципу:\nТип + Бренд + Модель (серия + пояснение) + Артикул производителя + , (запятая) + Атрибут\nНазвание не пишется большими буквами (не используем caps lock).\nПеред атрибутом ставится запятая. Если атрибутов несколько, они так же разделяются запятыми.\nЕсли какой-то составной части названия нет - пропускаем её.\nАтрибутом может быть: цвет, вес, объём, количество штук в упаковке и т.д.\nЦвет пишется с маленькой буквы, в мужском роде, единственном числе.\nСлово цвет в названии не пишем.\nТочка в конце не ставится.\nНикаких знаков препинания, кроме запятой, не используем.\nКавычки используем только для названий на русском языке.\nПримеры корректных названий:\nСмартфон Apple iPhone XS MT572RU/A, space black \nКеды Dr. Martens Киноклассика, бело-черные, размер 43\nСтиральный порошок Ariel Магия белого с мерной ложкой, 15 кг\nСоус Heinz Xtreme Tabasco суперострый, 10 мл\nИгрушка для животных Четыре лапы \"Бегающая мышка\" БММ, белый", + "type": "String", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4191, + "attribute_complex_id": 0, + "name": "Аннотация", + "description": "Описание товара, маркетинговый текст. Необходимо заполнять на русском языке.", + "type": "multiline", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4385, + "attribute_complex_id": 0, + "name": "Гарантийный срок", + "description": "Укажите гарантийный срок. Гарантийный срок – это период, в течение которого изготовитель гарантирует качество товара и обязуется принять данный товар у потребителя для проведения проверки качества (экспертизы) и выполнения предусмотренных законом требований.", + "type": "String", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, + "category_dependent": false + }, + { + "id": 4389, + "attribute_complex_id": 0, + "name": "Страна-изготовитель", + "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", + "type": "String", + "is_collection": true, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1935, + "category_dependent": false + }, + { + "id": 6548, + "attribute_complex_id": 0, + "name": "Материал", + "description": "Выберите из списка или укажите вручную. Можно добавить несколько значений через точку с запятой. Если точка с запятой есть в значении атрибута, поместите знак в кавычки \";\".", + "type": "String", + "is_collection": true, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1503, + "category_dependent": true + }, + { + "id": 8229, + "attribute_complex_id": 0, + "name": "Тип", + "description": "Выберите наиболее подходящий тип товара. По типам товары распределяются по категориям на сайте Ozon. Если тип указан неправильно, товар попадет в неверную категорию. Чтобы правильно указать тип, найдите на сайте Ozon товары, похожие на ваш, и посмотрите, какой тип у них указан.", + "type": "String", + "is_collection": false, + "is_required": true, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1960, + "category_dependent": true + }, + { + "id": 8245, + "attribute_complex_id": 0, + "name": "Число строк", + "description": "Выберите из списка. Можно указать только одно значение.", + "type": "String", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 1324, + "category_dependent": true + }, + { + "id": 8249, + "attribute_complex_id": 0, + "name": "Число знаков шрифта для выделения", + "description": "Можно указать только целое число.", + "type": "Integer", + "is_collection": false, + "is_required": false, + "is_aspect": false, + "max_value_count": 0, + "group_name": "", + "group_id": 0, + "dictionary_id": 0, +... +``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-products-requests-limits.md b/docs/ru/md/Ozon/Attributes-and-features/Get-products-requests-limits.md deleted file mode 100644 index bd1a3d2839..0000000000 --- a/docs/ru/md/Ozon/Attributes-and-features/Get-products-requests-limits.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить лимиты работы с товарами - Получает данные о лимитах на ассортимент, создание и обновление товаров - - - -`Функция ПолучитьЛимитыРаботыСТоварами(Знач IDКлиента, Знач КлючAPI) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v4/product/info/limit](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetUploadQuota) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - Результат = OPI_Ozon.ПолучитьЛимитыРаботыСТоварами(IDКлиента, КлючAPI); -``` - - - - -```json title="Результат" -{ - "daily_create": { - "usage": 0, - "limit": 1500, - "reset_at": "2024-10-09T00:00:00Z" - }, - "daily_update": { - "usage": 0, - "limit": 5000, - "reset_at": "2024-10-09T00:00:00Z" - }, - "total": { - "usage": 4, - "limit": 20000 - } -} -``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Get-products-requests-limits.mdx b/docs/ru/md/Ozon/Attributes-and-features/Get-products-requests-limits.mdx new file mode 100644 index 0000000000..44bde7d9e0 --- /dev/null +++ b/docs/ru/md/Ozon/Attributes-and-features/Get-products-requests-limits.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить лимиты работы с товарами + Получает данные о лимитах на ассортимент, создание и обновление товаров + + + +`Функция ПолучитьЛимитыРаботыСТоварами(Знач IDКлиента, Знач КлючAPI) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v4/product/info/limit](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetUploadQuota) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + Результат = OPI_Ozon.ПолучитьЛимитыРаботыСТоварами(IDКлиента, КлючAPI); +``` + + + + +```json title="Результат" +{ + "daily_create": { + "usage": 0, + "limit": 1500, + "reset_at": "2024-10-09T00:00:00Z" + }, + "daily_update": { + "usage": 0, + "limit": 5000, + "reset_at": "2024-10-09T00:00:00Z" + }, + "total": { + "usage": 4, + "limit": 20000 + } +} +``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Search-attribute-value.md b/docs/ru/md/Ozon/Attributes-and-features/Search-attribute-value.md deleted file mode 100644 index 2de065d34a..0000000000 --- a/docs/ru/md/Ozon/Attributes-and-features/Search-attribute-value.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Найти значения характеристики - Получает справочные значения характеристики по заданному значению в запросе - - - -`Функция НайтиЗначенияХарактеристики(Знач IDКлиента, Знач КлючAPI, Знач IDКатегории, Знач IDТипа, Знач IDХарактеристики, Знач Значение) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDКатегории | --categoryid | Строка, Число | Идентификатор категории | - | IDТипа | --typeid | Строка, Число | Идентификатор типа товара | - | IDХарактеристики | --attributeid | Строка, Число | ID характеристики для получения значений | - | Значение | --value | Строка | Значение для поиска | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Узнать, есть ли вложенный справочник, можно через метод ПолучитьХарактеристикиКатегории() - - Метод в документации API: [post /v1/description-category/attribute/values/search](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_SearchAttributeValues) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDКатегории = 17054869; - IDТипа = 97311; - IDХарактеристики = 85; - Значение = "Sunshine"; - - Результат = OPI_Ozon.НайтиЗначенияХарактеристики(IDКлиента - , КлючAPI - , IDКатегории - , IDТипа - , IDХарактеристики - , Значение); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "id": 5055881, - "value": "Sunshine", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-i/6010930878.jpg" - }, - { - "id": 971026862, - "value": "SUNSHINE", - "info": "Спорт и отдых", - "picture": "" - }, - { - "id": 971719299, - "value": "Sunshine", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6601244203.jpg" - }, - { - "id": 971818888, - "value": "Sunshine", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6644299477.jpg" - }, - { - "id": 972176200, - "value": "sunshine", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/e6dcf5aa-eb30-442d-afa0-5812652d2816.png" - }, - { - "id": 972202223, - "value": "SUNSHINE", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/68384d8e-4b49-4f99-a045-3403c1f10f0f.jpg" - }, - { - "id": 971227292, - "value": "Sunshine Baby", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-r/6299308959.jpg" - }, - { - "id": 972029069, - "value": "Sunshine Beams", - "info": "", - "picture": "" - }, - { - "id": 971168926, - "value": "Sunshine-Craft", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-u/6267516354.jpg" - }, - { - "id": 972173064, - "value": "Sunshine Day", - "info": "", - "picture": "" - }, - { - "id": 970974258, - "value": "sunshinefilm", - "info": "Защитная пленка на экран смартфона, гидрогелевая", - "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6048813188.jpg" - }, - { - "id": 972066951, - "value": "SunShineFox", - "info": "", - "picture": "" - }, - { - "id": 972172514, - "value": "SUNSHINEFXY", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/d48c1614-b9c4-4785-b9ef-3142f5cfb12c.png" - }, - { - "id": 971110891, - "value": "Sunshine Habibi", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6158730376.jpg" - }, - { - "id": 971896068, - "value": "Sunshine House", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-b/6704404415.jpg" - }, - { - "id": 971967921, - "value": "SunShine in me", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6775950013.jpg" - }, - { - "id": 970712762, - "value": "Sunshine Innovations", - "info": "", - "picture": "" - }, - { - "id": 5115939, - "value": "Sunshine Kids", - "info": "", - "picture": "" - }, - { - "id": 971303326, - "value": "Sunshine Lady", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6371652253.jpg" - }, - { - "id": 972131760, - "value": "Sunshineland", - "info": "", - "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/63bfd44b-6338-4fa6-8843-39b1c7827099.jpg" - }, - { - "id": 5142226, - "value": "Sunshine Optics", - "info": "", - "picture": "" - }, - { - "id": 972026686, - "value": "SUNSHINE PANDI", - "info": "", - "picture": "https://cdn1.ozone.ru/s3/multimedia-3/6842409075.jpg" - }, - { - "id": 970954160, - "value": "SUNSHINE PEARL", - "info": "Соль для ванны", - "picture": "https://cdn1.ozone.ru/s3/multimedia-j/6041114827.jpg" - }, - { - "id": 970697481, - "value": "SunShines", - "info": "", - "picture": "" - }, - { - "id": 972077059, - "value": "Sunshine shop", - "info": "", -... -``` diff --git a/docs/ru/md/Ozon/Attributes-and-features/Search-attribute-value.mdx b/docs/ru/md/Ozon/Attributes-and-features/Search-attribute-value.mdx new file mode 100644 index 0000000000..8aeaca82a5 --- /dev/null +++ b/docs/ru/md/Ozon/Attributes-and-features/Search-attribute-value.mdx @@ -0,0 +1,208 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Найти значения характеристики + Получает справочные значения характеристики по заданному значению в запросе + + + +`Функция НайтиЗначенияХарактеристики(Знач IDКлиента, Знач КлючAPI, Знач IDКатегории, Знач IDТипа, Знач IDХарактеристики, Знач Значение) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDКатегории | --categoryid | Строка, Число | Идентификатор категории | + | IDТипа | --typeid | Строка, Число | Идентификатор типа товара | + | IDХарактеристики | --attributeid | Строка, Число | ID характеристики для получения значений | + | Значение | --value | Строка | Значение для поиска | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Узнать, есть ли вложенный справочник, можно через метод ПолучитьХарактеристикиКатегории() + + Метод в документации API: [post /v1/description-category/attribute/values/search](https://docs.ozon.ru/api/seller/#operation/DescriptionCategoryAPI_SearchAttributeValues) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDКатегории = 17054869; + IDТипа = 97311; + IDХарактеристики = 85; + Значение = "Sunshine"; + + Результат = OPI_Ozon.НайтиЗначенияХарактеристики(IDКлиента + , КлючAPI + , IDКатегории + , IDТипа + , IDХарактеристики + , Значение); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "id": 5055881, + "value": "Sunshine", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-i/6010930878.jpg" + }, + { + "id": 971026862, + "value": "SUNSHINE", + "info": "Спорт и отдых", + "picture": "" + }, + { + "id": 971719299, + "value": "Sunshine", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-v/6601244203.jpg" + }, + { + "id": 971818888, + "value": "Sunshine", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6644299477.jpg" + }, + { + "id": 972176200, + "value": "sunshine", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/e6dcf5aa-eb30-442d-afa0-5812652d2816.png" + }, + { + "id": 972202223, + "value": "SUNSHINE", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/68384d8e-4b49-4f99-a045-3403c1f10f0f.jpg" + }, + { + "id": 971227292, + "value": "Sunshine Baby", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-r/6299308959.jpg" + }, + { + "id": 972029069, + "value": "Sunshine Beams", + "info": "", + "picture": "" + }, + { + "id": 971168926, + "value": "Sunshine-Craft", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-u/6267516354.jpg" + }, + { + "id": 972173064, + "value": "Sunshine Day", + "info": "", + "picture": "" + }, + { + "id": 970974258, + "value": "sunshinefilm", + "info": "Защитная пленка на экран смартфона, гидрогелевая", + "picture": "https://cdn1.ozone.ru/s3/multimedia-w/6048813188.jpg" + }, + { + "id": 972066951, + "value": "SunShineFox", + "info": "", + "picture": "" + }, + { + "id": 972172514, + "value": "SUNSHINEFXY", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/d48c1614-b9c4-4785-b9ef-3142f5cfb12c.png" + }, + { + "id": 971110891, + "value": "Sunshine Habibi", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-4/6158730376.jpg" + }, + { + "id": 971896068, + "value": "Sunshine House", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-b/6704404415.jpg" + }, + { + "id": 971967921, + "value": "SunShine in me", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-1/6775950013.jpg" + }, + { + "id": 970712762, + "value": "Sunshine Innovations", + "info": "", + "picture": "" + }, + { + "id": 5115939, + "value": "Sunshine Kids", + "info": "", + "picture": "" + }, + { + "id": 971303326, + "value": "Sunshine Lady", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-p/6371652253.jpg" + }, + { + "id": 972131760, + "value": "Sunshineland", + "info": "", + "picture": "https://cdn1.ozonusercontent.com/s3/product-service-meta-media/63bfd44b-6338-4fa6-8843-39b1c7827099.jpg" + }, + { + "id": 5142226, + "value": "Sunshine Optics", + "info": "", + "picture": "" + }, + { + "id": 972026686, + "value": "SUNSHINE PANDI", + "info": "", + "picture": "https://cdn1.ozone.ru/s3/multimedia-3/6842409075.jpg" + }, + { + "id": 970954160, + "value": "SUNSHINE PEARL", + "info": "Соль для ванны", + "picture": "https://cdn1.ozone.ru/s3/multimedia-j/6041114827.jpg" + }, + { + "id": 970697481, + "value": "SunShines", + "info": "", + "picture": "" + }, + { + "id": 972077059, + "value": "Sunshine shop", + "info": "", +... +``` diff --git a/docs/ru/md/Ozon/Barcodes/Bind-barcodes.md b/docs/ru/md/Ozon/Barcodes/Bind-barcodes.md deleted file mode 100644 index c69f847cb3..0000000000 --- a/docs/ru/md/Ozon/Barcodes/Bind-barcodes.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Привязать штрихкоды - Привязывает штрихкоды к товарам - - - -`Функция ПривязатьШтрихкоды(Знач IDКлиента, Знач КлючAPI, Знач СоответствиеШтрихкодов) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | СоответствиеШтрихкодов | --barcodes | Соответствие Из КлючИЗначение | Ключ > SKU товара, Значение > Штрихкод | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/barcode/add](https://docs.ozon.ru/api/seller/#operation/add-barcode) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - СоответствиеШтрихкодов = Новый Соответствие; - СоответствиеШтрихкодов.Вставить(1626044001, "112233"); - - Результат = OPI_Ozon.ПривязатьШтрихкоды(IDКлиента, КлючAPI, СоответствиеШтрихкодов); -``` - - - - -```json title="Результат" -{ - "errors": [ - { - "barcode": "112233", - "code": "item_not_found", - "error": "sellerID of item 1626044001 is not 2128753", - "sku": 1626044001 - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Barcodes/Bind-barcodes.mdx b/docs/ru/md/Ozon/Barcodes/Bind-barcodes.mdx new file mode 100644 index 0000000000..806f72e255 --- /dev/null +++ b/docs/ru/md/Ozon/Barcodes/Bind-barcodes.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Привязать штрихкоды + Привязывает штрихкоды к товарам + + + +`Функция ПривязатьШтрихкоды(Знач IDКлиента, Знач КлючAPI, Знач СоответствиеШтрихкодов) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | СоответствиеШтрихкодов | --barcodes | Соответствие Из КлючИЗначение | Ключ > SKU товара, Значение > Штрихкод | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/barcode/add](https://docs.ozon.ru/api/seller/#operation/add-barcode) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + СоответствиеШтрихкодов = Новый Соответствие; + СоответствиеШтрихкодов.Вставить(1626044001, "112233"); + + Результат = OPI_Ozon.ПривязатьШтрихкоды(IDКлиента, КлючAPI, СоответствиеШтрихкодов); +``` + + + + +```json title="Результат" +{ + "errors": [ + { + "barcode": "112233", + "code": "item_not_found", + "error": "sellerID of item 1626044001 is not 2128753", + "sku": 1626044001 + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Barcodes/Create-barcodes.md b/docs/ru/md/Ozon/Barcodes/Create-barcodes.md deleted file mode 100644 index b1950107a2..0000000000 --- a/docs/ru/md/Ozon/Barcodes/Create-barcodes.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать штрихкоды - Генерирует новые штрихкоды для товаров - - - -`Функция СоздатьШтрихкоды(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТоваров | --productids | Строка, Массив Из Строка | ID товаров для создания штрихкодов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -За один запрос вы можете создать штрихкоды не больше чем для 100 товаров - - С одного аккаунта продавца можно использовать метод не больше 20 раз в минуту - - Метод в документации API: [post /v1/barcode/generate](https://docs.ozon.ru/api/seller/#operation/generate-barcode) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Результат = OPI_Ozon.СоздатьШтрихкоды(IDКлиента, КлючAPI, IDТовара); -``` - - - - -```json title="Результат" -{ - "errors": [] -} -``` diff --git a/docs/ru/md/Ozon/Barcodes/Create-barcodes.mdx b/docs/ru/md/Ozon/Barcodes/Create-barcodes.mdx new file mode 100644 index 0000000000..c56fd764cb --- /dev/null +++ b/docs/ru/md/Ozon/Barcodes/Create-barcodes.mdx @@ -0,0 +1,51 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать штрихкоды + Генерирует новые штрихкоды для товаров + + + +`Функция СоздатьШтрихкоды(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТоваров | --productids | Строка, Массив Из Строка | ID товаров для создания штрихкодов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +За один запрос вы можете создать штрихкоды не больше чем для 100 товаров + + С одного аккаунта продавца можно использовать метод не больше 20 раз в минуту + + Метод в документации API: [post /v1/barcode/generate](https://docs.ozon.ru/api/seller/#operation/generate-barcode) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Результат = OPI_Ozon.СоздатьШтрихкоды(IDКлиента, КлючAPI, IDТовара); +``` + + + + +```json title="Результат" +{ + "errors": [] +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-discount-information.md b/docs/ru/md/Ozon/Prices-and-stocks/Get-discount-information.md deleted file mode 100644 index 0ee6bdf5d5..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Get-discount-information.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию об уценке - Получает информацию об уценке и основном товаре по SKU уценённых товаров - - - -`Функция ПолучитьИнформациюОбУценке(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | SKU | --sku | Число, Массив Из Число | SKU уцененных товаров | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/info/discounted](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDiscounted) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Результат = OPI_Ozon.ПолучитьИнформациюОбУценке(IDКлиента, КлючAPI, SKU); -``` - - - - -```json title="Результат" -{ - "items": [] -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-discount-information.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Get-discount-information.mdx new file mode 100644 index 0000000000..598cf62876 --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Get-discount-information.mdx @@ -0,0 +1,47 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить информацию об уценке + Получает информацию об уценке и основном товаре по SKU уценённых товаров + + + +`Функция ПолучитьИнформациюОбУценке(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | SKU | --sku | Число, Массив Из Число | SKU уцененных товаров | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/info/discounted](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDiscounted) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Результат = OPI_Ozon.ПолучитьИнформациюОбУценке(IDКлиента, КлючAPI, SKU); +``` + + + + +```json title="Результат" +{ + "items": [] +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-product-price-structure.md b/docs/ru/md/Ozon/Prices-and-stocks/Get-product-price-structure.md deleted file mode 100644 index cac1d224d2..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Get-product-price-structure.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить структуру цены товара - Получает структуру цены товара для функции ОбновитьЦеныТоваров - - - -`Функция ПолучитьСтруктуруЦеныТовара(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей фильра - -
- -:::tip -Описание полей фильтра можно найти на странице документации по получению списка товаров: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) -::: -
- - -```bsl title="Пример кода" - Результат = OPI_Ozon.ПолучитьСтруктуруЦеныТовара(); -``` - - - - -```json title="Результат" -{ - "auto_action_enabled": "<включение автоприменения акций: ENABLED или DISABLED>", - "currency_code": "<валюта>", - "min_price": "<минимальная цена товара после применения акций>", - "offer_id": "<идентификатор товара в системе продавца>", - "old_price": "<цена до скидок; укажите значение 0, если скидок нет>", - "price": "<цена товара с учётом скидок>", - "price_strategy_enabled": "<автоприменения стратегий цены: ENABLED или DISABLED>", - "product_id": "" -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-product-price-structure.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Get-product-price-structure.mdx new file mode 100644 index 0000000000..02350811cb --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Get-product-price-structure.mdx @@ -0,0 +1,48 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить структуру цены товара + Получает структуру цены товара для функции ОбновитьЦеныТоваров + + + +`Функция ПолучитьСтруктуруЦеныТовара(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей фильра + +
+ +:::tip +Описание полей фильтра можно найти на странице документации по получению списка товаров: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) +::: +
+ + +```bsl title="Пример кода" + Результат = OPI_Ozon.ПолучитьСтруктуруЦеныТовара(); +``` + + + + +```json title="Результат" +{ + "auto_action_enabled": "<включение автоприменения акций: ENABLED или DISABLED>", + "currency_code": "<валюта>", + "min_price": "<минимальная цена товара после применения акций>", + "offer_id": "<идентификатор товара в системе продавца>", + "old_price": "<цена до скидок; укажите значение 0, если скидок нет>", + "price": "<цена товара с учётом скидок>", + "price_strategy_enabled": "<автоприменения стратегий цены: ENABLED или DISABLED>", + "product_id": "" +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.md b/docs/ru/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.md deleted file mode 100644 index ef01c4da51..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить структуру остатков товара - Получает структуру для внесения остатков товара в функции ОбновитьКоличествоТоваров - - - -`Функция ПолучитьСтруктуруОстатковТовара(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей фильра - -
- -:::tip -Описание полей фильтра можно найти на странице документации по получению списка товаров: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) -::: -
- - -```bsl title="Пример кода" - Результат = OPI_Ozon.ПолучитьСтруктуруОстатковТовара(); -``` - - - - -```json title="Результат" -{ - "offer_id": "<артикул>", - "product_id": "", - "stock": "<количество>", - "warehouse_id": "" -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.mdx new file mode 100644 index 0000000000..3529e5c5c8 --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Get-product-stocks-structure.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить структуру остатков товара + Получает структуру для внесения остатков товара в функции ОбновитьКоличествоТоваров + + + +`Функция ПолучитьСтруктуруОстатковТовара(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей фильра + +
+ +:::tip +Описание полей фильтра можно найти на странице документации по получению списка товаров: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) +::: +
+ + +```bsl title="Пример кода" + Результат = OPI_Ozon.ПолучитьСтруктуруОстатковТовара(); +``` + + + + +```json title="Результат" +{ + "offer_id": "<артикул>", + "product_id": "", + "stock": "<количество>", + "warehouse_id": "" +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-products-prices.md b/docs/ru/md/Ozon/Prices-and-stocks/Get-products-prices.md deleted file mode 100644 index de671fc3dd..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Get-products-prices.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить цены товаров - Получает цены товаров с фильтром или без - - - -`Функция ПолучитьЦеныТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | - | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v4/product/info/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoPricesV4) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - Результат = OPI_Ozon.ПолучитьЦеныТоваров(IDКлиента, КлючAPI, Новый Структура); -``` - - - - -```json title="Результат" -{ - "result": { - "items": [ - { - "product_id": 1156646653, - "offer_id": "91132", - "price": { - "price": "1100.0000", - "old_price": "1100.0000", - "premium_price": "", - "recommended_price": "", - "retail_price": "0.0000", - "vat": "0.100000", - "min_ozon_price": "", - "marketing_price": "", - "marketing_seller_price": "", - "min_price": "0.0000", - "currency_code": "RUB", - "auto_action_enabled": false - }, - "price_index": "0.00", - "commissions": { - "sales_percent": 0, - "fbo_fulfillment_amount": 0, - "fbo_direct_flow_trans_min_amount": 0, - "fbo_direct_flow_trans_max_amount": 0, - "fbo_deliv_to_customer_amount": 0, - "fbo_return_flow_amount": 0, - "fbo_return_flow_trans_min_amount": 0, - "fbo_return_flow_trans_max_amount": 0, - "fbs_first_mile_min_amount": 0, - "fbs_first_mile_max_amount": 25, - "fbs_direct_flow_trans_min_amount": 0, - "fbs_direct_flow_trans_max_amount": 0, - "fbs_deliv_to_customer_amount": 0, - "fbs_return_flow_amount": 0, - "fbs_return_flow_trans_min_amount": 0, - "fbs_return_flow_trans_max_amount": 0, - "sales_percent_fbo": 0, - "sales_percent_fbs": 0 - }, - "marketing_actions": null, - "volume_weight": 1.2, - "price_indexes": { - "price_index": "WITHOUT_INDEX", - "external_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "ozon_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "self_marketplaces_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - } - }, - "acquiring": 0 - }, - { - "product_id": 1179304145, - "offer_id": "143210610", - "price": { - "price": "1300.0000", - "old_price": "1400.0000", - "premium_price": "", - "recommended_price": "", - "retail_price": "0.0000", - "vat": "0.100000", - "min_ozon_price": "", - "marketing_price": "", - "marketing_seller_price": "", - "min_price": "1300.0000", - "currency_code": "RUB", - "auto_action_enabled": false - }, - "price_index": "0.00", - "commissions": { - "sales_percent": 0, - "fbo_fulfillment_amount": 0, - "fbo_direct_flow_trans_min_amount": 0, - "fbo_direct_flow_trans_max_amount": 0, - "fbo_deliv_to_customer_amount": 0, - "fbo_return_flow_amount": 0, - "fbo_return_flow_trans_min_amount": 0, - "fbo_return_flow_trans_max_amount": 0, - "fbs_first_mile_min_amount": 0, - "fbs_first_mile_max_amount": 25, - "fbs_direct_flow_trans_min_amount": 0, - "fbs_direct_flow_trans_max_amount": 0, - "fbs_deliv_to_customer_amount": 0, - "fbs_return_flow_amount": 0, - "fbs_return_flow_trans_min_amount": 0, - "fbs_return_flow_trans_max_amount": 0, - "sales_percent_fbo": 0, - "sales_percent_fbs": 0 - }, - "marketing_actions": null, - "volume_weight": 0.1, - "price_indexes": { - "price_index": "WITHOUT_INDEX", - "external_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "ozon_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - }, - "self_marketplaces_index_data": { - "minimal_price": "", - "minimal_price_currency": "", - "price_index_value": 0 - } - }, - "acquiring": 0 - }, - { - "product_id": 1179307106, - "offer_id": "143210611", - "price": { - "price": "1300.0000", - "old_price": "1300.0000", - "premium_price": "", - "recommended_price": "", - "retail_price": "0.0000", - "vat": "0.100000", - "min_ozon_price": "", - "marketing_price": "", - "marketing_seller_price": "", - "min_price": "0.0000", - "currency_code": "RUB", - "auto_action_enabled": false - }, - "price_index": "0.00", - "commissions": { - "sales_percent": 0, - "fbo_fulfillment_amount": 0, - "fbo_direct_flow_trans_min_amount": 0, - "fbo_direct_flow_trans_max_amount": 0, - "fbo_deliv_to_customer_amount": 0, - "fbo_return_flow_amount": 0, - "fbo_return_flow_trans_min_amount": 0, - "fbo_return_flow_trans_max_amount": 0, -... -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-products-prices.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Get-products-prices.mdx new file mode 100644 index 0000000000..779055681a --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Get-products-prices.mdx @@ -0,0 +1,195 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить цены товаров + Получает цены товаров с фильтром или без + + + +`Функция ПолучитьЦеныТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | + | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v4/product/info/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoPricesV4) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + Результат = OPI_Ozon.ПолучитьЦеныТоваров(IDКлиента, КлючAPI, Новый Структура); +``` + + + + +```json title="Результат" +{ + "result": { + "items": [ + { + "product_id": 1156646653, + "offer_id": "91132", + "price": { + "price": "1100.0000", + "old_price": "1100.0000", + "premium_price": "", + "recommended_price": "", + "retail_price": "0.0000", + "vat": "0.100000", + "min_ozon_price": "", + "marketing_price": "", + "marketing_seller_price": "", + "min_price": "0.0000", + "currency_code": "RUB", + "auto_action_enabled": false + }, + "price_index": "0.00", + "commissions": { + "sales_percent": 0, + "fbo_fulfillment_amount": 0, + "fbo_direct_flow_trans_min_amount": 0, + "fbo_direct_flow_trans_max_amount": 0, + "fbo_deliv_to_customer_amount": 0, + "fbo_return_flow_amount": 0, + "fbo_return_flow_trans_min_amount": 0, + "fbo_return_flow_trans_max_amount": 0, + "fbs_first_mile_min_amount": 0, + "fbs_first_mile_max_amount": 25, + "fbs_direct_flow_trans_min_amount": 0, + "fbs_direct_flow_trans_max_amount": 0, + "fbs_deliv_to_customer_amount": 0, + "fbs_return_flow_amount": 0, + "fbs_return_flow_trans_min_amount": 0, + "fbs_return_flow_trans_max_amount": 0, + "sales_percent_fbo": 0, + "sales_percent_fbs": 0 + }, + "marketing_actions": null, + "volume_weight": 1.2, + "price_indexes": { + "price_index": "WITHOUT_INDEX", + "external_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "ozon_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "self_marketplaces_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + } + }, + "acquiring": 0 + }, + { + "product_id": 1179304145, + "offer_id": "143210610", + "price": { + "price": "1300.0000", + "old_price": "1400.0000", + "premium_price": "", + "recommended_price": "", + "retail_price": "0.0000", + "vat": "0.100000", + "min_ozon_price": "", + "marketing_price": "", + "marketing_seller_price": "", + "min_price": "1300.0000", + "currency_code": "RUB", + "auto_action_enabled": false + }, + "price_index": "0.00", + "commissions": { + "sales_percent": 0, + "fbo_fulfillment_amount": 0, + "fbo_direct_flow_trans_min_amount": 0, + "fbo_direct_flow_trans_max_amount": 0, + "fbo_deliv_to_customer_amount": 0, + "fbo_return_flow_amount": 0, + "fbo_return_flow_trans_min_amount": 0, + "fbo_return_flow_trans_max_amount": 0, + "fbs_first_mile_min_amount": 0, + "fbs_first_mile_max_amount": 25, + "fbs_direct_flow_trans_min_amount": 0, + "fbs_direct_flow_trans_max_amount": 0, + "fbs_deliv_to_customer_amount": 0, + "fbs_return_flow_amount": 0, + "fbs_return_flow_trans_min_amount": 0, + "fbs_return_flow_trans_max_amount": 0, + "sales_percent_fbo": 0, + "sales_percent_fbs": 0 + }, + "marketing_actions": null, + "volume_weight": 0.1, + "price_indexes": { + "price_index": "WITHOUT_INDEX", + "external_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "ozon_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + }, + "self_marketplaces_index_data": { + "minimal_price": "", + "minimal_price_currency": "", + "price_index_value": 0 + } + }, + "acquiring": 0 + }, + { + "product_id": 1179307106, + "offer_id": "143210611", + "price": { + "price": "1300.0000", + "old_price": "1300.0000", + "premium_price": "", + "recommended_price": "", + "retail_price": "0.0000", + "vat": "0.100000", + "min_ozon_price": "", + "marketing_price": "", + "marketing_seller_price": "", + "min_price": "0.0000", + "currency_code": "RUB", + "auto_action_enabled": false + }, + "price_index": "0.00", + "commissions": { + "sales_percent": 0, + "fbo_fulfillment_amount": 0, + "fbo_direct_flow_trans_min_amount": 0, + "fbo_direct_flow_trans_max_amount": 0, + "fbo_deliv_to_customer_amount": 0, + "fbo_return_flow_amount": 0, + "fbo_return_flow_trans_min_amount": 0, + "fbo_return_flow_trans_max_amount": 0, +... +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-products-stocks.md b/docs/ru/md/Ozon/Prices-and-stocks/Get-products-stocks.md deleted file mode 100644 index ecb1b15aa7..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Get-products-stocks.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить количество товаров - Получает количество товаров в остатке с фильтром или без - - - -`Функция ПолучитьКоличествоТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | - | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v3/product/info/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoStocksV3) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - МассивID = Новый Массив; - МассивID.Добавить("143210608"); - - Фильтр = Новый Структура; - Фильтр.Вставить("visibility" , "ALL"); - Фильтр.Вставить("offer_id" , МассивID); - - Результат = OPI_Ozon.ПолучитьКоличествоТоваров(IDКлиента, КлючAPI, Фильтр); -``` - - - - -```json title="Результат" -{ - "result": { - "items": [], - "total": 0, - "last_id": "" - } -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Get-products-stocks.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Get-products-stocks.mdx new file mode 100644 index 0000000000..c7173cedc4 --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Get-products-stocks.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить количество товаров + Получает количество товаров в остатке с фильтром или без + + + +`Функция ПолучитьКоличествоТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | + | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v3/product/info/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoStocksV3) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + МассивID = Новый Массив; + МассивID.Добавить("143210608"); + + Фильтр = Новый Структура; + Фильтр.Вставить("visibility" , "ALL"); + Фильтр.Вставить("offer_id" , МассивID); + + Результат = OPI_Ozon.ПолучитьКоличествоТоваров(IDКлиента, КлючAPI, Фильтр); +``` + + + + +```json title="Результат" +{ + "result": { + "items": [], + "total": 0, + "last_id": "" + } +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Set-product-discount.md b/docs/ru/md/Ozon/Prices-and-stocks/Set-product-discount.md deleted file mode 100644 index cc54cc053e..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Set-product-discount.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Установить скидку на уцененный товар - Устанавливает размер скидки на уценённые товары, продающиеся по схеме FBS - - - -`Функция УстановитьСкидкуНаУцененныйТовар(Знач IDКлиента, Знач КлючAPI, Знач IDТовара, Знач Скидка) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТовара | --productid | Строка, Число | Идентификатор товара | - | Скидка | --discount | Строка, Число | Размер скидки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/update/discount](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateDiscount) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = 1156646653; - - Скидка = 10; - - Результат = OPI_Ozon.УстановитьСкидкуНаУцененныйТовар(IDКлиента, КлючAPI, IDТовара, Скидка); -``` - - - - -```json title="Результат" -{ - "code": 5, - "message": "item discount not found", - "details": [] -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Set-product-discount.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Set-product-discount.mdx new file mode 100644 index 0000000000..fdf7aee49d --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Set-product-discount.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Установить скидку на уцененный товар + Устанавливает размер скидки на уценённые товары, продающиеся по схеме FBS + + + +`Функция УстановитьСкидкуНаУцененныйТовар(Знач IDКлиента, Знач КлючAPI, Знач IDТовара, Знач Скидка) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТовара | --productid | Строка, Число | Идентификатор товара | + | Скидка | --discount | Строка, Число | Размер скидки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/update/discount](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateDiscount) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = 1156646653; + + Скидка = 10; + + Результат = OPI_Ozon.УстановитьСкидкуНаУцененныйТовар(IDКлиента, КлючAPI, IDТовара, Скидка); +``` + + + + +```json title="Результат" +{ + "code": 5, + "message": "item discount not found", + "details": [] +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Update-products-prices.md b/docs/ru/md/Ozon/Prices-and-stocks/Update-products-prices.md deleted file mode 100644 index bb00790171..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Update-products-prices.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Обновить цены товаров - Изменяет цены однного или нескольких товаров - - - -`Функция ОбновитьЦеныТоваров(Знач IDКлиента, Знач КлючAPI, Знач Цены) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Цены | --prices | Массив из Структура | Цены товаров. См. ПолучитьСтруктуруЦеныТовара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Цены = Новый Структура; - Цены.Вставить("auto_action_enabled" , "DISABLED"); - Цены.Вставить("currency_code" , "RUB"); - Цены.Вставить("min_price" , "1300"); - Цены.Вставить("offer_id" , "143210610"); - Цены.Вставить("old_price" , "1400"); - Цены.Вставить("price" , "1300"); - Цены.Вставить("price_strategy_enabled", "DISABLED"); - Цены.Вставить("product_id" , IDТовара); - - Результат = OPI_Ozon.ОбновитьЦеныТоваров(IDКлиента, КлючAPI, Цены); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "product_id": 1179304145, - "offer_id": "143210610", - "updated": true, - "errors": [] - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Update-products-prices.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Update-products-prices.mdx new file mode 100644 index 0000000000..bf82885be2 --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Update-products-prices.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Обновить цены товаров + Изменяет цены однного или нескольких товаров + + + +`Функция ОбновитьЦеныТоваров(Знач IDКлиента, Знач КлючAPI, Знач Цены) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Цены | --prices | Массив из Структура | Цены товаров. См. ПолучитьСтруктуруЦеныТовара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/import/prices](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsPrices) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Цены = Новый Структура; + Цены.Вставить("auto_action_enabled" , "DISABLED"); + Цены.Вставить("currency_code" , "RUB"); + Цены.Вставить("min_price" , "1300"); + Цены.Вставить("offer_id" , "143210610"); + Цены.Вставить("old_price" , "1400"); + Цены.Вставить("price" , "1300"); + Цены.Вставить("price_strategy_enabled", "DISABLED"); + Цены.Вставить("product_id" , IDТовара); + + Результат = OPI_Ozon.ОбновитьЦеныТоваров(IDКлиента, КлючAPI, Цены); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "product_id": 1179304145, + "offer_id": "143210610", + "updated": true, + "errors": [] + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Update-products-stocks.md b/docs/ru/md/Ozon/Prices-and-stocks/Update-products-stocks.md deleted file mode 100644 index ffca4badc3..0000000000 --- a/docs/ru/md/Ozon/Prices-and-stocks/Update-products-stocks.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Обновить количество товаров - Изменяет информацию о количестве товара в наличии - - - -`Функция ОбновитьКоличествоТоваров(Знач IDКлиента, Знач КлючAPI, Знач Остатки) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Остатки | --stocks | Массив Из Структура | Массив описаний остатков. См. ПолучитьСтруктуруОстатковТовара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -За один запрос можно изменить наличие для 100 товаров. С одного аккаунта продавца можно отправить до 80 запросов в минуту. - - Обновлять остатки товара на одном складе можно только 1 раз в 2 минуты. Вы можете задать наличие товара только после того, как его статус сменится на price_sent - - Остатки крупногабаритных товаров можно обновлять только на предназначенных для них складах - - Метод в документации API: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Остатки = Новый Структура; - Остатки.Вставить("offer_id" , "143210610"); - Остатки.Вставить("product_id" , IDТовара); - Остатки.Вставить("stock" , 20); - Остатки.Вставить("warehouse_id", 1); - - Результат = OPI_Ozon.ОбновитьКоличествоТоваров(IDКлиента, КлючAPI, Остатки); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "warehouse_id": 1, - "product_id": 0, - "offer_id": "143210610", - "updated": false, - "errors": [ - { - "code": "WAREHOUSE_NOT_FOUND", - "message": "warehouse has wrong id: 1" - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Prices-and-stocks/Update-products-stocks.mdx b/docs/ru/md/Ozon/Prices-and-stocks/Update-products-stocks.mdx new file mode 100644 index 0000000000..6ebecffe15 --- /dev/null +++ b/docs/ru/md/Ozon/Prices-and-stocks/Update-products-stocks.mdx @@ -0,0 +1,72 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Обновить количество товаров + Изменяет информацию о количестве товара в наличии + + + +`Функция ОбновитьКоличествоТоваров(Знач IDКлиента, Знач КлючAPI, Знач Остатки) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Остатки | --stocks | Массив Из Структура | Массив описаний остатков. См. ПолучитьСтруктуруОстатковТовара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +За один запрос можно изменить наличие для 100 товаров. С одного аккаунта продавца можно отправить до 80 запросов в минуту. + + Обновлять остатки товара на одном складе можно только 1 раз в 2 минуты. Вы можете задать наличие товара только после того, как его статус сменится на price_sent + + Остатки крупногабаритных товаров можно обновлять только на предназначенных для них складах + + Метод в документации API: [post /v2/products/stocks](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductsStocksV2) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Остатки = Новый Структура; + Остатки.Вставить("offer_id" , "143210610"); + Остатки.Вставить("product_id" , IDТовара); + Остатки.Вставить("stock" , 20); + Остатки.Вставить("warehouse_id", 1); + + Результат = OPI_Ozon.ОбновитьКоличествоТоваров(IDКлиента, КлючAPI, Остатки); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "warehouse_id": 1, + "product_id": 0, + "offer_id": "143210610", + "updated": false, + "errors": [ + { + "code": "WAREHOUSE_NOT_FOUND", + "message": "warehouse has wrong id: 1" + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Promotions-managment/Get-available-promo-products.md b/docs/ru/md/Ozon/Promotions-managment/Get-available-promo-products.md deleted file mode 100644 index 139fe2429e..0000000000 --- a/docs/ru/md/Ozon/Promotions-managment/Get-available-promo-products.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить доступные товары акции - Получает товары, доступные в выбранной акции - - - -`Функция ПолучитьДоступныеТоварыАкции(Знач IDКлиента, Знач КлючAPI, Знач IDАкции, Знач Отступ = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDАкции | --actionid | Число | ID акции | - | Отступ | --offset | Число | Отступ получения элементов списка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/actions/candidates](https://docs.ozon.ru/api/seller/#operation/PromosCandidates) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDАкции = 111111111; - - Результат = OPI_Ozon.ПолучитьДоступныеТоварыАкции(IDКлиента, КлючAPI, IDАкции); -``` - - - - -```json title="Результат" -{ - "code": 5, - "message": "Resource not found", - "details": [] -} -``` diff --git a/docs/ru/md/Ozon/Promotions-managment/Get-available-promo-products.mdx b/docs/ru/md/Ozon/Promotions-managment/Get-available-promo-products.mdx new file mode 100644 index 0000000000..f203ad8442 --- /dev/null +++ b/docs/ru/md/Ozon/Promotions-managment/Get-available-promo-products.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить доступные товары акции + Получает товары, доступные в выбранной акции + + + +`Функция ПолучитьДоступныеТоварыАкции(Знач IDКлиента, Знач КлючAPI, Знач IDАкции, Знач Отступ = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDАкции | --actionid | Число | ID акции | + | Отступ | --offset | Число | Отступ получения элементов списка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/actions/candidates](https://docs.ozon.ru/api/seller/#operation/PromosCandidates) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDАкции = 111111111; + + Результат = OPI_Ozon.ПолучитьДоступныеТоварыАкции(IDКлиента, КлючAPI, IDАкции); +``` + + + + +```json title="Результат" +{ + "code": 5, + "message": "Resource not found", + "details": [] +} +``` diff --git a/docs/ru/md/Ozon/Promotions-managment/Get-current-promo-products.md b/docs/ru/md/Ozon/Promotions-managment/Get-current-promo-products.md deleted file mode 100644 index fe10a8a54f..0000000000 --- a/docs/ru/md/Ozon/Promotions-managment/Get-current-promo-products.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить участвующие товары акции - Получает товары, участвующие в выбранной акции - - - -`Функция ПолучитьУчаствующиеТоварыАкции(Знач IDКлиента, Знач КлючAPI, Знач IDАкции, Знач Отступ = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDАкции | --actionid | Число | ID акции | - | Отступ | --offset | Число | Отступ получения элементов списка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/actions/products](https://docs.ozon.ru/api/seller/#operation/PromosProducts) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDАкции = 111111111; - - Результат = OPI_Ozon.ПолучитьУчаствующиеТоварыАкции(IDКлиента, КлючAPI, IDАкции); -``` - - - - -```json title="Результат" -{ - "code": 5, - "message": "Resource not found", - "details": [] -} -``` diff --git a/docs/ru/md/Ozon/Promotions-managment/Get-current-promo-products.mdx b/docs/ru/md/Ozon/Promotions-managment/Get-current-promo-products.mdx new file mode 100644 index 0000000000..6324c987de --- /dev/null +++ b/docs/ru/md/Ozon/Promotions-managment/Get-current-promo-products.mdx @@ -0,0 +1,50 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить участвующие товары акции + Получает товары, участвующие в выбранной акции + + + +`Функция ПолучитьУчаствующиеТоварыАкции(Знач IDКлиента, Знач КлючAPI, Знач IDАкции, Знач Отступ = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDАкции | --actionid | Число | ID акции | + | Отступ | --offset | Число | Отступ получения элементов списка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/actions/products](https://docs.ozon.ru/api/seller/#operation/PromosProducts) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDАкции = 111111111; + + Результат = OPI_Ozon.ПолучитьУчаствующиеТоварыАкции(IDКлиента, КлючAPI, IDАкции); +``` + + + + +```json title="Результат" +{ + "code": 5, + "message": "Resource not found", + "details": [] +} +``` diff --git a/docs/ru/md/Ozon/Promotions-managment/Get-promotions-list.md b/docs/ru/md/Ozon/Promotions-managment/Get-promotions-list.md deleted file mode 100644 index a00e7ba28b..0000000000 --- a/docs/ru/md/Ozon/Promotions-managment/Get-promotions-list.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список акций - Получает список акций, доступных для участия - - - -`Функция ПолучитьСписокАкций(Знач IDКлиента, Знач КлючAPI) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/actions](https://docs.ozon.ru/api/seller/#operation/Promos) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - Результат = OPI_Ozon.ПолучитьСписокАкций(IDКлиента, КлючAPI); -``` - - - - -```json title="Результат" -{ - "result": [] -} -``` diff --git a/docs/ru/md/Ozon/Promotions-managment/Get-promotions-list.mdx b/docs/ru/md/Ozon/Promotions-managment/Get-promotions-list.mdx new file mode 100644 index 0000000000..4e4d381e53 --- /dev/null +++ b/docs/ru/md/Ozon/Promotions-managment/Get-promotions-list.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список акций + Получает список акций, доступных для участия + + + +`Функция ПолучитьСписокАкций(Знач IDКлиента, Знач КлючAPI) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/actions](https://docs.ozon.ru/api/seller/#operation/Promos) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + Результат = OPI_Ozon.ПолучитьСписокАкций(IDКлиента, КлючAPI); +``` + + + + +```json title="Результат" +{ + "result": [] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.md deleted file mode 100644 index 0e8dd02e8e..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 25 ---- - -# Добавить видеообложку товара - Добавляет видеообложку к атрибутам товара - - - -`Функция ДобавитьВидеообложкуТовара(СтруктураТовара, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | СтруктураТовара | --item | Структура Из Строка | Основная структура полей товара. См. ПолучитьСтруктуруТовара | - | URL | --url | Строка | URL к видеообложке для добавления | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара с добавленным видео - -
- -:::tip -В 1С метод может использоваться как процедура, без получения возвращаемого значения. Возвращаемое значение необходимо для CLI версии -::: -
- - -```bsl title="Пример кода" - Видео = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; - - СтруктураТовара = Новый Структура; - СтруктураТовара.Вставить("description_category_id", 17028922); - СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - СтруктураТовара.Вставить("offer_id" , "143210608"); - СтруктураТовара.Вставить("barcode" , "112772873170"); - СтруктураТовара.Вставить("price" , "1000"); - СтруктураТовара.Вставить("old_price" , "1100"); - СтруктураТовара.Вставить("vat" , "0.1"); - СтруктураТовара.Вставить("height" , 250); - СтруктураТовара.Вставить("width" , 150); - СтруктураТовара.Вставить("depth" , 10); - СтруктураТовара.Вставить("dimension_unit" , "mm"); - СтруктураТовара.Вставить("weight" , 100); - СтруктураТовара.Вставить("weight_unit" , "g"); - - // Видеообложка - - OPI_Ozon.ДобавитьВидеообложкуТовара(СтруктураТовара, Видео); -``` - - - - -```json title="Результат" -{ - "description_category_id": 17028922, - "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", - "offer_id": "143210608", - "barcode": "112772873170", - "price": "1000", - "old_price": "1100", - "vat": "0.1", - "height": 250, - "width": 150, - "depth": 10, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "complex_attributes": [ - { - "attributes": [ - { - "id": 21845, - "complex_id": 100002, - "values": [ - { - "dictionary_value_id": 0, - "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" - } - ] - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.mdx new file mode 100644 index 0000000000..750bea938d --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video-cover.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 25 +--- + +# Добавить видеообложку товара + Добавляет видеообложку к атрибутам товара + + + +`Функция ДобавитьВидеообложкуТовара(СтруктураТовара, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | СтруктураТовара | --item | Структура Из Строка | Основная структура полей товара. См. ПолучитьСтруктуруТовара | + | URL | --url | Строка | URL к видеообложке для добавления | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара с добавленным видео + +
+ +:::tip +В 1С метод может использоваться как процедура, без получения возвращаемого значения. Возвращаемое значение необходимо для CLI версии +::: +
+ + +```bsl title="Пример кода" + Видео = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; + + СтруктураТовара = Новый Структура; + СтруктураТовара.Вставить("description_category_id", 17028922); + СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + СтруктураТовара.Вставить("offer_id" , "143210608"); + СтруктураТовара.Вставить("barcode" , "112772873170"); + СтруктураТовара.Вставить("price" , "1000"); + СтруктураТовара.Вставить("old_price" , "1100"); + СтруктураТовара.Вставить("vat" , "0.1"); + СтруктураТовара.Вставить("height" , 250); + СтруктураТовара.Вставить("width" , 150); + СтруктураТовара.Вставить("depth" , 10); + СтруктураТовара.Вставить("dimension_unit" , "mm"); + СтруктураТовара.Вставить("weight" , 100); + СтруктураТовара.Вставить("weight_unit" , "g"); + + // Видеообложка + + OPI_Ozon.ДобавитьВидеообложкуТовара(СтруктураТовара, Видео); +``` + + + + +```json title="Результат" +{ + "description_category_id": 17028922, + "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", + "offer_id": "143210608", + "barcode": "112772873170", + "price": "1000", + "old_price": "1100", + "vat": "0.1", + "height": 250, + "width": 150, + "depth": 10, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "complex_attributes": [ + { + "attributes": [ + { + "id": 21845, + "complex_id": 100002, + "values": [ + { + "dictionary_value_id": 0, + "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" + } + ] + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video.md deleted file mode 100644 index 78537c602d..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -sidebar_position: 24 ---- - -# Добавить видео товара - Добавляет видео к атрибутам товара - - - -`Функция ДобавитьВидеоТовара(СтруктураТовара, Знач URL, Знач Наименование) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | СтруктураТовара | --item | Структура Из Строка | Основная структура полей товара. См. ПолучитьСтруктуруТовара | - | URL | --url | Строка | URL к видео для добавления | - | Наименование | --title | Строка | Техническое наименование видео | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара с добавленным видео - -
- -:::tip -В 1С метод может использоваться как процедура, без получения возвращаемого значения. Возвращаемое значение необходимо для CLI версии -::: -
- - -```bsl title="Пример кода" - Видео = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; - - СтруктураТовара = Новый Структура; - СтруктураТовара.Вставить("description_category_id", 17028922); - СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - СтруктураТовара.Вставить("offer_id" , "143210608"); - СтруктураТовара.Вставить("barcode" , "112772873170"); - СтруктураТовара.Вставить("price" , "1000"); - СтруктураТовара.Вставить("old_price" , "1100"); - СтруктураТовара.Вставить("vat" , "0.1"); - СтруктураТовара.Вставить("height" , 250); - СтруктураТовара.Вставить("width" , 150); - СтруктураТовара.Вставить("depth" , 10); - СтруктураТовара.Вставить("dimension_unit" , "mm"); - СтруктураТовара.Вставить("weight" , 100); - СтруктураТовара.Вставить("weight_unit" , "g"); - - // Видео - - OPI_Ozon.ДобавитьВидеоТовара(СтруктураТовара, Видео, "viedo1"); -``` - - - - -```json title="Результат" -{ - "description_category_id": 17028922, - "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", - "offer_id": "143210608", - "barcode": "112772873170", - "price": "1000", - "old_price": "1100", - "vat": "0.1", - "height": 250, - "width": 150, - "depth": 10, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "complex_attributes": [ - { - "attributes": [ - { - "id": 21841, - "complex_id": 100001, - "values": [ - { - "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" - } - ] - }, - { - "id": 21837, - "complex_id": 100001, - "values": [ - { - "value": "viedo1" - } - ] - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video.mdx new file mode 100644 index 0000000000..76293930c9 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Add-product-video.mdx @@ -0,0 +1,98 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 24 +--- + +# Добавить видео товара + Добавляет видео к атрибутам товара + + + +`Функция ДобавитьВидеоТовара(СтруктураТовара, Знач URL, Знач Наименование) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | СтруктураТовара | --item | Структура Из Строка | Основная структура полей товара. См. ПолучитьСтруктуруТовара | + | URL | --url | Строка | URL к видео для добавления | + | Наименование | --title | Строка | Техническое наименование видео | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара с добавленным видео + +
+ +:::tip +В 1С метод может использоваться как процедура, без получения возвращаемого значения. Возвращаемое значение необходимо для CLI версии +::: +
+ + +```bsl title="Пример кода" + Видео = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; + + СтруктураТовара = Новый Структура; + СтруктураТовара.Вставить("description_category_id", 17028922); + СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + СтруктураТовара.Вставить("offer_id" , "143210608"); + СтруктураТовара.Вставить("barcode" , "112772873170"); + СтруктураТовара.Вставить("price" , "1000"); + СтруктураТовара.Вставить("old_price" , "1100"); + СтруктураТовара.Вставить("vat" , "0.1"); + СтруктураТовара.Вставить("height" , 250); + СтруктураТовара.Вставить("width" , 150); + СтруктураТовара.Вставить("depth" , 10); + СтруктураТовара.Вставить("dimension_unit" , "mm"); + СтруктураТовара.Вставить("weight" , 100); + СтруктураТовара.Вставить("weight_unit" , "g"); + + // Видео + + OPI_Ozon.ДобавитьВидеоТовара(СтруктураТовара, Видео, "viedo1"); +``` + + + + +```json title="Результат" +{ + "description_category_id": 17028922, + "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", + "offer_id": "143210608", + "barcode": "112772873170", + "price": "1000", + "old_price": "1100", + "vat": "0.1", + "height": 250, + "width": 150, + "depth": 10, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "complex_attributes": [ + { + "attributes": [ + { + "id": 21841, + "complex_id": 100001, + "values": [ + { + "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" + } + ] + }, + { + "id": 21837, + "complex_id": 100001, + "values": [ + { + "value": "viedo1" + } + ] + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Archive-products.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Archive-products.md deleted file mode 100644 index 0c1b04f1f8..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Archive-products.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Архивировать товары - Переносит выбранные товары в архив - - - -`Функция АрхивироватьТовары(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТоваров | --products | Строка, Число, Массив Из Строка, Число | ID товаров для архивации | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Вы можете передать до 100 идентификаторов за раз - - Метод в документации API: [post /v1/product/archive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductArchive) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Результат = OPI_Ozon.АрхивироватьТовары(IDКлиента, КлючAPI, IDТовара); -``` - - - - -```json title="Результат" -{ - "result": true -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Archive-products.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Archive-products.mdx new file mode 100644 index 0000000000..824f1498dd --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Archive-products.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Архивировать товары + Переносит выбранные товары в архив + + + +`Функция АрхивироватьТовары(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТоваров | --products | Строка, Число, Массив Из Строка, Число | ID товаров для архивации | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Вы можете передать до 100 идентификаторов за раз + + Метод в документации API: [post /v1/product/archive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductArchive) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Результат = OPI_Ozon.АрхивироватьТовары(IDКлиента, КлючAPI, IDТовара); +``` + + + + +```json title="Результат" +{ + "result": true +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.md deleted file mode 100644 index 23d123186a..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Проверить загрузку изображений товаров - Проверяет загрузку изображений по массиву ID товаров - - - -`Функция ПроверитьЗагрузкуИзображенийТоваров(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТоваров | --products | Строка, Число, Массив Из Строка, Число | ID товаров для проверки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/pictures/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductInfoPictures) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Результат = OPI_Ozon.ПроверитьЗагрузкуИзображенийТоваров(IDКлиента, КлючAPI, IDТовара); -``` - - - - -```json title="Результат" -{ - "result": { - "pictures": [ - { - "product_id": 1215208579, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "state": "imported", - "is_primary": true, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215208579, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215208579, - "url": "GREEN", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": true - } - ] - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.mdx new file mode 100644 index 0000000000..47ecca8c8f --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Check-products-images-upload.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Проверить загрузку изображений товаров + Проверяет загрузку изображений по массиву ID товаров + + + +`Функция ПроверитьЗагрузкуИзображенийТоваров(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТоваров | --products | Строка, Число, Массив Из Строка, Число | ID товаров для проверки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/pictures/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductInfoPictures) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Результат = OPI_Ozon.ПроверитьЗагрузкуИзображенийТоваров(IDКлиента, КлючAPI, IDТовара); +``` + + + + +```json title="Результат" +{ + "result": { + "pictures": [ + { + "product_id": 1215208579, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "state": "imported", + "is_primary": true, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215208579, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215208579, + "url": "GREEN", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": true + } + ] + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.md deleted file mode 100644 index 643aed9e51..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -sidebar_position: 26 ---- - -# Дополнить комплексный атрибут - Оформляет значение в формате атрибута и добавляет его в массив attributes переданной коллекции - - - -`Функция ДополнитьКомплексныйАтрибут(Коллекция, Знач IDАтрибута, Знач КомплексныйID, Знач Значения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Коллекция | --object | Структура Из Строка | Структура комплексного атрибута или структура товара | - | IDАтрибута | --attributeid | Строка, Число | ID атрибута | - | КомплексныйID | --complexid | Строка, Число | Комплексный ID | - | Значения | --values | Произвольный | Значение или массив значений для добавления в values | - - - Возвращаемое значение: Структура - Коллекция, дополненная атрибутом - -
- -:::tip -В 1С метод может использоваться как процедура, без получения возвращаемого значения. Возвращаемое значение необходимо для CLI версии -::: -
- - -```bsl title="Пример кода" - СтруктураТовара = Новый Структура; - СтруктураТовара.Вставить("description_category_id", 17028922); - СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - СтруктураТовара.Вставить("offer_id" , "143210608"); - СтруктураТовара.Вставить("barcode" , "112772873170"); - СтруктураТовара.Вставить("price" , "1000"); - СтруктураТовара.Вставить("old_price" , "1100"); - СтруктураТовара.Вставить("vat" , "0.1"); - СтруктураТовара.Вставить("height" , 250); - СтруктураТовара.Вставить("width" , 150); - СтруктураТовара.Вставить("depth" , 10); - СтруктураТовара.Вставить("dimension_unit" , "mm"); - СтруктураТовара.Вставить("weight" , 100); - СтруктураТовара.Вставить("weight_unit" , "g"); - - АтрибутКатегории1 = Новый Структура("dictionary_value_id,value", 971082156, "Стойка для акустической системы"); - - АтрибутКатегории2 = Новый Структура("value", "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 5076 , 0, АтрибутКатегории1); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 9048 , 0, АтрибутКатегории2); -``` - - - - -```json title="Результат" -{ - "description_category_id": 17028922, - "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", - "offer_id": "143210608", - "barcode": "112772873170", - "price": "1000", - "old_price": "1100", - "vat": "0.1", - "height": 250, - "width": 150, - "depth": 10, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "attributes": [ - { - "id": 5076, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 971082156, - "value": "Стойка для акустической системы" - } - ] - }, - { - "id": 9048, - "complex_id": 0, - "values": [ - { - "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.mdx new file mode 100644 index 0000000000..e5a8c040fd --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Complete-complex-attribute.mdx @@ -0,0 +1,97 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 26 +--- + +# Дополнить комплексный атрибут + Оформляет значение в формате атрибута и добавляет его в массив attributes переданной коллекции + + + +`Функция ДополнитьКомплексныйАтрибут(Коллекция, Знач IDАтрибута, Знач КомплексныйID, Знач Значения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Коллекция | --object | Структура Из Строка | Структура комплексного атрибута или структура товара | + | IDАтрибута | --attributeid | Строка, Число | ID атрибута | + | КомплексныйID | --complexid | Строка, Число | Комплексный ID | + | Значения | --values | Произвольный | Значение или массив значений для добавления в values | + + + Возвращаемое значение: Структура - Коллекция, дополненная атрибутом + +
+ +:::tip +В 1С метод может использоваться как процедура, без получения возвращаемого значения. Возвращаемое значение необходимо для CLI версии +::: +
+ + +```bsl title="Пример кода" + СтруктураТовара = Новый Структура; + СтруктураТовара.Вставить("description_category_id", 17028922); + СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + СтруктураТовара.Вставить("offer_id" , "143210608"); + СтруктураТовара.Вставить("barcode" , "112772873170"); + СтруктураТовара.Вставить("price" , "1000"); + СтруктураТовара.Вставить("old_price" , "1100"); + СтруктураТовара.Вставить("vat" , "0.1"); + СтруктураТовара.Вставить("height" , 250); + СтруктураТовара.Вставить("width" , 150); + СтруктураТовара.Вставить("depth" , 10); + СтруктураТовара.Вставить("dimension_unit" , "mm"); + СтруктураТовара.Вставить("weight" , 100); + СтруктураТовара.Вставить("weight_unit" , "g"); + + АтрибутКатегории1 = Новый Структура("dictionary_value_id,value", 971082156, "Стойка для акустической системы"); + + АтрибутКатегории2 = Новый Структура("value", "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 5076 , 0, АтрибутКатегории1); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 9048 , 0, АтрибутКатегории2); +``` + + + + +```json title="Результат" +{ + "description_category_id": 17028922, + "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", + "offer_id": "143210608", + "barcode": "112772873170", + "price": "1000", + "old_price": "1100", + "vat": "0.1", + "height": 250, + "width": 150, + "depth": 10, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "attributes": [ + { + "id": 5076, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 971082156, + "value": "Стойка для акустической системы" + } + ] + }, + { + "id": 9048, + "complex_id": 0, + "values": [ + { + "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.md deleted file mode 100644 index 553efa80cf..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Создать товары по Ozon ID - Создаёт товар по указанному Ozon ID - - - -`Функция СоздатьТоварыПоOzonID(Знач IDКлиента, Знач КлючAPI, Знач МассивТоваров) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | МассивТоваров | --items | Массив Из Строка | Массив или одна сокращенная структура полей описания товара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Получить пустую структуру можно при помощи метода ПолучитьСокращеннуюСтруктуруТовара() - - Обновить товар по Ozon ID нельзя - - Метод в документации API: [post /v1/product/import-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsBySKU) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - СтруктураТовара = Новый Структура; - СтруктураТовара.Вставить("name" , "Новый импортированный товар"); - СтруктураТовара.Вставить("sku" , 1626044001); - СтруктураТовара.Вставить("offer_id" , "91132"); - СтруктураТовара.Вставить("price" , "1100"); - СтруктураТовара.Вставить("old_price" , "1100"); - СтруктураТовара.Вставить("vat" , "0.1"); - СтруктураТовара.Вставить("currency_code", "RUB"); - - Результат = OPI_Ozon.СоздатьТоварыПоOzonID(IDКлиента, КлючAPI, СтруктураТовара); -``` - - - - -```json title="Результат" -{ - "result": { - "task_id": 1346454017, - "unmatched_sku_list": [] - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.mdx new file mode 100644 index 0000000000..2b2d5cd63e --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Create-product-by-ozon-id.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Создать товары по Ozon ID + Создаёт товар по указанному Ozon ID + + + +`Функция СоздатьТоварыПоOzonID(Знач IDКлиента, Знач КлючAPI, Знач МассивТоваров) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | МассивТоваров | --items | Массив Из Строка | Массив или одна сокращенная структура полей описания товара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Получить пустую структуру можно при помощи метода ПолучитьСокращеннуюСтруктуруТовара() + + Обновить товар по Ozon ID нельзя + + Метод в документации API: [post /v1/product/import-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsBySKU) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + СтруктураТовара = Новый Структура; + СтруктураТовара.Вставить("name" , "Новый импортированный товар"); + СтруктураТовара.Вставить("sku" , 1626044001); + СтруктураТовара.Вставить("offer_id" , "91132"); + СтруктураТовара.Вставить("price" , "1100"); + СтруктураТовара.Вставить("old_price" , "1100"); + СтруктураТовара.Вставить("vat" , "0.1"); + СтруктураТовара.Вставить("currency_code", "RUB"); + + Результат = OPI_Ozon.СоздатьТоварыПоOzonID(IDКлиента, КлючAPI, СтруктураТовара); +``` + + + + +```json title="Результат" +{ + "result": { + "task_id": 1346454017, + "unmatched_sku_list": [] + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Create-update-products.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Create-update-products.md deleted file mode 100644 index bba871186f..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Create-update-products.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Создать обновить товары - Создает новые или обновляет существующие товары по структурам полей - - - -`Функция СоздатьОбновитьТовары(Знач IDКлиента, Знач КлючAPI, Знач МассивТоваров) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | МассивТоваров | --items | Массив Из Строка | Массив или одна структура полей описания товара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Методы формирования структуры товара: ПолучитьСтруктуруТовара(), ДобавитьВидеоТовара(), ДобавитьВидеообложкуТовара() - - Метод проверки статуса добавления - ПолучитьСтатусДобавленияТовара() - - Метод в документации API: [post /v3/product/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsV3) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; - Видео = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить(Картинка1); - МассивКартинок.Добавить(Картинка2); - - // Стандартные реквизиты - - СтруктураТовара = Новый Структура; - СтруктураТовара.Вставить("description_category_id", 17028922); - СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - СтруктураТовара.Вставить("offer_id" , "143210609"); - СтруктураТовара.Вставить("barcode" , "112772873170"); - СтруктураТовара.Вставить("price" , "1300"); - СтруктураТовара.Вставить("old_price" , "1300"); - СтруктураТовара.Вставить("vat" , "0.1"); - СтруктураТовара.Вставить("height" , 250); - СтруктураТовара.Вставить("width" , 150); - СтруктураТовара.Вставить("depth" , 10); - СтруктураТовара.Вставить("dimension_unit" , "mm"); - СтруктураТовара.Вставить("weight" , 100); - СтруктураТовара.Вставить("weight_unit" , "g"); - СтруктураТовара.Вставить("images" , МассивКартинок); - - // Видео - - OPI_Ozon.ДобавитьВидеоТовара(СтруктураТовара, Видео, "viedo1"); - - // Атрибуты, индивидуальные для разных категорий - - АтрибутКатегории1 = Новый Структура("dictionary_value_id,value", 971082156, "Стойка для акустической системы"); - АтрибутКатегории2 = Новый Структура("dictionary_value_id,value", 5060050 , "Samsung"); - АтрибутКатегории3 = Новый Структура("dictionary_value_id,value", 61576 , "серый"); - АтрибутКатегории4 = Новый Структура("dictionary_value_id,value", 95911 , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - - АтрибутКатегории5 = Новый Структура("value", "Комплект защитных плёнок для X3 NFC. Темный хлопок"); - - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 5076 , 0, АтрибутКатегории1); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 85 , 0, АтрибутКатегории2); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 10096, 0, АтрибутКатегории3); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 8229 , 0, АтрибутКатегории4); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 9048 , 0, АтрибутКатегории5); - - Результат = OPI_Ozon.СоздатьОбновитьТовары(IDКлиента, КлючAPI, СтруктураТовара); -``` - - - - -```json title="Результат" -{ - "result": { - "task_id": 1346453806 - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Create-update-products.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Create-update-products.mdx new file mode 100644 index 0000000000..ca90665b02 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Create-update-products.mdx @@ -0,0 +1,96 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Создать обновить товары + Создает новые или обновляет существующие товары по структурам полей + + + +`Функция СоздатьОбновитьТовары(Знач IDКлиента, Знач КлючAPI, Знач МассивТоваров) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | МассивТоваров | --items | Массив Из Строка | Массив или одна структура полей описания товара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Методы формирования структуры товара: ПолучитьСтруктуруТовара(), ДобавитьВидеоТовара(), ДобавитьВидеообложкуТовара() + + Метод проверки статуса добавления - ПолучитьСтатусДобавленияТовара() + + Метод в документации API: [post /v3/product/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ImportProductsV3) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; + Видео = "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/"; + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка1); + МассивКартинок.Добавить(Картинка2); + + // Стандартные реквизиты + + СтруктураТовара = Новый Структура; + СтруктураТовара.Вставить("description_category_id", 17028922); + СтруктураТовара.Вставить("name" , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + СтруктураТовара.Вставить("offer_id" , "143210609"); + СтруктураТовара.Вставить("barcode" , "112772873170"); + СтруктураТовара.Вставить("price" , "1300"); + СтруктураТовара.Вставить("old_price" , "1300"); + СтруктураТовара.Вставить("vat" , "0.1"); + СтруктураТовара.Вставить("height" , 250); + СтруктураТовара.Вставить("width" , 150); + СтруктураТовара.Вставить("depth" , 10); + СтруктураТовара.Вставить("dimension_unit" , "mm"); + СтруктураТовара.Вставить("weight" , 100); + СтруктураТовара.Вставить("weight_unit" , "g"); + СтруктураТовара.Вставить("images" , МассивКартинок); + + // Видео + + OPI_Ozon.ДобавитьВидеоТовара(СтруктураТовара, Видео, "viedo1"); + + // Атрибуты, индивидуальные для разных категорий + + АтрибутКатегории1 = Новый Структура("dictionary_value_id,value", 971082156, "Стойка для акустической системы"); + АтрибутКатегории2 = Новый Структура("dictionary_value_id,value", 5060050 , "Samsung"); + АтрибутКатегории3 = Новый Структура("dictionary_value_id,value", 61576 , "серый"); + АтрибутКатегории4 = Новый Структура("dictionary_value_id,value", 95911 , "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + + АтрибутКатегории5 = Новый Структура("value", "Комплект защитных плёнок для X3 NFC. Темный хлопок"); + + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 5076 , 0, АтрибутКатегории1); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 85 , 0, АтрибутКатегории2); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 10096, 0, АтрибутКатегории3); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 8229 , 0, АтрибутКатегории4); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураТовара, 9048 , 0, АтрибутКатегории5); + + Результат = OPI_Ozon.СоздатьОбновитьТовары(IDКлиента, КлючAPI, СтруктураТовара); +``` + + + + +```json title="Результат" +{ + "result": { + "task_id": 1346453806 + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.md deleted file mode 100644 index 5eb329eac2..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Удалить товары без SKU - Удаляет товары без SKU из архива - - - -`Функция УдалитьТоварыБезSKU(Знач IDКлиента, Знач КлючAPI, Знач Артикулы) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Артикулы | --articles | Строка, Число, Массив Из Строка, Число | Артикулы товаров | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Товар должен быть предварительно архивирован (см. АрхивироватьТовары) - - В одном запросе можно передать до 500 идентификаторов - - Метод в документации API: [post /v2/products/delete](https://docs.ozon.ru/api/seller/#operation/ProductAPI_DeleteProducts) -::: -
- - -```bsl title="Пример кода" - OPI_Инструменты.Пауза(30); - - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Результат = OPI_Ozon.АрхивироватьТовары(IDКлиента, КлючAPI, IDТовара); - - Артикул = "143210609"; - - Результат = OPI_Ozon.УдалитьТоварыБезSKU(IDКлиента, КлючAPI, Артикул); -``` - - - - -```json title="Результат" -{ - "status": [ - { - "offer_id": "143210609", - "is_deleted": true, - "error": "" - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.mdx new file mode 100644 index 0000000000..bf28c106bf --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Delete-products-without-sku.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Удалить товары без SKU + Удаляет товары без SKU из архива + + + +`Функция УдалитьТоварыБезSKU(Знач IDКлиента, Знач КлючAPI, Знач Артикулы) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Артикулы | --articles | Строка, Число, Массив Из Строка, Число | Артикулы товаров | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Товар должен быть предварительно архивирован (см. АрхивироватьТовары) + + В одном запросе можно передать до 500 идентификаторов + + Метод в документации API: [post /v2/products/delete](https://docs.ozon.ru/api/seller/#operation/ProductAPI_DeleteProducts) +::: +
+ + +```bsl title="Пример кода" + OPI_Инструменты.Пауза(30); + + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Результат = OPI_Ozon.АрхивироватьТовары(IDКлиента, КлючAPI, IDТовара); + + Артикул = "143210609"; + + Результат = OPI_Ozon.УдалитьТоварыБезSKU(IDКлиента, КлючAPI, Артикул); +``` + + + + +```json title="Результат" +{ + "status": [ + { + "offer_id": "143210609", + "is_deleted": true, + "error": "" + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.md deleted file mode 100644 index 024c0f40c1..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_position: 22 ---- - -# Получить структуру обновления характеристик - Получает структуру для обновления характеристик товара в функции ОбновитьХарактеристикиТоваров() - - - -`Функция ПолучитьСтруктуруОбновленияХарактеристик(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара - -
- -:::tip -Характеристики представляют из себя структуры с полями complex_id, id и массивом values. Для их быстрого создания есть метод ДополнитьКомплексныйАтрибут() -::: -
- - -```bsl title="Пример кода" - Результат = OPI_Ozon.ПолучитьСтруктуруОбновленияХарактеристик(); -``` - - - - -```json title="Результат" -{ - "offer_id": "<артикул>", - "attributes": "<массив обновляемых атрибутов>" -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.mdx new file mode 100644 index 0000000000..c5559b4d87 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-attributes-update-structure.mdx @@ -0,0 +1,42 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 22 +--- + +# Получить структуру обновления характеристик + Получает структуру для обновления характеристик товара в функции ОбновитьХарактеристикиТоваров() + + + +`Функция ПолучитьСтруктуруОбновленияХарактеристик(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара + +
+ +:::tip +Характеристики представляют из себя структуры с полями complex_id, id и массивом values. Для их быстрого создания есть метод ДополнитьКомплексныйАтрибут() +::: +
+ + +```bsl title="Пример кода" + Результат = OPI_Ozon.ПолучитьСтруктуруОбновленияХарактеристик(); +``` + + + + +```json title="Результат" +{ + "offer_id": "<артикул>", + "attributes": "<массив обновляемых атрибутов>" +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.md deleted file mode 100644 index 933a4415ec..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 19 ---- - -# Получить статус добавления кодов - Получает статус добавления кодов цифрового товара по ID задачи - - - -`Функция ПолучитьСтатусДобавленияКодов(Знач IDКлиента, Знач КлючAPI, Знач IDЗадачи) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDЗадачи | --taskid | Строка, Число | ID задачи добавления товара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/upload_digital_codes/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCodeInfo) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDЗадачи = "1"; - - Результат = OPI_Ozon.ПолучитьСтатусДобавленияКодов(IDКлиента, КлючAPI, IDЗадачи); -``` - - - - -```json title="Результат" -{ - "code": 7, - "message": "s2s: method \"/endpoints.v1.Service/GetDigitalCodesTaskByID\" is not allowed for the provided access tokens: permission denied", - "details": [] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.mdx new file mode 100644 index 0000000000..d9aa280959 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-codes-upload-status.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 19 +--- + +# Получить статус добавления кодов + Получает статус добавления кодов цифрового товара по ID задачи + + + +`Функция ПолучитьСтатусДобавленияКодов(Знач IDКлиента, Знач КлючAPI, Знач IDЗадачи) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDЗадачи | --taskid | Строка, Число | ID задачи добавления товара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/upload_digital_codes/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCodeInfo) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDЗадачи = "1"; + + Результат = OPI_Ozon.ПолучитьСтатусДобавленияКодов(IDКлиента, КлючAPI, IDЗадачи); +``` + + + + +```json title="Результат" +{ + "code": 7, + "message": "s2s: method \"/endpoints.v1.Service/GetDigitalCodesTaskByID\" is not allowed for the provided access tokens: permission denied", + "details": [] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.md deleted file mode 100644 index e0f7b23c71..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 18 ---- - -# Получить статус добавления товара - Получает статус добавления нового товара по ID задачи - - - -`Функция ПолучитьСтатусДобавленияТовара(Знач IDКлиента, Знач КлючAPI, Знач IDЗадачи) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDЗадачи | --taskid | Строка, Число | ID задачи добавления товара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/import/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetImportProductsInfo) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDЗадачи = "1352681806"; - - Результат = OPI_Ozon.ПолучитьСтатусДобавленияТовара(IDКлиента, КлючAPI, IDЗадачи); -``` - - - - -```json title="Результат" -{ - "result": { - "items": [ - { - "offer_id": "143210609", - "product_id": 1215208579, - "status": "imported", - "errors": [ - { - "code": "SELLER_NO_CONTRACT_FAILED", - "field": "", - "attribute_id": 0, - "state": "unmatched", - "level": "error", - "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", - "optional_description_elements": {}, - "attribute_name": "", - "message": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете." - } - ] - } - ], - "total": 1 - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.mdx new file mode 100644 index 0000000000..f90c28050d --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-creation-status.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 18 +--- + +# Получить статус добавления товара + Получает статус добавления нового товара по ID задачи + + + +`Функция ПолучитьСтатусДобавленияТовара(Знач IDКлиента, Знач КлючAPI, Знач IDЗадачи) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDЗадачи | --taskid | Строка, Число | ID задачи добавления товара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/import/info](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetImportProductsInfo) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDЗадачи = "1352681806"; + + Результат = OPI_Ozon.ПолучитьСтатусДобавленияТовара(IDКлиента, КлючAPI, IDЗадачи); +``` + + + + +```json title="Результат" +{ + "result": { + "items": [ + { + "offer_id": "143210609", + "product_id": 1215208579, + "status": "imported", + "errors": [ + { + "code": "SELLER_NO_CONTRACT_FAILED", + "field": "", + "attribute_id": 0, + "state": "unmatched", + "level": "error", + "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", + "optional_description_elements": {}, + "attribute_name": "", + "message": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете." + } + ] + } + ], + "total": 1 + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-description.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-description.md deleted file mode 100644 index 6dd5151995..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-description.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить описание товара - Получает описание товара по идентификаторам - - - -`Функция ПолучитьОписаниеТовара(Знач IDКлиента, Знач КлючAPI, Знач IDТовара = 0, Знач Артикул = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТовара | --productid | Строка, Число | Идентификатор товара | - | Артикул | --offerid | Строка, Число | Идентификатор товара в системе продавца (Артикул) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/info/description](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDescription) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - Артикул = "143210609"; - - Результат = OPI_Ozon.ПолучитьОписаниеТовара(IDКлиента, КлючAPI, , Артикул); -``` - - - - -```json title="Результат" -{ - "result": { - "id": 1215208579, - "offer_id": "143210609", - "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", - "description": "" - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-description.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-description.mdx new file mode 100644 index 0000000000..2335749a23 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-description.mdx @@ -0,0 +1,53 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить описание товара + Получает описание товара по идентификаторам + + + +`Функция ПолучитьОписаниеТовара(Знач IDКлиента, Знач КлючAPI, Знач IDТовара = 0, Знач Артикул = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТовара | --productid | Строка, Число | Идентификатор товара | + | Артикул | --offerid | Строка, Число | Идентификатор товара в системе продавца (Артикул) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/info/description](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoDescription) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + Артикул = "143210609"; + + Результат = OPI_Ozon.ПолучитьОписаниеТовара(IDКлиента, КлючAPI, , Артикул); +``` + + + + +```json title="Результат" +{ + "result": { + "id": 1215208579, + "offer_id": "143210609", + "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", + "description": "" + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-list.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-list.md deleted file mode 100644 index f3a8f3a4d7..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-list.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список товаров - Получает список товаров с фильтром или без - - - -`Функция ПолучитьСписокТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | - | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - МассивID = Новый Массив; - МассивID.Добавить("143210609"); - - Фильтр = Новый Структура; - Фильтр.Вставить("visibility" , "ALL"); - Фильтр.Вставить("offer_id" , МассивID); - - Результат = OPI_Ozon.ПолучитьСписокТоваров(IDКлиента, КлючAPI, Фильтр); -``` - - - - -```json title="Результат" -{ - "result": { - "items": [ - { - "product_id": 1215208579, - "offer_id": "143210609", - "is_fbo_visible": false, - "is_fbs_visible": false, - "archived": false, - "is_discounted": false - } - ], - "total": 1, - "last_id": "WzEyMTUyMDg1NzksMTIxNTIwODU3OV0=" - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-list.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-list.mdx new file mode 100644 index 0000000000..8cd2d6f8af --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-list.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список товаров + Получает список товаров с фильтром или без + + + +`Функция ПолучитьСписокТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | + | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + МассивID = Новый Массив; + МассивID.Добавить("143210609"); + + Фильтр = Новый Структура; + Фильтр.Вставить("visibility" , "ALL"); + Фильтр.Вставить("offer_id" , МассивID); + + Результат = OPI_Ozon.ПолучитьСписокТоваров(IDКлиента, КлючAPI, Фильтр); +``` + + + + +```json title="Результат" +{ + "result": { + "items": [ + { + "product_id": 1215208579, + "offer_id": "143210609", + "is_fbo_visible": false, + "is_fbs_visible": false, + "archived": false, + "is_discounted": false + } + ], + "total": 1, + "last_id": "WzEyMTUyMDg1NzksMTIxNTIwODU3OV0=" + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-structure.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-structure.md deleted file mode 100644 index 687f4e826f..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Получить структуру товара - Получает структуру стандартных полей товара - - - -`Функция ПолучитьСтруктуруТовара(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара - -
- -:::tip -Эту структуру необходимо дополнить полями, зависящими от категории товара из ПолучитьХарактеристикиКатегории() - - Первая картинка в массиве картинок (поле images) будет основной -::: -
- - -```bsl title="Пример кода" - Результат = OPI_Ozon.ПолучитьСтруктуруТовара(); -``` - - - - -```json title="Результат" -{ - "description_category_id": "", - "name": "<имя товара>", - "offer_id": "<артикул>", - "barcode": "<штрихкод>", - "price": "<цена>", - "old_price": "<старая цена>", - "vat": "<ставка ндс, например 0.2>", - "height": "<высота>", - "width": "<ширина>", - "depth": "<глубина>", - "dimension_unit": "<единица измерения для размеров, например mm>", - "weight": "<вес>", - "weight_unit": "<единица измерения для веса, например g>", - "images": "<массив URL картинок товара>", - "images360": "<массив URL картинок 360>", - "color_image": "<маркетинговый цвет для картинок>" -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-structure.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-structure.mdx new file mode 100644 index 0000000000..f1fa36f112 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-structure.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 20 +--- + +# Получить структуру товара + Получает структуру стандартных полей товара + + + +`Функция ПолучитьСтруктуруТовара(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара + +
+ +:::tip +Эту структуру необходимо дополнить полями, зависящими от категории товара из ПолучитьХарактеристикиКатегории() + + Первая картинка в массиве картинок (поле images) будет основной +::: +
+ + +```bsl title="Пример кода" + Результат = OPI_Ozon.ПолучитьСтруктуруТовара(); +``` + + + + +```json title="Результат" +{ + "description_category_id": "", + "name": "<имя товара>", + "offer_id": "<артикул>", + "barcode": "<штрихкод>", + "price": "<цена>", + "old_price": "<старая цена>", + "vat": "<ставка ндс, например 0.2>", + "height": "<высота>", + "width": "<ширина>", + "depth": "<глубина>", + "dimension_unit": "<единица измерения для размеров, например mm>", + "weight": "<вес>", + "weight_unit": "<единица измерения для веса, например g>", + "images": "<массив URL картинок товара>", + "images360": "<массив URL картинок 360>", + "color_image": "<маркетинговый цвет для картинок>" +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.md deleted file mode 100644 index b08aa17b8f..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 16 ---- - -# Получить количество подписчиков товаров - Получает количество пользователей, которые нажали Узнать о поступлении на странице товара - - - -`Функция ПолучитьКоличествоПодписчиковТоваров(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/info/subscription](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoSubscription) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Результат = OPI_Ozon.ПолучитьКоличествоПодписчиковТоваров(IDКлиента, КлючAPI, SKU); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "sku": 1626044001, - "count": 1 - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.mdx new file mode 100644 index 0000000000..4fee0a8fab --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-product-subscribers-count.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 16 +--- + +# Получить количество подписчиков товаров + Получает количество пользователей, которые нажали Узнать о поступлении на странице товара + + + +`Функция ПолучитьКоличествоПодписчиковТоваров(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/info/subscription](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoSubscription) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Результат = OPI_Ozon.ПолучитьКоличествоПодписчиковТоваров(IDКлиента, КлючAPI, SKU); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "sku": 1626044001, + "count": 1 + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.md deleted file mode 100644 index 078e5e49bb..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить описания харакетристик товаров - Получает описания характеристик товаров с фильтром или без - - - -`Функция ПолучитьОписанияХарактеристикТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | - | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v3/products/info/attributes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductAttributesV3) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - МассивID = Новый Массив; - МассивID.Добавить("143210609"); - - Фильтр = Новый Структура; - Фильтр.Вставить("visibility", "ALL"); - Фильтр.Вставить("offer_id" , МассивID); - - Результат = OPI_Ozon.ПолучитьОписанияХарактеристикТоваров(IDКлиента, КлючAPI, Фильтр); -``` - - - - -```json title="Результат" -{ - "result": [ - { - "id": 1215208579, - "barcode": "", - "category_id": 0, - "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", - "offer_id": "143210609", - "height": 250, - "depth": 10, - "width": 150, - "dimension_unit": "mm", - "weight": 100, - "weight_unit": "g", - "images": [ - { - "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "default": false, - "index": 1 - }, - { - "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "default": false, - "index": 2 - } - ], - "image_group_id": "", - "images360": [], - "pdf_list": [], - "attributes": [ - { - "attribute_id": 85, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 5060050, - "value": "Samsung" - } - ] - }, - { - "attribute_id": 10096, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 61576, - "value": "красный" - } - ] - }, - { - "attribute_id": 8229, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 95911, - "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" - } - ] - }, - { - "attribute_id": 9048, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" - } - ] - }, - { - "attribute_id": 4180, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" - } - ] - }, - { - "attribute_id": 9024, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "143210609" - } - ] - }, - { - "attribute_id": 20900, - "complex_id": 0, - "values": [ - { - "dictionary_value_id": 0, - "value": "true" - } - ] - } - ], - "complex_attributes": [ - { - "attributes": [ - { - "attribute_id": 21837, - "complex_id": 100001, - "values": [ - { - "dictionary_value_id": 0, - "value": "viedo1" - } - ] - }, - { - "attribute_id": 21841, - "complex_id": 100001, - "values": [ - { - "dictionary_value_id": 0, - "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" - } - ] - } - ] - } - ], - "color_image": "", - "last_id": "", - "description_category_id": 17028922, - "type_id": 95911 - } - ], - "total": 1, - "last_id": "" -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.mdx new file mode 100644 index 0000000000..52f1b0847b --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-attributes-data.mdx @@ -0,0 +1,187 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить описания харакетристик товаров + Получает описания характеристик товаров с фильтром или без + + + +`Функция ПолучитьОписанияХарактеристикТоваров(Знач IDКлиента, Знач КлючAPI, Знач Фильтр = "", Знач IDПоследнего = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | Фильтр | --filter | Структура Из КлючИЗначение | Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров | + | IDПоследнего | --last | Строка, Число | ID последнего значения (last_id) из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v3/products/info/attributes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductAttributesV3) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + МассивID = Новый Массив; + МассивID.Добавить("143210609"); + + Фильтр = Новый Структура; + Фильтр.Вставить("visibility", "ALL"); + Фильтр.Вставить("offer_id" , МассивID); + + Результат = OPI_Ozon.ПолучитьОписанияХарактеристикТоваров(IDКлиента, КлючAPI, Фильтр); +``` + + + + +```json title="Результат" +{ + "result": [ + { + "id": 1215208579, + "barcode": "", + "category_id": 0, + "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", + "offer_id": "143210609", + "height": 250, + "depth": 10, + "width": 150, + "dimension_unit": "mm", + "weight": 100, + "weight_unit": "g", + "images": [ + { + "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "default": false, + "index": 1 + }, + { + "file_name": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "default": false, + "index": 2 + } + ], + "image_group_id": "", + "images360": [], + "pdf_list": [], + "attributes": [ + { + "attribute_id": 85, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 5060050, + "value": "Samsung" + } + ] + }, + { + "attribute_id": 10096, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 61576, + "value": "красный" + } + ] + }, + { + "attribute_id": 8229, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 95911, + "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" + } + ] + }, + { + "attribute_id": 9048, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" + } + ] + }, + { + "attribute_id": 4180, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "Комплект защитных плёнок для X3 NFC. Темный хлопок" + } + ] + }, + { + "attribute_id": 9024, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "143210609" + } + ] + }, + { + "attribute_id": 20900, + "complex_id": 0, + "values": [ + { + "dictionary_value_id": 0, + "value": "true" + } + ] + } + ], + "complex_attributes": [ + { + "attributes": [ + { + "attribute_id": 21837, + "complex_id": 100001, + "values": [ + { + "dictionary_value_id": 0, + "value": "viedo1" + } + ] + }, + { + "attribute_id": 21841, + "complex_id": 100001, + "values": [ + { + "dictionary_value_id": 0, + "value": "https://rutube.ru/video/c6cc4d620b1d4338901770a44b3e82f4/" + } + ] + } + ] + } + ], + "color_image": "", + "last_id": "", + "description_category_id": 17028922, + "type_id": 95911 + } + ], + "total": 1, + "last_id": "" +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.md deleted file mode 100644 index 72d72e3eb9..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить контент рейтинг товаров - Получает контент рейтинг товаров по SKU - - - -`Функция ПолучитьКонтентРейтингТоваров(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/rating-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductRatingBySku) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Результат = OPI_Ozon.ПолучитьКонтентРейтингТоваров(IDКлиента, КлючAPI, SKU); -``` - - - - -```json title="Результат" -{ - "products": [ - { - "sku": 1626044001, - "rating": 70, - "groups": [ - { - "key": "important_attributes", - "name": "Важные атрибуты", - "rating": 100, - "weight": 30, - "conditions": [ - { - "key": "important_2", - "description": "Заполнено 2 атрибута и более", - "fulfilled": true, - "cost": 50 - }, - { - "key": "important_50_percent", - "description": "Заполнено более 50% атрибутов", - "fulfilled": true, - "cost": 25 - }, - { - "key": "important_70_percent", - "description": "Заполнено более 70% атрибутов", - "fulfilled": true, - "cost": 25 - } - ], - "improve_attributes": [], - "improve_at_least": 0 - }, - { - "key": "other_attributes", - "name": "Остальные атрибуты", - "rating": 100, - "weight": 25, - "conditions": [ - { - "key": "other_2", - "description": "Заполнено 2 атрибута и более", - "fulfilled": true, - "cost": 50 - }, - { - "key": "other_50_percent", - "description": "Заполнено более 50% атрибутов", - "fulfilled": true, - "cost": 50 - } - ], - "improve_attributes": [], - "improve_at_least": 0 - }, - { - "key": "text", - "name": "Текстовое описание", - "rating": 50, - "weight": 20, - "conditions": [ - { - "key": "text_annotation_100_chars", - "description": "Аннотация более 100 знаков", - "fulfilled": true, - "cost": 25 - }, - { - "key": "text_annotation_500_chars", - "description": "Аннотация более 500 знаков", - "fulfilled": true, - "cost": 25 - }, - { - "key": "text_rich", - "description": "Заполнен Rich-контент", - "fulfilled": false, - "cost": 100 - } - ], - "improve_attributes": [ - { - "id": 11254, - "name": "Rich-контент JSON" - } - ], - "improve_at_least": 1 - }, - { - "key": "media", - "name": "Медиа", - "rating": 20, - "weight": 25, - "conditions": [ - { - "key": "media_video_cover", - "description": "Добавлена видеообложка", - "fulfilled": false, - "cost": 50 - }, - { - "key": "media_video", - "description": "Добавлено видео", - "fulfilled": false, - "cost": 30 - }, - { - "key": "media_images_3", - "description": "Добавлено 3 изображения и более", - "fulfilled": true, - "cost": 20 - } - ], - "improve_attributes": [ - { - "id": 21841, - "name": "Озон.Видео: ссылка" - }, - { - "id": 21845, - "name": "Озон.Видеообложка: ссылка" - } - ], - "improve_at_least": 2 - } - ] - } - ] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.mdx new file mode 100644 index 0000000000..df831aade7 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-content-rating.mdx @@ -0,0 +1,174 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить контент рейтинг товаров + Получает контент рейтинг товаров по SKU + + + +`Функция ПолучитьКонтентРейтингТоваров(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/rating-by-sku](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductRatingBySku) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Результат = OPI_Ozon.ПолучитьКонтентРейтингТоваров(IDКлиента, КлючAPI, SKU); +``` + + + + +```json title="Результат" +{ + "products": [ + { + "sku": 1626044001, + "rating": 70, + "groups": [ + { + "key": "important_attributes", + "name": "Важные атрибуты", + "rating": 100, + "weight": 30, + "conditions": [ + { + "key": "important_2", + "description": "Заполнено 2 атрибута и более", + "fulfilled": true, + "cost": 50 + }, + { + "key": "important_50_percent", + "description": "Заполнено более 50% атрибутов", + "fulfilled": true, + "cost": 25 + }, + { + "key": "important_70_percent", + "description": "Заполнено более 70% атрибутов", + "fulfilled": true, + "cost": 25 + } + ], + "improve_attributes": [], + "improve_at_least": 0 + }, + { + "key": "other_attributes", + "name": "Остальные атрибуты", + "rating": 100, + "weight": 25, + "conditions": [ + { + "key": "other_2", + "description": "Заполнено 2 атрибута и более", + "fulfilled": true, + "cost": 50 + }, + { + "key": "other_50_percent", + "description": "Заполнено более 50% атрибутов", + "fulfilled": true, + "cost": 50 + } + ], + "improve_attributes": [], + "improve_at_least": 0 + }, + { + "key": "text", + "name": "Текстовое описание", + "rating": 50, + "weight": 20, + "conditions": [ + { + "key": "text_annotation_100_chars", + "description": "Аннотация более 100 знаков", + "fulfilled": true, + "cost": 25 + }, + { + "key": "text_annotation_500_chars", + "description": "Аннотация более 500 знаков", + "fulfilled": true, + "cost": 25 + }, + { + "key": "text_rich", + "description": "Заполнен Rich-контент", + "fulfilled": false, + "cost": 100 + } + ], + "improve_attributes": [ + { + "id": 11254, + "name": "Rich-контент JSON" + } + ], + "improve_at_least": 1 + }, + { + "key": "media", + "name": "Медиа", + "rating": 20, + "weight": 25, + "conditions": [ + { + "key": "media_video_cover", + "description": "Добавлена видеообложка", + "fulfilled": false, + "cost": 50 + }, + { + "key": "media_video", + "description": "Добавлено видео", + "fulfilled": false, + "cost": 30 + }, + { + "key": "media_images_3", + "description": "Добавлено 3 изображения и более", + "fulfilled": true, + "cost": 20 + } + ], + "improve_attributes": [ + { + "id": 21841, + "name": "Озон.Видео: ссылка" + }, + { + "id": 21845, + "name": "Озон.Видеообложка: ссылка" + } + ], + "improve_at_least": 2 + } + ] + } + ] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.md deleted file mode 100644 index 5f06c07196..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 23 ---- - -# Получить структуру фильтра товаров - Получает структуру для отбора списка товаров - - - -`Функция ПолучитьСтруктуруФильтраТоваров(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей фильра - -
- -:::tip -Связанные функции: ПолучитьСписокТоваров, ПолучитьКоличествоТоваров, ПолучитьЦеныТоваров - - Описание полей фильтра можно найти на странице документации по получению списка товаров: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) -::: -
- - -```bsl title="Пример кода" - Результат = OPI_Ozon.ПолучитьСтруктуруФильтраТоваров(); -``` - - - - -```json title="Результат" -{ - "offer_id": "<массив артикулов>", - "product_id": "<массив ID товаров>", - "visibility": "<видимость>" -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.mdx new file mode 100644 index 0000000000..5ec141d302 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-filter-structure.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 23 +--- + +# Получить структуру фильтра товаров + Получает структуру для отбора списка товаров + + + +`Функция ПолучитьСтруктуруФильтраТоваров(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей фильра + +
+ +:::tip +Связанные функции: ПолучитьСписокТоваров, ПолучитьКоличествоТоваров, ПолучитьЦеныТоваров + + Описание полей фильтра можно найти на странице документации по получению списка товаров: [post /v2/product/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductList) +::: +
+ + +```bsl title="Пример кода" + Результат = OPI_Ozon.ПолучитьСтруктуруФильтраТоваров(); +``` + + + + +```json title="Результат" +{ + "offer_id": "<массив артикулов>", + "product_id": "<массив ID товаров>", + "visibility": "<видимость>" +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-information.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-information.md deleted file mode 100644 index 09b41637ea..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-information.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию о товарах - Получает информацию о товарах по массиву идентификаторов - - - -`Функция ПолучитьИнформациюОТоварах(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров = 0, Знач SKU = 0, Знач Артикулы = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТоваров | --productid | Число, Массив Из Число | Идентификаторы товаров | - | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | - | Артикулы | --offerid | Строка, Массив Из Строка | Идентификаторы товаров в системе продавца (Артикул) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Уточняйте минимальную цену товара после применения всех акций в личном кабинете. Параметр min_price из ответа метода на доработке и возвращает 0 - - Параметр active_product устарел, используйте значения параметра visible - - Параметры fbs_sku и fbo_sku из ответа метода были отключены 15 августа 2023 года - - В теле запроса должен быть один идентификатор или массив однотипных идентификаторов, в ответе будет массив items - - Метод в документации API: [post /v2/product/info/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoListV2) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - Артикул = "143210609"; - - Результат = OPI_Ozon.ПолучитьИнформациюОТоварах(IDКлиента, КлючAPI, , , Артикул); -``` - - - - -```json title="Результат" -{ - "result": { - "items": [ - { - "id": 1215208579, - "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", - "offer_id": "143210609", - "barcode": "", - "buybox_price": "", - "category_id": 0, - "created_at": "2024-10-08T17:54:16.435862Z", - "images": [ - "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" - ], - "marketing_price": "", - "min_ozon_price": "", - "old_price": "1300.0000", - "premium_price": "", - "price": "1300.0000", - "recommended_price": "", - "min_price": "", - "sources": [], - "stocks": { - "coming": 0, - "present": 0, - "reserved": 0 - }, - "errors": [], - "vat": "0.100000", - "visible": false, - "visibility_details": { - "has_price": false, - "has_stock": false, - "active_product": false, - "reasons": {} - }, - "price_index": "0.00", - "images360": [], - "color_image": "", - "primary_image": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "status": { - "state": "imported", - "state_failed": "unmatched", - "moderate_status": "", - "decline_reasons": [], - "validation_state": "pending", - "state_name": "Не продается", - "state_description": "Не создан", - "is_failed": true, - "is_created": false, - "state_tooltip": "Не прошел валидацию", - "item_errors": [ - { - "code": "SELLER_NO_CONTRACT_FAILED", - "field": "", - "attribute_id": 0, - "state": "unmatched", - "level": "error", - "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", - "optional_description_elements": {}, - "attribute_name": "" - } - ], - "state_updated_at": "2024-10-08T17:55:03.678263Z" - }, - "state": "", - "service_type": "IS_CODE_SERVICE", - "fbo_sku": 0, - "fbs_sku": 0, - "currency_code": "RUB", - "is_kgt": false, - "rating": "", - "discounted_stocks": { - "coming": 0, - "present": 0, - "reserved": 0 - }, - "is_discounted": false, - "has_discounted_item": false, - "barcodes": [], - "updated_at": "2024-10-08T17:54:58.950158Z", - "price_indexes": { - "price_index": "WITHOUT_INDEX", - "external_index_data": null, - "ozon_index_data": null, - "self_marketplaces_index_data": null - }, - "sku": 0, - "description_category_id": 17028922, - "type_id": 95911, - "is_archived": false, - "is_autoarchived": false - } - ] - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-information.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-information.mdx new file mode 100644 index 0000000000..e56cfffaba --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-products-information.mdx @@ -0,0 +1,150 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить информацию о товарах + Получает информацию о товарах по массиву идентификаторов + + + +`Функция ПолучитьИнформациюОТоварах(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров = 0, Знач SKU = 0, Знач Артикулы = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТоваров | --productid | Число, Массив Из Число | Идентификаторы товаров | + | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | + | Артикулы | --offerid | Строка, Массив Из Строка | Идентификаторы товаров в системе продавца (Артикул) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Уточняйте минимальную цену товара после применения всех акций в личном кабинете. Параметр min_price из ответа метода на доработке и возвращает 0 + + Параметр active_product устарел, используйте значения параметра visible + + Параметры fbs_sku и fbo_sku из ответа метода были отключены 15 августа 2023 года + + В теле запроса должен быть один идентификатор или массив однотипных идентификаторов, в ответе будет массив items + + Метод в документации API: [post /v2/product/info/list](https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoListV2) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + Артикул = "143210609"; + + Результат = OPI_Ozon.ПолучитьИнформациюОТоварах(IDКлиента, КлючAPI, , , Артикул); +``` + + + + +```json title="Результат" +{ + "result": { + "items": [ + { + "id": 1215208579, + "name": "Комплект защитных плёнок для X3 NFC. Темный хлопок", + "offer_id": "143210609", + "barcode": "", + "buybox_price": "", + "category_id": 0, + "created_at": "2024-10-08T17:54:16.435862Z", + "images": [ + "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg" + ], + "marketing_price": "", + "min_ozon_price": "", + "old_price": "1300.0000", + "premium_price": "", + "price": "1300.0000", + "recommended_price": "", + "min_price": "", + "sources": [], + "stocks": { + "coming": 0, + "present": 0, + "reserved": 0 + }, + "errors": [], + "vat": "0.100000", + "visible": false, + "visibility_details": { + "has_price": false, + "has_stock": false, + "active_product": false, + "reasons": {} + }, + "price_index": "0.00", + "images360": [], + "color_image": "", + "primary_image": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "status": { + "state": "imported", + "state_failed": "unmatched", + "moderate_status": "", + "decline_reasons": [], + "validation_state": "pending", + "state_name": "Не продается", + "state_description": "Не создан", + "is_failed": true, + "is_created": false, + "state_tooltip": "Не прошел валидацию", + "item_errors": [ + { + "code": "SELLER_NO_CONTRACT_FAILED", + "field": "", + "attribute_id": 0, + "state": "unmatched", + "level": "error", + "description": "Истек срок договора. Чтобы загрузить товар, возобновите договор в личном кабинете.", + "optional_description_elements": {}, + "attribute_name": "" + } + ], + "state_updated_at": "2024-10-08T17:55:03.678263Z" + }, + "state": "", + "service_type": "IS_CODE_SERVICE", + "fbo_sku": 0, + "fbs_sku": 0, + "currency_code": "RUB", + "is_kgt": false, + "rating": "", + "discounted_stocks": { + "coming": 0, + "present": 0, + "reserved": 0 + }, + "is_discounted": false, + "has_discounted_item": false, + "barcodes": [], + "updated_at": "2024-10-08T17:54:58.950158Z", + "price_indexes": { + "price_index": "WITHOUT_INDEX", + "external_index_data": null, + "ozon_index_data": null, + "self_marketplaces_index_data": null + }, + "sku": 0, + "description_category_id": 17028922, + "type_id": 95911, + "is_archived": false, + "is_autoarchived": false + } + ] + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.md deleted file mode 100644 index 2c9bf53565..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 17 ---- - -# Получить связанные SKU - Получает единый SKU по старым идентификаторам SKU FBS и SKU FBO - - - -`Функция ПолучитьСвязанныеSKU(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -В ответе будут все SKU, связанные с переданными. Метод может обработать любые SKU, даже скрытые или удалённые. - - Передавайте до 200 SKU в одном запросе. - - Метод в документации API: [post /v1/product/related-sku/get](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductGetRelatedSKU) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - SKU = 1626044001; - - Результат = OPI_Ozon.ПолучитьСвязанныеSKU(IDКлиента, КлючAPI, SKU); -``` - - - - -```json title="Результат" -{ - "items": [ - { - "delivery_schema": "SDS", - "sku": 1626044001, - "product_id": 1108702494, - "availability": "AVAILABLE", - "deleted_at": null - } - ], - "errors": [] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.mdx new file mode 100644 index 0000000000..97f2e12936 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-related-sk-us.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 17 +--- + +# Получить связанные SKU + Получает единый SKU по старым идентификаторам SKU FBS и SKU FBO + + + +`Функция ПолучитьСвязанныеSKU(Знач IDКлиента, Знач КлючAPI, Знач SKU) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | SKU | --sku | Число, Массив Из Число | Идентификаторы товаров в системе Ozon (SKU) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +В ответе будут все SKU, связанные с переданными. Метод может обработать любые SKU, даже скрытые или удалённые. + + Передавайте до 200 SKU в одном запросе. + + Метод в документации API: [post /v1/product/related-sku/get](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductGetRelatedSKU) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + SKU = 1626044001; + + Результат = OPI_Ozon.ПолучитьСвязанныеSKU(IDКлиента, КлючAPI, SKU); +``` + + + + +```json title="Результат" +{ + "items": [ + { + "delivery_schema": "SDS", + "sku": 1626044001, + "product_id": 1108702494, + "availability": "AVAILABLE", + "deleted_at": null + } + ], + "errors": [] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.md deleted file mode 100644 index f5d4c568a9..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_position: 21 ---- - -# Получить сокращенную структуру товара - Получает структуру для создания товара на основе Ozon ID в функции СоздатьТоварыПоOzonID() - - - -`Функция ПолучитьСокращеннуюСтруктуруТовара(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара - -
- - - - -```bsl title="Пример кода" - Результат = OPI_Ozon.ПолучитьСокращеннуюСтруктуруТовара(); -``` - - - - -```json title="Результат" -{ - "name": "<наименование>", - "sku": "<идентификатор товара в системе Ozon>", - "offer_id": "<артикул>", - "price": "<цена>", - "old_price": "<старая цена>", - "vat": "<ставка ндс, например 0.2>", - "currency_code": "<валюта>" -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.mdx new file mode 100644 index 0000000000..2421698448 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Get-simplified-product-structure.mdx @@ -0,0 +1,44 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 21 +--- + +# Получить сокращенную структуру товара + Получает структуру для создания товара на основе Ozon ID в функции СоздатьТоварыПоOzonID() + + + +`Функция ПолучитьСокращеннуюСтруктуруТовара(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей товара + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_Ozon.ПолучитьСокращеннуюСтруктуруТовара(); +``` + + + + +```json title="Результат" +{ + "name": "<наименование>", + "sku": "<идентификатор товара в системе Ozon>", + "offer_id": "<артикул>", + "price": "<цена>", + "old_price": "<старая цена>", + "vat": "<ставка ндс, например 0.2>", + "currency_code": "<валюта>" +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Unarchive-products.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Unarchive-products.md deleted file mode 100644 index 5d716d0b87..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Unarchive-products.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Разархивировать товары - Возвращает выбранные товары из архива - - - -`Функция РазархивироватьТовары(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТоваров | --products | Строка, Число, Массив Из Строка, Число | ID товаров для восстановления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -В сутки можно восстановить из архива не больше 10 товаров, которые были архивированы автоматически. На разархивацию товаров, перенесённых в архив вручную, ограничений нет. - - Метод в документации API: [post /v1/product/unarchive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUnarchive) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Результат = OPI_Ozon.РазархивироватьТовары(IDКлиента, КлючAPI, IDТовара); -``` - - - - -```json title="Результат" -{ - "result": true -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Unarchive-products.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Unarchive-products.mdx new file mode 100644 index 0000000000..a4160b81e7 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Unarchive-products.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Разархивировать товары + Возвращает выбранные товары из архива + + + +`Функция РазархивироватьТовары(Знач IDКлиента, Знач КлючAPI, Знач IDТоваров) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТоваров | --products | Строка, Число, Массив Из Строка, Число | ID товаров для восстановления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +В сутки можно восстановить из архива не больше 10 товаров, которые были архивированы автоматически. На разархивацию товаров, перенесённых в архив вручную, ограничений нет. + + Метод в документации API: [post /v1/product/unarchive](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUnarchive) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Результат = OPI_Ozon.РазархивироватьТовары(IDКлиента, КлючAPI, IDТовара); +``` + + + + +```json title="Результат" +{ + "result": true +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-product-images.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-product-images.md deleted file mode 100644 index c516431a66..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-product-images.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Обновить изображения товара - Обновляет изображения и маркетинговый цвет товара - - - -`Функция ОбновитьИзображенияТовара(Знач IDКлиента, Знач КлючAPI, Знач IDТовара, Знач МассивИзображений = "", Знач Массив360 = "", Знач МаркетинговыйЦвет = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТовара | --productid | Строка, Число | Идентификатор товара | - | МассивИзображений | --images | Массив Из Строка | Массив URL изображений | - | Массив360 | --images360 | Массив Из Строка | Массив изображений 360 | - | МаркетинговыйЦвет | --color | Строка | Маркетинговый цвет | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -При каждом вызове метода передавайте все изображения, которые должны быть на карточке товара - - Для загрузки передайте адрес ссылки на изображение в общедоступном облачном хранилище. Формат изображения по ссылке: JPG или PNG - - Если вы хотите изменить состав или порядок изображений, получите информацию с помощью метода ПолучитьИнформациюОТоваре(), скопируйте данные полей images, images360, color_image, измените и дополните состав или порядок в соответствии с необходимостью - - Метод в документации API: [post /v1/product/pictures/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductImportPictures) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; - - МаркетинговыйЦвет = "GREEN"; - - МассивИзображений = Новый Массив; - МассивИзображений.Добавить(Картинка1); - МассивИзображений.Добавить(Картинка2); - - Результат = OPI_Ozon.ОбновитьИзображенияТовара(IDКлиента - , КлючAPI - , IDТовара - , МассивИзображений - , - , МаркетинговыйЦвет); -``` - - - - -```json title="Результат" -{ - "result": { - "pictures": [ - { - "product_id": 1215208579, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "state": "imported", - "is_primary": true, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215208579, - "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": false - }, - { - "product_id": 1215208579, - "url": "GREEN", - "state": "imported", - "is_primary": false, - "is_360": false, - "is_color": true - } - ] - } -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-product-images.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-product-images.mdx new file mode 100644 index 0000000000..9d9f93e43a --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-product-images.mdx @@ -0,0 +1,97 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Обновить изображения товара + Обновляет изображения и маркетинговый цвет товара + + + +`Функция ОбновитьИзображенияТовара(Знач IDКлиента, Знач КлючAPI, Знач IDТовара, Знач МассивИзображений = "", Знач Массив360 = "", Знач МаркетинговыйЦвет = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТовара | --productid | Строка, Число | Идентификатор товара | + | МассивИзображений | --images | Массив Из Строка | Массив URL изображений | + | Массив360 | --images360 | Массив Из Строка | Массив изображений 360 | + | МаркетинговыйЦвет | --color | Строка | Маркетинговый цвет | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +При каждом вызове метода передавайте все изображения, которые должны быть на карточке товара + + Для загрузки передайте адрес ссылки на изображение в общедоступном облачном хранилище. Формат изображения по ссылке: JPG или PNG + + Если вы хотите изменить состав или порядок изображений, получите информацию с помощью метода ПолучитьИнформациюОТоваре(), скопируйте данные полей images, images360, color_image, измените и дополните состав или порядок в соответствии с необходимостью + + Метод в документации API: [post /v1/product/pictures/import](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductImportPictures) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; + + МаркетинговыйЦвет = "GREEN"; + + МассивИзображений = Новый Массив; + МассивИзображений.Добавить(Картинка1); + МассивИзображений.Добавить(Картинка2); + + Результат = OPI_Ozon.ОбновитьИзображенияТовара(IDКлиента + , КлючAPI + , IDТовара + , МассивИзображений + , + , МаркетинговыйЦвет); +``` + + + + +```json title="Результат" +{ + "result": { + "pictures": [ + { + "product_id": 1215208579, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "state": "imported", + "is_primary": true, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215208579, + "url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": false + }, + { + "product_id": 1215208579, + "url": "GREEN", + "state": "imported", + "is_primary": false, + "is_360": false, + "is_color": true + } + ] + } +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-articles.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-articles.md deleted file mode 100644 index 0b41450e8e..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-articles.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Изменить артикулы товаров - Изменяет артикулы существующих товаров - - - -`Функция ИзменитьАртикулыТоваров(Знач IDКлиента, Знач КлючAPI, Знач СоответствиеАртикулов) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | СоответствиеАртикулов | --offers | Соответствие Из КлючИЗначение | Артикулы: Ключ > старый, Значение > новый | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/product/update/offer-id](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateOfferID) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - СоответствиеАртикулов = Новый Соответствие; - СоответствиеАртикулов.Вставить("143210609", "143210612"); - - Результат = OPI_Ozon.ИзменитьАртикулыТоваров(IDКлиента, КлючAPI, СоответствиеАртикулов); -``` - - - - -```json title="Результат" -{ - "errors": [] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-articles.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-articles.mdx new file mode 100644 index 0000000000..11ad6938b8 --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-articles.mdx @@ -0,0 +1,49 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Изменить артикулы товаров + Изменяет артикулы существующих товаров + + + +`Функция ИзменитьАртикулыТоваров(Знач IDКлиента, Знач КлючAPI, Знач СоответствиеАртикулов) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | СоответствиеАртикулов | --offers | Соответствие Из КлючИЗначение | Артикулы: Ключ > старый, Значение > новый | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/product/update/offer-id](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateOfferID) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + СоответствиеАртикулов = Новый Соответствие; + СоответствиеАртикулов.Вставить("143210609", "143210612"); + + Результат = OPI_Ozon.ИзменитьАртикулыТоваров(IDКлиента, КлючAPI, СоответствиеАртикулов); +``` + + + + +```json title="Результат" +{ + "errors": [] +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-attributes.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-attributes.md deleted file mode 100644 index ca29b62cfd..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-attributes.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Обновить характеристики товаров - Обновляет характеристики выбранных товаров - - - -`Функция ОбновитьХарактеристикиТоваров(Знач IDКлиента, Знач КлючAPI, Знач МассивХарактеристик) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | МассивХарактеристик | --items | Массив Из Строка | Массив или одна структура полей атрибутов товара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Получить пустую структуру можно при помощи метода ПолучитьСтруктуруОбновленияХарактеристик() - - Метод в документации API: [post /v1/product/attributes/update](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateAttributes) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - СтруктураХаракетристик = Новый Структура("offer_id", "143210609"); - - АтрибутКатегории1 = Новый Структура("dictionary_value_id,value", 971082156, "Стойка для акустической системы"); - АтрибутКатегории2 = Новый Структура("dictionary_value_id,value", 5060050 , "Samsung"); - АтрибутКатегории3 = Новый Структура("dictionary_value_id,value", 61576 , "красный"); - - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураХаракетристик, 5076 , 0, АтрибутКатегории1); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураХаракетристик, 85 , 0, АтрибутКатегории2); - OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураХаракетристик, 10096, 0, АтрибутКатегории3); - - Результат = OPI_Ozon.ОбновитьХарактеристикиТоваров(IDКлиента, КлючAPI, СтруктураХаракетристик); -``` - - - - -```json title="Результат" -{ - "task_id": 1346454270 -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-attributes.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-attributes.mdx new file mode 100644 index 0000000000..7f306bbbbd --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Update-products-attributes.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Обновить характеристики товаров + Обновляет характеристики выбранных товаров + + + +`Функция ОбновитьХарактеристикиТоваров(Знач IDКлиента, Знач КлючAPI, Знач МассивХарактеристик) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | МассивХарактеристик | --items | Массив Из Строка | Массив или одна структура полей атрибутов товара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Получить пустую структуру можно при помощи метода ПолучитьСтруктуруОбновленияХарактеристик() + + Метод в документации API: [post /v1/product/attributes/update](https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductUpdateAttributes) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + СтруктураХаракетристик = Новый Структура("offer_id", "143210609"); + + АтрибутКатегории1 = Новый Структура("dictionary_value_id,value", 971082156, "Стойка для акустической системы"); + АтрибутКатегории2 = Новый Структура("dictionary_value_id,value", 5060050 , "Samsung"); + АтрибутКатегории3 = Новый Структура("dictionary_value_id,value", 61576 , "красный"); + + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураХаракетристик, 5076 , 0, АтрибутКатегории1); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураХаракетристик, 85 , 0, АтрибутКатегории2); + OPI_Ozon.ДополнитьКомплексныйАтрибут(СтруктураХаракетристик, 10096, 0, АтрибутКатегории3); + + Результат = OPI_Ozon.ОбновитьХарактеристикиТоваров(IDКлиента, КлючAPI, СтруктураХаракетристик); +``` + + + + +```json title="Результат" +{ + "task_id": 1346454270 +} +``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.md b/docs/ru/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.md deleted file mode 100644 index ca2dd95609..0000000000 --- a/docs/ru/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 15 ---- - -# Загрузить коды активации товара - Загружает коды активации для цифрового товара или услуги - - - -`Функция ЗагрузитьКодыАктивацииТовара(Знач IDКлиента, Знач КлючAPI, Знач IDТовара, Знач Коды) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - | IDТовара | --productid | Число | ID товара | - | Коды | --codes | Строка, Массив Из Строка | Коды активации цифрового товара | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Код активации привязывается к карточке цифрового товара - - Метод проверки статуса добавления - ПолучитьСтатусДобавленияКодов() - - Метод в документации API: [post /v1/product/upload_digital_codes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCode) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - IDТовара = "1220696576"; - - Коды = Новый Массив; - Коды.Добавить("11111111"); - Коды.Добавить("22222222"); - - Результат = OPI_Ozon.ЗагрузитьКодыАктивацииТовара(IDКлиента, КлючAPI, IDТовара, Коды); -``` - - - - -```json title="Результат" -{ - "code": 7, - "message": "s2s: method \"/endpoints.v1.Service/UploadDigitalCodes\" is not allowed for the provided access tokens: permission denied", - "details": [] -} -``` diff --git a/docs/ru/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.mdx b/docs/ru/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.mdx new file mode 100644 index 0000000000..f570335a0b --- /dev/null +++ b/docs/ru/md/Ozon/Uploading-and-updating-products/Upload-product-activation-codes.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 15 +--- + +# Загрузить коды активации товара + Загружает коды активации для цифрового товара или услуги + + + +`Функция ЗагрузитьКодыАктивацииТовара(Знач IDКлиента, Знач КлючAPI, Знач IDТовара, Знач Коды) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + | IDТовара | --productid | Число | ID товара | + | Коды | --codes | Строка, Массив Из Строка | Коды активации цифрового товара | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Код активации привязывается к карточке цифрового товара + + Метод проверки статуса добавления - ПолучитьСтатусДобавленияКодов() + + Метод в документации API: [post /v1/product/upload_digital_codes](https://docs.ozon.ru/api/seller/#operation/ProductAPI_UploadDigitalCode) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + IDТовара = "1220696576"; + + Коды = Новый Массив; + Коды.Добавить("11111111"); + Коды.Добавить("22222222"); + + Результат = OPI_Ozon.ЗагрузитьКодыАктивацииТовара(IDКлиента, КлючAPI, IDТовара, Коды); +``` + + + + +```json title="Результат" +{ + "code": 7, + "message": "s2s: method \"/endpoints.v1.Service/UploadDigitalCodes\" is not allowed for the provided access tokens: permission denied", + "details": [] +} +``` diff --git a/docs/ru/md/Ozon/Warehouses-managment/Get-warehouses-list.md b/docs/ru/md/Ozon/Warehouses-managment/Get-warehouses-list.md deleted file mode 100644 index a136ceef31..0000000000 --- a/docs/ru/md/Ozon/Warehouses-managment/Get-warehouses-list.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список складов - Получает список складов компании - - - -`Функция ПолучитьСписокСкладов(Знач IDКлиента, Знач КлючAPI) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКлиента | --clientid | Строка | Идентификатор клиента | - | КлючAPI | --apikey | Строка | API ключ | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API - -
- -:::tip -Метод в документации API: [post /v1/warehouse/list](https://docs.ozon.ru/api/seller/#operation/WarehouseAPI_WarehouseList) -::: -
- - -```bsl title="Пример кода" - IDКлиента = "2128753"; - КлючAPI = "7cc90d26-33e4-499b..."; - - Результат = OPI_Ozon.ПолучитьСписокСкладов(IDКлиента, КлючAPI); -``` - - - - -```json title="Результат" -{ - "result": [] -} -``` diff --git a/docs/ru/md/Ozon/Warehouses-managment/Get-warehouses-list.mdx b/docs/ru/md/Ozon/Warehouses-managment/Get-warehouses-list.mdx new file mode 100644 index 0000000000..81202d9c92 --- /dev/null +++ b/docs/ru/md/Ozon/Warehouses-managment/Get-warehouses-list.mdx @@ -0,0 +1,45 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список складов + Получает список складов компании + + + +`Функция ПолучитьСписокСкладов(Знач IDКлиента, Знач КлючAPI) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКлиента | --clientid | Строка | Идентификатор клиента | + | КлючAPI | --apikey | Строка | API ключ | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Ozon Seller API + +
+ +:::tip +Метод в документации API: [post /v1/warehouse/list](https://docs.ozon.ru/api/seller/#operation/WarehouseAPI_WarehouseList) +::: +
+ + +```bsl title="Пример кода" + IDКлиента = "2128753"; + КлючAPI = "7cc90d26-33e4-499b..."; + + Результат = OPI_Ozon.ПолучитьСписокСкладов(IDКлиента, КлючAPI); +``` + + + + +```json title="Результат" +{ + "result": [] +} +``` diff --git a/docs/ru/md/Slack/Block-formation/Generate-image-block.md b/docs/ru/md/Slack/Block-formation/Generate-image-block.md deleted file mode 100644 index bd29e5931f..0000000000 --- a/docs/ru/md/Slack/Block-formation/Generate-image-block.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Сформировать блок картинку - Формирует блок с картинкой для добавления в массив блоков сообщения - - - -`Функция СформироватьБлокКартинку(Знач URL, Знач АльтернативныйТекст = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --picture | Строка | URL картинки | - | АльтернативныйТекст | --alt | Строка | Альтернативный текст картинки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Блок картинки - -
- - - - -```bsl title="Пример кода" - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - - Результат = OPI_Slack.СформироватьБлокКартинку(Картинка, "Картинка"); -``` - - - - - - ```bash - oint slack СформироватьБлокКартинку --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --alt "Картинка" - ``` - - - - ```batch - oint slack СформироватьБлокКартинку ^ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --alt "Картинка" - ``` - - - - -```json title="Результат" -{ - "type": "image", - "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", - "alt_text": "Картинка" -} -``` diff --git a/docs/ru/md/Slack/Block-formation/Generate-image-block.mdx b/docs/ru/md/Slack/Block-formation/Generate-image-block.mdx new file mode 100644 index 0000000000..501fb76c41 --- /dev/null +++ b/docs/ru/md/Slack/Block-formation/Generate-image-block.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Сформировать блок картинку + Формирует блок с картинкой для добавления в массив блоков сообщения + + + +`Функция СформироватьБлокКартинку(Знач URL, Знач АльтернативныйТекст = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --picture | Строка | URL картинки | + | АльтернативныйТекст | --alt | Строка | Альтернативный текст картинки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Блок картинки + +
+ + + + +```bsl title="Пример кода" + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + + Результат = OPI_Slack.СформироватьБлокКартинку(Картинка, "Картинка"); +``` + + + + + + ```bash + oint slack СформироватьБлокКартинку --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --alt "Картинка" + ``` + + + + ```batch + oint slack СформироватьБлокКартинку ^ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --alt "Картинка" + ``` + + + + +```json title="Результат" +{ + "type": "image", + "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg", + "alt_text": "Картинка" +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Archive-channel.md b/docs/ru/md/Slack/Channel-management/Archive-channel.md deleted file mode 100644 index 5815445d38..0000000000 --- a/docs/ru/md/Slack/Channel-management/Archive-channel.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Архивировать канал - Архивирует активный канал - - - -`Функция АрхивироватьКанал(Знач Токен, Знач Канал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - - Результат = OPI_Slack.АрхивироватьКанал(Токен, Канал); -``` - - - - - - ```bash - oint slack АрхивироватьКанал --token "***" \ - --channel "C07SJFNT9SL" - ``` - - - - ```batch - oint slack АрхивироватьКанал ^ - --token "***" ^ - --channel "C07SJFNT9SL" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Archive-channel.mdx b/docs/ru/md/Slack/Channel-management/Archive-channel.mdx new file mode 100644 index 0000000000..49ad69f6a0 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Archive-channel.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Архивировать канал + Архивирует активный канал + + + +`Функция АрхивироватьКанал(Знач Токен, Знач Канал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + + Результат = OPI_Slack.АрхивироватьКанал(Токен, Канал); +``` + + + + + + ```bash + oint slack АрхивироватьКанал --token "***" \ + --channel "C07SJFNT9SL" + ``` + + + + ```batch + oint slack АрхивироватьКанал ^ + --token "***" ^ + --channel "C07SJFNT9SL" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Create-channel.md b/docs/ru/md/Slack/Channel-management/Create-channel.md deleted file mode 100644 index a83be4bcf3..0000000000 --- a/docs/ru/md/Slack/Channel-management/Create-channel.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать канал - Создает новый канал - - - -`Функция СоздатьКанал(Знач Токен, Знач Название, Знач Приватный = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Название | --title | Строка | Наименование канала | - | Приватный | --private | Булево | Создать канал приватным | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Имя = "testconv" + Строка(Новый УникальныйИдентификатор); - - Результат = OPI_Slack.СоздатьКанал(Токен, Имя); -``` - - - - - - ```bash - oint slack СоздатьКанал --token "***" \ - --title "testconv9d2a1472-7419-436a-a418-a8a70d5b9ec3" \ - --private false - ``` - - - - ```batch - oint slack СоздатьКанал ^ - --token "***" ^ - --title "testconv9d2a1472-7419-436a-a418-a8a70d5b9ec3" ^ - --private false - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409452819, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "0000000000.000000", - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [], - "priority": 0 - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Create-channel.mdx b/docs/ru/md/Slack/Channel-management/Create-channel.mdx new file mode 100644 index 0000000000..a1e7a8df27 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Create-channel.mdx @@ -0,0 +1,103 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать канал + Создает новый канал + + + +`Функция СоздатьКанал(Знач Токен, Знач Название, Знач Приватный = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Название | --title | Строка | Наименование канала | + | Приватный | --private | Булево | Создать канал приватным | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Имя = "testconv" + Строка(Новый УникальныйИдентификатор); + + Результат = OPI_Slack.СоздатьКанал(Токен, Имя); +``` + + + + + + ```bash + oint slack СоздатьКанал --token "***" \ + --title "testconv9d2a1472-7419-436a-a418-a8a70d5b9ec3" \ + --private false + ``` + + + + ```batch + oint slack СоздатьКанал ^ + --token "***" ^ + --title "testconv9d2a1472-7419-436a-a418-a8a70d5b9ec3" ^ + --private false + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409452819, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "0000000000.000000", + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [], + "priority": 0 + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-history.md b/docs/ru/md/Slack/Channel-management/Get-channel-history.md deleted file mode 100644 index 0b3882a0a9..0000000000 --- a/docs/ru/md/Slack/Channel-management/Get-channel-history.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить историю канала - Получает информацию событиях канала - - - -`Функция ПолучитьИсториюКанала(Знач Токен, Знач Канал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - - Результат = OPI_Slack.ПолучитьИсториюКанала(Токен, Канал); -``` - - - - - - ```bash - oint slack ПолучитьИсториюКанала --token "***" \ - --channel "C07SJFNT9SL" - ``` - - - - ```batch - oint slack ПолучитьИсториюКанала ^ - --token "***" ^ - --channel "C07SJFNT9SL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "messages": [ - { - "subtype": "channel_join", - "user": "U06UABH3APP", - "text": "<@U06UABH3APP> has joined the channel", - "inviter": "U06UG1CAYH2", - "type": "message", - "ts": "1728409454.019979" - }, - { - "subtype": "channel_purpose", - "user": "U06UG1CAYH2", - "purpose": "Тестовая цель", - "text": "set the channel description: Тестовая цель", - "type": "message", - "ts": "1728409453.584309" - }, - { - "subtype": "channel_topic", - "user": "U06UG1CAYH2", - "topic": "Тестовая тема", - "text": "set the channel topic: Тестовая тема", - "type": "message", - "ts": "1728409453.313629" - }, - { - "subtype": "channel_join", - "user": "U06UG1CAYH2", - "text": "<@U06UG1CAYH2> has joined the channel", - "type": "message", - "ts": "1728409452.945219" - } - ], - "has_more": false, - "is_limited": false, - "pin_count": 0, - "channel_actions_ts": null, - "channel_actions_count": 0 -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-history.mdx b/docs/ru/md/Slack/Channel-management/Get-channel-history.mdx new file mode 100644 index 0000000000..ce43f9bb69 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Get-channel-history.mdx @@ -0,0 +1,97 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить историю канала + Получает информацию событиях канала + + + +`Функция ПолучитьИсториюКанала(Знач Токен, Знач Канал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + + Результат = OPI_Slack.ПолучитьИсториюКанала(Токен, Канал); +``` + + + + + + ```bash + oint slack ПолучитьИсториюКанала --token "***" \ + --channel "C07SJFNT9SL" + ``` + + + + ```batch + oint slack ПолучитьИсториюКанала ^ + --token "***" ^ + --channel "C07SJFNT9SL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "messages": [ + { + "subtype": "channel_join", + "user": "U06UABH3APP", + "text": "<@U06UABH3APP> has joined the channel", + "inviter": "U06UG1CAYH2", + "type": "message", + "ts": "1728409454.019979" + }, + { + "subtype": "channel_purpose", + "user": "U06UG1CAYH2", + "purpose": "Тестовая цель", + "text": "set the channel description: Тестовая цель", + "type": "message", + "ts": "1728409453.584309" + }, + { + "subtype": "channel_topic", + "user": "U06UG1CAYH2", + "topic": "Тестовая тема", + "text": "set the channel topic: Тестовая тема", + "type": "message", + "ts": "1728409453.313629" + }, + { + "subtype": "channel_join", + "user": "U06UG1CAYH2", + "text": "<@U06UG1CAYH2> has joined the channel", + "type": "message", + "ts": "1728409452.945219" + } + ], + "has_more": false, + "is_limited": false, + "pin_count": 0, + "channel_actions_ts": null, + "channel_actions_count": 0 +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-list.md b/docs/ru/md/Slack/Channel-management/Get-channel-list.md deleted file mode 100644 index b9c4964fe7..0000000000 --- a/docs/ru/md/Slack/Channel-management/Get-channel-list.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список каналов - Получает список доступных каналов - - - -`Функция ПолучитьСписокКаналов(Знач Токен, Знач ИсключатьАрхивированные = Ложь, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИсключатьАрхивированные | --notarchived | Булево | Признак исключения архивированных каналов | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - - Результат = OPI_Slack.ПолучитьСписокКаналов(Токен); -``` - - - - - - ```bash - oint slack ПолучитьСписокКаналов --token "***" - ``` - - - - ```batch - oint slack ПолучитьСписокКаналов ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channels": [ - { - "id": "C06UD92DF1Q", - "name": "general", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713202497, - "is_archived": false, - "is_general": true, - "unlinked": 0, - "name_normalized": "general", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1724394518358, - "parent_conversation": null, - "creator": "U06UABH3APP", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "This is the one channel that will always include everyone. It’s a great spot for announcements and team-wide conversations.", - "creator": "U06UABH3APP", - "last_set": 1713202497 - }, - "properties": { - "use_case": "welcome" - }, - "previous_names": [], - "num_members": 1 - }, - { - "id": "C06UFNUTKUL", - "name": "slack-api-librarry", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713202541, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "slack-api-librarry", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1724394515808, - "parent_conversation": null, - "creator": "U06UABH3APP", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "This channel is for everything #slack-api-librarry. Hold meetings, share docs, and make decisions together with your team.", - "creator": "U06UABH3APP", - "last_set": 1713202541 - }, - "properties": { - "tabs": [ - { - "id": "files", - "label": "", - "type": "files" - } - ], - "use_case": "project" - }, - "previous_names": [], - "num_members": 2 - }, - { - "id": "C06UW6XHU5V", - "name": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713701752, - "is_archived": true, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1724394515915, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "", - "creator": "", - "last_set": 0 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [], - "num_members": 0 - }, - { - "id": "C06UWD6523Z", - "name": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1713712534, - "is_archived": true, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", - "is_shared": false, -... -``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-list.mdx b/docs/ru/md/Slack/Channel-management/Get-channel-list.mdx new file mode 100644 index 0000000000..7c5369094f --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Get-channel-list.mdx @@ -0,0 +1,205 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список каналов + Получает список доступных каналов + + + +`Функция ПолучитьСписокКаналов(Знач Токен, Знач ИсключатьАрхивированные = Ложь, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИсключатьАрхивированные | --notarchived | Булево | Признак исключения архивированных каналов | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + + Результат = OPI_Slack.ПолучитьСписокКаналов(Токен); +``` + + + + + + ```bash + oint slack ПолучитьСписокКаналов --token "***" + ``` + + + + ```batch + oint slack ПолучитьСписокКаналов ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channels": [ + { + "id": "C06UD92DF1Q", + "name": "general", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713202497, + "is_archived": false, + "is_general": true, + "unlinked": 0, + "name_normalized": "general", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1724394518358, + "parent_conversation": null, + "creator": "U06UABH3APP", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "This is the one channel that will always include everyone. It’s a great spot for announcements and team-wide conversations.", + "creator": "U06UABH3APP", + "last_set": 1713202497 + }, + "properties": { + "use_case": "welcome" + }, + "previous_names": [], + "num_members": 1 + }, + { + "id": "C06UFNUTKUL", + "name": "slack-api-librarry", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713202541, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "slack-api-librarry", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1724394515808, + "parent_conversation": null, + "creator": "U06UABH3APP", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "This channel is for everything #slack-api-librarry. Hold meetings, share docs, and make decisions together with your team.", + "creator": "U06UABH3APP", + "last_set": 1713202541 + }, + "properties": { + "tabs": [ + { + "id": "files", + "label": "", + "type": "files" + } + ], + "use_case": "project" + }, + "previous_names": [], + "num_members": 2 + }, + { + "id": "C06UW6XHU5V", + "name": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713701752, + "is_archived": true, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconvd9226ab3-0341-4abb-97c4-a185b7ace9e8", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1724394515915, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "", + "creator": "", + "last_set": 0 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [], + "num_members": 0 + }, + { + "id": "C06UWD6523Z", + "name": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1713712534, + "is_archived": true, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconvdfd146d0-f8c0-4e9f-9df8-56cc13c7e1dc", + "is_shared": false, +... +``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md b/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md deleted file mode 100644 index 316307935f..0000000000 --- a/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список пользователей канала - Получает список пользователей указанного канала - - - -`Функция ПолучитьСписокПользователейКанала(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - - Результат = OPI_Slack.ПолучитьСписокПользователейКанала(Токен, Канал); -``` - - - - - - ```bash - oint slack ПолучитьСписокПользователейКанала --token "***" \ - --channel "C07SJFNT9SL" - ``` - - - - ```batch - oint slack ПолучитьСписокПользователейКанала ^ - --token "***" ^ - --channel "C07SJFNT9SL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "members": [ - "U06UG1CAYH2" - ], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-user-list.mdx b/docs/ru/md/Slack/Channel-management/Get-channel-user-list.mdx new file mode 100644 index 0000000000..3929872cb9 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Get-channel-user-list.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список пользователей канала + Получает список пользователей указанного канала + + + +`Функция ПолучитьСписокПользователейКанала(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + + Результат = OPI_Slack.ПолучитьСписокПользователейКанала(Токен, Канал); +``` + + + + + + ```bash + oint slack ПолучитьСписокПользователейКанала --token "***" \ + --channel "C07SJFNT9SL" + ``` + + + + ```batch + oint slack ПолучитьСписокПользователейКанала ^ + --token "***" ^ + --channel "C07SJFNT9SL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "members": [ + "U06UG1CAYH2" + ], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel.md b/docs/ru/md/Slack/Channel-management/Get-channel.md deleted file mode 100644 index 0add3dd00c..0000000000 --- a/docs/ru/md/Slack/Channel-management/Get-channel.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить канал - Получает информацию о канале - - - -`Функция ПолучитьКанал(Знач Токен, Знач Канал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - - Результат = OPI_Slack.ПолучитьКанал(Токен, Канал); -``` - - - - - - ```bash - oint slack ПолучитьКанал --token "***" \ - --channel "C07SJFNT9SL" - ``` - - - - ```batch - oint slack ПолучитьКанал ^ - --token "***" ^ - --channel "C07SJFNT9SL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409453555, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "0000000000.000000", - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "previous_names": [] - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel.mdx b/docs/ru/md/Slack/Channel-management/Get-channel.mdx new file mode 100644 index 0000000000..1f0c9d21cd --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Get-channel.mdx @@ -0,0 +1,99 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить канал + Получает информацию о канале + + + +`Функция ПолучитьКанал(Знач Токен, Знач Канал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + + Результат = OPI_Slack.ПолучитьКанал(Токен, Канал); +``` + + + + + + ```bash + oint slack ПолучитьКанал --token "***" \ + --channel "C07SJFNT9SL" + ``` + + + + ```batch + oint slack ПолучитьКанал ^ + --token "***" ^ + --channel "C07SJFNT9SL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409453555, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "0000000000.000000", + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "previous_names": [] + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md b/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md deleted file mode 100644 index 144bd9185c..0000000000 --- a/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Пригласить пользователей в канал - Добавляет указанных пользователей в канал - - - -`Функция ПригласитьПользователейВКанал(Знач Токен, Знач Канал, Знач МассивПользователей) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | МассивПользователей | --users | Массив Из Строка | Массив ID пользователей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - Пользователь = "U06UABH3APP"; - - Результат = OPI_Slack.ПригласитьПользователейВКанал(Токен, Канал, Пользователь); -``` - - - - - - ```bash - oint slack ПригласитьПользователейВКанал --token "***" \ - --channel "C07SJFNT9SL" \ - --users "U06UABH3APP" - ``` - - - - ```batch - oint slack ПригласитьПользователейВКанал ^ - --token "***" ^ - --channel "C07SJFNT9SL" ^ - --users "U06UABH3APP" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409453555, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "0000000000.000000", - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "previous_names": [] - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.mdx b/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.mdx new file mode 100644 index 0000000000..eeb10a630c --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.mdx @@ -0,0 +1,103 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Пригласить пользователей в канал + Добавляет указанных пользователей в канал + + + +`Функция ПригласитьПользователейВКанал(Знач Токен, Знач Канал, Знач МассивПользователей) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | МассивПользователей | --users | Массив Из Строка | Массив ID пользователей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + Пользователь = "U06UABH3APP"; + + Результат = OPI_Slack.ПригласитьПользователейВКанал(Токен, Канал, Пользователь); +``` + + + + + + ```bash + oint slack ПригласитьПользователейВКанал --token "***" \ + --channel "C07SJFNT9SL" \ + --users "U06UABH3APP" + ``` + + + + ```batch + oint slack ПригласитьПользователейВКанал ^ + --token "***" ^ + --channel "C07SJFNT9SL" ^ + --users "U06UABH3APP" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409453555, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "0000000000.000000", + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "previous_names": [] + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Join-channel.md b/docs/ru/md/Slack/Channel-management/Join-channel.md deleted file mode 100644 index 0cb3cb43a8..0000000000 --- a/docs/ru/md/Slack/Channel-management/Join-channel.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Вступить в канал - Добавляет текущего бота в канал - - - -`Функция ВступитьВКанал(Знач Токен, Знач Канал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - - Результат = OPI_Slack.ВступитьВКанал(Токен, Канал); -``` - - - - - - ```bash - oint slack ВступитьВКанал --token "***" \ - --channel "C07SJFNT9SL" - ``` - - - - ```batch - oint slack ВступитьВКанал ^ - --token "***" ^ - --channel "C07SJFNT9SL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409453555, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1728409454.019979", - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "previous_names": [], - "priority": 0 - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Join-channel.mdx b/docs/ru/md/Slack/Channel-management/Join-channel.mdx new file mode 100644 index 0000000000..ffddc58f40 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Join-channel.mdx @@ -0,0 +1,100 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Вступить в канал + Добавляет текущего бота в канал + + + +`Функция ВступитьВКанал(Знач Токен, Знач Канал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + + Результат = OPI_Slack.ВступитьВКанал(Токен, Канал); +``` + + + + + + ```bash + oint slack ВступитьВКанал --token "***" \ + --channel "C07SJFNT9SL" + ``` + + + + ```batch + oint slack ВступитьВКанал ^ + --token "***" ^ + --channel "C07SJFNT9SL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409453555, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1728409454.019979", + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "previous_names": [], + "priority": 0 + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md b/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md deleted file mode 100644 index 8e6aa01a4f..0000000000 --- a/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Выгнать пользователя из канала - Удаляет указанного пользователя из канала - - - -`Функция ВыгнатьПользователяИзКанала(Знач Токен, Знач Канал, Знач Пользователь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Пользователь | --user | Строка | ID пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - Пользователь = "U06UABH3APP"; - - Результат = OPI_Slack.ВыгнатьПользователяИзКанала(Токен, Канал, Пользователь); -``` - - - - - - ```bash - oint slack ВыгнатьПользователяИзКанала --token "***" \ - --channel "C07SJFNT9SL" \ - --user "U06UABH3APP" - ``` - - - - ```batch - oint slack ВыгнатьПользователяИзКанала ^ - --token "***" ^ - --channel "C07SJFNT9SL" ^ - --user "U06UABH3APP" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.mdx b/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.mdx new file mode 100644 index 0000000000..d75219b2bf --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Выгнать пользователя из канала + Удаляет указанного пользователя из канала + + + +`Функция ВыгнатьПользователяИзКанала(Знач Токен, Знач Канал, Знач Пользователь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Пользователь | --user | Строка | ID пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + Пользователь = "U06UABH3APP"; + + Результат = OPI_Slack.ВыгнатьПользователяИзКанала(Токен, Канал, Пользователь); +``` + + + + + + ```bash + oint slack ВыгнатьПользователяИзКанала --token "***" \ + --channel "C07SJFNT9SL" \ + --user "U06UABH3APP" + ``` + + + + ```batch + oint slack ВыгнатьПользователяИзКанала ^ + --token "***" ^ + --channel "C07SJFNT9SL" ^ + --user "U06UABH3APP" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Leave-channel.md b/docs/ru/md/Slack/Channel-management/Leave-channel.md deleted file mode 100644 index 7575a88795..0000000000 --- a/docs/ru/md/Slack/Channel-management/Leave-channel.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Покинуть канал - Удаляет текущего бота из канала - - - -`Функция ПокинутьКанал(Знач Токен, Знач Канал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - - Результат = OPI_Slack.ПокинутьКанал(Токен, Канал); -``` - - - - - - ```bash - oint slack ПокинутьКанал --token "***" \ - --channel "C07SJFNT9SL" - ``` - - - - ```batch - oint slack ПокинутьКанал ^ - --token "***" ^ - --channel "C07SJFNT9SL" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Leave-channel.mdx b/docs/ru/md/Slack/Channel-management/Leave-channel.mdx new file mode 100644 index 0000000000..131ee957c0 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Leave-channel.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Покинуть канал + Удаляет текущего бота из канала + + + +`Функция ПокинутьКанал(Знач Токен, Знач Канал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + + Результат = OPI_Slack.ПокинутьКанал(Токен, Канал); +``` + + + + + + ```bash + oint slack ПокинутьКанал --token "***" \ + --channel "C07SJFNT9SL" + ``` + + + + ```batch + oint slack ПокинутьКанал ^ + --token "***" ^ + --channel "C07SJFNT9SL" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Rename-channel.md b/docs/ru/md/Slack/Channel-management/Rename-channel.md deleted file mode 100644 index 5576c67719..0000000000 --- a/docs/ru/md/Slack/Channel-management/Rename-channel.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Переименовать канал - Изменяет название канала - - - -`Функция ПереименоватьКанал(Знач Токен, Знач Канал, Знач Название) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Название | --title | Строка | Новое название канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - Название = "testconv" + Строка(Новый УникальныйИдентификатор); - - Результат = OPI_Slack.ПереименоватьКанал(Токен, Канал, Название); -``` - - - - - - ```bash - oint slack ПереименоватьКанал --token "***" \ - --channel "C07SJFNT9SL" \ - --title "testconv9e5bb126-2a68-4e43-8ff1-049303a0549e" - ``` - - - - ```batch - oint slack ПереименоватьКанал ^ - --token "***" ^ - --channel "C07SJFNT9SL" ^ - --title "testconv9e5bb126-2a68-4e43-8ff1-049303a0549e" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconve34522e4-7b58-47dc-ad72-2b37eb41d7c8", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconve34522e4-7b58-47dc-ad72-2b37eb41d7c8", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409455684, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1728409454.019979", - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "previous_names": [ - "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74" - ] - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Rename-channel.mdx b/docs/ru/md/Slack/Channel-management/Rename-channel.mdx new file mode 100644 index 0000000000..af7febd5fd --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Rename-channel.mdx @@ -0,0 +1,105 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Переименовать канал + Изменяет название канала + + + +`Функция ПереименоватьКанал(Знач Токен, Знач Канал, Знач Название) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Название | --title | Строка | Новое название канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + Название = "testconv" + Строка(Новый УникальныйИдентификатор); + + Результат = OPI_Slack.ПереименоватьКанал(Токен, Канал, Название); +``` + + + + + + ```bash + oint slack ПереименоватьКанал --token "***" \ + --channel "C07SJFNT9SL" \ + --title "testconv9e5bb126-2a68-4e43-8ff1-049303a0549e" + ``` + + + + ```batch + oint slack ПереименоватьКанал ^ + --token "***" ^ + --channel "C07SJFNT9SL" ^ + --title "testconv9e5bb126-2a68-4e43-8ff1-049303a0549e" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconve34522e4-7b58-47dc-ad72-2b37eb41d7c8", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconve34522e4-7b58-47dc-ad72-2b37eb41d7c8", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409455684, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1728409454.019979", + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "previous_names": [ + "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74" + ] + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-goal.md b/docs/ru/md/Slack/Channel-management/Set-channel-goal.md deleted file mode 100644 index 0c388613ac..0000000000 --- a/docs/ru/md/Slack/Channel-management/Set-channel-goal.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Установить цель канала - Устанавливает цель (описание) канала - - - -`Функция УстановитьЦельКанала(Знач Токен, Знач Канал, Знач Цель) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Цель | --purpose | Строка | Цель канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - Цель = "Тестовая цель"; - - Результат = OPI_Slack.УстановитьЦельКанала(Токен, Канал, Цель); -``` - - - - - - ```bash - oint slack УстановитьЦельКанала --token "***" \ - --channel "C07SJFNT9SL" \ - --purpose "Тестовая цель" - ``` - - - - ```batch - oint slack УстановитьЦельКанала ^ - --token "***" ^ - --channel "C07SJFNT9SL" ^ - --purpose "Тестовая цель" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409453555, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "previous_names": [] - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-goal.mdx b/docs/ru/md/Slack/Channel-management/Set-channel-goal.mdx new file mode 100644 index 0000000000..b459820b35 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Set-channel-goal.mdx @@ -0,0 +1,102 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Установить цель канала + Устанавливает цель (описание) канала + + + +`Функция УстановитьЦельКанала(Знач Токен, Знач Канал, Знач Цель) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Цель | --purpose | Строка | Цель канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + Цель = "Тестовая цель"; + + Результат = OPI_Slack.УстановитьЦельКанала(Токен, Канал, Цель); +``` + + + + + + ```bash + oint slack УстановитьЦельКанала --token "***" \ + --channel "C07SJFNT9SL" \ + --purpose "Тестовая цель" + ``` + + + + ```batch + oint slack УстановитьЦельКанала ^ + --token "***" ^ + --channel "C07SJFNT9SL" ^ + --purpose "Тестовая цель" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409453555, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "previous_names": [] + } +} +``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-topic.md b/docs/ru/md/Slack/Channel-management/Set-channel-topic.md deleted file mode 100644 index 4157e9bd53..0000000000 --- a/docs/ru/md/Slack/Channel-management/Set-channel-topic.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Установить тему канала - Устанавливает тему канала - - - -`Функция УстановитьТемуКанала(Знач Токен, Знач Канал, Знач Тема) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Тема | --theme | Строка | Тема канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C07R7MSSPDM"; - Тема = "Тестовая тема"; - - Результат = OPI_Slack.УстановитьТемуКанала(Токен, Канал, Тема); -``` - - - - - - ```bash - oint slack УстановитьТемуКанала --token "***" \ - --channel "C07SJFNT9SL" \ - --theme "Тестовая тема" - ``` - - - - ```batch - oint slack УстановитьТемуКанала ^ - --token "***" ^ - --channel "C07SJFNT9SL" ^ - --theme "Тестовая тема" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": { - "id": "C07R1A2DAS0", - "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1728409452, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1728409453295, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": false, - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1728409453 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [] - } -} -``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-topic.mdx b/docs/ru/md/Slack/Channel-management/Set-channel-topic.mdx new file mode 100644 index 0000000000..7042703959 --- /dev/null +++ b/docs/ru/md/Slack/Channel-management/Set-channel-topic.mdx @@ -0,0 +1,102 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Установить тему канала + Устанавливает тему канала + + + +`Функция УстановитьТемуКанала(Знач Токен, Знач Канал, Знач Тема) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Тема | --theme | Строка | Тема канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C07R7MSSPDM"; + Тема = "Тестовая тема"; + + Результат = OPI_Slack.УстановитьТемуКанала(Токен, Канал, Тема); +``` + + + + + + ```bash + oint slack УстановитьТемуКанала --token "***" \ + --channel "C07SJFNT9SL" \ + --theme "Тестовая тема" + ``` + + + + ```batch + oint slack УстановитьТемуКанала ^ + --token "***" ^ + --channel "C07SJFNT9SL" ^ + --theme "Тестовая тема" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": { + "id": "C07R1A2DAS0", + "name": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1728409452, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv2e86d4e6-e191-4d76-981d-e9680d2efc74", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1728409453295, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": false, + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1728409453 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [] + } +} +``` diff --git a/docs/ru/md/Slack/Dialog-management/Close-dialog.md b/docs/ru/md/Slack/Dialog-management/Close-dialog.md deleted file mode 100644 index f4cba369f6..0000000000 --- a/docs/ru/md/Slack/Dialog-management/Close-dialog.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Закрыть диалог - Закрывает существующий диалог - - - -`Функция ЗакрытьДиалог(Знач Токен, Знач Диалог) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Диалог | --conv | Строка | ID диалога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Диалог = "D06UAKK1C6R"; - - Результат = OPI_Slack.ЗакрытьДиалог(Токен, Диалог); -``` - - - - - - ```bash - oint slack ЗакрытьДиалог --token "***" \ - --conv "D06UAKK1C6R" - ``` - - - - ```batch - oint slack ЗакрытьДиалог ^ - --token "***" ^ - --conv "D06UAKK1C6R" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "already_closed": false, - "no_op": false -} -``` diff --git a/docs/ru/md/Slack/Dialog-management/Close-dialog.mdx b/docs/ru/md/Slack/Dialog-management/Close-dialog.mdx new file mode 100644 index 0000000000..7136ebabe3 --- /dev/null +++ b/docs/ru/md/Slack/Dialog-management/Close-dialog.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Закрыть диалог + Закрывает существующий диалог + + + +`Функция ЗакрытьДиалог(Знач Токен, Знач Диалог) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Диалог | --conv | Строка | ID диалога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Диалог = "D06UAKK1C6R"; + + Результат = OPI_Slack.ЗакрытьДиалог(Токен, Диалог); +``` + + + + + + ```bash + oint slack ЗакрытьДиалог --token "***" \ + --conv "D06UAKK1C6R" + ``` + + + + ```batch + oint slack ЗакрытьДиалог ^ + --token "***" ^ + --conv "D06UAKK1C6R" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "already_closed": false, + "no_op": false +} +``` diff --git a/docs/ru/md/Slack/Dialog-management/Open-dialog.md b/docs/ru/md/Slack/Dialog-management/Open-dialog.md deleted file mode 100644 index 9ca694785a..0000000000 --- a/docs/ru/md/Slack/Dialog-management/Open-dialog.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Открыть диалог - Открывает новый диалог с одним или несколькими пользователями - - - -`Функция ОткрытьДиалог(Знач Токен, Знач МассивПользователей) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | МассивПользователей | --users | Массив из Строка | Массив ID пользователей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Пользователь = "U06UABH3APP"; - - Результат = OPI_Slack.ОткрытьДиалог(Токен, Пользователь); -``` - - - - - - ```bash - oint slack ОткрытьДиалог --token "***" \ - --users "U06UABH3APP" - ``` - - - - ```batch - oint slack ОткрытьДиалог ^ - --token "***" ^ - --users "U06UABH3APP" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "no_op": false, - "already_open": false, - "channel": { - "id": "D06UAKK1C6R" - } -} -``` diff --git a/docs/ru/md/Slack/Dialog-management/Open-dialog.mdx b/docs/ru/md/Slack/Dialog-management/Open-dialog.mdx new file mode 100644 index 0000000000..8fa51a90ee --- /dev/null +++ b/docs/ru/md/Slack/Dialog-management/Open-dialog.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Открыть диалог + Открывает новый диалог с одним или несколькими пользователями + + + +`Функция ОткрытьДиалог(Знач Токен, Знач МассивПользователей) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | МассивПользователей | --users | Массив из Строка | Массив ID пользователей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Пользователь = "U06UABH3APP"; + + Результат = OPI_Slack.ОткрытьДиалог(Токен, Пользователь); +``` + + + + + + ```bash + oint slack ОткрытьДиалог --token "***" \ + --users "U06UABH3APP" + ``` + + + + ```batch + oint slack ОткрытьДиалог ^ + --token "***" ^ + --users "U06UABH3APP" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "no_op": false, + "already_open": false, + "channel": { + "id": "D06UAKK1C6R" + } +} +``` diff --git a/docs/ru/md/Slack/External-files-management/Add-external-file.md b/docs/ru/md/Slack/External-files-management/Add-external-file.md deleted file mode 100644 index 8665eda9c5..0000000000 --- a/docs/ru/md/Slack/External-files-management/Add-external-file.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Добавить внешний файл - Добавляет новый внешний файл - - - -`Функция ДобавитьВнешнийФайл(Знач Токен, Знач URL, Знач Заголовок) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | URL | --url | Строка | URL к внешнему файлу | - | Заголовок | --title | Строка | Заголовок файла для Slack | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Заголовок = "Новый файл"; - Файл = "https://api.athenaeum.digital/test_data/document.docx"; - - Результат = OPI_Slack.ДобавитьВнешнийФайл(Токен, Файл, Заголовок); -``` - - - - - - ```bash - oint slack ДобавитьВнешнийФайл --token "***" \ - --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ - --title "Новый файл" - ``` - - - - ```batch - oint slack ДобавитьВнешнийФайл ^ - --token "***" ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ - --title "Новый файл" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "file": { - "id": "F07QYQS8ED8", - "created": 1728409471, - "timestamp": 1728409471, - "name": "Novyj_fajl", - "title": "Новый файл", - "mimetype": "application/vnd.slack-remote", - "filetype": "remote", - "pretty_type": "Remote", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 0, - "mode": "external", - "is_external": true, - "external_type": "app", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://slack.com/api/files.remote.add", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYQS8ED8/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "fe8bd555-b96a-44f3-8cc6-12e63a841cb7", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } -} -``` diff --git a/docs/ru/md/Slack/External-files-management/Add-external-file.mdx b/docs/ru/md/Slack/External-files-management/Add-external-file.mdx new file mode 100644 index 0000000000..dfbfc00ed8 --- /dev/null +++ b/docs/ru/md/Slack/External-files-management/Add-external-file.mdx @@ -0,0 +1,98 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Добавить внешний файл + Добавляет новый внешний файл + + + +`Функция ДобавитьВнешнийФайл(Знач Токен, Знач URL, Знач Заголовок) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | URL | --url | Строка | URL к внешнему файлу | + | Заголовок | --title | Строка | Заголовок файла для Slack | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Заголовок = "Новый файл"; + Файл = "https://api.athenaeum.digital/test_data/document.docx"; + + Результат = OPI_Slack.ДобавитьВнешнийФайл(Токен, Файл, Заголовок); +``` + + + + + + ```bash + oint slack ДобавитьВнешнийФайл --token "***" \ + --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ + --title "Новый файл" + ``` + + + + ```batch + oint slack ДобавитьВнешнийФайл ^ + --token "***" ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ + --title "Новый файл" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "file": { + "id": "F07QYQS8ED8", + "created": 1728409471, + "timestamp": 1728409471, + "name": "Novyj_fajl", + "title": "Новый файл", + "mimetype": "application/vnd.slack-remote", + "filetype": "remote", + "pretty_type": "Remote", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 0, + "mode": "external", + "is_external": true, + "external_type": "app", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://slack.com/api/files.remote.add", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYQS8ED8/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "fe8bd555-b96a-44f3-8cc6-12e63a841cb7", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } +} +``` diff --git a/docs/ru/md/Slack/External-files-management/Delete-external-file.md b/docs/ru/md/Slack/External-files-management/Delete-external-file.md deleted file mode 100644 index 1f94b99977..0000000000 --- a/docs/ru/md/Slack/External-files-management/Delete-external-file.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить внешний файл - Удаляет внешний файл из Slack - - - -`Функция УдалитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - ИдентификаторФайла = "F07RN8F33GS"; - - Результат = OPI_Slack.УдалитьВнешнийФайл(Токен, ИдентификаторФайла); -``` - - - - - - ```bash - oint slack УдалитьВнешнийФайл --token "***" \ - --fileid "F07SJFS1UG0" - ``` - - - - ```batch - oint slack УдалитьВнешнийФайл ^ - --token "***" ^ - --fileid "F07SJFS1UG0" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/Slack/External-files-management/Delete-external-file.mdx b/docs/ru/md/Slack/External-files-management/Delete-external-file.mdx new file mode 100644 index 0000000000..43cf366958 --- /dev/null +++ b/docs/ru/md/Slack/External-files-management/Delete-external-file.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить внешний файл + Удаляет внешний файл из Slack + + + +`Функция УдалитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + ИдентификаторФайла = "F07RN8F33GS"; + + Результат = OPI_Slack.УдалитьВнешнийФайл(Токен, ИдентификаторФайла); +``` + + + + + + ```bash + oint slack УдалитьВнешнийФайл --token "***" \ + --fileid "F07SJFS1UG0" + ``` + + + + ```batch + oint slack УдалитьВнешнийФайл ^ + --token "***" ^ + --fileid "F07SJFS1UG0" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/Slack/External-files-management/Get-external-file-list.md b/docs/ru/md/Slack/External-files-management/Get-external-file-list.md deleted file mode 100644 index 0778863d4c..0000000000 --- a/docs/ru/md/Slack/External-files-management/Get-external-file-list.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список внешних файлов - Получает список внешних файлов пользователя или канала - - - -`Функция ПолучитьСписокВнешнихФайлов(Знач Токен, Знач Канал = "", Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Канал для отбора | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - - Результат = OPI_Slack.ПолучитьСписокВнешнихФайлов(Токен, Канал); -``` - - - - - - ```bash - oint slack ПолучитьСписокВнешнихФайлов --token "***" - ``` - - - - ```batch - oint slack ПолучитьСписокВнешнихФайлов ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "files": [], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/ru/md/Slack/External-files-management/Get-external-file-list.mdx b/docs/ru/md/Slack/External-files-management/Get-external-file-list.mdx new file mode 100644 index 0000000000..7b8b562869 --- /dev/null +++ b/docs/ru/md/Slack/External-files-management/Get-external-file-list.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список внешних файлов + Получает список внешних файлов пользователя или канала + + + +`Функция ПолучитьСписокВнешнихФайлов(Знач Токен, Знач Канал = "", Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Канал для отбора | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + + Результат = OPI_Slack.ПолучитьСписокВнешнихФайлов(Токен, Канал); +``` + + + + + + ```bash + oint slack ПолучитьСписокВнешнихФайлов --token "***" + ``` + + + + ```batch + oint slack ПолучитьСписокВнешнихФайлов ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "files": [], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/ru/md/Slack/External-files-management/Get-external-file.md b/docs/ru/md/Slack/External-files-management/Get-external-file.md deleted file mode 100644 index 9579879f12..0000000000 --- a/docs/ru/md/Slack/External-files-management/Get-external-file.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить внешний файл - Получает информацию о внешнем файле - - - -`Функция ПолучитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - ИдентификаторФайла = "F07RN8F33GS"; - - Результат = OPI_Slack.ПолучитьВнешнийФайл(Токен, ИдентификаторФайла); -``` - - - - - - ```bash - oint slack ПолучитьВнешнийФайл --token "***" \ - --fileid "F07SJFS1UG0" - ``` - - - - ```batch - oint slack ПолучитьВнешнийФайл ^ - --token "***" ^ - --fileid "F07SJFS1UG0" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "file": { - "id": "F07QYQS8ED8", - "created": 1728409471, - "timestamp": 1728409471, - "name": "Novyj_fajl", - "title": "Новый файл", - "mimetype": "application/vnd.slack-remote", - "filetype": "remote", - "pretty_type": "Remote", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 0, - "mode": "external", - "is_external": true, - "external_type": "app", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://slack.com/api/files.remote.add", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYQS8ED8/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "fe8bd555-b96a-44f3-8cc6-12e63a841cb7", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } -} -``` diff --git a/docs/ru/md/Slack/External-files-management/Get-external-file.mdx b/docs/ru/md/Slack/External-files-management/Get-external-file.mdx new file mode 100644 index 0000000000..9662262dc8 --- /dev/null +++ b/docs/ru/md/Slack/External-files-management/Get-external-file.mdx @@ -0,0 +1,94 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить внешний файл + Получает информацию о внешнем файле + + + +`Функция ПолучитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + ИдентификаторФайла = "F07RN8F33GS"; + + Результат = OPI_Slack.ПолучитьВнешнийФайл(Токен, ИдентификаторФайла); +``` + + + + + + ```bash + oint slack ПолучитьВнешнийФайл --token "***" \ + --fileid "F07SJFS1UG0" + ``` + + + + ```batch + oint slack ПолучитьВнешнийФайл ^ + --token "***" ^ + --fileid "F07SJFS1UG0" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "file": { + "id": "F07QYQS8ED8", + "created": 1728409471, + "timestamp": 1728409471, + "name": "Novyj_fajl", + "title": "Новый файл", + "mimetype": "application/vnd.slack-remote", + "filetype": "remote", + "pretty_type": "Remote", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 0, + "mode": "external", + "is_external": true, + "external_type": "app", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://slack.com/api/files.remote.add", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYQS8ED8/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "fe8bd555-b96a-44f3-8cc6-12e63a841cb7", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } +} +``` diff --git a/docs/ru/md/Slack/External-files-management/Send-external-file.md b/docs/ru/md/Slack/External-files-management/Send-external-file.md deleted file mode 100644 index b1ae9977d2..0000000000 --- a/docs/ru/md/Slack/External-files-management/Send-external-file.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Отправить внешний файл - Отправляет внейшний файл по списку каналов - - - -`Функция ОтправитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла, Знач МассивКаналов) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - | МассивКаналов | --channels | Массив Из Строка | Массив каналов для отправки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - ИдентификаторФайла = "F07RN8F33GS"; - - Результат = OPI_Slack.ОтправитьВнешнийФайл(Токен, ИдентификаторФайла, Канал); -``` - - - - - - ```bash - oint slack ОтправитьВнешнийФайл --token "***" \ - --fileid "F07SJFS1UG0" \ - --channels "C06UFNUTKUL" - ``` - - - - ```batch - oint slack ОтправитьВнешнийФайл ^ - --token "***" ^ - --fileid "F07SJFS1UG0" ^ - --channels "C06UFNUTKUL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "file": { - "id": "F07QYQS8ED8", - "created": 1728409471, - "timestamp": 1728409471, - "name": "Novyj_fajl", - "title": "Новый файл", - "mimetype": "application/vnd.slack-remote", - "filetype": "remote", - "pretty_type": "Remote", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 0, - "mode": "external", - "is_external": true, - "external_type": "app", - "is_public": true, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://slack.com/api/files.remote.add", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYQS8ED8/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": { - "public": { - "C06UFNUTKUL": [ - { - "reply_users": [], - "reply_users_count": 0, - "reply_count": 0, - "ts": "1728409471.843489", - "channel_name": "slack-api-librarry", - "team_id": "T06UD92BS3C", - "share_user_id": "U06UG1CAYH2", - "source": "UNKNOWN" - } - ] - } - }, - "channels": [ - "C06UFNUTKUL" - ], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "fe8bd555-b96a-44f3-8cc6-12e63a841cb7", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } -} -``` diff --git a/docs/ru/md/Slack/External-files-management/Send-external-file.mdx b/docs/ru/md/Slack/External-files-management/Send-external-file.mdx new file mode 100644 index 0000000000..0b5fffd44d --- /dev/null +++ b/docs/ru/md/Slack/External-files-management/Send-external-file.mdx @@ -0,0 +1,115 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Отправить внешний файл + Отправляет внейшний файл по списку каналов + + + +`Функция ОтправитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла, Знач МассивКаналов) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + | МассивКаналов | --channels | Массив Из Строка | Массив каналов для отправки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + ИдентификаторФайла = "F07RN8F33GS"; + + Результат = OPI_Slack.ОтправитьВнешнийФайл(Токен, ИдентификаторФайла, Канал); +``` + + + + + + ```bash + oint slack ОтправитьВнешнийФайл --token "***" \ + --fileid "F07SJFS1UG0" \ + --channels "C06UFNUTKUL" + ``` + + + + ```batch + oint slack ОтправитьВнешнийФайл ^ + --token "***" ^ + --fileid "F07SJFS1UG0" ^ + --channels "C06UFNUTKUL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "file": { + "id": "F07QYQS8ED8", + "created": 1728409471, + "timestamp": 1728409471, + "name": "Novyj_fajl", + "title": "Новый файл", + "mimetype": "application/vnd.slack-remote", + "filetype": "remote", + "pretty_type": "Remote", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 0, + "mode": "external", + "is_external": true, + "external_type": "app", + "is_public": true, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://slack.com/api/files.remote.add", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07QYQS8ED8/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": { + "public": { + "C06UFNUTKUL": [ + { + "reply_users": [], + "reply_users_count": 0, + "reply_count": 0, + "ts": "1728409471.843489", + "channel_name": "slack-api-librarry", + "team_id": "T06UD92BS3C", + "share_user_id": "U06UG1CAYH2", + "source": "UNKNOWN" + } + ] + } + }, + "channels": [ + "C06UFNUTKUL" + ], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "fe8bd555-b96a-44f3-8cc6-12e63a841cb7", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } +} +``` diff --git a/docs/ru/md/Slack/File-managment/Delete-file.md b/docs/ru/md/Slack/File-managment/Delete-file.md deleted file mode 100644 index 011d857bda..0000000000 --- a/docs/ru/md/Slack/File-managment/Delete-file.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить файл - Удаляет файл на Slack - - - -`Функция УдалитьФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - ИдентификаторФайла = "F07RFKJR7GW"; - - Результат = OPI_Slack.УдалитьФайл(Токен, ИдентификаторФайла); -``` - - - - - - ```bash - oint slack УдалитьФайл --token "***" \ - --fileid "F07RP3G79F0" - ``` - - - - ```batch - oint slack УдалитьФайл ^ - --token "***" ^ - --fileid "F07RP3G79F0" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/Slack/File-managment/Delete-file.mdx b/docs/ru/md/Slack/File-managment/Delete-file.mdx new file mode 100644 index 0000000000..1dc0d1d114 --- /dev/null +++ b/docs/ru/md/Slack/File-managment/Delete-file.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить файл + Удаляет файл на Slack + + + +`Функция УдалитьФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + ИдентификаторФайла = "F07RFKJR7GW"; + + Результат = OPI_Slack.УдалитьФайл(Токен, ИдентификаторФайла); +``` + + + + + + ```bash + oint slack УдалитьФайл --token "***" \ + --fileid "F07RP3G79F0" + ``` + + + + ```batch + oint slack УдалитьФайл ^ + --token "***" ^ + --fileid "F07RP3G79F0" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/Slack/File-managment/Get-file-data.md b/docs/ru/md/Slack/File-managment/Get-file-data.md deleted file mode 100644 index bc45b2a193..0000000000 --- a/docs/ru/md/Slack/File-managment/Get-file-data.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить данные файла - Получает информацию о файле - - - -`Функция ПолучитьДанныеФайла(Знач Токен, Знач ИдентификаторФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - ИдентификаторФайла = "F07RFKJR7GW"; - - Результат = OPI_Slack.ПолучитьДанныеФайла(Токен, ИдентификаторФайла); -``` - - - - - - ```bash - oint slack ПолучитьДанныеФайла --token "***" \ - --fileid "F07RP3G79F0" - ``` - - - - ```batch - oint slack ПолучитьДанныеФайла ^ - --token "***" ^ - --fileid "F07RP3G79F0" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "file": { - "id": "F07RMJNEF32", - "created": 1728409464, - "timestamp": 1728409464, - "name": "megadoc.docx", - "title": "Новый файл", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", - "favorites": [], - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible", - "comments_count": 0 - }, - "comments": [], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/ru/md/Slack/File-managment/Get-file-data.mdx b/docs/ru/md/Slack/File-managment/Get-file-data.mdx new file mode 100644 index 0000000000..794032381b --- /dev/null +++ b/docs/ru/md/Slack/File-managment/Get-file-data.mdx @@ -0,0 +1,99 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить данные файла + Получает информацию о файле + + + +`Функция ПолучитьДанныеФайла(Знач Токен, Знач ИдентификаторФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + ИдентификаторФайла = "F07RFKJR7GW"; + + Результат = OPI_Slack.ПолучитьДанныеФайла(Токен, ИдентификаторФайла); +``` + + + + + + ```bash + oint slack ПолучитьДанныеФайла --token "***" \ + --fileid "F07RP3G79F0" + ``` + + + + ```batch + oint slack ПолучитьДанныеФайла ^ + --token "***" ^ + --fileid "F07RP3G79F0" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "file": { + "id": "F07RMJNEF32", + "created": 1728409464, + "timestamp": 1728409464, + "name": "megadoc.docx", + "title": "Новый файл", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", + "favorites": [], + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible", + "comments_count": 0 + }, + "comments": [], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/ru/md/Slack/File-managment/Get-files-list.md b/docs/ru/md/Slack/File-managment/Get-files-list.md deleted file mode 100644 index aec1e6e5d4..0000000000 --- a/docs/ru/md/Slack/File-managment/Get-files-list.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список файлов - Получает список файлов бота или канала - - - -`Функция ПолучитьСписокФайлов(Знач Токен, Знач Канал = "", Знач НомерСтраницы = 1) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Канал для отбора | - | НомерСтраницы | --page | Число, Строка | Номер страницы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - - Результат = OPI_Slack.ПолучитьСписокФайлов(Токен, Канал); -``` - - - - - - ```bash - oint slack ПолучитьСписокФайлов --token "***" - ``` - - - - ```batch - oint slack ПолучитьСписокФайлов ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "files": [], - "paging": { - "count": 100, - "total": 12, - "page": 1, - "pages": 1 - } -} -``` diff --git a/docs/ru/md/Slack/File-managment/Get-files-list.mdx b/docs/ru/md/Slack/File-managment/Get-files-list.mdx new file mode 100644 index 0000000000..78a6ce8f69 --- /dev/null +++ b/docs/ru/md/Slack/File-managment/Get-files-list.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список файлов + Получает список файлов бота или канала + + + +`Функция ПолучитьСписокФайлов(Знач Токен, Знач Канал = "", Знач НомерСтраницы = 1) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Канал для отбора | + | НомерСтраницы | --page | Число, Строка | Номер страницы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + + Результат = OPI_Slack.ПолучитьСписокФайлов(Токен, Канал); +``` + + + + + + ```bash + oint slack ПолучитьСписокФайлов --token "***" + ``` + + + + ```batch + oint slack ПолучитьСписокФайлов ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "files": [], + "paging": { + "count": 100, + "total": 12, + "page": 1, + "pages": 1 + } +} +``` diff --git a/docs/ru/md/Slack/File-managment/Make-file-private.md b/docs/ru/md/Slack/File-managment/Make-file-private.md deleted file mode 100644 index 42819ad9af..0000000000 --- a/docs/ru/md/Slack/File-managment/Make-file-private.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Сделать файл приватным - Удаляет публичный URL у файла. Требует токен пользователя - - - -`Функция СделатьФайлПриватным(Знач Токен, Знач ИдентификаторФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен пользователя | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - ИдентификаторФайла = "F07RFKJR7GW"; - - Результат = OPI_Slack.СделатьФайлПриватным(Токен, ИдентификаторФайла); -``` - - - - - - ```bash - oint slack СделатьФайлПриватным --token "***" \ - --fileid "F07RP3G79F0" - ``` - - - - ```batch - oint slack СделатьФайлПриватным ^ - --token "***" ^ - --fileid "F07RP3G79F0" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "files": [ - { - "id": "F07RMJNEF32", - "created": 1728409464, - "timestamp": 1728409464, - "name": "megadoc.docx", - "title": "Новый файл", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] -} -``` diff --git a/docs/ru/md/Slack/File-managment/Make-file-private.mdx b/docs/ru/md/Slack/File-managment/Make-file-private.mdx new file mode 100644 index 0000000000..effa71e84c --- /dev/null +++ b/docs/ru/md/Slack/File-managment/Make-file-private.mdx @@ -0,0 +1,96 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Сделать файл приватным + Удаляет публичный URL у файла. Требует токен пользователя + + + +`Функция СделатьФайлПриватным(Знач Токен, Знач ИдентификаторФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен пользователя | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + ИдентификаторФайла = "F07RFKJR7GW"; + + Результат = OPI_Slack.СделатьФайлПриватным(Токен, ИдентификаторФайла); +``` + + + + + + ```bash + oint slack СделатьФайлПриватным --token "***" \ + --fileid "F07RP3G79F0" + ``` + + + + ```batch + oint slack СделатьФайлПриватным ^ + --token "***" ^ + --fileid "F07RP3G79F0" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "files": [ + { + "id": "F07RMJNEF32", + "created": 1728409464, + "timestamp": 1728409464, + "name": "megadoc.docx", + "title": "Новый файл", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible" + } + ] +} +``` diff --git a/docs/ru/md/Slack/File-managment/Make-file-public.md b/docs/ru/md/Slack/File-managment/Make-file-public.md deleted file mode 100644 index 7ca06806ab..0000000000 --- a/docs/ru/md/Slack/File-managment/Make-file-public.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Сделать файл публичным - Создает публичный URL для файла. Требует токен пользователя - - - -`Функция СделатьФайлПубличным(Знач Токен, Знач ИдентификаторФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен пользователя | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - ИдентификаторФайла = "F07RFKJR7GW"; - - Результат = OPI_Slack.СделатьФайлПубличным(Токен, ИдентификаторФайла); -``` - - - - - - ```bash - oint slack СделатьФайлПубличным --token "***" \ - --fileid "F07RP3G79F0" - ``` - - - - ```batch - oint slack СделатьФайлПубличным ^ - --token "***" ^ - --fileid "F07RP3G79F0" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "files": [ - { - "id": "F07RMJNEF32", - "created": 1728409464, - "timestamp": 1728409464, - "name": "megadoc.docx", - "title": "Новый файл", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] -} -``` diff --git a/docs/ru/md/Slack/File-managment/Make-file-public.mdx b/docs/ru/md/Slack/File-managment/Make-file-public.mdx new file mode 100644 index 0000000000..8130b7ac44 --- /dev/null +++ b/docs/ru/md/Slack/File-managment/Make-file-public.mdx @@ -0,0 +1,96 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Сделать файл публичным + Создает публичный URL для файла. Требует токен пользователя + + + +`Функция СделатьФайлПубличным(Знач Токен, Знач ИдентификаторФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен пользователя | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + ИдентификаторФайла = "F07RFKJR7GW"; + + Результат = OPI_Slack.СделатьФайлПубличным(Токен, ИдентификаторФайла); +``` + + + + + + ```bash + oint slack СделатьФайлПубличным --token "***" \ + --fileid "F07RP3G79F0" + ``` + + + + ```batch + oint slack СделатьФайлПубличным ^ + --token "***" ^ + --fileid "F07RP3G79F0" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "files": [ + { + "id": "F07RMJNEF32", + "created": 1728409464, + "timestamp": 1728409464, + "name": "megadoc.docx", + "title": "Новый файл", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible" + } + ] +} +``` diff --git a/docs/ru/md/Slack/File-managment/Upload-file.md b/docs/ru/md/Slack/File-managment/Upload-file.md deleted file mode 100644 index abfefb5154..0000000000 --- a/docs/ru/md/Slack/File-managment/Upload-file.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Загрузить файл - Загружает файл на сервера Slack - - - -`Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач ИмяФайла, Знач Заголовок, Знач Канал = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | - | ИмяФайла | --filename | Строка | Имя файла с расширением | - | Заголовок | --title | Строка | Имя файла в Slack | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - Файл = "https://api.athenaeum.digital/test_data/document.docx"; // URL, Двоичные данные или Путь к файлу - - ИмяФайла = "megadoc.docx"; - Заголовок = "Новый файл"; - - Результат = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок); - - Результат = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок, Канал); -``` - - - - - - ```bash - oint slack ЗагрузитьФайл --token "***" \ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ - --filename "megadoc.docx" \ - --title "Новый файл" \ - --channel "C06UFNUTKUL" - ``` - - - - ```batch - oint slack ЗагрузитьФайл ^ - --token "***" ^ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ - --filename "megadoc.docx" ^ - --title "Новый файл" ^ - --channel "C06UFNUTKUL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "files": [ - { - "id": "F07RMJNEF32", - "created": 1728409464, - "timestamp": 1728409464, - "name": "megadoc.docx", - "title": "Новый файл", - "mimetype": "", - "filetype": "", - "pretty_type": "", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": false, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] -} -``` diff --git a/docs/ru/md/Slack/File-managment/Upload-file.mdx b/docs/ru/md/Slack/File-managment/Upload-file.mdx new file mode 100644 index 0000000000..1f251011bc --- /dev/null +++ b/docs/ru/md/Slack/File-managment/Upload-file.mdx @@ -0,0 +1,111 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Загрузить файл + Загружает файл на сервера Slack + + + +`Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач ИмяФайла, Знач Заголовок, Знач Канал = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | + | ИмяФайла | --filename | Строка | Имя файла с расширением | + | Заголовок | --title | Строка | Имя файла в Slack | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + Файл = "https://api.athenaeum.digital/test_data/document.docx"; // URL, Двоичные данные или Путь к файлу + + ИмяФайла = "megadoc.docx"; + Заголовок = "Новый файл"; + + Результат = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок); + + Результат = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок, Канал); +``` + + + + + + ```bash + oint slack ЗагрузитьФайл --token "***" \ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ + --filename "megadoc.docx" \ + --title "Новый файл" \ + --channel "C06UFNUTKUL" + ``` + + + + ```batch + oint slack ЗагрузитьФайл ^ + --token "***" ^ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ + --filename "megadoc.docx" ^ + --title "Новый файл" ^ + --channel "C06UFNUTKUL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "files": [ + { + "id": "F07RMJNEF32", + "created": 1728409464, + "timestamp": 1728409464, + "name": "megadoc.docx", + "title": "Новый файл", + "mimetype": "", + "filetype": "", + "pretty_type": "", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": false, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F07RMJNEF32/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F07RMJNEF32/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F07RMJNEF32-40bbd2cc47", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "has_rich_preview": false, + "file_access": "visible" + } + ] +} +``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md deleted file mode 100644 index 948fba0d6a..0000000000 --- a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о боте - Получает основную информацию о боте - - - -`Функция ПолучитьИнформациюОБоте(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Результат = OPI_Slack.ПолучитьИнформациюОБоте(Токен); -``` - - - - - - ```bash - oint slack ПолучитьИнформациюОБоте --token "***" - ``` - - - - ```batch - oint slack ПолучитьИнформациюОБоте ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "url": "https://openintegrationsgroup.slack.com/", - "team": "OpenIntegrations", - "user": "openintegrations", - "team_id": "T06UD92BS3C", - "user_id": "U06UG1CAYH2", - "bot_id": "B06TZ0MJV5M", - "is_enterprise_install": false -} -``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.mdx b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.mdx new file mode 100644 index 0000000000..e02a13dd02 --- /dev/null +++ b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить информацию о боте + Получает основную информацию о боте + + + +`Функция ПолучитьИнформациюОБоте(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Результат = OPI_Slack.ПолучитьИнформациюОБоте(Токен); +``` + + + + + + ```bash + oint slack ПолучитьИнформациюОБоте --token "***" + ``` + + + + ```batch + oint slack ПолучитьИнформациюОБоте ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "url": "https://openintegrationsgroup.slack.com/", + "team": "OpenIntegrations", + "user": "openintegrations", + "team_id": "T06UD92BS3C", + "user_id": "U06UG1CAYH2", + "bot_id": "B06TZ0MJV5M", + "is_enterprise_install": false +} +``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-user-list.md b/docs/ru/md/Slack/Management-and-settings/Get-user-list.md deleted file mode 100644 index 33b480bdd7..0000000000 --- a/docs/ru/md/Slack/Management-and-settings/Get-user-list.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить список пользователей - Получает список пользователей рабочей области - - - -`Функция ПолучитьСписокПользователей(Знач Токен, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Результат = OPI_Slack.ПолучитьСписокПользователей(Токен); -``` - - - - - - ```bash - oint slack ПолучитьСписокПользователей --token "***" - ``` - - - - ```batch - oint slack ПолучитьСписокПользователей ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "members": [ - { - "id": "USLACKBOT", - "team_id": "T06UD92BS3C", - "name": "slackbot", - "deleted": false, - "color": "757575", - "real_name": "Slackbot", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "Slackbot", - "real_name_normalized": "Slackbot", - "display_name": "Slackbot", - "display_name_normalized": "Slackbot", - "fields": {}, - "status_text": "", - "status_emoji": "", - "status_emoji_display_info": [], - "status_expiration": 0, - "avatar_hash": "sv41d8cd98f0", - "always_active": true, - "first_name": "slackbot", - "last_name": "", - "image_24": "https://a.slack-edge.com/80588/img/slackbot_24.png", - "image_32": "https://a.slack-edge.com/80588/img/slackbot_32.png", - "image_48": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/slackbot_72.png", - "image_192": "https://a.slack-edge.com/80588/marketing/img/avatars/slackbot/avatar-slackbot.png", - "image_512": "https://a.slack-edge.com/80588/img/slackbot_512.png", - "status_text_canonical": "", - "team": "T06UD92BS3C" - }, - "is_admin": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "is_bot": false, - "is_app_user": false, - "updated": 0, - "is_email_confirmed": false, - "who_can_share_contact_card": "EVERYONE" - }, - { - "id": "U06UABH3APP", - "team_id": "T06UD92BS3C", - "name": "bayselonarrend", - "deleted": false, - "color": "9f69e7", - "real_name": "Антон Титовец", - "tz": "Europe/Moscow", - "tz_label": "Moscow Time", - "tz_offset": 10800, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "Антон Титовец", - "real_name_normalized": "Anton Titovec", - "display_name": "", - "display_name_normalized": "", - "fields": null, - "status_text": "", - "status_emoji": "", - "status_emoji_display_info": [], - "status_expiration": 0, - "avatar_hash": "65215daf7a4a", - "image_original": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_original.png", - "is_custom_image": true, - "email": "bayselonarrend@gmail.com", - "first_name": "Антон", - "last_name": "Титовец", - "image_24": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_24.png", - "image_32": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_32.png", - "image_48": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_48.png", - "image_72": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_72.png", - "image_192": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_192.png", - "image_512": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_512.png", - "image_1024": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_1024.png", - "status_text_canonical": "", - "team": "T06UD92BS3C" - }, - "is_admin": true, - "is_owner": true, - "is_primary_owner": true, - "is_restricted": false, - "is_ultra_restricted": false, - "is_bot": false, - "is_app_user": false, - "updated": 1713202518, - "is_email_confirmed": true, - "who_can_share_contact_card": "EVERYONE" - }, - { - "id": "U06UG1CAYH2", - "team_id": "T06UD92BS3C", - "name": "openintegrations", - "deleted": false, - "color": "4bbe2e", - "real_name": "OpenIntegrations", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "OpenIntegrations", - "real_name_normalized": "OpenIntegrations", - "display_name": "", - "display_name_normalized": "", - "fields": null, - "status_text": "", - "status_emoji": "", - "status_emoji_display_info": [], - "status_expiration": 0, - "avatar_hash": "gada2f598798", - "api_app_id": "A06TYNH45RV", - "always_active": false, - "bot_id": "B06TZ0MJV5M", - "first_name": "OpenIntegrations", - "last_name": "", - "image_24": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=24&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-24.png", - "image_32": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=32&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-32.png", - "image_48": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=48&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-48.png", - "image_72": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=72&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-72.png", - "image_192": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-192.png", - "image_512": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=512&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-512.png", - "status_text_canonical": "", - "team": "T06UD92BS3C" - }, - "is_admin": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "is_bot": true, - "is_app_user": false, - "updated": 1713205238, - "is_email_confirmed": false, - "who_can_share_contact_card": "EVERYONE" - } - ], -... -``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-user-list.mdx b/docs/ru/md/Slack/Management-and-settings/Get-user-list.mdx new file mode 100644 index 0000000000..353bc35a66 --- /dev/null +++ b/docs/ru/md/Slack/Management-and-settings/Get-user-list.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить список пользователей + Получает список пользователей рабочей области + + + +`Функция ПолучитьСписокПользователей(Знач Токен, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Результат = OPI_Slack.ПолучитьСписокПользователей(Токен); +``` + + + + + + ```bash + oint slack ПолучитьСписокПользователей --token "***" + ``` + + + + ```batch + oint slack ПолучитьСписокПользователей ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "members": [ + { + "id": "USLACKBOT", + "team_id": "T06UD92BS3C", + "name": "slackbot", + "deleted": false, + "color": "757575", + "real_name": "Slackbot", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "Slackbot", + "real_name_normalized": "Slackbot", + "display_name": "Slackbot", + "display_name_normalized": "Slackbot", + "fields": {}, + "status_text": "", + "status_emoji": "", + "status_emoji_display_info": [], + "status_expiration": 0, + "avatar_hash": "sv41d8cd98f0", + "always_active": true, + "first_name": "slackbot", + "last_name": "", + "image_24": "https://a.slack-edge.com/80588/img/slackbot_24.png", + "image_32": "https://a.slack-edge.com/80588/img/slackbot_32.png", + "image_48": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/slackbot_72.png", + "image_192": "https://a.slack-edge.com/80588/marketing/img/avatars/slackbot/avatar-slackbot.png", + "image_512": "https://a.slack-edge.com/80588/img/slackbot_512.png", + "status_text_canonical": "", + "team": "T06UD92BS3C" + }, + "is_admin": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "is_bot": false, + "is_app_user": false, + "updated": 0, + "is_email_confirmed": false, + "who_can_share_contact_card": "EVERYONE" + }, + { + "id": "U06UABH3APP", + "team_id": "T06UD92BS3C", + "name": "bayselonarrend", + "deleted": false, + "color": "9f69e7", + "real_name": "Антон Титовец", + "tz": "Europe/Moscow", + "tz_label": "Moscow Time", + "tz_offset": 10800, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "Антон Титовец", + "real_name_normalized": "Anton Titovec", + "display_name": "", + "display_name_normalized": "", + "fields": null, + "status_text": "", + "status_emoji": "", + "status_emoji_display_info": [], + "status_expiration": 0, + "avatar_hash": "65215daf7a4a", + "image_original": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_original.png", + "is_custom_image": true, + "email": "bayselonarrend@gmail.com", + "first_name": "Антон", + "last_name": "Титовец", + "image_24": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_24.png", + "image_32": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_32.png", + "image_48": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_48.png", + "image_72": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_72.png", + "image_192": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_192.png", + "image_512": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_512.png", + "image_1024": "https://avatars.slack-edge.com/2024-04-15/6965308574562_65215daf7a4a35eddf9c_1024.png", + "status_text_canonical": "", + "team": "T06UD92BS3C" + }, + "is_admin": true, + "is_owner": true, + "is_primary_owner": true, + "is_restricted": false, + "is_ultra_restricted": false, + "is_bot": false, + "is_app_user": false, + "updated": 1713202518, + "is_email_confirmed": true, + "who_can_share_contact_card": "EVERYONE" + }, + { + "id": "U06UG1CAYH2", + "team_id": "T06UD92BS3C", + "name": "openintegrations", + "deleted": false, + "color": "4bbe2e", + "real_name": "OpenIntegrations", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "OpenIntegrations", + "real_name_normalized": "OpenIntegrations", + "display_name": "", + "display_name_normalized": "", + "fields": null, + "status_text": "", + "status_emoji": "", + "status_emoji_display_info": [], + "status_expiration": 0, + "avatar_hash": "gada2f598798", + "api_app_id": "A06TYNH45RV", + "always_active": false, + "bot_id": "B06TZ0MJV5M", + "first_name": "OpenIntegrations", + "last_name": "", + "image_24": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=24&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-24.png", + "image_32": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=32&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-32.png", + "image_48": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=48&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-48.png", + "image_72": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=72&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-72.png", + "image_192": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-192.png", + "image_512": "https://secure.gravatar.com/avatar/ada2f598798f33d7af084f0c8793a209.jpg?s=512&d=https%3A%2F%2Fa.slack-edge.com%2Fdf10d%2Fimg%2Favatars%2Fava_0007-512.png", + "status_text_canonical": "", + "team": "T06UD92BS3C" + }, + "is_admin": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "is_bot": true, + "is_app_user": false, + "updated": 1713205238, + "is_email_confirmed": false, + "who_can_share_contact_card": "EVERYONE" + } + ], +... +``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md b/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md deleted file mode 100644 index fd7c4fc600..0000000000 --- a/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список рабочих областей - Получает список рабочих областей, в которых подключен бот - - - -`Функция ПолучитьСписокРабочихОбластей(Знач Токен, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Результат = OPI_Slack.ПолучитьСписокРабочихОбластей(Токен); -``` - - - - - - ```bash - oint slack ПолучитьСписокРабочихОбластей --token "***" - ``` - - - - ```batch - oint slack ПолучитьСписокРабочихОбластей ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "teams": [ - { - "id": "T06UD92BS3C", - "name": "OpenIntegrations" - } - ] -} -``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.mdx b/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.mdx new file mode 100644 index 0000000000..807feae453 --- /dev/null +++ b/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список рабочих областей + Получает список рабочих областей, в которых подключен бот + + + +`Функция ПолучитьСписокРабочихОбластей(Знач Токен, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Результат = OPI_Slack.ПолучитьСписокРабочихОбластей(Токен); +``` + + + + + + ```bash + oint slack ПолучитьСписокРабочихОбластей --token "***" + ``` + + + + ```batch + oint slack ПолучитьСписокРабочихОбластей ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "teams": [ + { + "id": "T06UD92BS3C", + "name": "OpenIntegrations" + } + ] +} +``` diff --git a/docs/ru/md/Slack/Message-management/Delete-message.md b/docs/ru/md/Slack/Message-management/Delete-message.md deleted file mode 100644 index 7d78f4cab9..0000000000 --- a/docs/ru/md/Slack/Message-management/Delete-message.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить сообщение - Удаляет сообщение канала по timestamp - - - -`Функция УдалитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач ЭтоОтложенное = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка или ID сообщения | - | ЭтоОтложенное | --issheduled | Булево | Признак удаления отложенного сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - Отметка = "1728823163.597989"; - - Результат = OPI_Slack.УдалитьСообщение(Токен, Канал, Отметка); -``` - - - - - - ```bash - oint slack УдалитьСообщение --token "***" \ - --channel "C06UFNUTKUL" \ - --stamp "1728973059.579729" - ``` - - - - ```batch - oint slack УдалитьСообщение ^ - --token "***" ^ - --channel "C06UFNUTKUL" ^ - --stamp "1728973059.579729" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1728409447.484679" -} -``` diff --git a/docs/ru/md/Slack/Message-management/Delete-message.mdx b/docs/ru/md/Slack/Message-management/Delete-message.mdx new file mode 100644 index 0000000000..58abb4a2d1 --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Delete-message.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить сообщение + Удаляет сообщение канала по timestamp + + + +`Функция УдалитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач ЭтоОтложенное = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + | ЭтоОтложенное | --issheduled | Булево | Признак удаления отложенного сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + Отметка = "1728823163.597989"; + + Результат = OPI_Slack.УдалитьСообщение(Токен, Канал, Отметка); +``` + + + + + + ```bash + oint slack УдалитьСообщение --token "***" \ + --channel "C06UFNUTKUL" \ + --stamp "1728973059.579729" + ``` + + + + ```batch + oint slack УдалитьСообщение ^ + --token "***" ^ + --channel "C06UFNUTKUL" ^ + --stamp "1728973059.579729" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1728409447.484679" +} +``` diff --git a/docs/ru/md/Slack/Message-management/Edit-message.md b/docs/ru/md/Slack/Message-management/Edit-message.md deleted file mode 100644 index 58e1bf0e46..0000000000 --- a/docs/ru/md/Slack/Message-management/Edit-message.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить сообщение - Изменяет состав существующего сообщения - - - -`Функция ИзменитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Текст = "", Знач МассивБлоков = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка сообщения | - | Текст | --text | Строка | Новый текст сообщения | - | МассивБлоков | --blocks | Массив Из Структура | JSON массива описаний блоков | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - Отметка = "1728823163.597989"; - - Текст = "Тестовое сообщение 2"; - - Результат = OPI_Slack.ИзменитьСообщение(Токен, Канал, Отметка, Текст); -``` - - - - - - ```bash - oint slack ИзменитьСообщение --token "***" \ - --channel "C06UFNUTKUL" \ - --stamp "1728973059.579729" \ - --text "Тестовое сообщение 2" - ``` - - - - ```batch - oint slack ИзменитьСообщение ^ - --token "***" ^ - --channel "C06UFNUTKUL" ^ - --stamp "1728973059.579729" ^ - --text "Тестовое сообщение 2" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1728409447.484679", - "text": "Тестовое сообщение 2", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "edited": { - "user": "B06TZ0MJV5M", - "ts": "1728409448.000000" - }, - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "Тестовое сообщение 2", - "team": "T06UD92BS3C", - "bot_profile": { - "id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "name": "OpenIntegrations", - "icons": { - "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", - "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" - }, - "deleted": false, - "updated": 1713205238, - "team_id": "T06UD92BS3C" - }, - "blocks": [ - { - "type": "rich_text", - "block_id": "gpG", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "Тестовое сообщение 2" - } - ] - } - ] - } - ] - } -} -``` diff --git a/docs/ru/md/Slack/Message-management/Edit-message.mdx b/docs/ru/md/Slack/Message-management/Edit-message.mdx new file mode 100644 index 0000000000..971fec88f8 --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Edit-message.mdx @@ -0,0 +1,114 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить сообщение + Изменяет состав существующего сообщения + + + +`Функция ИзменитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Текст = "", Знач МассивБлоков = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка сообщения | + | Текст | --text | Строка | Новый текст сообщения | + | МассивБлоков | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + Отметка = "1728823163.597989"; + + Текст = "Тестовое сообщение 2"; + + Результат = OPI_Slack.ИзменитьСообщение(Токен, Канал, Отметка, Текст); +``` + + + + + + ```bash + oint slack ИзменитьСообщение --token "***" \ + --channel "C06UFNUTKUL" \ + --stamp "1728973059.579729" \ + --text "Тестовое сообщение 2" + ``` + + + + ```batch + oint slack ИзменитьСообщение ^ + --token "***" ^ + --channel "C06UFNUTKUL" ^ + --stamp "1728973059.579729" ^ + --text "Тестовое сообщение 2" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1728409447.484679", + "text": "Тестовое сообщение 2", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "edited": { + "user": "B06TZ0MJV5M", + "ts": "1728409448.000000" + }, + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "Тестовое сообщение 2", + "team": "T06UD92BS3C", + "bot_profile": { + "id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "name": "OpenIntegrations", + "icons": { + "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", + "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" + }, + "deleted": false, + "updated": 1713205238, + "team_id": "T06UD92BS3C" + }, + "blocks": [ + { + "type": "rich_text", + "block_id": "gpG", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "Тестовое сообщение 2" + } + ] + } + ] + } + ] + } +} +``` diff --git a/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md b/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md deleted file mode 100644 index 2352ed20d7..0000000000 --- a/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить список отложенных сообщений - Получает список отложенных сообщений канала - - - -`Функция ПолучитьСписокОтложенныхСообщений(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - - Результат = OPI_Slack.ПолучитьСписокОтложенныхСообщений(Токен, Канал); -``` - - - - - - ```bash - oint slack ПолучитьСписокОтложенныхСообщений --token "***" \ - --channel "C06UFNUTKUL" - ``` - - - - ```batch - oint slack ПолучитьСписокОтложенныхСообщений ^ - --token "***" ^ - --channel "C06UFNUTKUL" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "scheduled_messages": [], - "response_metadata": { - "next_cursor": "" - } -} -``` diff --git a/docs/ru/md/Slack/Message-management/Get-delayed-message-list.mdx b/docs/ru/md/Slack/Message-management/Get-delayed-message-list.mdx new file mode 100644 index 0000000000..15f0a9350f --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Get-delayed-message-list.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить список отложенных сообщений + Получает список отложенных сообщений канала + + + +`Функция ПолучитьСписокОтложенныхСообщений(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + + Результат = OPI_Slack.ПолучитьСписокОтложенныхСообщений(Токен, Канал); +``` + + + + + + ```bash + oint slack ПолучитьСписокОтложенныхСообщений --token "***" \ + --channel "C06UFNUTKUL" + ``` + + + + ```batch + oint slack ПолучитьСписокОтложенныхСообщений ^ + --token "***" ^ + --channel "C06UFNUTKUL" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "scheduled_messages": [], + "response_metadata": { + "next_cursor": "" + } +} +``` diff --git a/docs/ru/md/Slack/Message-management/Get-message-link.md b/docs/ru/md/Slack/Message-management/Get-message-link.md deleted file mode 100644 index 10a6822734..0000000000 --- a/docs/ru/md/Slack/Message-management/Get-message-link.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить ссылку на сообщение - Получает постоянный UTL к сообщению канала - - - -`Функция ПолучитьСсылкуНаСообщение(Знач Токен, Знач Канал, Знач Отметка) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка или ID сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - Отметка = "1728823163.597989"; - - Результат = OPI_Slack.ПолучитьСсылкуНаСообщение(Токен, Канал, Отметка); -``` - - - - - - ```bash - oint slack ПолучитьСсылкуНаСообщение --token "***" \ - --channel "C06UFNUTKUL" \ - --stamp "1728973059.579729" - ``` - - - - ```batch - oint slack ПолучитьСсылкуНаСообщение ^ - --token "***" ^ - --channel "C06UFNUTKUL" ^ - --stamp "1728973059.579729" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1728409447484679", - "channel": "C06UFNUTKUL" -} -``` diff --git a/docs/ru/md/Slack/Message-management/Get-message-link.mdx b/docs/ru/md/Slack/Message-management/Get-message-link.mdx new file mode 100644 index 0000000000..e48e7e6e20 --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Get-message-link.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить ссылку на сообщение + Получает постоянный UTL к сообщению канала + + + +`Функция ПолучитьСсылкуНаСообщение(Знач Токен, Знач Канал, Знач Отметка) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + Отметка = "1728823163.597989"; + + Результат = OPI_Slack.ПолучитьСсылкуНаСообщение(Токен, Канал, Отметка); +``` + + + + + + ```bash + oint slack ПолучитьСсылкуНаСообщение --token "***" \ + --channel "C06UFNUTKUL" \ + --stamp "1728973059.579729" + ``` + + + + ```batch + oint slack ПолучитьСсылкуНаСообщение ^ + --token "***" ^ + --channel "C06UFNUTKUL" ^ + --stamp "1728973059.579729" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1728409447484679", + "channel": "C06UFNUTKUL" +} +``` diff --git a/docs/ru/md/Slack/Message-management/Get-message-reply-list.md b/docs/ru/md/Slack/Message-management/Get-message-reply-list.md deleted file mode 100644 index ab1d025916..0000000000 --- a/docs/ru/md/Slack/Message-management/Get-message-reply-list.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить список ответов на сообщение - Получает массив сообщений, которые являются ответом на указанное - - - -`Функция ПолучитьСписокОтветовНаСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка или ID сообщения | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - Отметка = "1728823163.597989"; - - Результат = OPI_Slack.ПолучитьСписокОтветовНаСообщение(Токен, Канал, Отметка); -``` - - - - - - ```bash - oint slack ПолучитьСписокОтветовНаСообщение --token "***" \ - --channel "C06UFNUTKUL" \ - --stamp "1728973059.579729" - ``` - - - - ```batch - oint slack ПолучитьСписокОтветовНаСообщение ^ - --token "***" ^ - --channel "C06UFNUTKUL" ^ - --stamp "1728973059.579729" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "messages": [ - { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1728409447.484679", - "edited": { - "user": "B06TZ0MJV5M", - "ts": "1728409448.000000" - }, - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "Тестовое сообщение 2", - "team": "T06UD92BS3C", - "bot_profile": { - "id": "B06TZ0MJV5M", - "deleted": false, - "name": "OpenIntegrations", - "updated": 1713205238, - "app_id": "A06TYNH45RV", - "icons": { - "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", - "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" - }, - "team_id": "T06UD92BS3C" - }, - "blocks": [ - { - "type": "rich_text", - "block_id": "rhPcy", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "Тестовое сообщение 2" - } - ] - } - ] - } - ] - } - ], - "has_more": false -} -``` diff --git a/docs/ru/md/Slack/Message-management/Get-message-reply-list.mdx b/docs/ru/md/Slack/Message-management/Get-message-reply-list.mdx new file mode 100644 index 0000000000..bdef505a3b --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Get-message-reply-list.mdx @@ -0,0 +1,110 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить список ответов на сообщение + Получает массив сообщений, которые являются ответом на указанное + + + +`Функция ПолучитьСписокОтветовНаСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + Отметка = "1728823163.597989"; + + Результат = OPI_Slack.ПолучитьСписокОтветовНаСообщение(Токен, Канал, Отметка); +``` + + + + + + ```bash + oint slack ПолучитьСписокОтветовНаСообщение --token "***" \ + --channel "C06UFNUTKUL" \ + --stamp "1728973059.579729" + ``` + + + + ```batch + oint slack ПолучитьСписокОтветовНаСообщение ^ + --token "***" ^ + --channel "C06UFNUTKUL" ^ + --stamp "1728973059.579729" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "messages": [ + { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1728409447.484679", + "edited": { + "user": "B06TZ0MJV5M", + "ts": "1728409448.000000" + }, + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "Тестовое сообщение 2", + "team": "T06UD92BS3C", + "bot_profile": { + "id": "B06TZ0MJV5M", + "deleted": false, + "name": "OpenIntegrations", + "updated": 1713205238, + "app_id": "A06TYNH45RV", + "icons": { + "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", + "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" + }, + "team_id": "T06UD92BS3C" + }, + "blocks": [ + { + "type": "rich_text", + "block_id": "rhPcy", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "Тестовое сообщение 2" + } + ] + } + ] + } + ] + } + ], + "has_more": false +} +``` diff --git a/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md b/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md deleted file mode 100644 index 26475f1bca..0000000000 --- a/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Отправить эфемерное сообщение -Отправляет сообщение, которое приходит в канал, но видно только конкретному пользователю - - - -`Функция ОтправитьЭфемерноеСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач Пользователь = "", Знач Блоки = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Текст | --text | Строка | Текст сообщения | - | Пользователь | --user | Строка | ID пользователя | - | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - Пользователь = "U06UABH3APP"; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - Текст = "Эфимерное сообщение"; - - Блок = OPI_Slack.СформироватьБлокКартинку(Картинка, "Картинка"); - Результат = OPI_Slack.ОтправитьЭфемерноеСообщение(Токен, Канал, Текст, Пользователь, Блок); -``` - - - - - - ```bash - oint slack ОтправитьЭфемерноеСообщение --token "***" \ - --channel "C06UFNUTKUL" \ - --text "Эфимерное сообщение" \ - --user "U06UABH3APP" \ - --blocks "{'type':'image','image_url':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','alt_text':'Картинка'}" - ``` - - - - ```batch - oint slack ОтправитьЭфемерноеСообщение ^ - --token "***" ^ - --channel "C06UFNUTKUL" ^ - --text "Эфимерное сообщение" ^ - --user "U06UABH3APP" ^ - --blocks "{'type':'image','image_url':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','alt_text':'Картинка'}" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "message_ts": "1728409450.000300" -} -``` diff --git a/docs/ru/md/Slack/Message-management/Send-ephemeral-message.mdx b/docs/ru/md/Slack/Message-management/Send-ephemeral-message.mdx new file mode 100644 index 0000000000..6815c5ddfc --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Send-ephemeral-message.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Отправить эфемерное сообщение +Отправляет сообщение, которое приходит в канал, но видно только конкретному пользователю + + + +`Функция ОтправитьЭфемерноеСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач Пользователь = "", Знач Блоки = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Текст | --text | Строка | Текст сообщения | + | Пользователь | --user | Строка | ID пользователя | + | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + Пользователь = "U06UABH3APP"; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + Текст = "Эфимерное сообщение"; + + Блок = OPI_Slack.СформироватьБлокКартинку(Картинка, "Картинка"); + Результат = OPI_Slack.ОтправитьЭфемерноеСообщение(Токен, Канал, Текст, Пользователь, Блок); +``` + + + + + + ```bash + oint slack ОтправитьЭфемерноеСообщение --token "***" \ + --channel "C06UFNUTKUL" \ + --text "Эфимерное сообщение" \ + --user "U06UABH3APP" \ + --blocks "{'type':'image','image_url':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','alt_text':'Картинка'}" + ``` + + + + ```batch + oint slack ОтправитьЭфемерноеСообщение ^ + --token "***" ^ + --channel "C06UFNUTKUL" ^ + --text "Эфимерное сообщение" ^ + --user "U06UABH3APP" ^ + --blocks "{'type':'image','image_url':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','alt_text':'Картинка'}" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "message_ts": "1728409450.000300" +} +``` diff --git a/docs/ru/md/Slack/Message-management/Send-message.md b/docs/ru/md/Slack/Message-management/Send-message.md deleted file mode 100644 index eaa777ea89..0000000000 --- a/docs/ru/md/Slack/Message-management/Send-message.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Отправить сообщение - Отправляет сообщение в выбранный час - - - -`Функция ОтправитьСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач ДатаОтправки = "", Знач Блоки = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Текст | --text | Строка | Текст сообщения | - | ДатаОтправки | --date | Дата | Дата отправки для отложенного сообщения | - | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -
- - - - -```bsl title="Пример кода" - Токен = "xoxb-6965308400114-696804637..."; - Канал = "C06UFNUTKUL"; - - // Текстовое - - Текст = "Тестовое сообщение 1"; - Результат = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст); - - // С вложениями (в примере: блок с картинкой) - - Текст = "Сообщение с картинкой"; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - МассивБлоков = Новый Массив; - - Блок = OPI_Slack.СформироватьБлокКартинку(Картинка, "Картинка"); - МассивБлоков.Добавить(Блок); - - Результат = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст, , МассивБлоков); - - // Отложенное - - Текст = "Отложенное сообщение"; - Час = 3600; - Сутки = 24; - - ДатаОтправки = OPI_Инструменты.ПолучитьТекущуюДату() + (Сутки * Час); - Результат = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст, ДатаОтправки); -``` - - - - - - ```bash - oint slack ОтправитьСообщение --token "***" \ - --channel "C06UFNUTKUL" \ - --text "Отложенное сообщение" \ - --date 2024-10-16T09:17:43.1474062 - ``` - - - - ```batch - oint slack ОтправитьСообщение ^ - --token "***" ^ - --channel "C06UFNUTKUL" ^ - --text "Отложенное сообщение" ^ - --date 2024-10-16T09:17:43.1474062 - ``` - - - - -```json title="Результат" -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1728409447.484679", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1728409447.484679", - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "Тестовое сообщение 1", - "team": "T06UD92BS3C", - "bot_profile": { - "id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "name": "OpenIntegrations", - "icons": { - "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", - "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", - "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" - }, - "deleted": false, - "updated": 1713205238, - "team_id": "T06UD92BS3C" - }, - "blocks": [ - { - "type": "rich_text", - "block_id": "fog", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "Тестовое сообщение 1" - } - ] - } - ] - } - ] - } -} -``` diff --git a/docs/ru/md/Slack/Message-management/Send-message.mdx b/docs/ru/md/Slack/Message-management/Send-message.mdx new file mode 100644 index 0000000000..c91b5e8982 --- /dev/null +++ b/docs/ru/md/Slack/Message-management/Send-message.mdx @@ -0,0 +1,130 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Отправить сообщение + Отправляет сообщение в выбранный час + + + +`Функция ОтправитьСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач ДатаОтправки = "", Знач Блоки = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Текст | --text | Строка | Текст сообщения | + | ДатаОтправки | --date | Дата | Дата отправки для отложенного сообщения | + | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +
+ + + + +```bsl title="Пример кода" + Токен = "xoxb-6965308400114-696804637..."; + Канал = "C06UFNUTKUL"; + + // Текстовое + + Текст = "Тестовое сообщение 1"; + Результат = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст); + + // С вложениями (в примере: блок с картинкой) + + Текст = "Сообщение с картинкой"; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + МассивБлоков = Новый Массив; + + Блок = OPI_Slack.СформироватьБлокКартинку(Картинка, "Картинка"); + МассивБлоков.Добавить(Блок); + + Результат = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст, , МассивБлоков); + + // Отложенное + + Текст = "Отложенное сообщение"; + Час = 3600; + Сутки = 24; + + ДатаОтправки = OPI_Инструменты.ПолучитьТекущуюДату() + (Сутки * Час); + Результат = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст, ДатаОтправки); +``` + + + + + + ```bash + oint slack ОтправитьСообщение --token "***" \ + --channel "C06UFNUTKUL" \ + --text "Отложенное сообщение" \ + --date 2024-10-16T09:17:43.1474062 + ``` + + + + ```batch + oint slack ОтправитьСообщение ^ + --token "***" ^ + --channel "C06UFNUTKUL" ^ + --text "Отложенное сообщение" ^ + --date 2024-10-16T09:17:43.1474062 + ``` + + + + +```json title="Результат" +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1728409447.484679", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1728409447.484679", + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "Тестовое сообщение 1", + "team": "T06UD92BS3C", + "bot_profile": { + "id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "name": "OpenIntegrations", + "icons": { + "image_36": "https://a.slack-edge.com/80588/img/plugins/app/bot_36.png", + "image_48": "https://a.slack-edge.com/80588/img/plugins/app/bot_48.png", + "image_72": "https://a.slack-edge.com/80588/img/plugins/app/service_72.png" + }, + "deleted": false, + "updated": 1713205238, + "team_id": "T06UD92BS3C" + }, + "blocks": [ + { + "type": "rich_text", + "block_id": "fog", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "Тестовое сообщение 1" + } + ] + } + ] + } + ] + } +} +``` diff --git a/docs/ru/md/Telegram/Administration/Ban.md b/docs/ru/md/Telegram/Administration/Ban.md deleted file mode 100644 index ccdcf6e9c5..0000000000 --- a/docs/ru/md/Telegram/Administration/Ban.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Бан - Банит пользователя в выбранном чате - - - -`Функция Бан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | IDПользователя | --user | Строка, Число | ID целевого пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [banChatMember](https://core.telegram.org/bots/api#banchatmember) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDПользователя = "461699897"; - IDКанала = "@testsichee"; - - Результат = OPI_Telegram.Бан(Токен, IDКанала, IDПользователя); -``` - - - - - - ```bash - oint telegram Бан --token "***" \ - --chat "@testsichee" \ - --user "461699897" - ``` - - - - ```batch - oint telegram Бан ^ - --token "***" ^ - --chat "@testsichee" ^ - --user "461699897" - ``` - - - - -```json title="Результат" -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} -``` diff --git a/docs/ru/md/Telegram/Administration/Ban.mdx b/docs/ru/md/Telegram/Administration/Ban.mdx new file mode 100644 index 0000000000..8e9891c2da --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Ban.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Бан + Банит пользователя в выбранном чате + + + +`Функция Бан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | IDПользователя | --user | Строка, Число | ID целевого пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [banChatMember](https://core.telegram.org/bots/api#banchatmember) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDПользователя = "461699897"; + IDКанала = "@testsichee"; + + Результат = OPI_Telegram.Бан(Токен, IDКанала, IDПользователя); +``` + + + + + + ```bash + oint telegram Бан --token "***" \ + --chat "@testsichee" \ + --user "461699897" + ``` + + + + ```batch + oint telegram Бан ^ + --token "***" ^ + --chat "@testsichee" ^ + --user "461699897" + ``` + + + + +```json title="Результат" +{ + "ok": false, + "error_code": 400, + "description": "Bad Request: can't remove chat owner" +} +``` diff --git a/docs/ru/md/Telegram/Administration/Create-invitation-link.md b/docs/ru/md/Telegram/Administration/Create-invitation-link.md deleted file mode 100644 index 3b689c6e62..0000000000 --- a/docs/ru/md/Telegram/Administration/Create-invitation-link.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать ссылку-приглашение - Создает ссылку для вступления в закрытый чат - - - -`Функция СоздатьСсылкуПриглашение(Знач Токен, Знач IDЧата, Знач Заголовок = "", Знач ДатаИстечения = "", Знач ЛимитПользователей = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Заголовок | --title | Строка | Заголовок приглашения | - | ДатаИстечения | --expire | Дата | Дата окончания жизни ссылки (безсрочно, если не указано) | - | ЛимитПользователей | --limit | Число | Лимит пользователей (бесконечно, если не указано) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [createChatInviteLink](https://core.telegram.org/bots/api#createchatinvitelink) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - Сутки = 86400; - ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); - - Заголовок = "Ссылка " + Строка(ТекущаяДата); - Истечение = ТекущаяДата + Сутки; - UnixИстечение = OPI_Инструменты.UNIXTime(Истечение); - - Результат = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, IDКанала, Заголовок, Истечение, 200); -``` - - - - - - ```bash - oint telegram СоздатьСсылкуПриглашение --token "***" \ - --chat "@testsichee" \ - --expire 2024-10-16T08:56:57.5864404 \ - --title "Ссылка 15.10.2024 8:56:57" \ - --limit 200 - ``` - - - - ```batch - oint telegram СоздатьСсылкуПриглашение ^ - --token "***" ^ - --chat "@testsichee" ^ - --expire 2024-10-16T08:56:57.5864404 ^ - --title "Ссылка 15.10.2024 8:56:57" ^ - --limit 200 - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "invite_link": "https://t.me/+W4mnd9ZTHJRlZmVi", - "name": "Ссылка 08.10.2024 20:26:58", - "creator": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "expire_date": 1728502018, - "member_limit": 200, - "creates_join_request": false, - "is_primary": false, - "is_revoked": false - } -} -``` diff --git a/docs/ru/md/Telegram/Administration/Create-invitation-link.mdx b/docs/ru/md/Telegram/Administration/Create-invitation-link.mdx new file mode 100644 index 0000000000..fd6fa8683f --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Create-invitation-link.mdx @@ -0,0 +1,92 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать ссылку-приглашение + Создает ссылку для вступления в закрытый чат + + + +`Функция СоздатьСсылкуПриглашение(Знач Токен, Знач IDЧата, Знач Заголовок = "", Знач ДатаИстечения = "", Знач ЛимитПользователей = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Заголовок | --title | Строка | Заголовок приглашения | + | ДатаИстечения | --expire | Дата | Дата окончания жизни ссылки (безсрочно, если не указано) | + | ЛимитПользователей | --limit | Число | Лимит пользователей (бесконечно, если не указано) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [createChatInviteLink](https://core.telegram.org/bots/api#createchatinvitelink) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + Сутки = 86400; + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + + Заголовок = "Ссылка " + Строка(ТекущаяДата); + Истечение = ТекущаяДата + Сутки; + UnixИстечение = OPI_Инструменты.UNIXTime(Истечение); + + Результат = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, IDКанала, Заголовок, Истечение, 200); +``` + + + + + + ```bash + oint telegram СоздатьСсылкуПриглашение --token "***" \ + --chat "@testsichee" \ + --expire 2024-10-16T08:56:57.5864404 \ + --title "Ссылка 15.10.2024 8:56:57" \ + --limit 200 + ``` + + + + ```batch + oint telegram СоздатьСсылкуПриглашение ^ + --token "***" ^ + --chat "@testsichee" ^ + --expire 2024-10-16T08:56:57.5864404 ^ + --title "Ссылка 15.10.2024 8:56:57" ^ + --limit 200 + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "invite_link": "https://t.me/+W4mnd9ZTHJRlZmVi", + "name": "Ссылка 08.10.2024 20:26:58", + "creator": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "expire_date": 1728502018, + "member_limit": 200, + "creates_join_request": false, + "is_primary": false, + "is_revoked": false + } +} +``` diff --git a/docs/ru/md/Telegram/Administration/Delete-message.md b/docs/ru/md/Telegram/Administration/Delete-message.md deleted file mode 100644 index 34220a0d68..0000000000 --- a/docs/ru/md/Telegram/Administration/Delete-message.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Удалить сообщение - Удаляет указанное сообщение из чата или канала - - - -`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --chat | Строка, Число | ID целевого чата | - | IDСообщения | --message | Строка, Число | ID удаляемого сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [deleteMessage](https://core.telegram.org/bots/api#deletemessage) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "@testsichee"; - IDСообщения = "9761"; - - Результат = OPI_Telegram.УдалитьСообщение(Токен, IDЧата, IDСообщения); -``` - - - - - - ```bash - oint telegram УдалитьСообщение --token "***" \ - --chat "@testsichee" \ - --message "9781" - ``` - - - - ```batch - oint telegram УдалитьСообщение ^ - --token "***" ^ - --chat "@testsichee" ^ - --message "9781" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Administration/Delete-message.mdx b/docs/ru/md/Telegram/Administration/Delete-message.mdx new file mode 100644 index 0000000000..e89ce880bc --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Delete-message.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Удалить сообщение + Удаляет указанное сообщение из чата или канала + + + +`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --chat | Строка, Число | ID целевого чата | + | IDСообщения | --message | Строка, Число | ID удаляемого сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [deleteMessage](https://core.telegram.org/bots/api#deletemessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "@testsichee"; + IDСообщения = "9761"; + + Результат = OPI_Telegram.УдалитьСообщение(Токен, IDЧата, IDСообщения); +``` + + + + + + ```bash + oint telegram УдалитьСообщение --token "***" \ + --chat "@testsichee" \ + --message "9781" + ``` + + + + ```batch + oint telegram УдалитьСообщение ^ + --token "***" ^ + --chat "@testsichee" ^ + --message "9781" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Administration/Get-participant-count.md b/docs/ru/md/Telegram/Administration/Get-participant-count.md deleted file mode 100644 index 632193e3f6..0000000000 --- a/docs/ru/md/Telegram/Administration/Get-participant-count.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить число участников - Получает общее число участников чата - - - -`Функция ПолучитьЧислоУчастников(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [getChatMemberCount](https://core.telegram.org/bots/api#getchatmembercount) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - - Результат = OPI_Telegram.ПолучитьЧислоУчастников(Токен, IDКанала); -``` - - - - - - ```bash - oint telegram ПолучитьЧислоУчастников --token "***" \ - --chat "@testsichee" - ``` - - - - ```batch - oint telegram ПолучитьЧислоУчастников ^ - --token "***" ^ - --chat "@testsichee" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": 2 -} -``` diff --git a/docs/ru/md/Telegram/Administration/Get-participant-count.mdx b/docs/ru/md/Telegram/Administration/Get-participant-count.mdx new file mode 100644 index 0000000000..ef2359a8a2 --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Get-participant-count.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить число участников + Получает общее число участников чата + + + +`Функция ПолучитьЧислоУчастников(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [getChatMemberCount](https://core.telegram.org/bots/api#getchatmembercount) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + + Результат = OPI_Telegram.ПолучитьЧислоУчастников(Токен, IDКанала); +``` + + + + + + ```bash + oint telegram ПолучитьЧислоУчастников --token "***" \ + --chat "@testsichee" + ``` + + + + ```batch + oint telegram ПолучитьЧислоУчастников ^ + --token "***" ^ + --chat "@testsichee" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": 2 +} +``` diff --git a/docs/ru/md/Telegram/Administration/Pin-message.md b/docs/ru/md/Telegram/Administration/Pin-message.md deleted file mode 100644 index 993d477b2b..0000000000 --- a/docs/ru/md/Telegram/Administration/Pin-message.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Закрепить сообщение - Закрепляет сообщение в шапке чата - - - -`Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --chat | Строка, Число | ID целевого чата | - | IDСообщения | --message | Строка, Число | ID целевого сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [pinChatMessage](https://core.telegram.org/bots/api#pinchatmessage) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - IDСообщения = "9761"; - - Результат = OPI_Telegram.ЗакрепитьСообщение(Токен, IDКанала, IDСообщения); -``` - - - - - - ```bash - oint telegram ЗакрепитьСообщение --token "***" \ - --chat "@testsichee" \ - --message "9781" - ``` - - - - ```batch - oint telegram ЗакрепитьСообщение ^ - --token "***" ^ - --chat "@testsichee" ^ - --message "9781" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Administration/Pin-message.mdx b/docs/ru/md/Telegram/Administration/Pin-message.mdx new file mode 100644 index 0000000000..78f3f8469c --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Pin-message.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Закрепить сообщение + Закрепляет сообщение в шапке чата + + + +`Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --chat | Строка, Число | ID целевого чата | + | IDСообщения | --message | Строка, Число | ID целевого сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [pinChatMessage](https://core.telegram.org/bots/api#pinchatmessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + IDСообщения = "9761"; + + Результат = OPI_Telegram.ЗакрепитьСообщение(Токен, IDКанала, IDСообщения); +``` + + + + + + ```bash + oint telegram ЗакрепитьСообщение --token "***" \ + --chat "@testsichee" \ + --message "9781" + ``` + + + + ```batch + oint telegram ЗакрепитьСообщение ^ + --token "***" ^ + --chat "@testsichee" ^ + --message "9781" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Administration/Unban.md b/docs/ru/md/Telegram/Administration/Unban.md deleted file mode 100644 index 82e1a57018..0000000000 --- a/docs/ru/md/Telegram/Administration/Unban.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Разбан - Разбанивает забаненного ранее пользователя - - - -`Функция Разбан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | IDПользователя | --user | Строка, Число | ID целевого пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [unbanChatMember](https://core.telegram.org/bots/api#unbanchatmember) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDПользователя = "461699897"; - IDКанала = "@testsichee"; - - Результат = OPI_Telegram.Разбан(Токен, IDКанала, IDПользователя); -``` - - - - - - ```bash - oint telegram Разбан --token "***" \ - --chat "@testsichee" \ - --user "461699897" - ``` - - - - ```batch - oint telegram Разбан ^ - --token "***" ^ - --chat "@testsichee" ^ - --user "461699897" - ``` - - - - -```json title="Результат" -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} -``` diff --git a/docs/ru/md/Telegram/Administration/Unban.mdx b/docs/ru/md/Telegram/Administration/Unban.mdx new file mode 100644 index 0000000000..f1d2dd4a26 --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Unban.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Разбан + Разбанивает забаненного ранее пользователя + + + +`Функция Разбан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | IDПользователя | --user | Строка, Число | ID целевого пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [unbanChatMember](https://core.telegram.org/bots/api#unbanchatmember) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDПользователя = "461699897"; + IDКанала = "@testsichee"; + + Результат = OPI_Telegram.Разбан(Токен, IDКанала, IDПользователя); +``` + + + + + + ```bash + oint telegram Разбан --token "***" \ + --chat "@testsichee" \ + --user "461699897" + ``` + + + + ```batch + oint telegram Разбан ^ + --token "***" ^ + --chat "@testsichee" ^ + --user "461699897" + ``` + + + + +```json title="Результат" +{ + "ok": false, + "error_code": 400, + "description": "Bad Request: can't remove chat owner" +} +``` diff --git a/docs/ru/md/Telegram/Administration/Unpin-message.md b/docs/ru/md/Telegram/Administration/Unpin-message.md deleted file mode 100644 index 9093683c24..0000000000 --- a/docs/ru/md/Telegram/Administration/Unpin-message.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Открепить сообщение - Открепляет сообщение в шапке чата - - - -`Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата | - | IDСообщения | --message | Строка, Число | ID целевого сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [unpinChatMessage](https://core.telegram.org/bots/api#unpinchatmessage) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - IDСообщения = "9761"; - - Результат = OPI_Telegram.ОткрепитьСообщение(Токен, IDКанала, IDСообщения); -``` - - - - - - ```bash - oint telegram ОткрепитьСообщение --token "***" \ - --chat "@testsichee" \ - --message "9781" - ``` - - - - ```batch - oint telegram ОткрепитьСообщение ^ - --token "***" ^ - --chat "@testsichee" ^ - --message "9781" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Administration/Unpin-message.mdx b/docs/ru/md/Telegram/Administration/Unpin-message.mdx new file mode 100644 index 0000000000..9656144934 --- /dev/null +++ b/docs/ru/md/Telegram/Administration/Unpin-message.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Открепить сообщение + Открепляет сообщение в шапке чата + + + +`Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата | + | IDСообщения | --message | Строка, Число | ID целевого сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [unpinChatMessage](https://core.telegram.org/bots/api#unpinchatmessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + IDСообщения = "9761"; + + Результат = OPI_Telegram.ОткрепитьСообщение(Токен, IDКанала, IDСообщения); +``` + + + + + + ```bash + oint telegram ОткрепитьСообщение --token "***" \ + --chat "@testsichee" \ + --message "9781" + ``` + + + + ```batch + oint telegram ОткрепитьСообщение ^ + --token "***" ^ + --chat "@testsichee" ^ + --message "9781" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md deleted file mode 100644 index c5caa278f5..0000000000 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить Webhook - Удаляет URL обработчика событий бота для работы в режиме Webhook - - - -`Функция УдалитьWebhook(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [deleteWebhook](https://core.telegram.org/bots/api#deletewebhook) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.УдалитьWebhook(Токен); -``` - - - - - - ```bash - oint telegram УдалитьWebhook --token "***" - ``` - - - - ```batch - oint telegram УдалитьWebhook ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true, - "description": "Webhook was deleted" -} -``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.mdx b/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.mdx new file mode 100644 index 0000000000..ef477a115a --- /dev/null +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить Webhook + Удаляет URL обработчика событий бота для работы в режиме Webhook + + + +`Функция УдалитьWebhook(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [deleteWebhook](https://core.telegram.org/bots/api#deletewebhook) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.УдалитьWebhook(Токен); +``` + + + + + + ```bash + oint telegram УдалитьWebhook --token "***" + ``` + + + + ```batch + oint telegram УдалитьWebhook ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true, + "description": "Webhook was deleted" +} +``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md deleted file mode 100644 index 0dca0dac3e..0000000000 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Скачать файл - Скачивает файл с серверов Telegram - - - -`Функция СкачатьФайл(Знач Токен, Знач IDФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDФайла | --fileid | Строка | ID файла для скачивания | - - - Возвращаемое значение: ДвоичныеДанные - данные файла - -
- -:::tip -Метод в документации API: [getFile](https://core.telegram.org/bots/api#getfile) -::: -
- - -```bsl title="Пример кода" - IDФайла = "CQACAgIAAx0EcNsaZQACJdtnC600ChemDs9AfeCwKyUUQnYwzgACp1sAAj1KYEhCC24y7dGmOjYE"; - Токен = "6129457865:AAFyzNYOAFbu..."; - - Результат = OPI_Telegram.СкачатьФайл(Токен, IDФайла); -``` - - - - - - ```bash - oint telegram СкачатьФайл --token "***" \ - --fileid "CQACAgIAAx0EcNsaZQACJjtnDgO2ZimFeISq7ttxPDiI1yyo9QACcGMAApEmcEiFxLzdH2cMWTYE" - ``` - - - - ```batch - oint telegram СкачатьФайл ^ - --token "***" ^ - --fileid "CQACAgIAAx0EcNsaZQACJjtnDgO2ZimFeISq7ttxPDiI1yyo9QACcGMAApEmcEiFxLzdH2cMWTYE" - ``` - - - - -```json title="Результат" -НЕ JSON: 49 44 33 03 00 00 00 05 1F 76 54 49 54 32 00 00 00 0B 00 00 01 FF FE 44 00 6F 00 67 00 73 00 54 50 45 31 00 00 00 15 00 00 01 FF FE 4D 00 6F 00 74 00 6F 00 72 00 68 00 65 00 61 00 64 00 54 59… -``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.mdx b/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.mdx new file mode 100644 index 0000000000..09981ad26a --- /dev/null +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Скачать файл + Скачивает файл с серверов Telegram + + + +`Функция СкачатьФайл(Знач Токен, Знач IDФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла для скачивания | + + + Возвращаемое значение: ДвоичныеДанные - данные файла + +
+ +:::tip +Метод в документации API: [getFile](https://core.telegram.org/bots/api#getfile) +::: +
+ + +```bsl title="Пример кода" + IDФайла = "CQACAgIAAx0EcNsaZQACJdtnC600ChemDs9AfeCwKyUUQnYwzgACp1sAAj1KYEhCC24y7dGmOjYE"; + Токен = "6129457865:AAFyzNYOAFbu..."; + + Результат = OPI_Telegram.СкачатьФайл(Токен, IDФайла); +``` + + + + + + ```bash + oint telegram СкачатьФайл --token "***" \ + --fileid "CQACAgIAAx0EcNsaZQACJjtnDgO2ZimFeISq7ttxPDiI1yyo9QACcGMAApEmcEiFxLzdH2cMWTYE" + ``` + + + + ```batch + oint telegram СкачатьФайл ^ + --token "***" ^ + --fileid "CQACAgIAAx0EcNsaZQACJjtnDgO2ZimFeISq7ttxPDiI1yyo9QACcGMAApEmcEiFxLzdH2cMWTYE" + ``` + + + + +```json title="Результат" +НЕ JSON: 49 44 33 03 00 00 00 05 1F 76 54 49 54 32 00 00 00 0B 00 00 01 FF FE 44 00 6F 00 67 00 73 00 54 50 45 31 00 00 00 15 00 00 01 FF FE 4D 00 6F 00 74 00 6F 00 72 00 68 00 65 00 61 00 64 00 54 59… +``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md deleted file mode 100644 index 3ef94dd649..0000000000 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о боте - Выполняет запрос, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д. - - - -`Функция ПолучитьИнформациюБота(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [getMe](https://core.telegram.org/bots/api#getme) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.ПолучитьИнформациюБота(Токен); -``` - - - - - - ```bash - oint telegram ПолучитьИнформациюБота --token "***" - ``` - - - - ```batch - oint telegram ПолучитьИнформациюБота ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot", - "can_join_groups": true, - "can_read_all_group_messages": false, - "supports_inline_queries": false, - "can_connect_to_business": false, - "has_main_web_app": false - } -} -``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.mdx b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.mdx new file mode 100644 index 0000000000..bfa66eeac2 --- /dev/null +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить информацию о боте + Выполняет запрос, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д. + + + +`Функция ПолучитьИнформациюБота(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [getMe](https://core.telegram.org/bots/api#getme) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.ПолучитьИнформациюБота(Токен); +``` + + + + + + ```bash + oint telegram ПолучитьИнформациюБота --token "***" + ``` + + + + ```batch + oint telegram ПолучитьИнформациюБота ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot", + "can_join_groups": true, + "can_read_all_group_messages": false, + "supports_inline_queries": false, + "can_connect_to_business": false, + "has_main_web_app": false + } +} +``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md deleted file mode 100644 index 9942f1d536..0000000000 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить обновления - Выполняет запрос, возвращающий информацию о событиях бота. Используется при работе в polling режиме - - - -`Функция ПолучитьОбновления(Знач Токен, Знач Таймаут = 0, Знач Смещение = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Таймаут | --timeout | Строка,Число | Время ожидания новых событий | - | Смещение | --offset | Строка,Число | Смещение в списке получаемых сообщений | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [getUpdates](https://core.telegram.org/bots/api#getupdates) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.ПолучитьОбновления(Токен); -``` - - - - - - ```bash - oint telegram ПолучитьОбновления --token "***" - ``` - - - - ```batch - oint telegram ПолучитьОбновления ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": [ - { - "update_id": 291368988, - "channel_post": { - "message_id": 9379, - "sender_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "date": 1728325487, - "pinned_message": { - "message_id": 9360, - "sender_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "date": 1728325259, - "text": "Строковое значение" - } - } - }, - { - "update_id": 291368989, - "message": { - "message_id": 5363, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728325520, - "message_thread_id": 5363, - "forum_topic_created": { - "name": "Тестовая тема 6893bf69-7fb2-4e58-9069-7d0f17fcb054", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - } - }, - { - "update_id": 291368990, - "message": { - "message_id": 5365, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728325521, - "message_thread_id": 5363, - "reply_to_message": { - "message_id": 5363, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728325520, - "message_thread_id": 5363, - "forum_topic_created": { - "name": "Тестовая тема 6893bf69-7fb2-4e58-9069-7d0f17fcb054", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - }, - "forum_topic_edited": { - "name": "Новый тестовый заголовок", - "icon_custom_emoji_id": "5310132165583840589" - }, - "is_topic_message": true - } - }, - { - "update_id": 291368991, - "message": { - "message_id": 5366, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728325526, - "forum_topic_reopened": {} - } - }, - { - "update_id": 291368992, - "message": { - "message_id": 5367, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1728325526, -... -``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.mdx b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.mdx new file mode 100644 index 0000000000..3eda70f63d --- /dev/null +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.mdx @@ -0,0 +1,207 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить обновления + Выполняет запрос, возвращающий информацию о событиях бота. Используется при работе в polling режиме + + + +`Функция ПолучитьОбновления(Знач Токен, Знач Таймаут = 0, Знач Смещение = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Таймаут | --timeout | Строка,Число | Время ожидания новых событий | + | Смещение | --offset | Строка,Число | Смещение в списке получаемых сообщений | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [getUpdates](https://core.telegram.org/bots/api#getupdates) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.ПолучитьОбновления(Токен); +``` + + + + + + ```bash + oint telegram ПолучитьОбновления --token "***" + ``` + + + + ```batch + oint telegram ПолучитьОбновления ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": [ + { + "update_id": 291368988, + "channel_post": { + "message_id": 9379, + "sender_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "date": 1728325487, + "pinned_message": { + "message_id": 9360, + "sender_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "date": 1728325259, + "text": "Строковое значение" + } + } + }, + { + "update_id": 291368989, + "message": { + "message_id": 5363, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728325520, + "message_thread_id": 5363, + "forum_topic_created": { + "name": "Тестовая тема 6893bf69-7fb2-4e58-9069-7d0f17fcb054", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + } + }, + { + "update_id": 291368990, + "message": { + "message_id": 5365, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728325521, + "message_thread_id": 5363, + "reply_to_message": { + "message_id": 5363, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728325520, + "message_thread_id": 5363, + "forum_topic_created": { + "name": "Тестовая тема 6893bf69-7fb2-4e58-9069-7d0f17fcb054", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + }, + "forum_topic_edited": { + "name": "Новый тестовый заголовок", + "icon_custom_emoji_id": "5310132165583840589" + }, + "is_topic_message": true + } + }, + { + "update_id": 291368991, + "message": { + "message_id": 5366, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728325526, + "forum_topic_reopened": {} + } + }, + { + "update_id": 291368992, + "message": { + "message_id": 5367, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1728325526, +... +``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md deleted file mode 100644 index 0a8a8207be..0000000000 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Установить Webhook - Устанавливает URL обработчика событий бота для работы в режиме Webhook - - - -`Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | URL | --url | Строка | Адрес обработки запросов от Telegram (с https:) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [setWebhook](https://core.telegram.org/bots/api#setwebhook) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - URL = "https://api.athenaeum.digital/opi/hs/twitter"; - - Результат = OPI_Telegram.УстановитьWebhook(Токен, URL); -``` - - - - - - ```bash - oint telegram УстановитьWebhook --token "***" \ - --url "https://api.athenaeum.digital/opi/hs/twitter" - ``` - - - - ```batch - oint telegram УстановитьWebhook ^ - --token "***" ^ - --url "https://api.athenaeum.digital/opi/hs/twitter" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true, - "description": "Webhook was set" -} -``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.mdx b/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.mdx new file mode 100644 index 0000000000..f3c79ecd4a --- /dev/null +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Установить Webhook + Устанавливает URL обработчика событий бота для работы в режиме Webhook + + + +`Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | URL | --url | Строка | Адрес обработки запросов от Telegram (с https:) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [setWebhook](https://core.telegram.org/bots/api#setwebhook) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + URL = "https://api.athenaeum.digital/opi/hs/twitter"; + + Результат = OPI_Telegram.УстановитьWebhook(Токен, URL); +``` + + + + + + ```bash + oint telegram УстановитьWebhook --token "***" \ + --url "https://api.athenaeum.digital/opi/hs/twitter" + ``` + + + + ```batch + oint telegram УстановитьWebhook ^ + --token "***" ^ + --url "https://api.athenaeum.digital/opi/hs/twitter" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true, + "description": "Webhook was set" +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md b/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md deleted file mode 100644 index 45a18ab770..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Сформировать клавиатуру по массиву кнопок - Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели - - - -`Функция СформироватьКлавиатуруПоМассивуКнопок(Знач МассивКнопок, Знач ПодСообщением = Ложь, Знач ОднаПодОдной = Истина) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | - | ПодСообщением | --under | Булево | Клавиатура под сообщением или на нижней панели | - | ОднаПодОдной | --column | Булево | Истина > кнопки выводятся в столбик, Ложь > в строку | - - - Возвращаемое значение: Строка - JSON клавиатуры - -
- -:::tip -О клавиатурах в документации API: [InlineKeyboardMarkup](https://core.telegram.org/bots/api#inlinekeyboardmarkup) -::: -
- - -```bsl title="Пример кода" - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Кнопка1"); - МассивКнопок.Добавить("Кнопка2"); - МассивКнопок.Добавить("Кнопка3"); - - Результат = OPI_Telegram.СформироватьКлавиатуруПоМассивуКнопок(МассивКнопок); -``` - - - - -```json title="Результат" -"{\r\n \"keyboard\": [\r\n [\r\n {\r\n \"text\": \"Кнопка1\",\r\n \"callback_data\": \"Кнопка1\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Кнопка2\",\r\n \"callback_data\": \"Кнопка2\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Кнопка3\",\r\n \"callback_data\": \"Кнопка3\"\r\n }\r\n ]\r\n ],\r\n \"resize_keyboard\": true\r\n}" -``` diff --git a/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.mdx b/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.mdx new file mode 100644 index 0000000000..714b234c67 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.mdx @@ -0,0 +1,46 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Сформировать клавиатуру по массиву кнопок + Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели + + + +`Функция СформироватьКлавиатуруПоМассивуКнопок(Знач МассивКнопок, Знач ПодСообщением = Ложь, Знач ОднаПодОдной = Истина) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | + | ПодСообщением | --under | Булево | Клавиатура под сообщением или на нижней панели | + | ОднаПодОдной | --column | Булево | Истина > кнопки выводятся в столбик, Ложь > в строку | + + + Возвращаемое значение: Строка - JSON клавиатуры + +
+ +:::tip +О клавиатурах в документации API: [InlineKeyboardMarkup](https://core.telegram.org/bots/api#inlinekeyboardmarkup) +::: +
+ + +```bsl title="Пример кода" + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Кнопка1"); + МассивКнопок.Добавить("Кнопка2"); + МассивКнопок.Добавить("Кнопка3"); + + Результат = OPI_Telegram.СформироватьКлавиатуруПоМассивуКнопок(МассивКнопок); +``` + + + + +```json title="Результат" +"{\r\n \"keyboard\": [\r\n [\r\n {\r\n \"text\": \"Кнопка1\",\r\n \"callback_data\": \"Кнопка1\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Кнопка2\",\r\n \"callback_data\": \"Кнопка2\"\r\n }\r\n ],\r\n [\r\n {\r\n \"text\": \"Кнопка3\",\r\n \"callback_data\": \"Кнопка3\"\r\n }\r\n ]\r\n ],\r\n \"resize_keyboard\": true\r\n}" +``` diff --git a/docs/ru/md/Telegram/Data-sending/Forward-message.md b/docs/ru/md/Telegram/Data-sending/Forward-message.md deleted file mode 100644 index 801eafc398..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Forward-message.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Переслать сообщение - Пересылает сообщение между чатами или в рамках одного чата - - - -`Функция ПереслатьСообщение(Знач Токен, Знач IDОригинала, Знач ОткудаID, Знач КудаID) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDОригинала | --message | Строка, Число | ID оригинального сообщения | - | ОткудаID | --from | Строка, Число | ID чата оригинального сообщения | - | КудаID | --to | Строка, Число | ID целевого чата или IDЧата*IDТемы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [forwardMessage](https://core.telegram.org/bots/api#forwardmessage) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - IDСообщения = "9761"; - - Результат = OPI_Telegram.ПереслатьСообщение(Токен, IDСообщения, IDКанала, IDЧата); -``` - - - - - - ```bash - oint telegram ПереслатьСообщение --token "***" \ - --from "@testsichee" \ - --to "461699897" \ - --message "9781" - ``` - - - - ```batch - oint telegram ПереслатьСообщение ^ - --token "***" ^ - --from "@testsichee" ^ - --to "461699897" ^ - --message "9781" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8287, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408397, - "forward_origin": { - "type": "channel", - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "message_id": 9400, - "date": 1728408204 - }, - "forward_from_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "forward_from_message_id": 9400, - "forward_date": 1728408204, - "text": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Forward-message.mdx b/docs/ru/md/Telegram/Data-sending/Forward-message.mdx new file mode 100644 index 0000000000..d4be2d3438 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Forward-message.mdx @@ -0,0 +1,107 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Переслать сообщение + Пересылает сообщение между чатами или в рамках одного чата + + + +`Функция ПереслатьСообщение(Знач Токен, Знач IDОригинала, Знач ОткудаID, Знач КудаID) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDОригинала | --message | Строка, Число | ID оригинального сообщения | + | ОткудаID | --from | Строка, Число | ID чата оригинального сообщения | + | КудаID | --to | Строка, Число | ID целевого чата или IDЧата*IDТемы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [forwardMessage](https://core.telegram.org/bots/api#forwardmessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + IDСообщения = "9761"; + + Результат = OPI_Telegram.ПереслатьСообщение(Токен, IDСообщения, IDКанала, IDЧата); +``` + + + + + + ```bash + oint telegram ПереслатьСообщение --token "***" \ + --from "@testsichee" \ + --to "461699897" \ + --message "9781" + ``` + + + + ```batch + oint telegram ПереслатьСообщение ^ + --token "***" ^ + --from "@testsichee" ^ + --to "461699897" ^ + --message "9781" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8287, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408397, + "forward_origin": { + "type": "channel", + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "message_id": 9400, + "date": 1728408204 + }, + "forward_from_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "forward_from_message_id": 9400, + "forward_date": 1728408204, + "text": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-audio.md b/docs/ru/md/Telegram/Data-sending/Send-audio.md deleted file mode 100644 index 327ac114a8..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-audio.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Отправить аудио - Отправляет аудиофайл в чат или канал - - - -`Функция ОтправитьАудио(Знач Токен, Знач IDЧата, Знач Текст, Знач Аудио, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Аудио | --audio | ДвоичныеДанные, Строка | Файл аудио | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendAudio](https://core.telegram.org/bots/api#sendaudio) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Аудио = "https://api.athenaeum.digital/test_data/song.mp3"; - - АудиоПуть = ПолучитьИмяВременногоФайла("mp3"); - КопироватьФайл(Аудио, АудиоПуть); - - АудиоДД = Новый ДвоичныеДанные(АудиоПуть); - - Результат = OPI_Telegram.ОтправитьАудио(Токен, IDЧата, Текст, Аудио); - - Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоПуть); - - Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоДД); -``` - - - - - - ```bash - oint telegram ОтправитьАудио --token "***" \ - --chat "@testsichee" \ - --text "Строковое значение" \ - --audio "C:\Users\Administrator\AppData\Local\Temp\0xvlclunabj.mp3" - ``` - - - - ```batch - oint telegram ОтправитьАудио ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Строковое значение" ^ - --audio "C:\Users\Administrator\AppData\Local\Temp\0xvlclunabj.mp3" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8278, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408273, - "audio": { - "duration": 228, - "file_name": "audio", - "mime_type": "audio/mpeg", - "title": "Dogs", - "performer": "Motorhead", - "file_id": "CQACAgIAAxkDAAIgVmcFatAfi1tp6gnR4pa6qSPPUl4OAAKIXQAC_cgwSE-J_MttICg0NgQ", - "file_unique_id": "AgADiF0AAv3IMEg", - "file_size": 9229352 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-audio.mdx b/docs/ru/md/Telegram/Data-sending/Send-audio.mdx new file mode 100644 index 0000000000..a9dd42be55 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-audio.mdx @@ -0,0 +1,110 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Отправить аудио + Отправляет аудиофайл в чат или канал + + + +`Функция ОтправитьАудио(Знач Токен, Знач IDЧата, Знач Текст, Знач Аудио, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Аудио | --audio | ДвоичныеДанные, Строка | Файл аудио | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendAudio](https://core.telegram.org/bots/api#sendaudio) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Аудио = "https://api.athenaeum.digital/test_data/song.mp3"; + + АудиоПуть = ПолучитьИмяВременногоФайла("mp3"); + КопироватьФайл(Аудио, АудиоПуть); + + АудиоДД = Новый ДвоичныеДанные(АудиоПуть); + + Результат = OPI_Telegram.ОтправитьАудио(Токен, IDЧата, Текст, Аудио); + + Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоПуть); + + Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоДД); +``` + + + + + + ```bash + oint telegram ОтправитьАудио --token "***" \ + --chat "@testsichee" \ + --text "Строковое значение" \ + --audio "C:\Users\Administrator\AppData\Local\Temp\0xvlclunabj.mp3" + ``` + + + + ```batch + oint telegram ОтправитьАудио ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Строковое значение" ^ + --audio "C:\Users\Administrator\AppData\Local\Temp\0xvlclunabj.mp3" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8278, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408273, + "audio": { + "duration": 228, + "file_name": "audio", + "mime_type": "audio/mpeg", + "title": "Dogs", + "performer": "Motorhead", + "file_id": "CQACAgIAAxkDAAIgVmcFatAfi1tp6gnR4pa6qSPPUl4OAAKIXQAC_cgwSE-J_MttICg0NgQ", + "file_unique_id": "AgADiF0AAv3IMEg", + "file_size": 9229352 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-contact.md b/docs/ru/md/Telegram/Data-sending/Send-contact.md deleted file mode 100644 index 59663c5941..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-contact.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Отправить контакт - Отправляет контакт с именем и номером телефона - - - -`Функция ОтправитьКонтакт(Знач Токен, Знач IDЧата, Знач Имя, Знач Фамилия, Знач Телефон, Знач Клавиатура = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Имя | --name | Строка | Имя контакта | - | Фамилия | --surname | Строка | Фамилия контакта | - | Телефон | --phone | Строка | Телефон контакта | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendContact](https://core.telegram.org/bots/api#sendcontact) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Имя = "Петр"; - Фамилия = "Петров"; - Телефон = "88005553535"; - - Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDЧата , Имя, Фамилия, Телефон); - - Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDКанала, Имя, Фамилия, Телефон); -``` - - - - - - ```bash - oint telegram ОтправитьКонтакт --token "***" \ - --chat "@testsichee" \ - --surname "Петров" \ - --phone "88005553535" \ - --name "Петр" - ``` - - - - ```batch - oint telegram ОтправитьКонтакт ^ - --token "***" ^ - --chat "@testsichee" ^ - --surname "Петров" ^ - --phone "88005553535" ^ - --name "Петр" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8285, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408362, - "contact": { - "phone_number": "88005553535", - "first_name": "Петр", - "last_name": "Петров" - } - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-contact.mdx b/docs/ru/md/Telegram/Data-sending/Send-contact.mdx new file mode 100644 index 0000000000..144ab36f1e --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-contact.mdx @@ -0,0 +1,100 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Отправить контакт + Отправляет контакт с именем и номером телефона + + + +`Функция ОтправитьКонтакт(Знач Токен, Знач IDЧата, Знач Имя, Знач Фамилия, Знач Телефон, Знач Клавиатура = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Имя | --name | Строка | Имя контакта | + | Фамилия | --surname | Строка | Фамилия контакта | + | Телефон | --phone | Строка | Телефон контакта | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendContact](https://core.telegram.org/bots/api#sendcontact) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Имя = "Петр"; + Фамилия = "Петров"; + Телефон = "88005553535"; + + Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDЧата , Имя, Фамилия, Телефон); + + Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDКанала, Имя, Фамилия, Телефон); +``` + + + + + + ```bash + oint telegram ОтправитьКонтакт --token "***" \ + --chat "@testsichee" \ + --surname "Петров" \ + --phone "88005553535" \ + --name "Петр" + ``` + + + + ```batch + oint telegram ОтправитьКонтакт ^ + --token "***" ^ + --chat "@testsichee" ^ + --surname "Петров" ^ + --phone "88005553535" ^ + --name "Петр" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8285, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408362, + "contact": { + "phone_number": "88005553535", + "first_name": "Петр", + "last_name": "Петров" + } + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-document.md b/docs/ru/md/Telegram/Data-sending/Send-document.md deleted file mode 100644 index 8e017ff7d2..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-document.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Отправить документ - Отправляет документ в чат или канал - - - -`Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown", Знач ИмяФайла = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Документ | --doc | ДвоичныеДанные, Строка | Файл документа | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - | ИмяФайла | --filename | Строка | Отображаемое имя файла c расширением, если необходимо | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendDocument](https://core.telegram.org/bots/api#senddocument) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Документ = "https://api.athenaeum.digital/test_data/document.docx"; - - ДокументПуть = ПолучитьИмяВременногоФайла("docx"); - КопироватьФайл(Документ, ДокументПуть); - - ДокументДД = Новый ДвоичныеДанные(ДокументПуть); - - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ); - - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ, , , "customname.docx"); - - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументПуть); - - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументДД, , , "customname.docx"); -``` - - - - - - ```bash - oint telegram ОтправитьДокумент --token "***" \ - --chat "@testsichee" \ - --text "Строковое значение" \ - --doc "C:\Users\Administrator\AppData\Local\Temp\m2edygoo0ft.docx" \ - --filename "custom.docx" - ``` - - - - ```batch - oint telegram ОтправитьДокумент ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Строковое значение" ^ - --doc "C:\Users\Administrator\AppData\Local\Temp\m2edygoo0ft.docx" ^ - --filename "custom.docx" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8279, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408314, - "document": { - "file_name": "document.docx", - "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "file_id": "BQACAgIAAxkDAAIgV2cFavr7Sbt50mNnaTLorEcjT60bAAKLXQAC_cgwSJNNK5mZj9GxNgQ", - "file_unique_id": "AgADi10AAv3IMEg", - "file_size": 24069 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-document.mdx b/docs/ru/md/Telegram/Data-sending/Send-document.mdx new file mode 100644 index 0000000000..1d633e95aa --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-document.mdx @@ -0,0 +1,112 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Отправить документ + Отправляет документ в чат или канал + + + +`Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown", Знач ИмяФайла = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Документ | --doc | ДвоичныеДанные, Строка | Файл документа | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + | ИмяФайла | --filename | Строка | Отображаемое имя файла c расширением, если необходимо | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendDocument](https://core.telegram.org/bots/api#senddocument) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Документ = "https://api.athenaeum.digital/test_data/document.docx"; + + ДокументПуть = ПолучитьИмяВременногоФайла("docx"); + КопироватьФайл(Документ, ДокументПуть); + + ДокументДД = Новый ДвоичныеДанные(ДокументПуть); + + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ); + + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ, , , "customname.docx"); + + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументПуть); + + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументДД, , , "customname.docx"); +``` + + + + + + ```bash + oint telegram ОтправитьДокумент --token "***" \ + --chat "@testsichee" \ + --text "Строковое значение" \ + --doc "C:\Users\Administrator\AppData\Local\Temp\m2edygoo0ft.docx" \ + --filename "custom.docx" + ``` + + + + ```batch + oint telegram ОтправитьДокумент ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Строковое значение" ^ + --doc "C:\Users\Administrator\AppData\Local\Temp\m2edygoo0ft.docx" ^ + --filename "custom.docx" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8279, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408314, + "document": { + "file_name": "document.docx", + "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "file_id": "BQACAgIAAxkDAAIgV2cFavr7Sbt50mNnaTLorEcjT60bAAKLXQAC_cgwSJNNK5mZj9GxNgQ", + "file_unique_id": "AgADi10AAv3IMEg", + "file_size": 24069 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-gif.md b/docs/ru/md/Telegram/Data-sending/Send-gif.md deleted file mode 100644 index 8469b05d90..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-gif.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Отправить гифку - Отправляет гифку в чат или канал - - - -`Функция ОтправитьГифку(Знач Токен, Знач IDЧата, Знач Текст, Знач Гифка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Гифка | --gif | ДвоичныеДанные, Строка | Файл гифки | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendAnimation](https://core.telegram.org/bots/api#sendanimation) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Гифка = "https://api.athenaeum.digital/test_data/animation.gif"; - - ГифкаПуть = ПолучитьИмяВременногоФайла("gif"); - КопироватьФайл(Гифка, ГифкаПуть); - - ГифкаДД = Новый ДвоичныеДанные(ГифкаПуть); - - Результат = OPI_Telegram.ОтправитьГифку(Токен, IDЧата, Текст, Гифка); - - Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаПуть); - - Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаДД); -``` - - - - - - ```bash - oint telegram ОтправитьГифку --token "***" \ - --chat "@testsichee" \ - --text "Строковое значение" \ - --gif "C:\Users\Administrator\AppData\Local\Temp\nywpil3l3m4.gif" - ``` - - - - ```batch - oint telegram ОтправитьГифку ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Строковое значение" ^ - --gif "C:\Users\Administrator\AppData\Local\Temp\nywpil3l3m4.gif" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8281, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408327, - "animation": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "duration": 3, - "width": 220, - "height": 220, - "thumbnail": { - "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", - "file_unique_id": "AQADjV0AAv3IMEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", - "file_unique_id": "AQADjV0AAv3IMEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAIgWWcFawfBqyXqTRA1xYW4oBHbHMX6AAKNXQAC_cgwSFI4QC7_V_0XNgQ", - "file_unique_id": "AgADjV0AAv3IMEg", - "file_size": 84941 - }, - "document": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", - "file_unique_id": "AQADjV0AAv3IMEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", - "file_unique_id": "AQADjV0AAv3IMEhy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAIgWWcFawfBqyXqTRA1xYW4oBHbHMX6AAKNXQAC_cgwSFI4QC7_V_0XNgQ", - "file_unique_id": "AgADjV0AAv3IMEg", - "file_size": 84941 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-gif.mdx b/docs/ru/md/Telegram/Data-sending/Send-gif.mdx new file mode 100644 index 0000000000..ca0de19878 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-gif.mdx @@ -0,0 +1,145 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Отправить гифку + Отправляет гифку в чат или канал + + + +`Функция ОтправитьГифку(Знач Токен, Знач IDЧата, Знач Текст, Знач Гифка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Гифка | --gif | ДвоичныеДанные, Строка | Файл гифки | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendAnimation](https://core.telegram.org/bots/api#sendanimation) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Гифка = "https://api.athenaeum.digital/test_data/animation.gif"; + + ГифкаПуть = ПолучитьИмяВременногоФайла("gif"); + КопироватьФайл(Гифка, ГифкаПуть); + + ГифкаДД = Новый ДвоичныеДанные(ГифкаПуть); + + Результат = OPI_Telegram.ОтправитьГифку(Токен, IDЧата, Текст, Гифка); + + Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаПуть); + + Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаДД); +``` + + + + + + ```bash + oint telegram ОтправитьГифку --token "***" \ + --chat "@testsichee" \ + --text "Строковое значение" \ + --gif "C:\Users\Administrator\AppData\Local\Temp\nywpil3l3m4.gif" + ``` + + + + ```batch + oint telegram ОтправитьГифку ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Строковое значение" ^ + --gif "C:\Users\Administrator\AppData\Local\Temp\nywpil3l3m4.gif" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8281, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408327, + "animation": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "duration": 3, + "width": 220, + "height": 220, + "thumbnail": { + "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", + "file_unique_id": "AQADjV0AAv3IMEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", + "file_unique_id": "AQADjV0AAv3IMEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAIgWWcFawfBqyXqTRA1xYW4oBHbHMX6AAKNXQAC_cgwSFI4QC7_V_0XNgQ", + "file_unique_id": "AgADjV0AAv3IMEg", + "file_size": 84941 + }, + "document": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", + "file_unique_id": "AQADjV0AAv3IMEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAiBZZwVrB8GrJepNEDXFhbigEdscxfoAAo1dAAL9yDBIUjhALv9X_RcBAAdtAAM2BA", + "file_unique_id": "AQADjV0AAv3IMEhy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAIgWWcFawfBqyXqTRA1xYW4oBHbHMX6AAKNXQAC_cgwSFI4QC7_V_0XNgQ", + "file_unique_id": "AgADjV0AAv3IMEg", + "file_size": 84941 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-image.md b/docs/ru/md/Telegram/Data-sending/Send-image.md deleted file mode 100644 index a92eef22cc..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-image.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Отправить картинку - Отправляет картинку в чат или канал - - - -`Функция ОтправитьКартинку(Знач Токен, Знач IDЧата, Знач Текст, Знач Картинка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Картинка | --picture | ДвоичныеДанные, Строка | Файл картинки | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendPhoto](https://core.telegram.org/bots/api#sendphoto) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - - КартинкаПуть = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, КартинкаПуть); - - КартинкаДД = Новый ДвоичныеДанные(КартинкаПуть); - - Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка); - - Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаПуть); - - Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаДД); -``` - - - - - - ```bash - oint telegram ОтправитьКартинку --token "***" \ - --chat "@testsichee" \ - --text "Строковое значение" \ - --picture "C:\Users\Administrator\AppData\Local\Temp\soaqlv2nznt.png" - ``` - - - - ```batch - oint telegram ОтправитьКартинку ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Строковое значение" ^ - --picture "C:\Users\Administrator\AppData\Local\Temp\soaqlv2nznt.png" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8276, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408218, - "photo": [ - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Ety", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-image.mdx b/docs/ru/md/Telegram/Data-sending/Send-image.mdx new file mode 100644 index 0000000000..8d9a0abb25 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-image.mdx @@ -0,0 +1,137 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Отправить картинку + Отправляет картинку в чат или канал + + + +`Функция ОтправитьКартинку(Знач Токен, Знач IDЧата, Знач Текст, Знач Картинка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Картинка | --picture | ДвоичныеДанные, Строка | Файл картинки | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendPhoto](https://core.telegram.org/bots/api#sendphoto) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + + КартинкаПуть = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, КартинкаПуть); + + КартинкаДД = Новый ДвоичныеДанные(КартинкаПуть); + + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка); + + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаПуть); + + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаДД); +``` + + + + + + ```bash + oint telegram ОтправитьКартинку --token "***" \ + --chat "@testsichee" \ + --text "Строковое значение" \ + --picture "C:\Users\Administrator\AppData\Local\Temp\soaqlv2nznt.png" + ``` + + + + ```batch + oint telegram ОтправитьКартинку ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Строковое значение" ^ + --picture "C:\Users\Administrator\AppData\Local\Temp\soaqlv2nznt.png" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8276, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408218, + "photo": [ + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Ety", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-location.md b/docs/ru/md/Telegram/Data-sending/Send-location.md deleted file mode 100644 index d802da0a3e..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-location.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Отправить местоположение - Отправляет местоположение по географической широте и долготе в чат или канал - - - -`Функция ОтправитьМестоположение(Знач Токен, Знач IDЧата, Знач Широта, Знач Долгота, Знач Клавиатура = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Широта | --lat | Строка, Число | Географическая широта | - | Долгота | --long | Строка, Число | Географическая долгота | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendLocation](https://core.telegram.org/bots/api#sendlocation) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Ширина = "48.87373649724122"; - Долгота = "48.87373649724122"; - - Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDЧата, Ширина, Долгота); - - Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDКанала, Ширина, Долгота); -``` - - - - - - ```bash - oint telegram ОтправитьМестоположение --token "***" \ - --chat "@testsichee" \ - --lat "48.87373649724122" \ - --long "48.87373649724122" - ``` - - - - ```batch - oint telegram ОтправитьМестоположение ^ - --token "***" ^ - --chat "@testsichee" ^ - --lat "48.87373649724122" ^ - --long "48.87373649724122" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8284, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408355, - "location": { - "latitude": 48.873739, - "longitude": 48.873733 - } - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-location.mdx b/docs/ru/md/Telegram/Data-sending/Send-location.mdx new file mode 100644 index 0000000000..65a1d01ce9 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-location.mdx @@ -0,0 +1,95 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Отправить местоположение + Отправляет местоположение по географической широте и долготе в чат или канал + + + +`Функция ОтправитьМестоположение(Знач Токен, Знач IDЧата, Знач Широта, Знач Долгота, Знач Клавиатура = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Широта | --lat | Строка, Число | Географическая широта | + | Долгота | --long | Строка, Число | Географическая долгота | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendLocation](https://core.telegram.org/bots/api#sendlocation) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Ширина = "48.87373649724122"; + Долгота = "48.87373649724122"; + + Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDЧата, Ширина, Долгота); + + Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDКанала, Ширина, Долгота); +``` + + + + + + ```bash + oint telegram ОтправитьМестоположение --token "***" \ + --chat "@testsichee" \ + --lat "48.87373649724122" \ + --long "48.87373649724122" + ``` + + + + ```batch + oint telegram ОтправитьМестоположение ^ + --token "***" ^ + --chat "@testsichee" ^ + --lat "48.87373649724122" ^ + --long "48.87373649724122" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8284, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408355, + "location": { + "latitude": 48.873739, + "longitude": 48.873733 + } + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-media-group.md b/docs/ru/md/Telegram/Data-sending/Send-media-group.md deleted file mode 100644 index a245bc08b7..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-media-group.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Отправить группу медиафайлов - Отправляет набор файлов в чат или канал. Варианты типов медиа: audio, document, photo, video - - - -`Функция ОтправитьМедиагруппу(Знач Токен, Знач IDЧата, Знач Текст, Знач СоответствиеФайлов, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | СоответствиеФайлов | --media | Соответствие из КлючИЗначение | Коллекция файлов: Ключ > Файл, Значение > Тип медиа | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - Текст = "Строковое значение"; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - Видео = "https://api.athenaeum.digital/test_data/video.mp4"; - - КартинкаПуть = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, КартинкаПуть); - - ВидеоПуть = ПолучитьИмяВременногоФайла("mp4"); - КопироватьФайл(Видео, ВидеоПуть); - - ВидеоДД = Новый ДвоичныеДанные(ВидеоПуть); - - Медиагруппа = Новый Соответствие; - Медиагруппа.Вставить(КартинкаПуть, "photo"); - Медиагруппа.Вставить(ВидеоДД , "video"); - - Результат = OPI_Telegram.ОтправитьМедиагруппу(Токен, IDЧата, Текст, Медиагруппа); -``` - - - - - - ```bash - oint telegram ОтправитьМедиагруппу --token "***" \ - --chat "@testsichee" \ - --text "Строковое значение" \ - --media "{'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx':'document','C:\\Users\\Administrator\\AppData\\Local\\Temp\\pmyc3oplpuq.docx':'document'}" - ``` - - - - ```batch - oint telegram ОтправитьМедиагруппу ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Строковое значение" ^ - --media "{'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx':'document','C:\\Users\\Administrator\\AppData\\Local\\Temp\\pmyc3oplpuq.docx':'document'}" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": [ - { - "message_id": 8282, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408346, - "media_group_id": "13827266772199674", - "photo": [ - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Ety", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", - "file_unique_id": "AQAD4-QxG9SO8Et8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "Строковое значение" - }, - { - "message_id": 8283, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408346, - "media_group_id": "13827266772199674", - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video1", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADFQdnBWsaZFhyFG76MFU1w7wcAAH06rEAApBdAAL9yDBIrGAr43CButQBAAdtAAM2BA", - "file_unique_id": "AQADkF0AAv3IMEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADFQdnBWsaZFhyFG76MFU1w7wcAAH06rEAApBdAAL9yDBIrGAr43CButQBAAdtAAM2BA", - "file_unique_id": "AQADkF0AAv3IMEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxUHZwVrGmRYchRu-jBVNcO8HAAB9OqxAAKQXQAC_cgwSKxgK-NwgbrUNgQ", - "file_unique_id": "AgADkF0AAv3IMEg", - "file_size": 1137878 - } - } - ] -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-media-group.mdx b/docs/ru/md/Telegram/Data-sending/Send-media-group.mdx new file mode 100644 index 0000000000..6a55517499 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-media-group.mdx @@ -0,0 +1,185 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Отправить группу медиафайлов + Отправляет набор файлов в чат или канал. Варианты типов медиа: audio, document, photo, video + + + +`Функция ОтправитьМедиагруппу(Знач Токен, Знач IDЧата, Знач Текст, Знач СоответствиеФайлов, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | СоответствиеФайлов | --media | Соответствие из КлючИЗначение | Коллекция файлов: Ключ > Файл, Значение > Тип медиа | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + Текст = "Строковое значение"; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + Видео = "https://api.athenaeum.digital/test_data/video.mp4"; + + КартинкаПуть = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, КартинкаПуть); + + ВидеоПуть = ПолучитьИмяВременногоФайла("mp4"); + КопироватьФайл(Видео, ВидеоПуть); + + ВидеоДД = Новый ДвоичныеДанные(ВидеоПуть); + + Медиагруппа = Новый Соответствие; + Медиагруппа.Вставить(КартинкаПуть, "photo"); + Медиагруппа.Вставить(ВидеоДД , "video"); + + Результат = OPI_Telegram.ОтправитьМедиагруппу(Токен, IDЧата, Текст, Медиагруппа); +``` + + + + + + ```bash + oint telegram ОтправитьМедиагруппу --token "***" \ + --chat "@testsichee" \ + --text "Строковое значение" \ + --media "{'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx':'document','C:\\Users\\Administrator\\AppData\\Local\\Temp\\pmyc3oplpuq.docx':'document'}" + ``` + + + + ```batch + oint telegram ОтправитьМедиагруппу ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Строковое значение" ^ + --media "{'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx':'document','C:\\Users\\Administrator\\AppData\\Local\\Temp\\pmyc3oplpuq.docx':'document'}" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": [ + { + "message_id": 8282, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408346, + "media_group_id": "13827266772199674", + "photo": [ + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADcwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADbQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Ety", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeAADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADeQADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAIfmWb-MR8PQhrvZHiqLmG6UdiAAznzAALj5DEb1I7wSxB3bmqDIveAAQADAgADdwADNgQ", + "file_unique_id": "AQAD4-QxG9SO8Et8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "Строковое значение" + }, + { + "message_id": 8283, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408346, + "media_group_id": "13827266772199674", + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video1", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADFQdnBWsaZFhyFG76MFU1w7wcAAH06rEAApBdAAL9yDBIrGAr43CButQBAAdtAAM2BA", + "file_unique_id": "AQADkF0AAv3IMEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADFQdnBWsaZFhyFG76MFU1w7wcAAH06rEAApBdAAL9yDBIrGAr43CButQBAAdtAAM2BA", + "file_unique_id": "AQADkF0AAv3IMEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxUHZwVrGmRYchRu-jBVNcO8HAAB9OqxAAKQXQAC_cgwSKxgK-NwgbrUNgQ", + "file_unique_id": "AgADkF0AAv3IMEg", + "file_size": 1137878 + } + } + ] +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-poll.md b/docs/ru/md/Telegram/Data-sending/Send-poll.md deleted file mode 100644 index e1ad258a6d..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-poll.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Отправить опрос - Отправляет опрос с вариантами ответа - - - -`Функция ОтправитьОпрос(Знач Токен, Знач IDЧата, Знач Вопрос, Знач МассивОтветов, Знач Анонимный = Истина) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Вопрос | --question | Строка | Вопрос опроса | - | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | - | Анонимный | --anonymous | Булево | Флаг анонимности опроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendPoll](https://core.telegram.org/bots/api#sendpoll) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Вопрос = "Какой ваш любимый цвет?"; - - МассивОтветов = Новый Массив; - МассивОтветов.Добавить("Красный"); - МассивОтветов.Добавить("Желтый"); - МассивОтветов.Добавить("Зеленый"); - МассивОтветов.Добавить("Синий"); - - Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDЧата , Вопрос, МассивОтветов, Ложь); - - Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDКанала, Вопрос, МассивОтветов, Истина); -``` - - - - - - ```bash - oint telegram ОтправитьОпрос --token "***" \ - --chat "@testsichee" \ - --question "Какой ваш любимый цвет?" \ - --options "['Красный','Желтый','Зеленый','Синий']" - ``` - - - - ```batch - oint telegram ОтправитьОпрос ^ - --token "***" ^ - --chat "@testsichee" ^ - --question "Какой ваш любимый цвет?" ^ - --options "['Красный','Желтый','Зеленый','Синий']" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8286, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408390, - "poll": { - "id": "5201878558565206764", - "question": "Какой ваш любимый цвет?", - "options": [ - { - "text": "Красный", - "voter_count": 0 - }, - { - "text": "Желтый", - "voter_count": 0 - }, - { - "text": "Зеленый", - "voter_count": 0 - }, - { - "text": "Синий", - "voter_count": 0 - } - ], - "total_voter_count": 0, - "is_closed": false, - "is_anonymous": false, - "type": "regular", - "allows_multiple_answers": false - } - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-poll.mdx b/docs/ru/md/Telegram/Data-sending/Send-poll.mdx new file mode 100644 index 0000000000..03f37f676b --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-poll.mdx @@ -0,0 +1,123 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Отправить опрос + Отправляет опрос с вариантами ответа + + + +`Функция ОтправитьОпрос(Знач Токен, Знач IDЧата, Знач Вопрос, Знач МассивОтветов, Знач Анонимный = Истина) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Вопрос | --question | Строка | Вопрос опроса | + | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | + | Анонимный | --anonymous | Булево | Флаг анонимности опроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendPoll](https://core.telegram.org/bots/api#sendpoll) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Вопрос = "Какой ваш любимый цвет?"; + + МассивОтветов = Новый Массив; + МассивОтветов.Добавить("Красный"); + МассивОтветов.Добавить("Желтый"); + МассивОтветов.Добавить("Зеленый"); + МассивОтветов.Добавить("Синий"); + + Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDЧата , Вопрос, МассивОтветов, Ложь); + + Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDКанала, Вопрос, МассивОтветов, Истина); +``` + + + + + + ```bash + oint telegram ОтправитьОпрос --token "***" \ + --chat "@testsichee" \ + --question "Какой ваш любимый цвет?" \ + --options "['Красный','Желтый','Зеленый','Синий']" + ``` + + + + ```batch + oint telegram ОтправитьОпрос ^ + --token "***" ^ + --chat "@testsichee" ^ + --question "Какой ваш любимый цвет?" ^ + --options "['Красный','Желтый','Зеленый','Синий']" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8286, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408390, + "poll": { + "id": "5201878558565206764", + "question": "Какой ваш любимый цвет?", + "options": [ + { + "text": "Красный", + "voter_count": 0 + }, + { + "text": "Желтый", + "voter_count": 0 + }, + { + "text": "Зеленый", + "voter_count": 0 + }, + { + "text": "Синий", + "voter_count": 0 + } + ], + "total_voter_count": 0, + "is_closed": false, + "is_anonymous": false, + "type": "regular", + "allows_multiple_answers": false + } + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-text-message.md b/docs/ru/md/Telegram/Data-sending/Send-text-message.md deleted file mode 100644 index 93ae244f9d..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-text-message.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Отправить текстовое сообщение - Отправляет текстовое сообщение в чат или канал - - - -`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач Клавиатура = "", Знач Разметка = "Markdown", Знач IDВходящего = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - | IDВходящего | --reply | Строка, Число | ID сообщения на которое надо ответить | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendMessage](https://core.telegram.org/bots/api#sendmessage) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - - Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); - - Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDКанала, Текст); -``` - - - - - - ```bash - oint telegram ОтправитьТекстовоеСообщение --token "***" \ - --chat "@testsichee" \ - --text "Текст %%F0%%9F%%A%5%9D и emoji \(10%%\)" \ - --parsemode "MarkdownV2" - ``` - - - - ```batch - oint telegram ОтправитьТекстовоеСообщение ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Текст %%F0%%9F%%A%5%9D и emoji \(10%%\)" ^ - --parsemode "MarkdownV2" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8274, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408204, - "text": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-text-message.mdx b/docs/ru/md/Telegram/Data-sending/Send-text-message.mdx new file mode 100644 index 0000000000..74248cda3b --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-text-message.mdx @@ -0,0 +1,92 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат или канал + + + +`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач Клавиатура = "", Знач Разметка = "Markdown", Знач IDВходящего = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + | IDВходящего | --reply | Строка, Число | ID сообщения на которое надо ответить | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendMessage](https://core.telegram.org/bots/api#sendmessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + + Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); + + Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDКанала, Текст); +``` + + + + + + ```bash + oint telegram ОтправитьТекстовоеСообщение --token "***" \ + --chat "@testsichee" \ + --text "Текст %%F0%%9F%%A%5%9D и emoji \(10%%\)" \ + --parsemode "MarkdownV2" + ``` + + + + ```batch + oint telegram ОтправитьТекстовоеСообщение ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Текст %%F0%%9F%%A%5%9D и emoji \(10%%\)" ^ + --parsemode "MarkdownV2" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8274, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408204, + "text": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-video.md b/docs/ru/md/Telegram/Data-sending/Send-video.md deleted file mode 100644 index 9cd9395b00..0000000000 --- a/docs/ru/md/Telegram/Data-sending/Send-video.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Отправить видео - Отправляет видео в чат или канал - - - -`Функция ОтправитьВидео(Знач Токен, Знач IDЧата, Знач Текст, Знач Видео, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Видео | --video | ДвоичныеДанные, Строка | Файл видео | - | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [sendVideo](https://core.telegram.org/bots/api#sendvideo) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Видео = "https://api.athenaeum.digital/test_data/video.mp4"; - - ВидеоПуть = ПолучитьИмяВременногоФайла("mp4"); - КопироватьФайл(Видео, ВидеоПуть); - - ВидеоДД = Новый ДвоичныеДанные(ВидеоПуть); - - Результат = OPI_Telegram.ОтправитьВидео(Токен, IDЧата, Текст, Видео); - - Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоПуть); - - Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоДД); -``` - - - - - - ```bash - oint telegram ОтправитьВидео --token "***" \ - --chat "@testsichee" \ - --text "Строковое значение" \ - --video "C:\Users\Administrator\AppData\Local\Temp\e2xdljrntxn.mp4" - ``` - - - - ```batch - oint telegram ОтправитьВидео ^ - --token "***" ^ - --chat "@testsichee" ^ - --text "Строковое значение" ^ - --video "C:\Users\Administrator\AppData\Local\Temp\e2xdljrntxn.mp4" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_id": 8277, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1728408239, - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAiBVZwVqr_rWWRWdOupHTG6S76vJ6i4AAoVdAAL9yDBIsh0vx_6fbycBAAdtAAM2BA", - "file_unique_id": "AQADhV0AAv3IMEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAiBVZwVqr_rWWRWdOupHTG6S76vJ6i4AAoVdAAL9yDBIsh0vx_6fbycBAAdtAAM2BA", - "file_unique_id": "AQADhV0AAv3IMEhy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxkDAAIgVWcFaq_61lkVnTrqR0xuku-ryeouAAKFXQAC_cgwSLIdL8f-n28nNgQ", - "file_unique_id": "AgADhV0AAv3IMEg", - "file_size": 1137878 - }, - "caption": "Строковое значение" - } -} -``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-video.mdx b/docs/ru/md/Telegram/Data-sending/Send-video.mdx new file mode 100644 index 0000000000..11f16a1924 --- /dev/null +++ b/docs/ru/md/Telegram/Data-sending/Send-video.mdx @@ -0,0 +1,124 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Отправить видео + Отправляет видео в чат или канал + + + +`Функция ОтправитьВидео(Знач Токен, Знач IDЧата, Знач Текст, Знач Видео, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка, Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Видео | --video | ДвоичныеДанные, Строка | Файл видео | + | Клавиатура | --keyboard | Строка | Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [sendVideo](https://core.telegram.org/bots/api#sendvideo) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Видео = "https://api.athenaeum.digital/test_data/video.mp4"; + + ВидеоПуть = ПолучитьИмяВременногоФайла("mp4"); + КопироватьФайл(Видео, ВидеоПуть); + + ВидеоДД = Новый ДвоичныеДанные(ВидеоПуть); + + Результат = OPI_Telegram.ОтправитьВидео(Токен, IDЧата, Текст, Видео); + + Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоПуть); + + Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоДД); +``` + + + + + + ```bash + oint telegram ОтправитьВидео --token "***" \ + --chat "@testsichee" \ + --text "Строковое значение" \ + --video "C:\Users\Administrator\AppData\Local\Temp\e2xdljrntxn.mp4" + ``` + + + + ```batch + oint telegram ОтправитьВидео ^ + --token "***" ^ + --chat "@testsichee" ^ + --text "Строковое значение" ^ + --video "C:\Users\Administrator\AppData\Local\Temp\e2xdljrntxn.mp4" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_id": 8277, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1728408239, + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAiBVZwVqr_rWWRWdOupHTG6S76vJ6i4AAoVdAAL9yDBIsh0vx_6fbycBAAdtAAM2BA", + "file_unique_id": "AQADhV0AAv3IMEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAiBVZwVqr_rWWRWdOupHTG6S76vJ6i4AAoVdAAL9yDBIsh0vx_6fbycBAAdtAAM2BA", + "file_unique_id": "AQADhV0AAv3IMEhy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxkDAAIgVWcFaq_61lkVnTrqR0xuku-ryeouAAKFXQAC_cgwSLIdL8f-n28nNgQ", + "file_unique_id": "AgADhV0AAv3IMEg", + "file_size": 1137878 + }, + "caption": "Строковое значение" + } +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md b/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md deleted file mode 100644 index d5ca1761b8..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Очистить список закрепленных сообщений темы - Очищает список закрепленных сообщений в теме форума - - - -`Функция ОчиститьСписокЗакрепленныхСообщенийТемы(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - | IDТемы | --topic | Строка, Число | ID темы. Главная, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [unpinAllForumTopicMessages](https://core.telegram.org/bots/api#unpinallforumtopicmessages) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "5543"; - - Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат); - - Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат, Тема); -``` - - - - - - ```bash - oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы --token "***" \ - --forum "-1001971186208" \ - --topic "5598" - ``` - - - - ```batch - oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы ^ - --token "***" ^ - --forum "-1001971186208" ^ - --topic "5598" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.mdx b/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.mdx new file mode 100644 index 0000000000..7b82f03367 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Очистить список закрепленных сообщений темы + Очищает список закрепленных сообщений в теме форума + + + +`Функция ОчиститьСписокЗакрепленныхСообщенийТемы(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + | IDТемы | --topic | Строка, Число | ID темы. Главная, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [unpinAllForumTopicMessages](https://core.telegram.org/bots/api#unpinallforumtopicmessages) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "5543"; + + Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат); + + Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат, Тема); +``` + + + + + + ```bash + oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы --token "***" \ + --forum "-1001971186208" \ + --topic "5598" + ``` + + + + ```batch + oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы ^ + --token "***" ^ + --forum "-1001971186208" ^ + --topic "5598" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md b/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md deleted file mode 100644 index 39e43cb683..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Закрыть тему форума - Закрывает тему для новых сообщений - - - -`Функция ЗакрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - | IDТемы | --topic | Строка, Число | ID темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [closeForumTopic](https://core.telegram.org/bots/api#closeforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "5543"; - - Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат); // Закрывает главную тему - - Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат, Тема); -``` - - - - - - ```bash - oint telegram ЗакрытьТемуФорума --token "***" \ - --forum "-1001971186208" \ - --topic "5598" - ``` - - - - ```batch - oint telegram ЗакрытьТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" ^ - --topic "5598" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.mdx b/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.mdx new file mode 100644 index 0000000000..6d6a10763f --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Закрыть тему форума + Закрывает тему для новых сообщений + + + +`Функция ЗакрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + | IDТемы | --topic | Строка, Число | ID темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [closeForumTopic](https://core.telegram.org/bots/api#closeforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "5543"; + + Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат); // Закрывает главную тему + + Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат, Тема); +``` + + + + + + ```bash + oint telegram ЗакрытьТемуФорума --token "***" \ + --forum "-1001971186208" \ + --topic "5598" + ``` + + + + ```batch + oint telegram ЗакрытьТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" ^ + --topic "5598" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md b/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md deleted file mode 100644 index c644ce387e..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать тему форума - Создает новую тему в группе с включенным функционалом тем - - - -`Функция СоздатьТемуФорума(Знач Токен, Знач IDЧата, Знач Заголовок, Знач IDИконки = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата создания темы | - | Заголовок | --title | Строка | Заголовок темы | - | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [createForumTopic](https://core.telegram.org/bots/api#createforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Иконка = "5357419403325481346"; - Имя = "Тестовая тема " + Строка(Новый УникальныйИдентификатор); - - Результат = OPI_Telegram.СоздатьТемуФорума(Токен, Чат, Имя, Иконка); -``` - - - - - - ```bash - oint telegram СоздатьТемуФорума --token "***" \ - --forum "-1001971186208" \ - --icon "5357419403325481346" \ - --title "Тестовая тема c4f190c7-3e37-4ffa-88c3-64170ac6fc92" - ``` - - - - ```batch - oint telegram СоздатьТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" ^ - --icon "5357419403325481346" ^ - --title "Тестовая тема c4f190c7-3e37-4ffa-88c3-64170ac6fc92" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": { - "message_thread_id": 5385, - "name": "Тестовая тема 6ff88eef-fb83-4761-9cdd-315c7420af44", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - } -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.mdx b/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.mdx new file mode 100644 index 0000000000..3dbc0fcd15 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать тему форума + Создает новую тему в группе с включенным функционалом тем + + + +`Функция СоздатьТемуФорума(Знач Токен, Знач IDЧата, Знач Заголовок, Знач IDИконки = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата создания темы | + | Заголовок | --title | Строка | Заголовок темы | + | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [createForumTopic](https://core.telegram.org/bots/api#createforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Иконка = "5357419403325481346"; + Имя = "Тестовая тема " + Строка(Новый УникальныйИдентификатор); + + Результат = OPI_Telegram.СоздатьТемуФорума(Токен, Чат, Имя, Иконка); +``` + + + + + + ```bash + oint telegram СоздатьТемуФорума --token "***" \ + --forum "-1001971186208" \ + --icon "5357419403325481346" \ + --title "Тестовая тема c4f190c7-3e37-4ffa-88c3-64170ac6fc92" + ``` + + + + ```batch + oint telegram СоздатьТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" ^ + --icon "5357419403325481346" ^ + --title "Тестовая тема c4f190c7-3e37-4ffa-88c3-64170ac6fc92" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": { + "message_thread_id": 5385, + "name": "Тестовая тема 6ff88eef-fb83-4761-9cdd-315c7420af44", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + } +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md deleted file mode 100644 index d9229de562..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Удалить тему форума - Удаляет тему форума - - - -`Функция УдалитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - | IDТемы | --topic | Строка, Число | ID темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [deleteForumTopic](https://core.telegram.org/bots/api#deleteforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "5543"; - - Результат = OPI_Telegram.УдалитьТемуФорума(Токен, Чат, Тема); -``` - - - - - - ```bash - oint telegram УдалитьТемуФорума --token "***" \ - --forum "-1001971186208" \ - --topic "5598" - ``` - - - - ```batch - oint telegram УдалитьТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" ^ - --topic "5598" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.mdx b/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.mdx new file mode 100644 index 0000000000..2bdc8bcfde --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Удалить тему форума + Удаляет тему форума + + + +`Функция УдалитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + | IDТемы | --topic | Строка, Число | ID темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [deleteForumTopic](https://core.telegram.org/bots/api#deleteforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "5543"; + + Результат = OPI_Telegram.УдалитьТемуФорума(Токен, Чат, Тема); +``` + + + + + + ```bash + oint telegram УдалитьТемуФорума --token "***" \ + --forum "-1001971186208" \ + --topic "5598" + ``` + + + + ```batch + oint telegram УдалитьТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" ^ + --topic "5598" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md deleted file mode 100644 index 2a50fdd234..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить тему форума - Создает новую тему в группе с включенным функционалом тем - - - -`Функция ИзменитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы, Знач Заголовок = Неопределено, Знач IDИконки = Неопределено) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата создания темы | - | IDТемы | --topic | Строка, Число | ID темы | - | Заголовок | --title | Строка | Новый заголовок | - | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [editForumTopic](https://core.telegram.org/bots/api#editforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "5543"; - НовоеИмя = "Новый тестовый заголовок"; - НовяИконка = "5310132165583840589"; - - Результат = OPI_Telegram.ИзменитьТемуФорума(Токен, Чат, Тема, НовоеИмя, НовяИконка); -``` - - - - - - ```bash - oint telegram ИзменитьТемуФорума --token "***" \ - --forum "-1001971186208" \ - --icon "5310132165583840589" \ - --title "Новый тестовый заголовок" \ - --topic "5598" - ``` - - - - ```batch - oint telegram ИзменитьТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" ^ - --icon "5310132165583840589" ^ - --title "Новый тестовый заголовок" ^ - --topic "5598" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.mdx b/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.mdx new file mode 100644 index 0000000000..203356a263 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить тему форума + Создает новую тему в группе с включенным функционалом тем + + + +`Функция ИзменитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы, Знач Заголовок = Неопределено, Знач IDИконки = Неопределено) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата создания темы | + | IDТемы | --topic | Строка, Число | ID темы | + | Заголовок | --title | Строка | Новый заголовок | + | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [editForumTopic](https://core.telegram.org/bots/api#editforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "5543"; + НовоеИмя = "Новый тестовый заголовок"; + НовяИконка = "5310132165583840589"; + + Результат = OPI_Telegram.ИзменитьТемуФорума(Токен, Чат, Тема, НовоеИмя, НовяИконка); +``` + + + + + + ```bash + oint telegram ИзменитьТемуФорума --token "***" \ + --forum "-1001971186208" \ + --icon "5310132165583840589" \ + --title "Новый тестовый заголовок" \ + --topic "5598" + ``` + + + + ```batch + oint telegram ИзменитьТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" ^ + --icon "5310132165583840589" ^ + --title "Новый тестовый заголовок" ^ + --topic "5598" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md b/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md deleted file mode 100644 index c428b3228a..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Изменить имя главной темы форума - Изменяет имя главной темы форума - - - -`Функция ИзменитьИмяГлавнойТемыФорума(Знач Токен, Знач IDЧата, Знач Заголовок) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - | Заголовок | --title | Строка | Новое имя главной темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [editGeneralForumTopic](https://core.telegram.org/bots/api#editgeneralforumtopic) -::: -
- - -```bsl title="Пример кода" - Заголовок = "Новое имя главной темы " + Строка(Новый УникальныйИдентификатор); - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - - Результат = OPI_Telegram.ИзменитьИмяГлавнойТемыФорума(Токен, Чат, Заголовок); -``` - - - - - - ```bash - oint telegram ИзменитьИмяГлавнойТемыФорума --token "***" \ - --forum "-1001971186208" \ - --title "Новое имя главной темы b5bf297e-1e9a-4739-9a49-4e30504d2bbb" - ``` - - - - ```batch - oint telegram ИзменитьИмяГлавнойТемыФорума ^ - --token "***" ^ - --forum "-1001971186208" ^ - --title "Новое имя главной темы b5bf297e-1e9a-4739-9a49-4e30504d2bbb" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.mdx b/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.mdx new file mode 100644 index 0000000000..93e769595f --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Изменить имя главной темы форума + Изменяет имя главной темы форума + + + +`Функция ИзменитьИмяГлавнойТемыФорума(Знач Токен, Знач IDЧата, Знач Заголовок) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + | Заголовок | --title | Строка | Новое имя главной темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [editGeneralForumTopic](https://core.telegram.org/bots/api#editgeneralforumtopic) +::: +
+ + +```bsl title="Пример кода" + Заголовок = "Новое имя главной темы " + Строка(Новый УникальныйИдентификатор); + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + + Результат = OPI_Telegram.ИзменитьИмяГлавнойТемыФорума(Токен, Чат, Заголовок); +``` + + + + + + ```bash + oint telegram ИзменитьИмяГлавнойТемыФорума --token "***" \ + --forum "-1001971186208" \ + --title "Новое имя главной темы b5bf297e-1e9a-4739-9a49-4e30504d2bbb" + ``` + + + + ```batch + oint telegram ИзменитьИмяГлавнойТемыФорума ^ + --token "***" ^ + --forum "-1001971186208" ^ + --title "Новое имя главной темы b5bf297e-1e9a-4739-9a49-4e30504d2bbb" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md b/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md deleted file mode 100644 index 9ea631d800..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список иконок-аватаров - Получает соответствие ID Emoji для установки в качестве иконок тем форума - - - -`Функция ПолучитьСписокИконокАватаров(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Ключ > ID, Значение > Emoji - -
- -:::tip -Метод в документации API: [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.ПолучитьСписокИконокАватаров(Токен); -``` - - - - - - ```bash - oint telegram ПолучитьСписокИконокАватаров --token "***" - ``` - - - - ```batch - oint telegram ПолучитьСписокИконокАватаров ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "5434144690511290129": "📰", - "5312536423851630001": "💡", - "5312016608254762256": "⚡️", - "5377544228505134960": "🎙", - "5418085807791545980": "🔝", - "5370870893004203704": "🗣", - "5420216386448270341": "🆒", - "5379748062124056162": "❗️", - "5373251851074415873": "📝", - "5433614043006903194": "📆", - "5357315181649076022": "📁", - "5309965701241379366": "🔎", - "5309984423003823246": "📣", - "5312241539987020022": "🔥", - "5312138559556164615": "❤️", - "5377316857231450742": "❓", - "5350305691942788490": "📈", - "5350713563512052787": "📉", - "5309958691854754293": "💎", - "5350452584119279096": "💰", - "5309929258443874898": "💸", - "5377690785674175481": "🪙", - "5310107765874632305": "💱", - "5377438129928020693": "⁉️", - "5309950797704865693": "🎮", - "5350554349074391003": "💻", - "5409357944619802453": "📱", - "5312322066328853156": "🚗", - "5312486108309757006": "🏠", - "5310029292527164639": "💘", - "5310228579009699834": "🎉", - "5377498341074542641": "‼️", - "5312315739842026755": "🏆", - "5408906741125490282": "🏁", - "5368653135101310687": "🎬", - "5310045076531978942": "🎵", - "5420331611830886484": "🔞", - "5350481781306958339": "📚", - "5357107601584693888": "👑", - "5375159220280762629": "⚽️", - "5384327463629233871": "🏀", - "5350513667144163474": "📺", - "5357121491508928442": "👀", - "5357185426392096577": "🫦", - "5310157398516703416": "🍓", - "5310262535021142850": "💄", - "5368741306484925109": "👠", - "5348436127038579546": "✈️", - "5357120306097956843": "🧳", - "5310303848311562896": "🏖", - "5350424168615649565": "⛅️", - "5413625003218313783": "🦄", - "5350699789551935589": "🛍", - "5377478880577724584": "👜", - "5431492767249342908": "🛒", - "5350497316203668441": "🚂", - "5350422527938141909": "🛥", - "5418196338774907917": "🏔", - "5350648297189023928": "🏕", - "5309832892262654231": "🤖", - "5350751634102166060": "🪩", - "5377624166436445368": "🎟", - "5386395194029515402": "🏴‍☠️", - "5350387571199319521": "🗳", - "5357419403325481346": "🎓", - "5368585403467048206": "🔭", - "5377580546748588396": "🔬", - "5377317729109811382": "🎶", - "5382003830487523366": "🎤", - "5357298525765902091": "🕺", - "5357370526597653193": "💃", - "5357188789351490453": "🪖", - "5348227245599105972": "💼", - "5411138633765757782": "🧪", - "5386435923204382258": "👨‍👩‍👧‍👦", - "5377675010259297233": "👶", - "5386609083400856174": "🤰", - "5368808634392257474": "💅", - "5350548830041415279": "🏛", - "5355127101970194557": "🧮", - "5386379624773066504": "🖨", - "5377494501373780436": "👮‍♂️", - "5350307998340226571": "🩺", - "5310094636159607472": "💊", - "5310139157790596888": "💉", - "5377468357907849200": "🧼", - "5418115271267197333": "🪪", - "5372819184658949787": "🛃", - "5350344462612570293": "🍽", - "5384574037701696503": "🐟", - "5310039132297242441": "🎨", - "5350658016700013471": "🎭", - "5357504778685392027": "🎩", - "5350367161514732241": "🔮", - "5350520238444126134": "🍹", - "5310132165583840589": "🎂", - "5350392020785437399": "☕️", - "5350406176997646350": "🍣", - "5350403544182694064": "🍔", - "5350444672789519765": "🍕", - "5312424913615723286": "🦠", - "5417915203100613993": "💬", - "5312054580060625569": "🎄", - "5309744892677727325": "🎃", - "5238156910363950406": "✍️", - "5235579393115438657": "⭐️", - "5237699328843200968": "✅", - "5238027455754680851": "🎖", - "5238234236955148254": "🤡", - "5237889595894414384": "🧠", - "5237999392438371490": "🦮", - "5235912661102773458": "🐈" -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.mdx b/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.mdx new file mode 100644 index 0000000000..920a05c685 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.mdx @@ -0,0 +1,168 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список иконок-аватаров + Получает соответствие ID Emoji для установки в качестве иконок тем форума + + + +`Функция ПолучитьСписокИконокАватаров(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Ключ > ID, Значение > Emoji + +
+ +:::tip +Метод в документации API: [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.ПолучитьСписокИконокАватаров(Токен); +``` + + + + + + ```bash + oint telegram ПолучитьСписокИконокАватаров --token "***" + ``` + + + + ```batch + oint telegram ПолучитьСписокИконокАватаров ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "5434144690511290129": "📰", + "5312536423851630001": "💡", + "5312016608254762256": "⚡️", + "5377544228505134960": "🎙", + "5418085807791545980": "🔝", + "5370870893004203704": "🗣", + "5420216386448270341": "🆒", + "5379748062124056162": "❗️", + "5373251851074415873": "📝", + "5433614043006903194": "📆", + "5357315181649076022": "📁", + "5309965701241379366": "🔎", + "5309984423003823246": "📣", + "5312241539987020022": "🔥", + "5312138559556164615": "❤️", + "5377316857231450742": "❓", + "5350305691942788490": "📈", + "5350713563512052787": "📉", + "5309958691854754293": "💎", + "5350452584119279096": "💰", + "5309929258443874898": "💸", + "5377690785674175481": "🪙", + "5310107765874632305": "💱", + "5377438129928020693": "⁉️", + "5309950797704865693": "🎮", + "5350554349074391003": "💻", + "5409357944619802453": "📱", + "5312322066328853156": "🚗", + "5312486108309757006": "🏠", + "5310029292527164639": "💘", + "5310228579009699834": "🎉", + "5377498341074542641": "‼️", + "5312315739842026755": "🏆", + "5408906741125490282": "🏁", + "5368653135101310687": "🎬", + "5310045076531978942": "🎵", + "5420331611830886484": "🔞", + "5350481781306958339": "📚", + "5357107601584693888": "👑", + "5375159220280762629": "⚽️", + "5384327463629233871": "🏀", + "5350513667144163474": "📺", + "5357121491508928442": "👀", + "5357185426392096577": "🫦", + "5310157398516703416": "🍓", + "5310262535021142850": "💄", + "5368741306484925109": "👠", + "5348436127038579546": "✈️", + "5357120306097956843": "🧳", + "5310303848311562896": "🏖", + "5350424168615649565": "⛅️", + "5413625003218313783": "🦄", + "5350699789551935589": "🛍", + "5377478880577724584": "👜", + "5431492767249342908": "🛒", + "5350497316203668441": "🚂", + "5350422527938141909": "🛥", + "5418196338774907917": "🏔", + "5350648297189023928": "🏕", + "5309832892262654231": "🤖", + "5350751634102166060": "🪩", + "5377624166436445368": "🎟", + "5386395194029515402": "🏴‍☠️", + "5350387571199319521": "🗳", + "5357419403325481346": "🎓", + "5368585403467048206": "🔭", + "5377580546748588396": "🔬", + "5377317729109811382": "🎶", + "5382003830487523366": "🎤", + "5357298525765902091": "🕺", + "5357370526597653193": "💃", + "5357188789351490453": "🪖", + "5348227245599105972": "💼", + "5411138633765757782": "🧪", + "5386435923204382258": "👨‍👩‍👧‍👦", + "5377675010259297233": "👶", + "5386609083400856174": "🤰", + "5368808634392257474": "💅", + "5350548830041415279": "🏛", + "5355127101970194557": "🧮", + "5386379624773066504": "🖨", + "5377494501373780436": "👮‍♂️", + "5350307998340226571": "🩺", + "5310094636159607472": "💊", + "5310139157790596888": "💉", + "5377468357907849200": "🧼", + "5418115271267197333": "🪪", + "5372819184658949787": "🛃", + "5350344462612570293": "🍽", + "5384574037701696503": "🐟", + "5310039132297242441": "🎨", + "5350658016700013471": "🎭", + "5357504778685392027": "🎩", + "5350367161514732241": "🔮", + "5350520238444126134": "🍹", + "5310132165583840589": "🎂", + "5350392020785437399": "☕️", + "5350406176997646350": "🍣", + "5350403544182694064": "🍔", + "5350444672789519765": "🍕", + "5312424913615723286": "🦠", + "5417915203100613993": "💬", + "5312054580060625569": "🎄", + "5309744892677727325": "🎃", + "5238156910363950406": "✍️", + "5235579393115438657": "⭐️", + "5237699328843200968": "✅", + "5238027455754680851": "🎖", + "5238234236955148254": "🤡", + "5237889595894414384": "🧠", + "5237999392438371490": "🦮", + "5235912661102773458": "🐈" +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md deleted file mode 100644 index 03678fc700..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Скрыть главную тему форума - Скрывает главную тему форума - - - -`Функция СкрытьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [hideGeneralForumTopic](https://core.telegram.org/bots/api#hidegeneralforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - - Результат = OPI_Telegram.СкрытьГлавнуюТемуФорума(Токен, Чат); -``` - - - - - - ```bash - oint telegram СкрытьГлавнуюТемуФорума --token "***" \ - --forum "-1001971186208" - ``` - - - - ```batch - oint telegram СкрытьГлавнуюТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.mdx b/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.mdx new file mode 100644 index 0000000000..2d4e92e474 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Скрыть главную тему форума + Скрывает главную тему форума + + + +`Функция СкрытьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [hideGeneralForumTopic](https://core.telegram.org/bots/api#hidegeneralforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + + Результат = OPI_Telegram.СкрытьГлавнуюТемуФорума(Токен, Чат); +``` + + + + + + ```bash + oint telegram СкрытьГлавнуюТемуФорума --token "***" \ + --forum "-1001971186208" + ``` + + + + ```batch + oint telegram СкрытьГлавнуюТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md b/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md deleted file mode 100644 index 53226ec812..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Открыть тему форума - Повторно открывает ранее закрытую тему форума - - - -`Функция ОткрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - | IDТемы | --topic | Строка, Число | ID темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [reopenForumTopic](https://core.telegram.org/bots/api#reopenforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "5543"; - - Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат); // Открывает главную тему - - Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат, Тема); -``` - - - - - - ```bash - oint telegram ОткрытьТемуФорума --token "***" \ - --forum "-1001971186208" \ - --topic "5598" - ``` - - - - ```batch - oint telegram ОткрытьТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" ^ - --topic "5598" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.mdx b/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.mdx new file mode 100644 index 0000000000..78eac9fcb7 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Открыть тему форума + Повторно открывает ранее закрытую тему форума + + + +`Функция ОткрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + | IDТемы | --topic | Строка, Число | ID темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [reopenForumTopic](https://core.telegram.org/bots/api#reopenforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "5543"; + + Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат); // Открывает главную тему + + Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат, Тема); +``` + + + + + + ```bash + oint telegram ОткрытьТемуФорума --token "***" \ + --forum "-1001971186208" \ + --topic "5598" + ``` + + + + ```batch + oint telegram ОткрытьТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" ^ + --topic "5598" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md deleted file mode 100644 index 814f7c0cdb..0000000000 --- a/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Показать главную тему форума - Показывает ранее скрытую главную тему форума - - - -`Функция ПоказатьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка, Число | ID чата темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -
- -:::tip -Метод в документации API: [unhideGeneralForumTopic](https://core.telegram.org/bots/api#unhidegeneralforumtopic) -::: -
- - -```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - - Результат = OPI_Telegram.ПоказатьГлавнуюТемуФорума(Токен, Чат); -``` - - - - - - ```bash - oint telegram ПоказатьГлавнуюТемуФорума --token "***" \ - --forum "-1001971186208" - ``` - - - - ```batch - oint telegram ПоказатьГлавнуюТемуФорума ^ - --token "***" ^ - --forum "-1001971186208" - ``` - - - - -```json title="Результат" -{ - "ok": true, - "result": true -} -``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.mdx b/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.mdx new file mode 100644 index 0000000000..c700df9bd2 --- /dev/null +++ b/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Показать главную тему форума + Показывает ранее скрытую главную тему форума + + + +`Функция ПоказатьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка, Число | ID чата темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +
+ +:::tip +Метод в документации API: [unhideGeneralForumTopic](https://core.telegram.org/bots/api#unhidegeneralforumtopic) +::: +
+ + +```bsl title="Пример кода" + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + + Результат = OPI_Telegram.ПоказатьГлавнуюТемуФорума(Токен, Чат); +``` + + + + + + ```bash + oint telegram ПоказатьГлавнуюТемуФорума --token "***" \ + --forum "-1001971186208" + ``` + + + + ```batch + oint telegram ПоказатьГлавнуюТемуФорума ^ + --token "***" ^ + --forum "-1001971186208" + ``` + + + + +```json title="Результат" +{ + "ok": true, + "result": true +} +``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md b/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md deleted file mode 100644 index 7669b1ae93..0000000000 --- a/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить ссылку для авторизации - Формирует ссылку для авторизации через браузер - - - -`Функция ПолучитьСсылкуАвторизации(Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Строка - URL для перехода в браузере - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Результат = OPI_Twitter.ПолучитьСсылкуАвторизации(Параметры); -``` - - - - - - ```bash - oint twitter ПолучитьСсылкуАвторизации --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter ПолучитьСсылкуАвторизации ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https://api.athenaeum.digital/opi/hs/twitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" -``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.mdx b/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.mdx new file mode 100644 index 0000000000..c324a37f1a --- /dev/null +++ b/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить ссылку для авторизации + Формирует ссылку для авторизации через браузер + + + +`Функция ПолучитьСсылкуАвторизации(Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Строка - URL для перехода в браузере + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Результат = OPI_Twitter.ПолучитьСсылкуАвторизации(Параметры); +``` + + + + + + ```bash + oint twitter ПолучитьСсылкуАвторизации --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter ПолучитьСсылкуАвторизации ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https://api.athenaeum.digital/opi/hs/twitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" +``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Get-token.md b/docs/ru/md/Twitter/Data-and-settings/Get-token.md deleted file mode 100644 index 7f192f9a8d..0000000000 --- a/docs/ru/md/Twitter/Data-and-settings/Get-token.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить токен - Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации - - - -`Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Код | --code | Строка | Код, полученный из авторизации См.ПолучитьСсылкуАвторизации | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Код = "123456"; - - Результат = OPI_Twitter.ПолучитьТокен(Код, Параметры); -``` - - - - - - ```bash - oint twitter ПолучитьТокен --code "123456" \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter ПолучитьТокен ^ - --code "123456" ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "error": "invalid_request", - "error_description": "Value passed for the authorization code was invalid." -} -``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Get-token.mdx b/docs/ru/md/Twitter/Data-and-settings/Get-token.mdx new file mode 100644 index 0000000000..4799eda8b0 --- /dev/null +++ b/docs/ru/md/Twitter/Data-and-settings/Get-token.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить токен + Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации + + + +`Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Код | --code | Строка | Код, полученный из авторизации См.ПолучитьСсылкуАвторизации | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Код = "123456"; + + Результат = OPI_Twitter.ПолучитьТокен(Код, Параметры); +``` + + + + + + ```bash + oint twitter ПолучитьТокен --code "123456" \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter ПолучитьТокен ^ + --code "123456" ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "error": "invalid_request", + "error_description": "Value passed for the authorization code was invalid." +} +``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md deleted file mode 100644 index bf253f034c..0000000000 --- a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Обновить токен - Обновляет v2 токен при помощи refresh_token - - - -`Функция ОбновитьТокен(Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Результат = OPI_Twitter.ОбновитьТокен(Параметры); -``` - - - - - - ```bash - oint twitter ОбновитьТокен --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter ОбновитьТокен ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "token_type": "bearer", - "expires_in": 7200, - "access_token": "OV9FRzBrRnRHYUgzMm9Ka0J0VWVhTXdfS2Y5X01NenRBd05yYk0xRGo4TUdNOjE3Mjg0MDc4NTI0ODU6MToxOmF0OjE", - "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", - "refresh_token": "TDU0MWRoU0VpS2tkN21qNUVLeVVkaUV5Wl9JeVQ3ZXRiUEVIdGtoQUlGWHhNOjE3Mjg0MDc4NTI0ODU6MToxOnJ0OjE" -} -``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.mdx b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.mdx new file mode 100644 index 0000000000..b25db27d06 --- /dev/null +++ b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Обновить токен + Обновляет v2 токен при помощи refresh_token + + + +`Функция ОбновитьТокен(Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Результат = OPI_Twitter.ОбновитьТокен(Параметры); +``` + + + + + + ```bash + oint twitter ОбновитьТокен --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter ОбновитьТокен ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "token_type": "bearer", + "expires_in": 7200, + "access_token": "OV9FRzBrRnRHYUgzMm9Ka0J0VWVhTXdfS2Y5X01NenRBd05yYk0xRGo4TUdNOjE3Mjg0MDc4NTI0ODU6MToxOmF0OjE", + "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", + "refresh_token": "TDU0MWRoU0VpS2tkN21qNUVLeVVkaUV5Wl9JeVQ3ZXRiUEVIdGtoQUlGWHhNOjE3Mjg0MDc4NTI0ODU6MToxOnJ0OjE" +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-custom-tweet.md b/docs/ru/md/Twitter/Tweets/Create-custom-tweet.md deleted file mode 100644 index d6d65550b1..0000000000 --- a/docs/ru/md/Twitter/Tweets/Create-custom-tweet.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать произвольный твит - Создает твит с произвольным содержимым - - - -`Функция СоздатьПроизвольныйТвит(Знач Текст = "", Знач МассивМедиа = "", Знач МассивВариантовОпроса = "", Знач ДлительностьОпроса = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивМедиа | --media | Массив из Строка,ДвоичныеДанные | Массив двоичных данных или путей к файлам | - | МассивВариантовОпроса | --options | Массив из Строка | Массив вариантов опроса, если необходимо | - | ДлительностьОпроса | --dur | Строка,Число | Длительность опроса, если необходимо (опрос без длительности не создается) | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные данные или Путь к файлу - - МассивКартинок = Новый Массив(); - МассивКартинок.Добавить(Картинка1); - МассивКартинок.Добавить(Картинка2); - - МассивМедиа = OPI_Twitter.ЗагрузитьМассивВложений(МассивКартинок, "tweet_image", Параметры); - Результат = OPI_Twitter.СоздатьПроизвольныйТвит(Текст, МассивМедиа, , , Параметры); -``` - - - - - - ```bash - oint twitter СоздатьПроизвольныйТвит --text "Тестовый твитт5c0475ff-6640-40da-8f15-f6fc9bfa3703" \ - --media "['1846066565659197440','1846066584634167296']" \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter СоздатьПроизвольныйТвит ^ - --text "Тестовый твитт5c0475ff-6640-40da-8f15-f6fc9bfa3703" ^ - --media "['1846066565659197440','1846066584634167296']" ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "data": { - "edit_history_tweet_ids": [ - "1843703511571182018" - ], - "id": "1843703511571182018", - "text": "Тестовый твиттd33e634d-1e04-444a-b6be-f8a6f1babec0" - } -} -``` diff --git a/docs/ru/md/Twitter/Tweets/Create-custom-tweet.mdx b/docs/ru/md/Twitter/Tweets/Create-custom-tweet.mdx new file mode 100644 index 0000000000..1f5090dde7 --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Create-custom-tweet.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать произвольный твит + Создает твит с произвольным содержимым + + + +`Функция СоздатьПроизвольныйТвит(Знач Текст = "", Знач МассивМедиа = "", Знач МассивВариантовОпроса = "", Знач ДлительностьОпроса = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивМедиа | --media | Массив из Строка,ДвоичныеДанные | Массив двоичных данных или путей к файлам | + | МассивВариантовОпроса | --options | Массив из Строка | Массив вариантов опроса, если необходимо | + | ДлительностьОпроса | --dur | Строка,Число | Длительность опроса, если необходимо (опрос без длительности не создается) | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные данные или Путь к файлу + + МассивКартинок = Новый Массив(); + МассивКартинок.Добавить(Картинка1); + МассивКартинок.Добавить(Картинка2); + + МассивМедиа = OPI_Twitter.ЗагрузитьМассивВложений(МассивКартинок, "tweet_image", Параметры); + Результат = OPI_Twitter.СоздатьПроизвольныйТвит(Текст, МассивМедиа, , , Параметры); +``` + + + + + + ```bash + oint twitter СоздатьПроизвольныйТвит --text "Тестовый твитт5c0475ff-6640-40da-8f15-f6fc9bfa3703" \ + --media "['1846066565659197440','1846066584634167296']" \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter СоздатьПроизвольныйТвит ^ + --text "Тестовый твитт5c0475ff-6640-40da-8f15-f6fc9bfa3703" ^ + --media "['1846066565659197440','1846066584634167296']" ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "data": { + "edit_history_tweet_ids": [ + "1843703511571182018" + ], + "id": "1843703511571182018", + "text": "Тестовый твиттd33e634d-1e04-444a-b6be-f8a6f1babec0" + } +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md deleted file mode 100644 index 7bbdb49730..0000000000 --- a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Создать твит гифки - Создает твит с вложением-гифкой - - - -`Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивГифок | --gifs | Массив из Строка,ДвоичныеДанные | Массив файлов гифок | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - - Гифка = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Двоичные или Путь к файлу - Гифка2 = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Двоичные или Путь к файлу - - МассивГифок = Новый Массив; - МассивГифок.Добавить(Гифка); - МассивГифок.Добавить(Гифка2); - - Результат = OPI_Twitter.СоздатьТвитГифки(Текст, МассивГифок, Параметры); - - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - Результат = OPI_Twitter.СоздатьТвитГифки(Текст, Гифка, Параметры); -``` - - - - - - ```bash - oint twitter СоздатьТвитГифки --text "Тестовый твитт87e832c1-266b-4b63-80cf-d1c58048aa20" \ - --gifs C:\Users\Administrator\AppData\Local\Temp\2yqchovj31l.tmp \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter СоздатьТвитГифки ^ - --text "Тестовый твитт87e832c1-266b-4b63-80cf-d1c58048aa20" ^ - --gifs C:\Users\Administrator\AppData\Local\Temp\2yqchovj31l.tmp ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "data": { - "id": "1843703120704008495", - "edit_history_tweet_ids": [ - "1843703120704008495" - ], - "text": "Тестовый твитт7bb8366e-e270-4284-957c-19ec2ecda762 https://t.co/eufWFKfOpX" - } -} -``` diff --git a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.mdx b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.mdx new file mode 100644 index 0000000000..5789bab444 --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Создать твит гифки + Создает твит с вложением-гифкой + + + +`Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивГифок | --gifs | Массив из Строка,ДвоичныеДанные | Массив файлов гифок | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + + Гифка = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Двоичные или Путь к файлу + Гифка2 = "https://api.athenaeum.digital/test_data/animation.gif"; // URL, Двоичные или Путь к файлу + + МассивГифок = Новый Массив; + МассивГифок.Добавить(Гифка); + МассивГифок.Добавить(Гифка2); + + Результат = OPI_Twitter.СоздатьТвитГифки(Текст, МассивГифок, Параметры); + + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + Результат = OPI_Twitter.СоздатьТвитГифки(Текст, Гифка, Параметры); +``` + + + + + + ```bash + oint twitter СоздатьТвитГифки --text "Тестовый твитт87e832c1-266b-4b63-80cf-d1c58048aa20" \ + --gifs C:\Users\Administrator\AppData\Local\Temp\2yqchovj31l.tmp \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter СоздатьТвитГифки ^ + --text "Тестовый твитт87e832c1-266b-4b63-80cf-d1c58048aa20" ^ + --gifs C:\Users\Administrator\AppData\Local\Temp\2yqchovj31l.tmp ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "data": { + "id": "1843703120704008495", + "edit_history_tweet_ids": [ + "1843703120704008495" + ], + "text": "Тестовый твитт7bb8366e-e270-4284-957c-19ec2ecda762 https://t.co/eufWFKfOpX" + } +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-image-tweet.md b/docs/ru/md/Twitter/Tweets/Create-image-tweet.md deleted file mode 100644 index c80211bc3c..0000000000 --- a/docs/ru/md/Twitter/Tweets/Create-image-tweet.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать твит картинки - Создает твит с картинкой вложением - - - -`Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив файлов картинок | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные или Путь к файлу - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные или Путь к файлу - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить(Картинка); - МассивКартинок.Добавить(Картинка2); - - Результат = OPI_Twitter.СоздатьТвитКартинки(Текст, МассивКартинок, Параметры); - - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - Результат = OPI_Twitter.СоздатьТвитКартинки(Текст, Картинка, Параметры); -``` - - - - - - ```bash - oint twitter СоздатьТвитКартинки --text "Тестовый твиттe17ad33a-3564-4a01-a426-be88395376c1" \ - --pictures C:\Users\Administrator\AppData\Local\Temp\mta1akidbh2.tmp \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter СоздатьТвитКартинки ^ - --text "Тестовый твиттe17ad33a-3564-4a01-a426-be88395376c1" ^ - --pictures C:\Users\Administrator\AppData\Local\Temp\mta1akidbh2.tmp ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "data": { - "edit_history_tweet_ids": [ - "1843702764976603573" - ], - "text": "Тестовый твитт434c5e75-7284-4ee5-b4ce-ffbc33febd80 https://t.co/4j5KPuRULH", - "id": "1843702764976603573" - } -} -``` diff --git a/docs/ru/md/Twitter/Tweets/Create-image-tweet.mdx b/docs/ru/md/Twitter/Tweets/Create-image-tweet.mdx new file mode 100644 index 0000000000..25ae90e68a --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Create-image-tweet.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать твит картинки + Создает твит с картинкой вложением + + + +`Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив файлов картинок | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные или Путь к файлу + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные или Путь к файлу + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка); + МассивКартинок.Добавить(Картинка2); + + Результат = OPI_Twitter.СоздатьТвитКартинки(Текст, МассивКартинок, Параметры); + + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + Результат = OPI_Twitter.СоздатьТвитКартинки(Текст, Картинка, Параметры); +``` + + + + + + ```bash + oint twitter СоздатьТвитКартинки --text "Тестовый твиттe17ad33a-3564-4a01-a426-be88395376c1" \ + --pictures C:\Users\Administrator\AppData\Local\Temp\mta1akidbh2.tmp \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter СоздатьТвитКартинки ^ + --text "Тестовый твиттe17ad33a-3564-4a01-a426-be88395376c1" ^ + --pictures C:\Users\Administrator\AppData\Local\Temp\mta1akidbh2.tmp ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "data": { + "edit_history_tweet_ids": [ + "1843702764976603573" + ], + "text": "Тестовый твитт434c5e75-7284-4ee5-b4ce-ffbc33febd80 https://t.co/4j5KPuRULH", + "id": "1843702764976603573" + } +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md deleted file mode 100644 index 504e486bdc..0000000000 --- a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Создать твит опрос - Создает твит с опросом - - - -`Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивВариантов | --options | Массив из Строка | Массив вариантов опроса | - | Длительность | --duration | Строка,Число | Длительность опроса | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - - МассивОтветов = Новый Массив; - МассивОтветов.Добавить("Вариант 1"); - МассивОтветов.Добавить("Вариант 2"); - - Результат = OPI_Twitter.СоздатьТвитОпрос(Текст, МассивОтветов, 60, Параметры); -``` - - - - - - ```bash - oint twitter СоздатьТвитОпрос --text "Тестовый твитт239b5631-21ce-4267-a2fd-d1ffb4b5aca8" \ - --options "['Вариант 1','Вариант 2']" \ - --duration 60 \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter СоздатьТвитОпрос ^ - --text "Тестовый твитт239b5631-21ce-4267-a2fd-d1ffb4b5aca8" ^ - --options "['Вариант 1','Вариант 2']" ^ - --duration 60 ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "data": { - "text": "Тестовый твиттa06201e3-4fa7-403b-bdda-f9a6b14e5e94", - "id": "1843703421678887363", - "edit_history_tweet_ids": [ - "1843703421678887363" - ] - } -} -``` diff --git a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.mdx b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.mdx new file mode 100644 index 0000000000..e767739189 --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.mdx @@ -0,0 +1,75 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Создать твит опрос + Создает твит с опросом + + + +`Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивВариантов | --options | Массив из Строка | Массив вариантов опроса | + | Длительность | --duration | Строка,Число | Длительность опроса | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + + МассивОтветов = Новый Массив; + МассивОтветов.Добавить("Вариант 1"); + МассивОтветов.Добавить("Вариант 2"); + + Результат = OPI_Twitter.СоздатьТвитОпрос(Текст, МассивОтветов, 60, Параметры); +``` + + + + + + ```bash + oint twitter СоздатьТвитОпрос --text "Тестовый твитт239b5631-21ce-4267-a2fd-d1ffb4b5aca8" \ + --options "['Вариант 1','Вариант 2']" \ + --duration 60 \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter СоздатьТвитОпрос ^ + --text "Тестовый твитт239b5631-21ce-4267-a2fd-d1ffb4b5aca8" ^ + --options "['Вариант 1','Вариант 2']" ^ + --duration 60 ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "data": { + "text": "Тестовый твиттa06201e3-4fa7-403b-bdda-f9a6b14e5e94", + "id": "1843703421678887363", + "edit_history_tweet_ids": [ + "1843703421678887363" + ] + } +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-text-tweet.md b/docs/ru/md/Twitter/Tweets/Create-text-tweet.md deleted file mode 100644 index 52c5c2a8f0..0000000000 --- a/docs/ru/md/Twitter/Tweets/Create-text-tweet.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать текстовый твит - Создает твит без вложений - - - -`Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , , , Параметры);КонецФункции` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - - Результат = OPI_Twitter.СоздатьТекстовыйТвит(Текст, Параметры); -``` - - - - - - ```bash - oint twitter СоздатьТекстовыйТвит --text "Тестовый твиттba79585d-fd72-4bf5-8c16-32da70569d89" \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter СоздатьТекстовыйТвит ^ - --text "Тестовый твиттba79585d-fd72-4bf5-8c16-32da70569d89" ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "data": { - "edit_history_tweet_ids": [ - "1843702311643721803" - ], - "text": "Тестовый твиттc6e90c85-c8f1-42e2-93d6-417465165081", - "id": "1843702311643721803" - } -} -``` diff --git a/docs/ru/md/Twitter/Tweets/Create-text-tweet.mdx b/docs/ru/md/Twitter/Tweets/Create-text-tweet.mdx new file mode 100644 index 0000000000..c53367b6cf --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Create-text-tweet.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать текстовый твит + Создает твит без вложений + + + +`Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , , , Параметры);КонецФункции` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + + Результат = OPI_Twitter.СоздатьТекстовыйТвит(Текст, Параметры); +``` + + + + + + ```bash + oint twitter СоздатьТекстовыйТвит --text "Тестовый твиттba79585d-fd72-4bf5-8c16-32da70569d89" \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter СоздатьТекстовыйТвит ^ + --text "Тестовый твиттba79585d-fd72-4bf5-8c16-32da70569d89" ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "data": { + "edit_history_tweet_ids": [ + "1843702311643721803" + ], + "text": "Тестовый твиттc6e90c85-c8f1-42e2-93d6-417465165081", + "id": "1843702311643721803" + } +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-video-tweet.md b/docs/ru/md/Twitter/Tweets/Create-video-tweet.md deleted file mode 100644 index 07512c2885..0000000000 --- a/docs/ru/md/Twitter/Tweets/Create-video-tweet.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Создать твит видео - Создает твит с видеовложением - - - -`Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивВидео | --videos | Массив из Строка,ДвоичныеДанные | Массив файлов видео | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - - Видео = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Двоичные или Путь к файлу - Видео2 = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Двоичные или Путь к файлу - - МассивВидео = Новый Массив; - МассивВидео.Добавить(Видео); - МассивВидео.Добавить(Видео2); - - Результат = OPI_Twitter.СоздатьТвитВидео(Текст, МассивВидео, Параметры); - - Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); - Результат = OPI_Twitter.СоздатьТвитВидео(Текст, Видео, Параметры); -``` - - - - - - ```bash - oint twitter СоздатьТвитВидео --text "Тестовый твитт14a548af-c125-420a-8b58-bdf6790580cc" \ - --videos C:\Users\Administrator\AppData\Local\Temp\aoyarkkvwz3.tmp \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter СоздатьТвитВидео ^ - --text "Тестовый твитт14a548af-c125-420a-8b58-bdf6790580cc" ^ - --videos C:\Users\Administrator\AppData\Local\Temp\aoyarkkvwz3.tmp ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -{ - "data": { - "edit_history_tweet_ids": [ - "1843702415477895473" - ], - "text": "Тестовый твитт3d643580-f681-495e-9b5e-1f8af82745d4 https://t.co/0e9OmASUoP", - "id": "1843702415477895473" - } -} -``` diff --git a/docs/ru/md/Twitter/Tweets/Create-video-tweet.mdx b/docs/ru/md/Twitter/Tweets/Create-video-tweet.mdx new file mode 100644 index 0000000000..17e4787555 --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Create-video-tweet.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Создать твит видео + Создает твит с видеовложением + + + +`Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивВидео | --videos | Массив из Строка,ДвоичныеДанные | Массив файлов видео | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + + Видео = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Двоичные или Путь к файлу + Видео2 = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Двоичные или Путь к файлу + + МассивВидео = Новый Массив; + МассивВидео.Добавить(Видео); + МассивВидео.Добавить(Видео2); + + Результат = OPI_Twitter.СоздатьТвитВидео(Текст, МассивВидео, Параметры); + + Текст = "Тестовый твитт" + Строка(Новый УникальныйИдентификатор); + Результат = OPI_Twitter.СоздатьТвитВидео(Текст, Видео, Параметры); +``` + + + + + + ```bash + oint twitter СоздатьТвитВидео --text "Тестовый твитт14a548af-c125-420a-8b58-bdf6790580cc" \ + --videos C:\Users\Administrator\AppData\Local\Temp\aoyarkkvwz3.tmp \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter СоздатьТвитВидео ^ + --text "Тестовый твитт14a548af-c125-420a-8b58-bdf6790580cc" ^ + --videos C:\Users\Administrator\AppData\Local\Temp\aoyarkkvwz3.tmp ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +{ + "data": { + "edit_history_tweet_ids": [ + "1843702415477895473" + ], + "text": "Тестовый твитт3d643580-f681-495e-9b5e-1f8af82745d4 https://t.co/0e9OmASUoP", + "id": "1843702415477895473" + } +} +``` diff --git a/docs/ru/md/Twitter/Tweets/Upload-attachments-array.md b/docs/ru/md/Twitter/Tweets/Upload-attachments-array.md deleted file mode 100644 index ff59e88d57..0000000000 --- a/docs/ru/md/Twitter/Tweets/Upload-attachments-array.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Загрузить массив вложений - Загружает файлы на сервер и возвращает их ID - - - -`Функция ЗагрузитьМассивВложений(Знач МассивФайлов, Знач ТипВложений, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивФайлов | --files | Массив из Строка, ДвоичныеДанные | Массив файлов для загрузки | - | ТипВложений | --type | Строка | Тип вложений: tweet_video, tweet_image, tweet_gif | - | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | - - - Возвращаемое значение: Массив Из Строка - Массив ID медиа - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыАвторизацииТвиттер(); - - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные данные или Путь к файлу - - МассивКартинок = Новый Массив(); - МассивКартинок.Добавить(Картинка1); - МассивКартинок.Добавить(Картинка2); - - Результат = OPI_Twitter.ЗагрузитьМассивВложений(МассивКартинок, "tweet_image", Параметры); -``` - - - - - - ```bash - oint twitter ЗагрузитьМассивВложений --files "['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg']" \ - --type "tweet_image" \ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - ```batch - oint twitter ЗагрузитьМассивВложений ^ - --files "['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg']" ^ - --type "tweet_image" ^ - --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" - ``` - - - - -```json title="Результат" -[ - "1843702341419106304", - "1843702367809626112" -] -``` diff --git a/docs/ru/md/Twitter/Tweets/Upload-attachments-array.mdx b/docs/ru/md/Twitter/Tweets/Upload-attachments-array.mdx new file mode 100644 index 0000000000..1366ac62a7 --- /dev/null +++ b/docs/ru/md/Twitter/Tweets/Upload-attachments-array.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Загрузить массив вложений + Загружает файлы на сервер и возвращает их ID + + + +`Функция ЗагрузитьМассивВложений(Знач МассивФайлов, Знач ТипВложений, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивФайлов | --files | Массив из Строка, ДвоичныеДанные | Массив файлов для загрузки | + | ТипВложений | --type | Строка | Тип вложений: tweet_video, tweet_image, tweet_gif | + | Параметры | --auth | Структура из Строка | Данные авторизации. См.ПолучитьСтандартныеПараметры | + + + Возвращаемое значение: Массив Из Строка - Массив ID медиа + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыАвторизацииТвиттер(); + + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные данные или Путь к файлу + + МассивКартинок = Новый Массив(); + МассивКартинок.Добавить(Картинка1); + МассивКартинок.Добавить(Картинка2); + + Результат = OPI_Twitter.ЗагрузитьМассивВложений(МассивКартинок, "tweet_image", Параметры); +``` + + + + + + ```bash + oint twitter ЗагрузитьМассивВложений --files "['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg']" \ + --type "tweet_image" \ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + ```batch + oint twitter ЗагрузитьМассивВложений ^ + --files "['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg']" ^ + --type "tweet_image" ^ + --auth "{'redirect_uri':'https://api.athenaeum.digital/opi/hs/twitter','client_id':'***','client_secret':'***','access_token':'***','refresh_token':'***','oauth_token':'***','oauth_token_secret':'***','oauth_consumer_key':'***','oauth_consumer_secret':'***'}" + ``` + + + + +```json title="Результат" +[ + "1843702341419106304", + "1843702367809626112" +] +``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-ad.md b/docs/ru/md/VK/Ad-account-management/Create-ad.md deleted file mode 100644 index 5e3c7a9817..0000000000 --- a/docs/ru/md/VK/Ad-account-management/Create-ad.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать рекламное объявление - Создает рекламное объявление на основе поста - - - -`Функция СоздатьРекламноеОбъявление(Знач НомерКампании, Знач ДневнойЛимит, Знач НомерКатегории, Знач IDПоста, Знач IDКабинета, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | НомерКампании | --campaign | Строка,Число | ID рекламной кампании | - | ДневнойЛимит | --limit | Строка,Число | Дневной лимит в рублях | - | НомерКатегории | --category | Строка,Число | Номер рекламной категории | - | IDПоста | --post | Строка,Число | ID поста, используемого в качетсве рекламы | - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - НомерКампании = "1030715875"; - ДневнойЛимит = 150; - НомерКатегории = 126; - IDПоста = "4712"; - IDКабинета = "1607951446"; - - Результат = OPI_VK.СоздатьРекламноеОбъявление(НомерКампании - , ДневнойЛимит - , НомерКатегории - , IDПоста - , IDКабинета - , Параметры); -``` - - - - - - ```bash - oint vk СоздатьРекламноеОбъявление --campaign 1030721014 \ - --limit 150 \ - --category 126 \ - --post 4759 \ - --cabinet "1607951446" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьРекламноеОбъявление ^ - --campaign 1030721014 ^ - --limit 150 ^ - --category 126 ^ - --post 4759 ^ - --cabinet "1607951446" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": [ - { - "id": 0, - "error_code": 603, - "error_desc": "Some ads error occurs: ORD details must be presented." - } - ] -} -``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-ad.mdx b/docs/ru/md/VK/Ad-account-management/Create-ad.mdx new file mode 100644 index 0000000000..9586085fab --- /dev/null +++ b/docs/ru/md/VK/Ad-account-management/Create-ad.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать рекламное объявление + Создает рекламное объявление на основе поста + + + +`Функция СоздатьРекламноеОбъявление(Знач НомерКампании, Знач ДневнойЛимит, Знач НомерКатегории, Знач IDПоста, Знач IDКабинета, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | НомерКампании | --campaign | Строка,Число | ID рекламной кампании | + | ДневнойЛимит | --limit | Строка,Число | Дневной лимит в рублях | + | НомерКатегории | --category | Строка,Число | Номер рекламной категории | + | IDПоста | --post | Строка,Число | ID поста, используемого в качетсве рекламы | + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + НомерКампании = "1030715875"; + ДневнойЛимит = 150; + НомерКатегории = 126; + IDПоста = "4712"; + IDКабинета = "1607951446"; + + Результат = OPI_VK.СоздатьРекламноеОбъявление(НомерКампании + , ДневнойЛимит + , НомерКатегории + , IDПоста + , IDКабинета + , Параметры); +``` + + + + + + ```bash + oint vk СоздатьРекламноеОбъявление --campaign 1030721014 \ + --limit 150 \ + --category 126 \ + --post 4759 \ + --cabinet "1607951446" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьРекламноеОбъявление ^ + --campaign 1030721014 ^ + --limit 150 ^ + --category 126 ^ + --post 4759 ^ + --cabinet "1607951446" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": [ + { + "id": 0, + "error_code": 603, + "error_desc": "Some ads error occurs: ORD details must be presented." + } + ] +} +``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md b/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md deleted file mode 100644 index 4eb1bbee24..0000000000 --- a/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать рекламную кампанию - Создает кампанию в выбранном рекламном кабинете - - - -`Функция СоздатьРекламнуюКампанию(Знач IDКабинета, Знач Наименование, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | Наименование | --title | Строка | Наименование кампании | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - IDКабинета = "1607951446"; - Наименование = "Новая кампания"; - - Результат = OPI_VK.СоздатьРекламнуюКампанию(IDКабинета, Наименование, Параметры); -``` - - - - - - ```bash - oint vk СоздатьРекламнуюКампанию --cabinet "1607951446" \ - --title "Новая кампания" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьРекламнуюКампанию ^ - --cabinet "1607951446" ^ - --title "Новая кампания" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": [ - { - "id": 1030701429, - "error_code": 602, - "error_desc": "Some part of the request has not been completed" - } - ] -} -``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.mdx b/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.mdx new file mode 100644 index 0000000000..7f8d1bb763 --- /dev/null +++ b/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать рекламную кампанию + Создает кампанию в выбранном рекламном кабинете + + + +`Функция СоздатьРекламнуюКампанию(Знач IDКабинета, Знач Наименование, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | Наименование | --title | Строка | Наименование кампании | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + IDКабинета = "1607951446"; + Наименование = "Новая кампания"; + + Результат = OPI_VK.СоздатьРекламнуюКампанию(IDКабинета, Наименование, Параметры); +``` + + + + + + ```bash + oint vk СоздатьРекламнуюКампанию --cabinet "1607951446" \ + --title "Новая кампания" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьРекламнуюКампанию ^ + --cabinet "1607951446" ^ + --title "Новая кампания" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": [ + { + "id": 1030701429, + "error_code": 602, + "error_desc": "Some part of the request has not been completed" + } + ] +} +``` diff --git a/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md b/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md deleted file mode 100644 index 0aab2861d7..0000000000 --- a/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить список рекламных категорий - Получает список id рекламных категорий для создания рекламного объявления - - - -`Функция ПолучитьСписокРекламныхКатегорий(Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Результат = OPI_VK.ПолучитьСписокРекламныхКатегорий(Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСписокРекламныхКатегорий --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСписокРекламныхКатегорий ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "v1": [ - { - "id": 1, - "name": "Авто/мото", - "subcategories": [ - { - "id": 2, - "name": "Автомобильные дилеры" - }, - { - "id": 3, - "name": "Автопроизводители" - }, - { - "id": 4, - "name": "Автострахование" - }, - { - "id": 5, - "name": "Запчасти и аксессуары" - }, - { - "id": 7, - "name": "Курсы вождения" - }, - { - "id": 6, - "name": "Мотоциклы" - }, - { - "id": 8, - "name": "Техническое обслуживание" - }, - { - "id": 9, - "name": "Транспортные услуги" - } - ] - }, - { - "id": 112, - "name": "Бизнес", - "subcategories": [ - { - "id": 113, - "name": "Всё для офиса" - }, - { - "id": 114, - "name": "Деловые услуги" - }, - { - "id": 115, - "name": "Программное обеспечение и БД" - } - ] - }, - { - "id": 116, - "name": "Дом и быт", - "subcategories": [ - { - "id": 117, - "name": "Бытовая химия" - }, - { - "id": 122, - "name": "Дизайн интерьера" - }, - { - "id": 120, - "name": "Домашние животные" - }, - { - "id": 119, - "name": "Обустройства дома, мебель" - }, - { - "id": 123, - "name": "Ремонт, стройматериалы" - }, - { - "id": 121, - "name": "Садоводство" - }, - { - "id": 124, - "name": "Товары для детей" - }, - { - "id": 118, - "name": "Услуги клининговых компаний" - } - ] - }, - { - "id": 75, - "name": "Красота и здоровье", - "subcategories": [ - { - "id": 80, - "name": "БАДы" - }, - { - "id": 86, - "name": "Косметика и парфюмерия" - }, - { - "id": 82, - "name": "Косметология" - }, - { - "id": 77, - "name": "Лекарства и медицинские товары" - }, - { - "id": 76, - "name": "Медицинские учреждения" - }, - { - "id": 79, - "name": "Медицинское страхование" - }, - { - "id": 78, - "name": "Методы лечения" - }, - { - "id": 81, - "name": "Нетрадиционная медицина" - }, - { - "id": 83, - "name": "Пластическая хирургия" - }, - { - "id": 85, - "name": "Салоны красоты" - }, - { - "id": 84, - "name": "Стоматология" - }, - { - "id": 87, - "name": "Другие товары для красоты и здоровья" - } - ] -... -``` diff --git a/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.mdx b/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.mdx new file mode 100644 index 0000000000..df729b2b60 --- /dev/null +++ b/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить список рекламных категорий + Получает список id рекламных категорий для создания рекламного объявления + + + +`Функция ПолучитьСписокРекламныхКатегорий(Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Результат = OPI_VK.ПолучитьСписокРекламныхКатегорий(Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСписокРекламныхКатегорий --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСписокРекламныхКатегорий ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "v1": [ + { + "id": 1, + "name": "Авто/мото", + "subcategories": [ + { + "id": 2, + "name": "Автомобильные дилеры" + }, + { + "id": 3, + "name": "Автопроизводители" + }, + { + "id": 4, + "name": "Автострахование" + }, + { + "id": 5, + "name": "Запчасти и аксессуары" + }, + { + "id": 7, + "name": "Курсы вождения" + }, + { + "id": 6, + "name": "Мотоциклы" + }, + { + "id": 8, + "name": "Техническое обслуживание" + }, + { + "id": 9, + "name": "Транспортные услуги" + } + ] + }, + { + "id": 112, + "name": "Бизнес", + "subcategories": [ + { + "id": 113, + "name": "Всё для офиса" + }, + { + "id": 114, + "name": "Деловые услуги" + }, + { + "id": 115, + "name": "Программное обеспечение и БД" + } + ] + }, + { + "id": 116, + "name": "Дом и быт", + "subcategories": [ + { + "id": 117, + "name": "Бытовая химия" + }, + { + "id": 122, + "name": "Дизайн интерьера" + }, + { + "id": 120, + "name": "Домашние животные" + }, + { + "id": 119, + "name": "Обустройства дома, мебель" + }, + { + "id": 123, + "name": "Ремонт, стройматериалы" + }, + { + "id": 121, + "name": "Садоводство" + }, + { + "id": 124, + "name": "Товары для детей" + }, + { + "id": 118, + "name": "Услуги клининговых компаний" + } + ] + }, + { + "id": 75, + "name": "Красота и здоровье", + "subcategories": [ + { + "id": 80, + "name": "БАДы" + }, + { + "id": 86, + "name": "Косметика и парфюмерия" + }, + { + "id": 82, + "name": "Косметология" + }, + { + "id": 77, + "name": "Лекарства и медицинские товары" + }, + { + "id": 76, + "name": "Медицинские учреждения" + }, + { + "id": 79, + "name": "Медицинское страхование" + }, + { + "id": 78, + "name": "Методы лечения" + }, + { + "id": 81, + "name": "Нетрадиционная медицина" + }, + { + "id": 83, + "name": "Пластическая хирургия" + }, + { + "id": 85, + "name": "Салоны красоты" + }, + { + "id": 84, + "name": "Стоматология" + }, + { + "id": 87, + "name": "Другие товары для красоты и здоровья" + } + ] +... +``` diff --git a/docs/ru/md/VK/Ad-account-management/Pause-advertising.md b/docs/ru/md/VK/Ad-account-management/Pause-advertising.md deleted file mode 100644 index 6d123f84b2..0000000000 --- a/docs/ru/md/VK/Ad-account-management/Pause-advertising.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Приостановить рекламное объявление - Приостанавливает показ рекламного объявления - - - -`Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | IDОбъявления | --adv | Строка,Число | ID объявления | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - IDКабинета = "1607951446"; - IDОбъявления = "0"; - - Результат = OPI_VK.ПриостановитьРекламноеОбъявление(IDКабинета, IDОбъявления, Параметры); -``` - - - - - - ```bash - oint vk ПриостановитьРекламноеОбъявление --adv 0 \ - --cabinet "1607951446" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПриостановитьРекламноеОбъявление ^ - --adv 0 ^ - --cabinet "1607951446" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "error": { - "error_code": 100, - "error_msg": "One of the parameters specified was missing or invalid: data[0][ad_id] is invalid", - "request_params": [ - { - "key": "from_group", - "value": "1" - }, - { - "key": "owner_id", - "value": "-218861756" - }, - { - "key": "v", - "value": "5.131" - }, - { - "key": "app_id", - "value": "51694790" - }, - { - "key": "group_id", - "value": "218861756" - }, - { - "key": "account_id", - "value": "1607951446" - }, - { - "key": "data", - "value": "[\r\n {\r\n \"ad_id\": \"0\",\r\n \"status\": 0\r\n }\r\n]" - }, - { - "key": "method", - "value": "ads.updateAds" - }, - { - "key": "oauth", - "value": "1" - } - ] - } -} -``` diff --git a/docs/ru/md/VK/Ad-account-management/Pause-advertising.mdx b/docs/ru/md/VK/Ad-account-management/Pause-advertising.mdx new file mode 100644 index 0000000000..b9c166e2b7 --- /dev/null +++ b/docs/ru/md/VK/Ad-account-management/Pause-advertising.mdx @@ -0,0 +1,105 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Приостановить рекламное объявление + Приостанавливает показ рекламного объявления + + + +`Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | IDОбъявления | --adv | Строка,Число | ID объявления | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + IDКабинета = "1607951446"; + IDОбъявления = "0"; + + Результат = OPI_VK.ПриостановитьРекламноеОбъявление(IDКабинета, IDОбъявления, Параметры); +``` + + + + + + ```bash + oint vk ПриостановитьРекламноеОбъявление --adv 0 \ + --cabinet "1607951446" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПриостановитьРекламноеОбъявление ^ + --adv 0 ^ + --cabinet "1607951446" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "error": { + "error_code": 100, + "error_msg": "One of the parameters specified was missing or invalid: data[0][ad_id] is invalid", + "request_params": [ + { + "key": "from_group", + "value": "1" + }, + { + "key": "owner_id", + "value": "-218861756" + }, + { + "key": "v", + "value": "5.131" + }, + { + "key": "app_id", + "value": "51694790" + }, + { + "key": "group_id", + "value": "218861756" + }, + { + "key": "account_id", + "value": "1607951446" + }, + { + "key": "data", + "value": "[\r\n {\r\n \"ad_id\": \"0\",\r\n \"status\": 0\r\n }\r\n]" + }, + { + "key": "method", + "value": "ads.updateAds" + }, + { + "key": "oauth", + "value": "1" + } + ] + } +} +``` diff --git a/docs/ru/md/VK/Community-managment/Create-album.md b/docs/ru/md/VK/Community-managment/Create-album.md deleted file mode 100644 index c1da30de6e..0000000000 --- a/docs/ru/md/VK/Community-managment/Create-album.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Создать альбом - Создает альбом для хранения картинок - - - -`Функция СоздатьАльбом(Знач Наименование, Знач Описание = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование альбома | - | Описание | --description | Строка | Описание альбома | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Имя = "Альбом из автотеста"; - Описание = "Новый альбом из автотеста"; - - Результат = OPI_VK.СоздатьАльбом(Имя, Описание, Параметры); -``` - - - - - - ```bash - oint vk СоздатьАльбом --title "Альбом из автотеста" \ - --description "Новый альбом из автотеста" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьАльбом ^ - --title "Альбом из автотеста" ^ - --description "Новый альбом из автотеста" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "id": 306037648, - "owner_id": -218861756, - "size": 0, - "title": "Альбом из автотеста", - "feed_disabled": 0, - "feed_has_pinned": 0, - "can_upload": 1, - "comments_disabled": 0, - "created": 1728408618, - "description": "Новый альбом из автотеста", - "thumb_id": 0, - "updated": 1728408618, - "upload_by_admins_only": 1 - } -} -``` diff --git a/docs/ru/md/VK/Community-managment/Create-album.mdx b/docs/ru/md/VK/Community-managment/Create-album.mdx new file mode 100644 index 0000000000..300437654c --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Create-album.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Создать альбом + Создает альбом для хранения картинок + + + +`Функция СоздатьАльбом(Знач Наименование, Знач Описание = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование альбома | + | Описание | --description | Строка | Описание альбома | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Имя = "Альбом из автотеста"; + Описание = "Новый альбом из автотеста"; + + Результат = OPI_VK.СоздатьАльбом(Имя, Описание, Параметры); +``` + + + + + + ```bash + oint vk СоздатьАльбом --title "Альбом из автотеста" \ + --description "Новый альбом из автотеста" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьАльбом ^ + --title "Альбом из автотеста" ^ + --description "Новый альбом из автотеста" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "id": 306037648, + "owner_id": -218861756, + "size": 0, + "title": "Альбом из автотеста", + "feed_disabled": 0, + "feed_has_pinned": 0, + "can_upload": 1, + "comments_disabled": 0, + "created": 1728408618, + "description": "Новый альбом из автотеста", + "thumb_id": 0, + "updated": 1728408618, + "upload_by_admins_only": 1 + } +} +``` diff --git a/docs/ru/md/VK/Community-managment/Create-composite-post.md b/docs/ru/md/VK/Community-managment/Create-composite-post.md deleted file mode 100644 index d03ee87854..0000000000 --- a/docs/ru/md/VK/Community-managment/Create-composite-post.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать составной пост - Создает пост на основе массива идетификаторов объектов (картинок, видео и др.) - - - -`Функция СоздатьСоставнойПост(Знач Текст, Знач Объекты, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст поста | - | Объекты | --objects | Массив из Строка | Массив идентификаторов вида photo123_123 | - | Реклама | --ad | Булево | Признак ""Это реклама"" | - | СсылкаПодЗаписью | --url | Строка | Ссылка (URL) под записью | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Текст = "Пост из автотеста"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Видео = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Путь или Двоичные данные - - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, ИВФ); - - ЗагрузкаКартинки = OPI_VK.ЗагрузитьФотоНаСервер(ИВФ, Параметры)["response"][0]; - ЗагрузкаВидео = OPI_VK.ЗагрузитьВидеоНаСервер(Видео, "Новое видео", , , Параметры); - - ВладелецКартинки = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаКартинки["owner_id"]); - ВладелецВидео = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаВидео["owner_id"]); - - IDКартинки = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаКартинки["id"]); - IDВидео = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаВидео["video_id"]); - - МассивВложений = Новый Массив; - МассивВложений.Добавить("photo" + ВладелецКартинки + "_" + IDКартинки); - МассивВложений.Добавить("video" + ВладелецВидео + "_" + IDВидео); - - Результат = OPI_VK.СоздатьСоставнойПост(Текст, МассивВложений, Ложь, URL, Параметры); -``` - - - - - - ```bash - oint vk СоздатьСоставнойПост --text "Пост из автотеста" \ - --objects "['photo657846756_457244660','video-218861756_456239654']" \ - --ad false \ - --url "https://github.com/Bayselonarrend/OpenIntegrations" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьСоставнойПост ^ - --text "Пост из автотеста" ^ - --objects "['photo657846756_457244660','video-218861756_456239654']" ^ - --ad false ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "post_id": 4537 - } -} -``` diff --git a/docs/ru/md/VK/Community-managment/Create-composite-post.mdx b/docs/ru/md/VK/Community-managment/Create-composite-post.mdx new file mode 100644 index 0000000000..cf658d5056 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Create-composite-post.mdx @@ -0,0 +1,90 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать составной пост + Создает пост на основе массива идетификаторов объектов (картинок, видео и др.) + + + +`Функция СоздатьСоставнойПост(Знач Текст, Знач Объекты, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст поста | + | Объекты | --objects | Массив из Строка | Массив идентификаторов вида photo123_123 | + | Реклама | --ad | Булево | Признак ""Это реклама"" | + | СсылкаПодЗаписью | --url | Строка | Ссылка (URL) под записью | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Текст = "Пост из автотеста"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Видео = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Путь или Двоичные данные + + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, ИВФ); + + ЗагрузкаКартинки = OPI_VK.ЗагрузитьФотоНаСервер(ИВФ, Параметры)["response"][0]; + ЗагрузкаВидео = OPI_VK.ЗагрузитьВидеоНаСервер(Видео, "Новое видео", , , Параметры); + + ВладелецКартинки = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаКартинки["owner_id"]); + ВладелецВидео = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаВидео["owner_id"]); + + IDКартинки = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаКартинки["id"]); + IDВидео = OPI_Инструменты.ЧислоВСтроку(ЗагрузкаВидео["video_id"]); + + МассивВложений = Новый Массив; + МассивВложений.Добавить("photo" + ВладелецКартинки + "_" + IDКартинки); + МассивВложений.Добавить("video" + ВладелецВидео + "_" + IDВидео); + + Результат = OPI_VK.СоздатьСоставнойПост(Текст, МассивВложений, Ложь, URL, Параметры); +``` + + + + + + ```bash + oint vk СоздатьСоставнойПост --text "Пост из автотеста" \ + --objects "['photo657846756_457244660','video-218861756_456239654']" \ + --ad false \ + --url "https://github.com/Bayselonarrend/OpenIntegrations" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьСоставнойПост ^ + --text "Пост из автотеста" ^ + --objects "['photo657846756_457244660','video-218861756_456239654']" ^ + --ad false ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "post_id": 4537 + } +} +``` diff --git a/docs/ru/md/VK/Community-managment/Create-poll.md b/docs/ru/md/VK/Community-managment/Create-poll.md deleted file mode 100644 index 3d83f3ec60..0000000000 --- a/docs/ru/md/VK/Community-managment/Create-poll.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Создать опрос - Создает опрос с вариантами ответа - - - -`Функция СоздатьОпрос(Знач Вопрос, Знач МассивОтветов, Знач Картинка = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Вопрос | --question | Строка | Вопрос опроса | - | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | - | Картинка | --picture | Строка,ДвоичныеДанные | Картинка опроса | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Вопрос = "Какой ваш любимый цвет?"; - - МассивВариантов = Новый Массив; - МассивВариантов.Добавить("Красный"); - МассивВариантов.Добавить("Желтый"); - МассивВариантов.Добавить("Зеленый"); - - Результат = OPI_VK.СоздатьОпрос(Вопрос, МассивВариантов, , Параметры); -``` - - - - - - ```bash - oint vk СоздатьОпрос --question "Какой ваш любимый цвет?" \ - --options "['Красный','Желтый','Зеленый']" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьОпрос ^ - --question "Какой ваш любимый цвет?" ^ - --options "['Красный','Желтый','Зеленый']" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "post_id": 4538 - } -} -``` diff --git a/docs/ru/md/VK/Community-managment/Create-poll.mdx b/docs/ru/md/VK/Community-managment/Create-poll.mdx new file mode 100644 index 0000000000..506f0c3fac --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Create-poll.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Создать опрос + Создает опрос с вариантами ответа + + + +`Функция СоздатьОпрос(Знач Вопрос, Знач МассивОтветов, Знач Картинка = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Вопрос | --question | Строка | Вопрос опроса | + | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | + | Картинка | --picture | Строка,ДвоичныеДанные | Картинка опроса | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Вопрос = "Какой ваш любимый цвет?"; + + МассивВариантов = Новый Массив; + МассивВариантов.Добавить("Красный"); + МассивВариантов.Добавить("Желтый"); + МассивВариантов.Добавить("Зеленый"); + + Результат = OPI_VK.СоздатьОпрос(Вопрос, МассивВариантов, , Параметры); +``` + + + + + + ```bash + oint vk СоздатьОпрос --question "Какой ваш любимый цвет?" \ + --options "['Красный','Желтый','Зеленый']" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьОпрос ^ + --question "Какой ваш любимый цвет?" ^ + --options "['Красный','Желтый','Зеленый']" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "post_id": 4538 + } +} +``` diff --git a/docs/ru/md/VK/Community-managment/Create-post.md b/docs/ru/md/VK/Community-managment/Create-post.md deleted file mode 100644 index 876712e2b8..0000000000 --- a/docs/ru/md/VK/Community-managment/Create-post.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать пост - Создает пост с картинками - - - -`Функция СоздатьПост(Знач Текст, Знач МассивКартинок, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст поста | - | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив картинок | - | Реклама | --ad | Булево | Признак ""Это реклама"" | - | СсылкаПодЗаписью | --url | Строка | Ссылка (URL) под записью | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Текст = "Пост из автотеста"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Путь или Двоичные данные - - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка2, ИВФ); - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить(Картинка); - МассивКартинок.Добавить(ИВФ); - - Результат = OPI_VK.СоздатьПост(Текст, МассивКартинок, Истина, URL, Параметры); - - Результат = OPI_VK.СоздатьПост(Текст, Картинка, Ложь , , Параметры); -``` - - - - - - ```bash - oint vk СоздатьПост --text "Пост из автотеста" \ - --pictures "C:\Users\Administrator\AppData\Local\Temp\htntb5b3mly.png" \ - --ad true \ - --url "https://github.com/Bayselonarrend/OpenIntegrations" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьПост ^ - --text "Пост из автотеста" ^ - --pictures "C:\Users\Administrator\AppData\Local\Temp\htntb5b3mly.png" ^ - --ad true ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "post_id": 4534 - } -} -``` diff --git a/docs/ru/md/VK/Community-managment/Create-post.mdx b/docs/ru/md/VK/Community-managment/Create-post.mdx new file mode 100644 index 0000000000..6f7ba6151d --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Create-post.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать пост + Создает пост с картинками + + + +`Функция СоздатьПост(Знач Текст, Знач МассивКартинок, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст поста | + | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив картинок | + | Реклама | --ad | Булево | Признак ""Это реклама"" | + | СсылкаПодЗаписью | --url | Строка | Ссылка (URL) под записью | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Текст = "Пост из автотеста"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Путь или Двоичные данные + + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка2, ИВФ); + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка); + МассивКартинок.Добавить(ИВФ); + + Результат = OPI_VK.СоздатьПост(Текст, МассивКартинок, Истина, URL, Параметры); + + Результат = OPI_VK.СоздатьПост(Текст, Картинка, Ложь , , Параметры); +``` + + + + + + ```bash + oint vk СоздатьПост --text "Пост из автотеста" \ + --pictures "C:\Users\Administrator\AppData\Local\Temp\htntb5b3mly.png" \ + --ad true \ + --url "https://github.com/Bayselonarrend/OpenIntegrations" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьПост ^ + --text "Пост из автотеста" ^ + --pictures "C:\Users\Administrator\AppData\Local\Temp\htntb5b3mly.png" ^ + --ad true ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "post_id": 4534 + } +} +``` diff --git a/docs/ru/md/VK/Community-managment/Create-story.md b/docs/ru/md/VK/Community-managment/Create-story.md deleted file mode 100644 index d80196a5e2..0000000000 --- a/docs/ru/md/VK/Community-managment/Create-story.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Создать историю - Создает историю из картинки - - - -`Функция СоздатьИсторию(Знач Картинка, Знач URL = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Картинка | --picture | Строка,ДвоичныеДанные | Фон истории | - | URL | --url | Строка | URL для кнопки под историей | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, ИВФ); - Картинка = Новый ДвоичныеДанные(ИВФ); - - Результат = OPI_VK.СоздатьИсторию(Картинка , URL, Параметры); - - Результат = OPI_VK.СоздатьИсторию(ИВФ, , Параметры); -``` - - - - - - ```bash - oint vk СоздатьИсторию --picture "C:\Users\Administrator\AppData\Local\Temp\q5rtb2rnv2w.png" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьИсторию ^ - --picture "C:\Users\Administrator\AppData\Local\Temp\q5rtb2rnv2w.png" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "count": 1, - "items": [ - { - "id": 456239998, - "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": 1728408648, - "expires_at": 1728495048, - "link": { - "text": "Ещё", - "url": "https://github.com/Bayselonarrend/OpenIntegrations" - }, - "photo": { - "album_id": -81, - "date": 1728408648, - "id": 457249038, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun56-1.userapi.com/s/v1/ig2/Ud898csCCBAUh2w5L9fAQVHmm1MUChbDInW0YEjaSIPDTlVQGK6UUMhkav_oNqt9eA-m6NDXEglLvORdbOuOadHv.jpg?size=75x56&quality=95&type=story" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun56-1.userapi.com/s/v1/ig2/u5KBsVBmOwMEK8nGhNfjBcjrXYftO9dA-LLDH99tVvbzwhDaEAf25ag6iKg01Mq6kj0qUgL5Qx2b2Rep-0cHG_26.jpg?size=130x97&quality=95&type=story" - }, - { - "height": 192, - "type": "j", - "width": 256, - "url": "https://sun56-1.userapi.com/s/v1/ig2/2GHJduAuLaF7BSc535N-mB_YGBZKVaOmQCjdloX5sciu6bgsumzPgIUNLAGL3G25RV-KH5rz88GOmCL6NK8b9X18.jpg?size=256x192&quality=95&type=story" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun56-1.userapi.com/s/v1/ig2/-ktZ0uSZs5NYAeuKsDA3bS8iY3u2pBAxKUbvr3-S0p5l_k_30256vz_ECssJleF5kw5jnHa_INPLpXWjFatmlPW-.jpg?size=604x453&quality=95&type=story" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun56-1.userapi.com/s/v1/ig2/calELmiznnblgHJadnEcqwC13Zz_6mT-O-JTaCjjIwxzxsqB-SdyeX1VWTQ-q4f9b42V5LlXaAB_oHx2tlCIN-5A.jpg?size=807x605&quality=95&type=story" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun56-1.userapi.com/s/v1/ig2/_wrqPshHjgaUHuDgTe7kQ-O56dggxZbmh7D7wgwFvDlsECztrBQs_WNXvG6c6YxXlXKHsAG3U-4n-UI3JtSCrUUU.jpg?size=1280x960&quality=95&type=story" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun56-1.userapi.com/s/v1/ig2/L3_kf0hdHujB8uGlvAEvb5ag7K3pG8Lka7r9PV-ABADqLXCPoVjCslUS_n6mYnQE9-1HAk0vpXauwPWsbe-D8vFn.jpg?size=2560x1920&quality=95&type=story" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "7c7f903732449b0623", - "has_tags": false - }, - "replies": { - "count": 0, - "new": 0 - }, - "track_code": "story/3AAQAdLy9G9EAs4bMat+A84nNfHkBAAFoAagB6AIAA==", - "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 - } - ] - } -} -``` diff --git a/docs/ru/md/VK/Community-managment/Create-story.mdx b/docs/ru/md/VK/Community-managment/Create-story.mdx new file mode 100644 index 0000000000..265d147767 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Create-story.mdx @@ -0,0 +1,156 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Создать историю + Создает историю из картинки + + + +`Функция СоздатьИсторию(Знач Картинка, Знач URL = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Картинка | --picture | Строка,ДвоичныеДанные | Фон истории | + | URL | --url | Строка | URL для кнопки под историей | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, ИВФ); + Картинка = Новый ДвоичныеДанные(ИВФ); + + Результат = OPI_VK.СоздатьИсторию(Картинка , URL, Параметры); + + Результат = OPI_VK.СоздатьИсторию(ИВФ, , Параметры); +``` + + + + + + ```bash + oint vk СоздатьИсторию --picture "C:\Users\Administrator\AppData\Local\Temp\q5rtb2rnv2w.png" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьИсторию ^ + --picture "C:\Users\Administrator\AppData\Local\Temp\q5rtb2rnv2w.png" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "count": 1, + "items": [ + { + "id": 456239998, + "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": 1728408648, + "expires_at": 1728495048, + "link": { + "text": "Ещё", + "url": "https://github.com/Bayselonarrend/OpenIntegrations" + }, + "photo": { + "album_id": -81, + "date": 1728408648, + "id": 457249038, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun56-1.userapi.com/s/v1/ig2/Ud898csCCBAUh2w5L9fAQVHmm1MUChbDInW0YEjaSIPDTlVQGK6UUMhkav_oNqt9eA-m6NDXEglLvORdbOuOadHv.jpg?size=75x56&quality=95&type=story" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun56-1.userapi.com/s/v1/ig2/u5KBsVBmOwMEK8nGhNfjBcjrXYftO9dA-LLDH99tVvbzwhDaEAf25ag6iKg01Mq6kj0qUgL5Qx2b2Rep-0cHG_26.jpg?size=130x97&quality=95&type=story" + }, + { + "height": 192, + "type": "j", + "width": 256, + "url": "https://sun56-1.userapi.com/s/v1/ig2/2GHJduAuLaF7BSc535N-mB_YGBZKVaOmQCjdloX5sciu6bgsumzPgIUNLAGL3G25RV-KH5rz88GOmCL6NK8b9X18.jpg?size=256x192&quality=95&type=story" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun56-1.userapi.com/s/v1/ig2/-ktZ0uSZs5NYAeuKsDA3bS8iY3u2pBAxKUbvr3-S0p5l_k_30256vz_ECssJleF5kw5jnHa_INPLpXWjFatmlPW-.jpg?size=604x453&quality=95&type=story" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun56-1.userapi.com/s/v1/ig2/calELmiznnblgHJadnEcqwC13Zz_6mT-O-JTaCjjIwxzxsqB-SdyeX1VWTQ-q4f9b42V5LlXaAB_oHx2tlCIN-5A.jpg?size=807x605&quality=95&type=story" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun56-1.userapi.com/s/v1/ig2/_wrqPshHjgaUHuDgTe7kQ-O56dggxZbmh7D7wgwFvDlsECztrBQs_WNXvG6c6YxXlXKHsAG3U-4n-UI3JtSCrUUU.jpg?size=1280x960&quality=95&type=story" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun56-1.userapi.com/s/v1/ig2/L3_kf0hdHujB8uGlvAEvb5ag7K3pG8Lka7r9PV-ABADqLXCPoVjCslUS_n6mYnQE9-1HAk0vpXauwPWsbe-D8vFn.jpg?size=2560x1920&quality=95&type=story" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "7c7f903732449b0623", + "has_tags": false + }, + "replies": { + "count": 0, + "new": 0 + }, + "track_code": "story/3AAQAdLy9G9EAs4bMat+A84nNfHkBAAFoAagB6AIAA==", + "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 + } + ] + } +} +``` diff --git a/docs/ru/md/VK/Community-managment/Delete-album.md b/docs/ru/md/VK/Community-managment/Delete-album.md deleted file mode 100644 index 34379b9947..0000000000 --- a/docs/ru/md/VK/Community-managment/Delete-album.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Удалить альбом - Удаляет ранее созданный альбом - - - -`Функция УдалитьАльбом(Знач IDАльбома, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDАльбома | --album | Строка,Число | ID альбома | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ИДАльбома = "306093980"; - - Результат = OPI_VK.УдалитьАльбом(ИДАльбома, Параметры); -``` - - - - - - ```bash - oint vk УдалитьАльбом --album 306116890 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьАльбом ^ - --album 306116890 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Community-managment/Delete-album.mdx b/docs/ru/md/VK/Community-managment/Delete-album.mdx new file mode 100644 index 0000000000..9c0ccdde20 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Delete-album.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Удалить альбом + Удаляет ранее созданный альбом + + + +`Функция УдалитьАльбом(Знач IDАльбома, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDАльбома | --album | Строка,Число | ID альбома | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ИДАльбома = "306093980"; + + Результат = OPI_VK.УдалитьАльбом(ИДАльбома, Параметры); +``` + + + + + + ```bash + oint vk УдалитьАльбом --album 306116890 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьАльбом ^ + --album 306116890 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Community-managment/Delete-image.md b/docs/ru/md/VK/Community-managment/Delete-image.md deleted file mode 100644 index 4b74a05cb6..0000000000 --- a/docs/ru/md/VK/Community-managment/Delete-image.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Удалить картинку - Удалить картинку из альбома - - - -`Функция УдалитьКартинку(Знач IDКартинки, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКартинки | --pictureid | Строка,Число | ID картинки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ИДКартинки = "457249318"; - - Результат = OPI_VK.УдалитьКартинку(ИДКартинки, Параметры); -``` - - - - - - ```bash - oint vk УдалитьКартинку --pictureid 457249412 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьКартинку ^ - --pictureid 457249412 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Community-managment/Delete-image.mdx b/docs/ru/md/VK/Community-managment/Delete-image.mdx new file mode 100644 index 0000000000..2a6186a158 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Delete-image.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Удалить картинку + Удалить картинку из альбома + + + +`Функция УдалитьКартинку(Знач IDКартинки, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКартинки | --pictureid | Строка,Число | ID картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ИДКартинки = "457249318"; + + Результат = OPI_VK.УдалитьКартинку(ИДКартинки, Параметры); +``` + + + + + + ```bash + oint vk УдалитьКартинку --pictureid 457249412 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьКартинку ^ + --pictureid 457249412 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Community-managment/Delete-post.md b/docs/ru/md/VK/Community-managment/Delete-post.md deleted file mode 100644 index ceb1051841..0000000000 --- a/docs/ru/md/VK/Community-managment/Delete-post.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Удалить пост - Удаляет пост по id - - - -`Функция УдалитьПост(Знач IDПоста, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID поста | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ИДПоста = "4712"; - - Результат = OPI_VK.УдалитьПост(ИДПоста, Параметры); -``` - - - - - - ```bash - oint vk УдалитьПост --post "4753" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьПост ^ - --post "4753" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Community-managment/Delete-post.mdx b/docs/ru/md/VK/Community-managment/Delete-post.mdx new file mode 100644 index 0000000000..ac3501ce12 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Delete-post.mdx @@ -0,0 +1,59 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Удалить пост + Удаляет пост по id + + + +`Функция УдалитьПост(Знач IDПоста, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ИДПоста = "4712"; + + Результат = OPI_VK.УдалитьПост(ИДПоста, Параметры); +``` + + + + + + ```bash + oint vk УдалитьПост --post "4753" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьПост ^ + --post "4753" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Community-managment/Save-image-to-album.md b/docs/ru/md/VK/Community-managment/Save-image-to-album.md deleted file mode 100644 index 2642b8a7da..0000000000 --- a/docs/ru/md/VK/Community-managment/Save-image-to-album.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Сохранить картинку в альбом - Сохраняет картинку в альбом сообщества - - - -`Функция СохранитьКартинкуВАльбом(Знач IDАльбома, Знач Картинка, Знач Описание = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDАльбома | --album | Строка,Число | ID альбома | - | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | - | Описание | --description | Строка | Описание картинки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ОписаниеКартинки = "Картинка автотест"; - ИДАльбома = "306093980"; - - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, ИВФ); - - Картинка = Новый ДвоичныеДанные(ИВФ); - - Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, Картинка, ОписаниеКартинки, Параметры); - - Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, ИВФ, ОписаниеКартинки, Параметры); -``` - - - - - - ```bash - oint vk СохранитьКартинкуВАльбом --album 306116890 \ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --description "Картинка автотест" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СохранитьКартинкуВАльбом ^ - --album 306116890 ^ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --description "Картинка автотест" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": [ - { - "album_id": 306037648, - "date": 1728408622, - "id": 457249036, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "Картинка автотест", - "user_id": 100, - "web_view_token": "247a58d67fba483dc5", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - } - ] -} -``` diff --git a/docs/ru/md/VK/Community-managment/Save-image-to-album.mdx b/docs/ru/md/VK/Community-managment/Save-image-to-album.mdx new file mode 100644 index 0000000000..e349199f95 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Save-image-to-album.mdx @@ -0,0 +1,153 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Сохранить картинку в альбом + Сохраняет картинку в альбом сообщества + + + +`Функция СохранитьКартинкуВАльбом(Знач IDАльбома, Знач Картинка, Знач Описание = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDАльбома | --album | Строка,Число | ID альбома | + | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | + | Описание | --description | Строка | Описание картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ОписаниеКартинки = "Картинка автотест"; + ИДАльбома = "306093980"; + + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, ИВФ); + + Картинка = Новый ДвоичныеДанные(ИВФ); + + Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, Картинка, ОписаниеКартинки, Параметры); + + Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, ИВФ, ОписаниеКартинки, Параметры); +``` + + + + + + ```bash + oint vk СохранитьКартинкуВАльбом --album 306116890 \ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --description "Картинка автотест" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СохранитьКартинкуВАльбом ^ + --album 306116890 ^ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --description "Картинка автотест" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": [ + { + "album_id": 306037648, + "date": 1728408622, + "id": 457249036, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "Картинка автотест", + "user_id": 100, + "web_view_token": "247a58d67fba483dc5", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-38.userapi.com/s/v1/ig2/A0JdYbr6lxHvLdC6DlrNoC3y2qa-W-TIyotYztuH9zRhQEmA1B4gsTImrFiNTdNtd6cFazDTc1ay6yUckCcWXD4B.jpg?quality=96&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + } + ] +} +``` diff --git a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md deleted file mode 100644 index b29e7302e4..0000000000 --- a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Загрузить фото на сервер - Загружает фото на сервер для его дальнейшего использования - - - -`Функция ЗагрузитьФотоНаСервер(Знач Картинка, Знач Параметры = "", Знач Вид = "Пост") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Картинка | --file | Строка, ДвоичныеДанные | Файл картинки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - | Вид | --type | Строка | Вид загрузки (Пост, Товар, История, Опрос, Прочее) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу - Вид = "Пост"; - - Результат = OPI_VK.ЗагрузитьФотоНаСервер(Картинка, Параметры, Вид); -``` - - - - - - ```bash - oint vk ЗагрузитьФотоНаСервер --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --type "Пост" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ЗагрузитьФотоНаСервер ^ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --type "Пост" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response":[ - { - "album_id":289219319, - "date":1673516629, - "id":457239023, - "owner_id":743784474, - "sizes":[{"height":50,"type":"s","width":75,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Vus7E6r8jZjgv5E9bnuM6fbvL9U_NP4-goegNOaEy8t4Z1DnzofjER9exwblecB6Hxb3EUbWv7lQvxdRaErZGoT3.jpg?size=75x50&quality=96&type=album"},{"height":87,"type":"m","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":402,"type":"x","width":604,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/2DBzUBeOMpydPcypQFkirgj6g9mzsj8le0qsrWQ_lPX3zNQN1229bLivxf26ya-91HF9D57exLSnkSnJwUxJdUBN.jpg?size=604x402&quality=96&type=album"},{"height":537,"type":"y","width":807,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Biye5eNVG4UA_ymuN60MU6Qp26yO7rYp0WB-ch55oxkaATpXs4Kmqqznz1keCYHg_BHyvPhyrSGyK3zRK29LoVKH.jpg?size=807x537&quality=96&type=album"},{"height":852,"type":"z","width":1280,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/O-BkqGyWMw2ZKcOyYz8sH543Ihkws7mAn6x76JYh0mVW2MCR9x9eig_AS6gT6OLeySlvewx5oyri1Ejj0uNhJuKo.jpg?size=1280x852&quality=96&type=album"},{"height":1704,"type":"w","width":2560,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/o5klH0kpqicWBkDGQl_ch2j8VRpW69xrnq_PXw823wrMYc2qnXQLuDZeECtcKSaka1gfCpP9smoz7XwGAMDTk7vo.jpg?size=2560x1704&quality=96&type=album"},{"height":87,"type":"o","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":133,"type":"p","width":200,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/dFvcZ_sYZeMJtmvotINsevf_0x4KbDxo-jcrZojRQtebIKvM0juMU9U9NjybaidOukkrImr2CWcW8u6IHdlceWKD.jpg?size=200x133&quality=96&type=album"},{"height":213,"type":"q","width":320,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/GglL_Kv0x1_rnPwXwtTPZUMFg9sT_JB9xUSUeNvNIRapPRhGvQbQAaCwD57WBhUKU8sPD6-BhyadPIXaALqERkS1.jpg?size=320x213&quality=96&type=album"},{"height":340,"type":"r","width":510,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/LnQwirb-SUb689R2k90Q8MwuwHJ0tfO03a0IkCeXObaQERRE2-UUyLBCTTLme2qkLcxXAekHVbkLMEZhRq5E6Ggr.jpg?size=510x340&quality=96&crop=2,0,2556,1704&type=album"}], - "text":"", - "has_tags":false - } - ] -} -``` diff --git a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.mdx b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.mdx new file mode 100644 index 0000000000..74f6a30e90 --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Загрузить фото на сервер + Загружает фото на сервер для его дальнейшего использования + + + +`Функция ЗагрузитьФотоНаСервер(Знач Картинка, Знач Параметры = "", Знач Вид = "Пост") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Картинка | --file | Строка, ДвоичныеДанные | Файл картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + | Вид | --type | Строка | Вид загрузки (Пост, Товар, История, Опрос, Прочее) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные данные или Путь к файлу + Вид = "Пост"; + + Результат = OPI_VK.ЗагрузитьФотоНаСервер(Картинка, Параметры, Вид); +``` + + + + + + ```bash + oint vk ЗагрузитьФотоНаСервер --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --type "Пост" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ЗагрузитьФотоНаСервер ^ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --type "Пост" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response":[ + { + "album_id":289219319, + "date":1673516629, + "id":457239023, + "owner_id":743784474, + "sizes":[{"height":50,"type":"s","width":75,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Vus7E6r8jZjgv5E9bnuM6fbvL9U_NP4-goegNOaEy8t4Z1DnzofjER9exwblecB6Hxb3EUbWv7lQvxdRaErZGoT3.jpg?size=75x50&quality=96&type=album"},{"height":87,"type":"m","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":402,"type":"x","width":604,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/2DBzUBeOMpydPcypQFkirgj6g9mzsj8le0qsrWQ_lPX3zNQN1229bLivxf26ya-91HF9D57exLSnkSnJwUxJdUBN.jpg?size=604x402&quality=96&type=album"},{"height":537,"type":"y","width":807,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/Biye5eNVG4UA_ymuN60MU6Qp26yO7rYp0WB-ch55oxkaATpXs4Kmqqznz1keCYHg_BHyvPhyrSGyK3zRK29LoVKH.jpg?size=807x537&quality=96&type=album"},{"height":852,"type":"z","width":1280,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/O-BkqGyWMw2ZKcOyYz8sH543Ihkws7mAn6x76JYh0mVW2MCR9x9eig_AS6gT6OLeySlvewx5oyri1Ejj0uNhJuKo.jpg?size=1280x852&quality=96&type=album"},{"height":1704,"type":"w","width":2560,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/o5klH0kpqicWBkDGQl_ch2j8VRpW69xrnq_PXw823wrMYc2qnXQLuDZeECtcKSaka1gfCpP9smoz7XwGAMDTk7vo.jpg?size=2560x1704&quality=96&type=album"},{"height":87,"type":"o","width":130,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/JTtJ-M4Y1Md4nbNyY6QNKBjs9xleCGkDwGw-NuMvLV0DKfQrPb_xN7QcfazSTrBcZ-_JzsJ21pTuLI7Slr8m9HcB.jpg?size=130x87&quality=96&type=album"},{"height":133,"type":"p","width":200,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/dFvcZ_sYZeMJtmvotINsevf_0x4KbDxo-jcrZojRQtebIKvM0juMU9U9NjybaidOukkrImr2CWcW8u6IHdlceWKD.jpg?size=200x133&quality=96&type=album"},{"height":213,"type":"q","width":320,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/GglL_Kv0x1_rnPwXwtTPZUMFg9sT_JB9xUSUeNvNIRapPRhGvQbQAaCwD57WBhUKU8sPD6-BhyadPIXaALqERkS1.jpg?size=320x213&quality=96&type=album"},{"height":340,"type":"r","width":510,"url":"https:\/\/sun9-west.userapi.com\/sun9-45\/s\/v1\/ig2\/LnQwirb-SUb689R2k90Q8MwuwHJ0tfO03a0IkCeXObaQERRE2-UUyLBCTTLme2qkLcxXAekHVbkLMEZhRq5E6Ggr.jpg?size=510x340&quality=96&crop=2,0,2556,1704&type=album"}], + "text":"", + "has_tags":false + } + ] +} +``` diff --git a/docs/ru/md/VK/Community-managment/Upload-video-to-server.md b/docs/ru/md/VK/Community-managment/Upload-video-to-server.md deleted file mode 100644 index 9fe2da2306..0000000000 --- a/docs/ru/md/VK/Community-managment/Upload-video-to-server.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Загрузить видео на сервер - Загружает видео в группу с возможностью его дальнейшего использования - - - -`Функция ЗагрузитьВидеоНаСервер(Знач Видео, Знач Наименование, Знач Описание = "", Знач Альбом = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Видео | --file | Строка, ДвоичныеДанные | Файл видео | - | Наименование | --title | Строка | Наименование видео | - | Описание | --description | Строка | Описание видео | - | Альбом | --album | Строка | ID альбома, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Видео = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Двоичные данные или Путь к файлу - Наименование = "Новое видео"; - Описание = "Описание видео"; - - Результат = OPI_VK.ЗагрузитьВидеоНаСервер(Видео, Наименование, Описание, , Параметры); -``` - - - - - - ```bash - oint vk ЗагрузитьВидеоНаСервер --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/video.mp4" \ - --title "Новое видео" \ - --description "Описание видео" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ЗагрузитьВидеоНаСервер ^ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/video.mp4" ^ - --title "Новое видео" ^ - --description "Описание видео" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "video_hash": "a898ea9e008b0121e5", - "size": 1137878, - "direct_link": "https://vkvd208.okcdn.ru/?expires=1728668113340&srcIp=93.125.42.204&pr=40&srcAg=UNKNOWN&ms=45.136.22.144&type=4&sig=aigYqKrgsfc&ct=27&urls=185.226.55.182&clientType=14&appId=512000384397&zs=72&id=7374388988556", - "owner_id": -218861756, - "video_id": 456239601 -} -``` diff --git a/docs/ru/md/VK/Community-managment/Upload-video-to-server.mdx b/docs/ru/md/VK/Community-managment/Upload-video-to-server.mdx new file mode 100644 index 0000000000..71679f551d --- /dev/null +++ b/docs/ru/md/VK/Community-managment/Upload-video-to-server.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Загрузить видео на сервер + Загружает видео в группу с возможностью его дальнейшего использования + + + +`Функция ЗагрузитьВидеоНаСервер(Знач Видео, Знач Наименование, Знач Описание = "", Знач Альбом = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Видео | --file | Строка, ДвоичныеДанные | Файл видео | + | Наименование | --title | Строка | Наименование видео | + | Описание | --description | Строка | Описание видео | + | Альбом | --album | Строка | ID альбома, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Видео = "https://api.athenaeum.digital/test_data/video.mp4"; // URL, Двоичные данные или Путь к файлу + Наименование = "Новое видео"; + Описание = "Описание видео"; + + Результат = OPI_VK.ЗагрузитьВидеоНаСервер(Видео, Наименование, Описание, , Параметры); +``` + + + + + + ```bash + oint vk ЗагрузитьВидеоНаСервер --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/video.mp4" \ + --title "Новое видео" \ + --description "Описание видео" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ЗагрузитьВидеоНаСервер ^ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/video.mp4" ^ + --title "Новое видео" ^ + --description "Описание видео" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "video_hash": "a898ea9e008b0121e5", + "size": 1137878, + "direct_link": "https://vkvd208.okcdn.ru/?expires=1728668113340&srcIp=93.125.42.204&pr=40&srcAg=UNKNOWN&ms=45.136.22.144&type=4&sig=aigYqKrgsfc&ct=27&urls=185.226.55.182&clientType=14&appId=512000384397&zs=72&id=7374388988556", + "owner_id": -218861756, + "video_id": 456239601 +} +``` diff --git a/docs/ru/md/VK/Discussion-management/Close-discussion.md b/docs/ru/md/VK/Discussion-management/Close-discussion.md deleted file mode 100644 index abf54cdf81..0000000000 --- a/docs/ru/md/VK/Discussion-management/Close-discussion.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Закрыть обсуждение - Закрывает или удаляет обсуждение - - - -`Функция ЗакрытьОбсуждение(Знач IDОбсуждения, Знач УдалитьПолностью = Ложь, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDОбсуждения | --topic | Строка,Число | ID обсуждения | - | УдалитьПолностью | --remove | Булево | Удалить полностью (Истина) или закрыть | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ИДОбсуждения = "52595199"; - Результат = OPI_VK.ЗакрытьОбсуждение(ИДОбсуждения, Ложь, Параметры); -``` - - - - - - ```bash - oint vk ЗакрытьОбсуждение --topic 52605638 \ - --remove false \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ЗакрытьОбсуждение ^ - --topic 52605638 ^ - --remove false ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Discussion-management/Close-discussion.mdx b/docs/ru/md/VK/Discussion-management/Close-discussion.mdx new file mode 100644 index 0000000000..61b659239a --- /dev/null +++ b/docs/ru/md/VK/Discussion-management/Close-discussion.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Закрыть обсуждение + Закрывает или удаляет обсуждение + + + +`Функция ЗакрытьОбсуждение(Знач IDОбсуждения, Знач УдалитьПолностью = Ложь, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | УдалитьПолностью | --remove | Булево | Удалить полностью (Истина) или закрыть | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "52595199"; + Результат = OPI_VK.ЗакрытьОбсуждение(ИДОбсуждения, Ложь, Параметры); +``` + + + + + + ```bash + oint vk ЗакрытьОбсуждение --topic 52605638 \ + --remove false \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ЗакрытьОбсуждение ^ + --topic 52605638 ^ + --remove false ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Discussion-management/Create-discussion.md b/docs/ru/md/VK/Discussion-management/Create-discussion.md deleted file mode 100644 index 2d8813f47e..0000000000 --- a/docs/ru/md/VK/Discussion-management/Create-discussion.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать обсуждение - Создает новое обсуждение - - - -`Функция СоздатьОбсуждение(Знач Наименование, Знач ТекстПервогоСообщения, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование обсуждения | - | ТекстПервогоСообщения | --text | Строка | Текст первого сообщения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Название = "Обсуждаем: какой цвет лучше?"; - Сообщение = "Красный, желтый, синий или какой-то другой?"; - - Результат = OPI_VK.СоздатьОбсуждение(Название, Сообщение, Параметры); -``` - - - - - - ```bash - oint vk СоздатьОбсуждение --title "Обсуждаем: какой цвет лучше?" \ - --text "Красный, желтый, синий или какой-то другой?" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьОбсуждение ^ - --title "Обсуждаем: какой цвет лучше?" ^ - --text "Красный, желтый, синий или какой-то другой?" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 52571123 -} -``` diff --git a/docs/ru/md/VK/Discussion-management/Create-discussion.mdx b/docs/ru/md/VK/Discussion-management/Create-discussion.mdx new file mode 100644 index 0000000000..db25aebf83 --- /dev/null +++ b/docs/ru/md/VK/Discussion-management/Create-discussion.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать обсуждение + Создает новое обсуждение + + + +`Функция СоздатьОбсуждение(Знач Наименование, Знач ТекстПервогоСообщения, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование обсуждения | + | ТекстПервогоСообщения | --text | Строка | Текст первого сообщения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Название = "Обсуждаем: какой цвет лучше?"; + Сообщение = "Красный, желтый, синий или какой-то другой?"; + + Результат = OPI_VK.СоздатьОбсуждение(Название, Сообщение, Параметры); +``` + + + + + + ```bash + oint vk СоздатьОбсуждение --title "Обсуждаем: какой цвет лучше?" \ + --text "Красный, желтый, синий или какой-то другой?" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьОбсуждение ^ + --title "Обсуждаем: какой цвет лучше?" ^ + --text "Красный, желтый, синий или какой-то другой?" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 52571123 +} +``` diff --git a/docs/ru/md/VK/Discussion-management/Open-discussion.md b/docs/ru/md/VK/Discussion-management/Open-discussion.md deleted file mode 100644 index 61a7b6cff3..0000000000 --- a/docs/ru/md/VK/Discussion-management/Open-discussion.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Открыть обсуждение - Открывает ранее закрытое обсуждение - - - -`Функция ОткрытьОбсуждение(Знач IDОбсуждения, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDОбсуждения | --topic | Строка,Число | ID обсуждения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ИДОбсуждения = "52595199"; - Результат = OPI_VK.ОткрытьОбсуждение(ИДОбсуждения, Параметры); -``` - - - - - - ```bash - oint vk ОткрытьОбсуждение --topic 52605638 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ОткрытьОбсуждение ^ - --topic 52605638 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Discussion-management/Open-discussion.mdx b/docs/ru/md/VK/Discussion-management/Open-discussion.mdx new file mode 100644 index 0000000000..39e185c326 --- /dev/null +++ b/docs/ru/md/VK/Discussion-management/Open-discussion.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Открыть обсуждение + Открывает ранее закрытое обсуждение + + + +`Функция ОткрытьОбсуждение(Знач IDОбсуждения, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "52595199"; + Результат = OPI_VK.ОткрытьОбсуждение(ИДОбсуждения, Параметры); +``` + + + + + + ```bash + oint vk ОткрытьОбсуждение --topic 52605638 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ОткрытьОбсуждение ^ + --topic 52605638 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Discussion-management/Write-in-discussion.md b/docs/ru/md/VK/Discussion-management/Write-in-discussion.md deleted file mode 100644 index c32e1cb35f..0000000000 --- a/docs/ru/md/VK/Discussion-management/Write-in-discussion.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Написать в обсуждение - Добавляет сообщение в обсуждение от имени группы - - - -`Функция НаписатьВОбсуждение(Знач IDОбсуждения, Знач Текст, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDОбсуждения | --topic | Строка,Число | ID обсуждения | - | Текст | --text | Строка | Текст сообщения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - ИДОбсуждения = "52595199"; - Сообщение = "Мне больше нравится желтый"; - - Результат = OPI_VK.НаписатьВОбсуждение(ИДОбсуждения, Сообщение, Параметры); -``` - - - - - - ```bash - oint vk НаписатьВОбсуждение --topic 52605638 \ - --text "Мне больше нравится желтый" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk НаписатьВОбсуждение ^ - --topic 52605638 ^ - --text "Мне больше нравится желтый" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1507 -} -``` diff --git a/docs/ru/md/VK/Discussion-management/Write-in-discussion.mdx b/docs/ru/md/VK/Discussion-management/Write-in-discussion.mdx new file mode 100644 index 0000000000..668a645d40 --- /dev/null +++ b/docs/ru/md/VK/Discussion-management/Write-in-discussion.mdx @@ -0,0 +1,63 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Написать в обсуждение + Добавляет сообщение в обсуждение от имени группы + + + +`Функция НаписатьВОбсуждение(Знач IDОбсуждения, Знач Текст, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | Текст | --text | Строка | Текст сообщения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "52595199"; + Сообщение = "Мне больше нравится желтый"; + + Результат = OPI_VK.НаписатьВОбсуждение(ИДОбсуждения, Сообщение, Параметры); +``` + + + + + + ```bash + oint vk НаписатьВОбсуждение --topic 52605638 \ + --text "Мне больше нравится желтый" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk НаписатьВОбсуждение ^ + --topic 52605638 ^ + --text "Мне больше нравится желтый" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1507 +} +``` diff --git a/docs/ru/md/VK/Interactive-actions/Like-post.md b/docs/ru/md/VK/Interactive-actions/Like-post.md deleted file mode 100644 index ebbab28ecd..0000000000 --- a/docs/ru/md/VK/Interactive-actions/Like-post.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Поставить лайк - Ставит лайк на пост - - - -`Функция ПоставитьЛайк(Знач IDПоста, Знач IDСтены = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID поста | - | IDСтены | --wall | Строка,Число | ID стены расположения поста | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - IDПоста = "4712"; - - Результат = OPI_VK.ПоставитьЛайк(IDПоста, , Параметры); -``` - - - - - - ```bash - oint vk ПоставитьЛайк --post 4756 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПоставитьЛайк ^ - --post 4756 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "likes": 1 - } -} -``` diff --git a/docs/ru/md/VK/Interactive-actions/Like-post.mdx b/docs/ru/md/VK/Interactive-actions/Like-post.mdx new file mode 100644 index 0000000000..bb4a05611f --- /dev/null +++ b/docs/ru/md/VK/Interactive-actions/Like-post.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Поставить лайк + Ставит лайк на пост + + + +`Функция ПоставитьЛайк(Знач IDПоста, Знач IDСтены = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | IDСтены | --wall | Строка,Число | ID стены расположения поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + IDПоста = "4712"; + + Результат = OPI_VK.ПоставитьЛайк(IDПоста, , Параметры); +``` + + + + + + ```bash + oint vk ПоставитьЛайк --post 4756 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПоставитьЛайк ^ + --post 4756 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "likes": 1 + } +} +``` diff --git a/docs/ru/md/VK/Interactive-actions/Make-repost.md b/docs/ru/md/VK/Interactive-actions/Make-repost.md deleted file mode 100644 index f84678e0ca..0000000000 --- a/docs/ru/md/VK/Interactive-actions/Make-repost.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Сделать репост - Делает репост записи - - - -`Функция СделатьРепост(Знач IDПоста, Знач IDСтены = "", Знач ЦелеваяСтена = "", Знач Рекламный = Ложь, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID поста | - | IDСтены | --from | Строка,Число | ID стены расположения поста | - | ЦелеваяСтена | --to | Строка,Число | ID целевой стены или группы | - | Рекламный | --ad | Булево | Признак рекламного поста | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - IDПоста = 2571; - IDСтены = -218704372; - - Результат = OPI_VK.СделатьРепост(IDПоста, IDСтены, , , Параметры); -``` - - - - - - ```bash - oint vk СделатьРепост --post 2571 \ - --from -218704372 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СделатьРепост ^ - --post 2571 ^ - --from -218704372 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "success": 1, - "post_id": 4540, - "reposts_count": 3, - "likes_count": 10, - "wall_repost_count": 1, - "mail_repost_count": 2, - "badges": { - "type": 11, - "id": 2571, - "owner_id": -218704372 - } - } -} -``` diff --git a/docs/ru/md/VK/Interactive-actions/Make-repost.mdx b/docs/ru/md/VK/Interactive-actions/Make-repost.mdx new file mode 100644 index 0000000000..b5b0607478 --- /dev/null +++ b/docs/ru/md/VK/Interactive-actions/Make-repost.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Сделать репост + Делает репост записи + + + +`Функция СделатьРепост(Знач IDПоста, Знач IDСтены = "", Знач ЦелеваяСтена = "", Знач Рекламный = Ложь, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | IDСтены | --from | Строка,Число | ID стены расположения поста | + | ЦелеваяСтена | --to | Строка,Число | ID целевой стены или группы | + | Рекламный | --ad | Булево | Признак рекламного поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + IDПоста = 2571; + IDСтены = -218704372; + + Результат = OPI_VK.СделатьРепост(IDПоста, IDСтены, , , Параметры); +``` + + + + + + ```bash + oint vk СделатьРепост --post 2571 \ + --from -218704372 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СделатьРепост ^ + --post 2571 ^ + --from -218704372 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "success": 1, + "post_id": 4540, + "reposts_count": 3, + "likes_count": 10, + "wall_repost_count": 1, + "mail_repost_count": 2, + "badges": { + "type": 11, + "id": 2571, + "owner_id": -218704372 + } + } +} +``` diff --git a/docs/ru/md/VK/Interactive-actions/Shorten-link.md b/docs/ru/md/VK/Interactive-actions/Shorten-link.md deleted file mode 100644 index 02592b5a2b..0000000000 --- a/docs/ru/md/VK/Interactive-actions/Shorten-link.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Сократить ссылку - Создает сокращенный URL из обычного - - - -`Функция СократитьСсылку(Знач URL, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL для сокращения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Строка - Сокращенный URL - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Результат = OPI_VK.СократитьСсылку("https://github.com/Bayselonarrend/OpenIntegrations", Параметры); -``` - - - - - - ```bash - oint vk СократитьСсылку --url "https://github.com/Bayselonarrend/OpenIntegrations" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СократитьСсылку ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -"https://vk.cc/ctL1sM" -``` diff --git a/docs/ru/md/VK/Interactive-actions/Shorten-link.mdx b/docs/ru/md/VK/Interactive-actions/Shorten-link.mdx new file mode 100644 index 0000000000..85ddbffca4 --- /dev/null +++ b/docs/ru/md/VK/Interactive-actions/Shorten-link.mdx @@ -0,0 +1,56 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Сократить ссылку + Создает сокращенный URL из обычного + + + +`Функция СократитьСсылку(Знач URL, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL для сокращения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Строка - Сокращенный URL + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Результат = OPI_VK.СократитьСсылку("https://github.com/Bayselonarrend/OpenIntegrations", Параметры); +``` + + + + + + ```bash + oint vk СократитьСсылку --url "https://github.com/Bayselonarrend/OpenIntegrations" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СократитьСсылку ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +"https://vk.cc/ctL1sM" +``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-comment.md b/docs/ru/md/VK/Interactive-actions/Write-comment.md deleted file mode 100644 index 29daa337f2..0000000000 --- a/docs/ru/md/VK/Interactive-actions/Write-comment.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Написать комментарий - Создает комментарий под выбранной записью - - - -`Функция НаписатьКомментарий(Знач IDПоста, Знач IDСтены, Знач Текст, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID целевого поста | - | IDСтены | --wall | Строка,Число | ID стены расположения поста | - | Текст | --text | Строка | Текст комментария | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Текст = "Новый комментарий"; - IDПоста = "4712"; - IDСтены = Параметры["owner_id"]; - - Результат = OPI_VK.НаписатьКомментарий(IDПоста, IDСтены, Текст, Параметры); -``` - - - - - - ```bash - oint vk НаписатьКомментарий --post 4756 \ - --wall "-218861756" \ - --text "Новый комментарий" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk НаписатьКомментарий ^ - --post 4756 ^ - --wall "-218861756" ^ - --text "Новый комментарий" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "comment_id": 4541, - "parents_stack": [] - } -} -``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-comment.mdx b/docs/ru/md/VK/Interactive-actions/Write-comment.mdx new file mode 100644 index 0000000000..23d9d8d704 --- /dev/null +++ b/docs/ru/md/VK/Interactive-actions/Write-comment.mdx @@ -0,0 +1,70 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Написать комментарий + Создает комментарий под выбранной записью + + + +`Функция НаписатьКомментарий(Знач IDПоста, Знач IDСтены, Знач Текст, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID целевого поста | + | IDСтены | --wall | Строка,Число | ID стены расположения поста | + | Текст | --text | Строка | Текст комментария | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Текст = "Новый комментарий"; + IDПоста = "4712"; + IDСтены = Параметры["owner_id"]; + + Результат = OPI_VK.НаписатьКомментарий(IDПоста, IDСтены, Текст, Параметры); +``` + + + + + + ```bash + oint vk НаписатьКомментарий --post 4756 \ + --wall "-218861756" \ + --text "Новый комментарий" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk НаписатьКомментарий ^ + --post 4756 ^ + --wall "-218861756" ^ + --text "Новый комментарий" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "comment_id": 4541, + "parents_stack": [] + } +} +``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-message.md b/docs/ru/md/VK/Interactive-actions/Write-message.md deleted file mode 100644 index 9a56191f68..0000000000 --- a/docs/ru/md/VK/Interactive-actions/Write-message.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Написать сообщение - Написать сообщение пользователю в диалоге сообщества - - - -`Функция НаписатьСообщение(Знач Текст, Знач IDПользователя, Знач Communitytoken, Знач Клавиатура = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст сообщения | - | IDПользователя | --user | Строка | ID пользователя адресата | - | Communitytoken | --ct | Строка | Токен бота чата сообщества, котрый можно получить в настройках | - | Клавиатура | --keyboard | Строка | JSON клавиатуры. См.СформироватьКлавиатуру | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Текст = "Сообщение из автотеста"; - IDПользователя = "657846756"; - Communitytoken = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8I..."; - - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Button 1"); - МассивКнопок.Добавить("Button 2"); - - Клавиатура = OPI_VK.СформироватьКлавиатуру(МассивКнопок); - Результат = OPI_VK.НаписатьСообщение(Текст, IDПользователя, Communitytoken, Клавиатура, Параметры); -``` - - - - - - ```bash - oint vk НаписатьСообщение --text "Сообщение из автотеста" \ - --user "657846756" \ - --ct "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8IFYAtSiw1s0xmjMMNN_mAKhsWQinOkAs5pw08YtWITbuKBgIboTFqvyTQyPtkpCbckftGHR6xabK0tA-Y98vsPZDUUZ2RVd9wO-P-8WzDyE86vg" \ - --keyboard "{'buttons':[[{'action':{'type':'text','label':'Button 1'}},{'action':{'type':'text','label':'Button 2'}}]],'one_time':false}" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk НаписатьСообщение ^ - --text "Сообщение из автотеста" ^ - --user "657846756" ^ - --ct "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8IFYAtSiw1s0xmjMMNN_mAKhsWQinOkAs5pw08YtWITbuKBgIboTFqvyTQyPtkpCbckftGHR6xabK0tA-Y98vsPZDUUZ2RVd9wO-P-8WzDyE86vg" ^ - --keyboard "{'buttons':[[{'action':{'type':'text','label':'Button 1'}},{'action':{'type':'text','label':'Button 2'}}]],'one_time':false}" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 561 -} -``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-message.mdx b/docs/ru/md/VK/Interactive-actions/Write-message.mdx new file mode 100644 index 0000000000..f30375bf2c --- /dev/null +++ b/docs/ru/md/VK/Interactive-actions/Write-message.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Написать сообщение + Написать сообщение пользователю в диалоге сообщества + + + +`Функция НаписатьСообщение(Знач Текст, Знач IDПользователя, Знач Communitytoken, Знач Клавиатура = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст сообщения | + | IDПользователя | --user | Строка | ID пользователя адресата | + | Communitytoken | --ct | Строка | Токен бота чата сообщества, котрый можно получить в настройках | + | Клавиатура | --keyboard | Строка | JSON клавиатуры. См.СформироватьКлавиатуру | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Текст = "Сообщение из автотеста"; + IDПользователя = "657846756"; + Communitytoken = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8I..."; + + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Button 1"); + МассивКнопок.Добавить("Button 2"); + + Клавиатура = OPI_VK.СформироватьКлавиатуру(МассивКнопок); + Результат = OPI_VK.НаписатьСообщение(Текст, IDПользователя, Communitytoken, Клавиатура, Параметры); +``` + + + + + + ```bash + oint vk НаписатьСообщение --text "Сообщение из автотеста" \ + --user "657846756" \ + --ct "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8IFYAtSiw1s0xmjMMNN_mAKhsWQinOkAs5pw08YtWITbuKBgIboTFqvyTQyPtkpCbckftGHR6xabK0tA-Y98vsPZDUUZ2RVd9wO-P-8WzDyE86vg" \ + --keyboard "{'buttons':[[{'action':{'type':'text','label':'Button 1'}},{'action':{'type':'text','label':'Button 2'}}]],'one_time':false}" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk НаписатьСообщение ^ + --text "Сообщение из автотеста" ^ + --user "657846756" ^ + --ct "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8IFYAtSiw1s0xmjMMNN_mAKhsWQinOkAs5pw08YtWITbuKBgIboTFqvyTQyPtkpCbckftGHR6xabK0tA-Y98vsPZDUUZ2RVd9wO-P-8WzDyE86vg" ^ + --keyboard "{'buttons':[[{'action':{'type':'text','label':'Button 1'}},{'action':{'type':'text','label':'Button 2'}}]],'one_time':false}" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 561 +} +``` diff --git a/docs/ru/md/VK/Order-management/Get-order-list.md b/docs/ru/md/VK/Order-management/Get-order-list.md deleted file mode 100644 index 6991171e0a..0000000000 --- a/docs/ru/md/VK/Order-management/Get-order-list.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список заказов - Возвращает список заказов сообщества - - - -`Функция ПолучитьСписокЗаказов(Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Результат = OPI_VK.ПолучитьСписокЗаказов(Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСписокЗаказов --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСписокЗаказов ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -[ - { - "id": 397209, - "group_id": 218861756, - "user_id": 657846756, - "date": 1708092731, - "status": 0, - "items_count": 1, - "total_price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽" - }, - "display_order_id": "657846756-397209", - "merchant_comment": "", - "weight": 100, - "tags": [], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "preview_order_items": [ - { - "owner_id": -218861756, - "item_id": 8653766, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽" - }, - "quantity": 1, - "item": { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "", - "section": { - "id": 9000, - "name": "Все товары" - } - }, - "description": "Описание товара", - "id": 8653766, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (Красный)", - "date": 1708083983, - "item_type": 0, - "is_owner": true, - "is_adult": false, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/wosvBQJa9bQ.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6068bf9db412cd491d405a90737e5208&c_uniq_tag=k-olNZ8Ykr5YbvQQiBDDJlj5UeQvopai5F2oAP29As8", - "cart_quantity": 0, - "sku": "12 345", - "reject_info": { - "title": "Отредактируйте товар, чтобы опубликовать в Маркете ВКонтакте", - "description": "Товар отклонён. Чтобы добавить его в «Маркет», укажите реальную цену товара или стоимость оказания услуги.", - "moderation_status": 2, - "info_link": "[https://vk.com/faq20323|Правила Маркета ВКонтакте]", - "write_to_support_link": "https://vk.com/im?media=&sel=-215808305&ref=ProductId%3D-218861756_8653766", - "in_progress": false, - "buttons": [ - { - "type": "market_edit", - "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653766&type=market" - }, - { - "type": "market_delete" - } - ] - }, - "has_group_access": true, - "market_url": "https://vk.com/market/product/testovy-tovar-krasny-218861756-8653766" - }, - "title": "Тестовый товар (Красный)", - "photo": { - "album_id": -105, - "date": 1708092731, - "id": 457241543, - "owner_id": 657846756, - "sizes": [ - { - "height": 75, - "type": "s", - "width": 75, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=75x75" - }, - { - "height": 130, - "type": "m", - "width": 130, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" - }, - { - "height": 604, - "type": "x", - "width": 604, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=604x604" - }, - { - "height": 807, - "type": "y", - "width": 807, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=807x807" - }, - { - "height": 1024, - "type": "z", - "width": 1024, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=1024x1024" - }, - { - "height": 130, - "type": "o", - "width": 130, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" - }, - { - "height": 200, - "type": "p", - "width": 200, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=200x200" - }, - { - "height": 320, - "type": "q", - "width": 320, - "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=320x320" - }, - { -... -``` diff --git a/docs/ru/md/VK/Order-management/Get-order-list.mdx b/docs/ru/md/VK/Order-management/Get-order-list.mdx new file mode 100644 index 0000000000..797839f437 --- /dev/null +++ b/docs/ru/md/VK/Order-management/Get-order-list.mdx @@ -0,0 +1,202 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список заказов + Возвращает список заказов сообщества + + + +`Функция ПолучитьСписокЗаказов(Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Результат = OPI_VK.ПолучитьСписокЗаказов(Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСписокЗаказов --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСписокЗаказов ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +[ + { + "id": 397209, + "group_id": 218861756, + "user_id": 657846756, + "date": 1708092731, + "status": 0, + "items_count": 1, + "total_price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽" + }, + "display_order_id": "657846756-397209", + "merchant_comment": "", + "weight": 100, + "tags": [], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "preview_order_items": [ + { + "owner_id": -218861756, + "item_id": 8653766, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽" + }, + "quantity": 1, + "item": { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "", + "section": { + "id": 9000, + "name": "Все товары" + } + }, + "description": "Описание товара", + "id": 8653766, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (Красный)", + "date": 1708083983, + "item_type": 0, + "is_owner": true, + "is_adult": false, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/wosvBQJa9bQ.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6068bf9db412cd491d405a90737e5208&c_uniq_tag=k-olNZ8Ykr5YbvQQiBDDJlj5UeQvopai5F2oAP29As8", + "cart_quantity": 0, + "sku": "12 345", + "reject_info": { + "title": "Отредактируйте товар, чтобы опубликовать в Маркете ВКонтакте", + "description": "Товар отклонён. Чтобы добавить его в «Маркет», укажите реальную цену товара или стоимость оказания услуги.", + "moderation_status": 2, + "info_link": "[https://vk.com/faq20323|Правила Маркета ВКонтакте]", + "write_to_support_link": "https://vk.com/im?media=&sel=-215808305&ref=ProductId%3D-218861756_8653766", + "in_progress": false, + "buttons": [ + { + "type": "market_edit", + "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653766&type=market" + }, + { + "type": "market_delete" + } + ] + }, + "has_group_access": true, + "market_url": "https://vk.com/market/product/testovy-tovar-krasny-218861756-8653766" + }, + "title": "Тестовый товар (Красный)", + "photo": { + "album_id": -105, + "date": 1708092731, + "id": 457241543, + "owner_id": 657846756, + "sizes": [ + { + "height": 75, + "type": "s", + "width": 75, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=75x75" + }, + { + "height": 130, + "type": "m", + "width": 130, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" + }, + { + "height": 604, + "type": "x", + "width": 604, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=604x604" + }, + { + "height": 807, + "type": "y", + "width": 807, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=807x807" + }, + { + "height": 1024, + "type": "z", + "width": 1024, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=1024x1024" + }, + { + "height": 130, + "type": "o", + "width": 130, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=130x130" + }, + { + "height": 200, + "type": "p", + "width": 200, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=200x200" + }, + { + "height": 320, + "type": "q", + "width": 320, + "url": "https://sun9-32.userapi.com/s/v1/ig2/31vvuOgBYo0XLpwmR4BsP1ilGbMDyMakBQIYLHejeBhcKeBHxTjKG25nKWgMCYPO-BgpcfrHGhrqpB1Qk7wWCZA-.jpg?quality=95&as=32x32,48x48,72x72,108x108,160x160,240x240,360x360,480x480,540x540,640x640,720x720,1024x1024&from=bu&cs=320x320" + }, + { +... +``` diff --git a/docs/ru/md/VK/Others/Form-keyboard.md b/docs/ru/md/VK/Others/Form-keyboard.md deleted file mode 100644 index 424bde8957..0000000000 --- a/docs/ru/md/VK/Others/Form-keyboard.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Сформировать клавиатуру - Формирует клавиатуру по массиву кнопок - - - -`Функция СформироватьКлавиатуру(Знач МассивКнопок) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивКнопок | --buttons | Массив из Строка | Массив заголовков кнопок | - - - Возвращаемое значение: Строка - JSON клавиатуры - -
- - - - -```bsl title="Пример кода" - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Button 1"); - МассивКнопок.Добавить("Button 2"); - - Клавиатура = OPI_VK.СформироватьКлавиатуру(МассивКнопок); -``` - - - - - - ```bash - oint vk СформироватьКлавиатуру --buttons "['Button 1','Button 2']" - ``` - - - - ```batch - oint vk СформироватьКлавиатуру ^ - --buttons "['Button 1','Button 2']" - ``` - - - - -```json title="Результат" -{ - "buttons": [ - [ - { - "action": { - "type": "text", - "label": "Кнопка 1" - } - }, - { - "action": { - "type": "text", - "label": "Кнопка 2" - } - } - ] - ], - "one_time": false - } -``` diff --git a/docs/ru/md/VK/Others/Form-keyboard.mdx b/docs/ru/md/VK/Others/Form-keyboard.mdx new file mode 100644 index 0000000000..62b42897e8 --- /dev/null +++ b/docs/ru/md/VK/Others/Form-keyboard.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Сформировать клавиатуру + Формирует клавиатуру по массиву кнопок + + + +`Функция СформироватьКлавиатуру(Знач МассивКнопок) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив заголовков кнопок | + + + Возвращаемое значение: Строка - JSON клавиатуры + +
+ + + + +```bsl title="Пример кода" + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Button 1"); + МассивКнопок.Добавить("Button 2"); + + Клавиатура = OPI_VK.СформироватьКлавиатуру(МассивКнопок); +``` + + + + + + ```bash + oint vk СформироватьКлавиатуру --buttons "['Button 1','Button 2']" + ``` + + + + ```batch + oint vk СформироватьКлавиатуру ^ + --buttons "['Button 1','Button 2']" + ``` + + + + +```json title="Результат" +{ + "buttons": [ + [ + { + "action": { + "type": "text", + "label": "Кнопка 1" + } + }, + { + "action": { + "type": "text", + "label": "Кнопка 2" + } + } + ] + ], + "one_time": false + } +``` diff --git a/docs/ru/md/VK/Product-management/Add-product.md b/docs/ru/md/VK/Product-management/Add-product.md deleted file mode 100644 index 53cac0e3b2..0000000000 --- a/docs/ru/md/VK/Product-management/Add-product.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Добавить товар - Добавляет новый товар в каталог сообщества - - - -`Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | - | Подборка | --sel | Строка | ID подборка для помещения товара, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные или Путь к файлу - Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные или Путь к файлу - Подборка = "130"; - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить(Картинка1); - МассивКартинок.Добавить(Картинка2); - - ОписаниеТовара = Новый Соответствие(); - ОписаниеТовара.Вставить("Имя" , "Тестовый товар"); - ОписаниеТовара.Вставить("Описание" , "Описание товара"); - ОписаниеТовара.Вставить("Категория" , "20173"); - ОписаниеТовара.Вставить("Цена" , 1); - ОписаниеТовара.Вставить("СтараяЦена" , 15); - ОписаниеТовара.Вставить("ОсновноеФото" , Картинка1); - ОписаниеТовара.Вставить("URL" , "https://github.com/Bayselonarrend/OpenIntegrations"); - ОписаниеТовара.Вставить("ДополнительныеФото" , МассивКартинок); - ОписаниеТовара.Вставить("ГлавныйВГруппе" , Истина); - ОписаниеТовара.Вставить("Ширина" , 20); - ОписаниеТовара.Вставить("Высота" , 30); - ОписаниеТовара.Вставить("Глубина" , 40); - ОписаниеТовара.Вставить("Вес" , 100); - ОписаниеТовара.Вставить("SKU" , "12345"); - ОписаниеТовара.Вставить("ДоступныйОстаток" , "10"); - - Результат = OPI_VK.ДобавитьТовар(ОписаниеТовара, Подборка, Параметры); -``` - - - - - - ```bash - oint vk ДобавитьТовар --product "{'Имя':'Тестовый товар (другой)','Описание':'Описание товара','Категория':'20173','Цена':1,'СтараяЦена':15,'ОсновноеФото':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','URL':'https://github.com/Bayselonarrend/OpenIntegrations','ДополнительныеФото':['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'],'ГлавныйВГруппе':true,'НомерГруппы':null,'Ширина':20,'Высота':30,'Глубина':40,'Вес':100,'SKU':12345,'ДоступныйОстаток':'10','ЗначенияСвойств':2617}" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ДобавитьТовар ^ - --product "{'Имя':'Тестовый товар (другой)','Описание':'Описание товара','Категория':'20173','Цена':1,'СтараяЦена':15,'ОсновноеФото':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','URL':'https://github.com/Bayselonarrend/OpenIntegrations','ДополнительныеФото':['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'],'ГлавныйВГруппе':true,'НомерГруппы':null,'Ширина':20,'Высота':30,'Глубина':40,'Вес':100,'SKU':12345,'ДоступныйОстаток':'10','ЗначенияСвойств':2617}" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "market_item_id": 9701909 - } -} -``` diff --git a/docs/ru/md/VK/Product-management/Add-product.mdx b/docs/ru/md/VK/Product-management/Add-product.mdx new file mode 100644 index 0000000000..27a962d4c1 --- /dev/null +++ b/docs/ru/md/VK/Product-management/Add-product.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Добавить товар + Добавляет новый товар в каталог сообщества + + + +`Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | + | Подборка | --sel | Строка | ID подборка для помещения товара, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Картинка1 = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Двоичные или Путь к файлу + Картинка2 = "https://api.athenaeum.digital/test_data/picture2.jpg"; // URL, Двоичные или Путь к файлу + Подборка = "130"; + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка1); + МассивКартинок.Добавить(Картинка2); + + ОписаниеТовара = Новый Соответствие(); + ОписаниеТовара.Вставить("Имя" , "Тестовый товар"); + ОписаниеТовара.Вставить("Описание" , "Описание товара"); + ОписаниеТовара.Вставить("Категория" , "20173"); + ОписаниеТовара.Вставить("Цена" , 1); + ОписаниеТовара.Вставить("СтараяЦена" , 15); + ОписаниеТовара.Вставить("ОсновноеФото" , Картинка1); + ОписаниеТовара.Вставить("URL" , "https://github.com/Bayselonarrend/OpenIntegrations"); + ОписаниеТовара.Вставить("ДополнительныеФото" , МассивКартинок); + ОписаниеТовара.Вставить("ГлавныйВГруппе" , Истина); + ОписаниеТовара.Вставить("Ширина" , 20); + ОписаниеТовара.Вставить("Высота" , 30); + ОписаниеТовара.Вставить("Глубина" , 40); + ОписаниеТовара.Вставить("Вес" , 100); + ОписаниеТовара.Вставить("SKU" , "12345"); + ОписаниеТовара.Вставить("ДоступныйОстаток" , "10"); + + Результат = OPI_VK.ДобавитьТовар(ОписаниеТовара, Подборка, Параметры); +``` + + + + + + ```bash + oint vk ДобавитьТовар --product "{'Имя':'Тестовый товар (другой)','Описание':'Описание товара','Категория':'20173','Цена':1,'СтараяЦена':15,'ОсновноеФото':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','URL':'https://github.com/Bayselonarrend/OpenIntegrations','ДополнительныеФото':['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'],'ГлавныйВГруппе':true,'НомерГруппы':null,'Ширина':20,'Высота':30,'Глубина':40,'Вес':100,'SKU':12345,'ДоступныйОстаток':'10','ЗначенияСвойств':2617}" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ДобавитьТовар ^ + --product "{'Имя':'Тестовый товар (другой)','Описание':'Описание товара','Категория':'20173','Цена':1,'СтараяЦена':15,'ОсновноеФото':'https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','URL':'https://github.com/Bayselonarrend/OpenIntegrations','ДополнительныеФото':['https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg','https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture2.jpg'],'ГлавныйВГруппе':true,'НомерГруппы':null,'Ширина':20,'Высота':30,'Глубина':40,'Вес':100,'SKU':12345,'ДоступныйОстаток':'10','ЗначенияСвойств':2617}" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "market_item_id": 9701909 + } +} +``` diff --git a/docs/ru/md/VK/Product-management/Delete-product.md b/docs/ru/md/VK/Product-management/Delete-product.md deleted file mode 100644 index 91377298a6..0000000000 --- a/docs/ru/md/VK/Product-management/Delete-product.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Удалить товар - Удаляет ранее созданный товар - - - -`Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товар | --item | Строка,Число | ID товара | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар = "9756133"; - - Результат = OPI_VK.УдалитьТовар(Товар, Параметры); -``` - - - - - - ```bash - oint vk УдалитьТовар --item 9774863 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьТовар ^ - --item 9774863 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-management/Delete-product.mdx b/docs/ru/md/VK/Product-management/Delete-product.mdx new file mode 100644 index 0000000000..e75299be95 --- /dev/null +++ b/docs/ru/md/VK/Product-management/Delete-product.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Удалить товар + Удаляет ранее созданный товар + + + +`Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Строка,Число | ID товара | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар = "9756133"; + + Результат = OPI_VK.УдалитьТовар(Товар, Параметры); +``` + + + + + + ```bash + oint vk УдалитьТовар --item 9774863 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьТовар ^ + --item 9774863 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-management/Edit-product.md b/docs/ru/md/VK/Product-management/Edit-product.md deleted file mode 100644 index fdc422e760..0000000000 --- a/docs/ru/md/VK/Product-management/Edit-product.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Изменить товар - Изменяет ранее созданный товар - - - -`Функция ИзменитьТовар(Знач Товар, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товар | --item | Число,Строка | Идентификатор изменяемого товара | - | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | - | Подборка | --sel | Строка | Идентификатор новой подборки, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар = "9756133"; - - ОписаниеТовара = Новый Соответствие; - ОписаниеТовара.Вставить("Имя", "Тестовый товар измененный"); - - Результат = OPI_VK.ИзменитьТовар(Товар, ОписаниеТовара, , Параметры); -``` - - - - - - ```bash - oint vk ИзменитьТовар --product "{'Имя':'Тестовый товар измененный'}" \ - --item 9774863 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ИзменитьТовар ^ - --product "{'Имя':'Тестовый товар измененный'}" ^ - --item 9774863 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-management/Edit-product.mdx b/docs/ru/md/VK/Product-management/Edit-product.mdx new file mode 100644 index 0000000000..dcc2648eb7 --- /dev/null +++ b/docs/ru/md/VK/Product-management/Edit-product.mdx @@ -0,0 +1,67 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Изменить товар + Изменяет ранее созданный товар + + + +`Функция ИзменитьТовар(Знач Товар, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Число,Строка | Идентификатор изменяемого товара | + | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | + | Подборка | --sel | Строка | Идентификатор новой подборки, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар = "9756133"; + + ОписаниеТовара = Новый Соответствие; + ОписаниеТовара.Вставить("Имя", "Тестовый товар измененный"); + + Результат = OPI_VK.ИзменитьТовар(Товар, ОписаниеТовара, , Параметры); +``` + + + + + + ```bash + oint vk ИзменитьТовар --product "{'Имя':'Тестовый товар измененный'}" \ + --item 9774863 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ИзменитьТовар ^ + --product "{'Имя':'Тестовый товар измененный'}" ^ + --item 9774863 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-management/Get-product-category-list.md b/docs/ru/md/VK/Product-management/Get-product-category-list.md deleted file mode 100644 index 5c4b0331a1..0000000000 --- a/docs/ru/md/VK/Product-management/Get-product-category-list.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список категорий товаров - Получает список ID товарных категорий для указания при создании товара - - - -`Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из Строка - Ключ - ID, Значение - Имя - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Результат = OPI_VK.ПолучитьСписокКатегорийТоваров(Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСписокКатегорийТоваров --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСписокКатегорийТоваров ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "20000": "Женщинам", - "20001": "Мужчинам", - "20002": "Детям", - "20003": "Смартфоны и гаджеты", - "20004": "Квадрокоптеры и аксессуары", - "20005": "Планшеты и электронные книги", - "20006": "Умный дом и безопасность", - "20007": "ТВ, аудио и видео", - "20008": "Фото- и видеокамеры", - "20009": "Компьютеры и ноутбуки", - "20010": "Сетевое оборудование", - "20011": "Оргтехника и расходники", - "20012": "Навигаторы", - "20013": "Крупная бытовая техника", - "20014": "Малая бытовая техника для кухни", - "20015": "Техника для дома", - "20016": "Климатическая техника", - "20017": "Встраиваемая бытовая техника", - "20018": "Техника для красоты и здоровья", - "20019": "Хозяйственные товары", - "20020": "Посуда и товары для кухни", - "20021": "Товары для праздников", - "20022": "Аксесcуары для ванной и туалета", - "20023": "Домашний текстиль", - "20024": "Интерьер и декор", - "20025": "Освещение", - "20026": "Мебель", - "20027": "Дача и сад", - "20179": "Ритуальные товары", - "20177": "Гадания и эзотерика", - "20028": "Билеты и путешествия", - "20029": "Книги и журналы", - "20030": "Рукоделие и творчество", - "20031": "Настольные и карточные игры", - "20033": "Музыкальные инструменты", - "20034": "Коллекционирование", - "20035": "Подарочные сертификаты", - "20036": "Сувениры и цветы", - "20147": "Теннис и бадминтон", - "20148": "Дартс", - "20146": "Гольф", - "20037": "Тренажеры и фитнес", - "20038": "Спортивная одежда", - "20039": "Спортивная обувь", - "20040": "Зимний спорт", - "20041": "Командные виды спорта", - "20042": "Бокс и единоборства", - "20043": "Водный спорт", - "20044": "Художественная гимнастика", - "20045": "Велосипеды и аксессуары", - "20047": "Самокаты, скейтборды и ролики", - "20048": "Электротранспорт", - "20049": "Настольные спортивные игры", - "20050": "Спортивные комплексы", - "20051": "Охота и рыбалка", - "20052": "Туризм и отдых на природе", - "20053": "Чемоданы, сумки и рюкзаки", - "20054": "Спортивное питание", - "20055": "Бакалея", - "20056": "Мясо и птица", - "20057": "Рыба и морепродукты", - "20058": "Овощи, фрукты, зелень", - "20059": "Соленья", - "20060": "Молочные продукты и яйца", - "20061": "Мясные деликатесы", - "20062": "Детское питание", - "20063": "Еда на заказ", - "20064": "Напитки", - "20180": "Замороженные продукты", - "20065": "Автокресла", - "20066": "Детская комната", - "20067": "Коляски", - "20068": "Игрушки и игры", - "20069": "Подгузники и гигиена", - "20070": "Техника для мам и детей", - "20071": "Товары для кормления", - "20072": "Детское питание и кормление", - "20073": "Спорт и отдых", - "20074": "Хобби и творчество", - "20076": "Игровые приставки", - "20077": "Игровые ноутбуки", - "20078": "Игровые компьютеры", - "20079": "Игровые мониторы", - "20080": "Игры для ПК", - "20081": "Игровая периферия", - "20082": "Игровые столы", - "20083": "Компьютерные кресла", - "20085": "Игровая атрибутика", - "20086": "Макияж", - "20087": "Уход за лицом", - "20088": "Уход за телом", - "20089": "Защита от солнца и автозагар", - "20090": "Уход за волосами", - "20091": "Маникюр и педикюр", - "20092": "Мужская косметика", - "20093": "Парфюмерия", - "20094": "Ароматерапия", - "20095": "Средства гигиены", - "20096": "Контактные линзы, очки и аксессуары", - "20097": "Ортопедия, Компрессионный трикотаж", - "20098": "Витамины, БАДы и пищевые добавки", - "20099": "Контрацептивы и лубриканты", - "20100": "Товары для людей с ограниченными возможностями", - "20178": "Медицинские изделия и расходные материалы", - "20176": "Промышленное оборудование и материалы", - "20101": "Строительные материалы", - "20102": "Инструмент", - "20103": "Электрика", - "20104": "Сантехника и инженерные системы", - "20105": "Отделочные материалы", - "20106": "Сауны и бани", - "20107": "Для собак", - "20108": "Для кошек", - "20109": "Для грызунов", - "20110": "Для птиц", - "20111": "Для рыб и рептилий", - "20112": "Для лошадей", - "20113": "Для фермерского хозяйства", - "20183": "Витамины, БАДы и пищевые добавки", - "20114": "Автомобили", - "20115": "Водный транспорт", - "20116": "Мототехника", - "20117": "Прицепы и полуприцепы", - "20118": "Автобусы", - "20119": "Грузовики", - "20120": "Спецтехника", - "20121": "Авиационный транспорт", - "20122": "Запчасти", - "20123": "Оборудование и тюнинг", - "20124": "Шины и диски", - "20125": "Масла и автохимия", - "20126": "Автоэлектроника и GPS", - "20127": "Инструменты", - "20128": "Аудио и видео", - "20129": "Противоугонные устройства", - "20130": "Багажные системы", - "20131": "Автоаксессуары", - "20132": "Недвижимость за рубежом", - "20133": "Недвижимость в России", - "20134": "Зажигалки, спички и аксессуары", - "20135": "Пепельницы", - "20136": "Портсигары", - "20141": "Товары для БДСМ", - "20142": "Эротические сувениры и игры", - "20143": "Аксессуары для взрослых", - "20144": "Секс-игрушки", - "20145": "Эротическое белье и костюмы", - "20154": "Ластики", - "20168": "Печати и штампы", -... -``` diff --git a/docs/ru/md/VK/Product-management/Get-product-category-list.mdx b/docs/ru/md/VK/Product-management/Get-product-category-list.mdx new file mode 100644 index 0000000000..aae0532597 --- /dev/null +++ b/docs/ru/md/VK/Product-management/Get-product-category-list.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список категорий товаров + Получает список ID товарных категорий для указания при создании товара + + + +`Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из Строка - Ключ - ID, Значение - Имя + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Результат = OPI_VK.ПолучитьСписокКатегорийТоваров(Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСписокКатегорийТоваров --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСписокКатегорийТоваров ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "20000": "Женщинам", + "20001": "Мужчинам", + "20002": "Детям", + "20003": "Смартфоны и гаджеты", + "20004": "Квадрокоптеры и аксессуары", + "20005": "Планшеты и электронные книги", + "20006": "Умный дом и безопасность", + "20007": "ТВ, аудио и видео", + "20008": "Фото- и видеокамеры", + "20009": "Компьютеры и ноутбуки", + "20010": "Сетевое оборудование", + "20011": "Оргтехника и расходники", + "20012": "Навигаторы", + "20013": "Крупная бытовая техника", + "20014": "Малая бытовая техника для кухни", + "20015": "Техника для дома", + "20016": "Климатическая техника", + "20017": "Встраиваемая бытовая техника", + "20018": "Техника для красоты и здоровья", + "20019": "Хозяйственные товары", + "20020": "Посуда и товары для кухни", + "20021": "Товары для праздников", + "20022": "Аксесcуары для ванной и туалета", + "20023": "Домашний текстиль", + "20024": "Интерьер и декор", + "20025": "Освещение", + "20026": "Мебель", + "20027": "Дача и сад", + "20179": "Ритуальные товары", + "20177": "Гадания и эзотерика", + "20028": "Билеты и путешествия", + "20029": "Книги и журналы", + "20030": "Рукоделие и творчество", + "20031": "Настольные и карточные игры", + "20033": "Музыкальные инструменты", + "20034": "Коллекционирование", + "20035": "Подарочные сертификаты", + "20036": "Сувениры и цветы", + "20147": "Теннис и бадминтон", + "20148": "Дартс", + "20146": "Гольф", + "20037": "Тренажеры и фитнес", + "20038": "Спортивная одежда", + "20039": "Спортивная обувь", + "20040": "Зимний спорт", + "20041": "Командные виды спорта", + "20042": "Бокс и единоборства", + "20043": "Водный спорт", + "20044": "Художественная гимнастика", + "20045": "Велосипеды и аксессуары", + "20047": "Самокаты, скейтборды и ролики", + "20048": "Электротранспорт", + "20049": "Настольные спортивные игры", + "20050": "Спортивные комплексы", + "20051": "Охота и рыбалка", + "20052": "Туризм и отдых на природе", + "20053": "Чемоданы, сумки и рюкзаки", + "20054": "Спортивное питание", + "20055": "Бакалея", + "20056": "Мясо и птица", + "20057": "Рыба и морепродукты", + "20058": "Овощи, фрукты, зелень", + "20059": "Соленья", + "20060": "Молочные продукты и яйца", + "20061": "Мясные деликатесы", + "20062": "Детское питание", + "20063": "Еда на заказ", + "20064": "Напитки", + "20180": "Замороженные продукты", + "20065": "Автокресла", + "20066": "Детская комната", + "20067": "Коляски", + "20068": "Игрушки и игры", + "20069": "Подгузники и гигиена", + "20070": "Техника для мам и детей", + "20071": "Товары для кормления", + "20072": "Детское питание и кормление", + "20073": "Спорт и отдых", + "20074": "Хобби и творчество", + "20076": "Игровые приставки", + "20077": "Игровые ноутбуки", + "20078": "Игровые компьютеры", + "20079": "Игровые мониторы", + "20080": "Игры для ПК", + "20081": "Игровая периферия", + "20082": "Игровые столы", + "20083": "Компьютерные кресла", + "20085": "Игровая атрибутика", + "20086": "Макияж", + "20087": "Уход за лицом", + "20088": "Уход за телом", + "20089": "Защита от солнца и автозагар", + "20090": "Уход за волосами", + "20091": "Маникюр и педикюр", + "20092": "Мужская косметика", + "20093": "Парфюмерия", + "20094": "Ароматерапия", + "20095": "Средства гигиены", + "20096": "Контактные линзы, очки и аксессуары", + "20097": "Ортопедия, Компрессионный трикотаж", + "20098": "Витамины, БАДы и пищевые добавки", + "20099": "Контрацептивы и лубриканты", + "20100": "Товары для людей с ограниченными возможностями", + "20178": "Медицинские изделия и расходные материалы", + "20176": "Промышленное оборудование и материалы", + "20101": "Строительные материалы", + "20102": "Инструмент", + "20103": "Электрика", + "20104": "Сантехника и инженерные системы", + "20105": "Отделочные материалы", + "20106": "Сауны и бани", + "20107": "Для собак", + "20108": "Для кошек", + "20109": "Для грызунов", + "20110": "Для птиц", + "20111": "Для рыб и рептилий", + "20112": "Для лошадей", + "20113": "Для фермерского хозяйства", + "20183": "Витамины, БАДы и пищевые добавки", + "20114": "Автомобили", + "20115": "Водный транспорт", + "20116": "Мототехника", + "20117": "Прицепы и полуприцепы", + "20118": "Автобусы", + "20119": "Грузовики", + "20120": "Спецтехника", + "20121": "Авиационный транспорт", + "20122": "Запчасти", + "20123": "Оборудование и тюнинг", + "20124": "Шины и диски", + "20125": "Масла и автохимия", + "20126": "Автоэлектроника и GPS", + "20127": "Инструменты", + "20128": "Аудио и видео", + "20129": "Противоугонные устройства", + "20130": "Багажные системы", + "20131": "Автоаксессуары", + "20132": "Недвижимость за рубежом", + "20133": "Недвижимость в России", + "20134": "Зажигалки, спички и аксессуары", + "20135": "Пепельницы", + "20136": "Портсигары", + "20141": "Товары для БДСМ", + "20142": "Эротические сувениры и игры", + "20143": "Аксессуары для взрослых", + "20144": "Секс-игрушки", + "20145": "Эротическое белье и костюмы", + "20154": "Ластики", + "20168": "Печати и штампы", +... +``` diff --git a/docs/ru/md/VK/Product-management/Get-product-description.md b/docs/ru/md/VK/Product-management/Get-product-description.md deleted file mode 100644 index 8ea47cab76..0000000000 --- a/docs/ru/md/VK/Product-management/Get-product-description.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить описание товара - Получает шаблон описания для создания товара - - - -`Функция ПолучитьОписаниеТовара(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Соответствие полей - -
- - - - -```bsl title="Пример кода" - Результат = OPI_VK.ПолучитьОписаниеТовара(); -``` - - - - - - ```bash - oint vk ПолучитьОписаниеТовара --empty false - ``` - - - - ```batch - oint vk ПолучитьОписаниеТовара ^ - --empty false - ``` - - - - -```json title="Результат" -{ - "Имя": "Новый товар", - "Описание": "Описание товара", - "Категория": "20173", - "Цена": 1, - "СтараяЦена": null, - "ОсновноеФото": null, - "URL": null, - "ДополнительныеФото": [], - "ЗначенияСвойств": [], - "ГлавныйВГруппе": false, - "Ширина": null, - "Высота": null, - "Глубина": null, - "Вес": null, - "SKU": null, - "ДоступныйОстаток": 1 -} -``` diff --git a/docs/ru/md/VK/Product-management/Get-product-description.mdx b/docs/ru/md/VK/Product-management/Get-product-description.mdx new file mode 100644 index 0000000000..571b2d16f1 --- /dev/null +++ b/docs/ru/md/VK/Product-management/Get-product-description.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить описание товара + Получает шаблон описания для создания товара + + + +`Функция ПолучитьОписаниеТовара(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Соответствие полей + +
+ + + + +```bsl title="Пример кода" + Результат = OPI_VK.ПолучитьОписаниеТовара(); +``` + + + + + + ```bash + oint vk ПолучитьОписаниеТовара --empty false + ``` + + + + ```batch + oint vk ПолучитьОписаниеТовара ^ + --empty false + ``` + + + + +```json title="Результат" +{ + "Имя": "Новый товар", + "Описание": "Описание товара", + "Категория": "20173", + "Цена": 1, + "СтараяЦена": null, + "ОсновноеФото": null, + "URL": null, + "ДополнительныеФото": [], + "ЗначенияСвойств": [], + "ГлавныйВГруппе": false, + "Ширина": null, + "Высота": null, + "Глубина": null, + "Вес": null, + "SKU": null, + "ДоступныйОстаток": 1 +} +``` diff --git a/docs/ru/md/VK/Product-management/Get-product-list.md b/docs/ru/md/VK/Product-management/Get-product-list.md deleted file mode 100644 index e60a136617..0000000000 --- a/docs/ru/md/VK/Product-management/Get-product-list.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить список товаров - Получает список товаров сообщества - - - -`Функция ПолучитьСписокТоваров(Знач Подборка = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Подборка | --sel | Строка,Число | ID подборки, если нужен отбор | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий товаров - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Результат = OPI_VK.ПолучитьСписокТоваров(, Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСписокТоваров --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСписокТоваров ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -[ - { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "Батарейки", - "section": { - "id": 10016, - "name": "Канцелярские товары" - } - }, - "description": "Описание товара", - "id": 9642576, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (со свойством)", - "other_items": [ - { - "title": "Другие товары сообщества", - "view_type": 1, - "item_ids": [ - "-218861756_9640025", - "-218861756_9578921", - "-218861756_9499082", - "-218861756_9423489", - "-218861756_9387853", - "-218861756_9320009", - "-218861756_9320008", - "-218861756_9259547", - "-218861756_9259390", - "-218861756_9192466" - ], - "referrer_item_type": "other_goods" - } - ], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "weight": 100, - "albums_ids": [], - "photos": [], - "can_comment": 1, - "can_repost": 1, - "likes": { - "count": 0, - "user_likes": 0 - }, - "reposts": { - "count": 0 - }, - "views_count": 0, - "variants_grid": [], - "owner_info": { - "avatar": [], - "name": "Test", - "category": "Батарейки", - "category_url": "/market-218861756", - "is_corporated_market": false, - "market_type": "pro" - }, - "can_edit": true, - "can_delete": true, - "can_recover": false, - "can_show_convert_to_service": true, - "promotion": { - "is_available": true - }, - "labels": [], - "date": 1727611884, - "item_type": 0, - "is_owner": true, - "is_adult": false, - "thumb_photo": "", - "variants_grouping_id": 10666, - "cart_quantity": 0, - "sku": "12345", - "has_group_access": true, - "market_url": "https://vk.com/market/product/testovy-tovar-so-svoystvom-218861756-9642576" - }, - { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "Батарейки", - "section": { - "id": 10016, - "name": "Канцелярские товары" - } - }, - "description": "Описание товара", - "id": 9640025, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (другой)", - "other_items": [ - { - "title": "Другие товары сообщества", - "view_type": 1, - "item_ids": [ - "-218861756_9642576", - "-218861756_9578921", - "-218861756_9499082", - "-218861756_9423489", - "-218861756_9387853", - "-218861756_9320009", - "-218861756_9320008", - "-218861756_9259547", - "-218861756_9259390", - "-218861756_9192466" - ], - "referrer_item_type": "other_goods" - } - ], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "weight": 100, - "albums_ids": [], - "photos": [], - "can_comment": 1, - "can_repost": 1, - "likes": { -... -``` diff --git a/docs/ru/md/VK/Product-management/Get-product-list.mdx b/docs/ru/md/VK/Product-management/Get-product-list.mdx new file mode 100644 index 0000000000..2f70dc7cb9 --- /dev/null +++ b/docs/ru/md/VK/Product-management/Get-product-list.mdx @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить список товаров + Получает список товаров сообщества + + + +`Функция ПолучитьСписокТоваров(Знач Подборка = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборка | --sel | Строка,Число | ID подборки, если нужен отбор | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий товаров + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Результат = OPI_VK.ПолучитьСписокТоваров(, Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСписокТоваров --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСписокТоваров ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +[ + { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "Батарейки", + "section": { + "id": 10016, + "name": "Канцелярские товары" + } + }, + "description": "Описание товара", + "id": 9642576, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (со свойством)", + "other_items": [ + { + "title": "Другие товары сообщества", + "view_type": 1, + "item_ids": [ + "-218861756_9640025", + "-218861756_9578921", + "-218861756_9499082", + "-218861756_9423489", + "-218861756_9387853", + "-218861756_9320009", + "-218861756_9320008", + "-218861756_9259547", + "-218861756_9259390", + "-218861756_9192466" + ], + "referrer_item_type": "other_goods" + } + ], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "weight": 100, + "albums_ids": [], + "photos": [], + "can_comment": 1, + "can_repost": 1, + "likes": { + "count": 0, + "user_likes": 0 + }, + "reposts": { + "count": 0 + }, + "views_count": 0, + "variants_grid": [], + "owner_info": { + "avatar": [], + "name": "Test", + "category": "Батарейки", + "category_url": "/market-218861756", + "is_corporated_market": false, + "market_type": "pro" + }, + "can_edit": true, + "can_delete": true, + "can_recover": false, + "can_show_convert_to_service": true, + "promotion": { + "is_available": true + }, + "labels": [], + "date": 1727611884, + "item_type": 0, + "is_owner": true, + "is_adult": false, + "thumb_photo": "", + "variants_grouping_id": 10666, + "cart_quantity": 0, + "sku": "12345", + "has_group_access": true, + "market_url": "https://vk.com/market/product/testovy-tovar-so-svoystvom-218861756-9642576" + }, + { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "Батарейки", + "section": { + "id": 10016, + "name": "Канцелярские товары" + } + }, + "description": "Описание товара", + "id": 9640025, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (другой)", + "other_items": [ + { + "title": "Другие товары сообщества", + "view_type": 1, + "item_ids": [ + "-218861756_9642576", + "-218861756_9578921", + "-218861756_9499082", + "-218861756_9423489", + "-218861756_9387853", + "-218861756_9320009", + "-218861756_9320008", + "-218861756_9259547", + "-218861756_9259390", + "-218861756_9192466" + ], + "referrer_item_type": "other_goods" + } + ], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "weight": 100, + "albums_ids": [], + "photos": [], + "can_comment": 1, + "can_repost": 1, + "likes": { +... +``` diff --git a/docs/ru/md/VK/Product-management/Get-products-by-id.md b/docs/ru/md/VK/Product-management/Get-products-by-id.md deleted file mode 100644 index 8b65458235..0000000000 --- a/docs/ru/md/VK/Product-management/Get-products-by-id.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить товары по ID - Получает информацию о товарах по массиву ID - - - -`Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товары | --items | Строка, Массив Из Строка | Массив ID товаров | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар1 = "9755489"; - Товар2 = "9755490"; - - МассивТоваров = Новый Массив; - МассивТоваров.Добавить(Товар1); - МассивТоваров.Добавить(Товар2); - - Результат = OPI_VK.ПолучитьТоварыПоИД(МассивТоваров, Параметры); -``` - - - - - - ```bash - oint vk ПолучитьТоварыПоИД --items "[9774866,9774867]" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьТоварыПоИД ^ - --items "[9774866,9774867]" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "count": 2, - "items": [ - { - "availability": 0, - "category": { - "inner_type": "market_market_category_old", - "id": 20173, - "name": "Батарейки", - "section": { - "id": 10016, - "name": "Канцелярские товары" - } - }, - "description": "Описание товара", - "id": 9701912, - "owner_id": -218861756, - "price": { - "amount": "100", - "currency": { - "id": 643, - "name": "RUB", - "title": "₽" - }, - "text": "1 ₽", - "discount_rate": -93, - "old_amount": "1500", - "old_amount_text": "15 ₽" - }, - "title": "Тестовый товар (со свойством)", - "other_items": [ - { - "title": "Другие товары сообщества", - "view_type": 1, - "item_ids": [ - "-218861756_9701913", - "-218861756_9642576", - "-218861756_9640025", - "-218861756_9578921", - "-218861756_9499082", - "-218861756_9423489", - "-218861756_9387853", - "-218861756_9320009", - "-218861756_9320008", - "-218861756_9259547" - ], - "referrer_item_type": "other_goods" - } - ], - "dimensions": { - "width": 20, - "height": 30, - "length": 40 - }, - "weight": 100, - "albums_ids": [], - "photos": [ - { - "album_id": -53, - "date": 1728408833, - "id": 457249044, - "owner_id": -218861756, - "access_key": "6b98ff65fbb9629724", - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "bb41aafe2d14fa379c", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - }, - { - "album_id": -53, - "date": 1728408836, - "id": 457249045, - "owner_id": -218861756, - "access_key": "3e91c2fb9982c87fd8", - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/wNlTZzbmekuMKk5_qIRuNeQJZGF-dfJgjaVzEg8fikFpy7YPCw69icIfJo8l71a58aBnrkFeh7zTR_8Eg_hosZPh.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, -... -``` diff --git a/docs/ru/md/VK/Product-management/Get-products-by-id.mdx b/docs/ru/md/VK/Product-management/Get-products-by-id.mdx new file mode 100644 index 0000000000..0d017b8c2f --- /dev/null +++ b/docs/ru/md/VK/Product-management/Get-products-by-id.mdx @@ -0,0 +1,213 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить товары по ID + Получает информацию о товарах по массиву ID + + + +`Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товары | --items | Строка, Массив Из Строка | Массив ID товаров | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар1 = "9755489"; + Товар2 = "9755490"; + + МассивТоваров = Новый Массив; + МассивТоваров.Добавить(Товар1); + МассивТоваров.Добавить(Товар2); + + Результат = OPI_VK.ПолучитьТоварыПоИД(МассивТоваров, Параметры); +``` + + + + + + ```bash + oint vk ПолучитьТоварыПоИД --items "[9774866,9774867]" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьТоварыПоИД ^ + --items "[9774866,9774867]" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "count": 2, + "items": [ + { + "availability": 0, + "category": { + "inner_type": "market_market_category_old", + "id": 20173, + "name": "Батарейки", + "section": { + "id": 10016, + "name": "Канцелярские товары" + } + }, + "description": "Описание товара", + "id": 9701912, + "owner_id": -218861756, + "price": { + "amount": "100", + "currency": { + "id": 643, + "name": "RUB", + "title": "₽" + }, + "text": "1 ₽", + "discount_rate": -93, + "old_amount": "1500", + "old_amount_text": "15 ₽" + }, + "title": "Тестовый товар (со свойством)", + "other_items": [ + { + "title": "Другие товары сообщества", + "view_type": 1, + "item_ids": [ + "-218861756_9701913", + "-218861756_9642576", + "-218861756_9640025", + "-218861756_9578921", + "-218861756_9499082", + "-218861756_9423489", + "-218861756_9387853", + "-218861756_9320009", + "-218861756_9320008", + "-218861756_9259547" + ], + "referrer_item_type": "other_goods" + } + ], + "dimensions": { + "width": 20, + "height": 30, + "length": 40 + }, + "weight": 100, + "albums_ids": [], + "photos": [ + { + "album_id": -53, + "date": 1728408833, + "id": 457249044, + "owner_id": -218861756, + "access_key": "6b98ff65fbb9629724", + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "bb41aafe2d14fa379c", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-13.userapi.com/s/v1/ig2/m3zPn0sp5e4NvdAhepOXjrb79EUmvLXp8DcC3yo7UZgNMMi0beNuAxDbUnx84q4L7-l7ZoHhed7Hx_AE8ZFcnwQn.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + }, + { + "album_id": -53, + "date": 1728408836, + "id": 457249045, + "owner_id": -218861756, + "access_key": "3e91c2fb9982c87fd8", + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/wNlTZzbmekuMKk5_qIRuNeQJZGF-dfJgjaVzEg8fikFpy7YPCw69icIfJo8l71a58aBnrkFeh7zTR_8Eg_hosZPh.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, +... +``` diff --git a/docs/ru/md/VK/Product-management/Group-products.md b/docs/ru/md/VK/Product-management/Group-products.md deleted file mode 100644 index 7a506e0baa..0000000000 --- a/docs/ru/md/VK/Product-management/Group-products.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Сгруппировать товары - Группирует товары на основе одинаковых наборов свойств - - - -`Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивТоваров | --items | Массив Из Строка | Массив ID товаров | - | СуществующаяГруппа | --sellgroup | Строка | ID существующей группы, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар1 = "9755489"; - Товар2 = "9755490"; - - МассивТоваров = Новый Массив; - МассивТоваров.Добавить(Товар1); - МассивТоваров.Добавить(Товар2); - - Результат = OPI_VK.СгруппироватьТовары(МассивТоваров, , Параметры); -``` - - - - - - ```bash - oint vk СгруппироватьТовары --items "[9774866,9774867]" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СгруппироватьТовары ^ - --items "[9774866,9774867]" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "item_group_id": 11251 - } -} -``` diff --git a/docs/ru/md/VK/Product-management/Group-products.mdx b/docs/ru/md/VK/Product-management/Group-products.mdx new file mode 100644 index 0000000000..41f7ef40be --- /dev/null +++ b/docs/ru/md/VK/Product-management/Group-products.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Сгруппировать товары + Группирует товары на основе одинаковых наборов свойств + + + +`Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив Из Строка | Массив ID товаров | + | СуществующаяГруппа | --sellgroup | Строка | ID существующей группы, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар1 = "9755489"; + Товар2 = "9755490"; + + МассивТоваров = Новый Массив; + МассивТоваров.Добавить(Товар1); + МассивТоваров.Добавить(Товар2); + + Результат = OPI_VK.СгруппироватьТовары(МассивТоваров, , Параметры); +``` + + + + + + ```bash + oint vk СгруппироватьТовары --items "[9774866,9774867]" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СгруппироватьТовары ^ + --items "[9774866,9774867]" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "item_group_id": 11251 + } +} +``` diff --git a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md deleted file mode 100644 index b93bc65c55..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Добавить вариант свойства товара - Добавляет вариант для существующего свойства - - - -`Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Значение | --value | Строка | Значение свойства | - | Свойство | --prop | Строка,Число | ID свойства, куда добавляется вариант | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Свойство = "878"; - МассивВариантов = Новый Массив; - МассивВариантов.Добавить("Желтый"); - МассивВариантов.Добавить("Синий"); - МассивВариантов.Добавить("Красный"); - - Для Каждого Значение Из МассивВариантов Цикл - - Результат = OPI_VK.ДобавитьВариантСвойстваТовара(Значение, Свойство, Параметры); - - ПараметрыФункции.Вставить(ИмяПараметра, ИДВарианта); - КонецЦикла; -``` - - - - - - ```bash - oint vk ДобавитьВариантСвойстваТовара --value "Красный" \ - --prop "883" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ДобавитьВариантСвойстваТовара ^ - --value "Красный" ^ - --prop "883" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "variant_id": 2557 - } -} -``` diff --git a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.mdx b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.mdx new file mode 100644 index 0000000000..65f21ee4dc --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Добавить вариант свойства товара + Добавляет вариант для существующего свойства + + + +`Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Значение | --value | Строка | Значение свойства | + | Свойство | --prop | Строка,Число | ID свойства, куда добавляется вариант | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Свойство = "878"; + МассивВариантов = Новый Массив; + МассивВариантов.Добавить("Желтый"); + МассивВариантов.Добавить("Синий"); + МассивВариантов.Добавить("Красный"); + + Для Каждого Значение Из МассивВариантов Цикл + + Результат = OPI_VK.ДобавитьВариантСвойстваТовара(Значение, Свойство, Параметры); + + ПараметрыФункции.Вставить(ИмяПараметра, ИДВарианта); + КонецЦикла; +``` + + + + + + ```bash + oint vk ДобавитьВариантСвойстваТовара --value "Красный" \ + --prop "883" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ДобавитьВариантСвойстваТовара ^ + --value "Красный" ^ + --prop "883" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "variant_id": 2557 + } +} +``` diff --git a/docs/ru/md/VK/Product-properties-management/Create-product-property.md b/docs/ru/md/VK/Product-properties-management/Create-product-property.md deleted file mode 100644 index 8b2d0a96a8..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Create-product-property.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать свойство товара - Создает новое свойство для использования в товарах - - - -`Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Название свойства | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Название = "Цвет"; - - Результат = OPI_VK.СоздатьСвойствоТовара(Название, Параметры); -``` - - - - - - ```bash - oint vk СоздатьСвойствоТовара --title "Цвет" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьСвойствоТовара ^ - --title "Цвет" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "property_id": 853 - } -} -``` diff --git a/docs/ru/md/VK/Product-properties-management/Create-product-property.mdx b/docs/ru/md/VK/Product-properties-management/Create-product-property.mdx new file mode 100644 index 0000000000..7eb1bf894e --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Create-product-property.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать свойство товара + Создает новое свойство для использования в товарах + + + +`Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Название свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Название = "Цвет"; + + Результат = OPI_VK.СоздатьСвойствоТовара(Название, Параметры); +``` + + + + + + ```bash + oint vk СоздатьСвойствоТовара --title "Цвет" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьСвойствоТовара ^ + --title "Цвет" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "property_id": 853 + } +} +``` diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md deleted file mode 100644 index b13c74c53a..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Удалить вариант свойства товара - Удаляет ранее созданный вариант свойства - - - -`Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Вариант | --option | Строка,Число | ID варианта | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Вариант = "2601"; - - Результат = OPI_VK.УдалитьВариантСвойстваТовара(Вариант, Параметры); - - OPI_ПолучениеДанныхТестов.Проверка_ВКИстина(Результат); - - OPI_Инструменты.Пауза(5); -``` - - - - - - ```bash - oint vk УдалитьВариантСвойстваТовара --option 2616 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьВариантСвойстваТовара ^ - --option 2616 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.mdx b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.mdx new file mode 100644 index 0000000000..9ef550200c --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Удалить вариант свойства товара + Удаляет ранее созданный вариант свойства + + + +`Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Вариант | --option | Строка,Число | ID варианта | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Вариант = "2601"; + + Результат = OPI_VK.УдалитьВариантСвойстваТовара(Вариант, Параметры); + + OPI_ПолучениеДанныхТестов.Проверка_ВКИстина(Результат); + + OPI_Инструменты.Пауза(5); +``` + + + + + + ```bash + oint vk УдалитьВариантСвойстваТовара --option 2616 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьВариантСвойстваТовара ^ + --option 2616 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md b/docs/ru/md/VK/Product-properties-management/Delete-product-property.md deleted file mode 100644 index b3d9b9ad91..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить свойство товара - Удаляет существующее свойство товара - - - -`Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Свойство | --prop | Строка,Число | ID свойства | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Свойство = "878"; - - Результат = OPI_VK.УдалитьСвойствоТовара(Свойство, Параметры); -``` - - - - - - ```bash - oint vk УдалитьСвойствоТовара --prop "883" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьСвойствоТовара ^ - --prop "883" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 - } -``` diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property.mdx b/docs/ru/md/VK/Product-properties-management/Delete-product-property.mdx new file mode 100644 index 0000000000..0003ff2e46 --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить свойство товара + Удаляет существующее свойство товара + + + +`Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Свойство | --prop | Строка,Число | ID свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Свойство = "878"; + + Результат = OPI_VK.УдалитьСвойствоТовара(Свойство, Параметры); +``` + + + + + + ```bash + oint vk УдалитьСвойствоТовара --prop "883" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьСвойствоТовара ^ + --prop "883" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 + } +``` diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md deleted file mode 100644 index 0a2822772e..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Изменить вариант свойства товара - Изменяет значение варианта существующего свойства товара - - - -`Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Значение | --value | Строка | Новое значение свойства | - | Свойство | --prop | Строка,Число | ID свойства | - | Вариант | --option | Строка,Число | ID варианта | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Свойство = "878"; - Вариант = "2601"; - Значение = "Новое имя варианта"; - - Результат = OPI_VK.ИзменитьВариантСвойстваТовара(Значение - , Свойство - , Вариант - , Параметры); -``` - - - - - - ```bash - oint vk ИзменитьВариантСвойстваТовара --value "Новое имя варианта" \ - --prop "883" \ - --option 2616 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ИзменитьВариантСвойстваТовара ^ - --value "Новое имя варианта" ^ - --prop "883" ^ - --option 2616 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.mdx b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.mdx new file mode 100644 index 0000000000..6b9eb673b5 --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Изменить вариант свойства товара + Изменяет значение варианта существующего свойства товара + + + +`Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Значение | --value | Строка | Новое значение свойства | + | Свойство | --prop | Строка,Число | ID свойства | + | Вариант | --option | Строка,Число | ID варианта | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Свойство = "878"; + Вариант = "2601"; + Значение = "Новое имя варианта"; + + Результат = OPI_VK.ИзменитьВариантСвойстваТовара(Значение + , Свойство + , Вариант + , Параметры); +``` + + + + + + ```bash + oint vk ИзменитьВариантСвойстваТовара --value "Новое имя варианта" \ + --prop "883" \ + --option 2616 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ИзменитьВариантСвойстваТовара ^ + --value "Новое имя варианта" ^ + --prop "883" ^ + --option 2616 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md b/docs/ru/md/VK/Product-properties-management/Edit-product-property.md deleted file mode 100644 index 024ad32f4d..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Изменить свойство товара - Изменяет существующее свойство товара - - - -`Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Новое название | - | Свойство | --prop | Строка,Число | ID свойства | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Название = "Цвет (изм.)"; - Свойство = "878"; - - Результат = OPI_VK.ИзменитьСвойствоТовара(Название, Свойство, Параметры); -``` - - - - - - ```bash - oint vk ИзменитьСвойствоТовара --title "Цвет (изм.)" \ - --prop "883" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ИзменитьСвойствоТовара ^ - --title "Цвет (изм.)" ^ - --prop "883" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property.mdx b/docs/ru/md/VK/Product-properties-management/Edit-product-property.mdx new file mode 100644 index 0000000000..9e3d8f1048 --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Изменить свойство товара + Изменяет существующее свойство товара + + + +`Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Новое название | + | Свойство | --prop | Строка,Число | ID свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Название = "Цвет (изм.)"; + Свойство = "878"; + + Результат = OPI_VK.ИзменитьСвойствоТовара(Название, Свойство, Параметры); +``` + + + + + + ```bash + oint vk ИзменитьСвойствоТовара --title "Цвет (изм.)" \ + --prop "883" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ИзменитьСвойствоТовара ^ + --title "Цвет (изм.)" ^ + --prop "883" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-properties-management/Get-property-list.md b/docs/ru/md/VK/Product-properties-management/Get-property-list.md deleted file mode 100644 index 0ed921a3f4..0000000000 --- a/docs/ru/md/VK/Product-properties-management/Get-property-list.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список свойств - Получает список свойств товаров группы - - - -`Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Результат = OPI_VK.ПолучитьСписокСвойств(Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСписокСвойств --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСписокСвойств ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -[ - { - "id": 509, - "title": "Color (change.)", - "type": "text", - "variants": [ - { - "id": 1629, - "title": "Yellowf3f597d4-38bc-4a58-9506-01477ec7529d" - }, - { - "id": 1630, - "title": "Blue51f47ff4-81e6-4394-9b2a-acaf901f5946" - }, - { - "id": 1631, - "title": "Red00b87017-f2e8-427d-88ce-7ace6762d332" - } - ] - }, - { - "id": 549, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 1751, - "title": "Желтый494c9013-bdd8-415c-bd16-96330d63c08b" - }, - { - "id": 1752, - "title": "Синий9e94071e-9b75-4b14-9849-61a6bcdc2e8c" - }, - { - "id": 1753, - "title": "Красныйa015bcd7-1328-45c5-abab-a162a89dba95" - } - ] - }, - { - "id": 558, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 1778, - "title": "Новое имя варианта" - }, - { - "id": 1779, - "title": "Синий" - }, - { - "id": 1780, - "title": "Красный" - } - ] - }, - { - "id": 623, - "title": "Color (change.)", - "type": "text", - "variants": [ - { - "id": 1976, - "title": "New variant name" - }, - { - "id": 1977, - "title": "Blue" - }, - { - "id": 1978, - "title": "Red" - } - ] - }, - { - "id": 665, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2096, - "title": "Новое имя варианта" - }, - { - "id": 2097, - "title": "Синий" - }, - { - "id": 2098, - "title": "Красный" - } - ] - }, - { - "id": 779, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2378, - "title": "Новое имя варианта" - }, - { - "id": 2379, - "title": "Синий" - }, - { - "id": 2380, - "title": "Красный" - } - ] - }, - { - "id": 791, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2404, - "title": "Новое имя варианта" - }, - { - "id": 2405, - "title": "Синий" - }, - { - "id": 2406, - "title": "Красный" - } - ] - }, - { - "id": 844, - "title": "Цвет (изм.)", - "type": "text", - "variants": [ - { - "id": 2531, - "title": "Новое имя варианта" - }, - { - "id": 2532, - "title": "Синий" - }, - { - "id": 2533, - "title": "Красный" -... -``` diff --git a/docs/ru/md/VK/Product-properties-management/Get-property-list.mdx b/docs/ru/md/VK/Product-properties-management/Get-property-list.mdx new file mode 100644 index 0000000000..42dbe34725 --- /dev/null +++ b/docs/ru/md/VK/Product-properties-management/Get-property-list.mdx @@ -0,0 +1,202 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список свойств + Получает список свойств товаров группы + + + +`Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Результат = OPI_VK.ПолучитьСписокСвойств(Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСписокСвойств --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСписокСвойств ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +[ + { + "id": 509, + "title": "Color (change.)", + "type": "text", + "variants": [ + { + "id": 1629, + "title": "Yellowf3f597d4-38bc-4a58-9506-01477ec7529d" + }, + { + "id": 1630, + "title": "Blue51f47ff4-81e6-4394-9b2a-acaf901f5946" + }, + { + "id": 1631, + "title": "Red00b87017-f2e8-427d-88ce-7ace6762d332" + } + ] + }, + { + "id": 549, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 1751, + "title": "Желтый494c9013-bdd8-415c-bd16-96330d63c08b" + }, + { + "id": 1752, + "title": "Синий9e94071e-9b75-4b14-9849-61a6bcdc2e8c" + }, + { + "id": 1753, + "title": "Красныйa015bcd7-1328-45c5-abab-a162a89dba95" + } + ] + }, + { + "id": 558, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 1778, + "title": "Новое имя варианта" + }, + { + "id": 1779, + "title": "Синий" + }, + { + "id": 1780, + "title": "Красный" + } + ] + }, + { + "id": 623, + "title": "Color (change.)", + "type": "text", + "variants": [ + { + "id": 1976, + "title": "New variant name" + }, + { + "id": 1977, + "title": "Blue" + }, + { + "id": 1978, + "title": "Red" + } + ] + }, + { + "id": 665, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2096, + "title": "Новое имя варианта" + }, + { + "id": 2097, + "title": "Синий" + }, + { + "id": 2098, + "title": "Красный" + } + ] + }, + { + "id": 779, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2378, + "title": "Новое имя варианта" + }, + { + "id": 2379, + "title": "Синий" + }, + { + "id": 2380, + "title": "Красный" + } + ] + }, + { + "id": 791, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2404, + "title": "Новое имя варианта" + }, + { + "id": 2405, + "title": "Синий" + }, + { + "id": 2406, + "title": "Красный" + } + ] + }, + { + "id": 844, + "title": "Цвет (изм.)", + "type": "text", + "variants": [ + { + "id": 2531, + "title": "Новое имя варианта" + }, + { + "id": 2532, + "title": "Синий" + }, + { + "id": 2533, + "title": "Красный" +... +``` diff --git a/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md b/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md deleted file mode 100644 index c8310be1d9..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Добавить товар в подборку - Добавляет товар в подборку - - - -`Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар = "9756133"; - Подборка = "130"; - - Результат = OPI_VK.ДобавитьТоварВПодборку(Товар, Подборка, Параметры); -``` - - - - - - ```bash - oint vk ДобавитьТоварВПодборку --sel 130 \ - --items 9774863 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ДобавитьТоварВПодборку ^ - --sel 130 ^ - --items 9774863 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.mdx b/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.mdx new file mode 100644 index 0000000000..884ec4deaf --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Добавить товар в подборку + Добавляет товар в подборку + + + +`Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар = "9756133"; + Подборка = "130"; + + Результат = OPI_VK.ДобавитьТоварВПодборку(Товар, Подборка, Параметры); +``` + + + + + + ```bash + oint vk ДобавитьТоварВПодборку --sel 130 \ + --items 9774863 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ДобавитьТоварВПодборку ^ + --sel 130 ^ + --items 9774863 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-selection-management/Create-product-collection.md b/docs/ru/md/VK/Product-selection-management/Create-product-collection.md deleted file mode 100644 index 6775b9ddac..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Create-product-collection.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Создать подборку товаров - Создает пустую подборку товаров - - - -`Функция СоздатьПодборкуТоваров(Знач Название, Знач Картинка, Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Название подборки | - | Картинка | --picture | Строка,ДвоичныеДанные | Файл картинки | - | Основная | --main | Булево | Основная | - | Скрытая | --hidden | Булево | Скрытая | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Название = "Тестовая подборка"; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; - Основная = Истина; - Скрытая = Ложь; - - Результат = OPI_VK.СоздатьПодборкуТоваров(Название - , Картинка - , Основная - , Скрытая - , Параметры); -``` - - - - - - ```bash - oint vk СоздатьПодборкуТоваров --title "Тестовая подборка" \ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --main true \ - --hidden false \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk СоздатьПодборкуТоваров ^ - --title "Тестовая подборка" ^ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --main true ^ - --hidden false ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "market_album_id": 125, - "albums_count": 66 - } -} -``` diff --git a/docs/ru/md/VK/Product-selection-management/Create-product-collection.mdx b/docs/ru/md/VK/Product-selection-management/Create-product-collection.mdx new file mode 100644 index 0000000000..89493f1e0b --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Create-product-collection.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Создать подборку товаров + Создает пустую подборку товаров + + + +`Функция СоздатьПодборкуТоваров(Знач Название, Знач Картинка, Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Название подборки | + | Картинка | --picture | Строка,ДвоичныеДанные | Файл картинки | + | Основная | --main | Булево | Основная | + | Скрытая | --hidden | Булево | Скрытая | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Название = "Тестовая подборка"; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; + Основная = Истина; + Скрытая = Ложь; + + Результат = OPI_VK.СоздатьПодборкуТоваров(Название + , Картинка + , Основная + , Скрытая + , Параметры); +``` + + + + + + ```bash + oint vk СоздатьПодборкуТоваров --title "Тестовая подборка" \ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --main true \ + --hidden false \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk СоздатьПодборкуТоваров ^ + --title "Тестовая подборка" ^ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --main true ^ + --hidden false ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "market_album_id": 125, + "albums_count": 66 + } +} +``` diff --git a/docs/ru/md/VK/Product-selection-management/Delete-selection.md b/docs/ru/md/VK/Product-selection-management/Delete-selection.md deleted file mode 100644 index 79a35681ac..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Delete-selection.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Удалить подборку - Удаляет подборку по ID - - - -`Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Подборка = "130"; - - Результат = OPI_VK.УдалитьПодборку(Подборка, Параметры); -``` - - - - - - ```bash - oint vk УдалитьПодборку --sel 130 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьПодборку ^ - --sel 130 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-selection-management/Delete-selection.mdx b/docs/ru/md/VK/Product-selection-management/Delete-selection.mdx new file mode 100644 index 0000000000..c3a1bd64f6 --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Delete-selection.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Удалить подборку + Удаляет подборку по ID + + + +`Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Подборка = "130"; + + Результат = OPI_VK.УдалитьПодборку(Подборка, Параметры); +``` + + + + + + ```bash + oint vk УдалитьПодборку --sel 130 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьПодборку ^ + --sel 130 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md b/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md deleted file mode 100644 index a59ee5ca66..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Изменить подборку товаров - Изменяет свойства подборки товаров - - - -`Функция ИзменитьПодборкуТоваров(Знач Название, Знач Подборка, Знач Картинка = "", Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Новое название подборки | - | Подборка | --sel | Строка | ID подборки | - | Картинка | --picture | Строка,ДвоичныеДанные | Новая картинка подборки | - | Основная | --main | Булево | Основная | - | Скрытая | --hidden | Булево | Скрытая | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Название = "Измененная подборка"; - Подборка = "130"; - - Результат = OPI_VK.ИзменитьПодборкуТоваров(Название, Подборка, , , , Параметры); - - OPI_ПолучениеДанныхТестов.Проверка_ВКИстина(Результат); - - OPI_Инструменты.Пауза(5); -``` - - - - - - ```bash - oint vk ИзменитьПодборкуТоваров --title "Измененная подборка" \ - --sel 130 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ИзменитьПодборкуТоваров ^ - --title "Измененная подборка" ^ - --sel 130 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-selection-management/Edit-product-collection.mdx b/docs/ru/md/VK/Product-selection-management/Edit-product-collection.mdx new file mode 100644 index 0000000000..1d4611b7fc --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Edit-product-collection.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Изменить подборку товаров + Изменяет свойства подборки товаров + + + +`Функция ИзменитьПодборкуТоваров(Знач Название, Знач Подборка, Знач Картинка = "", Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Новое название подборки | + | Подборка | --sel | Строка | ID подборки | + | Картинка | --picture | Строка,ДвоичныеДанные | Новая картинка подборки | + | Основная | --main | Булево | Основная | + | Скрытая | --hidden | Булево | Скрытая | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Название = "Измененная подборка"; + Подборка = "130"; + + Результат = OPI_VK.ИзменитьПодборкуТоваров(Название, Подборка, , , , Параметры); + + OPI_ПолучениеДанныхТестов.Проверка_ВКИстина(Результат); + + OPI_Инструменты.Пауза(5); +``` + + + + + + ```bash + oint vk ИзменитьПодборкуТоваров --title "Измененная подборка" \ + --sel 130 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ИзменитьПодборкуТоваров ^ + --title "Измененная подборка" ^ + --sel 130 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Product-selection-management/Get-selection-list.md b/docs/ru/md/VK/Product-selection-management/Get-selection-list.md deleted file mode 100644 index 095934a756..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Get-selection-list.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить список подборок - Получает список подборок товаров - - - -`Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий подборок - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Результат = OPI_VK.ПолучитьСписокПодборок(Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСписокПодборок --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСписокПодборок ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -[ - { - "id": 124, - "owner_id": -218861756, - "title": "Измененная подборка", - "count": 0, - "updated_time": 1728135129, - "is_main": false, - "is_hidden": false, - "photo": { - "album_id": -53, - "date": 1728135128, - "id": 457248915, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "e3c04e952b4aa2407b", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - } - }, - { - "id": 123, - "owner_id": -218861756, - "title": "Измененная подборка", - "count": 0, - "updated_time": 1728133931, - "is_main": false, - "is_hidden": false, - "photo": { - "album_id": -53, - "date": 1728133931, - "id": 457248908, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, -... -``` diff --git a/docs/ru/md/VK/Product-selection-management/Get-selection-list.mdx b/docs/ru/md/VK/Product-selection-management/Get-selection-list.mdx new file mode 100644 index 0000000000..23d1416b9e --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Get-selection-list.mdx @@ -0,0 +1,202 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить список подборок + Получает список подборок товаров + + + +`Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий подборок + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Результат = OPI_VK.ПолучитьСписокПодборок(Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСписокПодборок --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСписокПодборок ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +[ + { + "id": 124, + "owner_id": -218861756, + "title": "Измененная подборка", + "count": 0, + "updated_time": 1728135129, + "is_main": false, + "is_hidden": false, + "photo": { + "album_id": -53, + "date": 1728135128, + "id": 457248915, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "e3c04e952b4aa2407b", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-13.userapi.com/s/v1/ig2/9pOuUL0wmxDt9Z98Fq7pKoyDY6-cYLR22vaqQcLae3PvMvhK2H9cf_GrPQofPFW0MFRAZ9w855LeqfQhn98AIkpo.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + } + }, + { + "id": 123, + "owner_id": -218861756, + "title": "Измененная подборка", + "count": 0, + "updated_time": 1728133931, + "is_main": false, + "is_hidden": false, + "photo": { + "album_id": -53, + "date": 1728133931, + "id": 457248908, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/lHkvvHEaksUett4rixE53mBr9nZvxyMyOaieoiH7U8awGKPcSdNRJ6Fchg8168HpCIls9iyr52PaKhswR7yEwsj-.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, +... +``` diff --git a/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md b/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md deleted file mode 100644 index 7d198b5bf0..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить подборки по ID - Получить список подборок по массиву ID - - - -`Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Подборки | --sels | Строка, Массив Из Строка | ID подборок | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - Подборка = "130"; - - Результат = OPI_VK.ПолучитьПодборкиПоИД(Подборка, Параметры); -``` - - - - - - ```bash - oint vk ПолучитьПодборкиПоИД --sels 130 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьПодборкиПоИД ^ - --sels 130 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": { - "count": 1, - "items": [ - { - "id": 125, - "owner_id": -218861756, - "title": "Измененная подборка", - "count": 0, - "updated_time": 1728408758, - "is_main": false, - "is_hidden": false, - "photo": { - "album_id": -53, - "date": 1728408758, - "id": 457249040, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "73e74ae8033fe029e5", - "has_tags": false, - "orig_photo": { - "height": 1920, - "type": "base", - "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", - "width": 2560 - } - } - } - ] - } -} -``` diff --git a/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.mdx b/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.mdx new file mode 100644 index 0000000000..bcbcc48201 --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.mdx @@ -0,0 +1,150 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить подборки по ID + Получить список подборок по массиву ID + + + +`Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборки | --sels | Строка, Массив Из Строка | ID подборок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + Подборка = "130"; + + Результат = OPI_VK.ПолучитьПодборкиПоИД(Подборка, Параметры); +``` + + + + + + ```bash + oint vk ПолучитьПодборкиПоИД --sels 130 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьПодборкиПоИД ^ + --sels 130 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": { + "count": 1, + "items": [ + { + "id": 125, + "owner_id": -218861756, + "title": "Измененная подборка", + "count": 0, + "updated_time": 1728408758, + "is_main": false, + "is_hidden": false, + "photo": { + "album_id": -53, + "date": 1728408758, + "id": 457249040, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=75x56" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=604x453" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=807x605" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=1280x960" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=2560x1920" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=130x97" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=200x150" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=320x240" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu&cs=510x382" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "73e74ae8033fe029e5", + "has_tags": false, + "orig_photo": { + "height": 1920, + "type": "base", + "url": "https://sun9-13.userapi.com/s/v1/ig2/OAULCF77hqA8m3ZGbkMwJkiplTKTcBAsMu3Qv9lVZZHml4_G0e9Xd6JigmhItI8BD33CrYtPmb8nXQIASWhc4_oW.jpg?quality=95&as=32x24,48x36,72x54,108x81,160x120,240x180,360x270,480x360,540x405,640x480,720x540,1080x810,1280x960,1440x1080,2560x1920&from=bu", + "width": 2560 + } + } + } + ] + } +} +``` diff --git a/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md b/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md deleted file mode 100644 index 25d000a6a6..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Удалить товар из подборки - Удаляет ранее добавленный товар из подборки - - - -`Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товар | --item | Строка | ID товара | - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар = "9756133"; - Подборка = "130"; - - Результат = OPI_VK.УдалитьТоварИзПодборки(Товар, Подборка, Параметры); -``` - - - - - - ```bash - oint vk УдалитьТоварИзПодборки --sel 130 \ - --item 9774863 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk УдалитьТоварИзПодборки ^ - --sel 130 ^ - --item 9774863 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": 1 -} -``` diff --git a/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.mdx b/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.mdx new file mode 100644 index 0000000000..54d5fea98a --- /dev/null +++ b/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.mdx @@ -0,0 +1,64 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Удалить товар из подборки + Удаляет ранее добавленный товар из подборки + + + +`Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Строка | ID товара | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар = "9756133"; + Подборка = "130"; + + Результат = OPI_VK.УдалитьТоварИзПодборки(Товар, Подборка, Параметры); +``` + + + + + + ```bash + oint vk УдалитьТоварИзПодборки --sel 130 \ + --item 9774863 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk УдалитьТоварИзПодборки ^ + --sel 130 ^ + --item 9774863 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": 1 +} +``` diff --git a/docs/ru/md/VK/Statistics/Get-post-statistics.md b/docs/ru/md/VK/Statistics/Get-post-statistics.md deleted file mode 100644 index c273f5d8c0..0000000000 --- a/docs/ru/md/VK/Statistics/Get-post-statistics.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить статистику по постам - Получает статистику в разрезе постов - - - -`Функция ПолучитьСтатистикуПостов(Знач МассивИДПостов, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивИДПостов | --posts | Массив из Строка,Число | Массив ID постов | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Массив из Произвольный - Массив данных статистики по постам - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - МассивПостов = Новый Массив; - МассивПостов.Добавить(214); - МассивПостов.Добавить(215); - - Результат = OPI_VK.ПолучитьСтатистикуПостов(МассивПостов, Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСтатистикуПостов --posts "[214,215]" \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСтатистикуПостов ^ - --posts "[214,215]" ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -[ - { - "post_id": 214, - "hide": 0, - "join_group": 0, - "links": 0, - "reach_subscribers": 1, - "reach_total": 1, - "reach_viral": 0, - "reach_ads": 0, - "report": 0, - "to_group": 1, - "unsubscribe": 0, - "ad_views": 0, - "ad_subscribers": 0, - "ad_hide": 0, - "ad_unsubscribe": 0, - "ad_links": 0, - "ad_to_group": 0, - "ad_join_group": 0, - "ad_coverage": 0, - "ad_report": 0 - }, - { - "post_id": 215, - "hide": 0, - "join_group": 0, - "links": 0, - "reach_subscribers": 1, - "reach_total": 1, - "reach_viral": 0, - "reach_ads": 0, - "report": 0, - "to_group": 0, - "unsubscribe": 0, - "ad_views": 0, - "ad_subscribers": 0, - "ad_hide": 0, - "ad_unsubscribe": 0, - "ad_links": 0, - "ad_to_group": 0, - "ad_join_group": 0, - "ad_coverage": 0, - "ad_report": 0 - } -] -``` diff --git a/docs/ru/md/VK/Statistics/Get-post-statistics.mdx b/docs/ru/md/VK/Statistics/Get-post-statistics.mdx new file mode 100644 index 0000000000..e598ac81a6 --- /dev/null +++ b/docs/ru/md/VK/Statistics/Get-post-statistics.mdx @@ -0,0 +1,105 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить статистику по постам + Получает статистику в разрезе постов + + + +`Функция ПолучитьСтатистикуПостов(Знач МассивИДПостов, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивИДПостов | --posts | Массив из Строка,Число | Массив ID постов | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Массив из Произвольный - Массив данных статистики по постам + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + МассивПостов = Новый Массив; + МассивПостов.Добавить(214); + МассивПостов.Добавить(215); + + Результат = OPI_VK.ПолучитьСтатистикуПостов(МассивПостов, Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСтатистикуПостов --posts "[214,215]" \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСтатистикуПостов ^ + --posts "[214,215]" ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +[ + { + "post_id": 214, + "hide": 0, + "join_group": 0, + "links": 0, + "reach_subscribers": 1, + "reach_total": 1, + "reach_viral": 0, + "reach_ads": 0, + "report": 0, + "to_group": 1, + "unsubscribe": 0, + "ad_views": 0, + "ad_subscribers": 0, + "ad_hide": 0, + "ad_unsubscribe": 0, + "ad_links": 0, + "ad_to_group": 0, + "ad_join_group": 0, + "ad_coverage": 0, + "ad_report": 0 + }, + { + "post_id": 215, + "hide": 0, + "join_group": 0, + "links": 0, + "reach_subscribers": 1, + "reach_total": 1, + "reach_viral": 0, + "reach_ads": 0, + "report": 0, + "to_group": 0, + "unsubscribe": 0, + "ad_views": 0, + "ad_subscribers": 0, + "ad_hide": 0, + "ad_unsubscribe": 0, + "ad_links": 0, + "ad_to_group": 0, + "ad_join_group": 0, + "ad_coverage": 0, + "ad_report": 0 + } +] +``` diff --git a/docs/ru/md/VK/Statistics/Get-statistics.md b/docs/ru/md/VK/Statistics/Get-statistics.md deleted file mode 100644 index 3730dc376a..0000000000 --- a/docs/ru/md/VK/Statistics/Get-statistics.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить статистику - Получает общую статистику сообщества за период - - - -`Функция ПолучитьСтатистику(Знач ДатаНачала, Знач ДатаОкончания, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | ДатаНачала | --datefrom | Дата | Дата начала периода | - | ДатаОкончания | --dateto | Дата | Дата окончания периода | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); - ДатаНачала = НачалоДня(ТекущаяДата); - ДатаОкончания = КонецДня(ДатаНачала); - - Результат = OPI_VK.ПолучитьСтатистику(ДатаНачала, ДатаОкончания, Параметры); -``` - - - - - - ```bash - oint vk ПолучитьСтатистику --datefrom 2024-10-15T00:00:00 \ - --dateto 2024-10-15T23:59:59 \ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - ```batch - oint vk ПолучитьСтатистику ^ - --datefrom 2024-10-15T00:00:00 ^ - --dateto 2024-10-15T23:59:59 ^ - --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" - ``` - - - - -```json title="Результат" -{ - "response": [ - { - "activity": { - "comments": 1, - "likes": 1 - }, - "period_from": 1728345600, - "period_to": 1728431999, - "reach": { - "age": [ - { - "value": "12-18", - "count": 0 - }, - { - "value": "18-21", - "count": 0 - }, - { - "value": "21-24", - "count": 1 - }, - { - "value": "24-27", - "count": 0 - }, - { - "value": "27-30", - "count": 0 - }, - { - "value": "30-35", - "count": 0 - }, - { - "value": "35-45", - "count": 0 - }, - { - "value": "45-100", - "count": 0 - } - ], - "cities": [], - "countries": [ - { - "code": "BY", - "count": 1, - "name": "Беларусь", - "value": 3 - } - ], - "mobile_reach": 1, - "reach": 1, - "reach_subscribers": 1, - "sex": [ - { - "value": "f", - "count": 0 - }, - { - "value": "m", - "count": 1 - } - ], - "sex_age": [ - { - "value": "f;12-18", - "count": 0 - }, - { - "value": "f;18-21", - "count": 0 - }, - { - "value": "f;21-24", - "count": 0 - }, - { - "value": "f;24-27", - "count": 0 - }, - { - "value": "f;27-30", - "count": 0 - }, - { - "value": "f;30-35", - "count": 0 - }, - { - "value": "f;35-45", - "count": 0 - }, - { - "value": "f;45-100", - "count": 0 - }, - { - "value": "m;12-18", - "count": 0 - }, - { - "value": "m;18-21", - "count": 0 - }, - { - "value": "m;21-24", - "count": 1 - }, - { - "value": "m;24-27", - "count": 0 - }, - { - "value": "m;27-30", - "count": 0 - }, - { - "value": "m;30-35", - "count": 0 - }, - { - "value": "m;35-45", - "count": 0 - }, - { - "value": "m;45-100", - "count": 0 - } - ] - }, - "visitors": { - "cities": [], - "countries": [ - { - "code": "RU", - "count": 1, - "name": "Россия", - "value": 1 - }, - { - "code": "SC", - "count": 1, - "name": "Сейшелы", - "value": 175 - } - ], - "mobile_views": 0, -... -``` diff --git a/docs/ru/md/VK/Statistics/Get-statistics.mdx b/docs/ru/md/VK/Statistics/Get-statistics.mdx new file mode 100644 index 0000000000..6b4071eb65 --- /dev/null +++ b/docs/ru/md/VK/Statistics/Get-statistics.mdx @@ -0,0 +1,213 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить статистику + Получает общую статистику сообщества за период + + + +`Функция ПолучитьСтатистику(Знач ДатаНачала, Знач ДатаОкончания, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ДатаНачала | --datefrom | Дата | Дата начала периода | + | ДатаОкончания | --dateto | Дата | Дата окончания периода | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + ДатаНачала = НачалоДня(ТекущаяДата); + ДатаОкончания = КонецДня(ДатаНачала); + + Результат = OPI_VK.ПолучитьСтатистику(ДатаНачала, ДатаОкончания, Параметры); +``` + + + + + + ```bash + oint vk ПолучитьСтатистику --datefrom 2024-10-15T00:00:00 \ + --dateto 2024-10-15T23:59:59 \ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + ```batch + oint vk ПолучитьСтатистику ^ + --datefrom 2024-10-15T00:00:00 ^ + --dateto 2024-10-15T23:59:59 ^ + --auth "{'access_token':'***','owner_id':'-218861756','app_id':'51694790','group_id':'218861756'}" + ``` + + + + +```json title="Результат" +{ + "response": [ + { + "activity": { + "comments": 1, + "likes": 1 + }, + "period_from": 1728345600, + "period_to": 1728431999, + "reach": { + "age": [ + { + "value": "12-18", + "count": 0 + }, + { + "value": "18-21", + "count": 0 + }, + { + "value": "21-24", + "count": 1 + }, + { + "value": "24-27", + "count": 0 + }, + { + "value": "27-30", + "count": 0 + }, + { + "value": "30-35", + "count": 0 + }, + { + "value": "35-45", + "count": 0 + }, + { + "value": "45-100", + "count": 0 + } + ], + "cities": [], + "countries": [ + { + "code": "BY", + "count": 1, + "name": "Беларусь", + "value": 3 + } + ], + "mobile_reach": 1, + "reach": 1, + "reach_subscribers": 1, + "sex": [ + { + "value": "f", + "count": 0 + }, + { + "value": "m", + "count": 1 + } + ], + "sex_age": [ + { + "value": "f;12-18", + "count": 0 + }, + { + "value": "f;18-21", + "count": 0 + }, + { + "value": "f;21-24", + "count": 0 + }, + { + "value": "f;24-27", + "count": 0 + }, + { + "value": "f;27-30", + "count": 0 + }, + { + "value": "f;30-35", + "count": 0 + }, + { + "value": "f;35-45", + "count": 0 + }, + { + "value": "f;45-100", + "count": 0 + }, + { + "value": "m;12-18", + "count": 0 + }, + { + "value": "m;18-21", + "count": 0 + }, + { + "value": "m;21-24", + "count": 1 + }, + { + "value": "m;24-27", + "count": 0 + }, + { + "value": "m;27-30", + "count": 0 + }, + { + "value": "m;30-35", + "count": 0 + }, + { + "value": "m;35-45", + "count": 0 + }, + { + "value": "m;45-100", + "count": 0 + } + ] + }, + "visitors": { + "cities": [], + "countries": [ + { + "code": "RU", + "count": 1, + "name": "Россия", + "value": 1 + }, + { + "code": "SC", + "count": 1, + "name": "Сейшелы", + "value": 175 + } + ], + "mobile_views": 0, +... +``` diff --git a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md deleted file mode 100644 index 43ec9586b5..0000000000 --- a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Создать ссылку получения токена -Получение ссылки для интерактивного получения токена (access_token), который необходим для дальнейших действий - - - -`Функция СоздатьСсылкуПолученияТокена(Знач App_id) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | app_id | --app | Строка,Число | app_id из настроек приложения | - - - Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере - -
- - - - -```bsl title="Пример кода" - Приложение = "51694790"; - Результат = OPI_VK.СоздатьСсылкуПолученияТокена(Приложение); -``` - - - - - - ```bash - oint vk СоздатьСсылкуПолученияТокена --app "51694790" - ``` - - - - ```batch - oint vk СоздатьСсылкуПолученияТокена ^ - --app "51694790" - ``` - - - - -```json title="Результат" -"https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" -``` diff --git a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.mdx b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.mdx new file mode 100644 index 0000000000..174004aa9a --- /dev/null +++ b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.mdx @@ -0,0 +1,52 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Создать ссылку получения токена +Получение ссылки для интерактивного получения токена (access_token), который необходим для дальнейших действий + + + +`Функция СоздатьСсылкуПолученияТокена(Знач App_id) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | app_id | --app | Строка,Число | app_id из настроек приложения | + + + Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере + +
+ + + + +```bsl title="Пример кода" + Приложение = "51694790"; + Результат = OPI_VK.СоздатьСсылкуПолученияТокена(Приложение); +``` + + + + + + ```bash + oint vk СоздатьСсылкуПолученияТокена --app "51694790" + ``` + + + + ```batch + oint vk СоздатьСсылкуПолученияТокена ^ + --app "51694790" + ``` + + + + +```json title="Результат" +"https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Approve-pending.md b/docs/ru/md/VKTeams/Chat-management/Approve-pending.md deleted file mode 100644 index 049975ee43..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Approve-pending.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Одобрить заявку на вступление - Подтверждает вступление пользователя в закрытый чат - - - -`Функция ОдобритьЗаявкуНаВступление(Знач Токен, Знач IDЧата, Знач IDПользователя = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | IDПользователя | --userid | Строка, Число | ID пользователя. Ответ на все заявки, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Пользователь = 1011987091; - - Результат = OPI_VKTeams.ОдобритьЗаявкуНаВступление(Токен, IDЧата, Пользователь); - - Результат = OPI_VKTeams.ОдобритьЗаявкуНаВступление(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ОдобритьЗаявкуНаВступление --token "***" \ - --chatid "689203963@chat.agent" - ``` - - - - ```batch - oint vkteams ОдобритьЗаявкуНаВступление ^ - --token "***" ^ - --chatid "689203963@chat.agent" - ``` - - - - -```json title="Результат" -{ - "ok": false, - "description": "User is not pending or nobody in pending list" -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Approve-pending.mdx b/docs/ru/md/VKTeams/Chat-management/Approve-pending.mdx new file mode 100644 index 0000000000..0bc490789d --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Approve-pending.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Одобрить заявку на вступление + Подтверждает вступление пользователя в закрытый чат + + + +`Функция ОдобритьЗаявкуНаВступление(Знач Токен, Знач IDЧата, Знач IDПользователя = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | IDПользователя | --userid | Строка, Число | ID пользователя. Ответ на все заявки, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Пользователь = 1011987091; + + Результат = OPI_VKTeams.ОдобритьЗаявкуНаВступление(Токен, IDЧата, Пользователь); + + Результат = OPI_VKTeams.ОдобритьЗаявкуНаВступление(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ОдобритьЗаявкуНаВступление --token "***" \ + --chatid "689203963@chat.agent" + ``` + + + + ```batch + oint vkteams ОдобритьЗаявкуНаВступление ^ + --token "***" ^ + --chatid "689203963@chat.agent" + ``` + + + + +```json title="Результат" +{ + "ok": false, + "description": "User is not pending or nobody in pending list" +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Block-chat-user.md b/docs/ru/md/VKTeams/Chat-management/Block-chat-user.md deleted file mode 100644 index edd7ee87ca..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Block-chat-user.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Заблокировать пользователя чата - Блокирует выбранного пользователя в чате - - - -`Функция ЗаблокироватьПользователяЧата(Знач Токен, Знач IDЧата, Знач IDПользователя, Знач УдалитьПоследниеСообщения = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | IDПользователя | --userid | Строка, Число | ID пользователя для блокировки | - | УдалитьПоследниеСообщения | --dellast | Булево | Удалить последние сообщения перед блокировкой | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats​/blockUser](https://teams.vk.com/botapi/#/chats/get_chats_blockUser) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Пользователь = 1011987091; - - Результат = OPI_VKTeams.ЗаблокироватьПользователяЧата(Токен, IDЧата, Пользователь, Истина); -``` - - - - - - ```bash - oint vkteams ЗаблокироватьПользователяЧата --token "***" \ - --chatid "689203963@chat.agent" \ - --userid 1011987091 \ - --dellast true - ``` - - - - ```batch - oint vkteams ЗаблокироватьПользователяЧата ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --userid 1011987091 ^ - --dellast true - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Block-chat-user.mdx b/docs/ru/md/VKTeams/Chat-management/Block-chat-user.mdx new file mode 100644 index 0000000000..c9ca560127 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Block-chat-user.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Заблокировать пользователя чата + Блокирует выбранного пользователя в чате + + + +`Функция ЗаблокироватьПользователяЧата(Знач Токен, Знач IDЧата, Знач IDПользователя, Знач УдалитьПоследниеСообщения = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | IDПользователя | --userid | Строка, Число | ID пользователя для блокировки | + | УдалитьПоследниеСообщения | --dellast | Булево | Удалить последние сообщения перед блокировкой | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats​/blockUser](https://teams.vk.com/botapi/#/chats/get_chats_blockUser) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Пользователь = 1011987091; + + Результат = OPI_VKTeams.ЗаблокироватьПользователяЧата(Токен, IDЧата, Пользователь, Истина); +``` + + + + + + ```bash + oint vkteams ЗаблокироватьПользователяЧата --token "***" \ + --chatid "689203963@chat.agent" \ + --userid 1011987091 \ + --dellast true + ``` + + + + ```batch + oint vkteams ЗаблокироватьПользователяЧата ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --userid 1011987091 ^ + --dellast true + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Change-chat-picture.md b/docs/ru/md/VKTeams/Chat-management/Change-chat-picture.md deleted file mode 100644 index 38954e3af0..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Change-chat-picture.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Изменить аватар чата - Изменяет картинку аватар чата - - - -`Функция ИзменитьАватарЧата(Знач Токен, Знач IDЧата, Знач Файл) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | Файл | --file | ДвоичныеДанные, Строка | Файл картинки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [POST ​/chats​/avatar​/set](https://teams.vk.com/botapi/#/chats/post_chats_avatar_set) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - - Файл = "https://api.athenaeum.digital/test_data/spy2.png"; // URL - ФайлПуть = ПолучитьИмяВременногоФайла("png"); // Путь - - КопироватьФайл(Файл, ФайлПуть); - - ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные - - Результат = OPI_VKTeams.ИзменитьАватарЧата(Токен, IDЧата, Файл); - - Результат = OPI_VKTeams.ИзменитьАватарЧата(Токен, IDЧата, ФайлПуть); - - Результат = OPI_VKTeams.ИзменитьАватарЧата(Токен, IDЧата, ФайлДД); -``` - - - - - - ```bash - oint vkteams ИзменитьАватарЧата --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" \ - --file "C:\Users\Administrator\AppData\Local\Temp\bhvf2o3csdt.png" - ``` - - - - ```batch - oint vkteams ИзменитьАватарЧата ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" ^ - --file "C:\Users\Administrator\AppData\Local\Temp\bhvf2o3csdt.png" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Change-chat-picture.mdx b/docs/ru/md/VKTeams/Chat-management/Change-chat-picture.mdx new file mode 100644 index 0000000000..7efffea04b --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Change-chat-picture.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Изменить аватар чата + Изменяет картинку аватар чата + + + +`Функция ИзменитьАватарЧата(Знач Токен, Знач IDЧата, Знач Файл) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Файл | --file | ДвоичныеДанные, Строка | Файл картинки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [POST ​/chats​/avatar​/set](https://teams.vk.com/botapi/#/chats/post_chats_avatar_set) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + + Файл = "https://api.athenaeum.digital/test_data/spy2.png"; // URL + ФайлПуть = ПолучитьИмяВременногоФайла("png"); // Путь + + КопироватьФайл(Файл, ФайлПуть); + + ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные + + Результат = OPI_VKTeams.ИзменитьАватарЧата(Токен, IDЧата, Файл); + + Результат = OPI_VKTeams.ИзменитьАватарЧата(Токен, IDЧата, ФайлПуть); + + Результат = OPI_VKTeams.ИзменитьАватарЧата(Токен, IDЧата, ФайлДД); +``` + + + + + + ```bash + oint vkteams ИзменитьАватарЧата --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" \ + --file "C:\Users\Administrator\AppData\Local\Temp\bhvf2o3csdt.png" + ``` + + + + ```batch + oint vkteams ИзменитьАватарЧата ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" ^ + --file "C:\Users\Administrator\AppData\Local\Temp\bhvf2o3csdt.png" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Disapprove-pending.md b/docs/ru/md/VKTeams/Chat-management/Disapprove-pending.md deleted file mode 100644 index 746a1c118c..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Disapprove-pending.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Отклонить заявку на вступление - Отклоняет вступление пользователя в закрытый чат - - - -`Функция ОтклонитьЗаявкуНаВступление(Знач Токен, Знач IDЧата, Знач IDПользователя = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | IDПользователя | --userid | Строка, Число | ID пользователя. Ответ на все заявки, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Пользователь = 1011987091; - - Результат = OPI_VKTeams.ОтклонитьЗаявкуНаВступление(Токен, IDЧата, Пользователь); - - Результат = OPI_VKTeams.ОтклонитьЗаявкуНаВступление(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ОтклонитьЗаявкуНаВступление --token "***" \ - --chatid "689203963@chat.agent" - ``` - - - - ```batch - oint vkteams ОтклонитьЗаявкуНаВступление ^ - --token "***" ^ - --chatid "689203963@chat.agent" - ``` - - - - -```json title="Результат" -{ - "ok": false, - "description": "User is not pending or nobody in pending list" -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Disapprove-pending.mdx b/docs/ru/md/VKTeams/Chat-management/Disapprove-pending.mdx new file mode 100644 index 0000000000..c64e2bf688 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Disapprove-pending.mdx @@ -0,0 +1,69 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Отклонить заявку на вступление + Отклоняет вступление пользователя в закрытый чат + + + +`Функция ОтклонитьЗаявкуНаВступление(Знач Токен, Знач IDЧата, Знач IDПользователя = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | IDПользователя | --userid | Строка, Число | ID пользователя. Ответ на все заявки, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats/resolvePending](https://teams.vk.com/botapi/#/chats/get_chats_resolvePending) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Пользователь = 1011987091; + + Результат = OPI_VKTeams.ОтклонитьЗаявкуНаВступление(Токен, IDЧата, Пользователь); + + Результат = OPI_VKTeams.ОтклонитьЗаявкуНаВступление(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ОтклонитьЗаявкуНаВступление --token "***" \ + --chatid "689203963@chat.agent" + ``` + + + + ```batch + oint vkteams ОтклонитьЗаявкуНаВступление ^ + --token "***" ^ + --chatid "689203963@chat.agent" + ``` + + + + +```json title="Результат" +{ + "ok": false, + "description": "User is not pending or nobody in pending list" +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-admins.md b/docs/ru/md/VKTeams/Chat-management/Get-chat-admins.md deleted file mode 100644 index 62ec12fa4b..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Get-chat-admins.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить администраторов чата - Получает список администраторов чата - - - -`Функция ПолучитьАдминистраторовЧата(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /chats/getAdmins](https://teams.vk.com/botapi/#/chats/get_chats_getAdmins) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - - Результат = OPI_VKTeams.ПолучитьАдминистраторовЧата(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ПолучитьАдминистраторовЧата --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - ```batch - oint vkteams ПолучитьАдминистраторовЧата ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - -```json title="Результат" -{ - "admins": [ - { - "userId": "1011893356" - }, - { - "creator": true, - "userId": "bayselonarrend@openintegrations.bizml.ru" - } - ], - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-admins.mdx b/docs/ru/md/VKTeams/Chat-management/Get-chat-admins.mdx new file mode 100644 index 0000000000..edd358b3d3 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Get-chat-admins.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить администраторов чата + Получает список администраторов чата + + + +`Функция ПолучитьАдминистраторовЧата(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /chats/getAdmins](https://teams.vk.com/botapi/#/chats/get_chats_getAdmins) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + + Результат = OPI_VKTeams.ПолучитьАдминистраторовЧата(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ПолучитьАдминистраторовЧата --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + ```batch + oint vkteams ПолучитьАдминистраторовЧата ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + +```json title="Результат" +{ + "admins": [ + { + "userId": "1011893356" + }, + { + "creator": true, + "userId": "bayselonarrend@openintegrations.bizml.ru" + } + ], + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-blocked-users.md b/docs/ru/md/VKTeams/Chat-management/Get-chat-blocked-users.md deleted file mode 100644 index d90c78b3d8..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Get-chat-blocked-users.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить заблокированных пользователей чата - Получает список заблокированных пользователей чата - - - -`Функция ПолучитьЗаблокированныхПользователейЧата(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​/chats​/getBlockedUsers](https://teams.vk.com/botapi/#/chats/get_chats_getBlockedUsers) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - - Результат = OPI_VKTeams.ПолучитьЗаблокированныхПользователейЧата(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ПолучитьЗаблокированныхПользователейЧата --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - ```batch - oint vkteams ПолучитьЗаблокированныхПользователейЧата ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - -```json title="Результат" -{ - "users": [], - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-blocked-users.mdx b/docs/ru/md/VKTeams/Chat-management/Get-chat-blocked-users.mdx new file mode 100644 index 0000000000..72f700517e --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Get-chat-blocked-users.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить заблокированных пользователей чата + Получает список заблокированных пользователей чата + + + +`Функция ПолучитьЗаблокированныхПользователейЧата(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​/chats​/getBlockedUsers](https://teams.vk.com/botapi/#/chats/get_chats_getBlockedUsers) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + + Результат = OPI_VKTeams.ПолучитьЗаблокированныхПользователейЧата(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ПолучитьЗаблокированныхПользователейЧата --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + ```batch + oint vkteams ПолучитьЗаблокированныхПользователейЧата ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + +```json title="Результат" +{ + "users": [], + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-info.md b/docs/ru/md/VKTeams/Chat-management/Get-chat-info.md deleted file mode 100644 index 1b0a44b124..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Get-chat-info.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию о чате - Получает основную информацию о чате - - - -`Функция ПолучитьИнформациюОЧате(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /chats/getInfo](https://teams.vk.com/botapi/#/chats/get_chats_getInfo) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - - Результат = OPI_VKTeams.ПолучитьИнформациюОЧате(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ПолучитьИнформациюОЧате --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - ```batch - oint vkteams ПолучитьИнформациюОЧате ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - -```json title="Результат" -{ - "inviteLink": "https://icq.com/chat/AoLI0egLWBSLR1Ngn2w", - "joinModeration": false, - "public": false, - "rules": "Это новые правила из CLI", - "title": "Тест2", - "type": "group", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-info.mdx b/docs/ru/md/VKTeams/Chat-management/Get-chat-info.mdx new file mode 100644 index 0000000000..1429f15c26 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Get-chat-info.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить информацию о чате + Получает основную информацию о чате + + + +`Функция ПолучитьИнформациюОЧате(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /chats/getInfo](https://teams.vk.com/botapi/#/chats/get_chats_getInfo) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + + Результат = OPI_VKTeams.ПолучитьИнформациюОЧате(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ПолучитьИнформациюОЧате --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + ```batch + oint vkteams ПолучитьИнформациюОЧате ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + +```json title="Результат" +{ + "inviteLink": "https://icq.com/chat/AoLI0egLWBSLR1Ngn2w", + "joinModeration": false, + "public": false, + "rules": "Это новые правила из CLI", + "title": "Тест2", + "type": "group", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-join-requests.md b/docs/ru/md/VKTeams/Chat-management/Get-chat-join-requests.md deleted file mode 100644 index 569bb512ea..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Get-chat-join-requests.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Получить запросы вступления чата - Получает список запросов на вступление в чат - - - -`Функция ПолучитьЗапросыВступленияЧата(Знач Токен, Знач IDЧата) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats​/getPendingUsers](https://teams.vk.com/botapi/#/chats/get_chats_getPendingUsers) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - - Результат = OPI_VKTeams.ПолучитьЗапросыВступленияЧата(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ПолучитьЗапросыВступленияЧата --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - ```batch - oint vkteams ПолучитьЗапросыВступленияЧата ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - -```json title="Результат" -{ - "users": [], - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-join-requests.mdx b/docs/ru/md/VKTeams/Chat-management/Get-chat-join-requests.mdx new file mode 100644 index 0000000000..ad626fa552 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Get-chat-join-requests.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Получить запросы вступления чата + Получает список запросов на вступление в чат + + + +`Функция ПолучитьЗапросыВступленияЧата(Знач Токен, Знач IDЧата) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats​/getPendingUsers](https://teams.vk.com/botapi/#/chats/get_chats_getPendingUsers) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + + Результат = OPI_VKTeams.ПолучитьЗапросыВступленияЧата(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ПолучитьЗапросыВступленияЧата --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + ```batch + oint vkteams ПолучитьЗапросыВступленияЧата ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + +```json title="Результат" +{ + "users": [], + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-members.md b/docs/ru/md/VKTeams/Chat-management/Get-chat-members.md deleted file mode 100644 index 161c099a00..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Get-chat-members.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить пользователей чата - Получает список пользователей чата - - - -`Функция ПолучитьПользователейЧата(Знач Токен, Знач IDЧата, Знач Курсор = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | Курсор | --cursor | Строка | Маркер продолжения списка из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /chats/getMembers](https://teams.vk.com/botapi/#/chats/get_chats_getMembers) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - - Результат = OPI_VKTeams.ПолучитьПользователейЧата(Токен, IDЧата); -``` - - - - - - ```bash - oint vkteams ПолучитьПользователейЧата --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - ```batch - oint vkteams ПолучитьПользователейЧата ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" - ``` - - - - -```json title="Результат" -{ - "members": [ - { - "admin": true, - "userId": "1011893356" - }, - { - "creator": true, - "userId": "bayselonarrend@openintegrations.bizml.ru" - }, - { - "userId": "1011987091" - } - ], - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Get-chat-members.mdx b/docs/ru/md/VKTeams/Chat-management/Get-chat-members.mdx new file mode 100644 index 0000000000..48e3fd2ed4 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Get-chat-members.mdx @@ -0,0 +1,76 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить пользователей чата + Получает список пользователей чата + + + +`Функция ПолучитьПользователейЧата(Знач Токен, Знач IDЧата, Знач Курсор = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Курсор | --cursor | Строка | Маркер продолжения списка из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /chats/getMembers](https://teams.vk.com/botapi/#/chats/get_chats_getMembers) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + + Результат = OPI_VKTeams.ПолучитьПользователейЧата(Токен, IDЧата); +``` + + + + + + ```bash + oint vkteams ПолучитьПользователейЧата --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + ```batch + oint vkteams ПолучитьПользователейЧата ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" + ``` + + + + +```json title="Результат" +{ + "members": [ + { + "admin": true, + "userId": "1011893356" + }, + { + "creator": true, + "userId": "bayselonarrend@openintegrations.bizml.ru" + }, + { + "userId": "1011987091" + } + ], + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md b/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md deleted file mode 100644 index f8625a1854..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Исключить пользователей чата - Исключает пользователей из чата - - - -`Функция ИсключитьПользователейЧата(Знач Токен, Знач IDЧата, Знач Пользователи) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | Пользователи | --members | Строка, Число, Массив Из Строка, Число | Пользователь или пользователи чата для удаления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Пользователь = 1011987091; - - Результат = OPI_VKTeams.ИсключитьПользователейЧата(Токен, IDЧата, Пользователь); -``` - - - - - - ```bash - oint vkteams ИсключитьПользователейЧата --token "***" \ - --chatid "689203963@chat.agent" \ - --members 1011987091 - ``` - - - - ```batch - oint vkteams ИсключитьПользователейЧата ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --members 1011987091 - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.mdx b/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.mdx new file mode 100644 index 0000000000..7ab46ed534 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Исключить пользователей чата + Исключает пользователей из чата + + + +`Функция ИсключитьПользователейЧата(Знач Токен, Знач IDЧата, Знач Пользователи) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Пользователи | --members | Строка, Число, Массив Из Строка, Число | Пользователь или пользователи чата для удаления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Пользователь = 1011987091; + + Результат = OPI_VKTeams.ИсключитьПользователейЧата(Токен, IDЧата, Пользователь); +``` + + + + + + ```bash + oint vkteams ИсключитьПользователейЧата --token "***" \ + --chatid "689203963@chat.agent" \ + --members 1011987091 + ``` + + + + ```batch + oint vkteams ИсключитьПользователейЧата ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --members 1011987091 + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Set-chat-description.md b/docs/ru/md/VKTeams/Chat-management/Set-chat-description.md deleted file mode 100644 index 7b3c30df57..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Set-chat-description.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 13 ---- - -# Установить описание чата - Устанавливает новое описание чата - - - -`Функция УстановитьОписаниеЧата(Знач Токен, Знач IDЧата, Знач Текст) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | Текст | --text | Строка | Текст описания | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats/setAbout](https://teams.vk.com/botapi/#/chats/get_chats_setAbout) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Текст = "Новое описание"; - - Результат = OPI_VKTeams.УстановитьОписаниеЧата(Токен, IDЧата, Текст); -``` - - - - - - ```bash - oint vkteams УстановитьОписаниеЧата --token "***" \ - --chatid "689203963@chat.agent" \ - --text "Новое описание" - ``` - - - - ```batch - oint vkteams УстановитьОписаниеЧата ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --text "Новое описание" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Set-chat-description.mdx b/docs/ru/md/VKTeams/Chat-management/Set-chat-description.mdx new file mode 100644 index 0000000000..01e9034270 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Set-chat-description.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 13 +--- + +# Установить описание чата + Устанавливает новое описание чата + + + +`Функция УстановитьОписаниеЧата(Знач Токен, Знач IDЧата, Знач Текст) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Текст | --text | Строка | Текст описания | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats/setAbout](https://teams.vk.com/botapi/#/chats/get_chats_setAbout) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Текст = "Новое описание"; + + Результат = OPI_VKTeams.УстановитьОписаниеЧата(Токен, IDЧата, Текст); +``` + + + + + + ```bash + oint vkteams УстановитьОписаниеЧата --token "***" \ + --chatid "689203963@chat.agent" \ + --text "Новое описание" + ``` + + + + ```batch + oint vkteams УстановитьОписаниеЧата ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --text "Новое описание" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Set-chat-rules.md b/docs/ru/md/VKTeams/Chat-management/Set-chat-rules.md deleted file mode 100644 index d7d0dbdddb..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Set-chat-rules.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 14 ---- - -# Установить правила чата - Устанавливает новые правила чата - - - -`Функция УстановитьПравилаЧата(Знач Токен, Знач IDЧата, Знач Текст) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | Текст | --text | Строка | Текст правил | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET /chats/setRules](https://teams.vk.com/botapi/#/chats/get_chats_setRules) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Текст = "Текст новых правил"; - - Результат = OPI_VKTeams.УстановитьПравилаЧата(Токен, IDЧата, Текст); -``` - - - - - - ```bash - oint vkteams УстановитьПравилаЧата --token "***" \ - --chatid "689203963@chat.agent" \ - --text "Текст новых правил" - ``` - - - - ```batch - oint vkteams УстановитьПравилаЧата ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --text "Текст новых правил" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Set-chat-rules.mdx b/docs/ru/md/VKTeams/Chat-management/Set-chat-rules.mdx new file mode 100644 index 0000000000..9fd504dc14 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Set-chat-rules.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 14 +--- + +# Установить правила чата + Устанавливает новые правила чата + + + +`Функция УстановитьПравилаЧата(Знач Токен, Знач IDЧата, Знач Текст) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Текст | --text | Строка | Текст правил | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET /chats/setRules](https://teams.vk.com/botapi/#/chats/get_chats_setRules) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Текст = "Текст новых правил"; + + Результат = OPI_VKTeams.УстановитьПравилаЧата(Токен, IDЧата, Текст); +``` + + + + + + ```bash + oint vkteams УстановитьПравилаЧата --token "***" \ + --chatid "689203963@chat.agent" \ + --text "Текст новых правил" + ``` + + + + ```batch + oint vkteams УстановитьПравилаЧата ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --text "Текст новых правил" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Set-chat-title.md b/docs/ru/md/VKTeams/Chat-management/Set-chat-title.md deleted file mode 100644 index ab316b5d23..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Set-chat-title.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Установить заголовок чата - Устанавливает новый заголовок чата - - - -`Функция УстановитьЗаголовокЧата(Знач Токен, Знач IDЧата, Знач Текст) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | Текст | --text | Строка | Текст заголовка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats/setTitle](https://teams.vk.com/botapi/#/chats/get_chats_setTitle) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Текст = "Новый заголовок"; - - Результат = OPI_VKTeams.УстановитьЗаголовокЧата(Токен, IDЧата, Текст); -``` - - - - - - ```bash - oint vkteams УстановитьЗаголовокЧата --token "***" \ - --chatid "689203963@chat.agent" \ - --text "Новый заголовок" - ``` - - - - ```batch - oint vkteams УстановитьЗаголовокЧата ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --text "Новый заголовок" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Set-chat-title.mdx b/docs/ru/md/VKTeams/Chat-management/Set-chat-title.mdx new file mode 100644 index 0000000000..6a84ee4b89 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Set-chat-title.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Установить заголовок чата + Устанавливает новый заголовок чата + + + +`Функция УстановитьЗаголовокЧата(Знач Токен, Знач IDЧата, Знач Текст) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Текст | --text | Строка | Текст заголовка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats/setTitle](https://teams.vk.com/botapi/#/chats/get_chats_setTitle) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Текст = "Новый заголовок"; + + Результат = OPI_VKTeams.УстановитьЗаголовокЧата(Токен, IDЧата, Текст); +``` + + + + + + ```bash + oint vkteams УстановитьЗаголовокЧата --token "***" \ + --chatid "689203963@chat.agent" \ + --text "Новый заголовок" + ``` + + + + ```batch + oint vkteams УстановитьЗаголовокЧата ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --text "Новый заголовок" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Unblock-chat-user.md b/docs/ru/md/VKTeams/Chat-management/Unblock-chat-user.md deleted file mode 100644 index 678e64a8fb..0000000000 --- a/docs/ru/md/VKTeams/Chat-management/Unblock-chat-user.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Разблокировать пользователя чата - Разблокирует ранее заблокированного пользователя в чате - - - -`Функция РазблокироватьПользователяЧата(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | IDПользователя | --userid | Строка, Число | ID пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате. - - Метод в документации API: [GET ​​/chats/unblockUser](https://teams.vk.com/botapi/#/chats/get_chats_unblockUser) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - Пользователь = 1011987091; - - Результат = OPI_VKTeams.РазблокироватьПользователяЧата(Токен, IDЧата, Пользователь); -``` - - - - - - ```bash - oint vkteams РазблокироватьПользователяЧата --token "***" \ - --chatid "689203963@chat.agent" \ - --userid 1011987091 - ``` - - - - ```batch - oint vkteams РазблокироватьПользователяЧата ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --userid 1011987091 - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Chat-management/Unblock-chat-user.mdx b/docs/ru/md/VKTeams/Chat-management/Unblock-chat-user.mdx new file mode 100644 index 0000000000..666e7a9739 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Unblock-chat-user.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Разблокировать пользователя чата + Разблокирует ранее заблокированного пользователя в чате + + + +`Функция РазблокироватьПользователяЧата(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | IDПользователя | --userid | Строка, Число | ID пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате. + + Метод в документации API: [GET ​​/chats/unblockUser](https://teams.vk.com/botapi/#/chats/get_chats_unblockUser) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + Пользователь = 1011987091; + + Результат = OPI_VKTeams.РазблокироватьПользователяЧата(Токен, IDЧата, Пользователь); +``` + + + + + + ```bash + oint vkteams РазблокироватьПользователяЧата --token "***" \ + --chatid "689203963@chat.agent" \ + --userid 1011987091 + ``` + + + + ```batch + oint vkteams РазблокироватьПользователяЧата ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --userid 1011987091 + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Common-methods/Check-token.md b/docs/ru/md/VKTeams/Common-methods/Check-token.md deleted file mode 100644 index b8c9d47330..0000000000 --- a/docs/ru/md/VKTeams/Common-methods/Check-token.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Проверить токен - Проверяет работоспособность токена бота - - - -`Функция ПроверитьТокен(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - Результат = OPI_VKTeams.ПроверитьТокен(Токен); -``` - - - - - - ```bash - oint vkteams ПроверитьТокен --token "***" - ``` - - - - ```batch - oint vkteams ПроверитьТокен ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "userId": "1011893356", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Common-methods/Check-token.mdx b/docs/ru/md/VKTeams/Common-methods/Check-token.mdx new file mode 100644 index 0000000000..8b13f406d0 --- /dev/null +++ b/docs/ru/md/VKTeams/Common-methods/Check-token.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Проверить токен + Проверяет работоспособность токена бота + + + +`Функция ПроверитьТокен(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + Результат = OPI_VKTeams.ПроверитьТокен(Токен); +``` + + + + + + ```bash + oint vkteams ПроверитьТокен --token "***" + ``` + + + + ```batch + oint vkteams ПроверитьТокен ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "userId": "1011893356", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Common-methods/Get-events.md b/docs/ru/md/VKTeams/Common-methods/Get-events.md deleted file mode 100644 index 7cc756991d..0000000000 --- a/docs/ru/md/VKTeams/Common-methods/Get-events.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить события - Получает события бота в Polling режиме - - - -`Функция ПолучитьСобытия(Знач Токен, Знач IDПоследнего, Знач Таймаут = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDПоследнего | --last | Строка, Число | ID последнего обработанного до этого события | - | Таймаут | --timeout | Строка, Число | Время удержания соединения для Long Polling | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDПоследнего = 0; - - Для Н = 1 По 5 Цикл // В реальной работе - бесконечный цикл - - Результат = OPI_VKTeams.ПолучитьСобытия(Токен, IDПоследнего, 3); - - События = Результат["events"]; - - // Обработка событий... - - Если Не События.Количество() = 0 Тогда - - IDПоследнего = События[События.ВГраница()]["eventId"]; - - КонецЕсли; - - КонецЦикла; -``` - - - - - - ```bash - oint vkteams ПолучитьСобытия --token "***" \ - --last 152 \ - --timeout 3 - ``` - - - - ```batch - oint vkteams ПолучитьСобытия ^ - --token "***" ^ - --last 152 ^ - --timeout 3 - ``` - - - - -```json title="Результат" -{ - "events": [], - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Common-methods/Get-events.mdx b/docs/ru/md/VKTeams/Common-methods/Get-events.mdx new file mode 100644 index 0000000000..8aa100d43d --- /dev/null +++ b/docs/ru/md/VKTeams/Common-methods/Get-events.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить события + Получает события бота в Polling режиме + + + +`Функция ПолучитьСобытия(Знач Токен, Знач IDПоследнего, Знач Таймаут = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDПоследнего | --last | Строка, Число | ID последнего обработанного до этого события | + | Таймаут | --timeout | Строка, Число | Время удержания соединения для Long Polling | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDПоследнего = 0; + + Для Н = 1 По 5 Цикл // В реальной работе - бесконечный цикл + + Результат = OPI_VKTeams.ПолучитьСобытия(Токен, IDПоследнего, 3); + + События = Результат["events"]; + + // Обработка событий... + + Если Не События.Количество() = 0 Тогда + + IDПоследнего = События[События.ВГраница()]["eventId"]; + + КонецЕсли; + + КонецЦикла; +``` + + + + + + ```bash + oint vkteams ПолучитьСобытия --token "***" \ + --last 152 \ + --timeout 3 + ``` + + + + ```batch + oint vkteams ПолучитьСобытия ^ + --token "***" ^ + --last 152 ^ + --timeout 3 + ``` + + + + +```json title="Результат" +{ + "events": [], + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Common-methods/Get-file-information.md b/docs/ru/md/VKTeams/Common-methods/Get-file-information.md deleted file mode 100644 index 33378e5554..0000000000 --- a/docs/ru/md/VKTeams/Common-methods/Get-file-information.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию о файле - Получает информацию о файле по его ID - - - -`Функция ПолучитьИнформациюОФайле(Знач Токен, Знач IDФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDФайла | --fileid | Строка, Число | ID Файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDФайла = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; - - Результат = OPI_VKTeams.ПолучитьИнформациюОФайле(Токен, IDФайла); -``` - - - - - - ```bash - oint vkteams ПолучитьИнформациюОФайле --token "***" \ - --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" - ``` - - - - ```batch - oint vkteams ПолучитьИнформациюОФайле ^ - --token "***" ^ - --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" - ``` - - - - -```json title="Результат" -{ - "filename": "ВажныйДокумент.docx", - "size": 24071, - "type": "application", - "url": "https://ub.icq.net/files/get/kqNCDPqMHd3CwGE3xUdGqRxUdGAr7neSGTqd7Gz03QfixOKjJSz9E4A1rHmhl1GdDMg1RXw8oI4Vn3hGWWwbmIbw7gWiSlulz1Z7j2Ai3ZMBIScnRvTGrBuAH1izuc5IoKL5FSZdeu6SL29x7Sxae0oGgfxUdG/%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Common-methods/Get-file-information.mdx b/docs/ru/md/VKTeams/Common-methods/Get-file-information.mdx new file mode 100644 index 0000000000..da5fa5f937 --- /dev/null +++ b/docs/ru/md/VKTeams/Common-methods/Get-file-information.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить информацию о файле + Получает информацию о файле по его ID + + + +`Функция ПолучитьИнформациюОФайле(Знач Токен, Знач IDФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDФайла | --fileid | Строка, Число | ID Файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDФайла = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; + + Результат = OPI_VKTeams.ПолучитьИнформациюОФайле(Токен, IDФайла); +``` + + + + + + ```bash + oint vkteams ПолучитьИнформациюОФайле --token "***" \ + --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" + ``` + + + + ```batch + oint vkteams ПолучитьИнформациюОФайле ^ + --token "***" ^ + --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" + ``` + + + + +```json title="Результат" +{ + "filename": "ВажныйДокумент.docx", + "size": 24071, + "type": "application", + "url": "https://ub.icq.net/files/get/kqNCDPqMHd3CwGE3xUdGqRxUdGAr7neSGTqd7Gz03QfixOKjJSz9E4A1rHmhl1GdDMg1RXw8oI4Vn3hGWWwbmIbw7gWiSlulz1Z7j2Ai3ZMBIScnRvTGrBuAH1izuc5IoKL5FSZdeu6SL29x7Sxae0oGgfxUdG/%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Answer-button-event.md b/docs/ru/md/VKTeams/Message-sending/Answer-button-event.md deleted file mode 100644 index 7d5ce69dea..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Answer-button-event.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Ответить на событие клавиатуры - Возвращает ответ пользователю при нажатии на кнопку клавиатуры - - - -`Функция ОтветитьНаСобытиеКлавиатуры(Знач Токен, Знач IDСобытия, Знач Текст = "", Знач URL = "", Знач ЭтоПредупреждение = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDСобытия | --queryid | Строка | Идентификатор callback query полученного ботом | - | Текст | --text | Строка | Текст ответа | - | URL | --url | Строка | URL, который будет открыт клиентским приложением | - | ЭтоПредупреждение | --showalert | Булево | Отображать ответ как предупреждение (alert) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Вызов данного метода должен использоваться в ответ на получение события callbackQuery - - Метод в документации API: [GET /messages/answerCallbackQuery](https://teams.vk.com/botapi/#/messages/get_messages_answerCallbackQuery) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDПоследнего = 0; - - Для Н = 1 По 5 Цикл - - Результат = OPI_VKTeams.ПолучитьСобытия(Токен, IDПоследнего, 3); - События = Результат["events"]; - - Если Не События.Количество() = 0 Тогда - - Для Каждого Событие Из События Цикл - - ДанныеСобытия = Событие["payload"]; - - Если ДанныеСобытия["callbackData"] = "НажатиеКнопки1" Тогда - - IDСобытия = ДанныеСобытия["queryId"]; - Результат = OPI_VKTeams.ОтветитьНаСобытиеКлавиатуры(Токен, IDСобытия, "Получено!"); - - КонецЕсли; - - КонецЦикла; - - IDПоследнего = События[События.ВГраница()]["eventId"]; - - КонецЕсли; - - КонецЦикла; -``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Answer-button-event.mdx b/docs/ru/md/VKTeams/Message-sending/Answer-button-event.mdx new file mode 100644 index 0000000000..339886d925 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Answer-button-event.mdx @@ -0,0 +1,74 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Ответить на событие клавиатуры + Возвращает ответ пользователю при нажатии на кнопку клавиатуры + + + +`Функция ОтветитьНаСобытиеКлавиатуры(Знач Токен, Знач IDСобытия, Знач Текст = "", Знач URL = "", Знач ЭтоПредупреждение = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDСобытия | --queryid | Строка | Идентификатор callback query полученного ботом | + | Текст | --text | Строка | Текст ответа | + | URL | --url | Строка | URL, который будет открыт клиентским приложением | + | ЭтоПредупреждение | --showalert | Булево | Отображать ответ как предупреждение (alert) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Вызов данного метода должен использоваться в ответ на получение события callbackQuery + + Метод в документации API: [GET /messages/answerCallbackQuery](https://teams.vk.com/botapi/#/messages/get_messages_answerCallbackQuery) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDПоследнего = 0; + + Для Н = 1 По 5 Цикл + + Результат = OPI_VKTeams.ПолучитьСобытия(Токен, IDПоследнего, 3); + События = Результат["events"]; + + Если Не События.Количество() = 0 Тогда + + Для Каждого Событие Из События Цикл + + ДанныеСобытия = Событие["payload"]; + + Если ДанныеСобытия["callbackData"] = "НажатиеКнопки1" Тогда + + IDСобытия = ДанныеСобытия["queryId"]; + Результат = OPI_VKTeams.ОтветитьНаСобытиеКлавиатуры(Токен, IDСобытия, "Получено!"); + + КонецЕсли; + + КонецЦикла; + + IDПоследнего = События[События.ВГраница()]["eventId"]; + + КонецЕсли; + + КонецЦикла; +``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Delete-message.md b/docs/ru/md/VKTeams/Message-sending/Delete-message.md deleted file mode 100644 index 2bd428a794..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Delete-message.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Удалить сообщение - Удаляет сообщение по ID - - - -`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDСообщения = "7425684917876428136"; - - Результат = OPI_VKTeams.УдалитьСообщение(Токен, IDЧата, IDСообщения); -``` - - - - - - ```bash - oint vkteams УдалитьСообщение --token "***" \ - --chatid "689203963@chat.agent" \ - --messageid "7425884578021117348" - ``` - - - - ```batch - oint vkteams УдалитьСообщение ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --messageid "7425884578021117348" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Delete-message.mdx b/docs/ru/md/VKTeams/Message-sending/Delete-message.mdx new file mode 100644 index 0000000000..2daa4dda87 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Delete-message.mdx @@ -0,0 +1,66 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Удалить сообщение + Удаляет сообщение по ID + + + +`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDСообщения = "7425684917876428136"; + + Результат = OPI_VKTeams.УдалитьСообщение(Токен, IDЧата, IDСообщения); +``` + + + + + + ```bash + oint vkteams УдалитьСообщение --token "***" \ + --chatid "689203963@chat.agent" \ + --messageid "7425884578021117348" + ``` + + + + ```batch + oint vkteams УдалитьСообщение ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --messageid "7425884578021117348" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md b/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md deleted file mode 100644 index f9ef61b4d4..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Изменить текст сообщения - Изменяет текст сущесствующего сообщения - - - -`Функция ИзменитьТекстСообщения(Знач Токен, Знач IDЧата, Знач IDСообщения, Знач Текст, Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | - | Текст | --text | Строка | Новый текст сообщения | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] - - Метод в документации API: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDСообщения = "7425684917876428136"; - Текст = "Новый текст сообщения"; - - Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст); - - Текст = "Новый полужирный текст сообщения"; - Разметка = "HTML"; - - Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст, Разметка); -``` - - - - - - ```bash - oint vkteams ИзменитьТекстСообщения --token "***" \ - --chatid "689203963@chat.agent" \ - --messageid "7425884578021117348" \ - --text "Новый полужирный текст сообщения" \ - --parsemod "HTML" - ``` - - - - ```batch - oint vkteams ИзменитьТекстСообщения ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --messageid "7425884578021117348" ^ - --text "Новый полужирный текст сообщения" ^ - --parsemod "HTML" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Edit-message-text.mdx b/docs/ru/md/VKTeams/Message-sending/Edit-message-text.mdx new file mode 100644 index 0000000000..3d8e12a5a6 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Edit-message-text.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Изменить текст сообщения + Изменяет текст сущесствующего сообщения + + + +`Функция ИзменитьТекстСообщения(Знач Токен, Знач IDЧата, Знач IDСообщения, Знач Текст, Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | + | Текст | --text | Строка | Новый текст сообщения | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] + + Метод в документации API: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDСообщения = "7425684917876428136"; + Текст = "Новый текст сообщения"; + + Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст); + + Текст = "Новый полужирный текст сообщения"; + Разметка = "HTML"; + + Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст, Разметка); +``` + + + + + + ```bash + oint vkteams ИзменитьТекстСообщения --token "***" \ + --chatid "689203963@chat.agent" \ + --messageid "7425884578021117348" \ + --text "Новый полужирный текст сообщения" \ + --parsemod "HTML" + ``` + + + + ```batch + oint vkteams ИзменитьТекстСообщения ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --messageid "7425884578021117348" ^ + --text "Новый полужирный текст сообщения" ^ + --parsemod "HTML" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Forward-message.md b/docs/ru/md/VKTeams/Message-sending/Forward-message.md deleted file mode 100644 index bcb7591d15..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Forward-message.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Переслать сообщение - Переслыает существующее сообщение в текущий диалог - - - -`Функция ПереслатьСообщение(Знач Токен, Знач IDСообщения, Знач IDЧатаИсточника, Знач IDЧата, Знач Текст = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDСообщения | --messageid | Строка, Число | ID оригинального сообщения | - | IDЧатаИсточника | --fromid | Строка, Число | ID чата источника оригинального сообщения | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | Текст | --text | Строка | Дополнительный текст сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -В IDЧатаИсточника можно передавать только chatId из событий (код из ссылки на чат не подходит) - - Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - IDЧатаИсточника = "689203963@chat.agent"; - IDСообщения = "7425684917876428136"; - - Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата); - - Текст = "Дополнительный текст"; - - Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата, Текст); -``` - - - - - - ```bash - oint vkteams ПереслатьСообщение --token "***" \ - --messageid "7425884578021117348" \ - --fromid "689203963@chat.agent" \ - --chatid "AoLI0egLWBSLR1Ngn2w" \ - --text "Дополнительный текст" - ``` - - - - ```batch - oint vkteams ПереслатьСообщение ^ - --token "***" ^ - --messageid "7425884578021117348" ^ - --fromid "689203963@chat.agent" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" ^ - --text "Дополнительный текст" - ``` - - - - -```json title="Результат" -{ - "msgId": "7423464132021586198", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Forward-message.mdx b/docs/ru/md/VKTeams/Message-sending/Forward-message.mdx new file mode 100644 index 0000000000..a281c4f250 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Forward-message.mdx @@ -0,0 +1,80 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Переслать сообщение + Переслыает существующее сообщение в текущий диалог + + + +`Функция ПереслатьСообщение(Знач Токен, Знач IDСообщения, Знач IDЧатаИсточника, Знач IDЧата, Знач Текст = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDСообщения | --messageid | Строка, Число | ID оригинального сообщения | + | IDЧатаИсточника | --fromid | Строка, Число | ID чата источника оригинального сообщения | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | Текст | --text | Строка | Дополнительный текст сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +В IDЧатаИсточника можно передавать только chatId из событий (код из ссылки на чат не подходит) + + Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + IDЧатаИсточника = "689203963@chat.agent"; + IDСообщения = "7425684917876428136"; + + Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата); + + Текст = "Дополнительный текст"; + + Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата, Текст); +``` + + + + + + ```bash + oint vkteams ПереслатьСообщение --token "***" \ + --messageid "7425884578021117348" \ + --fromid "689203963@chat.agent" \ + --chatid "AoLI0egLWBSLR1Ngn2w" \ + --text "Дополнительный текст" + ``` + + + + ```batch + oint vkteams ПереслатьСообщение ^ + --token "***" ^ + --messageid "7425884578021117348" ^ + --fromid "689203963@chat.agent" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" ^ + --text "Дополнительный текст" + ``` + + + + +```json title="Результат" +{ + "msgId": "7423464132021586198", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Make-action-button.md b/docs/ru/md/VKTeams/Message-sending/Make-action-button.md deleted file mode 100644 index 0543fd3cc5..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Make-action-button.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 12 ---- - -# Сформировать кнопку действия - Формирует кнопку действия для клавиатуры сообщения (см. ОтправитьТекстовоеСообщение) - - - -`Функция СформироватьКнопкуДействия(Знач Текст, Знач Значение = "", Знач URL = "", Знач Стиль = "base") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст кнопки | - | Значение | --data | Строка | Значение, возвращаемое в событии нажатия. Только если не заполнено URL | - | URL | --url | Строка | URL для создания кнопки открытия страницы. Только если не заполнено Значение | - | Стиль | --style | Строка | Стиль кнопки: primary, attention или base | - - - Возвращаемое значение: Структура - Кнопка для клавиатуры - -
- - - - -```bsl title="Пример кода" - Клавиатура = Новый Массив; - МассивСтрокиКнопок = Новый Массив; - - МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка1", "НажатиеКнопки1", , "attention")); - - МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка2", , "https://openintegrations.dev")); - - Клавиатура.Добавить(МассивСтрокиКнопок); - Клавиатура.Добавить(МассивСтрокиКнопок); -``` - - - - - - ```bash - oint vkteams СформироватьКнопкуДействия --text "Кнопка2" \ - --url "https://openintegrations.dev" - ``` - - - - ```batch - oint vkteams СформироватьКнопкуДействия ^ - --text "Кнопка2" ^ - --url "https://openintegrations.dev" - ``` - - - - -```json title="Результат" -[ - [ - { - "text": "Кнопка1", - "callbackData": "НажатиеКнопки1", - "style": "attention" - }, - { - "text": "Кнопка2", - "url": "https://openintegrations.dev", - "style": "base" - } - ], - [ - { - "text": "Кнопка1", - "callbackData": "НажатиеКнопки1", - "style": "attention" - }, - { - "text": "Кнопка2", - "url": "https://openintegrations.dev", - "style": "base" - } - ] -] -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Make-action-button.mdx b/docs/ru/md/VKTeams/Message-sending/Make-action-button.mdx new file mode 100644 index 0000000000..04ef5eec6c --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Make-action-button.mdx @@ -0,0 +1,89 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 12 +--- + +# Сформировать кнопку действия + Формирует кнопку действия для клавиатуры сообщения (см. ОтправитьТекстовоеСообщение) + + + +`Функция СформироватьКнопкуДействия(Знач Текст, Знач Значение = "", Знач URL = "", Знач Стиль = "base") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст кнопки | + | Значение | --data | Строка | Значение, возвращаемое в событии нажатия. Только если не заполнено URL | + | URL | --url | Строка | URL для создания кнопки открытия страницы. Только если не заполнено Значение | + | Стиль | --style | Строка | Стиль кнопки: primary, attention или base | + + + Возвращаемое значение: Структура - Кнопка для клавиатуры + +
+ + + + +```bsl title="Пример кода" + Клавиатура = Новый Массив; + МассивСтрокиКнопок = Новый Массив; + + МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка1", "НажатиеКнопки1", , "attention")); + + МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка2", , "https://openintegrations.dev")); + + Клавиатура.Добавить(МассивСтрокиКнопок); + Клавиатура.Добавить(МассивСтрокиКнопок); +``` + + + + + + ```bash + oint vkteams СформироватьКнопкуДействия --text "Кнопка2" \ + --url "https://openintegrations.dev" + ``` + + + + ```batch + oint vkteams СформироватьКнопкуДействия ^ + --text "Кнопка2" ^ + --url "https://openintegrations.dev" + ``` + + + + +```json title="Результат" +[ + [ + { + "text": "Кнопка1", + "callbackData": "НажатиеКнопки1", + "style": "attention" + }, + { + "text": "Кнопка2", + "url": "https://openintegrations.dev", + "style": "base" + } + ], + [ + { + "text": "Кнопка1", + "callbackData": "НажатиеКнопки1", + "style": "attention" + }, + { + "text": "Кнопка2", + "url": "https://openintegrations.dev", + "style": "base" + } + ] +] +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Pin-message.md b/docs/ru/md/VKTeams/Message-sending/Pin-message.md deleted file mode 100644 index 7665083002..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Pin-message.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Закрепить сообщение - Закрепляет выбранное сообщение в чате - - - -`Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | IDСообщения | --messageid | Строка, Число | ID сообщения для закрепления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате - - Метод в документации API: [GET /chats/pinMessage](https://teams.vk.com/botapi/#/chats/get_chats_pinMessage) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDСообщения = "7425684917876428136"; - - Результат = OPI_VKTeams.ЗакрепитьСообщение(Токен, IDЧата, IDСообщения); -``` - - - - - - ```bash - oint vkteams ЗакрепитьСообщение --token "***" \ - --chatid "689203963@chat.agent" \ - --messageid "7425884578021117348" - ``` - - - - ```batch - oint vkteams ЗакрепитьСообщение ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --messageid "7425884578021117348" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Pin-message.mdx b/docs/ru/md/VKTeams/Message-sending/Pin-message.mdx new file mode 100644 index 0000000000..000c897eac --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Pin-message.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Закрепить сообщение + Закрепляет выбранное сообщение в чате + + + +`Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | IDСообщения | --messageid | Строка, Число | ID сообщения для закрепления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате + + Метод в документации API: [GET /chats/pinMessage](https://teams.vk.com/botapi/#/chats/get_chats_pinMessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDСообщения = "7425684917876428136"; + + Результат = OPI_VKTeams.ЗакрепитьСообщение(Токен, IDЧата, IDСообщения); +``` + + + + + + ```bash + oint vkteams ЗакрепитьСообщение --token "***" \ + --chatid "689203963@chat.agent" \ + --messageid "7425884578021117348" + ``` + + + + ```batch + oint vkteams ЗакрепитьСообщение ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --messageid "7425884578021117348" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Resend-file.md b/docs/ru/md/VKTeams/Message-sending/Resend-file.md deleted file mode 100644 index 6615606739..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Resend-file.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Переслать файл - Отправляет ранее загруженный файл по его ID - - - -`Функция ПереслатьФайл(Знач Токен, Знач IDЧата, Знач IDФайла, Знач Текст = "", Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | IDФайла | --fileid | Строка, Число | ID Файла для отправки | - | Текст | --text | Строка | Подпись к файлу | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - IDФайла = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; - Текст = "Подпись к файлу"; - - Результат = OPI_VKTeams.ПереслатьФайл(Токен, IDЧата, IDФайла, Текст); -``` - - - - - - ```bash - oint vkteams ПереслатьФайл --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" \ - --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" \ - --text "Подпись к файлу" - ``` - - - - ```batch - oint vkteams ПереслатьФайл ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" ^ - --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" ^ - --text "Подпись к файлу" - ``` - - - - -```json title="Результат" -{ - "fileId": "kqNCDmWzJuzZn6ZHS9b5Yq6705714e1bd", - "msgId": "7423464162086357274", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Resend-file.mdx b/docs/ru/md/VKTeams/Message-sending/Resend-file.mdx new file mode 100644 index 0000000000..90386150c2 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Resend-file.mdx @@ -0,0 +1,73 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Переслать файл + Отправляет ранее загруженный файл по его ID + + + +`Функция ПереслатьФайл(Знач Токен, Знач IDЧата, Знач IDФайла, Знач Текст = "", Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | IDФайла | --fileid | Строка, Число | ID Файла для отправки | + | Текст | --text | Строка | Подпись к файлу | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + IDФайла = "XG1vEIB5FTX4tJi9IUA6Gg670d55381bd"; + Текст = "Подпись к файлу"; + + Результат = OPI_VKTeams.ПереслатьФайл(Токен, IDЧата, IDФайла, Текст); +``` + + + + + + ```bash + oint vkteams ПереслатьФайл --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" \ + --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" \ + --text "Подпись к файлу" + ``` + + + + ```batch + oint vkteams ПереслатьФайл ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" ^ + --fileid "xNjCbcI70PvUmFRTcD3t0c670e0acf1bd" ^ + --text "Подпись к файлу" + ``` + + + + +```json title="Результат" +{ + "fileId": "kqNCDmWzJuzZn6ZHS9b5Yq6705714e1bd", + "msgId": "7423464162086357274", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Resend-voice.md b/docs/ru/md/VKTeams/Message-sending/Resend-voice.md deleted file mode 100644 index 204fcc852a..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Resend-voice.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Переслать голосовое сообщение - Отправляет ранее загруженное голосовое сообщение по ID - - - -`Функция ПереслатьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач IDФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | IDФайла | --fileid | Строка, Число | ID Файла голосового сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - IDФайла = "I000bzdU0pRaLPRFQ42mv6670d55531bd"; - - Результат = OPI_VKTeams.ПереслатьГолосовоеСообщение(Токен, IDЧата, IDФайла); -``` - - - - - - ```bash - oint vkteams ПереслатьГолосовоеСообщение --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" \ - --fileid "I000bde2Hh0irg0qrY9Cyd670e0aec1bd" - ``` - - - - ```batch - oint vkteams ПереслатьГолосовоеСообщение ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" ^ - --fileid "I000bde2Hh0irg0qrY9Cyd670e0aec1bd" - ``` - - - - -```json title="Результат" -{ - "fileId": "I000b9oIbxV4CRazpAottg670571601bd", - "msgId": "7423464243690735899", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Resend-voice.mdx b/docs/ru/md/VKTeams/Message-sending/Resend-voice.mdx new file mode 100644 index 0000000000..361602c1ae --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Resend-voice.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Переслать голосовое сообщение + Отправляет ранее загруженное голосовое сообщение по ID + + + +`Функция ПереслатьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач IDФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | IDФайла | --fileid | Строка, Число | ID Файла голосового сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + IDФайла = "I000bzdU0pRaLPRFQ42mv6670d55531bd"; + + Результат = OPI_VKTeams.ПереслатьГолосовоеСообщение(Токен, IDЧата, IDФайла); +``` + + + + + + ```bash + oint vkteams ПереслатьГолосовоеСообщение --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" \ + --fileid "I000bde2Hh0irg0qrY9Cyd670e0aec1bd" + ``` + + + + ```batch + oint vkteams ПереслатьГолосовоеСообщение ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" ^ + --fileid "I000bde2Hh0irg0qrY9Cyd670e0aec1bd" + ``` + + + + +```json title="Результат" +{ + "fileId": "I000b9oIbxV4CRazpAottg670571601bd", + "msgId": "7423464243690735899", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Send-file.md b/docs/ru/md/VKTeams/Message-sending/Send-file.md deleted file mode 100644 index f36365997d..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Send-file.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Отправить файл - Отправляет файл в чат - - - -`Функция ОтправитьФайл(Знач Токен, Знач IDЧата, Знач Файл, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | - | Текст | --text | Строка | Подпись к файлу | - | ИмяФайла | --filename | Строка | Отображаемое имя файла | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - Текст = "Подпись к файлу"; - - Файл = "https://api.athenaeum.digital/test_data/document.docx"; // URL - ФайлПуть = ПолучитьИмяВременногоФайла("docx"); // Путь - - КопироватьФайл(Файл, ФайлПуть); - - ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные - - Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, Файл); - - Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, ФайлПуть, Текст); - - Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, ФайлДД, Текст, "ВажныйДокумент.docx"); -``` - - - - - - ```bash - oint vkteams ОтправитьФайл --token "***" \ - --chatid "AoLI0egLWBSLR1Ngn2w" \ - --file C:\Users\Administrator\AppData\Local\Temp\2ezls2afywa.tmp \ - --text "Подпись к файлу" \ - --filename "ВажныйДокумент.docx" - ``` - - - - ```batch - oint vkteams ОтправитьФайл ^ - --token "***" ^ - --chatid "AoLI0egLWBSLR1Ngn2w" ^ - --file C:\Users\Administrator\AppData\Local\Temp\2ezls2afywa.tmp ^ - --text "Подпись к файлу" ^ - --filename "ВажныйДокумент.docx" - ``` - - - - -```json title="Результат" -{ - "fileId": "kqNCDmWzJuzZn6ZHS9b5Yq6705714e1bd", - "msgId": "7423464140611520793", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Send-file.mdx b/docs/ru/md/VKTeams/Message-sending/Send-file.mdx new file mode 100644 index 0000000000..3e30db7c17 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Send-file.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Отправить файл + Отправляет файл в чат + + + +`Функция ОтправитьФайл(Знач Токен, Знач IDЧата, Знач Файл, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | + | Текст | --text | Строка | Подпись к файлу | + | ИмяФайла | --filename | Строка | Отображаемое имя файла | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + Текст = "Подпись к файлу"; + + Файл = "https://api.athenaeum.digital/test_data/document.docx"; // URL + ФайлПуть = ПолучитьИмяВременногоФайла("docx"); // Путь + + КопироватьФайл(Файл, ФайлПуть); + + ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные + + Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, Файл); + + Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, ФайлПуть, Текст); + + Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, ФайлДД, Текст, "ВажныйДокумент.docx"); +``` + + + + + + ```bash + oint vkteams ОтправитьФайл --token "***" \ + --chatid "AoLI0egLWBSLR1Ngn2w" \ + --file C:\Users\Administrator\AppData\Local\Temp\2ezls2afywa.tmp \ + --text "Подпись к файлу" \ + --filename "ВажныйДокумент.docx" + ``` + + + + ```batch + oint vkteams ОтправитьФайл ^ + --token "***" ^ + --chatid "AoLI0egLWBSLR1Ngn2w" ^ + --file C:\Users\Administrator\AppData\Local\Temp\2ezls2afywa.tmp ^ + --text "Подпись к файлу" ^ + --filename "ВажныйДокумент.docx" + ``` + + + + +```json title="Результат" +{ + "fileId": "kqNCDmWzJuzZn6ZHS9b5Yq6705714e1bd", + "msgId": "7423464140611520793", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Send-text-message.md b/docs/ru/md/VKTeams/Message-sending/Send-text-message.md deleted file mode 100644 index 8720b26086..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Send-text-message.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Отправить текстовое сообщение - Отправляет текстовое сообщение в чат - - - -`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач IDЦитируемого = 0, Знач Клавиатура = "", Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | Текст | --text | Строка | Текст сообщения | - | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | - | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] - - Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - Текст = "Текст сообщения"; - - Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); - - IDЧата = "689203963@chat.agent"; - IDЦитируемого = "7425684917876428136"; - Текст = "Полужирный текст сообщения"; - Разметка = "HTML"; - - Клавиатура = Новый Массив; - МассивСтрокиКнопок = Новый Массив; - - МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка1", "НажатиеКнопки1", , "attention")); - - МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка2", , "https://openintegrations.dev")); - - Клавиатура.Добавить(МассивСтрокиКнопок); - Клавиатура.Добавить(МассивСтрокиКнопок); - - Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст, IDЦитируемого, Клавиатура, Разметка); -``` - - - - - - ```bash - oint vkteams ОтправитьТекстовоеСообщение --token "***" \ - --chatid "689203963@chat.agent" \ - --text "Полужирный текст сообщения" \ - --reply "7425730916976168326" \ - --keyboard "[[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}],[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}]]" \ - --parsemod "HTML" - ``` - - - - ```batch - oint vkteams ОтправитьТекстовоеСообщение ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --text "Полужирный текст сообщения" ^ - --reply "7425730916976168326" ^ - --keyboard "[[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}],[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}]]" ^ - --parsemod "HTML" - ``` - - - - -```json title="Результат" -{ - "msgId": "7423463955927927814", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Send-text-message.mdx b/docs/ru/md/VKTeams/Message-sending/Send-text-message.mdx new file mode 100644 index 0000000000..7fa9ad956e --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Send-text-message.mdx @@ -0,0 +1,95 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат + + + +`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач IDЦитируемого = 0, Знач Клавиатура = "", Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | Текст | --text | Строка | Текст сообщения | + | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | + | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] + + Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + Текст = "Текст сообщения"; + + Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); + + IDЧата = "689203963@chat.agent"; + IDЦитируемого = "7425684917876428136"; + Текст = "Полужирный текст сообщения"; + Разметка = "HTML"; + + Клавиатура = Новый Массив; + МассивСтрокиКнопок = Новый Массив; + + МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка1", "НажатиеКнопки1", , "attention")); + + МассивСтрокиКнопок.Добавить(OPI_VKTeams.СформироватьКнопкуДействия("Кнопка2", , "https://openintegrations.dev")); + + Клавиатура.Добавить(МассивСтрокиКнопок); + Клавиатура.Добавить(МассивСтрокиКнопок); + + Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст, IDЦитируемого, Клавиатура, Разметка); +``` + + + + + + ```bash + oint vkteams ОтправитьТекстовоеСообщение --token "***" \ + --chatid "689203963@chat.agent" \ + --text "Полужирный текст сообщения" \ + --reply "7425730916976168326" \ + --keyboard "[[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}],[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}]]" \ + --parsemod "HTML" + ``` + + + + ```batch + oint vkteams ОтправитьТекстовоеСообщение ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --text "Полужирный текст сообщения" ^ + --reply "7425730916976168326" ^ + --keyboard "[[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}],[{'text':'Кнопка1','callbackData':'НажатиеКнопки1','style':'attention'},{'text':'Кнопка2','url':'https://openintegrations.dev','style':'base'}]]" ^ + --parsemod "HTML" + ``` + + + + +```json title="Результат" +{ + "msgId": "7423463955927927814", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Send-voice.md b/docs/ru/md/VKTeams/Message-sending/Send-voice.md deleted file mode 100644 index 972291832c..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Send-voice.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Отправить голосовое сообщение - Отправляет аудиофайл в качестве голосового сообщения - - - -`Функция ОтправитьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач Файл, Знач ТипФайла = "m4a", Знач IDЦитируемого = 0, Знач Клавиатура = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | - | ТипФайла | --type | Строка | Тип аудиофайла: aac, ogg или m4a | - | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | - | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Если вы хотите, чтобы клиент отображал этот файл как воспроизводимое голосовое сообщение, он должен быть в формате aac, ogg или m4a - - Метод в документации API: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDЦитируемого = "7425684917876428136"; - - Файл = "https://api.athenaeum.digital/test_data/song.m4a" ; // URL - ФайлПуть = ПолучитьИмяВременногоФайла("m4a"); // Путь - - КопироватьФайл(Файл, ФайлПуть); - - ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные - - Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, Файл); - - Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, ФайлПуть, ,IDЦитируемого); - - Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, ФайлДД); -``` - - - - - - ```bash - oint vkteams ОтправитьГолосовоеСообщение --token "***" \ - --chatid "689203963@chat.agent" \ - --file "C:\Users\Administrator\AppData\Local\Temp\sthvkyzxuce.m4a" \ - --reply "7425884578021117348" - ``` - - - - ```batch - oint vkteams ОтправитьГолосовоеСообщение ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --file "C:\Users\Administrator\AppData\Local\Temp\sthvkyzxuce.m4a" ^ - --reply "7425884578021117348" - ``` - - - - -```json title="Результат" -{ - "fileId": "I000b9oIbxV4CRazpAottg670571601bd", - "msgId": "7423464222215900180", - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Send-voice.mdx b/docs/ru/md/VKTeams/Message-sending/Send-voice.mdx new file mode 100644 index 0000000000..6427247978 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Send-voice.mdx @@ -0,0 +1,86 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Отправить голосовое сообщение + Отправляет аудиофайл в качестве голосового сообщения + + + +`Функция ОтправитьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач Файл, Знач ТипФайла = "m4a", Знач IDЦитируемого = 0, Знач Клавиатура = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | + | ТипФайла | --type | Строка | Тип аудиофайла: aac, ogg или m4a | + | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | + | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Если вы хотите, чтобы клиент отображал этот файл как воспроизводимое голосовое сообщение, он должен быть в формате aac, ogg или m4a + + Метод в документации API: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDЦитируемого = "7425684917876428136"; + + Файл = "https://api.athenaeum.digital/test_data/song.m4a" ; // URL + ФайлПуть = ПолучитьИмяВременногоФайла("m4a"); // Путь + + КопироватьФайл(Файл, ФайлПуть); + + ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные + + Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, Файл); + + Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, ФайлПуть, ,IDЦитируемого); + + Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, ФайлДД); +``` + + + + + + ```bash + oint vkteams ОтправитьГолосовоеСообщение --token "***" \ + --chatid "689203963@chat.agent" \ + --file "C:\Users\Administrator\AppData\Local\Temp\sthvkyzxuce.m4a" \ + --reply "7425884578021117348" + ``` + + + + ```batch + oint vkteams ОтправитьГолосовоеСообщение ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --file "C:\Users\Administrator\AppData\Local\Temp\sthvkyzxuce.m4a" ^ + --reply "7425884578021117348" + ``` + + + + +```json title="Результат" +{ + "fileId": "I000b9oIbxV4CRazpAottg670571601bd", + "msgId": "7423464222215900180", + "ok": true +} +``` diff --git a/docs/ru/md/VKTeams/Message-sending/Unpin-message.md b/docs/ru/md/VKTeams/Message-sending/Unpin-message.md deleted file mode 100644 index 9cfaeda8b5..0000000000 --- a/docs/ru/md/VKTeams/Message-sending/Unpin-message.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Открепить сообщение - Открепляет ранее закрепленное сообщение в чате - - - -`Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата | - | IDСообщения | --messageid | Строка, Число | ID сообщения для открепления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Для вызова этого метода бот должен быть администратором в чате - - Метод в документации API: [GET /chats/unpinMessage](https://teams.vk.com/botapi/#/chats/get_chats_unpinMessage) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDСообщения = "7425684917876428136"; - - Результат = OPI_VKTeams.ОткрепитьСообщение(Токен, IDЧата, IDСообщения); -``` - - - - - - ```bash - oint vkteams ОткрепитьСообщение --token "***" \ - --chatid "689203963@chat.agent" \ - --messageid "7425884578021117348" - ``` - - - - ```batch - oint vkteams ОткрепитьСообщение ^ - --token "***" ^ - --chatid "689203963@chat.agent" ^ - --messageid "7425884578021117348" - ``` - - - - -```json title="Результат" -{ - "ok": true -} -``` diff --git a/docs/ru/md/VKTeams/Message-sending/Unpin-message.mdx b/docs/ru/md/VKTeams/Message-sending/Unpin-message.mdx new file mode 100644 index 0000000000..73277a6978 --- /dev/null +++ b/docs/ru/md/VKTeams/Message-sending/Unpin-message.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Открепить сообщение + Открепляет ранее закрепленное сообщение в чате + + + +`Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | IDСообщения | --messageid | Строка, Число | ID сообщения для открепления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Для вызова этого метода бот должен быть администратором в чате + + Метод в документации API: [GET /chats/unpinMessage](https://teams.vk.com/botapi/#/chats/get_chats_unpinMessage) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDСообщения = "7425684917876428136"; + + Результат = OPI_VKTeams.ОткрепитьСообщение(Токен, IDЧата, IDСообщения); +``` + + + + + + ```bash + oint vkteams ОткрепитьСообщение --token "***" \ + --chatid "689203963@chat.agent" \ + --messageid "7425884578021117348" + ``` + + + + ```batch + oint vkteams ОткрепитьСообщение ^ + --token "***" ^ + --chatid "689203963@chat.agent" ^ + --messageid "7425884578021117348" + ``` + + + + +```json title="Результат" +{ + "ok": true +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md b/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md deleted file mode 100644 index c8638008f0..0000000000 --- a/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Сформировать клавиатуру из массива кнопок - Возвращает структура клавиатуры для сообщений - - - -`Функция СформироватьКлавиатуруИзМассиваКнопок(Знач МассивКнопок, Знач ЦветКнопок = "#2db9b9") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | - | ЦветКнопок | --color | Строка | HEX цвет кнопок с # в начале | - - - Возвращаемое значение: Структура - Сформировать клавиатуру из массива кнопок: - - -
- - - - -```bsl title="Пример кода" - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Кнопка 1"); - МассивКнопок.Добавить("Кнопка 2"); - МассивКнопок.Добавить("Кнопка 3"); - - Результат = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); -``` - - - - - - ```bash - oint viber СформироватьКлавиатуруИзМассиваКнопок --buttons "['Кнопка 1','Кнопка 2','Кнопка 3']" - ``` - - - - ```batch - oint viber СформироватьКлавиатуруИзМассиваКнопок ^ - --buttons "['Кнопка 1','Кнопка 2','Кнопка 3']" - ``` - - - - -```json title="Результат" -{ - "Buttons": [ - { - "ActionType": "reply", - "ActionBody": "Кнопка 1", - "Text": "Кнопка 1", - "BgColor": "#2db9b9", - "Coloumns": 3 - }, - { - "ActionType": "reply", - "ActionBody": "Кнопка 2", - "Text": "Кнопка 2", - "BgColor": "#2db9b9", - "Coloumns": 3 - }, - { - "ActionType": "reply", - "ActionBody": "Кнопка 3", - "Text": "Кнопка 3", - "BgColor": "#2db9b9", - "Coloumns": 3 - } - ], - "Type": "keyboard" -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.mdx b/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.mdx new file mode 100644 index 0000000000..f1b41980c0 --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Сформировать клавиатуру из массива кнопок + Возвращает структура клавиатуры для сообщений + + + +`Функция СформироватьКлавиатуруИзМассиваКнопок(Знач МассивКнопок, Знач ЦветКнопок = "#2db9b9") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | + | ЦветКнопок | --color | Строка | HEX цвет кнопок с # в начале | + + + Возвращаемое значение: Структура - Сформировать клавиатуру из массива кнопок: + + +
+ + + + +```bsl title="Пример кода" + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Кнопка 1"); + МассивКнопок.Добавить("Кнопка 2"); + МассивКнопок.Добавить("Кнопка 3"); + + Результат = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); +``` + + + + + + ```bash + oint viber СформироватьКлавиатуруИзМассиваКнопок --buttons "['Кнопка 1','Кнопка 2','Кнопка 3']" + ``` + + + + ```batch + oint viber СформироватьКлавиатуруИзМассиваКнопок ^ + --buttons "['Кнопка 1','Кнопка 2','Кнопка 3']" + ``` + + + + +```json title="Результат" +{ + "Buttons": [ + { + "ActionType": "reply", + "ActionBody": "Кнопка 1", + "Text": "Кнопка 1", + "BgColor": "#2db9b9", + "Coloumns": 3 + }, + { + "ActionType": "reply", + "ActionBody": "Кнопка 2", + "Text": "Кнопка 2", + "BgColor": "#2db9b9", + "Coloumns": 3 + }, + { + "ActionType": "reply", + "ActionBody": "Кнопка 3", + "Text": "Кнопка 3", + "BgColor": "#2db9b9", + "Coloumns": 3 + } + ], + "Type": "keyboard" +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-contact.md b/docs/ru/md/Viber/Message-sending/Send-contact.md deleted file mode 100644 index 82291a8a81..0000000000 --- a/docs/ru/md/Viber/Message-sending/Send-contact.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Отправить контакт - Отправляет контакт с номером телефона в чат или канал - - - -`Функция ОтправитьКонтакт(Знач Токен, Знач ИмяКонтакта, Знач НомерТелефона, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИмяКонтакта | --name | Строка | Имя контакта | - | НомерТелефона | --phone | Строка | Номер телефона | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Имя = "Петр Петров"; - Телефон = "+123456789"; - - IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; - Токен = "523b5b25ed27e6ec-fdf013e4..."; - ОтправкаВКанал = Ложь; - - Результат = OPI_Viber.ОтправитьКонтакт(Токен, Имя, Телефон, IDПользователя, ОтправкаВКанал); - - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - Токен = "523b58ba82afffaa-7ef3b426..."; - ОтправкаВКанал = Истина; - - Результат = OPI_Viber.ОтправитьКонтакт(Токен, Имя, Телефон, IDПользователя, ОтправкаВКанал); -``` - - - - - - ```bash - oint viber ОтправитьКонтакт --token "***" \ - --name "Петр Петров" \ - --phone "+123456789" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" \ - --ischannel true - ``` - - - - ```batch - oint viber ОтправитьКонтакт ^ - --token "***" ^ - --name "Петр Петров" ^ - --phone "+123456789" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" ^ - --ischannel true - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024493507725909542, - "chat_hostname": "SN-CHAT-08_", - "billing_status": 3 -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Send-contact.mdx b/docs/ru/md/Viber/Message-sending/Send-contact.mdx new file mode 100644 index 0000000000..763b50e4bd --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Send-contact.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Отправить контакт + Отправляет контакт с номером телефона в чат или канал + + + +`Функция ОтправитьКонтакт(Знач Токен, Знач ИмяКонтакта, Знач НомерТелефона, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяКонтакта | --name | Строка | Имя контакта | + | НомерТелефона | --phone | Строка | Номер телефона | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Имя = "Петр Петров"; + Телефон = "+123456789"; + + IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; + Токен = "523b5b25ed27e6ec-fdf013e4..."; + ОтправкаВКанал = Ложь; + + Результат = OPI_Viber.ОтправитьКонтакт(Токен, Имя, Телефон, IDПользователя, ОтправкаВКанал); + + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + Токен = "523b58ba82afffaa-7ef3b426..."; + ОтправкаВКанал = Истина; + + Результат = OPI_Viber.ОтправитьКонтакт(Токен, Имя, Телефон, IDПользователя, ОтправкаВКанал); +``` + + + + + + ```bash + oint viber ОтправитьКонтакт --token "***" \ + --name "Петр Петров" \ + --phone "+123456789" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" \ + --ischannel true + ``` + + + + ```batch + oint viber ОтправитьКонтакт ^ + --token "***" ^ + --name "Петр Петров" ^ + --phone "+123456789" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" ^ + --ischannel true + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024493507725909542, + "chat_hostname": "SN-CHAT-08_", + "billing_status": 3 +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-file.md b/docs/ru/md/Viber/Message-sending/Send-file.md deleted file mode 100644 index cf15b78ebd..0000000000 --- a/docs/ru/md/Viber/Message-sending/Send-file.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Отправить файл - Отправляет файл (документ) в чат или канал - - - -`Функция ОтправитьФайл(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Расширение, Знач Размер = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --file | Строка | URL файла | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - | Расширение | --ext | Строка | Расширение файла | - | Размер | --size | Число | Размер файла. Если не заполнен > определяется автоматически скачиванием файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Расширение = "docx"; - URL = "https://api.athenaeum.digital/test_data/document.docx"; - - IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; - Токен = "523b5b25ed27e6ec-fdf013e4..."; - ОтправкаВКанал = Ложь; - - Результат = OPI_Viber.ОтправитьФайл(Токен, URL, IDПользователя, ОтправкаВКанал, Расширение); - - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - Токен = "523b58ba82afffaa-7ef3b426..."; - ОтправкаВКанал = Истина; - - Результат = OPI_Viber.ОтправитьФайл(Токен, URL, IDПользователя, ОтправкаВКанал, Расширение); -``` - - - - - - ```bash - oint viber ОтправитьФайл --token "***" \ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" \ - --ischannel true \ - --ext "docx" - ``` - - - - ```batch - oint viber ОтправитьФайл ^ - --token "***" ^ - --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" ^ - --ischannel true ^ - --ext "docx" - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024493484262966074, - "chat_hostname": "SN-CHAT-01_", - "billing_status": 3 -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Send-file.mdx b/docs/ru/md/Viber/Message-sending/Send-file.mdx new file mode 100644 index 0000000000..cc29081e79 --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Send-file.mdx @@ -0,0 +1,83 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Отправить файл + Отправляет файл (документ) в чат или канал + + + +`Функция ОтправитьФайл(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Расширение, Знач Размер = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --file | Строка | URL файла | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + | Расширение | --ext | Строка | Расширение файла | + | Размер | --size | Число | Размер файла. Если не заполнен > определяется автоматически скачиванием файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Расширение = "docx"; + URL = "https://api.athenaeum.digital/test_data/document.docx"; + + IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; + Токен = "523b5b25ed27e6ec-fdf013e4..."; + ОтправкаВКанал = Ложь; + + Результат = OPI_Viber.ОтправитьФайл(Токен, URL, IDПользователя, ОтправкаВКанал, Расширение); + + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + Токен = "523b58ba82afffaa-7ef3b426..."; + ОтправкаВКанал = Истина; + + Результат = OPI_Viber.ОтправитьФайл(Токен, URL, IDПользователя, ОтправкаВКанал, Расширение); +``` + + + + + + ```bash + oint viber ОтправитьФайл --token "***" \ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" \ + --ischannel true \ + --ext "docx" + ``` + + + + ```batch + oint viber ОтправитьФайл ^ + --token "***" ^ + --file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" ^ + --ischannel true ^ + --ext "docx" + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024493484262966074, + "chat_hostname": "SN-CHAT-01_", + "billing_status": 3 +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-image.md b/docs/ru/md/Viber/Message-sending/Send-image.md deleted file mode 100644 index e2b805002f..0000000000 --- a/docs/ru/md/Viber/Message-sending/Send-image.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Отправить картинку - Отправляет картинку в чат или канал - - - -`Функция ОтправитьКартинку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Описание = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --picture | Строка | URL картинки | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | булево | Отправка в канал или в чат бота | - | Описание | --description | Строка | Аннотация к картинке | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Описание = "Тестовое сообщение"; - URL = "https://api.athenaeum.digital/test_data/picture.jpg"; - - IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; - Токен = "523b5b25ed27e6ec-fdf013e4..."; - ОтправкаВКанал = Ложь; - - Результат = OPI_Viber.ОтправитьКартинку(Токен, URL, IDПользователя, ОтправкаВКанал, Описание); - - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - Токен = "523b58ba82afffaa-7ef3b426..."; - ОтправкаВКанал = Истина; - - Результат = OPI_Viber.ОтправитьКартинку(Токен, URL, IDПользователя, ОтправкаВКанал, Описание); -``` - - - - - - ```bash - oint viber ОтправитьКартинку --token "***" \ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" \ - --ischannel true \ - --description "Тестовое сообщение" - ``` - - - - ```batch - oint viber ОтправитьКартинку ^ - --token "***" ^ - --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" ^ - --ischannel true ^ - --description "Тестовое сообщение" - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024493458589634249, - "chat_hostname": "SN-CHAT-04_", - "billing_status": 3 -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Send-image.mdx b/docs/ru/md/Viber/Message-sending/Send-image.mdx new file mode 100644 index 0000000000..eb43d234b4 --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Send-image.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Отправить картинку + Отправляет картинку в чат или канал + + + +`Функция ОтправитьКартинку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Описание = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --picture | Строка | URL картинки | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | булево | Отправка в канал или в чат бота | + | Описание | --description | Строка | Аннотация к картинке | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Описание = "Тестовое сообщение"; + URL = "https://api.athenaeum.digital/test_data/picture.jpg"; + + IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; + Токен = "523b5b25ed27e6ec-fdf013e4..."; + ОтправкаВКанал = Ложь; + + Результат = OPI_Viber.ОтправитьКартинку(Токен, URL, IDПользователя, ОтправкаВКанал, Описание); + + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + Токен = "523b58ba82afffaa-7ef3b426..."; + ОтправкаВКанал = Истина; + + Результат = OPI_Viber.ОтправитьКартинку(Токен, URL, IDПользователя, ОтправкаВКанал, Описание); +``` + + + + + + ```bash + oint viber ОтправитьКартинку --token "***" \ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" \ + --ischannel true \ + --description "Тестовое сообщение" + ``` + + + + ```batch + oint viber ОтправитьКартинку ^ + --token "***" ^ + --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" ^ + --ischannel true ^ + --description "Тестовое сообщение" + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024493458589634249, + "chat_hostname": "SN-CHAT-04_", + "billing_status": 3 +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-link.md b/docs/ru/md/Viber/Message-sending/Send-link.md deleted file mode 100644 index 9d4a9bb76e..0000000000 --- a/docs/ru/md/Viber/Message-sending/Send-link.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Отправить ссылку - Отправляет URL с предпросмотром в чат или канал - - - -`Функция ОтправитьСсылку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Отправляемая ссылка | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; - Токен = "523b5b25ed27e6ec-fdf013e4..."; - ОтправкаВКанал = Ложь; - - Результат = OPI_Viber.ОтправитьСсылку(Токен, URL, IDПользователя, ОтправкаВКанал); - - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - Токен = "523b58ba82afffaa-7ef3b426..."; - ОтправкаВКанал = Истина; - - Результат = OPI_Viber.ОтправитьСсылку(Токен, URL, IDПользователя, ОтправкаВКанал); -``` - - - - - - ```bash - oint viber ОтправитьСсылку --token "***" \ - --url "https://github.com/Bayselonarrend/OpenIntegrations" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" \ - --ischannel true - ``` - - - - ```batch - oint viber ОтправитьСсылку ^ - --token "***" ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" ^ - --ischannel true - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024493557554233637, - "chat_hostname": "SN-CHAT-01_", - "billing_status": 3 -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Send-link.mdx b/docs/ru/md/Viber/Message-sending/Send-link.mdx new file mode 100644 index 0000000000..2d60263f1d --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Send-link.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Отправить ссылку + Отправляет URL с предпросмотром в чат или канал + + + +`Функция ОтправитьСсылку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Отправляемая ссылка | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; + Токен = "523b5b25ed27e6ec-fdf013e4..."; + ОтправкаВКанал = Ложь; + + Результат = OPI_Viber.ОтправитьСсылку(Токен, URL, IDПользователя, ОтправкаВКанал); + + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + Токен = "523b58ba82afffaa-7ef3b426..."; + ОтправкаВКанал = Истина; + + Результат = OPI_Viber.ОтправитьСсылку(Токен, URL, IDПользователя, ОтправкаВКанал); +``` + + + + + + ```bash + oint viber ОтправитьСсылку --token "***" \ + --url "https://github.com/Bayselonarrend/OpenIntegrations" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" \ + --ischannel true + ``` + + + + ```batch + oint viber ОтправитьСсылку ^ + --token "***" ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" ^ + --ischannel true + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024493557554233637, + "chat_hostname": "SN-CHAT-01_", + "billing_status": 3 +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-location.md b/docs/ru/md/Viber/Message-sending/Send-location.md deleted file mode 100644 index 2342a66fed..0000000000 --- a/docs/ru/md/Viber/Message-sending/Send-location.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Отправить локацию - Отправляет географические координаты в чат или канал - - - -`Функция ОтправитьЛокацию(Знач Токен, Знач Широта, Знач Долгота, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Широта | --lat | Строка,Число | Географическая широта | - | Долгота | --long | Строка,Число | Географическая долгота | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Широта = "48.87373649724122"; - Долгота = "2.2954639195323967"; - - IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; - Токен = "523b5b25ed27e6ec-fdf013e4..."; - ОтправкаВКанал = Ложь; - - Результат = OPI_Viber.ОтправитьЛокацию(Токен, Широта, Долгота, IDПользователя, ОтправкаВКанал); - - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - Токен = "523b58ba82afffaa-7ef3b426..."; - ОтправкаВКанал = Истина; - - Результат = OPI_Viber.ОтправитьЛокацию(Токен, Широта, Долгота, IDПользователя, ОтправкаВКанал); -``` - - - - - - ```bash - oint viber ОтправитьЛокацию --token "***" \ - --lat "48.87373649724122" \ - --long "2.2954639195323967" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" \ - --ischannel true - ``` - - - - ```batch - oint viber ОтправитьЛокацию ^ - --token "***" ^ - --lat "48.87373649724122" ^ - --long "2.2954639195323967" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" ^ - --ischannel true - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024493531369195564, - "chat_hostname": "SN-CHAT-03_", - "billing_status": 3 -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Send-location.mdx b/docs/ru/md/Viber/Message-sending/Send-location.mdx new file mode 100644 index 0000000000..fae37d1f18 --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Send-location.mdx @@ -0,0 +1,82 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Отправить локацию + Отправляет географические координаты в чат или канал + + + +`Функция ОтправитьЛокацию(Знач Токен, Знач Широта, Знач Долгота, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Широта | --lat | Строка,Число | Географическая широта | + | Долгота | --long | Строка,Число | Географическая долгота | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Широта = "48.87373649724122"; + Долгота = "2.2954639195323967"; + + IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; + Токен = "523b5b25ed27e6ec-fdf013e4..."; + ОтправкаВКанал = Ложь; + + Результат = OPI_Viber.ОтправитьЛокацию(Токен, Широта, Долгота, IDПользователя, ОтправкаВКанал); + + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + Токен = "523b58ba82afffaa-7ef3b426..."; + ОтправкаВКанал = Истина; + + Результат = OPI_Viber.ОтправитьЛокацию(Токен, Широта, Долгота, IDПользователя, ОтправкаВКанал); +``` + + + + + + ```bash + oint viber ОтправитьЛокацию --token "***" \ + --lat "48.87373649724122" \ + --long "2.2954639195323967" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" \ + --ischannel true + ``` + + + + ```batch + oint viber ОтправитьЛокацию ^ + --token "***" ^ + --lat "48.87373649724122" ^ + --long "2.2954639195323967" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" ^ + --ischannel true + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024493531369195564, + "chat_hostname": "SN-CHAT-03_", + "billing_status": 3 +} +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-text-message.md b/docs/ru/md/Viber/Message-sending/Send-text-message.md deleted file mode 100644 index 957a2bb8f7..0000000000 --- a/docs/ru/md/Viber/Message-sending/Send-text-message.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Отправить текстовое сообщение - Отправляет текстовое сообщение в чат или канал - - - -`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач Текст, Знач IDПользователя, Знач ОтправкаВКанал, Знач Клавиатура = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Текст | --text | Строка | Текст сообщения | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - | Клавиатура | --keyboard | Структура из Строка | См. СформироватьКлавиатуруИзМассиваКнопок | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Текст = "Тестовое сообщение"; - - IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; - Токен = "523b5b25ed27e6ec-fdf013e4..."; - ОтправкаВКанал = Ложь; - - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Кнопка 1"); - МассивКнопок.Добавить("Кнопка 2"); - МассивКнопок.Добавить("Кнопка 3"); - - Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); - - Результат = OPI_Viber.ОтправитьТекстовоеСообщение(Токен, Текст, IDПользователя, ОтправкаВКанал, Клавиатура); - - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - Токен = "523b58ba82afffaa-7ef3b426..."; - ОтправкаВКанал = Истина; - - Результат = OPI_Viber.ОтправитьТекстовоеСообщение(Токен, Текст, IDПользователя, ОтправкаВКанал, Клавиатура); -``` - - - - - - ```bash - oint viber ОтправитьТекстовоеСообщение --token "***" \ - --text "Тестовое сообщение" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" \ - --ischannel true \ - --keyboard "{'Buttons':[{'ActionType':'reply','ActionBody':'Кнопка 1','Text':'Кнопка 1','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 2','Text':'Кнопка 2','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 3','Text':'Кнопка 3','BgColor':'#2db9b9','Coloumns':3}],'Type':'keyboard'}" - ``` - - - - ```batch - oint viber ОтправитьТекстовоеСообщение ^ - --token "***" ^ - --text "Тестовое сообщение" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" ^ - --ischannel true ^ - --keyboard "{'Buttons':[{'ActionType':'reply','ActionBody':'Кнопка 1','Text':'Кнопка 1','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 2','Text':'Кнопка 2','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 3','Text':'Кнопка 3','BgColor':'#2db9b9','Coloumns':3}],'Type':'keyboard'}" - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "message_token": 6024493435357382925, - "chat_hostname": "SN-CHAT-03_", - "billing_status": 3 -} -``` diff --git a/docs/ru/md/Viber/Message-sending/Send-text-message.mdx b/docs/ru/md/Viber/Message-sending/Send-text-message.mdx new file mode 100644 index 0000000000..68aea9e568 --- /dev/null +++ b/docs/ru/md/Viber/Message-sending/Send-text-message.mdx @@ -0,0 +1,88 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат или канал + + + +`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач Текст, Знач IDПользователя, Знач ОтправкаВКанал, Знач Клавиатура = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Текст | --text | Строка | Текст сообщения | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + | Клавиатура | --keyboard | Структура из Строка | См. СформироватьКлавиатуруИзМассиваКнопок | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Текст = "Тестовое сообщение"; + + IDПользователя = "d3jxe61Z4W73nmNkjYGgZg=="; + Токен = "523b5b25ed27e6ec-fdf013e4..."; + ОтправкаВКанал = Ложь; + + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Кнопка 1"); + МассивКнопок.Добавить("Кнопка 2"); + МассивКнопок.Добавить("Кнопка 3"); + + Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); + + Результат = OPI_Viber.ОтправитьТекстовоеСообщение(Токен, Текст, IDПользователя, ОтправкаВКанал, Клавиатура); + + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + Токен = "523b58ba82afffaa-7ef3b426..."; + ОтправкаВКанал = Истина; + + Результат = OPI_Viber.ОтправитьТекстовоеСообщение(Токен, Текст, IDПользователя, ОтправкаВКанал, Клавиатура); +``` + + + + + + ```bash + oint viber ОтправитьТекстовоеСообщение --token "***" \ + --text "Тестовое сообщение" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" \ + --ischannel true \ + --keyboard "{'Buttons':[{'ActionType':'reply','ActionBody':'Кнопка 1','Text':'Кнопка 1','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 2','Text':'Кнопка 2','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 3','Text':'Кнопка 3','BgColor':'#2db9b9','Coloumns':3}],'Type':'keyboard'}" + ``` + + + + ```batch + oint viber ОтправитьТекстовоеСообщение ^ + --token "***" ^ + --text "Тестовое сообщение" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" ^ + --ischannel true ^ + --keyboard "{'Buttons':[{'ActionType':'reply','ActionBody':'Кнопка 1','Text':'Кнопка 1','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 2','Text':'Кнопка 2','BgColor':'#2db9b9','Coloumns':3},{'ActionType':'reply','ActionBody':'Кнопка 3','Text':'Кнопка 3','BgColor':'#2db9b9','Coloumns':3}],'Type':'keyboard'}" + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "message_token": 6024493435357382925, + "chat_hostname": "SN-CHAT-03_", + "billing_status": 3 +} +``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md b/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md deleted file mode 100644 index bc5afd5248..0000000000 --- a/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Получить информацию о канале -Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook ID пользователя из информации о канале не подойдет для отправки сообщений через бота - они разные - - - -`Функция ПолучитьИнформациюОКанале(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Токен = "523b58ba82afffaa-7ef3b426..."; - Результат = OPI_Viber.ПолучитьИнформациюОКанале(Токен); -``` - - - - - - ```bash - oint viber ПолучитьИнформациюОКанале --token "***" - ``` - - - - ```batch - oint viber ПолучитьИнформациюОКанале ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "id": "pa:5925427292815753130", - "chat_hostname": "SN-CHAT-05_", - "name": "1C Test", - "members": [ - { - "id": "tMNGhftyUPrB3r1lD+bT4g==", - "name": "John", - "role": "superadmin" - } - ] -} -``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-channel-information.mdx b/docs/ru/md/Viber/Settings-and-information/Get-channel-information.mdx new file mode 100644 index 0000000000..e776b28258 --- /dev/null +++ b/docs/ru/md/Viber/Settings-and-information/Get-channel-information.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Получить информацию о канале +Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook ID пользователя из информации о канале не подойдет для отправки сообщений через бота - они разные + + + +`Функция ПолучитьИнформациюОКанале(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Токен = "523b58ba82afffaa-7ef3b426..."; + Результат = OPI_Viber.ПолучитьИнформациюОКанале(Токен); +``` + + + + + + ```bash + oint viber ПолучитьИнформациюОКанале --token "***" + ``` + + + + ```batch + oint viber ПолучитьИнформациюОКанале ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "id": "pa:5925427292815753130", + "chat_hostname": "SN-CHAT-05_", + "name": "1C Test", + "members": [ + { + "id": "tMNGhftyUPrB3r1lD+bT4g==", + "name": "John", + "role": "superadmin" + } + ] +} +``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-online-users.md b/docs/ru/md/Viber/Settings-and-information/Get-online-users.md deleted file mode 100644 index 6e53a847ec..0000000000 --- a/docs/ru/md/Viber/Settings-and-information/Get-online-users.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить онлайн пользователей - Получает статус пользователя или нескольких пользователей по ID - - - -`Функция ПолучитьОнлайнПользователей(Знач Токен, Знач IDПользователей) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен Viber | - | IDПользователей | --users | Строка,Число,Массив из Строка,Число | ID пользователей(я) Viber | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Токен = "523b58ba82afffaa-7ef3b426..."; - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - - Результат = OPI_Viber.ПолучитьОнлайнПользователей(Токен, IDПользователя); -``` - - - - - - ```bash - oint viber ПолучитьОнлайнПользователей --token "***" \ - --users "tMNGhftyUPrB3r1lD+bT4g==" - ``` - - - - ```batch - oint viber ПолучитьОнлайнПользователей ^ - --token "***" ^ - --users "tMNGhftyUPrB3r1lD+bT4g==" - ``` - - - - -```json title="Результат" -{ - "status": 0, - "status_message": "ok", - "users": [ - { - "id": "tMNGhftyUPrB3r1lD+bT4g==", - "online_status": 4, - "online_status_message": "unavailable", - "last_online": 0 - } - ] -} -``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-online-users.mdx b/docs/ru/md/Viber/Settings-and-information/Get-online-users.mdx new file mode 100644 index 0000000000..5ff29b9d6f --- /dev/null +++ b/docs/ru/md/Viber/Settings-and-information/Get-online-users.mdx @@ -0,0 +1,68 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить онлайн пользователей + Получает статус пользователя или нескольких пользователей по ID + + + +`Функция ПолучитьОнлайнПользователей(Знач Токен, Знач IDПользователей) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен Viber | + | IDПользователей | --users | Строка,Число,Массив из Строка,Число | ID пользователей(я) Viber | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Токен = "523b58ba82afffaa-7ef3b426..."; + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + + Результат = OPI_Viber.ПолучитьОнлайнПользователей(Токен, IDПользователя); +``` + + + + + + ```bash + oint viber ПолучитьОнлайнПользователей --token "***" \ + --users "tMNGhftyUPrB3r1lD+bT4g==" + ``` + + + + ```batch + oint viber ПолучитьОнлайнПользователей ^ + --token "***" ^ + --users "tMNGhftyUPrB3r1lD+bT4g==" + ``` + + + + +```json title="Результат" +{ + "status": 0, + "status_message": "ok", + "users": [ + { + "id": "tMNGhftyUPrB3r1lD+bT4g==", + "online_status": 4, + "online_status_message": "unavailable", + "last_online": 0 + } + ] +} +``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-user-data.md b/docs/ru/md/Viber/Settings-and-information/Get-user-data.md deleted file mode 100644 index 4726fb6a5b..0000000000 --- a/docs/ru/md/Viber/Settings-and-information/Get-user-data.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить данные пользователя - Получает информацию о пользователе по ID - - - -`Функция ПолучитьДанныеПользователя(Знач Токен, Знач IDПользователя) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDПользователя | --user | Строка, Число | ID пользователя Viber | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Токен = "523b58ba82afffaa-7ef3b426..."; - IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; - - Результат = OPI_Viber.ПолучитьДанныеПользователя(Токен, IDПользователя); -``` - - - - - - ```bash - oint viber ПолучитьДанныеПользователя --token "***" \ - --user "tMNGhftyUPrB3r1lD+bT4g==" - ``` - - - - ```batch - oint viber ПолучитьДанныеПользователя ^ - --token "***" ^ - --user "tMNGhftyUPrB3r1lD+bT4g==" - ``` - - - - -```json title="Результат" -{ - "status": 6, - "status_message": "notSubscribed", - "chat_hostname": "SN-CHAT-03_" -} -``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-user-data.mdx b/docs/ru/md/Viber/Settings-and-information/Get-user-data.mdx new file mode 100644 index 0000000000..7d65ea6fb6 --- /dev/null +++ b/docs/ru/md/Viber/Settings-and-information/Get-user-data.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить данные пользователя + Получает информацию о пользователе по ID + + + +`Функция ПолучитьДанныеПользователя(Знач Токен, Знач IDПользователя) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПользователя | --user | Строка, Число | ID пользователя Viber | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Токен = "523b58ba82afffaa-7ef3b426..."; + IDПользователя = "tMNGhftyUPrB3r1lD+bT4g=="; + + Результат = OPI_Viber.ПолучитьДанныеПользователя(Токен, IDПользователя); +``` + + + + + + ```bash + oint viber ПолучитьДанныеПользователя --token "***" \ + --user "tMNGhftyUPrB3r1lD+bT4g==" + ``` + + + + ```batch + oint viber ПолучитьДанныеПользователя ^ + --token "***" ^ + --user "tMNGhftyUPrB3r1lD+bT4g==" + ``` + + + + +```json title="Результат" +{ + "status": 6, + "status_message": "notSubscribed", + "chat_hostname": "SN-CHAT-03_" +} +``` diff --git a/docs/ru/md/Viber/Settings-and-information/Set-webhook.md b/docs/ru/md/Viber/Settings-and-information/Set-webhook.md deleted file mode 100644 index 95a3dc1643..0000000000 --- a/docs/ru/md/Viber/Settings-and-information/Set-webhook.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Установить Webhook -ВАЖНО: Установка Webhook обязательна по правилам Viber. Для этого надо иметь свободный URL, который будет возвращать 200 и подлинный SSL сертификат. Если есть сертификат и база опубликована на сервере - можно использовать http-сервис. Туда же будет приходить и информация о новых сообщениях Viber периодически стучит по адресу Webhook, так что если он будет неактивен, то все перестанет работать - - - -`Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен Viber | - | URL | --url | Строка | URL для установки Webhook | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -
- - - - -```bsl title="Пример кода" - Токен = "523b58ba82afffaa-7ef3b426..."; - URL = "http://api.athenaeum.digital/hs/viber"; - - Результат = OPI_Viber.УстановитьWebhook(Токен, URL); -``` - - - - - - ```bash - oint viber УстановитьWebhook --token "***" \ - --url "http://api.athenaeum.digital/hs/viber" - ``` - - - - ```batch - oint viber УстановитьWebhook ^ - --token "***" ^ - --url "http://api.athenaeum.digital/hs/viber" - ``` - - - - -```json title="Результат" -{ - "status": 1, - "status_message": "URL not valid or not HTTPS", - "chat_hostname": "SN-CHAT-01_" -} -``` diff --git a/docs/ru/md/Viber/Settings-and-information/Set-webhook.mdx b/docs/ru/md/Viber/Settings-and-information/Set-webhook.mdx new file mode 100644 index 0000000000..8bedbc713e --- /dev/null +++ b/docs/ru/md/Viber/Settings-and-information/Set-webhook.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Установить Webhook +ВАЖНО: Установка Webhook обязательна по правилам Viber. Для этого надо иметь свободный URL, который будет возвращать 200 и подлинный SSL сертификат. Если есть сертификат и база опубликована на сервере - можно использовать http-сервис. Туда же будет приходить и информация о новых сообщениях Viber периодически стучит по адресу Webhook, так что если он будет неактивен, то все перестанет работать + + + +`Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен Viber | + | URL | --url | Строка | URL для установки Webhook | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +
+ + + + +```bsl title="Пример кода" + Токен = "523b58ba82afffaa-7ef3b426..."; + URL = "http://api.athenaeum.digital/hs/viber"; + + Результат = OPI_Viber.УстановитьWebhook(Токен, URL); +``` + + + + + + ```bash + oint viber УстановитьWebhook --token "***" \ + --url "http://api.athenaeum.digital/hs/viber" + ``` + + + + ```batch + oint viber УстановитьWebhook ^ + --token "***" ^ + --url "http://api.athenaeum.digital/hs/viber" + ``` + + + + +```json title="Результат" +{ + "status": 1, + "status_message": "URL not valid or not HTTPS", + "chat_hostname": "SN-CHAT-01_" +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md deleted file mode 100644 index a735ecb376..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Создать папку - Создает каталог на диске - - - -`Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к созаваемой папке | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/" + Строка(Новый УникальныйИдентификатор); - - Результат = OPI_YandexDisk.СоздатьПапку(Токен, Путь); -``` - - - - - - ```bash - oint yadisk СоздатьПапку --token "***" \ - --path "/86370596-5581-42c8-8f28-b656625dd450" - ``` - - - - ```batch - oint yadisk СоздатьПапку ^ - --token "***" ^ - --path "/86370596-5581-42c8-8f28-b656625dd450" - ``` - - - - -```json title="Результат" -{ - "_embedded": { - "sort": "", - "items": [], - "limit": 20, - "offset": 0, - "path": "disk:/e422cffd-fe43-4f0d-8854-b240e020678c", - "total": 0 - }, - "name": "e422cffd-fe43-4f0d-8854-b240e020678c", - "exif": {}, - "resource_id": "1573541518:2ac953f1aae933a16a37a5bc21259e31be9d53633aab0c2fbc267d249a8897cf", - "created": "2024-10-08T20:36:28+03:00", - "modified": "2024-10-08T20:36:28+03:00", - "path": "disk:/e422cffd-fe43-4f0d-8854-b240e020678c", - "comment_ids": { - "private_resource": "1573541518:2ac953f1aae933a16a37a5bc21259e31be9d53633aab0c2fbc267d249a8897cf", - "public_resource": "1573541518:2ac953f1aae933a16a37a5bc21259e31be9d53633aab0c2fbc267d249a8897cf" - }, - "type": "dir", - "revision": 1728408988944976 -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.mdx new file mode 100644 index 0000000000..0e08b07f0d --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.mdx @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Создать папку + Создает каталог на диске + + + +`Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к созаваемой папке | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/" + Строка(Новый УникальныйИдентификатор); + + Результат = OPI_YandexDisk.СоздатьПапку(Токен, Путь); +``` + + + + + + ```bash + oint yadisk СоздатьПапку --token "***" \ + --path "/86370596-5581-42c8-8f28-b656625dd450" + ``` + + + + ```batch + oint yadisk СоздатьПапку ^ + --token "***" ^ + --path "/86370596-5581-42c8-8f28-b656625dd450" + ``` + + + + +```json title="Результат" +{ + "_embedded": { + "sort": "", + "items": [], + "limit": 20, + "offset": 0, + "path": "disk:/e422cffd-fe43-4f0d-8854-b240e020678c", + "total": 0 + }, + "name": "e422cffd-fe43-4f0d-8854-b240e020678c", + "exif": {}, + "resource_id": "1573541518:2ac953f1aae933a16a37a5bc21259e31be9d53633aab0c2fbc267d249a8897cf", + "created": "2024-10-08T20:36:28+03:00", + "modified": "2024-10-08T20:36:28+03:00", + "path": "disk:/e422cffd-fe43-4f0d-8854-b240e020678c", + "comment_ids": { + "private_resource": "1573541518:2ac953f1aae933a16a37a5bc21259e31be9d53633aab0c2fbc267d249a8897cf", + "public_resource": "1573541518:2ac953f1aae933a16a37a5bc21259e31be9d53633aab0c2fbc267d249a8897cf" + }, + "type": "dir", + "revision": 1728408988944976 +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md deleted file mode 100644 index dd72bae9fd..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Создать копию объекта - Создает копию объекта по заданному пути и пути к оригиналу - - - -`Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Оригинал | --from | Строка | Путь к оригинальному файлу или каталогу | - | Путь | --to | Строка | Путь назначения для копии | - | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Оригинал = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - Путь = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; - - Результат = OPI_YandexDisk.СоздатьКопиюОбъекта(Токен, Оригинал, Путь, Истина); -``` - - - - - - ```bash - oint yadisk СоздатьКопиюОбъекта --token "***" \ - --from "/a9426fbb-8e40-48c5-ad9f-82b47a8faad1.png" \ - --to "/b3eb9639-b28a-43ca-ba27-ff756234f627.png" \ - --rewrite true - ``` - - - - ```batch - oint yadisk СоздатьКопиюОбъекта ^ - --token "***" ^ - --from "/a9426fbb-8e40-48c5-ad9f-82b47a8faad1.png" ^ - --to "/b3eb9639-b28a-43ca-ba27-ff756234f627.png" ^ - --rewrite true - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:78a00502b73055618006dcdf96af1d8867a982076ecfb35fb57f6e6bd09ac053", - "public_resource": "1573541518:78a00502b73055618006dcdf96af1d8867a982076ecfb35fb57f6e6bd09ac053" - }, - "name": "62d0280f-b17f-47bf-9305-1eac20cec63e.png", - "exif": {}, - "created": "2024-10-08T20:37:45+03:00", - "resource_id": "1573541518:78a00502b73055618006dcdf96af1d8867a982076ecfb35fb57f6e6bd09ac053", - "modified": "2024-10-08T20:37:44+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/134dca3fa4b231f3ad8f586d42d1633a159217bca10bcf3ebff5610ca8a0d776/6705a62a/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=62d0280f-b17f-47bf-9305-1eac20cec63e.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/62d0280f-b17f-47bf-9305-1eac20cec63e.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728409065245429 -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.mdx new file mode 100644 index 0000000000..12ae82cc99 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Создать копию объекта + Создает копию объекта по заданному пути и пути к оригиналу + + + +`Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Оригинал | --from | Строка | Путь к оригинальному файлу или каталогу | + | Путь | --to | Строка | Путь назначения для копии | + | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Оригинал = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + Путь = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; + + Результат = OPI_YandexDisk.СоздатьКопиюОбъекта(Токен, Оригинал, Путь, Истина); +``` + + + + + + ```bash + oint yadisk СоздатьКопиюОбъекта --token "***" \ + --from "/a9426fbb-8e40-48c5-ad9f-82b47a8faad1.png" \ + --to "/b3eb9639-b28a-43ca-ba27-ff756234f627.png" \ + --rewrite true + ``` + + + + ```batch + oint yadisk СоздатьКопиюОбъекта ^ + --token "***" ^ + --from "/a9426fbb-8e40-48c5-ad9f-82b47a8faad1.png" ^ + --to "/b3eb9639-b28a-43ca-ba27-ff756234f627.png" ^ + --rewrite true + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:78a00502b73055618006dcdf96af1d8867a982076ecfb35fb57f6e6bd09ac053", + "public_resource": "1573541518:78a00502b73055618006dcdf96af1d8867a982076ecfb35fb57f6e6bd09ac053" + }, + "name": "62d0280f-b17f-47bf-9305-1eac20cec63e.png", + "exif": {}, + "created": "2024-10-08T20:37:45+03:00", + "resource_id": "1573541518:78a00502b73055618006dcdf96af1d8867a982076ecfb35fb57f6e6bd09ac053", + "modified": "2024-10-08T20:37:44+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/134dca3fa4b231f3ad8f586d42d1633a159217bca10bcf3ebff5610ca8a0d776/6705a62a/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=62d0280f-b17f-47bf-9305-1eac20cec63e.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/62d0280f-b17f-47bf-9305-1eac20cec63e.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728409065245429 +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md deleted file mode 100644 index 68dc6e602a..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Удалить объект - Удаляет объект по заданному пути - - - -`Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к удаляемой папке или файлу | - | ВКорзину | --can | Булево | В корзину | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/b3327332-137b-454c-be37-06cff128756c.png"; - - Результат = OPI_YandexDisk.УдалитьОбъект(Токен, Путь, Ложь); -``` - - - - - - ```bash - oint yadisk УдалитьОбъект --token "***" \ - --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" \ - --can false - ``` - - - - ```batch - oint yadisk УдалитьОбъект ^ - --token "***" ^ - --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" ^ - --can false - ``` - - - - -```json title="Результат" -null -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.mdx new file mode 100644 index 0000000000..bdbb249252 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.mdx @@ -0,0 +1,60 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Удалить объект + Удаляет объект по заданному пути + + + +`Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к удаляемой папке или файлу | + | ВКорзину | --can | Булево | В корзину | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/b3327332-137b-454c-be37-06cff128756c.png"; + + Результат = OPI_YandexDisk.УдалитьОбъект(Токен, Путь, Ложь); +``` + + + + + + ```bash + oint yadisk УдалитьОбъект --token "***" \ + --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" \ + --can false + ``` + + + + ```batch + oint yadisk УдалитьОбъект ^ + --token "***" ^ + --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" ^ + --can false + ``` + + + + +```json title="Результат" +null +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md deleted file mode 100644 index f1dd924a9a..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 7 ---- - -# Скачать файл - Скачивает файл по указанному пути - - - -`Функция СкачатьФайл(Знач Токен, Знач Путь, Знач ПутьСохранения = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к файлу для скачивания | - | ПутьСохранения | --out | Строка | Путь сохранения файла | - - - Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; - - Результат = OPI_YandexDisk.СкачатьФайл(Токен, Путь); -``` - - - - - - ```bash - oint yadisk СкачатьФайл --token "***" \ - --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" - ``` - - - - ```batch - oint yadisk СкачатьФайл ^ - --token "***" ^ - --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" - ``` - - - - -```json title="Результат" -НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.mdx new file mode 100644 index 0000000000..13371aa10c --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.mdx @@ -0,0 +1,58 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 7 +--- + +# Скачать файл + Скачивает файл по указанному пути + + + +`Функция СкачатьФайл(Знач Токен, Знач Путь, Знач ПутьСохранения = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к файлу для скачивания | + | ПутьСохранения | --out | Строка | Путь сохранения файла | + + + Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; + + Результат = OPI_YandexDisk.СкачатьФайл(Токен, Путь); +``` + + + + + + ```bash + oint yadisk СкачатьФайл --token "***" \ + --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" + ``` + + + + ```batch + oint yadisk СкачатьФайл ^ + --token "***" ^ + --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" + ``` + + + + +```json title="Результат" +НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md deleted file mode 100644 index ffb7a22938..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о диске - Получает информацию о текущем диске - - - -`Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Результат = OPI_YandexDisk.ПолучитьИнформациюОДиске(Токен); -``` - - - - - - ```bash - oint yadisk ПолучитьИнформациюОДиске --token "***" - ``` - - - - ```batch - oint yadisk ПолучитьИнформациюОДиске ^ - --token "***" - ``` - - - - -```json title="Результат" -{ - "max_file_size": 1073741824, - "paid_max_file_size": 53687091200, - "total_space": 5368709120, - "reg_time": "2024-02-01T15:13:41+03:00", - "trash_size": 0, - "is_paid": false, - "is_idm_managed_folder_address_access": false, - "used_space": 821720258, - "system_folders": { - "odnoklassniki": "disk:/Социальные сети/Одноклассники", - "google": "disk:/Социальные сети/Google+", - "instagram": "disk:/Социальные сети/Instagram", - "vkontakte": "disk:/Социальные сети/ВКонтакте", - "attach": "disk:/Почтовые вложения", - "mailru": "disk:/Социальные сети/Мой Мир", - "downloads": "disk:/Загрузки/", - "applications": "disk:/Приложения", - "facebook": "disk:/Социальные сети/Facebook", - "social": "disk:/Социальные сети/", - "messenger": "disk:/Файлы Мессенджера", - "calendar": "disk:/Материалы встреч", - "scans": "disk:/Сканы", - "screenshots": "disk:/Скриншоты/", - "photostream": "disk:/Фотокамера/" - }, - "user": { - "reg_time": "2024-02-01T15:13:41+03:00", - "display_name": "bayselonarrend", - "uid": "1573541518", - "country": "by", - "is_child": false, - "login": "bayselonarrend" - }, - "is_idm_managed_public_access": false, - "payment_flow": true, - "unlimited_autoupload_enabled": false, - "revision": 1728328585901186 -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.mdx new file mode 100644 index 0000000000..f3d43dc333 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.mdx @@ -0,0 +1,90 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Получить информацию о диске + Получает информацию о текущем диске + + + +`Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Результат = OPI_YandexDisk.ПолучитьИнформациюОДиске(Токен); +``` + + + + + + ```bash + oint yadisk ПолучитьИнформациюОДиске --token "***" + ``` + + + + ```batch + oint yadisk ПолучитьИнформациюОДиске ^ + --token "***" + ``` + + + + +```json title="Результат" +{ + "max_file_size": 1073741824, + "paid_max_file_size": 53687091200, + "total_space": 5368709120, + "reg_time": "2024-02-01T15:13:41+03:00", + "trash_size": 0, + "is_paid": false, + "is_idm_managed_folder_address_access": false, + "used_space": 821720258, + "system_folders": { + "odnoklassniki": "disk:/Социальные сети/Одноклассники", + "google": "disk:/Социальные сети/Google+", + "instagram": "disk:/Социальные сети/Instagram", + "vkontakte": "disk:/Социальные сети/ВКонтакте", + "attach": "disk:/Почтовые вложения", + "mailru": "disk:/Социальные сети/Мой Мир", + "downloads": "disk:/Загрузки/", + "applications": "disk:/Приложения", + "facebook": "disk:/Социальные сети/Facebook", + "social": "disk:/Социальные сети/", + "messenger": "disk:/Файлы Мессенджера", + "calendar": "disk:/Материалы встреч", + "scans": "disk:/Сканы", + "screenshots": "disk:/Скриншоты/", + "photostream": "disk:/Фотокамера/" + }, + "user": { + "reg_time": "2024-02-01T15:13:41+03:00", + "display_name": "bayselonarrend", + "uid": "1573541518", + "country": "by", + "is_child": false, + "login": "bayselonarrend" + }, + "is_idm_managed_public_access": false, + "payment_flow": true, + "unlimited_autoupload_enabled": false, + "revision": 1728328585901186 +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md deleted file mode 100644 index d906352e64..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Получить ссылку для скачивания - Получает ссылку для скачивания файла - - - -`Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к файлу для скачивания | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; - - Результат = OPI_YandexDisk.ПолучитьСсылкуДляСкачивания(Токен, Путь); -``` - - - - - - ```bash - oint yadisk ПолучитьСсылкуДляСкачивания --token "***" \ - --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" - ``` - - - - ```batch - oint yadisk ПолучитьСсылкуДляСкачивания ^ - --token "***" ^ - --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" - ``` - - - - -```json title="Результат" -{ - "href": "https://downloader.disk.yandex.ru/disk/dd238bf4fdd879d13c37dc6b404e14c84ab2186704d640ce6e8213a30318e641/6705a64e/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=6605347b-a937-40bd-9d48-b1d480048e0d.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "method": "GET", - "templated": false -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.mdx new file mode 100644 index 0000000000..0ccd1be844 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.mdx @@ -0,0 +1,61 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Получить ссылку для скачивания + Получает ссылку для скачивания файла + + + +`Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к файлу для скачивания | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/3971b158-4a89-4050-8150-1497befa9c9b.png"; + + Результат = OPI_YandexDisk.ПолучитьСсылкуДляСкачивания(Токен, Путь); +``` + + + + + + ```bash + oint yadisk ПолучитьСсылкуДляСкачивания --token "***" \ + --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" + ``` + + + + ```batch + oint yadisk ПолучитьСсылкуДляСкачивания ^ + --token "***" ^ + --path "/19f0da08-92c2-44b6-97c0-35732788e82d.png" + ``` + + + + +```json title="Результат" +{ + "href": "https://downloader.disk.yandex.ru/disk/dd238bf4fdd879d13c37dc6b404e14c84ab2186704d640ce6e8213a30318e641/6705a64e/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=6605347b-a937-40bd-9d48-b1d480048e0d.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "method": "GET", + "templated": false +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md deleted file mode 100644 index fc5cb5efcf..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -sidebar_position: 8 ---- - -# Получить список файлов -Получает список файлов с или без отбора по типу Список доступных типов: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, mage, settings, spreadsheet, text, unknown, video, web - - - -`Функция ПолучитьСписокФайлов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0, Знач ОтборПоТипу = "", Знач СортироватьПоДате = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Количество | --amount | Число,Строка | Количество возвращаемых объектов | - | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | - | ОтборПоТипу | --type | Строка | Отбор по типу файла | - | СортироватьПоДате | --datesort | Булево | Истина > сортировать по дате, Ложь > по алфавиту | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Количество = 2; - СмещениеОтНачала = 1; - ОтборПоТипу = "image"; - - Результат = OPI_YandexDisk.ПолучитьСписокФайлов(Токен, Количество, СмещениеОтНачала, ОтборПоТипу); -``` - - - - - - ```bash - oint yadisk ПолучитьСписокФайлов --token "***" \ - --amount 2 \ - --offset 1 \ - --type "image" - ``` - - - - ```batch - oint yadisk ПолучитьСписокФайлов ^ - --token "***" ^ - --amount 2 ^ - --offset 1 ^ - --type "image" - ``` - - - - -```json title="Результат" -{ - "items": [ - { - "antivirus_status": "clean", - "size": 943229, - "comment_ids": { - "private_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", - "public_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2" - }, - "name": "3.png", - "exif": {}, - "created": "2024-02-10T13:58:14+03:00", - "resource_id": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", - "modified": "2024-02-10T13:58:14+03:00", - "mime_type": "multipart", - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/b021ae21fc996c5a3a44886f13944686d2e9d7d7e0fb6ab11f21ff3ae3b8acd2/6705a65d/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/b021ae21fc996c5a3a44886f13944686d2e9d7d7e0fb6ab11f21ff3ae3b8acd2/6705a65d/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/3.png", - "sha256": "7be951c04b6169d0cf9406dbbc916c8c77f2fc2ee3409f4c045098a1ae19e13a", - "type": "file", - "md5": "7036267356255aebb8af32adad2a1261", - "revision": 1707576606183957 - }, - { - "antivirus_status": "clean", - "size": 1555830, - "comment_ids": { - "private_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", - "public_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60" - }, - "name": "Мишки.jpg", - "exif": { - "date_time": "2014-12-13T17:29:24+03:00" - }, - "created": "2024-02-01T15:13:45+03:00", - "resource_id": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", - "modified": "2024-02-10T14:05:03+03:00", - "mime_type": "image/jpeg", - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/3427e772d0830fea80a3fd0cee21d98c7c223f1cba9cacddc35699738a6803b9/6705a65d/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/86322bae705cb8ff1671af2949b43e898fb7cc61fb755c5eeca73d8b10e457f4/6705a65d/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/Тестовая папка/Мишки.jpg", - "sha256": "d76ce57d8abf4e8eafbc7c85cec59a7a7f12b1d603d51e928be4a3fea0f6817c", - "type": "file", - "md5": "569a1c98696050439b5b2a1ecfa52d19", - "revision": 1707563104041868 - } - ], - "limit": 2, -... -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.mdx new file mode 100644 index 0000000000..8d80cdc7e9 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.mdx @@ -0,0 +1,216 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 8 +--- + +# Получить список файлов +Получает список файлов с или без отбора по типу Список доступных типов: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, mage, settings, spreadsheet, text, unknown, video, web + + + +`Функция ПолучитьСписокФайлов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0, Знач ОтборПоТипу = "", Знач СортироватьПоДате = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Количество | --amount | Число,Строка | Количество возвращаемых объектов | + | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | + | ОтборПоТипу | --type | Строка | Отбор по типу файла | + | СортироватьПоДате | --datesort | Булево | Истина > сортировать по дате, Ложь > по алфавиту | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Количество = 2; + СмещениеОтНачала = 1; + ОтборПоТипу = "image"; + + Результат = OPI_YandexDisk.ПолучитьСписокФайлов(Токен, Количество, СмещениеОтНачала, ОтборПоТипу); +``` + + + + + + ```bash + oint yadisk ПолучитьСписокФайлов --token "***" \ + --amount 2 \ + --offset 1 \ + --type "image" + ``` + + + + ```batch + oint yadisk ПолучитьСписокФайлов ^ + --token "***" ^ + --amount 2 ^ + --offset 1 ^ + --type "image" + ``` + + + + +```json title="Результат" +{ + "items": [ + { + "antivirus_status": "clean", + "size": 943229, + "comment_ids": { + "private_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", + "public_resource": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2" + }, + "name": "3.png", + "exif": {}, + "created": "2024-02-10T13:58:14+03:00", + "resource_id": "1573541518:8d5a6c05045c6d30055759ff7e851f0f7399065285d5bb05fa17e4496cf40bb2", + "modified": "2024-02-10T13:58:14+03:00", + "mime_type": "multipart", + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/b021ae21fc996c5a3a44886f13944686d2e9d7d7e0fb6ab11f21ff3ae3b8acd2/6705a65d/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/b021ae21fc996c5a3a44886f13944686d2e9d7d7e0fb6ab11f21ff3ae3b8acd2/6705a65d/gwThwhLBKYvLhQCNnqAHivS6rT4sf9tf_ZJmzmkuDiNdKb0wAuoUZP3xa-RGUkOqgqn8vgvsrYeT6Yzc-yAjmA%3D%3D?uid=1573541518&filename=3.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=943229&hid=200c348630ee4906d2f7ca6ab71c2248&media_type=image&tknv=v2&etag=7036267356255aebb8af32adad2a1261", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/c16d9789f5933632ff4b02b3c11bc3c0d0b652c91e648c2fd44e244f70066c43/inf/BosSAbexHFf60TUoCsdh22Gr_8Es4dtgZ04xvb02xNQsPPW1eMxghoiPy_6bf3JAPKipLfpSpuhNnc9i6XsR2A%3D%3D?uid=1573541518&filename=3.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/3.png", + "sha256": "7be951c04b6169d0cf9406dbbc916c8c77f2fc2ee3409f4c045098a1ae19e13a", + "type": "file", + "md5": "7036267356255aebb8af32adad2a1261", + "revision": 1707576606183957 + }, + { + "antivirus_status": "clean", + "size": 1555830, + "comment_ids": { + "private_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", + "public_resource": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60" + }, + "name": "Мишки.jpg", + "exif": { + "date_time": "2014-12-13T17:29:24+03:00" + }, + "created": "2024-02-01T15:13:45+03:00", + "resource_id": "1573541518:12897a65b076a5a0a92f3033e271eb251764c1e70ba590f383d55c3da7ef8c60", + "modified": "2024-02-10T14:05:03+03:00", + "mime_type": "image/jpeg", + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/3427e772d0830fea80a3fd0cee21d98c7c223f1cba9cacddc35699738a6803b9/6705a65d/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/86322bae705cb8ff1671af2949b43e898fb7cc61fb755c5eeca73d8b10e457f4/6705a65d/YCWwIV93r7kdvdgkpYJf7GJbR3ANcQde87h7hiBT0GgAoFo_n3KO9GXq2HWzSWwrwox97L651eAD93T19uJnow%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1555830&hid=d4562df88a4f7d98d8aa94e30de24c09&media_type=image&tknv=v2&etag=569a1c98696050439b5b2a1ecfa52d19", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/0053f98e5a160a5ac87edf75174e8881491b359379323f8c8325378a7c9c5a85/inf/fwhLIia_-zlk2uITaqxgbGJbR3ANcQde87h7hiBT0GhEI8fhcC9IFRIL8W4OBV0J-yLh1Ds-lBckf41RQO7cPQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%B8%D1%88%D0%BA%D0%B8.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/Тестовая папка/Мишки.jpg", + "sha256": "d76ce57d8abf4e8eafbc7c85cec59a7a7f12b1d603d51e928be4a3fea0f6817c", + "type": "file", + "md5": "569a1c98696050439b5b2a1ecfa52d19", + "revision": 1707563104041868 + } + ], + "limit": 2, +... +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md deleted file mode 100644 index d4a49e338f..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить объект - Получает информацию об объекте диска по заданному пути - - - -`Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к папке или файлу | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/b3327332-137b-454c-be37-06cff128756c.png"; - - Результат = OPI_YandexDisk.ПолучитьОбъект(Токен, Путь); -``` - - - - - - ```bash - oint yadisk ПолучитьОбъект --token "***" \ - --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" - ``` - - - - ```batch - oint yadisk ПолучитьОбъект ^ - --token "***" ^ - --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:fa61a4f9382d790a5dbe60113da64fa17557010c70d38c9bad93e9d7b03a0344", - "public_resource": "1573541518:fa61a4f9382d790a5dbe60113da64fa17557010c70d38c9bad93e9d7b03a0344" - }, - "name": "51524c09-f1a8-43a2-b630-0a7eddb59bad.png", - "exif": {}, - "created": "2024-10-08T20:36:40+03:00", - "resource_id": "1573541518:fa61a4f9382d790a5dbe60113da64fa17557010c70d38c9bad93e9d7b03a0344", - "modified": "2024-10-08T20:36:40+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/6679def59da6c17cd0711c44ea050414aa05b8a200f14f59c5ef70e1f20673bb/6705a5ec/gwThwhLBKYvLhQCNnqAHiuK8Ahrq5JWEM2INP0-LokTQTU0YuDY1w93ExosczTWq3ALOfQvG7DeHbaEMV-uPlg%3D%3D?uid=1573541518&filename=51524c09-f1a8-43a2-b630-0a7eddb59bad.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/51524c09-f1a8-43a2-b630-0a7eddb59bad.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728409001059933 -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.mdx new file mode 100644 index 0000000000..7ae8819d48 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить объект + Получает информацию об объекте диска по заданному пути + + + +`Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к папке или файлу | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/b3327332-137b-454c-be37-06cff128756c.png"; + + Результат = OPI_YandexDisk.ПолучитьОбъект(Токен, Путь); +``` + + + + + + ```bash + oint yadisk ПолучитьОбъект --token "***" \ + --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" + ``` + + + + ```batch + oint yadisk ПолучитьОбъект ^ + --token "***" ^ + --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:fa61a4f9382d790a5dbe60113da64fa17557010c70d38c9bad93e9d7b03a0344", + "public_resource": "1573541518:fa61a4f9382d790a5dbe60113da64fa17557010c70d38c9bad93e9d7b03a0344" + }, + "name": "51524c09-f1a8-43a2-b630-0a7eddb59bad.png", + "exif": {}, + "created": "2024-10-08T20:36:40+03:00", + "resource_id": "1573541518:fa61a4f9382d790a5dbe60113da64fa17557010c70d38c9bad93e9d7b03a0344", + "modified": "2024-10-08T20:36:40+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/6679def59da6c17cd0711c44ea050414aa05b8a200f14f59c5ef70e1f20673bb/6705a5ec/gwThwhLBKYvLhQCNnqAHiuK8Ahrq5JWEM2INP0-LokTQTU0YuDY1w93ExosczTWq3ALOfQvG7DeHbaEMV-uPlg%3D%3D?uid=1573541518&filename=51524c09-f1a8-43a2-b630-0a7eddb59bad.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/51524c09-f1a8-43a2-b630-0a7eddb59bad.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728409001059933 +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md deleted file mode 100644 index cd2b230b94..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -sidebar_position: 9 ---- - -# Переместить объект - Перемещает объект по заданному пути и пути к оригиналу - - - -`Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Оригинал | --from | Строка | Путь к оригинальному файлу или папке | - | Путь | --to | Строка | Путь назначение для перемещения | - | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Оригинал = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - Путь = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; - - Результат = OPI_YandexDisk.ПереместитьОбъект(Токен, Оригинал, Путь, Истина); -``` - - - - - - ```bash - oint yadisk ПереместитьОбъект --token "***" \ - --from "/00f77d2e-c416-4bb1-9bef-d04c9e6c7c9f.png" \ - --to "/f3267ec4-db71-4316-88a4-ee7d1dfa5bb3.png" \ - --rewrite true - ``` - - - - ```batch - oint yadisk ПереместитьОбъект ^ - --token "***" ^ - --from "/00f77d2e-c416-4bb1-9bef-d04c9e6c7c9f.png" ^ - --to "/f3267ec4-db71-4316-88a4-ee7d1dfa5bb3.png" ^ - --rewrite true - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:3118f85db2c52d63f46739f577b98e05246dde4586b4ab1cc0e24dd78d620f05", - "public_resource": "1573541518:3118f85db2c52d63f46739f577b98e05246dde4586b4ab1cc0e24dd78d620f05" - }, - "name": "8c8186aa-c5cf-48ce-b708-9414a656b3c5.png", - "exif": {}, - "created": "2024-10-08T20:38:47+03:00", - "resource_id": "1573541518:3118f85db2c52d63f46739f577b98e05246dde4586b4ab1cc0e24dd78d620f05", - "modified": "2024-10-08T20:39:07+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/9208eb610a8ebc365afcea9f3804f32bc9f0ee3ca14862dae8921832b46aaa15/6705a67c/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=8c8186aa-c5cf-48ce-b708-9414a656b3c5.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/8c8186aa-c5cf-48ce-b708-9414a656b3c5.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728409147932226 -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.mdx new file mode 100644 index 0000000000..a16c66255b --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.mdx @@ -0,0 +1,84 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 9 +--- + +# Переместить объект + Перемещает объект по заданному пути и пути к оригиналу + + + +`Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Оригинал | --from | Строка | Путь к оригинальному файлу или папке | + | Путь | --to | Строка | Путь назначение для перемещения | + | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Оригинал = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + Путь = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; + + Результат = OPI_YandexDisk.ПереместитьОбъект(Токен, Оригинал, Путь, Истина); +``` + + + + + + ```bash + oint yadisk ПереместитьОбъект --token "***" \ + --from "/00f77d2e-c416-4bb1-9bef-d04c9e6c7c9f.png" \ + --to "/f3267ec4-db71-4316-88a4-ee7d1dfa5bb3.png" \ + --rewrite true + ``` + + + + ```batch + oint yadisk ПереместитьОбъект ^ + --token "***" ^ + --from "/00f77d2e-c416-4bb1-9bef-d04c9e6c7c9f.png" ^ + --to "/f3267ec4-db71-4316-88a4-ee7d1dfa5bb3.png" ^ + --rewrite true + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:3118f85db2c52d63f46739f577b98e05246dde4586b4ab1cc0e24dd78d620f05", + "public_resource": "1573541518:3118f85db2c52d63f46739f577b98e05246dde4586b4ab1cc0e24dd78d620f05" + }, + "name": "8c8186aa-c5cf-48ce-b708-9414a656b3c5.png", + "exif": {}, + "created": "2024-10-08T20:38:47+03:00", + "resource_id": "1573541518:3118f85db2c52d63f46739f577b98e05246dde4586b4ab1cc0e24dd78d620f05", + "modified": "2024-10-08T20:39:07+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/9208eb610a8ebc365afcea9f3804f32bc9f0ee3ca14862dae8921832b46aaa15/6705a67c/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=8c8186aa-c5cf-48ce-b708-9414a656b3c5.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/8c8186aa-c5cf-48ce-b708-9414a656b3c5.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728409147932226 +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md deleted file mode 100644 index 22f1e6c7b7..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_position: 11 ---- - -# Загрузить файл по URL - Загружает файл на диск, забирая его по заданному URL - - - -`Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь помещения загруженного файла | - | Адрес | --url | Строка | URL файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Адрес = "https://api.athenaeum.digital/test_data/picture.jpg"; - Путь = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; - - Результат = OPI_YandexDisk.ЗагрузитьФайлПоURL(Токен, Путь, Адрес); -``` - - - - - - ```bash - oint yadisk ЗагрузитьФайлПоURL --token "***" \ - --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" \ - --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - ``` - - - - ```batch - oint yadisk ЗагрузитьФайлПоURL ^ - --token "***" ^ - --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" ^ - --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" - ``` - - - - -```json title="Результат" -{ - "href": "https://cloud-api.yandex.net/v1/disk/operations/520264c4fc3c8e9ae87085c0d12fc77767c13fc7f11582ea5aac37756d3f823f", - "method": "GET", - "templated": false -} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.mdx new file mode 100644 index 0000000000..49f213ba6a --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.mdx @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 11 +--- + +# Загрузить файл по URL + Загружает файл на диск, забирая его по заданному URL + + + +`Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь помещения загруженного файла | + | Адрес | --url | Строка | URL файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Адрес = "https://api.athenaeum.digital/test_data/picture.jpg"; + Путь = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; + + Результат = OPI_YandexDisk.ЗагрузитьФайлПоURL(Токен, Путь, Адрес); +``` + + + + + + ```bash + oint yadisk ЗагрузитьФайлПоURL --token "***" \ + --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" \ + --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + ``` + + + + ```batch + oint yadisk ЗагрузитьФайлПоURL ^ + --token "***" ^ + --path "/c46d08de-5793-45c2-88c8-4cef86e5f487.png" ^ + --url "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" + ``` + + + + +```json title="Результат" +{ + "href": "https://cloud-api.yandex.net/v1/disk/operations/520264c4fc3c8e9ae87085c0d12fc77767c13fc7f11582ea5aac37756d3f823f", + "method": "GET", + "templated": false +} +``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md deleted file mode 100644 index ab32fff3d8..0000000000 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -sidebar_position: 10 ---- - -# Загрузить файл - Загружает файл на диск по заданному пути - - - -`Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь для сохранение файла на Диске | - | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | - | Перезаписывать | --rewrite | Булево | Перезаписывать, если файл с таким именем уже существует | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Путь1 = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; - Путь2 = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; - - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL - - ИВФ = ПолучитьИмяВременногоФайла("png"); // Путь - КопироватьФайл(Картинка, ИВФ); - - Результат = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь1, Картинка, Истина); - - Результат = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь2, ИВФ, Истина); -``` - - - - - - ```bash - oint yadisk ЗагрузитьФайл --token "***" \ - --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" \ - --file "C:\Users\Administrator\AppData\Local\Temp\w5swc4j5i1g.png" \ - --rewrite true - ``` - - - - ```batch - oint yadisk ЗагрузитьФайл ^ - --token "***" ^ - --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" ^ - --file "C:\Users\Administrator\AppData\Local\Temp\w5swc4j5i1g.png" ^ - --rewrite true - ``` - - - - -```json title="Результат" -{} -``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.mdx b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.mdx new file mode 100644 index 0000000000..3f863d2c04 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.mdx @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 10 +--- + +# Загрузить файл + Загружает файл на диск по заданному пути + + + +`Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь для сохранение файла на Диске | + | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | + | Перезаписывать | --rewrite | Булево | Перезаписывать, если файл с таким именем уже существует | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Путь1 = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; + Путь2 = "/" + Строка(Новый УникальныйИдентификатор) + ".png"; + + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Картинка = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL + + ИВФ = ПолучитьИмяВременногоФайла("png"); // Путь + КопироватьФайл(Картинка, ИВФ); + + Результат = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь1, Картинка, Истина); + + Результат = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь2, ИВФ, Истина); +``` + + + + + + ```bash + oint yadisk ЗагрузитьФайл --token "***" \ + --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" \ + --file "C:\Users\Administrator\AppData\Local\Temp\w5swc4j5i1g.png" \ + --rewrite true + ``` + + + + ```batch + oint yadisk ЗагрузитьФайл ^ + --token "***" ^ + --path "/4f1954c8-c1db-4fd5-810d-bc0042ea7c3b.png" ^ + --file "C:\Users\Administrator\AppData\Local\Temp\w5swc4j5i1g.png" ^ + --rewrite true + ``` + + + + +```json title="Результат" +{} +``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md deleted file mode 100644 index 04df4d2d77..0000000000 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Отменить публикацию объекта - Отменяет публикацию ранее опубликованного объекта - - - -`Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к опубликованному ранее объекту | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - - Результат = OPI_YandexDisk.ОтменитьПубликациюОбъекта(Токен, Путь); -``` - - - - - - ```bash - oint yadisk ОтменитьПубликациюОбъекта --token "***" \ - --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" - ``` - - - - ```batch - oint yadisk ОтменитьПубликациюОбъекта ^ - --token "***" ^ - --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", - "public_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e" - }, - "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png", - "exif": {}, - "created": "2024-10-08T20:39:25+03:00", - "resource_id": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", - "modified": "2024-10-08T20:39:25+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/df86c73f4f1b371ed5f12cbc011b1804415c80ca25a3eec12dddc883794034fa/6705a6a4/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/95934d00-67ef-43eb-a306-73a490a0aac0.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728409188091257 -} -``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.mdx b/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.mdx new file mode 100644 index 0000000000..a56fe8d3ae --- /dev/null +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.mdx @@ -0,0 +1,77 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 2 +--- + +# Отменить публикацию объекта + Отменяет публикацию ранее опубликованного объекта + + + +`Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к опубликованному ранее объекту | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + + Результат = OPI_YandexDisk.ОтменитьПубликациюОбъекта(Токен, Путь); +``` + + + + + + ```bash + oint yadisk ОтменитьПубликациюОбъекта --token "***" \ + --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" + ``` + + + + ```batch + oint yadisk ОтменитьПубликациюОбъекта ^ + --token "***" ^ + --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", + "public_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e" + }, + "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png", + "exif": {}, + "created": "2024-10-08T20:39:25+03:00", + "resource_id": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", + "modified": "2024-10-08T20:39:25+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/df86c73f4f1b371ed5f12cbc011b1804415c80ca25a3eec12dddc883794034fa/6705a6a4/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/95934d00-67ef-43eb-a306-73a490a0aac0.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728409188091257 +} +``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md deleted file mode 100644 index 7b1f75ad0f..0000000000 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Получить ссылку скачивания публичного объекта - Получает прямую ссылку для скачивания публичного объекта - - - -`Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Адрес объекта | - | Путь | --path | Строка | Путь внутри объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; - - Результат = OPI_YandexDisk.ПолучитьСсылкуСкачиванияПубличногоОбъекта(Токен, URL); -``` - - - - - - ```bash - oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта --token "***" \ - --url "https://yadi.sk/d/_GkFflxiflKIKg" - ``` - - - - ```batch - oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта ^ - --token "***" ^ - --url "https://yadi.sk/d/_GkFflxiflKIKg" - ``` - - - - -```json title="Результат" -{ - "href": "https://downloader.disk.yandex.ru/disk/8e95b3a88dc1790aba8ecfc4c6cc1233a175cbfa796b4c58004664dd966be7bb/6705a6a1/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=0&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=fLfKnKmtqPt6TSTumjWC%2BGMkuduPJAnpx5lwlWVVqp8zeDXp5X74XLJ2GbNOAgYIq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2", - "method": "GET", - "templated": false -} -``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.mdx b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.mdx new file mode 100644 index 0000000000..6dba1b3993 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.mdx @@ -0,0 +1,62 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 5 +--- + +# Получить ссылку скачивания публичного объекта + Получает прямую ссылку для скачивания публичного объекта + + + +`Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Путь | --path | Строка | Путь внутри объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; + + Результат = OPI_YandexDisk.ПолучитьСсылкуСкачиванияПубличногоОбъекта(Токен, URL); +``` + + + + + + ```bash + oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта --token "***" \ + --url "https://yadi.sk/d/_GkFflxiflKIKg" + ``` + + + + ```batch + oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта ^ + --token "***" ^ + --url "https://yadi.sk/d/_GkFflxiflKIKg" + ``` + + + + +```json title="Результат" +{ + "href": "https://downloader.disk.yandex.ru/disk/8e95b3a88dc1790aba8ecfc4c6cc1233a175cbfa796b4c58004664dd966be7bb/6705a6a1/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=0&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=fLfKnKmtqPt6TSTumjWC%2BGMkuduPJAnpx5lwlWVVqp8zeDXp5X74XLJ2GbNOAgYIq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2", + "method": "GET", + "templated": false +} +``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md deleted file mode 100644 index 765cf8585c..0000000000 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Получить публичный объект - Получает информацию об опубликованном объекте по его URL - - - -`Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Адрес объекта | - | Количество | --amount | Число | Количество возвращаемых вложенных объектов (для каталога) | - | СмещениеОтНачала | --offset | Число | Смещение для получение вложенных объектов не из начала списка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; - - Результат = OPI_YandexDisk.ПолучитьПубличныйОбъект(Токен, URL); -``` - - - - - - ```bash - oint yadisk ПолучитьПубличныйОбъект --token "***" \ - --url "https://yadi.sk/d/_GkFflxiflKIKg" - ``` - - - - ```batch - oint yadisk ПолучитьПубличныйОбъект ^ - --token "***" ^ - --url "https://yadi.sk/d/_GkFflxiflKIKg" - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "public_key": "fLfKnKmtqPt6TSTumjWC+GMkuduPJAnpx5lwlWVVqp8zeDXp5X74XLJ2GbNOAgYIq/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/d/yOLqz8yUAZeE0g", - "views_count": 0, - "exif": {}, - "created": "2024-10-08T20:39:25+03:00", - "type": "file", - "resource_id": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", - "modified": "2024-10-08T20:39:25+03:00", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", - "public_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e" - }, - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/c4253bc7630c64e30f5623d8e60b4b819746fcba2015fb6af9d08c88edcf5ccd/6705a6a2/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=0&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=0&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "/", - "owner": { - "login": "bayselonarrend", - "display_name": "bayselonarrend", - "uid": "1573541518" - }, - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "revision": 1728409184987250, - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png" -} -``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.mdx b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.mdx new file mode 100644 index 0000000000..895a89d288 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.mdx @@ -0,0 +1,87 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 4 +--- + +# Получить публичный объект + Получает информацию об опубликованном объекте по его URL + + + +`Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Количество | --amount | Число | Количество возвращаемых вложенных объектов (для каталога) | + | СмещениеОтНачала | --offset | Число | Смещение для получение вложенных объектов не из начала списка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; + + Результат = OPI_YandexDisk.ПолучитьПубличныйОбъект(Токен, URL); +``` + + + + + + ```bash + oint yadisk ПолучитьПубличныйОбъект --token "***" \ + --url "https://yadi.sk/d/_GkFflxiflKIKg" + ``` + + + + ```batch + oint yadisk ПолучитьПубличныйОбъект ^ + --token "***" ^ + --url "https://yadi.sk/d/_GkFflxiflKIKg" + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "public_key": "fLfKnKmtqPt6TSTumjWC+GMkuduPJAnpx5lwlWVVqp8zeDXp5X74XLJ2GbNOAgYIq/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/d/yOLqz8yUAZeE0g", + "views_count": 0, + "exif": {}, + "created": "2024-10-08T20:39:25+03:00", + "type": "file", + "resource_id": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", + "modified": "2024-10-08T20:39:25+03:00", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", + "public_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e" + }, + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/c4253bc7630c64e30f5623d8e60b4b819746fcba2015fb6af9d08c88edcf5ccd/6705a6a2/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=0&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=0&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "/", + "owner": { + "login": "bayselonarrend", + "display_name": "bayselonarrend", + "uid": "1573541518" + }, + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "revision": 1728409184987250, + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png" +} +``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md deleted file mode 100644 index 1045f7bd79..0000000000 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Получить список опубликованных объектов. - Получает список опубликованных объектов - - - -`Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Количество | --amount | Число | Количество возвращаемых объектов | - | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Количество = 2; - СмещениеОтНачала = 1; - - Результат = OPI_YandexDisk.ПолучитьСписокОпубликованныхОбъектов(Токен, Количество, СмещениеОтНачала); -``` - - - - - - ```bash - oint yadisk ПолучитьСписокОпубликованныхОбъектов --token "***" \ - --amount 2 \ - --offset 1 - ``` - - - - ```batch - oint yadisk ПолучитьСписокОпубликованныхОбъектов ^ - --token "***" ^ - --amount 2 ^ - --offset 1 - ``` - - - - -```json title="Результат" -{ - "items": [ - { - "antivirus_status": "clean", - "public_key": "lzUqwAcU+PlMrKbzcxhks09qmXiWowXTBvUgesT7NxgPfIAvkNlDx1N5dnN4RI6hq/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/i/Ato4XjVRIb4nVw", - "name": "0b5585af-2bca-43cf-9d3a-decc63db8821.png", - "exif": {}, - "created": "2024-06-02T16:49:58+03:00", - "size": 225883, - "resource_id": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", - "modified": "2024-06-02T16:49:58+03:00", - "mime_type": "image/png", - "comment_ids": { - "private_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", - "public_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f" - }, - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/1a1fc16fc4103d93c26779ac22b890cd9466a47346ec885c5803da7e30eb0688/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/84d39edf249d8df76f966afb50704b11a2173cd053500d72d1a48f5ccfe3c78f/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/0b5585af-2bca-43cf-9d3a-decc63db8821.png", - "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", - "type": "file", - "md5": "403262e03464796e99ff362e913e9a4d", - "revision": 1717336203287577 - }, - { - "antivirus_status": "clean", - "public_key": "MSeNtB4sL4oM/DMiMUqGGdAxiEkFI7EStMcjgb9PMJR2xYUasH+IJFEqziFNXjfRq/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/i/LIWuPUAfQz2AAg", - "name": "0cd21557-08ba-496c-ba35-503833fa5bd6.png", - "exif": {}, - "created": "2024-06-01T19:54:41+03:00", - "size": 225883, - "resource_id": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", - "modified": "2024-06-01T19:54:41+03:00", - "mime_type": "image/png", - "comment_ids": { - "private_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", - "public_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275" - }, - "sizes": [ - { - "url": "https://downloader.disk.yandex.ru/disk/d45d482a0590f7b327f0aad9d22ce754cd00ac522a17b4374898b868a461ad26/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "name": "ORIGINAL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", - "name": "DEFAULT" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", - "name": "XXXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", - "name": "XXS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", - "name": "XS" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "S" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", - "name": "M" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", - "name": "L" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", - "name": "XL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", - "name": "XXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", - "name": "XXXL" - }, - { - "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "name": "C" - } - ], - "file": "https://downloader.disk.yandex.ru/disk/8e0594d4f836d69c3b7fdde029d263f0c3f5e7efd9cab68db82d579947bc0a3c/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", - "media_type": "image", - "preview": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "path": "disk:/0cd21557-08ba-496c-ba35-503833fa5bd6.png", - "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", - "type": "file", - "md5": "403262e03464796e99ff362e913e9a4d", - "revision": 1717260886231743 - } -... -``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.mdx b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.mdx new file mode 100644 index 0000000000..c80484ffdb --- /dev/null +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.mdx @@ -0,0 +1,211 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 3 +--- + +# Получить список опубликованных объектов. + Получает список опубликованных объектов + + + +`Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Количество | --amount | Число | Количество возвращаемых объектов | + | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Количество = 2; + СмещениеОтНачала = 1; + + Результат = OPI_YandexDisk.ПолучитьСписокОпубликованныхОбъектов(Токен, Количество, СмещениеОтНачала); +``` + + + + + + ```bash + oint yadisk ПолучитьСписокОпубликованныхОбъектов --token "***" \ + --amount 2 \ + --offset 1 + ``` + + + + ```batch + oint yadisk ПолучитьСписокОпубликованныхОбъектов ^ + --token "***" ^ + --amount 2 ^ + --offset 1 + ``` + + + + +```json title="Результат" +{ + "items": [ + { + "antivirus_status": "clean", + "public_key": "lzUqwAcU+PlMrKbzcxhks09qmXiWowXTBvUgesT7NxgPfIAvkNlDx1N5dnN4RI6hq/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/i/Ato4XjVRIb4nVw", + "name": "0b5585af-2bca-43cf-9d3a-decc63db8821.png", + "exif": {}, + "created": "2024-06-02T16:49:58+03:00", + "size": 225883, + "resource_id": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", + "modified": "2024-06-02T16:49:58+03:00", + "mime_type": "image/png", + "comment_ids": { + "private_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f", + "public_resource": "1573541518:12e7259ce9e080f16c6d3b5207184744d8c7ef4084fee37e6f8aa72906003f9f" + }, + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/1a1fc16fc4103d93c26779ac22b890cd9466a47346ec885c5803da7e30eb0688/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/84d39edf249d8df76f966afb50704b11a2173cd053500d72d1a48f5ccfe3c78f/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/a24eaaac73d08a894eba2cc6ddee821b76f6d5878e011583921f5f629baa59d6/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0b5585af-2bca-43cf-9d3a-decc63db8821.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/0b5585af-2bca-43cf-9d3a-decc63db8821.png", + "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", + "type": "file", + "md5": "403262e03464796e99ff362e913e9a4d", + "revision": 1717336203287577 + }, + { + "antivirus_status": "clean", + "public_key": "MSeNtB4sL4oM/DMiMUqGGdAxiEkFI7EStMcjgb9PMJR2xYUasH+IJFEqziFNXjfRq/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/i/LIWuPUAfQz2AAg", + "name": "0cd21557-08ba-496c-ba35-503833fa5bd6.png", + "exif": {}, + "created": "2024-06-01T19:54:41+03:00", + "size": 225883, + "resource_id": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", + "modified": "2024-06-01T19:54:41+03:00", + "mime_type": "image/png", + "comment_ids": { + "private_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275", + "public_resource": "1573541518:c7bf5f5709e3dd9b00a7ccd2a82952842d87b2fbe03994f9e3db437adb801275" + }, + "sizes": [ + { + "url": "https://downloader.disk.yandex.ru/disk/d45d482a0590f7b327f0aad9d22ce754cd00ac522a17b4374898b868a461ad26/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "name": "ORIGINAL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2", + "name": "DEFAULT" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0", + "name": "XXXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0", + "name": "XXS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0", + "name": "XS" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "S" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0", + "name": "M" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0", + "name": "L" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0", + "name": "XL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0", + "name": "XXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0", + "name": "XXXL" + }, + { + "url": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "name": "C" + } + ], + "file": "https://downloader.disk.yandex.ru/disk/8e0594d4f836d69c3b7fdde029d263f0c3f5e7efd9cab68db82d579947bc0a3c/6705a6ad/gwThwhLBKYvLhQCNnqAHituHMr72DpUpd6C6-9w911vW8ivir0rElI21oNjVEQFTesbLx_asncX9gQFzcTfYww%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=225883&hid=7c41e6147b7dd41ea3cc2d615f42bcb7&media_type=image&tknv=v2&etag=403262e03464796e99ff362e913e9a4d", + "media_type": "image", + "preview": "https://downloader.disk.yandex.ru/preview/a1752acf54f1a3cdcc545523e57f3b56de1e78d4ab8bbb608152445a2202b043/inf/agGl7FsmrZi_rLwSr_YZE-iLFMsE0Kg4uy9w7SmAoFzz2voeU1keULK7rWnCo1I_pYaH_RrgTTgD4CfIchHW3Q%3D%3D?uid=1573541518&filename=0cd21557-08ba-496c-ba35-503833fa5bd6.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "path": "disk:/0cd21557-08ba-496c-ba35-503833fa5bd6.png", + "sha256": "9ff374c811f9545ca1f55c890c72d583f8abab4a689a733b13e2f32069fa330a", + "type": "file", + "md5": "403262e03464796e99ff362e913e9a4d", + "revision": 1717260886231743 + } +... +``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md deleted file mode 100644 index 645161d0aa..0000000000 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Опубликовать объект - Публикует объект диска в публичный доступ - - - -`Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к публикуемому объекту | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - Путь = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; - - Результат = OPI_YandexDisk.ОпубликоватьОбъект(Токен, Путь); -``` - - - - - - ```bash - oint yadisk ОпубликоватьОбъект --token "***" \ - --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" - ``` - - - - ```batch - oint yadisk ОпубликоватьОбъект ^ - --token "***" ^ - --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "public_key": "fLfKnKmtqPt6TSTumjWC+GMkuduPJAnpx5lwlWVVqp8zeDXp5X74XLJ2GbNOAgYIq/J6bpmRyOJonT3VoXnDag==", - "public_url": "https://yadi.sk/d/yOLqz8yUAZeE0g", - "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png", - "exif": {}, - "created": "2024-10-08T20:39:25+03:00", - "size": 2114023, - "resource_id": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", - "modified": "2024-10-08T20:39:25+03:00", - "comment_ids": { - "private_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", - "public_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e" - }, - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/287c003d8d26c9be77bfaad30e8fc7d1cb5c36bf12d2da9569bace0f8b2d2294/6705a6a1/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/95934d00-67ef-43eb-a306-73a490a0aac0.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728409184987250 -} -``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.mdx b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.mdx new file mode 100644 index 0000000000..eb69f2b081 --- /dev/null +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 1 +--- + +# Опубликовать объект + Публикует объект диска в публичный доступ + + + +`Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к публикуемому объекту | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + Путь = "/55ea8d67-9f19-45d3-a65e-2f8ae070c7e2.png"; + + Результат = OPI_YandexDisk.ОпубликоватьОбъект(Токен, Путь); +``` + + + + + + ```bash + oint yadisk ОпубликоватьОбъект --token "***" \ + --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" + ``` + + + + ```batch + oint yadisk ОпубликоватьОбъект ^ + --token "***" ^ + --path "/499d9d99-abef-44a1-930f-5b464034f75c.png" + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "public_key": "fLfKnKmtqPt6TSTumjWC+GMkuduPJAnpx5lwlWVVqp8zeDXp5X74XLJ2GbNOAgYIq/J6bpmRyOJonT3VoXnDag==", + "public_url": "https://yadi.sk/d/yOLqz8yUAZeE0g", + "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png", + "exif": {}, + "created": "2024-10-08T20:39:25+03:00", + "size": 2114023, + "resource_id": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", + "modified": "2024-10-08T20:39:25+03:00", + "comment_ids": { + "private_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e", + "public_resource": "1573541518:37b19cb1e46f814bb80288ca074d36440e9a4aace2331d9d71390839d4ad7c4e" + }, + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/287c003d8d26c9be77bfaad30e8fc7d1cb5c36bf12d2da9569bace0f8b2d2294/6705a6a1/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/95934d00-67ef-43eb-a306-73a490a0aac0.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728409184987250 +} +``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md deleted file mode 100644 index 64f0cb8df3..0000000000 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Сохранить публичный объект на диск - Сохраняет публичный объект на ваш диск - - - -`Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Адрес объекта | - | Откуда | --from | Строка | Путь внутри публичного каталога (только для папок) | - | Куда | --to | Строка | Путь сохранения файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -
- - - - -```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; - URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; - - Результат = OPI_YandexDisk.СохранитьПубличныйОбъектНаДиск(Токен, URL); -``` - - - - - - ```bash - oint yadisk СохранитьПубличныйОбъектНаДиск --token "***" \ - --url "https://yadi.sk/d/_GkFflxiflKIKg" - ``` - - - - ```batch - oint yadisk СохранитьПубличныйОбъектНаДиск ^ - --token "***" ^ - --url "https://yadi.sk/d/_GkFflxiflKIKg" - ``` - - - - -```json title="Результат" -{ - "antivirus_status": "clean", - "size": 2114023, - "comment_ids": { - "private_resource": "1573541518:56b58a9dc4882571f5ddb4c4df9023e364fed6f8258ad07d3e927a325383c831", - "public_resource": "1573541518:56b58a9dc4882571f5ddb4c4df9023e364fed6f8258ad07d3e927a325383c831" - }, - "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png", - "exif": {}, - "created": "2024-10-08T20:39:46+03:00", - "resource_id": "1573541518:56b58a9dc4882571f5ddb4c4df9023e364fed6f8258ad07d3e927a325383c831", - "modified": "2024-10-08T20:39:46+03:00", - "mime_type": "multipart", - "file": "https://downloader.disk.yandex.ru/disk/aa279cf70c494c153f0cb76408769b15183f78821a7871acef6d48b9cfd213bf/6705a6a3/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", - "path": "disk:/Загрузки/95934d00-67ef-43eb-a306-73a490a0aac0.png", - "media_type": "image", - "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", - "type": "file", - "md5": "9e0176f87f6565a22f78e0f9b39a4d78", - "revision": 1728409186840406 -} -``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.mdx b/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.mdx new file mode 100644 index 0000000000..78eed311ca --- /dev/null +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.mdx @@ -0,0 +1,79 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +--- +sidebar_position: 6 +--- + +# Сохранить публичный объект на диск + Сохраняет публичный объект на ваш диск + + + +`Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Откуда | --from | Строка | Путь внутри публичного каталога (только для папок) | + | Куда | --to | Строка | Путь сохранения файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +
+ + + + +```bsl title="Пример кода" + Токен = "y0_AgAAAABdylaOAAs0QgAAAAD5i-a..."; + URL = "https://yadi.sk/d/pbI5RwM66dK-nA"; + + Результат = OPI_YandexDisk.СохранитьПубличныйОбъектНаДиск(Токен, URL); +``` + + + + + + ```bash + oint yadisk СохранитьПубличныйОбъектНаДиск --token "***" \ + --url "https://yadi.sk/d/_GkFflxiflKIKg" + ``` + + + + ```batch + oint yadisk СохранитьПубличныйОбъектНаДиск ^ + --token "***" ^ + --url "https://yadi.sk/d/_GkFflxiflKIKg" + ``` + + + + +```json title="Результат" +{ + "antivirus_status": "clean", + "size": 2114023, + "comment_ids": { + "private_resource": "1573541518:56b58a9dc4882571f5ddb4c4df9023e364fed6f8258ad07d3e927a325383c831", + "public_resource": "1573541518:56b58a9dc4882571f5ddb4c4df9023e364fed6f8258ad07d3e927a325383c831" + }, + "name": "95934d00-67ef-43eb-a306-73a490a0aac0.png", + "exif": {}, + "created": "2024-10-08T20:39:46+03:00", + "resource_id": "1573541518:56b58a9dc4882571f5ddb4c4df9023e364fed6f8258ad07d3e927a325383c831", + "modified": "2024-10-08T20:39:46+03:00", + "mime_type": "multipart", + "file": "https://downloader.disk.yandex.ru/disk/aa279cf70c494c153f0cb76408769b15183f78821a7871acef6d48b9cfd213bf/6705a6a3/gwThwhLBKYvLhQCNnqAHirWAoEC4dKsPFFzSTeWuFK5ceIUkIDC7fKzI6e0Ic1rFWZAX7ZAMHvmKl9PvgqcSEQ%3D%3D?uid=1573541518&filename=95934d00-67ef-43eb-a306-73a490a0aac0.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=2114023&hid=03d7263840468e281bd0b238a26e7d0d&media_type=image&tknv=v2&etag=9e0176f87f6565a22f78e0f9b39a4d78", + "path": "disk:/Загрузки/95934d00-67ef-43eb-a306-73a490a0aac0.png", + "media_type": "image", + "sha256": "89f8eb42a35208a17c85036e17237b0aa0657e1841efa6171dc5acbc0dea9e18", + "type": "file", + "md5": "9e0176f87f6565a22f78e0f9b39a4d78", + "revision": 1728409186840406 +} +``` diff --git a/service/dictionaries/en.json b/service/dictionaries/en.json index 3b5d93b8d3..976a73ca02 100644 --- a/service/dictionaries/en.json +++ b/service/dictionaries/en.json @@ -7,58 +7,32 @@ "в": "in", "И": "And", "К": "K", -"ГТ": "GS", -"См": "See", -"из": "from", -"ГД": "GD", -"АТ": "AT", -"Да": "Yes", -"на": "to", -"не": "not", -"но": "but", -"Не": "Not", -"ВК": "VK", -"ДД": "BD", -"ФС": "FS", "по": "to", "ГВ": "GW", "со": "with", "ПС": "PS", -"ГК": "GC", -"По": "To", -"МБ": "MB", -"Из": "In", "НС": "NC", +"По": "To", +"Из": "In", +"ФС": "FS", "1С": "1C", -"Окр": "Round", -"ООД": "OOD", -".PF": ".FF", -"изм": "change", -"Вес": "Weight", -"Хэш": "Hash", -"Имя": "Name", -"Или": "Or", -"ОТД": "OTD", -"нет": "no", -"ндс": "vat", -"Цел": "Int", -"Тег": "Tag", -"ВКТ": "VKT", -"вес": "weight", -"Хеш": "Hash", -"это": "this", -"для": "for", -"Код": "Code", -"Лев": "Left", -"НПП": "NPP", -"ИНН": "TIN", -"Таб": "Tab", -"ИВФ": "TFN", -"Что": "What", -"2 ч": "2 hr", +"ГК": "GC", +"ДД": "BD", +"МБ": "MB", +"Не": "Not", +"ВК": "VK", +"См": "See", +"из": "from", +"ГД": "GD", +"ГТ": "GS", +"Да": "Yes", +"на": "to", +"не": "not", +"но": "but", +"АТ": "AT", ".VK": ".CR", +"три": "three", "Чат": "Chat", -"Для": "For", "осн": "main", "Бан": "Ban", "Вид": "View", @@ -66,233 +40,317 @@ "БСП": "BSP", "Два": "Two", ".PS": ".LF", -"три": "three", "Ещё": "More", -"Б24": "B24", +"доп": "add", "Час": "Hour", "ОПИ": "OPI", "Тип": "Type", -"доп": "add", "или": "or", "имя": "name", "Нет": "No", "без": "without", "тэг": "tag", "тип": "type", -"лида": "of lead", -"АирТ": "AirT", -"Тык!": "Click!", -"\"No\"": "\"None\"", -"Тема": "Topic", -"Иван": "Ivan", -"Прав": "Right", -"тип:": "type", -"Файл": "File", -"Дата": "Date", -"Цикл": "Do", -"Если": "If", -"Тело": "Body", -"чата": "of chat", -"Озон": "Ozon", -"файл": "file", -"темы": "of topic", -"Пост": "Post", -"цвет": "color", -"Сайт": "Website", -"Цвет": "Color", -"Сдэк": "Cdek", -"Диск": "Drive", -"Ждет": "Waiting", -"план": "plan", -"Фото": "Photo", -"Лист": "Sheet", -"Лого": "Logo", -"Срок": "Deadline", -"База": "Base", -"Стат": "Stat", -"Сред": "Mid", -"Цена": "Price", -"чате": "chat", -"цены": "price", -"поля": "fields", -"быть": "be", -"Слак": "Slack", -"Тест": "Test", -"Куда": "Target", -"Пара": "Pair", -"цена": "price", -"Флаг": "Flag", -"срок": "deadline", -"веса": "of weight", -"Блок": "Block", -"Ложь": "False", -"тему": "topic", -"мета": "meta", -"Пока": "WHile", -"Цель": "Purpose", -"Пётр": "John", -"дата": "date", -".NPP": ".NBSp", -"Море": "Sea", -"цикл": "loop", +"2 ч": "2 hr", +"Б24": "B24", +"Что": "What", +"Для": "For", +"Таб": "Tab", +"ИВФ": "TFN", +"Окр": "Round", +"ООД": "OOD", +".PF": ".FF", +"Вес": "Weight", +"Хэш": "Hash", +"Имя": "Name", +"Или": "Or", +"ОТД": "OTD", +"нет": "no", +"ндс": "vat", +"изм": "change", +"Тег": "Tag", +"Цел": "Int", +"НПП": "NPP", +"Лев": "Left", +"Код": "Code", +"ИНН": "TIN", +"это": "this", +"Хеш": "Hash", +"вес": "weight", +"ВКТ": "VKT", +"для": "for", "Петр": "John", +"Пока": "WHile", +"Море": "Sea", +".NPP": ".NBSp", +"дата": "date", +"Пётр": "John", +"Цель": "Purpose", +"цикл": "loop", +"Блок": "Block", +"тему": "topic", +"Ложь": "False", +"веса": "of weight", +"срок": "deadline", +"Флаг": "Flag", +"цена": "price", "Коды": "Codes", +"мета": "meta", "Путь": "Path", -"вРег": "Upper", -"Линк": "Link", -"Олег": "Oleg", -"Знач": "Val", -"если": "if", -"нРег": "Lower", -"ТРег": "Title", -"путь": "path", -"Пути": "Paths", -"Лама": "Lama", -"Ключ": "Key", "Поле": "Field", -"Язык": "Lang", -"Авто": "Auto", -"Поля": "Fields", -"Вход": "Entry", -"Цены": "Prices", -"фото": "photo", +"Линк": "Link", +"Пара": "Pair", "всех": "all", -"имеет": "have", -"Антон": "Anton", -"будет": "will", -"ЯДиск": "YDisk", -"вроде": "like", -"Домен": "Domain", -"Новый": "New", -"Путь1": "Path1", -"адрес": "adress", -"Белый": "White", -"Форум": "Forum", -"Лимит": "Limit", -"Буфер": "Buffer", -"Вызов": "Call", -"Автор": "Author", -"Книга": "Spreadsheet", -"почты": "of email", -"Отгул": "Time off", -"Перем": "Var", -"Равно": "Equal", -"Часть": "Part", -"Всего": "Total", -"Режим": "Mode", -"Иначе": "Else", -"копия": "copy", -"Метод": "Method", -"Сдвиг": "Shift", -"Адрес": "Address", -"Папка": "Folder", -"Ответ": "Response", -"своей": "of its", -"Части": "Parts", -"Добро": "Welcome", -"нечто": "something", -"Заказ": "Order", -"Шапка": "Header", -"Файлу": "File", -"Товар": "Product", -"Опции": "Options", -"сумма": "amount", -"Схема": "Scheme", -"почта": "email", -"текст": "text", -"Плохо": "Bad", -"Путь2": "Path2", -"Дата1": "Date1", -"Пакет": "Package", -"Сутки": "Day", -"Файла": "File", -"Набор": "Set", -"число": "number", -"Твиты": "Tweets", -"Медиа": "Media", -"Лист2": "Sheet2", -"Опрос": "Poll", -"путей": "paths", -"Тогда": "Then", -"Тесты": "Tests", -"Драйв": "Drive", -"КБайт": "KBytes", -"опция": "option", -"Логин": "Login", -"Копия": "Copy", -"Текст": "Text", -"Аудио": "Audio", -"ЕдИзм": "Unit", -"ТЗнач": "TValue", -"Токен": "Token", -"Минск": "Minsk", -"диска": "of drive", -"После": "After", -"Гифки": "Gifs", -"Пауза": "Pause", -"Канал": "Channel", -"Файлы": "Files", +"фото": "photo", +"Цены": "Prices", +"Вход": "Entry", +"Поля": "Fields", +"Авто": "Auto", +"Язык": "Lang", +"Ключ": "Key", +"Лама": "Lama", +"Пути": "Paths", +"путь": "path", +"ТРег": "Title", +"нРег": "Lower", +"если": "if", +"Знач": "Val", +"Олег": "Oleg", +"вРег": "Upper", +"Куда": "Target", +"Лого": "Logo", +"Слак": "Slack", +"файл": "file", +"Озон": "Ozon", +"чата": "of chat", +"Тело": "Body", +"Если": "If", +"Цикл": "Do", +"Дата": "Date", +"темы": "of topic", +"Файл": "File", +"Прав": "Right", +"Тема": "Topic", +"\"No\"": "\"None\"", +"Тык!": "Click!", +"АирТ": "AirT", +"лида": "of lead", +"Тест": "Test", +"тип:": "type", +"Пост": "Post", +"Иван": "Ivan", +"Сайт": "Website", +"быть": "be", +"цвет": "color", +"поля": "fields", +"цены": "price", +"чате": "chat", +"Сред": "Mid", +"Стат": "Stat", +"База": "Base", +"Цена": "Price", +"Лист": "Sheet", +"Цвет": "Color", +"Фото": "Photo", +"план": "plan", +"Ждет": "Waiting", +"Диск": "Drive", +"Срок": "Deadline", +"Сдэк": "Cdek", +"Вывод": "Output", "Номер": "Number", "МБайт": "MByte", "парам": "option", "после": "after", -"Опция": "Option", -"Стиль": "Style", "Листы": "Sheets", +"Стиль": "Style", "Отбор": "Filter", +"Файлы": "Files", "Серый": "Gray", -"Вывод": "Output", +"Опция": "Option", +"Канал": "Channel", +"ЕдИзм": "Unit", +"Гифки": "Gifs", +"После": "After", +"диска": "of drive", +"Минск": "Minsk", +"Токен": "Token", +"ТЗнач": "TValue", +"Аудио": "Audio", +"Текст": "Text", +"Копия": "Copy", +"Логин": "Login", "Архив": "Archive", +"опция": "option", +"Пауза": "Pause", "метод": "method", -"Почты": "Mails", -"Ноушн": "Notion", -"Метка": "Label", -"ЮТест": "UTest", -"Тариф": "Tariff", -"Финал": "Final", -"Марта": "Marta", -"Лист1": "Sheet1", -"отчет": "report", -"файла": "file", -"серый": "gray", -"можно": "may", -"чата:": "chat", -"Число": "Number", -"файлу": "file", -"места": "of the venue", -"Время": "Time", -"Синий": "Blue", -"Отчет": "Report", "Блоки": "Blocks", -"Целое": "Whole", -"сайта": "site", -"Гифка": "GIF", -"Видео": "Video", -"Сканы": "Scans", -"Почта": "Email", -"Перед": "Prev", -"Пусто": "Empty", +"Ноушн": "Notion", +"КБайт": "KBytes", "Дата0": "Date0", -"IDФото": "PhotoID", -"Это B2": "ThisIsB2", -"Ячейка": "Cell", -"Ширина": "Width", -"Бирюза": "Turquoise", -"Москва": "Moscow", -"Это A4": "ThisIsA4", -"КудаID": "ToID", -"искать": "search", -"Должно": "Should", -"Товар2": "Item2", -"СКонца": "FromEnd", -"IDТипа": "TypeID", -"Объект": "Object", -"строка": "string", -"Работа": "Work", -"Скидка": "Discount", -"Курсор": "Cursor", -"валюта": "currency", -"ИДФото": "PhotoID", +"Пусто": "Empty", +"Перед": "Prev", +"Почта": "Email", +"Сканы": "Scans", +"Видео": "Video", +"Гифка": "GIF", +"сайта": "site", +"Целое": "Whole", +"Отчет": "Report", +"Синий": "Blue", +"Почты": "Mails", +"Время": "Time", +"файлу": "file", +"Число": "Number", +"можно": "may", +"серый": "gray", +"файла": "file", +"отчет": "report", +"Лист1": "Sheet1", +"Марта": "Marta", +"Финал": "Final", +"Тариф": "Tariff", +"ЮТест": "UTest", +"Метка": "Label", +"места": "of the venue", +"Драйв": "Drive", +"чата:": "chat", +"Тогда": "Then", +"Метод": "Method", +"копия": "copy", +"Иначе": "Else", +"Режим": "Mode", +"Всего": "Total", +"Часть": "Part", +"Равно": "Equal", +"Перем": "Var", +"Отгул": "Time off", +"почты": "of email", +"Книга": "Spreadsheet", +"Автор": "Author", +"Сдвиг": "Shift", +"Вызов": "Call", +"Форум": "Forum", +"Белый": "White", +"адрес": "adress", +"Путь1": "Path1", +"Новый": "New", +"Домен": "Domain", +"вроде": "like", +"ЯДиск": "YDisk", +"будет": "will", +"Антон": "Anton", +"имеет": "have", +"Тесты": "Tests", +"Буфер": "Buffer", +"Адрес": "Address", +"Лимит": "Limit", +"Ответ": "Response", +"путей": "paths", +"Папка": "Folder", +"Опрос": "Poll", +"Лист2": "Sheet2", +"Медиа": "Media", +"Твиты": "Tweets", +"число": "number", +"Файла": "File", +"Сутки": "Day", +"Пакет": "Package", +"Дата1": "Date1", +"Путь2": "Path2", +"Плохо": "Bad", +"Набор": "Set", +"почта": "email", +"Части": "Parts", +"текст": "text", +"своей": "of its", +"Добро": "Welcome", +"нечто": "something", +"Заказ": "Order", +"Файлу": "File", +"Шапка": "Header", +"Товар": "Product", +"Опции": "Options", +"сумма": "amount", +"Схема": "Scheme", +"Кнопки": "Buttons", +"Формат": "Format", +"Канбан": "Kanban", +"валюты": "of currency", +"метода": "method", +"Индекс": "Index", +"Список": "List", +"Запрос": "Request", +"Это B3": "ThisIsB3", +"опцияN": "optionN", +"Это A2": "ThisIsA2", +"опции:": "options:", +"ФайлДД": "FileBD", +"булево": "boolean", +"Модуль": "Module", +"IDТемы": "ThreadID", +"Диалог": "Dialog", +"Видео2": "Video2", +"вывода": "output", +"Россия": "Russia", +"ВКПост": "VKPost", +"Массив": "Array", +"Записи": "Records", +"Ошибка": "Error", +"Первый": "First", +"Откуда": "From", +"данных": "data", +"оценка": "mark", +"Письмо": "Letter", +"Ссылка": "Link", +"Иванов": "Ivanov", +"автора": "of author", +"статус": "status", +"Сессия": "Session", +"ВКЛайк": "VKLike", +"отчете": "report", +"Петров": "Doe", +"Задачи": "Tasks", +"старая": "old", +"Разбан": "Unban", +"товара": "product", +"начала": "of start", +"форума": "of forum", +"Оценка": "Mark", +"работу": "work", +"IDЧата": "ChatID", +"Прочие": "Others", +"Услуга": "Service", +"опция1": "option1", +"ВСпейс": "VSpace", +"Данные": "Data", +"Отступ": "Indent", +"ширина": "width", +"Первое": "First", +"Ответы": "Answers", +"Хорошо": "Good", +"Иконка": "Icon", +"Товары": "Products", +"Задача": "Task", +"Коммит": "Commit", +"массив": "array", +"Рефреш": "Refresh", +"корень": "root", +"Иконки": "Icons", +"Книга2": "Spreadsheet2", +"важное": "important", +"ВКТЧат": "VKTChat", +"команд": "commands", +"Привет": "Hello", +"Стадия": "Stage", +"Статус": "Status", +"Широта": "Latitude", +"задача": "task", +"файлов": "of files", +"Пароль": "Password", +"Способ": "Way", +"СокрЛП": "TrimAll", +"Строка": "String", "АТПоле": "ATField", "Это A3": "ThisIsA3", "Товар1": "Item1", @@ -308,20 +366,59 @@ "Прочее": "Miscellaneous", "Истина": "True", "данные": "Data", +"ИДФото": "PhotoID", +"валюта": "currency", +"Курсор": "Cursor", +"Работа": "Work", +"Сервер": "Server", +"IDФото": "PhotoID", +"Это B2": "ThisIsB2", +"Ячейка": "Cell", +"Ширина": "Width", +"Бирюза": "Turquoise", +"Москва": "Moscow", "ТипЗнч": "TypeOf", +"Это A4": "ThisIsA4", +"искать": "search", +"Должно": "Should", +"Товар2": "Item2", +"СКонца": "FromEnd", +"IDТипа": "TypeID", +"Объект": "Object", +"строка": "string", +"КудаID": "ToID", "задачи": "of topic", -"Высота": "Height", +"Скидка": "Discount", "высота": "height", +"Вопрос": "Question", +"Фильтр": "Filter", +"Желтый": "Yellow", +"IDПоля": "FieldID", +"ставка": "value", +"Текст2": "Text2", +"ФотоID": "PhotoID", +"Это B4": "ThisIsB4", +"Запись": "Record", +"Это A1": "ThisIsA1", +"Версия": "Version", +"работы": "work", +"Клиент": "Client", +"Булево": "Boolean", +"Высота": "Height", +"группы": "of group", +"Это B1": "ThisIsB1", +"группе": "group", +"Аватар": "Picture", +"Альбом": "Album", +"IDЛида": "LeadID", "Вайбер": "Viber", -"Важное": "Important", "тестов": "tests", "Строки": "Strings", "Раздел": "Section", -"Альбом": "Album", "СлакОк": "SlackOk", "Оплата": "Payment", +"Важное": "Important", "стадия": "stage", -"Гифка2": "Gif2", "работе": "work", "стадию": "stage", "Парсер": "Parser", @@ -329,203 +426,39 @@ "Услуги": "Services", "Пакеты": "Packages", "Дважды": "Twice", -"IDЛида": "LeadID", -"группе": "group", -"Это B4": "ThisIsB4", -"Вопрос": "Question", -"Фильтр": "Filter", -"Желтый": "Yellow", -"IDПоля": "FieldID", -"ставка": "value", -"Текст2": "Text2", -"Аватар": "Picture", -"ФотоID": "PhotoID", -"Запись": "Record", -"Это B1": "ThisIsB1", -"Это A1": "ThisIsA1", -"Версия": "Version", -"работы": "work", -"Клиент": "Client", -"Булево": "Boolean", -"группы": "of group", -"Строка": "String", -"Сервер": "Server", -"Способ": "Way", -"работу": "work", -"Россия": "Russia", -"Массив": "Array", -"Записи": "Records", -"Ошибка": "Error", -"Видео2": "Video2", -"Первый": "First", -"Откуда": "From", -"данных": "data", -"оценка": "mark", -"Письмо": "Letter", -"Ссылка": "Link", -"Иванов": "Ivanov", -"СокрЛП": "TrimAll", -"автора": "of author", -"статус": "status", -"Сессия": "Session", -"вывода": "output", -"ВКЛайк": "VKLike", -"Диалог": "Dialog", -"ФайлДД": "FileBD", -"валюты": "of currency", -"Формат": "Format", -"Индекс": "Index", -"Канбан": "Kanban", -"метода": "method", -"Кнопки": "Buttons", -"Список": "List", -"IDТемы": "ThreadID", -"Это B3": "ThisIsB3", -"опцияN": "optionN", -"Это A2": "ThisIsA2", -"Запрос": "Request", -"опции:": "options:", -"Модуль": "Module", -"булево": "boolean", -"ВКПост": "VKPost", -"отчете": "report", -"Хорошо": "Good", -"Задачи": "Tasks", -"Задача": "Task", -"Коммит": "Commit", -"массив": "array", -"Рефреш": "Refresh", -"корень": "root", -"Иконки": "Icons", -"Книга2": "Spreadsheet2", -"ВКТЧат": "VKTChat", -"Пароль": "Password", -"команд": "commands", -"Привет": "Hello", -"Стадия": "Stage", -"Статус": "Status", -"Широта": "Latitude", -"задача": "task", -"файлов": "of files", -"Товары": "Products", -"важное": "important", -"Иконка": "Icon", -"IDЧата": "ChatID", -"старая": "old", -"Разбан": "Unban", -"товара": "product", -"начала": "of start", -"форума": "of forum", -"Оценка": "Mark", -"Петров": "Doe", -"Прочие": "Others", -"Ответы": "Answers", -"Услуга": "Service", -"опция1": "option1", -"ВСпейс": "VSpace", -"Данные": "Data", -"Отступ": "Indent", -"ширина": "width", -"Первое": "First", -"Твиттер": "Twitter", -"справку": "help", -"События": "Events", -"Евгений": "Evgeniy", -"Титовец": "Titovets", -"Позиции": "Items", -"Уволить": "Fire", -"ЕстьТег": "HasTag", -"Вариант": "Option", -"СдэкАПИ": "CdekAPI", -"Реклама": "Advertisement", -"Граница": "Border", -"Альпака": "Alpaca", -"Коммент": "Comment", -"Возврат": "Return", -"Долгота": "Longitude", -"Булево_": "Boolean_", -"IDМедиа": "MediaID", -"В офисе": "InOffice", -"Желтый_": "Yellow_", -"Вывести": "Output", -"парсить": "parse", -"Экспорт": "Export", -"Справка": "Help", -"ЮТТесты": "UTTests", -"которые": "that", -"статуса": "of status", -"Артикул": "Article", -"Отладка": "Debugging", -"Скрытая": "Hidden", -"НСУспех": "NCSuccess", -"Счетчик": "Counter", -"Символы": "Chars", -"ВКВидео": "VKVideo", -"ВКТФайл": "VKTFile", -"Колонки": "Columns", -"текущей": "current", -"Аккаунт": "Account", -"смайлов": "smiles", -"ОзонАПИ": "OzonAPI", -"Область": "Region", -"АТТекст": "ATText", -"Доступы": "Rights", -"Таблица": "Table", -"Удалить": "Delete", -"ОпросID": "PollID", -"Каталог": "Directory", -"Текущее": "Current", -"глубина": "depth", -"Высокий": "High", -"Префикс": "Prefix", -"Таймаут": "Timeout", -"Магазин": "Market", -"ТипПоля": "FieldType", -"ИДБлока": "BlockID", -"ЧатТема": "ChatTopic", -"изменен": "changed", -"признак": "attribute", -"Изменил": "Changer", -"Позиция": "Item", -"ВКТовар": "VKProduct", -"Кнопка1": "Button1", -"ДопФото": "AdditionalPhoto", -"IDФайла": "FileID", -"Обычный": "Regular", -"Красный": "Red", -"ID чата": "Chat ID", -"Глубина": "Depth", -"Отметка": "Timestamp", -"артикул": "article", -"Зеленый": "Green", -"свойств": "properties", -"нажмите": "press", -"Скачать": "Download", -"Секунды": "Seconds", -"Подпись": "Signature", -"СНачала": "FromBegin", -"главную": "main", -"0 Тогда": "0 Then", -"Перейти": "Goto", -"Кнопка2": "Button2", -"наличие": "availability", -"Остатки": "Stocks", -"Обложка": "Cover", -"Фамилия": "LastName", -"Крайний": "Last", -"ВидеоДД": "VideoDD", -"Телефон": "Phone", -"формате": "format", +"Гифка2": "Gif2", +"Открыть": "Open", +"VK (ОПИ": "VK (OpenIntegrations", +"Объекты": "Objects", +"ИДПоста": "PostID", +"Команды": "Commands", +"ОзонSKU": "OzonSKU", +"телефон": "phone", +"команды": "commands", +"ID темы": "Thread ID", +"Ревизия": "Revision", +"шаблону": "for pattern", +"Извлечь": "Extract", +"красный": "red", +"граммах": "grams", +"СлакБот": "SlackBot", +"АудиоДД": "AudioDD", +"Записал": "Write it!", +"IDПапки": "FolderID", +"Закрыть": "Close", +"Причина": "Reason", +"Виталий": "Vitaly", +"парсера": "parser", +"Ожидаем": "Awaiting", "Попытка": "Try", "методы:": "methods:", -"Виталий": "Vitaly", "IDПоста": "PostID", "История": "Story", "Мой Мир": "My World", "Событие": "Event", "Ресурсы": "Other", +"крайний": "last", "Скрытый": "Hidden", -"Русский": "Russian", "Консоль": "Console", "Каждого": "Each", "Сделать": "Make", @@ -534,32 +467,32 @@ "1 Тогда": "1 Then", "главным": "main", "ИмяПоля": "FieldName", -"парсера": "parser", -"крайний": "last", -"Причина": "Reason", -"IDПапки": "FolderID", -"телефон": "phone", -"Команды": "Commands", -"команды": "commands", -"Объекты": "Objects", -"VK (ОПИ": "VK (OpenIntegrations", -"Открыть": "Open", -"ОзонSKU": "OzonSKU", -"ID темы": "Thread ID", -"Закрыть": "Close", -"шаблону": "for pattern", -"Извлечь": "Extract", -"красный": "red", -"граммах": "grams", -"СлакБот": "SlackBot", -"АудиоДД": "AudioDD", -"Ревизия": "Revision", -"Записал": "Write it!", -"ИДПоста": "PostID", -"Ожидаем": "Awaiting", +"Русский": "Russian", "Отлично": "Great", -"фамилия": "surname", +"IDВидео": "VideoID", "единица": "unit", +"Таблицы": "Tables", +"события": "events", +"ВКЧисло": "VKNumber", +"указано": "filled", +"Команда": "Command", +"Текущий": "Current", +"ДатаISO": "DateISO", +"Средний": "Normal", +"Функция": "Function", +"вызова:": "call:", +"ГифкаДД": "GifDD", +"IDСтены": "WallID", +"Природа": "Nature", +"ЭтоБаза": "ThisIsBase", +"Запросы": "Requests", +"каждого": "each", +"Перенос": "LineBreak", +"формате": "format", +"запуска": "start", +"Строка_": "String_", +"товаров": "of products", +"Разделы": "Sections", "Кнопка3": "Button3", "системе": "at system", "Элемент": "Element", @@ -579,50 +512,183 @@ "Признак": "Indication", "рабочей": "works", "удалено": "deleted", -"Разделы": "Sections", -"товаров": "of products", -"Строка_": "String_", -"Функция": "Function", -"Таблицы": "Tables", -"события": "events", -"ВКЧисло": "VKNumber", -"указано": "filled", -"Команда": "Command", -"Текущий": "Current", -"ДатаISO": "DateISO", -"Средний": "Normal", -"вызова:": "call:", -"запуска": "start", -"ГифкаДД": "GifDD", -"IDСтены": "WallID", -"Природа": "Nature", -"IDВидео": "VideoID", -"ЭтоБаза": "ThisIsBase", -"Запросы": "Requests", -"каждого": "each", -"Перенос": "LineBreak", -"Красный_": "Red_", -"ТипЧисло": "TypeNumber", -"Евгеньев": "Evgeniev", -"ИДРаботы": "WorkID", -"Вес в гр": "Weight in g", -"являются": "be", -"НоушнАпи": "NotionAPI", -"Кнопка 1": "Button 1", -"подборку": "selection", -"JSONДата": "JSONDate", -"Двоичные": "Binary", -"IDСтадии": "StageID", -"ТипСвязи": "LinkType", -"ЕстьДата": "HasDate", -"ДатаISOZ": "DateISOZ", -"Очистить": "Clear", -"контакта": "of contact", -"Упаковка": "Packaging", -"собщение": "message", -"магазина": "store", -"Основная": "Main", -"ТипФайла": "FileType", +"фамилия": "surname", +"Телефон": "Phone", +"справку": "help", +"Крайний": "Last", +"ЮТТесты": "UTTests", +"которые": "that", +"статуса": "of status", +"Артикул": "Article", +"Отладка": "Debugging", +"Скрытая": "Hidden", +"НСУспех": "NCSuccess", +"Счетчик": "Counter", +"Символы": "Chars", +"ВКВидео": "VKVideo", +"ВКТФайл": "VKTFile", +"Колонки": "Columns", +"текущей": "current", +"Аккаунт": "Account", +"смайлов": "smiles", +"ОзонАПИ": "OzonAPI", +"Область": "Region", +"Справка": "Help", +"Экспорт": "Export", +"парсить": "parse", +"Вывести": "Output", +"События": "Events", +"Евгений": "Evgeniy", +"Титовец": "Titovets", +"Позиции": "Items", +"Уволить": "Fire", +"ЕстьТег": "HasTag", +"Вариант": "Option", +"СдэкАПИ": "CdekAPI", +"АТТекст": "ATText", +"Реклама": "Advertisement", +"Альпака": "Alpaca", +"Коммент": "Comment", +"Возврат": "Return", +"Долгота": "Longitude", +"Булево_": "Boolean_", +"IDМедиа": "MediaID", +"В офисе": "InOffice", +"Желтый_": "Yellow_", +"Граница": "Border", +"Доступы": "Rights", +"Твиттер": "Twitter", +"Удалить": "Delete", +"Отметка": "Timestamp", +"артикул": "article", +"Зеленый": "Green", +"свойств": "properties", +"нажмите": "press", +"Скачать": "Download", +"Секунды": "Seconds", +"Подпись": "Signature", +"Глубина": "Depth", +"СНачала": "FromBegin", +"0 Тогда": "0 Then", +"Перейти": "Goto", +"Кнопка2": "Button2", +"наличие": "availability", +"Остатки": "Stocks", +"Обложка": "Cover", +"Фамилия": "LastName", +"Таблица": "Table", +"главную": "main", +"ID чата": "Chat ID", +"ВидеоДД": "VideoDD", +"Обычный": "Regular", +"Красный": "Red", +"ОпросID": "PollID", +"Каталог": "Directory", +"Текущее": "Current", +"глубина": "depth", +"Высокий": "High", +"Таймаут": "Timeout", +"Магазин": "Market", +"ТипПоля": "FieldType", +"Префикс": "Prefix", +"ЧатТема": "ChatTopic", +"IDФайла": "FileID", +"ИДБлока": "BlockID", +"Кнопка1": "Button1", +"ВКТовар": "VKProduct", +"ДопФото": "AdditionalPhoto", +"Изменил": "Changer", +"признак": "attribute", +"изменен": "changed", +"Позиция": "Item", +"ВКАльбом": "VKAlbum", +"ПотокZip": "ZipStream", +"Строчный": "StringType", +"ключевой": "primary", +"Значение": "Value", +"Штрихкод": "Barcode", +"входящих": "incoming", +"ПутьФайл": "FilePath", +"IDКанала": "ChannelID", +"АТЗапись": "ATRecord", +"создания": "of create", +"элементы": "elements", +"ВайберОк": "ViberOk", +"Свернуть": "Collapse", +"IDРаботы": "JobID", +"ID акции": "Promo ID", +"СтрВсего": "StrTotal", +"ИмяЛиста": "SheetName", +"Свойства": "Properties", +"ID поста": "Post ID", +"Удаление": "Deletion", +"Картинка": "Image", +"Приемник": "Receiver", +"Проверки": "Checks", +"ИДТовара": "ProductID", +"Сообщить": "Message", +"Уадление": "Removal", +"ВКИстина": "VKTrue", +"IDЗатрат": "SpendingID", +"Вложение": "Attachment", +"IDЗадачи": "TaskID", +"Родитель": "Parent", +"Кнопка 2": "Button 2", +"Телефоны": "Phones", +"ГКОбъект": "GCObject", +"IDЗаписи": "RecordID", +"СтрНайти": "StrFind", +"Числовой": "Numeric", +"Прервать": "Break", +"ПоОдному": "Singly", +"ОбъектВК": "VKObject", +"значение": "value", +"каталога": "directory", +"Загрузки": "Downloads", +"В оффисе": "On office", +"Страница": "Page", +"Имя,MIME": "Name,MIME", +"Видмость": "Visibility", +"Оригинал": "Original", +"отправки": "of sending", +"временем": "time", +"Получить": "Get", +"Загрузка": "Upload", +"Разметка": "Markup", +"ФайлСлак": "SlackFile", +"размеров": "of size", +"Неоситиз": "Neocities", +"например": "for example", +"название": "name", +"ДатаСтоп": "EndDate", +"ВКорзину": "ToCart", +"В работе": "InProgress", +"ХешСумма": "HashSum", +"IDИконки": "IconID", +"IDТовара": "ProductID", +"двоичные": "binary", +"МассивID": "IDArray", +"СтрДлина": "StrLen", +"ЭтоКанал": "IsChannel", +"Беларусь": "Belarus", +"РазмерДД": "SizeDD", +"штрихкод": "barcode", +"Вложения": "Attachments", +"СтрокаТЗ": "DataString", +"Вставить": "Insert", +"ФайлТела": "BodyFile", +"параметр": "parameter", +"МедиаГиф": "MediaGif", +"ИмяФайла": "FileName", +"закрытия": "of closing", +"ID блока": "Block ID", +"ТипМедиа": "TypeOfMedia", +"Отложена": "Deferred", +"Прогресс": "Progress", +"НЕ JSON:": "NOT JSON:", +"Телеграм": "Telegram", +"Выполнен": "Completed", +"IDСделки": "DealID", "страницу": "page", "НовоеИмя": "NewName", "Внимание": "Attention", @@ -640,32 +706,32 @@ "Параметр": "Parameter", "заполнен": "filled", "реальной": "real", +"Основная": "Main", +"магазина": "store", +"собщение": "message", +"Упаковка": "Packaging", +"Элементы": "Items", +"Красный_": "Red_", +"ТипЧисло": "TypeNumber", +"Евгеньев": "Evgeniev", +"ИДРаботы": "WorkID", +"Вес в гр": "Weight in g", +"являются": "be", +"НоушнАпи": "NotionAPI", "Документ": "Document", +"Кнопка 1": "Button 1", +"JSONДата": "JSONDate", +"Двоичные": "Binary", +"IDСтадии": "StageID", +"ТипСвязи": "LinkType", +"ЕстьДата": "HasDate", +"ДатаISOZ": "DateISOZ", +"Очистить": "Clear", +"контакта": "of contact", +"подборку": "selection", "Максимум": "Maximum", -"загрузки": "upload", +"ТипФайла": "FileType", "Смещение": "Offset", -"БлокJSON": "JSONBlock", -"API ключ": "API key", -"Источник": "Source", -"IDФайла2": "FileID2", -"Отправка": "Sending", -"Действие": "Action", -"СлакФайл": "SlackFile", -"ПоляБазы": "BaseFields", -"КонецДня": "EndOfDay", -"Активный": "Active", -"Артикулы": "Articles", -"Значения": "Values", -"МассивИД": "IDArray", -"ФайлЛога": "LogFile", -"ИмеетТип": "HasType", -"Название": "Name", -"Elements": "Items", -"подборки": "selections", -"компании": "of company", -"АТЗаписи": "ATRecords", -"ВГраница": "UBound", -"Свойство": "Property", "Делитель": "Divider", "Кнопка 3": "Button 3", "Записать": "Write", @@ -674,8 +740,8 @@ "ДропБокс": "Dropbox", "оплачено": "paid", "Основные": "Main", +"Свойство": "Property", "картинок": "images", -"Проверка": "Check", "ИмяМедиа": "MediaName", "доступен": "available", "Точность": "Precision", @@ -683,126 +749,124 @@ "ФайлПуть": "FilePath", "ГуглЛист": "GoogleSheet", "варианты": "variants", +"загрузки": "upload", +"Проверка": "Check", +"ВГраница": "UBound", "URLФайла": "FileURL", -"IDСделки": "DealID", -"Элементы": "Items", -"Выполнен": "Completed", -"ВКорзину": "ToCart", -"Картинка": "Image", -"Приемник": "Receiver", -"Проверки": "Checks", -"ИДТовара": "ProductID", -"Сообщить": "Message", -"Уадление": "Removal", -"ВКИстина": "VKTrue", -"IDЗатрат": "SpendingID", -"Вложение": "Attachment", -"IDЗадачи": "TaskID", -"Родитель": "Parent", -"Кнопка 2": "Button 2", -"ID поста": "Post ID", -"ГКОбъект": "GCObject", -"IDЗаписи": "RecordID", -"СтрНайти": "StrFind", -"Числовой": "Numeric", -"Прервать": "Break", -"ПоОдному": "Singly", -"Удаление": "Deletion", -"ОбъектВК": "VKObject", -"Свойства": "Properties", -"СтрВсего": "StrTotal", -"ПотокZip": "ZipStream", -"Строчный": "StringType", -"ключевой": "primary", -"Значение": "Value", -"Штрихкод": "Barcode", -"входящих": "incoming", -"ВКАльбом": "VKAlbum", -"ПутьФайл": "FilePath", -"ИмяЛиста": "SheetName", -"АТЗапись": "ATRecord", -"создания": "of create", -"элементы": "elements", -"ВайберОк": "ViberOk", -"Свернуть": "Collapse", -"IDРаботы": "JobID", -"ID акции": "Promo ID", -"IDКанала": "ChannelID", -"Телефоны": "Phones", -"значение": "value", -"IDИконки": "IconID", -"Загрузки": "Downloads", -"МассивID": "IDArray", -"СтрДлина": "StrLen", -"ЭтоКанал": "IsChannel", -"Беларусь": "Belarus", -"РазмерДД": "SizeDD", -"штрихкод": "barcode", -"Вложения": "Attachments", -"каталога": "directory", -"СтрокаТЗ": "DataString", -"ФайлТела": "BodyFile", -"НЕ JSON:": "NOT JSON:", -"параметр": "parameter", -"МедиаГиф": "MediaGif", -"ИмяФайла": "FileName", -"закрытия": "of closing", -"ID блока": "Block ID", -"ТипМедиа": "TypeOfMedia", -"Отложена": "Deferred", -"Телеграм": "Telegram", -"Прогресс": "Progress", -"двоичные": "binary", -"Вставить": "Insert", -"IDТовара": "ProductID", -"Загрузка": "Upload", -"В оффисе": "On office", -"Страница": "Page", -"Имя,MIME": "Name,MIME", -"Видмость": "Visibility", -"Оригинал": "Original", -"отправки": "of sending", -"временем": "time", -"Получить": "Get", -"Разметка": "Markup", -"ХешСумма": "HashSum", -"ФайлСлак": "SlackFile", -"размеров": "of size", -"Неоситиз": "Neocities", -"например": "for example", -"название": "name", -"ДатаСтоп": "EndDate", -"В работе": "InProgress", -"Доступные": "Available", -"должность": "position", -"Календари": "Calendars", -"ЯДискДиск": "YaDiskDrive", -"измерения": "dimension", -"Последний": "Last", -"Прочитать": "Read", -"Сумма НДС": "VAT amount", -"Сообщение": "Message", -"ТокенБота": "BotToken", -"Картинка2": "Image2", -"ГуглКнига": "GoogleSpreadsheet", -"Перейдите": "Go", -"Сигнатура": "Signature", -"Текстовое": "Text", -"сообщение": "message", -"ТипСтрока": "TypeString", -"XMLСтрока": "XMLString", -"СлакКанал": "SlackChannel", -"видимость": "visibility", -"ВебКлиент": "WebClient", -"ID склада": "Warehouse ID", -"ВерсияАпи": "APIVersion", +"компании": "of company", +"АТЗаписи": "ATRecords", +"API ключ": "API key", +"Источник": "Source", +"IDФайла2": "FileID2", +"Отправка": "Sending", +"Действие": "Action", +"СлакФайл": "SlackFile", +"ПоляБазы": "BaseFields", +"КонецДня": "EndOfDay", +"БлокJSON": "JSONBlock", +"Артикулы": "Articles", +"Значения": "Values", +"МассивИД": "IDArray", +"ФайлЛога": "LogFile", +"ИмеетТип": "HasType", +"Название": "Name", +"Elements": "Items", +"подборки": "selections", +"Активный": "Active", +"Имя папки": "Folder name", +"Значение_": "Value_", +"Подробнее": "More", +"В корзину": "To cart", +"ВидеоПуть": "VideoPath", +"последним": "last", +"НаСервере": "AtServer", +"АудиоПуть": "AudioPath", +"Локальный": "Local", +"Подборки_": "Selections_", +"Закрывает": "Closes", +"БанРазбан": "BanUnban", +"ВКонтакте": "VKontakte", +"ГифкаПуть": "GifPath", +"Вариант 2": "Option 2", +"Разобрать": "Parse", +"Получено!": "Get it!", +"программы": "program", +"IDНовости": "PostID", +"окончания": "of end", +"Исполнить": "Execute", +"СдэкТокен": "CdekToken", +"Изменение": "Change", +"просмотра": "view", +"Батарейки": "Batteries", +"ПутьКопии": "CopyPath", +"IDКлиента": "ClientID", +"ВКТСписок": "VKTList", +"ЗависитОт": "ЗависитОт", +"Приватный": "Private", +"РазмерCDH": "SizeCDH", +"СтрШаблон": "StrTemplate", +"Цвет чата": "Chat color", +"Вложенный": "Embedded", +"НаКлиенте": "AtClient", +"АТТаблица": "ATTable", +"HTTPОтвет": "HTTPResponse", +"заголовок": "title", +"ОзонТовар": "OzonProduct", +"Параметр_": "Parameter_", +"Скриншоты": "Screenshots", +"КонецЕсли": "EndIf", +"ТипДанных": "DataType", +"Строковое": "String", +"Вычислить": "Eval", +"OPI_Тесты": "OPI_Tests", +"владельца": "of owner", +"ПутьКСтат": "PathToStat", +"НачалоДня": "BegOfDay", +"обработки": "processing", +"СтрокаBat": "BatString", +"ТекущийИД": "CurrentID", +"категории": "category", +"Штрихкоды": "Barcodes", +"ИДАльбома": "AlbumID", +"Константы": "Constants", +"ДатаСтарт": "StartDate", +"сообщения": "of message", +"Цвет (изм": "Color (change", +"Как дела?": "How are you?", +"Конецесли": "EndIf", +"Картинка1": "Image1", +"Кодировка": "Encoding", +"OPI тесты": "OPI tests", +"Заголовок": "Title", +"ИДОбъекта": "ObjectID", +"НовыйЛист": "NewSheet", +"ID товара": "Product ID", +"Параметры": "Parameters", +"Процедура": "Procedure", +"Приоритет": "Priority", +"ИмяПакета": "PackageName", +"РазмерСДХ": "SizeCDH", +"Завершена": "Complete", +"ИДЖелтого": "YellowID", +"Коллекция": "Collection", +"Результат": "Result", +"ID сделки": "Deal ID", +"IDСобытия": "EventID", +"Календарь": "Calendar", +"Рекламный": "Advertising", +"Категории": "Categories", +"Заполнено": "Filled", +"изменения": "change", +"Выключить": "Off", +"отражения": "reflection", +"Нормально": "Ok", "Публичный": "Public", "Тесты CLI": "CLI Tests", "Анонимный": "Anonymous", "Служебные": "Service", "Категория": "Category", "приоритет": "priority", -"отражения": "reflection", +".HasType(": ".ИмеетТип(", "ГуглТокен": "GoogleToken", "Файл_Стат": "File_Stat", "Выражение": "Expression", @@ -813,32 +877,32 @@ "НовыйТест": "NewTest", "доступных": "available", "Выполнить": "Execute", +"ВерсияАпи": "APIVersion", +"ID склада": "Warehouse ID", +"ВебКлиент": "WebClient", +"видимость": "visibility", +"Доступные": "Available", +"должность": "position", +"Календари": "Calendars", +"измерения": "dimension", +"Последний": "Last", +"Прочитать": "Read", +"Сумма НДС": "VAT amount", +"Сообщение": "Message", "Открывает": "Opens", +"ТокенБота": "BotToken", +"ГуглКнига": "GoogleSpreadsheet", +"Перейдите": "Go", +"Сигнатура": "Signature", +"Текстовое": "Text", +"сообщение": "message", +"ТипСтрока": "TypeString", +"XMLСтрока": "XMLString", +"СлакКанал": "SlackChannel", +"Картинка2": "Image2", "Вариант 1": "Option 1", -"Затрачено": "Spend", +"ЯДискДиск": "YaDiskDrive", "Поддержка": "Support", -"ИначеЕсли": "ElsIf", -"Истечение": "Expiration", -"РазмерЛФХ": "SizeLFH", -"URL файла": "File URL", -"ПутьЛогов": "LogPath", -"Заголовки": "Headers", -"заполнена": "filled", -"IDТоваров": "ProductsID", -"Удаленный": "Remote", -"Значение:": "Value:", -"ID задачи": "Task ID", -"Опоздание": "Late", -"Массив360": "Array360", -"СдэкЗаказ": "CdekOrder", -"МассивИД_": "ArrayID_", -"Ozon (ОПИ": "Ozon (OpenIntegrations", -"РазмерЕСД": "SizeESD", -"ВКТИстина": "VKTTrue", -"Свойства_": "Properties_", -"Сохранить": "Save", -"IDЗадания": "TaskID", -"ВКТЗаявки": "VKTPending", "Получение": "Obtaining", "IDПервого": "FirstID", "ИмяМетода": "MethodName", @@ -847,188 +911,61 @@ "CDEK (ОПИ": "CDEK (OpenIntegrations", "Видимость": "Visibility", "ПолноеИмя": "FullName", +"ВКТЗаявки": "VKTPending", "Структура": "Structure", -"Одиночное": "Single", "URLОтвета": "ResponseURL", "Новый чат": "New chat", "ВКИстория": "VKStorie", "Код КЛАДР": "CLADR code", "Удаляемый": "Deletable", -"ID канала": "Channel ID", "IDАльбома": "AlbumID", "ЧтениеZip": "ReadingZip", -"Нормально": "Ok", -".HasType(": ".ИмеетТип(", -"Выключить": "Off", -"КонецЕсли": "EndIf", -"Изменение": "Change", -"просмотра": "view", -"Батарейки": "Batteries", -"ПутьКопии": "CopyPath", -"IDКлиента": "ClientID", -"ВКТСписок": "VKTList", -"ЗависитОт": "ЗависитОт", -"РазмерCDH": "SizeCDH", -"Параметр_": "Parameter_", -"СтрШаблон": "StrTemplate", -"окончания": "of end", -"Цвет чата": "Chat color", -"Вложенный": "Embedded", -"НаКлиенте": "AtClient", -"АТТаблица": "ATTable", -"HTTPОтвет": "HTTPResponse", -"заголовок": "title", -"ОзонТовар": "OzonProduct", -"Исполнить": "Execute", -"Приватный": "Private", -"IDНовости": "PostID", -"Получено!": "Get it!", -"Подробнее": "More", -"ВидеоПуть": "VideoPath", -"В корзину": "To cart", -"НаСервере": "AtServer", -"Значение_": "Value_", -"Имя папки": "Folder name", -"АудиоПуть": "AudioPath", -"программы": "program", -"Подборки_": "Selections_", -"Закрывает": "Closes", -"БанРазбан": "BanUnban", -"Локальный": "Local", -"ВКонтакте": "VKontakte", -"ГифкаПуть": "GifPath", -"Вариант 2": "Option 2", -"Разобрать": "Parse", -"последним": "last", -"СдэкТокен": "CdekToken", -"Скриншоты": "Screenshots", -"Кодировка": "Encoding", -"ТипДанных": "DataType", -"ИДОбъекта": "ObjectID", -"НовыйЛист": "NewSheet", -"ID товара": "Product ID", -"Параметры": "Parameters", -"Процедура": "Procedure", -"Приоритет": "Priority", -"ИмяПакета": "PackageName", -"РазмерСДХ": "SizeCDH", -"ИДЖелтого": "YellowID", -"изменения": "change", -"Коллекция": "Collection", -"Результат": "Result", -"ID сделки": "Deal ID", -"IDСобытия": "EventID", -"Календарь": "Calendar", -"Рекламный": "Advertising", -"Категории": "Categories", -"Заполнено": "Filled", -"Заголовок": "Title", -"Завершена": "Complete", -"OPI тесты": "OPI tests", -"ТекущийИД": "CurrentID", -"Строковое": "String", -"Вычислить": "Eval", -"OPI_Тесты": "OPI_Tests", -"владельца": "of owner", -"ПутьКСтат": "PathToStat", -"НачалоДня": "BegOfDay", -"обработки": "processing", -"СтрокаBat": "BatString", -"категории": "category", -"Картинка1": "Image1", -"Штрихкоды": "Barcodes", -"ИДАльбома": "AlbumID", -"Константы": "Constants", -"ДатаСтарт": "StartDate", -"сообщения": "of message", -"Цвет (изм": "Color (change", -"Как дела?": "How are you?", -"Конецесли": "EndIf", -"Токен бота": "Bot token", -"Мегаклиент": "MegaClient", -"ИДКартинки": "ImageID", -"ХешФункция": "HashFunction", -"ЦветТекста": "TextColor", -"ФайлВывода": "OutputFile", -"УдалитьЛид": "DeleteLead", -"бибилотека": "library", -"ЖиваяЛента": "NewsFeed", -"Новый файл": "NewFile", -"ИмеетДлину": "HasLength", -"ТекущееИмя": "CurrentName", -"МассивПочт": "EmailsArray", -"СоздатьЧат": "CreateChat", -"ИДВарианта": "VariantID", -"IDКартинки": "ImageID", -"НайтиФайлы": "FindFiles", -"ВКЭлементы": "VKElement", -"ПутьНового": "NewPath", -"Интеграция": "Integrations", -"Назначение": "Destination", -"ID диалога": "Dialog ID", -"НовяИконка": "NewIcon", -"Пропустить": "Skip", -"Продолжить": "Continue", -"информации": "information", -"Информация": "Information", -"Б24_Канбан": "B24_Kanban", -"ПутьКФайлу": "FilePath", -"Статистика": "Statistics", -"СерверФото": "PhotoServer", -"Текст тега": "Tag text", -"Параметры:": "Parameters:", -"Сохранение": "Save", -"ВКТСобытия": "VKTEvents", -"ИДКрасного": "RedID", -"ОтветТокен": "TokenResponse", -"параметров": "parameters", -"МассивЧата": "ChatArray", -"Символы.ПС": "Chars.LF", -"библиотека": "library", -"имя товара": "product name", -"Общий диск": "Main drive", -"СоздатьЛид": "CreateLead", -"ДанныеПоля": "FieldData", -"ОзонИстина": "OzonTrue", -"РазбитьURL": "SplitURL", -"Добавление": "Adding", -"IDЭлемента": "ElementID", -"ОжидаетЧто": "ExpectsThat", -"Внутренний": "Internal", -"пожаловать": "welcome", -"Разрешения": "Permissions", -"Вес брутто": "Gross weight", -"ЭтоКаталог": "IsDirectory", -"СтрПроцент": "StrPercentage", -"Получатель": "Recipient", -"имя автора": "author's name", -"тип сделки": "deal type", -"ОзонЛимиты": "OzonLimits", -"ПолеЗаказа": "OrderField", -"завершения": "of complete", -"Все товары": "All goods", -"Библиотека": "Library", -"БитриксЛид": "BitrixLead", -"на сервере": "on the server", -"Количество": "Count", -"ИДКабинета": "CabinetID", -"ЗаписьJSON": "JSONWriter", -"ДокументДД": "DocumentDD", -"ОзонМассив": "OzonArray", -"сортировки": "of sorting", -"ТекущийТип": "CurrentType", -"СлакДиалог": "SlackDialog", -"Расширение": "Extension", -"возвращает": "returns", -"полужирный": "bold", -"Полужирный": "Bold", -"ID альбома": "Album ID", -"количество": "amount", -"артинкулов": "of articles", -"отладочной": "debug", +"Затрачено": "Spend", +"Одиночное": "Single", +"IDЗадания": "TaskID", +"ID канала": "Channel ID", +"Свойства_": "Properties_", +"Сохранить": "Save", +"Истечение": "Expiration", +"URL файла": "File URL", +"ПутьЛогов": "LogPath", +"Заголовки": "Headers", +"заполнена": "filled", +"IDТоваров": "ProductsID", +"Удаленный": "Remote", +"РазмерЛФХ": "SizeLFH", +"ID задачи": "Task ID", +"ВКТИстина": "VKTTrue", +"Значение:": "Value:", +"РазмерЕСД": "SizeESD", +"Ozon (ОПИ": "Ozon (OpenIntegrations", +"ИначеЕсли": "ElsIf", +"СдэкЗаказ": "CdekOrder", +"Массив360": "Array360", +"Опоздание": "Late", +"МассивИД_": "ArrayID_", +"ВКСвойство": "VKProp", +"фактически": "fact", +"ВидЗапроса": "RequestType", +"ВнешнийКод": "ExternalID", +"Соединение": "Connection", +"библиотек:": "libraries:", +"участникам": "to participants", +"ДатаНачала": "StartDate", +"участников": "of users", +"Файл1.docx": "File1.docx", +"Установить": "Set", +"ФайлОбъект": "FileObject", +"ИДПодборки": "SelectionID", +"Примечание": "Note", +"ЧтениеJSON": "JSONReader", +"Аналогичен": "Similar", +"Отложенное": "Sheduled", +"ВККампания": "VCCampaign", +"IDРодителя": "ParentID", "Приложения": "Apps", +"IDАтрибута": "AttributeID", "библиотеки": "libraries", -"ООО Вектор": "LLC Vector", "Тип данных": "Data type", "проведения": "of the event", "ВКПодборка": "VKSelection", @@ -1036,7 +973,6 @@ "ИДКампании": "CampaignID", "Объявление": "Ad", "выполнения": "of completing", -"ВККампания": "VCCampaign", "МассивФото": "PhotoArray", "Приложение": "Application", "Обновление": "Updating", @@ -1044,29 +980,30 @@ "HTTPЗапрос": "HTTPRequest", "КартинкаДД": "ImageDD", "БезСтатуса": "NoStatus", -"IDРодителя": "ParentID", "публикации": "of publish", -"Примечание": "Note", -"фактически": "fact", -"ВидЗапроса": "RequestType", -"ВнешнийКод": "ExternalID", -"Соединение": "Connection", -"библиотек:": "libraries:", -"участникам": "to participants", -"Аналогичен": "Similar", -"ДатаНачала": "StartDate", -"участников": "of users", -"Файл1.docx": "File1.docx", -"Отложенное": "Sheduled", -"Установить": "Set", -"ФайлОбъект": "FileObject", -"ИДПодборки": "SelectionID", -"ЧтениеJSON": "JSONReader", -"ВКСвойство": "VKProp", -"IDАтрибута": "AttributeID", "Файл видео": "Video file", -"СтрТекущее": "StrCurrent", +"КонецЦикла": "EndDo", "отключения": "disconnection", +"они разные": "they are different", +"ID новости": "Post ID", +"Параметры_": "Parameters_", +"ID события": "Event ID", +"Исключение": "Except", +"ИДКаталога": "CatalogID", +"Существует": "Exists", +"Твит с гиф": "Tweet with gif", +"ФайлМетода": "MethodFile", +"ЦветКнопок": "ButtonColor", +"IDСущности": "EntityID", +"IDКабинета": "AccountID", +"УдалитьТег": "DeleteTag", +"последнего": "of last", +"ФорматДаты": "DateFormat", +"отладочной": "debug", +"Файл аудио": "Audio file", +"ИмяТаблицы": "TableName", +"СтрокаBash": "BashString", +"изменивший": "that change", "повторного": "repeated", "МассивИмен": "ArrayOfNames", "СтараяЦена": "OldPrice", @@ -1084,134 +1021,124 @@ "ОзонТовары": "OzonProducts", "Фотокамера": "Photos", "ТокенКанал": "ChannelToken", -"изменивший": "that change", -"КонецЦикла": "EndDo", -"СтрокаBash": "BashString", -"ИмяТаблицы": "TableName", -"Твит с гиф": "Tweet with gif", -"они разные": "they are different", -"ID новости": "Post ID", -"Параметры_": "Parameters_", -"ID события": "Event ID", -"Исключение": "Except", -"ИДКаталога": "CatalogID", -"Существует": "Exists", -"ФайлМетода": "MethodFile", -"Файл аудио": "Audio file", -"ЦветКнопок": "ButtonColor", -"IDСущности": "EntityID", -"IDКабинета": "AccountID", -"УдалитьТег": "DeleteTag", -"последнего": "of last", -"ФорматДаты": "DateFormat", -"исполнитель": "performer", -"СоздатьПост": "CreatePost", -"ОбъектВидео": "VideoObject", -"МассивИмени": "NameParts", -"Токен Viber": "Viber Token", -"МассивОпций": "OptionsArray", -"Выполняется": "In work", -"расширением": "extension", -"ТипЗначения": "ValeType", -"ID варианта": "Variant ID", -"ВерсияСреды": "ВерсияСреды", -"БитриксПоля": "BitrixFields", -"Имя поля БД": "DB field name", -"РазмерБлока": "BlockSize", -"Медиагруппа": "MediaGroup", -"Остаток. -1": "Balance. -1", -"Notion (ОПИ": "Notion (OpenIntegrations", -"Новый заказ": "New order", -"Фон истории": "Story background", -"уведомлений": "notifications", -"наблюдателя": "of auditor", -"IDХранилища": "StorageID", -"ТокенКанала": "ChannelToken", -"ID подборки": "Selection ID", -"НовыйСпособ": "NewMethod", -"ИзИсточника": "FromSource", -"Цель канала": "Channel purpose", -"ВнешнийПост": "ExternalPost", -"электронной": "of e", -"СоздатьПоле": "CreateField", -"Петров Петр": "Petrov Petr", -"ID картинки": "Image ID", -"АТСписокБаз": "ATBasesList", -"ВходнойФайл": "InputFile", -"МассивМедиа": "MediaArray", -"ФайлНаДиске": "FileOnDisk", -"Пример кода": "Code example", -"ПокинутьЧат": "LeaveChat", -"Иванов Иван": "Ivaniv Ivan", -"НомерГруппы": "GroupNumber", -"ОбщийДоступ": "PublicAccess", -"Обновленный": "Updated", -"ОткрытьФайл": "OpenFile", -"Стандартные": "Standard", -"JSON данные": "JSON data", -"ВККатегории": "VKCategories", -"ИмяКонтакта": "ContactName", -"ОбщийРазмер": "TotalSize", -"ТекущаяДата": "CurrentDate", -"ТипКонтента": "ContentType", -"ЭтоУдаление": "ThisIsDeletion", -"ТелоЗапроса": "RequestBody", -"ТипВложений": "AttachmentsType", -"НовыйЗапрос": "NewRequest", -"старая цена": "old price", -"комментария": "of comment", -"МедиаГруппа": "MediaGroup", -"МассивПолей": "FieldArray", -"Отправитель": "Sender", -"Суперклиент": "SuperClient", -"СтрокаФайла": "FileString", -"РазмерЧасти": "ChunkSize", -"УдалитьФайл": "DeleteFile", -"КлючСтрокой": "KeyString", -"Новый товар": "New product", -"НоушнОбъект": "NotionObject", -"UUID заказа": "Order UUID", -"ТекущийПуть": "CurrentPath", -"ДобавитьТег": "AddTag", -"IDСообщения": "MessageID", -"ВернутьБлок": "ReturnBlock", -"ТекущийКлюч": "CurrentKey", -"МассивГифок": "GifsArray", -"ТестовыйAPI": "TestAPI", -"электронная": "e", -"Текст поста": "Post text", -"Удалить тег": "Delete tag", -"ПутиСтрокой": "PathsString", -"НайтиСтроки": "FindRows", -"НомерЗаказа": "OrderNumber", -"УдалитьЛист": "DeleteSheet", -"ID элемента": "Element ID", -"Повторяемая": "Repeatable", -"Тема канала": "Channel topic", -"ОтборПоТипу": "FilterByType", -"Новосибирск": "Novosibirsk", -"ЛишниеБайты": "ExtraBytes", -"СоздатьБазу": "CreateDatabase", -"МассивСвязи": "LinkArray", -"Создать лид": "Create lead", -"ТелеграмБан": "TelegramBan", -"IDОригинала": "OriginalID", -"ID страницы": "Page ID", -"КопироватьВ": "CopyTo", -"ОченьВажное": "VeryImportant", -"ОтборСтрока": "FilterString", -"Комментарии": "Comments", +"СтрТекущее": "StrCurrent", +"артинкулов": "of articles", +"ООО Вектор": "LLC Vector", +"ID альбома": "Album ID", +"ID диалога": "Dialog ID", +"НовяИконка": "NewIcon", +"Пропустить": "Skip", +"Продолжить": "Continue", +"информации": "information", +"Информация": "Information", +"Б24_Канбан": "B24_Kanban", +"Назначение": "Destination", +"ПутьКФайлу": "FilePath", +"СерверФото": "PhotoServer", +"Текст тега": "Tag text", +"Параметры:": "Parameters:", +"Сохранение": "Save", +"ВКТСобытия": "VKTEvents", +"ИДКрасного": "RedID", +"ОтветТокен": "TokenResponse", +"Статистика": "Statistics", +"Интеграция": "Integrations", +"ПутьНового": "NewPath", +"НайтиФайлы": "FindFiles", +"количество": "amount", +"Токен бота": "Bot token", +"Мегаклиент": "MegaClient", +"ИДКартинки": "ImageID", +"ХешФункция": "HashFunction", +"ЦветТекста": "TextColor", +"ФайлВывода": "OutputFile", +"УдалитьЛид": "DeleteLead", +"бибилотека": "library", +"ЖиваяЛента": "NewsFeed", +"Новый файл": "NewFile", +"ИмеетДлину": "HasLength", +"ТекущееИмя": "CurrentName", +"МассивПочт": "EmailsArray", +"СоздатьЧат": "CreateChat", +"ИДВарианта": "VariantID", +"IDКартинки": "ImageID", +"параметров": "parameters", +"МассивЧата": "ChatArray", +"ВКЭлементы": "VKElement", +"библиотека": "library", +"Все товары": "All goods", +"Библиотека": "Library", +"БитриксЛид": "BitrixLead", +"на сервере": "on the server", +"Количество": "Count", +"ИДКабинета": "CabinetID", +"ЗаписьJSON": "JSONWriter", +"завершения": "of complete", +"ОзонМассив": "OzonArray", +"ТекущийТип": "CurrentType", +"СлакДиалог": "SlackDialog", +"Расширение": "Extension", +"возвращает": "returns", +"полужирный": "bold", +"Символы.ПС": "Chars.LF", +"Полужирный": "Bold", +"сортировки": "of sorting", +"ПолеЗаказа": "OrderField", +"ДокументДД": "DocumentDD", +"тип сделки": "deal type", +"имя товара": "product name", +"Общий диск": "Main drive", +"ОзонЛимиты": "OzonLimits", +"СоздатьЛид": "CreateLead", +"ДанныеПоля": "FieldData", +"ОзонИстина": "OzonTrue", +"Добавление": "Adding", +"IDЭлемента": "ElementID", +"ОжидаетЧто": "ExpectsThat", +"РазбитьURL": "SplitURL", +"Внутренний": "Internal", +"пожаловать": "welcome", +"Разрешения": "Permissions", +"Вес брутто": "Gross weight", +"ЭтоКаталог": "IsDirectory", +"СтрПроцент": "StrPercentage", +"Получатель": "Recipient", +"имя автора": "author's name", +"JSONСтрокой": "JSONString", +"IDВходящего": "RepliedID", +"ID Родителя": "Parent ID", +"Уведомления": "Notifications", +"НеЗаполнено": "Empty", +"МассивВидео": "VideosArray", +"Цена товара": "Product price", +"Скопировать": "Copy", +"Хеширование": "Hashing", +"постановщик": "producer", +"Тест диалог": "Test dialog", +"Для YaxUnit": "For YAxUnit", +"УдалитьБлок": "DeleteBlock", +"СкачатьФайл": "DownloadFile", +"комментарии": "comments", +"БитриксФайл": "BitrixFile", +"ОбщийМодуль": "CommonModule", +"Комментарий": "Comment", +"Бот Виталий": "Vitaly The Bot", +"ЧастейИмени": "NeedParts", +"Новое видео": "NewVideo", +"ЗаменаТочки": "DotReplacement", +"ЦветКонсоли": "ConsoleColor", +"ID атрибута": "Attribute ID", +"обновляемых": "of updated", "ТекстОтвета": "ReplyText", "ТекстКнопки": "ButtonText", "IDИсточника": "FromID", "НоваяСтрока": "NewLine", -"ЦветКонсоли": "ConsoleColor", "СоздатьБлок": "CreateBlock", "МассивПутей": "PathsArray", "IDКатегории": "CategoryID", "СлакОбласти": "SlackWorkspaces", +"дата начала": "start date", "ПолеОтметки": "TimestampField", -"ТекущийФайл": "CurrentFile", "ИДКатегории": "CategoryID", "вероятность": "probability", "Примечание:": "Note", @@ -1221,34 +1148,34 @@ "СтрЗаменить": "StrReplace", "МассивЯчеек": "CellsArray", "Мессенджеры": "Messengers", -"ID атрибута": "Attribute ID", -"дата начала": "start date", -"ЗаменаТочки": "DotReplacement", -"Бот Виталий": "Vitaly The Bot", -"JSONСтрокой": "JSONString", -"МассивВидео": "VideosArray", -"Цена товара": "Product price", -"НеЗаполнено": "Empty", -"Хеширование": "Hashing", -"Уведомления": "Notifications", -"ID Родителя": "Parent ID", -"ZipРазмерDD": "ZipSizeDD", -"Скопировать": "Copy", -"постановщик": "producer", -"Новое видео": "NewVideo", -"Для YaxUnit": "For YAxUnit", -"УдалитьБлок": "DeleteBlock", -"СкачатьФайл": "DownloadFile", -"комментарии": "comments", -"БитриксФайл": "BitrixFile", -"Тест диалог": "Test dialog", -"ОбщийМодуль": "CommonModule", -"Комментарий": "Comment", -"ЧастейИмени": "NeedParts", -"обновляемых": "of updated", +"ТекущийФайл": "CurrentFile", "ДанныеБлока": "BlockData", -"Инструменты": "Tools", +"Для Asserts": "For Asserts", "ИзменитьЛид": "UpdateLead", +"Постановщик": "Producer", +"ДанныеСхемы": "SchemaData", +"ЦелевойПуть": "TargetPath", +"УдалитьПост": "DeletePost", +"Петр Петров": "Petr Petrov", +"ID подборок": "Selection IDs", +"ОбщиеМетоды": "CommonMethods", +"ЗаписатьЛог": "WriteLog", +"АдресАвтора": "АдресАвтора", +"миллиметрах": "millimeters", +"МассивБлока": "ArrayBlock", +"СоздатьЛист": "CreateSheet", +"Имя таблицы": "Table name", +"URLЗагрузки": "UploadURL", +"ПолныйОтвет": "FullResponse", +"Создать чат": "Create chat", +"ГуглКаталог": "GoogleCatalog", +"ДокументURL": "DocumentURL", +"ДанныеФайла": "FileData", +"Комментарии": "Comments", +"ЯДискСсылка": "YaDiskLink", +"B64Картинка": "B64Image", +"ИмяСодержит": "NameContains", +"РефрешТокен": "RefreshToken", "АдресаПочты": "EmailAddresses", "Сортировать": "Sort", "IDПриемника": "DestinationID", @@ -1270,131 +1197,129 @@ "перемещения": "of movement", "ТекстОшибки": "ErrorText", "Исполнитель": "Responsible", -"РефрешТокен": "RefreshToken", -"ИмяСодержит": "NameContains", -"B64Картинка": "B64Image", -"миллиметрах": "millimeters", -"Постановщик": "Producer", -"ДанныеСхемы": "SchemaData", -"ЦелевойПуть": "TargetPath", -"УдалитьПост": "DeletePost", -"Петр Петров": "Petr Petrov", -"ID подборок": "Selection IDs", -"ОбщиеМетоды": "CommonMethods", -"ЗаписатьЛог": "WriteLog", -"АдресАвтора": "АдресАвтора", -"МассивБлока": "ArrayBlock", -"ЯДискСсылка": "YaDiskLink", -"СоздатьЛист": "CreateSheet", -"Для Asserts": "For Asserts", -"Имя таблицы": "Table name", -"URLЗагрузки": "UploadURL", -"ПолныйОтвет": "FullResponse", -"Создать чат": "Create chat", -"ГуглКаталог": "GoogleCatalog", -"ДокументURL": "DocumentURL", -"ДанныеФайла": "FileData", -"IDВходящего": "RepliedID", -"ТестыРаздела": "SectionTests", -"Base64Строка": "Base64String", -"ДропБоксФайл": "DropboxFile", -"IDПоследнего": "LastID", -"КонецОбласти": "EndRegion", -"пользователя": "of user", -"КартинкаПуть": "ImagePath", -"Пользователи": "Users", -"Криптография": "Cryptography", -"ВКОбсуждение": "VKDiscussion", -"ДокументПуть": "DocumentPath", -"КонечнаяДата": "EndDate", -"ПотокВПамяти": "MemoryStream", -"Удалить лист": "Delete sheet", -"color=Желтый": "color=Yellow", -"ВКТСообщение": "VKTMessage", -"ЧтениеДанных": "DataReader", -"СоздатьКнигу": "CreateSpreadsheet", -"Новая задача": "New task", -"ОписаниеТипа": "TypeDescription", -"ПрочитатьZip": "ReadZip", -"ДатаОтправки": "SendingDate", -"МассивБлоков": "BlockArray", -"БитриксВремя": "BitrixTime", -"ВКОбъявление": "VKAdversting", -"Текст кнопки": "Button text", -"МестноеВремя": "ToLocalTime", -"МассивЛишних": "ExtraArray", -"Текст ответа": "Answer text", -"Удалить файл": "Delete file", -"Закрытый чат": "Private chat", -"ZipРазмерLFH": "ZipSizeLFH", -"ЦветнойВывод": "ColorOutput", -"Создать базу": "Create base", -"ГуглКаталоги": "GoogleCatalogs", -"ПрочитатьВсе": "ReadAll", -"ТекущийТовар": "CurrentProduct", -"Архивирована": "Archived", -"OPI_ТестыCLI": "OPI_TestsCLI", -"ОтветСтрокой": "ResponseString", -"КодировкаURL": "URLencoding", -"ТекстСправки": "HelpText", -"Число,Строка": "Number, String", -"Конецфункции": "EndFunction", -"пустой ответ": "empty response", -"СписокКоманд": "CommandList", -"крайний срок": "deadline", -"РодительБаза": "ParentBase", -"ДанныеЯчейки": "CellData", -"Дата инвойса": "Invoice date", -"Номер заказа": "Order number", -"ОткрытьПоток": "OpenStream", -"МассивЛистов": "SheetArray", -"СоздатьЗаказ": "CreateOrder", -"Произвольный": "Arbitrary", -"СтрокаМетода": "MethodLine", -"ВключитьФайл": "ВключитьФайл", -"ПубличныйURL": "PublicURL", -"СоздатьПапку": "CreateFolder", -"ЗаписьДанных": "DataWriter", -"ИзменитьПоле": "ModifyField", -"Создать блок": "Create block", -"ДневнойЛимит": "DailyLimit", -"ДопЗаголовки": "AdditionalHeaders", -"УдалитьТовар": "DeleteProduct", -"Получить лид": "Get lead", -"МассивЧтения": "ArrayReading", -"ЗаписатьJSON": "WriteJSON", -"Имя каталога": "Folder name", -"Тип вложений": "Attachments type", -"Строка,Число": "String, Number", -"МассивФайлов": "ArrayOfFiles", -"наименование": "name", -"пользователь": "user", -"Изменить лид": "Update lead", -"Общие методы": "Common methods", -"Дни рождения": "Hollydays", -"МассивДанных": "DataArray", -"IDОбсуждения": "DiscussionID", -"ДокументЛога": "LogDocument", -"Твит с видео": "Tweet with video", -"ПолучитьДату": "GetDate", -"ОписаниеJSON": "JSONDescription", -"Использовать": "Use", -"СтруктураURL": "URLStructure", -"ОбновитьФайл": "UpdateFile", -"ДобавитьЛист": "AddSheet", -"УдалитьФайлы": "DeleteFiles", -"ПолучитьФайл": "GetFile", -"ВнешняяСтена": "ExternalWall", -"МассивПостов": "ArrayOfPosts", -"ОбъектИконка": "IconObject", -"СкачатьПапку": "DownloadFolder", -"БитриксЧисло": "BitrixNumber", -"приглашениям": "invitations", -"ИДОбсуждения": "DiscussionID", -"ВКСтатистика": "VKStatistics", -"загружаемого": "uploading", -"Покинуть чат": "Leave chat", +"Инструменты": "Tools", +"ОтборСтрока": "FilterString", +"ZipРазмерDD": "ZipSizeDD", +"КопироватьВ": "CopyTo", +"НовыйСпособ": "NewMethod", +"ИзИсточника": "FromSource", +"Цель канала": "Channel purpose", +"ВнешнийПост": "ExternalPost", +"электронной": "of e", +"СоздатьПоле": "CreateField", +"Петров Петр": "Petrov Petr", +"ID картинки": "Image ID", +"АТСписокБаз": "ATBasesList", +"ТокенКанала": "ChannelToken", +"ВходнойФайл": "InputFile", +"ФайлНаДиске": "FileOnDisk", +"Пример кода": "Code example", +"ПокинутьЧат": "LeaveChat", +"Иванов Иван": "Ivaniv Ivan", +"НомерГруппы": "GroupNumber", +"ОбщийДоступ": "PublicAccess", +"Обновленный": "Updated", +"ОткрытьФайл": "OpenFile", +"Стандартные": "Standard", +"МассивМедиа": "MediaArray", +"JSON данные": "JSON data", +"IDХранилища": "StorageID", +"уведомлений": "notifications", +"ОченьВажное": "VeryImportant", +"исполнитель": "performer", +"СоздатьПост": "CreatePost", +"ОбъектВидео": "VideoObject", +"МассивИмени": "NameParts", +"Токен Viber": "Viber Token", +"МассивОпций": "OptionsArray", +"Выполняется": "In work", +"расширением": "extension", +"наблюдателя": "of auditor", +"ТипЗначения": "ValeType", +"ВерсияСреды": "ВерсияСреды", +"БитриксПоля": "BitrixFields", +"Имя поля БД": "DB field name", +"РазмерБлока": "BlockSize", +"Медиагруппа": "MediaGroup", +"Остаток. -1": "Balance. -1", +"Notion (ОПИ": "Notion (OpenIntegrations", +"Новый заказ": "New order", +"Фон истории": "Story background", +"ID варианта": "Variant ID", +"ВККатегории": "VKCategories", +"ID подборки": "Selection ID", +"ОбщийРазмер": "TotalSize", +"МассивГифок": "GifsArray", +"ТестовыйAPI": "TestAPI", +"электронная": "e", +"Текст поста": "Post text", +"Удалить тег": "Delete tag", +"ПутиСтрокой": "PathsString", +"НайтиСтроки": "FindRows", +"НомерЗаказа": "OrderNumber", +"ID элемента": "Element ID", +"Повторяемая": "Repeatable", +"Тема канала": "Channel topic", +"ОтборПоТипу": "FilterByType", +"Новосибирск": "Novosibirsk", +"ЛишниеБайты": "ExtraBytes", +"СоздатьБазу": "CreateDatabase", +"МассивСвязи": "LinkArray", +"Создать лид": "Create lead", +"ТелеграмБан": "TelegramBan", +"IDОригинала": "OriginalID", +"ИмяКонтакта": "ContactName", +"ID страницы": "Page ID", +"ТекущийКлюч": "CurrentKey", +"ВернутьБлок": "ReturnBlock", +"УдалитьЛист": "DeleteSheet", +"ТипКонтента": "ContentType", +"ТекущаяДата": "CurrentDate", +"IDСообщения": "MessageID", +"ЭтоУдаление": "ThisIsDeletion", +"ТелоЗапроса": "RequestBody", +"ТипВложений": "AttachmentsType", +"НовыйЗапрос": "NewRequest", +"старая цена": "old price", +"МедиаГруппа": "MediaGroup", +"МассивПолей": "FieldArray", +"Отправитель": "Sender", +"комментария": "of comment", +"СтрокаФайла": "FileString", +"ДобавитьТег": "AddTag", +"Суперклиент": "SuperClient", +"UUID заказа": "Order UUID", +"НоушнОбъект": "NotionObject", +"Новый товар": "New product", +"ТекущийПуть": "CurrentPath", +"УдалитьФайл": "DeleteFile", +"РазмерЧасти": "ChunkSize", +"КлючСтрокой": "KeyString", +"ОднаПодОдной": "OneByOne", +"Удалить пост": "Delete post", +"НовыйПрефикс": "NewPrefix", +"ID, Значение": "ID, Value", +"данные файла": "file's binary data", +"Удалить блок": "Delete block", +"ОсновнойЦвет": "PrimaryColor", +"ИДОбъявления": "AnnouncementID", +"МассивТестов": "ArrayOfTests", +"Рефреш токен": "Refresh token", +"Имя контакта": "Contact name", +"URL картинки": "Image URL", +"ЧтениеТекста": "TextReader", +"РазмерДанных": "DataSize", +"КодСостояния": "StatusCode", +"Существующее": "Existing", +"ТвиттерТокен": "TwitterToken", +"ID чата темы": "Thread chat ID", +"ТипКоллекции": "CollectionType", +"КонецПопытки": "EndTry", +"ИмяПараметра": "ParameterName", +"ЯДискКаталог": "YaDiskFolder", "СоздатьОтказ": "CreateRefusal", +"СоздатьКанал": "CreateChannel", +"При отправке": "When sending data is", "Неопределено": "Undefined", "ЗаписьТекста": "TextRecord", "СжатыеДанные": "CompressedData", @@ -1402,10 +1327,9 @@ "ОзонКартинки": "OzonPictures", "ПараметрыURL": "URLParameters", "Вернуть блок": "Return block", -"КлючКартинка": "ImageKey", "КонецФункции": "EndFunction", +"ID календаря": "Calendar ID", "МассивТаблиц": "TableArray", -"МассивКнопок": "ButtonArray", "ФайлОтправки": "SendingFile", "Документация": "Read the Docs", "ВайберОнлайн": "ViberOnline", @@ -1415,34 +1339,35 @@ "IDОбъявления": "AdID", "Скачать файл": "Download file", "ОсновноеФото": "MainPhoto", -"СоздатьКанал": "CreateChannel", -"ID календаря": "Calendar ID", -"ЯДискКаталог": "YaDiskFolder", -"КонецПопытки": "EndTry", -"МассивТестов": "ArrayOfTests", -"Удалить пост": "Delete post", -"НовыйПрефикс": "NewPrefix", -"ID, Значение": "ID, Value", -"данные файла": "file's binary data", -"Удалить блок": "Delete block", -"ОсновнойЦвет": "PrimaryColor", -"ИДОбъявления": "AnnouncementID", -"ОднаПодОдной": "OneByOne", -"Рефреш токен": "Refresh token", -"ИмяПараметра": "ParameterName", -"URL картинки": "Image URL", -"ЧтениеТекста": "TextReader", -"РазмерДанных": "DataSize", -"КодСостояния": "StatusCode", -"Существующее": "Existing", -"ТвиттерТокен": "TwitterToken", -"ID чата темы": "Thread chat ID", -"ТипКоллекции": "CollectionType", -"Имя контакта": "Contact name", -"При отправке": "When sending data is", +"МассивКнопок": "ButtonArray", "ФайлПримеров": "FileExample", -"ЦелеваяСтена": "TargetWall", +"родительской": "of parrent", "Сформировать": "Formulate", +"элементы CRM": "CRM elements", +"СоздатьОпрос": "CreatePoll", +"ДропБоксТеги": "DropboxTags", +"Текст правил": "Rules Text", +"Путь, Данные": "Path, Data", +"ТонкийКлиент": "ThinClient", +"Telegram_Бан": "Telegram_Ban", +"Пользователь": "User", +"ДобавитьПоле": "AddField", +"ОтборКоманды": "CommandSelection", +"Наименование": "Name", +"ТолькоОснова": "OnlyBase", +"Архивировать": "Archive", +"прикрепления": "of attachments", +"Длительность": "Duration", +"Соответствие": "Map", +"ID сообщения": "Message ID", +"ТекущаяОпция": "CurrentOption", +"ЭтоOneScript": "IsOneScript", +"Покинуть чат": "Leave chat", +"МассивТекста": "TextArray", +"КлючДвоичные": "BinaryKey", +"ЦелеваяСтена": "TargetWall", +"МассивОшибок": "ErrorsArray", +"КаталогЛогов": "LogDirectory", "Создать поле": "Create field", "Twitter (ОПИ": "Twitter (OpenIntegrations", "Тестирование": "Testing", @@ -1464,166 +1389,149 @@ "Создать пост": "Create post", "ЧислоВСтроку": "NumberToString", "Перемещенная": "Moved", -"КаталогЛогов": "LogDirectory", "Дублирования": "duplicates", -"МассивОшибок": "ErrorsArray", -"КлючДвоичные": "BinaryKey", -"элементы CRM": "CRM elements", -"СоздатьОпрос": "CreatePoll", -"ДропБоксТеги": "DropboxTags", -"Текст правил": "Rules Text", -"Путь, Данные": "Path, Data", -"ТонкийКлиент": "ThinClient", -"Telegram_Бан": "Telegram_Ban", -"Пользователь": "User", -"ДобавитьПоле": "AddField", -"ОтборКоманды": "CommandSelection", -"Наименование": "Name", -"ТолькоОснова": "OnlyBase", -"Архивировать": "Archive", -"прикрепления": "of attachments", -"Длительность": "Duration", -"Соответствие": "Map", -"ID сообщения": "Message ID", -"ТекущаяОпция": "CurrentOption", -"ЭтоOneScript": "IsOneScript", -"родительской": "of parrent", -"МассивТекста": "TextArray", -"НомерСтраницы": "PageNumber", -"РазмерТекущих": "CurrentSize", -"дополнительно": "additionally", -"ЛокальныйПуть": "LocalPath", -"БитриксСтрока": "BitrixString", -"ДатаОкончания": "EndDate", -"ВозможныеПути": "PossiblePaths", -"СоздатьЗадачу": "CreateTask", -"ЛокальныеПути": "LocalPaths", -"ЛокальныйФайл": "LocalFile", -"Продажа в RUB": "Sale in RUB", -"маркетинговый": "Marketing", -"Наименование1": "Filename1", -"Тестовая база": "TestDatabase", -"Идентификатор": "Identifier", -"ПараАртикулов": "ArticlesPair", -"Текст новости": "Text of post", -"ПокинутьКанал": "LeaveChannel", -"ПараметрыJSON": "JSONParameters", -"ВозможныйФайл": "PossibleFile", -"Скачать папку": "Download folder", -"ЭлементДанных": "DataElement", -"СлакЭфемерное": "SlackEphemeral", -"СписокТоваров": "ProductList", -"БитриксИстина": "BitrixTrue", -"ТекущийРаздел": "CurrentSection", -"Одноклассники": "Classmates", -"IDКомментария": "CommentID", -"ТелеграмГифка": "TelegramGif", -"ЗапросыСТелом": "RequestsWithBody", -"ОбработатьТег": "ProcessTag", -"ТелеграмЧисло": "TelegramNumber", -"Описание чата": "Chat description", -"Обновить файл": "Update file", -"ПодСообщением": "UnderMessage", -"Размер скидки": "Discount amount", -"ЗакрытьСессию": "CloseSession", -"Код материала": "Material code", -"АТКомментарии": "ATComments", -"ОписаниеТипов": "TypeDescription", -"Администратор": "Administrator", -"ID обсуждения": "Discussion ID", -"Дата рождения": "Birth date", -"РаботаСДиском": "WorkingWithDrive", -"Переадресация": "Redirection", -"Bitrix24 (ОПИ": "Bitrix24 (OpenIntegrations", -"Массив кнопок": "Array of buttons", -"МассивПозиций": "ItemsArray", -"Экранирование": "Escaping", -"Прочитать все": "Read all", -"Первый запуск": "First start", -"СимволМассива": "ArraySymbol", -"ТекущиеДанные": "CurrentData", -"МассивОтветов": "AnswersArray", -"МассивТоваров": "ProductsArray", -"МассивСобытий": "ArrayOfEvents", -"Начало работы": "Getting started", -"БитриксСделка": "BitrixDeal", -"БитриксОбъект": "BitrixObject", -"Наименование2": "Filename2", -"Описание поля": "Field description", -"СтруктураПоля": "FieldStructure", -"ФайловыйПоток": "FileStream", -"VK Teams (ОПИ": "VK Teams (OpenIntegrations", -"СоздатьСделку": "CreateDeal", -"СвойстваЛиста": "SheetProperties", -"СлакСообщения": "SlackMessages", -"Airtable (ОПИ": "Airtable (OpenIntegrations", -"ВставитьПосле": "InsertAfter", -"IDЦитируемого": "ReplyID", -"Новая таблица": "NewTable", -"ПолучитьТекст": "GetText", -"ДанныеСобытия": "callbackData", -"ЭтоОтложенное": "IsDelayed", -"СоздатьЗаписи": "CreatePosts", -"ПолучитьКанал": "GetChannel", -"СтрокаНомеров": "NumbersString", -"Telegram (ОПИ": "Telegram (OpenIntegrations", -"ПрочитатьJSON": "ReadJSON", -"новый каталог": "new catalog", -"ТекущаяЗапись": "CurrentRecord", -"Версия: 2.4.8": "Version: 2.4.8", -"Дата создания": "CreationDate", -"БитриксБулево": "BitrixBool", -"ТелеграмВидео": "TelegramVideo", -"IDУведомления": "NotificationID", -"UnixИстечение": "UnixExpiration", -"ЛишниеСимволы": "ExtraCharacters", -"Массив файлов": "Files array", -"СоздатьЗапрос": "CreateRequest", -"ТекущийОбъект": "CurrentObject", -"МассивКаналов": "ChannelArray", -"УдалитьОбъект": "DeleteObject", -"Строка, Число": "String, Number", -"СтруктураЧата": "ChatStructure", -"дата создания": "date of creation", -"ГуглКалендарь": "GoogleCalendar", -"СлакСообщение": "SlackMessage", -"ИзменитьТовар": "EditProduct", -"МассивПорогов": "ThresholdsArray", -"Строка адреса": "Address string", -"ЗакрытьДиалог": "CloseDialog", -"Блок с файлом": "FileBlock", -"ОбновитьТокен": "RefreshToken", -"ПорядокБайтов": "ByteOrder", -"УдалитьСделку": "DeleteDeal", -"СтруктураДаты": "DateStructure", -"ВККомментарий": "VKComment", -"КомплексныйID": "ComplexID", -"Создать заказ": "Create order", -"СкрытьИсторию": "HideHistory", -"YandexID (ОПИ": "YandexID (OpenIntegrations", -"ПолучитьЗаказ": "GetOrder", -"Refresh токен": "Refresh token", -"НомерТелефона": "PhoneNumber", -"Это новый чат": "This is a new chat", -"ВозможныйПуть": "PossiblePath", -"ИДКомментария": "CommentID", -"РаботаСЧатами": "ChatManagment", -"ЗагрузитьФайл": "UploadFile", -"ОткрытьДиалог": "OpenDialog", +"загружаемого": "uploading", +"КлючКартинка": "ImageKey", +"ИДОбсуждения": "DiscussionID", +"Текст кнопки": "Button text", +"МестноеВремя": "ToLocalTime", +"МассивЛишних": "ExtraArray", +"Текст ответа": "Answer text", +"Удалить файл": "Delete file", +"Закрытый чат": "Private chat", +"ZipРазмерLFH": "ZipSizeLFH", +"ЦветнойВывод": "ColorOutput", +"Создать базу": "Create base", +"ВКОбъявление": "VKAdversting", +"ГуглКаталоги": "GoogleCatalogs", +"ТекущийТовар": "CurrentProduct", +"Архивирована": "Archived", +"OPI_ТестыCLI": "OPI_TestsCLI", +"ОтветСтрокой": "ResponseString", +"КодировкаURL": "URLencoding", +"ТекстСправки": "HelpText", +"Число,Строка": "Number, String", +"Конецфункции": "EndFunction", +"пустой ответ": "empty response", +"ПрочитатьВсе": "ReadAll", +"БитриксВремя": "BitrixTime", +"МассивБлоков": "BlockArray", +"ДатаОтправки": "SendingDate", +"ВКСтатистика": "VKStatistics", +"ТестыРаздела": "SectionTests", +"Base64Строка": "Base64String", +"ДропБоксФайл": "DropboxFile", +"IDПоследнего": "LastID", +"КонецОбласти": "EndRegion", +"пользователя": "of user", +"КартинкаПуть": "ImagePath", +"Пользователи": "Users", +"Криптография": "Cryptography", +"ВКОбсуждение": "VKDiscussion", +"ДокументПуть": "DocumentPath", +"КонечнаяДата": "EndDate", +"ПотокВПамяти": "MemoryStream", +"Удалить лист": "Delete sheet", +"color=Желтый": "color=Yellow", +"ВКТСообщение": "VKTMessage", +"ЧтениеДанных": "DataReader", +"СоздатьКнигу": "CreateSpreadsheet", +"Новая задача": "New task", +"ПрочитатьZip": "ReadZip", +"СписокКоманд": "CommandList", +"крайний срок": "deadline", +"ОписаниеТипа": "TypeDescription", +"ДанныеЯчейки": "CellData", +"Изменить лид": "Update lead", +"Общие методы": "Common methods", +"Дни рождения": "Hollydays", +"МассивДанных": "DataArray", +"IDОбсуждения": "DiscussionID", +"ДокументЛога": "LogDocument", +"Твит с видео": "Tweet with video", +"ПолучитьДату": "GetDate", +"ОписаниеJSON": "JSONDescription", +"Использовать": "Use", +"ОбновитьФайл": "UpdateFile", +"ДобавитьЛист": "AddSheet", +"УдалитьФайлы": "DeleteFiles", +"ПолучитьФайл": "GetFile", +"ВнешняяСтена": "ExternalWall", +"МассивПостов": "ArrayOfPosts", +"ОбъектИконка": "IconObject", +"СкачатьПапку": "DownloadFolder", +"БитриксЧисло": "BitrixNumber", +"РодительБаза": "ParentBase", +"приглашениям": "invitations", +"пользователь": "user", +"наименование": "name", +"СтруктураURL": "URLStructure", +"Строка,Число": "String, Number", +"Дата инвойса": "Invoice date", +"Номер заказа": "Order number", +"МассивФайлов": "ArrayOfFiles", +"ОткрытьПоток": "OpenStream", +"МассивЛистов": "SheetArray", +"СоздатьЗаказ": "CreateOrder", +"Произвольный": "Arbitrary", +"ВключитьФайл": "ВключитьФайл", +"ПубличныйURL": "PublicURL", +"СоздатьПапку": "CreateFolder", +"ЗаписьДанных": "DataWriter", +"СтрокаМетода": "MethodLine", +"ИзменитьПоле": "ModifyField", +"Создать блок": "Create block", +"ДневнойЛимит": "DailyLimit", +"ДопЗаголовки": "AdditionalHeaders", +"Тип вложений": "Attachments type", +"УдалитьТовар": "DeleteProduct", +"Получить лид": "Get lead", +"МассивЧтения": "ArrayReading", +"ЗаписатьJSON": "WriteJSON", +"Имя каталога": "Folder name", +"КонечныйОтвет": "FinalResponse", +"Новый каталог": "New catalog", +"ПолучитьТокен": "GetToken", +"БитриксЗадача": "BitrixTask", +"Добавить лист": "Add sheet", +"ФайлЛокальный": "LocalFile", +"ОбъектОбложка": "CoverObject", +"Вопрос опроса": "Poll question", +"Блок картинки": "Image block", +"color=Зеленый": "color=Green", +"Твиттер_Твиты": "TwitterAPI_Tweets", +"АдресЗагрузки": "UploadURL", +"Новое событие": "New event", +"РаботаСБазами": "WorkingWithDatabases", +"IDПодкаталога": "SubfolderID", +"Файл с Base64": "Base64 File", +"ДвойныеКавчки": "DoubleQuotes", +"СтрокаЗапуска": "LaunchString", +"ЕдиницаДанных": "DataUnit", +"Картинка2.jpg": "Picture2.jpg", +"ПолучитьКнигу": "GetSpreadsheet", +"соисполнителя": "co-preformer", +"Отрицательная": "Negative", +"пустая строка": "empty string", +"СделатьРепост": "MakeRepost", +"ЗагрузкаВидео": "VideoUpload", +"ТекущийСтатус": "CurrentStatus", +"РаботаСТегами": "TagsManagment", +"ВыборЗначения": "ValueSelection", +"Создано из 1С": "Created by 1C", "ВладелецВидео": "VideoOwner", "Файл размером": "File with size", "БитриксДиалог": "BitrixDialog", "Соответствие_": "Map_", "РАЗЛОЖИТЬJSON": "PARSEJSON", -"РаботаСТегами": "TagsManagment", "Граница Тогда": "Border Then", "ТекущийМассив": "CurrentArray", "СоздатьАльбом": "CreateAlbum", "ОткрытьСессию": "OpenSession", "Удалить товар": "Delete product", "СтрокаЗаписей": "RecordString", +"ОтправитьФайл": "SendFile", "ТаблицаТестов": "TestTable", -"РаботаСПолями": "WorkingWithFields", "Метод,Область": "Method,Region", "ИсходныйПоток": "SourceStream", "ДатаИстечения": "ExpirationDate", @@ -1636,69 +1544,10 @@ "ПрочитатьGZip": "ReadGZip", "ZipРазмерEOCD": "ZipSizeEOCD", "НовыйРодитель": "NewParent", -"ВыборЗначения": "ValueSelection", -"ОтправитьФайл": "SendFile", -"ТекущийСтатус": "CurrentStatus", -"пустая строка": "empty string", -"Твиттер_Твиты": "TwitterAPI_Tweets", -"Вопрос опроса": "Poll question", -"Блок картинки": "Image block", -"Добавить лист": "Add sheet", -"ОбъектОбложка": "CoverObject", -"ФайлЛокальный": "LocalFile", -"БитриксЗадача": "BitrixTask", -"ПолучитьТокен": "GetToken", -"Новый каталог": "New catalog", -"КонечныйОтвет": "FinalResponse", -"color=Зеленый": "color=Green", -"АдресЗагрузки": "UploadURL", -"ЗагрузкаВидео": "VideoUpload", -"РаботаСБазами": "WorkingWithDatabases", -"IDПодкаталога": "SubfolderID", -"Файл с Base64": "Base64 File", -"ДвойныеКавчки": "DoubleQuotes", -"СтрокаЗапуска": "LaunchString", -"ЕдиницаДанных": "DataUnit", -"Картинка2.jpg": "Picture2.jpg", -"ПолучитьКнигу": "GetSpreadsheet", -"Новое событие": "New event", -"соисполнителя": "co-preformer", -"Отрицательная": "Negative", -"СделатьРепост": "MakeRepost", -"Создано из 1С": "Created by 1C", +"РаботаСПолями": "WorkingWithFields", "Создать опрос": "Create poll", -"Создать отказ": "Create refusal", +"Число, Строка": "Number, String", "Тестовая цель": "TestGoal", -"Положительная": "Positive", -"ОтветЗагрузки": "UploadResponse", -"БитриксСписок": "BitrixList", -"дата закрытия": "closing date", -"БитриксМассив": "BitrixArray", -"ОтветПроверки": "CheckResponse", -"ВывестиСтроку": "PrintString", -"ID объявления": "Ad ID", -"идентификатор": "identifier", -"УдалитьЗадачу": "DeleteTask", -"Изменить поле": "Modify field", -"Множественная": "Multiple", -"ПереслатьФайл": "ResendFile", -"НомерКампании": "CampaignNumber", -"КодУстройства": "DeviceCode", -"ДФ=yyyy-MM-dd": "DF=yyyy-MM-dd", -"ПутьОригинала": "OriginalPath", -"Срок действия": "Expiration date", -"Картинка1.jpg": "Picture1.jpg", -"ТелеграмАудио": "TelegramAudio", -"ПолучитьЧисло": "GetNumber", -"РазложитьJSON": "ParseJSON", -"Создать канал": "Create channel", -"не ограничено": "unlimited", -"статус задачи": "task status", -"МассивНомеров": "PhonesArray", -"ДатаУстановки": "SetupDate", -"Тестовая тема": "TestTopic", -"Создать папку": "Create folder", -"УдаленныйФайл": "RemoteFile", "СтрокаТоваров": "ProductsString", "ПринятьЗадачу": "ApproveTask", "ТелеграмОпрос": "TelegramPoll", @@ -1711,11 +1560,10 @@ "УдалитьАльбом": "DeleteAlbum", "Закрыл задачу": "Close task", "ДобавитьТовар": "AddProduct", +"УдаленныйФайл": "RemoteFile", "ИзменитьЗаказ": "UpdateOrder", -"Удалить заказ": "Delete order", "Файл картинки": "Image file", "Тестовый лист": "TestSheet", -"Число, Строка": "Number, String", "МедиаКартинка": "MediaPicture", "КартинкаПоста": "PostImage", "ЭтоСимвольное": "ThisIsSymbolic", @@ -1725,34 +1573,268 @@ "МассивЗаказов": "ArrayOfOrders", "УдалитьЗаписи": "DeletePosts", "ПрочитаноБайт": "BytesRead", -"ПолучитьСтроку": "GetLine", -"Awaiting.What(": "Ожидаем.Что(", -"ПолучитьСделку": "GetDeal", -"ОписаниеЗаписи": "RecordDescription", -"Создать записи": "Create records", -"СтруктураФайла": "FileStructure", -"ОписаниеТовара": "ProductDescription", -"Проверка_Пусто": "Check_Empty", -"РаботаСФайлами": "FileManagment", -"Покинуть канал": "Leave channel", -"ПолучитьЗадачу": "GetTask", -"СтруктураМедиа": "MediaStructure", -"ИзменитьСделку": "UpdateDeal", -"НомерКатегории": "CategoryNumber", -"ДанныеАккаунта": "AccountData", -"Номер телефона": "Phone number", -"СлакТемаКанала": "SlackChannelTopic", -"МассивКартинок": "ImageArray", -"VK_УдалитьПост": "VK_DeletePost", -"ИДПользователя": "UserID", -"МассивТоваров_": "ArrayOfProducts_", -"ID базы данных": "Database ID", -"необяз. по ум.": "optional, def. val.", -"ДропБоксСтатус": "DropboxStatus", -"РаботаСДанными": "DataManagment", -"ПолучитьПревью": "GetPreview", -"Удалить альбом": "Delete album", -"Тип клавиатуры": "KeyboardType", +"ОткрытьДиалог": "OpenDialog", +"Удалить заказ": "Delete order", +"Создать отказ": "Create refusal", +"Создать папку": "Create folder", +"ДатаУстановки": "SetupDate", +"Положительная": "Positive", +"ОтветЗагрузки": "UploadResponse", +"БитриксСписок": "BitrixList", +"дата закрытия": "closing date", +"БитриксМассив": "BitrixArray", +"ОтветПроверки": "CheckResponse", +"ВывестиСтроку": "PrintString", +"ID объявления": "Ad ID", +"идентификатор": "identifier", +"УдалитьЗадачу": "DeleteTask", +"Изменить поле": "Modify field", +"Множественная": "Multiple", +"Тестовая тема": "TestTopic", +"ПереслатьФайл": "ResendFile", +"КодУстройства": "DeviceCode", +"ДФ=yyyy-MM-dd": "DF=yyyy-MM-dd", +"ПутьОригинала": "OriginalPath", +"Срок действия": "Expiration date", +"Картинка1.jpg": "Picture1.jpg", +"ТелеграмАудио": "TelegramAudio", +"ПолучитьЧисло": "GetNumber", +"РазложитьJSON": "ParseJSON", +"Создать канал": "Create channel", +"не ограничено": "unlimited", +"статус задачи": "task status", +"МассивНомеров": "PhonesArray", +"НомерКампании": "CampaignNumber", +"РаботаСЧатами": "ChatManagment", +"ЗагрузитьФайл": "UploadFile", +"ВозможныйПуть": "PossiblePath", +"ТелеграмЧисло": "TelegramNumber", +"Описание чата": "Chat description", +"Обновить файл": "Update file", +"ПодСообщением": "UnderMessage", +"Размер скидки": "Discount amount", +"ЗакрытьСессию": "CloseSession", +"Код материала": "Material code", +"АТКомментарии": "ATComments", +"ОписаниеТипов": "TypeDescription", +"Администратор": "Administrator", +"ID обсуждения": "Discussion ID", +"Дата рождения": "Birth date", +"ОбработатьТег": "ProcessTag", +"РаботаСДиском": "WorkingWithDrive", +"Bitrix24 (ОПИ": "Bitrix24 (OpenIntegrations", +"Массив кнопок": "Array of buttons", +"МассивПозиций": "ItemsArray", +"Экранирование": "Escaping", +"Прочитать все": "Read all", +"Первый запуск": "First start", +"СимволМассива": "ArraySymbol", +"ТекущиеДанные": "CurrentData", +"МассивОтветов": "AnswersArray", +"МассивТоваров": "ProductsArray", +"МассивСобытий": "ArrayOfEvents", +"Начало работы": "Getting started", +"Переадресация": "Redirection", +"БитриксСделка": "BitrixDeal", +"ЗапросыСТелом": "RequestsWithBody", +"IDКомментария": "CommentID", +"НомерСтраницы": "PageNumber", +"РазмерТекущих": "CurrentSize", +"дополнительно": "additionally", +"ЛокальныйПуть": "LocalPath", +"БитриксСтрока": "BitrixString", +"ВозможныеПути": "PossiblePaths", +"СоздатьЗадачу": "CreateTask", +"ЛокальныеПути": "LocalPaths", +"ЛокальныйФайл": "LocalFile", +"Продажа в RUB": "Sale in RUB", +"маркетинговый": "Marketing", +"Наименование1": "Filename1", +"ТелеграмГифка": "TelegramGif", +"Тестовая база": "TestDatabase", +"ПараАртикулов": "ArticlesPair", +"Текст новости": "Text of post", +"ПокинутьКанал": "LeaveChannel", +"ПараметрыJSON": "JSONParameters", +"ВозможныйФайл": "PossibleFile", +"Скачать папку": "Download folder", +"ЭлементДанных": "DataElement", +"СлакЭфемерное": "SlackEphemeral", +"СписокТоваров": "ProductList", +"БитриксИстина": "BitrixTrue", +"ТекущийРаздел": "CurrentSection", +"Одноклассники": "Classmates", +"Идентификатор": "Identifier", +"БитриксОбъект": "BitrixObject", +"ДатаОкончания": "EndDate", +"Описание поля": "Field description", +"МассивКаналов": "ChannelArray", +"УдалитьОбъект": "DeleteObject", +"Строка, Число": "String, Number", +"СтруктураЧата": "ChatStructure", +"дата создания": "date of creation", +"ГуглКалендарь": "GoogleCalendar", +"СлакСообщение": "SlackMessage", +"ИзменитьТовар": "EditProduct", +"МассивПорогов": "ThresholdsArray", +"Строка адреса": "Address string", +"ЗакрытьДиалог": "CloseDialog", +"Блок с файлом": "FileBlock", +"ТекущийОбъект": "CurrentObject", +"ОбновитьТокен": "RefreshToken", +"УдалитьСделку": "DeleteDeal", +"СтруктураДаты": "DateStructure", +"ВККомментарий": "VKComment", +"КомплексныйID": "ComplexID", +"Создать заказ": "Create order", +"СкрытьИсторию": "HideHistory", +"YandexID (ОПИ": "YandexID (OpenIntegrations", +"ПолучитьЗаказ": "GetOrder", +"Refresh токен": "Refresh token", +"Это новый чат": "This is a new chat", +"ИДКомментария": "CommentID", +"Наименование2": "Filename2", +"ПорядокБайтов": "ByteOrder", +"СоздатьЗапрос": "CreateRequest", +"НомерТелефона": "PhoneNumber", +"ЛишниеСимволы": "ExtraCharacters", +"Массив файлов": "Files array", +"ФайловыйПоток": "FileStream", +"СоздатьСделку": "CreateDeal", +"СвойстваЛиста": "SheetProperties", +"СлакСообщения": "SlackMessages", +"Airtable (ОПИ": "Airtable (OpenIntegrations", +"ВставитьПосле": "InsertAfter", +"IDЦитируемого": "ReplyID", +"Новая таблица": "NewTable", +"ПолучитьТекст": "GetText", +"ДанныеСобытия": "callbackData", +"ЭтоОтложенное": "IsDelayed", +"VK Teams (ОПИ": "VK Teams (OpenIntegrations", +"ПолучитьКанал": "GetChannel", +"UnixИстечение": "UnixExpiration", +"СоздатьЗаписи": "CreatePosts", +"IDУведомления": "NotificationID", +"ТелеграмВидео": "TelegramVideo", +"БитриксБулево": "BitrixBool", +"Дата создания": "CreationDate", +"СтруктураПоля": "FieldStructure", +"СтрокаНомеров": "NumbersString", +"ТекущаяЗапись": "CurrentRecord", +"новый каталог": "new catalog", +"ПрочитатьJSON": "ReadJSON", +"Telegram (ОПИ": "Telegram (OpenIntegrations", +"Версия: 2.4.8": "Version: 2.4.8", +"ТелеграмМассив": "TelegramArray", +"Тестовый твитт": "TestTweet", +"МассивУпаковок": "PackagesArray", +"ОчиститьЯчейки": "ClearCells", +"КонецПроцедуры": "EndProcedure", +"Переслать файл": "Resend file", +"Номер упаковки": "Package number", +"ОписаниеОшибки": "ErrorDescription", +"ЗаписатьСтроку": "WriteLine", +"Получить заказ": "Get order", +"Заголовок поля": "Field title", +"ТекущаяОбласть": "CurrentRegion", +"Создать сделку": "Create deal", +"ОтправкаДанных": "DataSending", +"Принять работу": "Approve task", +"ОтправкаВКанал": "SendingToChannel", +"УдалитьWebhook": "DeleteWebhook", +"ДропБоксРабота": "DropboxWork", +"ПолучитьОбъект": "GetObject", +"Путь к объекту": "Path to the object", +"DevOps инженер": "DevOps engineer", +"Описание файла": "File description", +"СтрНачинаетсяС": "StrStartsWith", +"Текстовый твит": "Text tweet", +"Текст описания": "Description text", +"ЯДискПроцедура": "YaDiskProc", +"ПутьУдаленного": "PathOfRemote", +"МассивОписаний": "ArrayOfDescriptions", +"ТекущийАртикул": "CurrentArticle", +"УдалитьКаталог": "DeleteFolder", +"МассивОтправки": "SendArray", +"ПривестиБулево": "MakeBoolean", +"VK_СоздатьПост": "VK_CreatePost", +"ОтправитьВидео": "SendVideo", +"КлючПриложения": "AppKey", +"ОписаниеМетода": "MethodDescription", +"СоздатьНовость": "CreatePost", +"РаботаСКнигами": "SpreadsheetsManagment", +"Принять задачу": "Approve task", +"ОзонПодписчики": "OzonSubscribers", +"Характеристика": "DescField", +"УдалитьНовость": "DeletePost", +"СтруктураОпций": "OptionsStructure", +"МассивАльбомов": "ArrayOfAlbums", +"ЗагрузитьФайлы": "UploadFiles", +"АТ_СоздатьПоле": "AT_CreateField", +"Заголовок темы": "Thread title", +"ГуглИмяТаблицы": "GoogleSheetTitle", +"ФайлРезультата": "ResultFile", +"ТекущеВложение": "CurrentAttachment", +"ЧатыИСообщения": "ChatsAndMessages", +"НажатиеКнопки1": "ButtonEvent1", +"HTTPСоединение": "HTTPConnection", +"Загрузить файл": "Upload file", +"ЗапросыБезТела": "RequestsWithoutBody", +"ФайлСтатистики": "StatisticsFile", +"ТелеграмИстина": "TelegramTrue", +"IDРуководителя": "HeadID", +"Получить токен": "Get token", +"Отправить файл": "Send file", +"СтрОбщийРазмер": "StrTotalSize", +"МассивСтруктур": "StructuresArray", +"Деловые услуги": "Business", +"ПроверитьТокен": "CheckToken", +"МассивСекретов": "SecretsArray", +"Тестовый товар": "TestProduct", +"СерверноеВремя": "ServerTime", +"МассивВложений": "AttachmentsArray", +"РазделительBat": "BatSeparator", +"ПолучитьМассив": "GetArray", +"ПолучитьВерсию": "GetVersion", +"СоздатьТаблицу": "CreateTable", +"СписокЗначений": "ValueList", +"Изменить заказ": "Update order", +"Новый файл.jpg": "New file.jpg", +"Удалить записи": "Delete records", +"ТолькоПросмотр": "ViewOnly", +"Удалить объект": "Delete object", +"УдаленныеФайлы": "RemoteFiles", +"ПараметрыТеста": "TestParameters", +"Новая стадия 2": "New stage 2", +"ТекущийАбсПуть": "CurrentAbsPath", +"РаботаСТокеном": "TokenManagment", +"ОтправитьАудио": "SendAudio", +"ЗаписатьЛогCLI": "WriteLogCLI", +"КопироватьЛист": "CopySheet", +"ЛокальныеФайлы": "LocalFiles", +"ПолноеИмяМедиа": "FullMediaName", +"Твит с опросом": "Tweet with poll", +"IDПользователя": "UserID", +"Номер страницы": "Page number", +"МассивИДПостов": "PostIDsArray", +"Описание видео": "Video description", +"ПолучитьЗапись": "GetRecord", +"УдалитьСобытие": "DeleteEvent", +"ТекущаяКоманда": "CurrentCommand", +"СоздатьСобытие": "CreateEvent", +"дата изменения": "date of change", +"СтрокаПодборок": "SelectionsString", +"ПолучитьБулево": "GetBoolean", +"ЗаписанныйФайл": "RecordedFile", +"ТекущийОтнПуть": "CurrentRelPath", +"РаботаСГруппой": "CommunityManagment", +"ДропБоксМассив": "DropboxArray", +"Заголовок чата": "Chat title", +"КопироватьФайл": "FileCopy", +"Файл, Значение": "File, Value", +"ПараметрМетода": "MethodParameter", +"ОтправитьОпрос": "SendPoll", +"ИзменитьЗадачу": "UpdateTask", "Некоторое поле": "Nekotoroe pole", "ПолучитьСостав": "GetComposition", "КартинкаЗамены": "ReplacementImage", @@ -1776,38 +1858,38 @@ "Получить книгу": "Get spreadsheet", "АТСписокТаблиц": "ATTablesList", "Это новый файл": "This is a new file", +"Тип клавиатуры": "KeyboardType", +"Удалить альбом": "Delete album", +"ПолучитьПревью": "GetPreview", +"РаботаСДанными": "DataManagment", +"ПолучитьСтроку": "GetLine", +"Awaiting.What(": "Ожидаем.Что(", +"ПолучитьСделку": "GetDeal", +"Тестовый канал": "Test channel", +"Создать записи": "Create records", +"СтруктураФайла": "FileStructure", +"ОписаниеТовара": "ProductDescription", +"Проверка_Пусто": "Check_Empty", +"РаботаСФайлами": "FileManagment", +"Покинуть канал": "Leave channel", +"ПолучитьЗадачу": "GetTask", "ТекущаяПозиция": "CurrentPosition", +"СтруктураМедиа": "MediaStructure", +"НомерКатегории": "CategoryNumber", +"ДанныеАккаунта": "AccountData", +"Номер телефона": "Phone number", +"СлакТемаКанала": "SlackChannelTopic", +"МассивКартинок": "ImageArray", +"VK_УдалитьПост": "VK_DeletePost", +"ИДПользователя": "UserID", +"МассивТоваров_": "ArrayOfProducts_", +"ID базы данных": "Database ID", +"необяз. по ум.": "optional, def. val.", +"ДропБоксСтатус": "DropboxStatus", +"ИзменитьСделку": "UpdateDeal", "Изменить товар": "Edit product", -"ОтправитьГифку": "SendGif", +"ОписаниеЗаписи": "RecordDescription", "Открыть диалог": "Open dialog", -"СтруктураПолей": "FieldsStructure", -"приветственное": "welcoming", -"предполагаемая": "expected", -"СтрокаВложений": "AttachmentsString", -"СтруктураЯчеек": "CellStructure", -"СлакОтложенные": "SlackSheduled", -"РаботаСАкциями": "PromotionsManagment", -"Перезаписывать": "Overwrite", -"ЗагрузитьВидео": "UploadVideo", -"Neocities (ОПИ": "Neocities (OPI", -"МассивОбъектов": "ArrayOfObjects", -"ФорматДатыJSON": "JSONDateFormat", -"Обновить токен": "Refresh token", -"РабочийКаталог": "WorkingDirectory", -"ПрочитанноБайт": "BytesRead", -"Новое название": "New name", -"МассивМедиаГиф": "MediaGifArray", -"ПолучитьДиалог": "GetDialog", -"Поставить лайк": "Like", -"<путь к файлу>": "", -"Добавить товар": "Add product", -"ОтложитьЗадачу": "DeferTask", -"Тестовая папка": "TestFolder", -"Сделать репост": "Make repost", -"СтрочныйМассив": "StringArray", -"МаксимумПостов": "MaximumPosts", -"ТаблицаСостава": "CompositionTable", -"РаботаСБлоками": "BlocksManagment", "АТ_СоздатьБазу": "AT_CreateDatabase", "OPI_Интеграция": "OPI_Integrations", "ТекущийЭлемент": "CurrentElement", @@ -1824,150 +1906,145 @@ "ВступитьВКанал": "JoinChannel", "ГВ_Авторизация": "GW_Auth", "ОписаниеЗаказа": "OrderDescription", -"ОтправитьОпрос": "SendPoll", "ответственного": "responsible", "АтомарныеТесты": "AtomicTests", "МассивЗапросов": "ArrayOfRequests", "color=Белый) v": "color=White) v", -"РаботаСЛистами": "WorkingWithSheets", "СоздатьИсторию": "CreateStory", "Новое описание": "New description", -"ИзменитьЗадачу": "UpdateTask", -"Тестовый канал": "Test channel", -"ПараметрМетода": "MethodParameter", -"Удалить объект": "Delete object", -"МассивОписаний": "ArrayOfDescriptions", -"УдалитьКаталог": "DeleteFolder", -"МассивОтправки": "SendArray", -"ПривестиБулево": "MakeBoolean", -"VK_СоздатьПост": "VK_CreatePost", -"ОтправитьВидео": "SendVideo", -"КлючПриложения": "AppKey", -"ОписаниеМетода": "MethodDescription", -"СоздатьНовость": "CreatePost", -"РаботаСКнигами": "SpreadsheetsManagment", -"ОзонПодписчики": "OzonSubscribers", -"НажатиеКнопки1": "ButtonEvent1", -"Характеристика": "DescField", -"ЯДискПроцедура": "YaDiskProc", -"УдалитьНовость": "DeletePost", -"СтруктураОпций": "OptionsStructure", -"МассивАльбомов": "ArrayOfAlbums", -"ЗагрузитьФайлы": "UploadFiles", -"АТ_СоздатьПоле": "AT_CreateField", -"Заголовок темы": "Thread title", -"ГуглИмяТаблицы": "GoogleSheetTitle", -"ФайлРезультата": "ResultFile", -"ТекущеВложение": "CurrentAttachment", -"ЧатыИСообщения": "ChatsAndMessages", -"ПутьУдаленного": "PathOfRemote", -"Принять задачу": "Approve task", -"Описание файла": "File description", -"ЗаписатьСтроку": "WriteLine", -"ОписаниеОшибки": "ErrorDescription", -"Номер упаковки": "Package number", -"Переслать файл": "Resend file", -"КонецПроцедуры": "EndProcedure", -"Получить заказ": "Get order", -"ОчиститьЯчейки": "ClearCells", -"МассивУпаковок": "PackagesArray", -"Тестовый твитт": "TestTweet", -"ТелеграмМассив": "TelegramArray", -"Текстовый твит": "Text tweet", -"Создать сделку": "Create deal", -"ТекущаяОбласть": "CurrentRegion", -"ОтправкаДанных": "DataSending", -"Принять работу": "Approve task", -"ОтправкаВКанал": "SendingToChannel", -"Текст описания": "Description text", -"УдалитьWebhook": "DeleteWebhook", -"ДропБоксРабота": "DropboxWork", -"ПолучитьОбъект": "GetObject", -"Путь к объекту": "Path to the object", -"DevOps инженер": "DevOps engineer", -"СтрНачинаетсяС": "StrStartsWith", -"Заголовок поля": "Field title", -"ТекущийАртикул": "CurrentArticle", -"HTTPСоединение": "HTTPConnection", -"ПолучитьЗапись": "GetRecord", -"ЗапросыБезТела": "RequestsWithoutBody", -"РаботаСТокеном": "TokenManagment", -"ОтправитьАудио": "SendAudio", -"ЗаписатьЛогCLI": "WriteLogCLI", -"КопироватьЛист": "CopySheet", -"ЛокальныеФайлы": "LocalFiles", -"ПолноеИмяМедиа": "FullMediaName", -"Твит с опросом": "Tweet with poll", -"IDПользователя": "UserID", -"Номер страницы": "Page number", -"МассивИДПостов": "PostIDsArray", -"Описание видео": "Video description", -"УдалитьСобытие": "DeleteEvent", -"Файл, Значение": "File, Value", -"ТекущаяКоманда": "CurrentCommand", -"СоздатьСобытие": "CreateEvent", -"дата изменения": "date of change", -"СтрокаПодборок": "SelectionsString", -"ПолучитьБулево": "GetBoolean", -"ЗаписанныйФайл": "RecordedFile", -"ТекущийОтнПуть": "CurrentRelPath", -"РаботаСГруппой": "CommunityManagment", -"ДропБоксМассив": "DropboxArray", -"Заголовок чата": "Chat title", -"КопироватьФайл": "FileCopy", -"ТекущийАбсПуть": "CurrentAbsPath", -"Новая стадия 2": "New stage 2", -"Загрузить файл": "Upload file", -"ПараметрыТеста": "TestParameters", -"УдаленныеФайлы": "RemoteFiles", -"ФайлСтатистики": "StatisticsFile", -"ТелеграмИстина": "TelegramTrue", -"IDРуководителя": "HeadID", -"Получить токен": "Get token", -"Отправить файл": "Send file", -"СтрОбщийРазмер": "StrTotalSize", -"МассивСтруктур": "StructuresArray", -"Деловые услуги": "Business", -"ПроверитьТокен": "CheckToken", -"МассивСекретов": "SecretsArray", -"Тестовый товар": "TestProduct", -"СерверноеВремя": "ServerTime", -"МассивВложений": "AttachmentsArray", -"РазделительBat": "BatSeparator", -"ПолучитьМассив": "GetArray", -"ПолучитьВерсию": "GetVersion", -"СоздатьТаблицу": "CreateTable", -"СписокЗначений": "ValueList", -"Изменить заказ": "Update order", -"Новый файл.jpg": "New file.jpg", -"Удалить записи": "Delete records", -"ТолькоПросмотр": "ViewOnly", -"СоздатьЛид (хук": "CreateLead (wh", -"Массив картинок": "Array of images", -"ПовторитьСтроку": "RepeatString", -"ОписаниеТаблицы": "TableDescription", -"ТекстВыполнения": "ExecutionText", -"VK_СоздатьОпрос": "VK_CreatePoll", -"ПеременнаяСреды": "EnvironmentVariable", -"ЗначениеВМассив": "ValueToArray", -"IDПодразделения": "DepartmentID", -"Создать событие": "Create event", -"Не спланированы": "Not planned", -"АТБазаСТаблицей": "ATBaseWithTable", -"ОписаниеСтроки1": "RowDescription1", -"СократитьСсылку": "ShortenLink", -"ИзменитьСобытие": "EditEvent", -"ТекущаяДатаUNIX": "CurrentUNIXDate", -"Проверить токен": "Check token", -"СтруктураЗадачи": "TaskData", -"НужнаРаспаковка": "NeedsUnpacking", -"Получить диалог": "Get dialog", -"ТелеграмКонтакт": "TelegramContact", -"IDИнициализации": "InitializationID", -"ИспользуемоеИмя": "DisplayedName", -"Новый каталог 2": "New folder 2", -"СтруктураЗаказа": "OrderStructure", -"ЗависимостиГугл": "GoogleDependencies", +"ОтправитьГифку": "SendGif", +"РаботаСБлоками": "BlocksManagment", +"ТаблицаСостава": "CompositionTable", +"РаботаСЛистами": "WorkingWithSheets", +"СтрочныйМассив": "StringArray", +"МаксимумПостов": "MaximumPosts", +"приветственное": "welcoming", +"СтрокаВложений": "AttachmentsString", +"СтруктураЯчеек": "CellStructure", +"СлакОтложенные": "SlackSheduled", +"РаботаСАкциями": "PromotionsManagment", +"Перезаписывать": "Overwrite", +"ЗагрузитьВидео": "UploadVideo", +"Neocities (ОПИ": "Neocities (OPI", +"МассивОбъектов": "ArrayOfObjects", +"ФорматДатыJSON": "JSONDateFormat", +"предполагаемая": "expected", +"РабочийКаталог": "WorkingDirectory", +"Сделать репост": "Make repost", +"Обновить токен": "Refresh token", +"Тестовая папка": "TestFolder", +"ОтложитьЗадачу": "DeferTask", +"Добавить товар": "Add product", +"<путь к файлу>": "", +"СтруктураПолей": "FieldsStructure", +"ПолучитьДиалог": "GetDialog", +"МассивМедиаГиф": "MediaGifArray", +"Новое название": "New name", +"Поставить лайк": "Like", +"ПрочитанноБайт": "BytesRead", +"ИскомыйПараметр": "DesiredParameter", +"OPI_Инструменты": "OPI_Tools", +"Доуступные типы": "Available types", +"Ключ приложения": "Application key", +"Серверное время": "Server time", +"Массив ID медиа": "Media ID array", +"РаботаСЗаписями": "RecordManagement", +"МестоПроведения": "Venue", +"ЗначениеСтрокой": "ValueAsString", +"РаботаСТоварами": "ProductManagement", +"ПараметрыМетода": "MethodParameters", +"ОригиналныйПуть": "OriginalPath", +"Настройка OAuth": "OAuth settings", +"Картинка опроса": "Poll image", +"УдалитьПодборку": "DeleteSelection", +"Плановое начало": "Planned start", +"ИзменитьТаблицу": "ModifyTable", +"СлакВнешнийФайл": "SlackExternalFile", +"Работа с лидами": "Leads managment", +"Загрузить файлы": "Upload files", +"ТокенВЗаголовки": "TokenInHeaders", +"IDПользователей": "UserIDs", +"СоздатьСтраницу": "CreatePage", +"Создать историю": "Create story", +"ДропбоксАккаунт": "DropboxAccount", +"УправлениеЧатом": "ChatManagment", +"Перенаправление": "Redirection", +"Telegram_Разбан": "Telegram_Unban", +"ОдиночнаяЗапись": "SingleRecord", +"ТекущееОписание": "CurrentDescription", +"МобильныйКлиент": "MobileClient", +"ИДЖелтогоТовара": "YellowItemID", +"ОбработатьОтвет": "ProcessResponse", +"Проверка_Строка": "Check_String", +"Сокращенный URL": "Shortened URL", +"МассивВариантов": "OptionArray", +"ВКГруппаТоваров": "VKProductsGroup", +"РаботаСЗаказами": "OrderManagement", +"Удалить каталог": "Delete folder", +"ТаблицаЗначений": "ValueTable", +"ПараметрыЗаписи": "WriterSettings", +"ВнутреннийНомер": "IMNumber", +"Проверка_ВКПост": "Check_VKPost", +"ЗапросИзменения": "ChangeRequest", +"ВКТПользователь": "VKTUser", +"ПолучитьСобытия": "GetEvents", +"HTTPСервисОтвет": "HTTPServiceResponse", +"ВК_СоздатьОпрос": "VKAPI_CreatePoll", +"Проверка_Массив": "Check_Array", +"Работа с диском": "Working with drive", +"СтатусСообщения": "MessageStatus", +"перенаправления": "redirection", +"ТипСоответствие": "TypeMap", +"Отправить видео": "Send video", +"Новый цвет чата": "New chat color", +"СтатусОбработки": "ProcessingStatus", +"ЗавершитьЗадачу": "CompleteTask", +"VK_УдалитьТовар": "VK_DeleteProduct", +"Дата с временем": "Date with time", +"Правила Маркета": "Market rules", +"РаботаСКаналами": "ChannelManagement", +"ОписаниеСобытия": "EventDescription", +"ID базовой темы": "ID of base topic", +"ПолучитьКаталог": "GetFolder", +"СодержимоеФайла": "FileContent", +"Отложить задачу": "Defer task", +"СоздатьТвитСГиф": "CreateTweetWithGif", +"Отправить опрос": "Send poll", +"РазделительBash": "BashSeparator", +"КаталогПримеров": "CatalogExample", +"ID пользователя": "User ID", +"Получить задачу": "Get task", +"РаботаСЗадачами": "TasksManagment", +"КодировкаТекста": "TextEncoding", +"Загрузить видео": "Upload video", +"Пункт чек-листа": "Checklist element", +"ВайберСообщение": "ViberMessage", +"СформироватьURL": "FormURL", +"СтруктураТекста": "TextStructure", +"Получить объект": "Get object", +"ОписаниеКоманды": "CommandDescription", +"СтруктураВыбора": "ChoiceStructure", +"установлен свой": "set your", +"ДвоичныеДанные2": "BinaryData2", +"Новый заголовок": "New title", +"ВКТ_ОбщиеМетоды": "VKT_CommonMethods", +"ПолучитьТаблицу": "GetTable", +"СтруктураТовара": "ItemStructure", +"Создать новость": "Create post", +"Измененное поле": "Izmenennoe pole", +"ОтклонитьЗадачу": "DisapproveTask", +"ДвоичныеДанные1": "BinaryData1", +"КоллекцияТаблиц": "TableCollection", +"Социальные сети": "Social networks", +"Данные аккаунта": "Account data", +"ЗаписатьЦелое32": "WriteInt32", +"Копировать лист": "Copy sheet", +"СоздатьЧат (хук": "CreateChat (wh", +"ПолучениеДанных": "DataRetrieving", +"Получить превью": "Get preview", +"Проверка_СлакОк": "Check_SlackOk", +"СкопироватьФайл": "MakeFileCopy", +"СтруктураКнопки": "ButtonStructure", "СтруктураУслуги": "ServiceStructure", "ЗагруженныйФайл": "UploadedFile", "НСФайлыКаталога": "NCFolderFiles", @@ -1989,36 +2066,36 @@ "ОтправитьСсылку": "SendLink", "БитриксВложение": "BitrixAttachment", "ГуглКомментарий": "GoogleComment", +"ЗависимостиГугл": "GoogleDependencies", +"СтруктураЗаказа": "OrderStructure", +"Новый каталог 2": "New folder 2", +"ИспользуемоеИмя": "DisplayedName", +"СоздатьЛид (хук": "CreateLead (wh", +"Массив картинок": "Array of images", +"ПовторитьСтроку": "RepeatString", +"ОписаниеТаблицы": "TableDescription", +"ТекстВыполнения": "ExecutionText", +"VK_СоздатьОпрос": "VK_CreatePoll", +"ПеременнаяСреды": "EnvironmentVariable", +"ЗначениеВМассив": "ValueToArray", +"IDПодразделения": "DepartmentID", +"Создать событие": "Create event", "Поле для текста": "Text field", +"Не спланированы": "Not planned", +"ОписаниеСтроки1": "RowDescription1", +"СократитьСсылку": "ShortenLink", +"ИзменитьСобытие": "EditEvent", +"ТекущаяДатаUNIX": "CurrentUNIXDate", +"Проверить токен": "Check token", +"СтруктураЗадачи": "TaskData", +"НужнаРаспаковка": "NeedsUnpacking", +"Получить диалог": "Get dialog", +"ТелеграмКонтакт": "TelegramContact", +"IDИнициализации": "InitializationID", +"АТБазаСТаблицей": "ATBaseWithTable", "ID целевой базы": "Target database ID", -"Ждет завершения": "Waiting for completion", +"МассивУдаляемых": "ArrayOfDeletions", "Отправить гифку": "Send GIF", -"Удалить Webhook": "Delete webhook", -"Работа с чатами": "Chats works", -"дата завершения": "completion date", -"СтруктураОплаты": "PaymentStructure", -"ИзменитьНовость": "UpdatePost", -"ул. Блюхера, 32": "st. Bluchera, 32", -"УдалитьКартинку": "DeleteImage", -"ЗаголовокПотока": "StreamHeader", -"Создать таблицу": "Create table", -"ПолучитьНовости": "GetPosts", -"ПолучитьАккаунт": "GetAccount", -"Получить запись": "Get record", -"ОзонНовыеТовары": "OzonNewProducts", -"Создание твитов": "Tweets creation", -"Я бот, а ты нет": "I am bot, but you - not", -"Проверка_ВКЛайк": "Check_VKLike", -"создайте проект": "create a project", -"СтруктураПорога": "ThresholdStructure", -"JSON клавиатуры": "Keyboard JSON", -"Получить сделку": "Get deal", -"ЗаписатьЦелое16": "WriteInt16", -"Изменить сделку": "Update deal", -"ЗавершитьРаботу": "FinishWork", -"СтруктураФайлов": "FileStructure", -"СтруктураАдреса": "AddressStructure", -"Подпись к файлу": "File caption", "МассивТелефонов": "PhonesArray", "ВводныйПараметр": "IntroductoryParameter", "ОписаниеСтроки2": "RowDescription2", @@ -2026,7 +2103,6 @@ "НССинхронизация": "NCSync", "Номер,Строковое": "Number,String", "Почтовый индекс": "Postal code", -"СкопироватьФайл": "MakeFileCopy", "УстановитьТекст": "SetText", "OPI инструменты": "OPI tools", "МассивРодителей": "ArrayOfParents", @@ -2040,136 +2116,137 @@ "ЗначенияСвойств": "PropertyValues", "Очистить ячейки": "Clear cells", "ПолучитьСобытие": "GetEvent", +"Ждет завершения": "Waiting for completion", +"Подпись к файлу": "File caption", +"СтруктураАдреса": "AddressStructure", "Вспомогательные": "Auxiliary", -"СтруктураКнопки": "ButtonStructure", -"МассивУдаляемых": "ArrayOfDeletions", -"Проверка_СлакОк": "Check_SlackOk", -"РаботаСЗадачами": "TasksManagment", -"УправлениеЧатом": "ChatManagment", -"Telegram_Разбан": "Telegram_Unban", -"ОдиночнаяЗапись": "SingleRecord", -"ТекущееОписание": "CurrentDescription", -"МобильныйКлиент": "MobileClient", -"ИДЖелтогоТовара": "YellowItemID", -"ОбработатьОтвет": "ProcessResponse", -"Проверка_Строка": "Check_String", -"Сокращенный URL": "Shortened URL", -"ВКГруппаТоваров": "VKProductsGroup", -"ВК_СоздатьОпрос": "VKAPI_CreatePoll", -"РаботаСЗаказами": "OrderManagement", -"Создать историю": "Create story", -"Удалить каталог": "Delete folder", -"ТаблицаЗначений": "ValueTable", -"ПараметрыЗаписи": "WriterSettings", -"ВнутреннийНомер": "IMNumber", -"Проверка_ВКПост": "Check_VKPost", -"ЗапросИзменения": "ChangeRequest", -"ВКТПользователь": "VKTUser", -"ПолучитьСобытия": "GetEvents", -"HTTPСервисОтвет": "HTTPServiceResponse", -"ДропбоксАккаунт": "DropboxAccount", -"МассивВариантов": "OptionArray", -"Загрузить файлы": "Upload files", -"OPI_Инструменты": "OPI_Tools", -"Доуступные типы": "Available types", -"Ключ приложения": "Application key", -"Серверное время": "Server time", -"Массив ID медиа": "Media ID array", -"РаботаСЗаписями": "RecordManagement", -"МестоПроведения": "Venue", -"ЗначениеСтрокой": "ValueAsString", -"РаботаСТоварами": "ProductManagement", -"IDПользователей": "UserIDs", -"ОригиналныйПуть": "OriginalPath", -"ПараметрыМетода": "MethodParameters", -"Настройка OAuth": "OAuth settings", -"Картинка опроса": "Poll image", -"УдалитьПодборку": "DeleteSelection", -"СоздатьСтраницу": "CreatePage", -"Плановое начало": "Planned start", -"ИзменитьТаблицу": "ModifyTable", -"СлакВнешнийФайл": "SlackExternalFile", -"Работа с лидами": "Leads managment", -"ТокенВЗаголовки": "TokenInHeaders", -"ИскомыйПараметр": "DesiredParameter", -"Перенаправление": "Redirection", -"Проверка_Массив": "Check_Array", -"Загрузить видео": "Upload video", -"СтатусСообщения": "MessageStatus", -"СформироватьURL": "FormURL", -"СтруктураТекста": "TextStructure", -"Получить объект": "Get object", -"ОписаниеКоманды": "CommandDescription", -"СтруктураВыбора": "ChoiceStructure", -"установлен свой": "set your", -"ДвоичныеДанные2": "BinaryData2", -"Новый заголовок": "New title", -"ВКТ_ОбщиеМетоды": "VKT_CommonMethods", -"ПолучитьТаблицу": "GetTable", -"Создать новость": "Create post", -"Получить превью": "Get preview", -"Измененное поле": "Izmenennoe pole", -"ОтклонитьЗадачу": "DisapproveTask", -"ДвоичныеДанные1": "BinaryData1", -"КоллекцияТаблиц": "TableCollection", -"Социальные сети": "Social networks", -"Данные аккаунта": "Account data", -"ЗаписатьЦелое32": "WriteInt32", -"Копировать лист": "Copy sheet", -"СоздатьЧат (хук": "CreateChat (wh", -"ПолучениеДанных": "DataRetrieving", -"ВайберСообщение": "ViberMessage", -"СтруктураТовара": "ItemStructure", -"Работа с диском": "Working with drive", -"Пункт чек-листа": "Checklist element", -"ОписаниеСобытия": "EventDescription", -"перенаправления": "redirection", -"ТипСоответствие": "TypeMap", -"Отправить видео": "Send video", -"Новый цвет чата": "New chat color", -"СтатусОбработки": "ProcessingStatus", -"ЗавершитьЗадачу": "CompleteTask", -"VK_УдалитьТовар": "VK_DeleteProduct", -"Дата с временем": "Date with time", -"Правила Маркета": "Market rules", -"РаботаСКаналами": "ChannelManagement", -"ID базовой темы": "ID of base topic", -"КодировкаТекста": "TextEncoding", -"ПолучитьКаталог": "GetFolder", -"СодержимоеФайла": "FileContent", -"Отложить задачу": "Defer task", -"СоздатьТвитСГиф": "CreateTweetWithGif", -"Отправить опрос": "Send poll", -"РазделительBash": "BashSeparator", -"КаталогПримеров": "CatalogExample", -"ID пользователя": "User ID", -"Получить задачу": "Get task", -"Проверка_ВКЧисло": "Check_VKNumber", -"Массив Из Строка": "Array Of String", -"Блок с картинкой": "PictureBlock", -"ПолучитьПараметр": "GetParameter", -"МассивКлавиатуры": "KeyboardArray", -"Тестовая таблица": "TestTable", -"OPI_Криптография": "OPI_Cryptography", -"МассивСтатистики": "StatisticsArray", -"ВариантСвойства2": "PropVariant2", -"Отправить ссылку": "Send link", -"ID целевого чата": "Target chat ID", -"СекретПриложения": "AppSecret", -"Сократить ссылку": "Shorten link", -"ЗапятаяВКавычках": "CommaInQuotes", -"Массив ID постов": "Array of post IDs", -"ВыгрузитьКолонку": "UnloadColumn", -"ОписаниеДвижений": "MovesDescription", -"ПолучитьЛид (хук": "GetLead (wh", -"Удалить картинку": "Delete image", -"Грузоотправитель": "Shipper", -"ИмяПоля,ИмяФайла": "FieldName,FileName", -"ПолучитьФайлПути": "GetFilePath", -"Описания методов": "Methods documentation", -"ГВ_ПолучитьТокен": "GV_GetToken", -"ДанныеИНастройка": "DataAndSettings", -"VK_СделатьРепост": "VK_MakeRepost", +"ЗавершитьРаботу": "FinishWork", +"СтруктураФайлов": "FileStructure", +"Работа с чатами": "Chats works", +"дата завершения": "completion date", +"СтруктураОплаты": "PaymentStructure", +"ИзменитьНовость": "UpdatePost", +"ул. Блюхера, 32": "st. Bluchera, 32", +"УдалитьКартинку": "DeleteImage", +"Создать таблицу": "Create table", +"ПолучитьНовости": "GetPosts", +"ПолучитьАккаунт": "GetAccount", +"Получить запись": "Get record", +"ЗаголовокПотока": "StreamHeader", +"Создание твитов": "Tweets creation", +"Изменить сделку": "Update deal", +"ОзонНовыеТовары": "OzonNewProducts", +"Получить сделку": "Get deal", +"JSON клавиатуры": "Keyboard JSON", +"СтруктураПорога": "ThresholdStructure", +"ЗаписатьЦелое16": "WriteInt16", +"Проверка_ВКЛайк": "Check_VKLike", +"Я бот, а ты нет": "I am bot, but you - not", +"Удалить Webhook": "Delete webhook", +"создайте проект": "create a project", +"Проверка_ВКТовар": "Check_VKProduct", +"ОбъектПроцессора": "ProcessorObject", +"Описание таблицы": "Table description", +"БитриксРезультат": "BitrixResult", +"СтруктураФильтра": "FilterStructure", +"УправлениеЧатами": "ChatManagement", +"Изменить новость": "Update post", +"БитриксСообщение": "BitrixMessage", +"ЗаписатьФайлЛога": "WriteLogFile", +"Телефон контакта": "Contact phone number", +"МассивОписания[Н": "ArrayDescription[N", +"УстановитьСтроку": "SetString", +"Картинка и видео": "Picture and video", +"ГуглОчисткаЯчеек": "GoogleCellCleanning", +"телефон заполнен": "phone number is filled in", +"МассивРазрешений": "PermissionsArray", +"Неактивный : red": "Inactive : red", +"Code из браузера": "Code from browser", +"Получить каталог": "Get folder information", +"УдаляемыйЭлемент": "DeletedElement", +"Массив из Строка": "Array of String", +"НеобходимоЧастей": "PartsRequired", +"Скопировать файл": "Copy file", +"Загружаемый файл": "File to be uploaded", +"Картинка альпаки": "Alpaca picture", +"ПолучитьСтраницу": "GetPage", +"Фамилия контакта": "Contact last name", +"КонецКодовУспеха": "EndOfSuccessCodes", +"СмещениеОтНачала": "OffsetFromStart", +"БитриксХранилища": "BitrixStorage", +"ЗагрузкаКартинки": "ImageUpload", +"Завершить задачу": "Complete task", +"КопироватьОбъект": "CopyObject", +"СоздатьШтрихкоды": "CreateBarcodes", +"СтруктураСтатуса": "StatusStructure", +"ID подразделения": "Department ID", +"ПолучитьПолеДаты": "GetDateField", +"СлакСписокФайлов": "SlackFilesList", +"МассивИменЛистов": "ArrayOfSheetNames", +"HTTPСервисЗапрос": "HTTPServiceRequest", +"Работа с акциями": "Promotions managment", +"VK_СоздатьАльбом": "VK_CreateAlbum", +"ВариантСвойства1": "PropVariant1", +"СоздатьКалендарь": "CreateCalendar", +"ПолучитьДвоичные": "GetBinary", +"СоответствиеMIME": "MIMETypeMapping", +"ГВ_ОбновитьТокен": "GV_UpdateToken", +"Получить таблицу": "Get table", +"ОбщийРазмер Цикл": "TotalSize Do", +"Инструменты (ОПИ": "Tools (OpenIntegrations", +"Описание альбома": "Album description", +"Новый подкаталог": "New subfolder", +"МассивПараметров": "ParameterArray", +"МетодХэширования": "HashingMethod", +"ДропбоксУчастник": "DropboxUser", +"УдалитьСообщение": "DeleteMessage", +"Добро пожаловать": "Welcome", +"ЗаписатьВызовCLI": "WriteCLICall", +"ОбработатьОбъект": "ProcessObject", +"ОтправитьКонтакт": "SendContact", +"Материалы встреч": "Meeting materials", +"СоздатьТвитГифки": "CreateGifTweet", +"МассивШтрихкодов": "BarcodesArray", +"ИсходноеЗначение": "InitialValue", +"СоставБиблиотеки": "LibraryComposition", +"IDSИнициализации": "InitializationIDS", +"Переместить файл": "Move file", +"РазделительСтрок": "LineSeparator", +"РаботаСТаблицами": "TableManagement", +"Изменить событие": "Edit event", +"Тестовая реклама": "Test ads", +"VK_ИзменитьТовар": "VK_EditProduct", +"ЗапускаемыеТесты": "RunnableTests", +"СтрокаПараметров": "ParameterString", +"ЗапросыMultipart": "MultipartRequests", +"РаботаСНовостями": "PostsManagment", +"ЮнитТестирование": "UnitTesting", +"СтруктураФормата": "FormatStructure", +"СледующаяПозиция": "NextPosition", +"МассивКалендарей": "ArrayOfCalendars", +"ИДКрасногоТовара": "RedItemID", +"Тестовый товар 2": "TestProduct2", +"ЗначениеОсновной": "MainValue", +"РаботаСДиалогами": "DialogManagement", +"ЛокальныйКаталог": "LocalFolder", +"ОсвободитьОбъект": "FreeObject", +"Отдел маркетинга": "Marketing department", +"МетодыОбсуждений": "DiscussionManagement", +"МБ был записан в": "MB was recorded in", +"ПолучитьСписокВФ": "GetExternalFileList", +"Сделаю на неделе": "For this week", +"Работа с токеном": "Token management", +"УдаленныйКаталог": "RemoteFolder", +"Твит с картинкой": "Tweet with image", +"МассивУчастников": "MembersArray", +"СтрокаФотографий": "PhotoString", +"ТелеграмДокумент": "TelegramDocument", +"Канал для отбора": "Channel for selection", +"Получить события": "Get events", +"СсылкаПодЗаписью": "LinkUnderPost", +"ВыполнитьТестCLI": "ExecuteTestCLI", +"Удалить подборку": "Delete selection", +"КоличествоЧастей": "NumberOfParts", "ГуглЭлементКниги": "GoogleSpreadsheetElement", "Yandex.Disk (ОПИ": "Yandex.Disk (OpenIntegrations", "Описание события": "Event description", @@ -2191,35 +2268,36 @@ "МаксимумВЗапросе": "MaxInRequest", "URLВКодировкеURL": "URLInURLEncoding", "ВладелецКартинки": "ImageOwner", +"VK_СделатьРепост": "VK_MakeRepost", +"ГВ_ПолучитьТокен": "GV_GetToken", +"Описания методов": "Methods documentation", +"ПолучитьФайлПути": "GetFilePath", +"РаботаССобытиями": "EventManagement", +"Проверка_ВКЧисло": "Check_VKNumber", +"Массив Из Строка": "Array Of String", +"Блок с картинкой": "PictureBlock", +"ПолучитьПараметр": "GetParameter", +"МассивКлавиатуры": "KeyboardArray", +"Тестовая таблица": "TestTable", +"OPI_Криптография": "OPI_Cryptography", +"МассивСтатистики": "StatisticsArray", +"ВариантСвойства2": "PropVariant2", "ВызватьHTTPМетод": "CallHTTPMethod", +"Отправить ссылку": "Send link", +"СекретПриложения": "AppSecret", +"Сократить ссылку": "Shorten link", +"ЗапятаяВКавычках": "CommaInQuotes", +"Массив ID постов": "Array of post IDs", +"ВыгрузитьКолонку": "UnloadColumn", +"ОписаниеДвижений": "MovesDescription", +"ПолучитьЛид (хук": "GetLead (wh", +"Удалить картинку": "Delete image", +"Грузоотправитель": "Shipper", +"ИмяПоля,ИмяФайла": "FieldName,FileName", +"ID целевого чата": "Target chat ID", "РаботаСоСделками": "DealsManagment", -"Расширение файла": "File extension", +"ДанныеИНастройка": "DataAndSettings", "KeyИнициализации": "InitializationKey", -"СтруктураПозиции": "ItemStructure", -"КакАдминистратор": "AsAdmin", -"Создать страницу": "Create page", -"ПокинутьЧат (хук": "LeaveChat (wh", -"Отклонить задачу": "Disapprove task", -"ЭтоПереадресация": "ThisIsRedirection", -"Начните диалог с": "Start a dialog with", -"ДоступныйОстаток": "AvailableBalance", -"ДобавитьИмяЛиста": "AddSheetName", -"УдалитьПолностью": "DeleteCompletely", -"VK_ДобавитьТовар": "VK_AddProduct", -"превью документа": "document preview", -"Ожидает контроля": "On controll", -"ПрочитатьЦелое32": "ReadInt32", -"ОписаниеКартинки": "ImageDescription", -"ПользовательЧата": "ChatMember", -"СоздатьТвитВидео": "CreateVideoTweet", -"ИзменитьЛид (хук": "UpdateLead (wh", -"ПутьКФайлуДанных": "DataFilePath", -"МассивИнформации": "ArrayOfInformation", -"ПривестиЗначение": "AdjustValue", -"Изменить таблицу": "Modify table", -"ПараметрыЗапроса": "RequestParameters", -"IDХарактеристики": "AttributeID", -"Работа с файлами": "Files managment", "Коллекция файлов": "File collection", "Получение данных": "Data retrieving", "УдалитьКалендарь": "DeleteCalendar", @@ -2230,8 +2308,8 @@ "Создание проекта": "Project creation", "СлакПользователи": "SlackUsers", "НеобходимаяДлина": "RequiredLength", +"Работа с файлами": "Files managment", "УдалитьФайл (хук": "DeleteFile (wh", -"Получить новости": "Get posts", "owner_id, но без": "owner_id, but without", "РаботаСДоступами": "AccessManagement", "ВосстановитьФайл": "RestoreFile", @@ -2241,213 +2319,59 @@ "VK_УдалитьАльбом": "VK_DeleteAlbum", "Проверка_ВКВидео": "Check_VKVideo", "Артикулы товаров": "Products articles", +"Расширение файла": "File extension", +"Получить новости": "Get posts", +"IDХарактеристики": "AttributeID", "VK_ПоставитьЛайк": "VK_LikePost", -"КоличествоЧастей": "NumberOfParts", -"РаботаССобытиями": "EventManagement", -"Удалить подборку": "Delete selection", -"VK_ИзменитьТовар": "VK_EditProduct", -"ПолучитьСтраницу": "GetPage", -"КонецКодовУспеха": "EndOfSuccessCodes", -"СмещениеОтНачала": "OffsetFromStart", -"БитриксХранилища": "BitrixStorage", -"ЗагрузкаКартинки": "ImageUpload", -"Завершить задачу": "Complete task", -"КопироватьОбъект": "CopyObject", -"СоздатьШтрихкоды": "CreateBarcodes", -"СтруктураСтатуса": "StatusStructure", -"ПолучитьПолеДаты": "GetDateField", -"Получить таблицу": "Get table", -"СлакСписокФайлов": "SlackFilesList", -"МассивИменЛистов": "ArrayOfSheetNames", -"Загружаемый файл": "File to be uploaded", -"HTTPСервисЗапрос": "HTTPServiceRequest", -"Работа с акциями": "Promotions managment", -"VK_СоздатьАльбом": "VK_CreateAlbum", -"ВариантСвойства1": "PropVariant1", -"СоздатьКалендарь": "CreateCalendar", -"ПолучитьДвоичные": "GetBinary", -"СоответствиеMIME": "MIMETypeMapping", -"ГВ_ОбновитьТокен": "GV_UpdateToken", -"Картинка альпаки": "Alpaca picture", -"ID подразделения": "Department ID", -"Скопировать файл": "Copy file", -"УдаляемыйЭлемент": "DeletedElement", -"ОбъектПроцессора": "ProcessorObject", -"Описание таблицы": "Table description", -"БитриксРезультат": "BitrixResult", -"СтруктураФильтра": "FilterStructure", -"УправлениеЧатами": "ChatManagement", -"Изменить новость": "Update post", -"БитриксСообщение": "BitrixMessage", -"Проверка_ВКТовар": "Check_VKProduct", -"ЗаписатьФайлЛога": "WriteLogFile", -"НеобходимоЧастей": "PartsRequired", -"МассивОписания[Н": "ArrayDescription[N", -"УстановитьСтроку": "SetString", -"Картинка и видео": "Picture and video", -"ГуглОчисткаЯчеек": "GoogleCellCleanning", -"телефон заполнен": "phone number is filled in", -"МассивРазрешений": "PermissionsArray", -"Неактивный : red": "Inactive : red", -"Code из браузера": "Code from browser", -"Получить каталог": "Get folder information", -"Телефон контакта": "Contact phone number", -"Массив из Строка": "Array of String", -"Фамилия контакта": "Contact last name", -"ОбщийРазмер Цикл": "TotalSize Do", -"ЗапросыMultipart": "MultipartRequests", -"Описание альбома": "Album description", -"СтруктураФормата": "FormatStructure", -"СледующаяПозиция": "NextPosition", -"МассивКалендарей": "ArrayOfCalendars", -"ИДКрасногоТовара": "RedItemID", -"Тестовый товар 2": "TestProduct2", -"ЗначениеОсновной": "MainValue", -"РаботаСДиалогами": "DialogManagement", -"ЛокальныйКаталог": "LocalFolder", -"ОсвободитьОбъект": "FreeObject", -"Отдел маркетинга": "Marketing department", -"МБ был записан в": "MB was recorded in", -"СсылкаПодЗаписью": "LinkUnderPost", -"ПолучитьСписокВФ": "GetExternalFileList", -"Сделаю на неделе": "For this week", -"Работа с токеном": "Token management", -"УдаленныйКаталог": "RemoteFolder", -"Твит с картинкой": "Tweet with image", -"МассивУчастников": "MembersArray", -"СтрокаФотографий": "PhotoString", -"ТелеграмДокумент": "TelegramDocument", -"Канал для отбора": "Channel for selection", -"Получить события": "Get events", -"Инструменты (ОПИ": "Tools (OpenIntegrations", -"ЮнитТестирование": "UnitTesting", -"МетодыОбсуждений": "DiscussionManagement", -"РаботаСНовостями": "PostsManagment", -"СоздатьТвитГифки": "CreateGifTweet", -"Новый подкаталог": "New subfolder", -"МассивПараметров": "ParameterArray", -"МетодХэширования": "HashingMethod", -"ДропбоксУчастник": "DropboxUser", -"УдалитьСообщение": "DeleteMessage", -"Добро пожаловать": "Welcome", -"ЗаписатьВызовCLI": "WriteCLICall", -"ОбработатьОбъект": "ProcessObject", -"ОтправитьКонтакт": "SendContact", -"Материалы встреч": "Meeting materials", -"МассивШтрихкодов": "BarcodesArray", -"СтрокаПараметров": "ParameterString", -"ИсходноеЗначение": "InitialValue", -"СоставБиблиотеки": "LibraryComposition", -"IDSИнициализации": "InitializationIDS", -"Переместить файл": "Move file", -"РазделительСтрок": "LineSeparator", -"РаботаСТаблицами": "TableManagement", -"Изменить событие": "Edit event", -"Тестовая реклама": "Test ads", -"ВыполнитьТестCLI": "ExecuteTestCLI", -"ЗапускаемыеТесты": "RunnableTests", -"Новый комментарий": "NewComment", -"ПреобразоватьДату": "ConvertDate", -"Данные для API v2": "Data for API v2", -"КалендарьПриемник": "TargetCalendar", -"ЛокальныеКаталоги": "LocalFolders", -"ID блока родителя": "Parent block ID", -"Определение полей": "Definition of fields", -"НачалоКодовУспеха": "StartOfSuccessCodes", -"ПолучитьБлокФайла": "GetFileBlock", -"Тестовое описание": "TestDescription", -"ПараметрЛокальный": "LocalParameter", -"АтрибутКатегории1": "CategoryAttribute1", -"ОзонАПИ_Штрихкоды": "OzonAPI_Barcodes", -"СортироватьПоДате": "SortByDate", -"Файлы Мессенджера": "Messenger files", -"СохранятьЛокально": "SaveLocally", -"ЗначениеПараметра": "ParameterValue", -"ПолучитьСписокБаз": "GetListOfBases", -"СтруктураТелефона": "PhoneStructure", -"РезультатПроверки": "CheckResult", -"Игровые приставки": "Consoles", -"ОткрытьОбсуждение": "OpenDiscussion", -"СтруктураЗначений": "ValueStructure", -"НачатьУчетВремени": "StartTimekeeping", -"Включение сервиса": "Enable service - ", -"Наш первый клиент": "OurFirstClient", -"КонецКодовПадений": "EndOfFailureCodes", -"Очень важный файл": "Very important file", -"ЭтоПредупреждение": "AsAlert", -"ЗакрытьОбсуждение": "CloseDiscussion", -"Наименование поля": "Field name", -"ВКВариантСвойства": "VKPropVariant", -"ГТ_СоздатьТаблицу": "GT_CreateTable", -"РаботаСКаталогами": "CatalogsManagment", -"ЗаполняемыеДанные": "FillableData", -"СтруктураПродавца": "SellerStructure", -"Тестовая подборка": "TestCollection", -"Текст уведомления": "Notification text", -"истории изменений": "changes history", -"СтруктураАтрибута": "AttributeStructure", -"Криптография (ОПИ": "Cryptography (OpenIntegrations", -"Копировать объект": "Copy object", -"ПолучитьХранилище": "GetStorage", -"СкопироватьОбъект": "CopyObject", -"Имя файла в Slack": "File name in Slack", -"Удалить сообщение": "Delete message", -"Ничего особенного": "Nothing special", -"ТелеграмПереслать": "TelegramReply", -"ОтправитьКартинку": "SendImage", -"СоздатьТемуФорума": "CreateForumThread", -"Обработка событий": "Event handling", -"Проверка_ВайберОк": "Check_ViberOk", -"Б24_РаботаСДиском": "B24_WorkingWithDrive", -"ОтветСоответствие": "ResponseMap", -"Секрет приложения": "Application secret", -"ЛокацияНазначения": "DestLocation", -"СоздатьБазуДанных": "CreateDatabase", -"ПереименоватьФайл": "RenameFile", -"Администрирование": "Administration", -"ВК_СоздатьИсторию": "VKAPI_CreateStory", -"ГД_СоздатьКаталог": "GD_CreateCatalog", -"СлакИсторияКанала": "SlackChannelHistory", -"Перейти по адресу": "Go to the", -"ПереместитьОбъект": "MoveObject", -"РазмерБлока Тогда": "BlockSize Then", -"Название подборки": "Selection name", -"ТекстовыйДокумент": "TextDocument", -"Проверка_ВКРепост": "Check_VKRepost", -"Токен авторизации": "Auth token", -"ОтправитьДокумент": "SendDocument", -"Название компании": "Company name", -"ВыходнаяКоллекция": "OutputCollection", -"НаписатьСообщение": "WriteMessage", -"Удаляет лид по ID": "Deletes a lead by ID", -"Заголовок новости": "Post title", -"Тестовая кампания": "TestCampaign", -"Название свойства": "Property name", -"КалендарьИсточник": "SourceCalendar", -"УправлениеСделкой": "ManageDeal", -"ВызватьИсключение": "Raise", -"СтруктураКартинки": "PictureStructure", -"Управление чатами": "Chat managment", -"Б24_РаботаСЛидами": "B24_LeadsManagment", -"./docs/ru/results": "./docs/en/results", -"ПрочитатьВсе (хук": "ReadAll (wh", -"ЯДискСписокФайлов": "YaDiskFilesList", -"ЛайкРепостКоммент": "LikeRepostComment", -"МинимальныйРазмер": "MinimumSize", -"Файл для отправки": "File for sending", -"КаталогИсходников": "SourceDirectory", -"АтрибутКатегории3": "CategoryAttribute3", -"ТаблицаПараметров": "ParametersTable", -"Пост из автотеста": "Post from autotest", -"ГуглЗначенияЯчеек": "GoogleCellValues", -"Путь или ID файла": "Path or ID of the file", -"СообщитьРезультат": "ReportResult", -"Получить страницу": "Get page", -"Файловые хостинги": "File-hosting services", -"СоответствиеПолей": "FieldMapping", -"КопироватьКаталог": "CopyFolder", -"Восстановить файл": "Restore file", -"МаркетинговыйЦвет": "MarketingColor", +"Начните диалог с": "Start a dialog with", +"СтруктураПозиции": "ItemStructure", +"КакАдминистратор": "AsAdmin", +"Создать страницу": "Create page", +"ПокинутьЧат (хук": "LeaveChat (wh", +"Отклонить задачу": "Disapprove task", +"ЭтоПереадресация": "ThisIsRedirection", +"ПараметрыЗапроса": "RequestParameters", +"ДоступныйОстаток": "AvailableBalance", +"ДобавитьИмяЛиста": "AddSheetName", +"VK_ДобавитьТовар": "VK_AddProduct", +"УдалитьПолностью": "DeleteCompletely", +"Ожидает контроля": "On controll", +"ПрочитатьЦелое32": "ReadInt32", +"ОписаниеКартинки": "ImageDescription", +"ПользовательЧата": "ChatMember", +"СоздатьТвитВидео": "CreateVideoTweet", +"ИзменитьЛид (хук": "UpdateLead (wh", +"ПутьКФайлуДанных": "DataFilePath", +"МассивИнформации": "ArrayOfInformation", +"ПривестиЗначение": "AdjustValue", +"Изменить таблицу": "Modify table", +"превью документа": "document preview", +"ЭлементСтатистики": "StatisticsItem", +"УдалитьТемуФорума": "DeleteForumTopic", +"Новое имя объекта": "New object name", +"VK_СоздатьИсторию": "VK_CreateStory", +"АтрибутКатегории5": "CategoryAttribute5", +"Б24_РаботаСЧатами": "B24_ChatManagment", +"массив ID товаров": "Products IDs array", +"Файл для загрузки": "File for upload", +"Дата : date": "Date : date", +"ID важной новости": "Id of important post", +"ID целевого поста": "ID of the target post", +"Текст комментария": "Comment text", +"Создать штрихкоды": "Create barcodes", +"ОтносительныеПути": "RelativePaths", +"Отправить контакт": "Send contact", +"Проверка_ВКИстина": "Check_VKTrue", +"УправлениеЗадачей": "ManageTask", +"ХешированиеДанных": "DataHashing", +"Проверка_ГКОбъект": "Check_GKObject", +"Строка, Структура": "String, Structure", +"Маркировка товара": "Product marking", +"Скрытый календарь": "Hidden calendar", +"СоздатьОбсуждение": "CreateDiscussion", +"ОсновнаяСтруктура": "MainStructure", +"ТоварСоСвойством2": "ProductWithProp2", +"НС_РаботаСФайлами": "NC_FilesManagment", "Использовать oint": "Use oint", "СообщениеУдаления": "DeletingMessage", "УстановитьWebhook": "SetWebhook", @@ -2460,7 +2384,6 @@ "Работа с задачами": "Tasks managment", "СоздатьУдалитьТег": "CreateDeleteTag", "Массив ID товаров": "Array of product IDs", -"ТоварСоСвойством2": "ProductWithProp2", "ПолучитьПолеПочты": "GetEmailField", "ГуглЦветКалендаря": "GoogleCalendarColors", "ИзменитьСообщение": "EditMessage", @@ -2470,60 +2393,10 @@ "СтруктураКампании": "CampaignStructure", "ВнешнееСоединение": "ExternalConnection", "СтандартныйСпособ": "StandardMethod", -"НС_РаботаСФайлами": "NC_FilesManagment", "Значение свойства": "Property value", -"ОсновнаяСтруктура": "MainStructure", -"Скрытый календарь": "Hidden calendar", -"Дата : date": "Date : date", -"Файл для загрузки": "File for upload", -"массив ID товаров": "Products IDs array", -"Б24_РаботаСЧатами": "B24_ChatManagment", -"ID важной новости": "Id of important post", -"ЭлементСтатистики": "StatisticsItem", -"Новое имя объекта": "New object name", -"УдалитьТемуФорума": "DeleteForumTopic", -"ID целевого поста": "ID of the target post", -"СоздатьОбсуждение": "CreateDiscussion", -"Создать штрихкоды": "Create barcodes", -"ОтносительныеПути": "RelativePaths", -"Отправить контакт": "Send contact", -"Проверка_ВКИстина": "Check_VKTrue", -"УправлениеЗадачей": "ManageTask", -"ХешированиеДанных": "DataHashing", -"Проверка_ГКОбъект": "Check_GKObject", -"Строка, Структура": "String, Structure", -"Маркировка товара": "Product marking", -"Текст комментария": "Comment text", -"АтрибутКатегории5": "CategoryAttribute5", "ЗначениеЛокальный": "LocalValue", -"СоответствиеФайла": "FileMapping", +"МаркетинговыйЦвет": "MarketingColor", "ВК_ЗагрузитьВидео": "VKAPI_UploadVideo", -"АтрибутКатегории4": "CategoryAttribute4", -"АТ_СоздатьТаблицу": "AT_CreateTable", -"НачалоКодовОшибок": "StartOfErrorCodes", -"СлакСписокКаналов": "SlackChannelsList", -"СоздатьТвитСВидео": "CreateTweetWithVideo", -"НачальнаяФигурная": "InitialCurly", -"Картинка автотест": "AutoTestImage", -"ЗакрытьТемуФорума": "CloseForumThread", -"МассивИзображений": "ImagesArray", -"СтруктураВозврата": "ReturnStructure", -"ОсновноеИзмерение": "MajorDimension", -"ОпросСоответствие": "PollMap", -"При отправке URL": "When sending URL", -"ВККартинкаАльбома": "VKAlbumPicture", -"МассивРезультатов": "ResultArray", -"СтруктураУпаковки": "PackageStructure", -"НовоеРасположение": "NewLocation", -"УдалитьОбработчик": "RemoveHandler", -"МаксимальнаяДлина": "MaximumLength", -"ПрочитатьJSONФайл": "ReadJSONFile", -"Проверка_ВКАльбом": "Check_VKAlbum", -"Отправить локацию": "Send location", -"Создать календарь": "Create calendar", -"ВозобновитьЗадачу": "RenewTask", -"АрхивироватьКанал": "ArchiveChannel", -"Криптография (OPI": "Cryptography (OPI", "ОтправкаСообщений": "MessageSending", "Описание картинки": "Image description", "СтруктураРодителя": "ParentStructure", @@ -2545,109 +2418,159 @@ "АтрибутКатегории2": "CategoryAttribute2", "ЗагруженныеДанные": "UploadedData", "ТелеграмСообщение": "TelegramMessage", -"VK_СоздатьИсторию": "VK_CreateStory", -"ЧЦ=10; ЧДЦ=0; ЧГ=0": "HC=10; HDC=0; HG=0", -"СоздатьЗадачу (хук": "CreateTask (wh", -"Удаляет пост по id": "Deletes a post by ID", -"ЗагрузитьМедиафайл": "UploadMediaFile", -"ПолучитьПолеФлажка": "GetCheckboxField", -"ЗагрузитьФайл (URL": "UploadFile (URL", -"НормализоватьФайлы": "NormalizeFiles", -"НайтиПользователей": "FindUsers", -"ЛокацияОтправления": "SendLocation", -"БитриксКомментарий": "BitrixComment", -"ПереданныйПараметр": "PassedParameter", -"ВайберПользователь": "ViberUser", -"Создать твит видео": "Create video tweet", -"СтрЗаканчиваетсяНа": "StrEndsWith", -"ПолучитьДанныеЧата": "GetChatData", -"ПринятьЗадачу (хук": "ApproveTask (wh", -"Создать твит гифки": "Create gif tweet", -"Копировать каталог": "Copy folder", -"Google Sheets (ОПИ": "Google Sheets (OpenIntegrations", -"ФормированиеБлоков": "BlockFormation", -"VK_УдалитьПодборку": "VK_DeleteCollection", -"ДвоичныеВКоллекцию": "BinaryToCollection", -"Архивировать канал": "Archive channel", -"РаботаСЖивойЛентой": "FeedPostsManagment", -"Новый подкаталог 2": "New subfolder 2", -"МассивСтрокиКнопок": "ButtonsLineArray", -"Email как RFC 2822": "Email as RFC 2822", -"СоответствиеТаблиц": "TableMapping", -"ДополнительныеФото": "AdditionalPhotos", -"ДлительностьОпроса": "PollDuration", -"СоздатьКомментарий": "CreateComment", -"Б24_РаботаСТокеном": "B24_TokenManagment", -"признак шаблона (Y": "is pattern (Y", -"ID книги приемника": "Destination spreadsheet ID", -"Отправка сообщений": "Messages sending", -"ПреобразоватьСвязь": "ConvertLink", -"Проверка_Структура": "Check_Structure", -"ИдентификаторФайла": "FileID", -"РазмерСжатыхДанных": "CompressedDataSize", -"Работа с новостями": "Posts managment", -"ПроцессорГенерации": "GenerationProcessor", -"ПривязатьШтрихкоды": "BindBarcodes", -"Отправить картинку": "Send image", -"БитриксАвторизация": "BitrixAuth", -"ИнформацияОбОшибке": "ErrorInfo", -"РазобратьКлючФайла": "SplitFileKey", -"КодированныеДанные": "EncodingString", -"ОзонУдалениеТовара": "OzonProductsDeleting", -"СоздатьУдалитьПост": "CreateDeletePost", -"ЗагрузитьФайлПоURL": "UploadFileByURL", -"Пример команды CLI": "CLI command example", -"ТолькоОбязательные": "RequiredOnly", -"Получить хранилище": "Get storage", -"Клиентский возврат": "Customer refund", -"Закрыть обсуждение": "Close discussion", -"ЯДиск_СоздатьПапку": "YDisk_CreateFolder", -"ОтправитьАудио (ДД": "SendAudio (DD", -"Активный : green": "Active : green", -"Переименовать файл": "Rename file", -"УдалитьЗадачу (хук": "DeleteTask (wh", -"Работа со складами": "Warehouses managment", -"ПреобразоватьПочту": "ConvertEmail", -"ОтправитьСообщение": "SendMessage", -"УправлениеДиалогом": "DialogManagement", -"ДобавитьОбработчик": "AddHandler", -"УдалитьСделку (хук": "DeleteDeal (wh", -"Отправить документ": "Send document", -"МассивКлючЗначение": "KeyValueArray", -"Создать твит опрос": "Create poll tweet", -"ОзонМассивОбъектов": "OzonObjectsArray", -"Изменить календарь": "Edit calendar", -"СтандартнаяЕдиница": "StandardUnit", -"УдалитьКомментарий": "DeleteComment", -"СуществующаяГруппа": "ExistingGroup", -"ПолучитьИнформацию": "GetData", -"НачальнаяТабуляция": "InitialTab", -"Создано из шаблона": "Created from template", -"ИзменитьАватарЧата": "ChangeChatPicture", -"НС_ПолучениеДанных": "NC_DataRetrieving", -"Тестовое сообщение": "TestMessage", -"СтрокаМетода.Метод": "MethodString.Method", -"Получить поле (url": "Get field (url", -"Тестовый заголовок": "TestTitle", -"ID книги источника": "Source spreadsheet ID", -"Высота товара в мм": "Product height in mm", -"Проверка_ЯДискДиск": "Check_YaDiskDrive", -"Идентификатор поля": "Field identifier", -"СоздатьСделку (хук": "CreateDeal (wh", -"ДанныеПользователя": "UserData", -"ОткрепитьСообщение": "UnpinMessage", -"ПараметрВКоллекцию": "ParameterToCollection", -"Удаляет файл по ID": "Delete file by ID", -"ОтправитьФайл (хук": "SendFile", -"Наименование видео": "Video name", -"СтруктураШтрихкода": "BarcodeStructure", -"Переместить объект": "Move object", -"ТекущаяВложенность": "CurrentNesting", -"УдалитьУведомление": "DeleteNotification", -"Токен пользователя": "User token", -"идентификатор лида": "lead identifier", -"Фильтр по родителю": "Filter by parent ID", +"Криптография (OPI": "Cryptography (OPI", +"АрхивироватьКанал": "ArchiveChannel", +"ВозобновитьЗадачу": "RenewTask", +"Создать календарь": "Create calendar", +"АтрибутКатегории4": "CategoryAttribute4", +"АТ_СоздатьТаблицу": "AT_CreateTable", +"НачалоКодовОшибок": "StartOfErrorCodes", +"СлакСписокКаналов": "SlackChannelsList", +"СоздатьТвитСВидео": "CreateTweetWithVideo", +"НачальнаяФигурная": "InitialCurly", +"Картинка автотест": "AutoTestImage", +"ЗакрытьТемуФорума": "CloseForumThread", +"МассивИзображений": "ImagesArray", +"СтруктураВозврата": "ReturnStructure", +"СоответствиеФайла": "FileMapping", +"ОсновноеИзмерение": "MajorDimension", +"При отправке URL": "When sending URL", +"ВККартинкаАльбома": "VKAlbumPicture", +"МассивРезультатов": "ResultArray", +"СтруктураУпаковки": "PackageStructure", +"НовоеРасположение": "NewLocation", +"УдалитьОбработчик": "RemoveHandler", +"МаксимальнаяДлина": "MaximumLength", +"ПрочитатьJSONФайл": "ReadJSONFile", +"Проверка_ВКАльбом": "Check_VKAlbum", +"Отправить локацию": "Send location", +"ОпросСоответствие": "PollMap", +"Восстановить файл": "Restore file", +"ТекстовыйДокумент": "TextDocument", +"СоответствиеПолей": "FieldMapping", +"Наш первый клиент": "OurFirstClient", +"КонецКодовПадений": "EndOfFailureCodes", +"Очень важный файл": "Very important file", +"ЭтоПредупреждение": "AsAlert", +"ЗакрытьОбсуждение": "CloseDiscussion", +"Наименование поля": "Field name", +"ВКВариантСвойства": "VKPropVariant", +"ГТ_СоздатьТаблицу": "GT_CreateTable", +"РаботаСКаталогами": "CatalogsManagment", +"ЗаполняемыеДанные": "FillableData", +"СтруктураПродавца": "SellerStructure", +"Тестовая подборка": "TestCollection", +"Текст уведомления": "Notification text", +"истории изменений": "changes history", +"СтруктураАтрибута": "AttributeStructure", +"Криптография (ОПИ": "Cryptography (OpenIntegrations", +"Копировать объект": "Copy object", +"ПолучитьХранилище": "GetStorage", +"СкопироватьОбъект": "CopyObject", +"Имя файла в Slack": "File name in Slack", +"Удалить сообщение": "Delete message", +"Включение сервиса": "Enable service - ", +"Ничего особенного": "Nothing special", +"НачатьУчетВремени": "StartTimekeeping", +"ОткрытьОбсуждение": "OpenDiscussion", +"КопироватьКаталог": "CopyFolder", +"ПреобразоватьДату": "ConvertDate", +"Данные для API v2": "Data for API v2", +"КалендарьПриемник": "TargetCalendar", +"ЛокальныеКаталоги": "LocalFolders", +"ID блока родителя": "Parent block ID", +"Определение полей": "Definition of fields", +"НачалоКодовУспеха": "StartOfSuccessCodes", +"ПолучитьБлокФайла": "GetFileBlock", +"Тестовое описание": "TestDescription", +"ПараметрЛокальный": "LocalParameter", +"АтрибутКатегории1": "CategoryAttribute1", +"ОзонАПИ_Штрихкоды": "OzonAPI_Barcodes", +"СортироватьПоДате": "SortByDate", +"Файлы Мессенджера": "Messenger files", +"СохранятьЛокально": "SaveLocally", +"ЗначениеПараметра": "ParameterValue", +"ПолучитьСписокБаз": "GetListOfBases", +"СтруктураТелефона": "PhoneStructure", +"РезультатПроверки": "CheckResult", +"Игровые приставки": "Consoles", +"СтруктураЗначений": "ValueStructure", +"ТелеграмПереслать": "TelegramReply", +"Новый комментарий": "NewComment", +"СоздатьТемуФорума": "CreateForumThread", +"КалендарьИсточник": "SourceCalendar", +"УправлениеСделкой": "ManageDeal", +"ВызватьИсключение": "Raise", +"СтруктураКартинки": "PictureStructure", +"Управление чатами": "Chat managment", +"Б24_РаботаСЛидами": "B24_LeadsManagment", +"./docs/ru/results": "./docs/en/results", +"ПрочитатьВсе (хук": "ReadAll (wh", +"ОтправитьКартинку": "SendImage", +"ЛайкРепостКоммент": "LikeRepostComment", +"МинимальныйРазмер": "MinimumSize", +"Файл для отправки": "File for sending", +"КаталогИсходников": "SourceDirectory", +"АтрибутКатегории3": "CategoryAttribute3", +"ТаблицаПараметров": "ParametersTable", +"Пост из автотеста": "Post from autotest", +"ГуглЗначенияЯчеек": "GoogleCellValues", +"Путь или ID файла": "Path or ID of the file", +"СообщитьРезультат": "ReportResult", +"Получить страницу": "Get page", +"Файловые хостинги": "File-hosting services", +"Название свойства": "Property name", +"Тестовая кампания": "TestCampaign", +"ЯДискСписокФайлов": "YaDiskFilesList", +"Удаляет лид по ID": "Deletes a lead by ID", +"Обработка событий": "Event handling", +"Заголовок новости": "Post title", +"Проверка_ВайберОк": "Check_ViberOk", +"Б24_РаботаСДиском": "B24_WorkingWithDrive", +"ОтветСоответствие": "ResponseMap", +"Секрет приложения": "Application secret", +"ЛокацияНазначения": "DestLocation", +"ПереименоватьФайл": "RenameFile", +"Администрирование": "Administration", +"ВК_СоздатьИсторию": "VKAPI_CreateStory", +"ГД_СоздатьКаталог": "GD_CreateCatalog", +"СоздатьБазуДанных": "CreateDatabase", +"Перейти по адресу": "Go to the", +"СлакИсторияКанала": "SlackChannelHistory", +"ВыходнаяКоллекция": "OutputCollection", +"Название компании": "Company name", +"ОтправитьДокумент": "SendDocument", +"Токен авторизации": "Auth token", +"НаписатьСообщение": "WriteMessage", +"Название подборки": "Selection name", +"РазмерБлока Тогда": "BlockSize Then", +"ПереместитьОбъект": "MoveObject", +"Проверка_ВКРепост": "Check_VKRepost", +"ДелегироватьЗадачу": "DelegateTask", +"Команда CLI: tools": "CLI Command: tools", +"РаботаССообщениями": "MessageManagement", +"Праздники Беларуси": "Holidays in Belarus", +"РаботаСХранилищами": "StoragesManagment", +"ул. Пушкина, д. 10": "Pushkin st., b. 10", +"Dropbox_УдалитьТег": "Dropbox_DeleteTag", +"VK_УдалитьКартинку": "VK_DeleteImage", +"Изменить цвет чата": "Change chat color", +"УдалитьОбъект (URL": "DeleteObject (URL", +"Открыть обсуждение": "Open discussion", +"задача в отчете (Y": "task in report (Y", +"Новое имя варианта": "New variant name", +"РазмерПрефиксаGZip": "GZipPrefixSize", +"ОтправитьВидео (ДД": "SendVideo (DD", +"Создать подкаталог": "Create new subfolder", +"Создать обсуждение": "Create discussion", +"ПолучитьПолеСсылки": "GetLinkField", +"Анонимность опроса": "Poll anonymity", +"Проверка_ВКИстория": "Check_VKStory", +"РежимОткрытияФайла": "FileOpenMode", +"Ширина товара в мм": "Product width in mm", "ПолучитьИДКартинки": "GetImageID", +"ПолучитьСтатистику": "GetStatistics", +"БитриксСписокЗадач": "BitrixTasksList", "Изменить сообщение": "Edit message", "СоздатьУдалитьБлок": "CreateDeleteBlock", "ГТ_ПолучитьТаблицу": "GT_GetTable", @@ -2668,34 +2591,35 @@ "ПолучитьОбновления": "GetUpdates", "АрхивироватьТовары": "ArchiveProducts", "URL для сокращения": "URL for shortening", -"ПолучитьСтатистику": "GetStatistics", "Установить Webhook": "Set Webhook", -"Ширина товара в мм": "Product width in mm", -"Команда CLI: tools": "CLI Command: tools", -"РаботаССообщениями": "MessageManagement", -"Праздники Беларуси": "Holidays in Belarus", -"РаботаСХранилищами": "StoragesManagment", -"ул. Пушкина, д. 10": "Pushkin st., b. 10", -"Dropbox_УдалитьТег": "Dropbox_DeleteTag", -"VK_УдалитьКартинку": "VK_DeleteImage", -"Изменить цвет чата": "Change chat color", -"ДелегироватьЗадачу": "DelegateTask", -"УдалитьОбъект (URL": "DeleteObject (URL", -"РежимОткрытияФайла": "FileOpenMode", -"задача в отчете (Y": "task in report (Y", -"Новое имя варианта": "New variant name", -"РазмерПрефиксаGZip": "GZipPrefixSize", -"ОтправитьВидео (ДД": "SendVideo (DD", -"Создать подкаталог": "Create new subfolder", -"Создать обсуждение": "Create discussion", -"ПолучитьПолеСсылки": "GetLinkField", -"Анонимность опроса": "Poll anonymity", -"Проверка_ВКИстория": "Check_VKStory", -"Открыть обсуждение": "Open discussion", -"БитриксСписокЗадач": "BitrixTasksList", "ЗначенияПараметров": "ParameterValues", -"Логин пользователя": "Users login", +"ОпубликоватьОбъект": "PublishObject", "СоответствиеФайлов": "FileMapping", +"Опубликовать папку": "Publish folder", +"СкопироватьКаталог": "MakeFolderCopy", +"Удаляет блок по ID": "Deletes block by ID", +"ПолучитьБазуДанных": "GetDatabase", +"ВключитьЗвукЗадачи": "UnmuteTask", +"ЗакрепитьСообщение": "PinMessage", +"ПолучитьТоварыПоИД": "GetProductsByID", +"ПреобразоватьЧисло": "ConvertNumber", +"ВКСтатистикаПостов": "VKPostsStatistic", +"Заголовок страницы": "Page title", +"Тестовая таблица 2": "TestTable2", +"СкоприроватьОбъект": "CopyObject", +"СтруктураПараметра": "ParameterStructure", +"ПолучитьПолеНомера": "GetNumberField", +"Соответствие полей": "Fields map", +"УдалитьВнешнийФайл": "DeleteExternalFile", +"Новое наименование": "New name", +"Получить календарь": "Get calendar", +"СоответствиеИконки": "IconMap", +"ИзменитьТемуФорума": "EditForumTopic", +"Фильтр по родителю": "Filter by parent ID", +"ПереименоватьКанал": "RenameChannel", +"Логин пользователя": "Users login", +"ДополнительныйЦвет": "SecondaryColor", +"ОсновнойОбработчик": "MainHandler", "!OInt КБайт = 1024": "!OInt KB = 1024", "ДропБоксМетаданные": "DropboxMetadata", "Новая таблица (изм": "New table (change", @@ -2717,133 +2641,133 @@ "Текст новых правил": "Text of the new rules", "Имя : title": "Name : title", "УправлениеСобытием": "EventManagement", -"ОсновнойОбработчик": "MainHandler", -"ОпубликоватьОбъект": "PublishObject", "ОтправитьГифку (ДД": "SendGif (DD", -"ДополнительныйЦвет": "SecondaryColor", -"ПереименоватьКанал": "RenameChannel", -"Опубликовать папку": "Publish folder", -"СкопироватьКаталог": "MakeFolderCopy", -"Удаляет блок по ID": "Deletes block by ID", -"ПолучитьБазуДанных": "GetDatabase", -"ВключитьЗвукЗадачи": "UnmuteTask", -"ЗакрепитьСообщение": "PinMessage", -"ПолучитьТоварыПоИД": "GetProductsByID", -"ПреобразоватьЧисло": "ConvertNumber", -"ВКСтатистикаПостов": "VKPostsStatistic", -"Заголовок страницы": "Page title", -"Тестовая таблица 2": "TestTable2", -"СкоприроватьОбъект": "CopyObject", -"СтруктураПараметра": "ParameterStructure", -"ПолучитьПолеНомера": "GetNumberField", -"Соответствие полей": "Fields map", -"УдалитьВнешнийФайл": "DeleteExternalFile", -"Новое наименование": "New name", -"Получить календарь": "Get calendar", -"СоответствиеИконки": "IconMap", -"ИзменитьТемуФорума": "EditForumTopic", -"Архив : yellow": "Archive : yellow", -"Идентификатор файла": "File identifier", -"ОбработатьВыводJSON": "ProcessJSONOutput", -"СоздатьЗаписи (одна": "CreateRecords (one", -"ПолучитьСписокАкций": "GetPromotionsList", -"ПолучитьСписокЛидов": "GetLeadsList", -"0 Или СтрНайти(Путь": "0 Or StrFind(Path", -"Массив из Структура": "Array of Structure", -"Фото- и видеоуслуги": "Photo and video service", -"Наименование канала": "Channel name", -"УдалитьОбъект (Путь": "DeleteObject (Path", -"Удалить тему форума": "Delete forum thread", -"ПараметрыЗаписиJSON": "JSONWriterSettings", -"Б24_РаботаСЗадачами": "B24_TaskManagment", -"ЗаменитьСпецсимволы": "ReplaceSpecialCharacters", -"Канцелярские товары": "Stationery", -"Создает базу данных": "Creates a database", -"Проверка_ВКСвойство": "Check_VKProp", -"Найти пользователей": "Find users", -"ПолучитьТекущуюДату": "GetCurrentDate", -"ГуглОбновлениеЯчеек": "GoogleCellUpdating", -"ОзонМассивОбновлено": "OzonUpdatedArray", -"Начать учет времени": "Start timekeeping", -"ПереданныеПараметры": "PassedParameters", -"ПолучитьСвойАккаунт": "GetOwnAccount", -"ID категории товара": "Product category ID", -"Dropbox_СкачатьФайл": "Dropbox_DownloadFile", -"РаскодироватьСтроку": "DecodeString", -"Новое описание базы": "New database description", -"СоздатьПользователя": "CreateUser", -"Dropbox_ДобавитьТег": "Dropbox_AddTag", -"Наименование товара": "Product name", -"МассивПользователей": "ArrayOfUsers", -"Данные для API v1.1": "Data for API v1.1", -"Удалить комментарий": "Delete comment", -"ОзонДобавлениеКодов": "OzonNewCodes", -"телефон заполнен (Y": "phone field is filled (Y", -"НеобходимыйПараметр": "RequiredParameter", -"АккаунтИАвторизация": "AccountAndAuthorization", -"СоответствиеСвойств": "PropertyMap", -"СоздатьСсылкуТокена": "CreateTokenLink", -"Получить информацию": "Get data", -"Кол-во комментариев": "Comments count", -"НормализоватьОснову": "NormalizeMain", -"Новое имя хранилища": "New storage name", -"идентификатор сайта": "site identifier", -"СтруктураПолучателя": "RecipientStructure", -"Плановое завершение": "Planned end", -"Длительность опроса": "Poll duration", -"ВажныйДокумент.docx": "ImportantDocument.docx", -"РаботаСОбсуждениями": "DiscussionManagement", -"Массив файлов видео": "Video files array", -"ПолучитьВнешнийФайл": "GetExternalFile", -"ОзонЗаданиеЗагрузки": "OzonUploadTask", -"ПреобразоватьСтатус": "ConvertStatus", -"Удаляет тему форума": "Deletes a forum thread", -"СоздатьТвитСОпросом": "CreateTweetWithPoll", -"РаботаСТемамиФорума": "ForumTopicManagement", -"Архивировать товары": "Archive products", -"МассивМедиаКартинок": "MediaPictureArray", -"СоответствиеСобытия": "EventMap", -"Получает файл по ID": "Gets file by ID", -"Опубликовать объект": "Publish object", -"Получить статистику": "Get statistics", -"Отбор по типу файла": "Filter by file type", -"Удалить уведомление": "Delete notification", -"БуферДвоичныхДанных": "BinaryDataBuffer", -"УчетРабочегоВремени": "Timekeeping", -"ПолучитьТокенПоКоду": "GetTokenByCode", -"ВосстановитьКаталог": "RestoreFolder", -"Новый текст новости": "New post text", -"Эфимерное сообщение": "Ephemeral message", -"Путь внутри объекта": "Path inside the object", -"ПолучитьЗадачу (хук": "GetTask (wh", -"Альбом из автотеста": "AlbumFromAutoTest", -"ДобавитьВидеоТовара": "AddProductVideo", -"СдэкАПИ_ОбщиеМетоды": "CdekAPI_CommonMethods", -"ПолучитьКомментарий": "GetComment", -"СтруктураЗаголовков": "HeadersStructure", -"Открепить сообщение": "Unpin message", -"СформироватьКоманду": "FormCommand", -"Картинка задачи.jpg": "Topic picture.jpg", -"ИзменитьСделку (хук": "UpdateDeal (wh", -"Создание приложения": "Creating an application", -"ДобавитьКомментарий": "CrateComment", -"ВК_МетодыОбсуждений": "VKAPI_DiscussionMethods", -"ОбновитьЦеныТоваров": "UpdateProductsPrices", -"Проверка_ВКПодборка": "Check_VKCollection", -"ОтключитьЗвукЗадачи": "MuteTask", -"Массив Из Структура": "Array of Structure", -"ИсполняемыеСценарии": "RunningScenarios", -"ПолучитьСписокТегов": "GetTagList", -"СоответствиеОбложки": "CoverMap", -"ПолучитьДанныеФайла": "GetFileData", -"СтрокаПользователей": "MembersQuery", -"Пароль пользователя": "Users password", -"Закрыть тему форума": "Close forum thread", -"Получить поле (дата": "Get field (date", -"Получить список баз": "Get list of bases", -"Перейдите по ссылке": "Go to the link", -"УдалитьНовость (хук": "DeletePost (wh", +"идентификатор лида": "lead identifier", +"Токен пользователя": "User token", +"Новый подкаталог 2": "New subfolder 2", +"МассивСтрокиКнопок": "ButtonsLineArray", +"Email как RFC 2822": "Email as RFC 2822", +"СоответствиеТаблиц": "TableMapping", +"ДополнительныеФото": "AdditionalPhotos", +"ДлительностьОпроса": "PollDuration", +"СоздатьКомментарий": "CreateComment", +"Б24_РаботаСТокеном": "B24_TokenManagment", +"признак шаблона (Y": "is pattern (Y", +"ID книги приемника": "Destination spreadsheet ID", +"Отправка сообщений": "Messages sending", +"ПреобразоватьСвязь": "ConvertLink", +"Проверка_Структура": "Check_Structure", +"РазмерСжатыхДанных": "CompressedDataSize", +"Работа с новостями": "Posts managment", +"ПроцессорГенерации": "GenerationProcessor", +"ПривязатьШтрихкоды": "BindBarcodes", +"Отправить картинку": "Send image", +"БитриксАвторизация": "BitrixAuth", +"ИнформацияОбОшибке": "ErrorInfo", +"РазобратьКлючФайла": "SplitFileKey", +"КодированныеДанные": "EncodingString", +"РаботаСЖивойЛентой": "FeedPostsManagment", +"ОзонУдалениеТовара": "OzonProductsDeleting", +"Архивировать канал": "Archive channel", +"VK_УдалитьПодборку": "VK_DeleteCollection", +"УдалитьУведомление": "DeleteNotification", +"ЧЦ=10; ЧДЦ=0; ЧГ=0": "HC=10; HDC=0; HG=0", +"СоздатьЗадачу (хук": "CreateTask (wh", +"Удаляет пост по id": "Deletes a post by ID", +"ЗагрузитьМедиафайл": "UploadMediaFile", +"ПолучитьПолеФлажка": "GetCheckboxField", +"ЗагрузитьФайл (URL": "UploadFile (URL", +"НормализоватьФайлы": "NormalizeFiles", +"НайтиПользователей": "FindUsers", +"ЛокацияОтправления": "SendLocation", +"БитриксКомментарий": "BitrixComment", +"ПереданныйПараметр": "PassedParameter", +"ВайберПользователь": "ViberUser", +"Создать твит видео": "Create video tweet", +"СтрЗаканчиваетсяНа": "StrEndsWith", +"ПолучитьДанныеЧата": "GetChatData", +"ПринятьЗадачу (хук": "ApproveTask (wh", +"Создать твит гифки": "Create gif tweet", +"Копировать каталог": "Copy folder", +"Google Sheets (ОПИ": "Google Sheets (OpenIntegrations", +"ФормированиеБлоков": "BlockFormation", +"ДвоичныеВКоллекцию": "BinaryToCollection", +"СоздатьУдалитьПост": "CreateDeletePost", +"ИдентификаторФайла": "FileID", +"Пример команды CLI": "CLI command example", +"НачальнаяТабуляция": "InitialTab", +"Создано из шаблона": "Created from template", +"ИзменитьАватарЧата": "ChangeChatPicture", +"НС_ПолучениеДанных": "NC_DataRetrieving", +"Тестовое сообщение": "TestMessage", +"СтрокаМетода.Метод": "MethodString.Method", +"Получить поле (url": "Get field (url", +"Тестовый заголовок": "TestTitle", +"ЗагрузитьФайлПоURL": "UploadFileByURL", +"Высота товара в мм": "Product height in mm", +"ПолучитьИнформацию": "GetData", +"Проверка_ЯДискДиск": "Check_YaDiskDrive", +"СоздатьСделку (хук": "CreateDeal (wh", +"ДанныеПользователя": "UserData", +"ОткрепитьСообщение": "UnpinMessage", +"ПараметрВКоллекцию": "ParameterToCollection", +"Удаляет файл по ID": "Delete file by ID", +"ОтправитьФайл (хук": "SendFile", +"Наименование видео": "Video name", +"СтруктураШтрихкода": "BarcodeStructure", +"Переместить объект": "Move object", +"ТекущаяВложенность": "CurrentNesting", +"Идентификатор поля": "Field identifier", +"СуществующаяГруппа": "ExistingGroup", +"ID книги источника": "Source spreadsheet ID", +"ТолькоОбязательные": "RequiredOnly", +"УдалитьКомментарий": "DeleteComment", +"Получить хранилище": "Get storage", +"Клиентский возврат": "Customer refund", +"Закрыть обсуждение": "Close discussion", +"ЯДиск_СоздатьПапку": "YDisk_CreateFolder", +"ОтправитьАудио (ДД": "SendAudio (DD", +"Активный : green": "Active : green", +"УдалитьЗадачу (хук": "DeleteTask (wh", +"Работа со складами": "Warehouses managment", +"ПреобразоватьПочту": "ConvertEmail", +"Переименовать файл": "Rename file", +"УправлениеДиалогом": "DialogManagement", +"СтандартнаяЕдиница": "StandardUnit", +"ОтправитьСообщение": "SendMessage", +"ОзонМассивОбъектов": "OzonObjectsArray", +"Создать твит опрос": "Create poll tweet", +"МассивКлючЗначение": "KeyValueArray", +"Изменить календарь": "Edit calendar", +"УдалитьСделку (хук": "DeleteDeal (wh", +"ДобавитьОбработчик": "AddHandler", +"Отправить документ": "Send document", +"СоздатьНовость (хук": "CreatePost (wh", +"Комплексные решения": "Complete solutions", +"Переместить каталог": "Move folder", +"УправлениеПодборкой": "SelectionManagement", +"БитриксСоответствие": "BitrixMap", +"АльтернативныйТекст": "AlternateText", +"СтруктураКлавиатуры": "KeyboardStructure", +"МассивХарактеристик": "AttributesArray", +"Получить обновления": "Get updates", +"ПолучениеИнформации": "DataRetrieval", +"Новое подразделение": "New department", +"СоздатьТвитКартинки": "CreateImageTweet", +"Получить поле (файл": "Get field (file", +"СгруппироватьТовары": "GroupProducts", +"НаписатьВОбсуждение": "WriteInDiscussion", +"ОтложитьЗадачу (хук": "DeferTask (wh", +"СтруктураИнформации": "DataStructure", +"Закрепить сообщение": "Pin message", +"БитриксНеопределено": "BitrixUndefined", +"ПутьЛоговБиблиотеки": "LibraryLogPath", +"ПолучитьСписокЗадач": "GetTasksList", +"СерверноеВремя (хук": "ServerTime (wh", +"ОзонСписокКатегорий": "OzonCategoryList", "ПолучитьОбщийМодуль": "GetCommonModule", +"УдалитьТоварыБезSKU": "DeleteProductsWithoutSKU", +"Создать базу данных": "Create database", "Переместить событие": "Move event", "УдалитьКаталог (хук": "DeleteFolder (wh", "ДобавитьФайлВЗадачу": "AttachFileToTopic", @@ -2851,9 +2775,10 @@ "СоздатьИзменитьБазу": "CreateUpdateDatabase", "РаботаСППолямиЗадач": "TasksFieldsManagment", "ПолучитьСделку (хук": "GetDeal (wh", +"ЦеныИОстаткиТоваров": "PricesAndStocks", "Портативная техника": "Portable gadgets", +"КопироватьЛист (доп": "CopySheet (new", "ПриостановитьЗадачу": "PauseTask", -"Измененная подборка": "EditedCollection", "Количество : number": "Count : number", "Скоприровать объект": "Copy object", "ЗаменитьСпецСимволы": "ReplaceSpecialCharacters", @@ -2864,61 +2789,10 @@ "ИзменитьЗадачу (хук": "UpdateTask (wh", "В качестве чат-бота": "Like a chat-bot", "ПреобразованиеТипов": "TypeConversion", -"УдалитьТоварыБезSKU": "DeleteProductsWithoutSKU", -"КопироватьЛист (доп": "CopySheet (new", -"ОзонСписокКатегорий": "OzonCategoryList", -"ПолучитьСписокЗадач": "GetTasksList", -"Комплексные решения": "Complete solutions", -"Переместить каталог": "Move folder", -"УправлениеПодборкой": "SelectionManagement", -"БитриксСоответствие": "BitrixMap", -"АльтернативныйТекст": "AlternateText", -"СтруктураКлавиатуры": "KeyboardStructure", -"МассивХарактеристик": "AttributesArray", -"Получить обновления": "Get updates", -"СоздатьНовость (хук": "CreatePost (wh", -"ПолучениеИнформации": "DataRetrieval", -"СерверноеВремя (хук": "ServerTime (wh", -"СоздатьТвитКартинки": "CreateImageTweet", -"Получить поле (файл": "Get field (file", -"СгруппироватьТовары": "GroupProducts", -"НаписатьВОбсуждение": "WriteInDiscussion", -"ОтложитьЗадачу (хук": "DeferTask (wh", -"СтруктураИнформации": "DataStructure", -"Закрепить сообщение": "Pin message", -"БитриксНеопределено": "BitrixUndefined", -"ПутьЛоговБиблиотеки": "LibraryLogPath", -"Новое подразделение": "New department", -"Создать базу данных": "Create database", +"Измененная подборка": "EditedCollection", "РабочееПространство": "Workspace", -"ПреобразоватьСсылку": "ConvertURL", +"Создает новую книгу": "Creates a new spreadsheet", "ТекущийПользователь": "CurrentUser", -"СоответствиеМетодов": "MethodMap", -"ПолучитьДиалог (хук": "GetDialog (wh", -"Нажмите Publish App": "Click on Publish App", -"УдалитьЗаписи (одна": "DeleteRecords (one", -"Переслать сообщение": "Forward message", -"ПреобразоватьБулево": "ConvertBoolean", -"Получить блок файла": "Get file block", -"Структура Из Строка": "Structure Of String", -"АТЗаписьНомерСтрока": "ATRecordNumberAndString", -"Глубина товара в мм": "Product depth in mm", -"Массив файлов гифок": "Gif files array", -"Новое имя файла.jpg": "New file name.jpg", -"СписокПользователей": "UserList", -"ДобавитьВнешнийФайл": "AddExternalFile", -"ПолучитьКомментарии": "GetComments", -"Делегировать задачу": "Delegate task", -"ОтправитьФайл (Путь": "SendFile (Path", -"ТелеграмПриглашение": "TelegramInvitation", -"Создать комментарий": "Create comment", -"ТелеграмМедиагруппа": "TelegramMediagroup", -"Открыть тему форума": "Open forum thread", -"СтруктураПараметров": "ParametersStructure", -"Привязать штрихкоды": "Bind barcodes", -"НаписатьКомментарий": "WriteComment", -"Структура из Строка": "Structure Of String", -"Отправить сообщение": "Send message", "ПолучитьЦеныТоваров": "GetProductsPrices", "РаботаСБазамиДанных": "DatabaseManagement", "Отправляемая ссылка": "SentLink", @@ -2940,100 +2814,158 @@ "Скопировать каталог": "Copy folder", "РазмерПостфиксаGZip": "GZipPostfixSize", "ОбработатьДанныеTMA": "ProcessTMAData", -"Создает новую книгу": "Creates a new spreadsheet", -"ЦеныИОстаткиТоваров": "PricesAndStocks", -"ВозвращаемоеЗначение": "ReturnValue", -"ВКИнформацияОТоварах": "VKProductData", -"Описание нового поля": "Description of the new field", -"ФИО контактного лица": "Full name of contact person", -"ПолучитьТелоКакПоток": "GetBodyAsStream", -"ВКТ_УправлениеЧатами": "VKT_ChatManagment", -"ПолучитьПодборкиПоИД": "GetSelectionsByID", -"Обновленный файл.jpg": "UpdatedFile.jpg", -"ИзменитьПользователя": "UpdateUser", -"УстановитьРежимТеста": "SetTestMode", -"Скопируйте **Токен**": "Copy the **Token**", -"Проверка_БитриксПоля": "Check_BitrixFields", -"ЗагрузитьБольшойФайл": "UploadLargeFile", -"Общий вес (в граммах": "Total weight (grams", -"СоздатьПапку (корень": "CreateFolder (root", -"ПолучитьИмяФайлаТела": "GetBodyFileName", -"Будущая сделка в RUB": "Future deal in RUB", -"Аудио и видеотехника": "Audio and video", -"СоответствиеВарианта": "OptionMap", -"ЛокальныеПодкаталоги": "LocalSubfolders", -"Создать/Удалить блок": "Create/Delete block", -"ПолучениеОбщихДанных": "GeneralDataRetrieval", -"ДобавитьОписаниеБазы": "AddDatabaseDescription", -"СоздатьТекстовыйТвит": "CreateTextTweet", -"Получение информации": "Data retrieval", -"НастройкиИИнформация": "SettingsAndInformation", -"Google Calendar (ОПИ": "Google Calendar (OpenIntegrations", -"Б24_РаботаСНовостями": "B24_PostsManagment", -"Приостановить задачу": "Pause task", -"Проверка_ВКСообщение": "Check_VKMessage", -"Размер).Равно(Истина": "Size).Equal(True", -"Проверка_ТелеграмБан": "Check_TelegramBan", -"СменитьВладельцаЧата": "ChangeChatOwner", -"ЗавершитьЗадачу (хук": "CompleteTask (wh", -"Путь или ID каталога": "Path or ID of the directory", -"СоздатьПодразделение": "CreateDepartment", -"Новый заголовок базы": "New database title", -"Наименование альбома": "Album name", -"ПереносСтрокJSON.Нет": "JSONLineBreak.None", -"ПолучитьСписокФайлов": "GetFilesList", -"Свойства базы данных": "Database properties", -"СформироватьТестыЯкс": "FormYAXTests", -"Получить базу данных": "Get database", -"Дата выдачи паспорта": "Date of issue of passport", -"БезопасноеСоединение": "SafeConnection", -"Отложенное сообщение": "Sheduled message", -"ПрограммныйИнтерфейс": "Public", -"Тестовое сообщение 2": "TestMessage2", -"СоздатьИсторию (путь": "CreateStory (path", -"ПолучитьПолеВложения": "GetAttachmentField", -"Аннотация к картинке": "Image annotation", -"ПолучитьСписокТестов": "GetTestList", -"СоздатьТоварПодборку": "CreateProductSelection", -"color=Зеленый) Метод": "color=Green) Method", -"ЗагрузитьУдалитьФайл": "UploadDeleteFile", -"Б24_РаботаСоСделками": "B24_DealsManagment", -"ПреобразоватьТелефон": "ConvertPhone", -"СделатьФайлПубличным": "MakeFilePublic", -"МассивДвоичныхДанных": "BinaryDataArray", -"МассивСтруктурКнопок": "ArrayOfButtonStructures", -"Работа с CLI версией": "Working with CLI app", -"СоздатьСтраницуВБазу": "CreatePageInDatabase", -"СоздатьУдалитьЗаписи": "CreateDeleteRecords", -"Проверка_НоушнОбъект": "Check_NotionObject", -"Изменить комментарий": "Modify comment", -"ID страницы родителя": "Parent page ID", -"Изменение публикации": "PublicationChange", -"Telegram_СкачатьФайл": "Telegram_DownloadFile", -"Восстановить каталог": "Restore folder", -"Bitrix24_УдалитьФайл": "Bitrix24_DeleteFile", -"Создать пользователя": "Create user", -"предполагаемая сумма": "expected amount", -"Идентификатор товара": "Product identifier", -"Начало синхронизации": "Start synchronization", -"Dropbox_СоздатьПапку": "Dropbox_CreateFolder", -"Делает репост записи": "Reposts the record", -"ЧатыИЛичныеСообщения": "ChatsAndMessages", -"ВК_ЛайкРепостКоммент": "VKAPI_LikeRepostComment", -"ПолучитьСвязанныеSKU": "GetRelatedSKUs", -"ПолучитьКаталог (хук": "GetFolder (wh", -"ВывестиДопИнформацию": "DisplayAdditionalInformation", -"ПолучитьПользователя": "GetUser", -"ответ сервера Google": "Google server response", -"ID поля для удаления": "Field ID for deletion", -"Важный документ.docx": "Imortant doc.docx", -"Неподдерживаемый тип": "Invalid type", -"Изменить аватар чата": "Change chat picture", -"Удаляет задачу по ID": "Delete task by ID", -"УправлениеЗвукомЧата": "ChatNotificationsSwitch", -"Комментарий к заказу": "Order comment", -"ОтклонитьЗадачу (хук": "DisapproveTask (wh", -"ОтправитьАудио (Путь": "SendAudio (Path", +"Отправить сообщение": "Send message", +"Структура из Строка": "Structure Of String", +"НаписатьКомментарий": "WriteComment", +"Привязать штрихкоды": "Bind barcodes", +"СоответствиеМетодов": "MethodMap", +"ПолучитьДиалог (хук": "GetDialog (wh", +"Нажмите Publish App": "Click on Publish App", +"УдалитьЗаписи (одна": "DeleteRecords (one", +"Переслать сообщение": "Forward message", +"ПреобразоватьБулево": "ConvertBoolean", +"Получить блок файла": "Get file block", +"Структура Из Строка": "Structure Of String", +"АТЗаписьНомерСтрока": "ATRecordNumberAndString", +"Глубина товара в мм": "Product depth in mm", +"ПреобразоватьСсылку": "ConvertURL", +"Массив файлов гифок": "Gif files array", +"СписокПользователей": "UserList", +"ДобавитьВнешнийФайл": "AddExternalFile", +"ПолучитьКомментарии": "GetComments", +"Делегировать задачу": "Delegate task", +"ОтправитьФайл (Путь": "SendFile (Path", +"ТелеграмПриглашение": "TelegramInvitation", +"Создать комментарий": "Create comment", +"ТелеграмМедиагруппа": "TelegramMediagroup", +"Открыть тему форума": "Open forum thread", +"СтруктураПараметров": "ParametersStructure", +"Новое имя файла.jpg": "New file name.jpg", +"УдалитьНовость (хук": "DeletePost (wh", +"ИсполняемыеСценарии": "RunningScenarios", +"Получить список баз": "Get list of bases", +"ID категории товара": "Product category ID", +"Dropbox_СкачатьФайл": "Dropbox_DownloadFile", +"РаскодироватьСтроку": "DecodeString", +"Новое описание базы": "New database description", +"СоздатьПользователя": "CreateUser", +"Dropbox_ДобавитьТег": "Dropbox_AddTag", +"Наименование товара": "Product name", +"МассивПользователей": "ArrayOfUsers", +"Данные для API v1.1": "Data for API v1.1", +"Удалить комментарий": "Delete comment", +"ОзонДобавлениеКодов": "OzonNewCodes", +"телефон заполнен (Y": "phone field is filled (Y", +"НеобходимыйПараметр": "RequiredParameter", +"АккаунтИАвторизация": "AccountAndAuthorization", +"СоответствиеСвойств": "PropertyMap", +"СоздатьСсылкуТокена": "CreateTokenLink", +"Получить информацию": "Get data", +"Кол-во комментариев": "Comments count", +"НормализоватьОснову": "NormalizeMain", +"Новое имя хранилища": "New storage name", +"идентификатор сайта": "site identifier", +"ПолучитьСвойАккаунт": "GetOwnAccount", +"СтруктураПолучателя": "RecipientStructure", +"ПереданныеПараметры": "PassedParameters", +"ОзонМассивОбновлено": "OzonUpdatedArray", +"Архив : yellow": "Archive : yellow", +"Идентификатор файла": "File identifier", +"ОбработатьВыводJSON": "ProcessJSONOutput", +"Перейдите по ссылке": "Go to the link", +"ПолучитьСписокАкций": "GetPromotionsList", +"ПолучитьСписокЛидов": "GetLeadsList", +"0 Или СтрНайти(Путь": "0 Or StrFind(Path", +"Массив из Структура": "Array of Structure", +"Фото- и видеоуслуги": "Photo and video service", +"Наименование канала": "Channel name", +"УдалитьОбъект (Путь": "DeleteObject (Path", +"Удалить тему форума": "Delete forum thread", +"ПараметрыЗаписиJSON": "JSONWriterSettings", +"Б24_РаботаСЗадачами": "B24_TaskManagment", +"ЗаменитьСпецсимволы": "ReplaceSpecialCharacters", +"Канцелярские товары": "Stationery", +"Создает базу данных": "Creates a database", +"Проверка_ВКСвойство": "Check_VKProp", +"Найти пользователей": "Find users", +"ПолучитьТекущуюДату": "GetCurrentDate", +"ГуглОбновлениеЯчеек": "GoogleCellUpdating", +"Начать учет времени": "Start timekeeping", +"Плановое завершение": "Planned end", +"СоздатьЗаписи (одна": "CreateRecords (one", +"ВажныйДокумент.docx": "ImportantDocument.docx", +"СдэкАПИ_ОбщиеМетоды": "CdekAPI_CommonMethods", +"ПолучитьКомментарий": "GetComment", +"СтруктураЗаголовков": "HeadersStructure", +"Открепить сообщение": "Unpin message", +"СформироватьКоманду": "FormCommand", +"Картинка задачи.jpg": "Topic picture.jpg", +"ИзменитьСделку (хук": "UpdateDeal (wh", +"Создание приложения": "Creating an application", +"ДобавитьКомментарий": "CrateComment", +"ВК_МетодыОбсуждений": "VKAPI_DiscussionMethods", +"ОбновитьЦеныТоваров": "UpdateProductsPrices", +"Проверка_ВКПодборка": "Check_VKCollection", +"ОтключитьЗвукЗадачи": "MuteTask", +"Массив Из Структура": "Array of Structure", +"ПолучитьСписокТегов": "GetTagList", +"СоответствиеОбложки": "CoverMap", +"ПолучитьДанныеФайла": "GetFileData", +"СтрокаПользователей": "MembersQuery", +"Пароль пользователя": "Users password", +"Получить поле (дата": "Get field (date", +"Длительность опроса": "Poll duration", +"ДобавитьВидеоТовара": "AddProductVideo", +"Альбом из автотеста": "AlbumFromAutoTest", +"Закрыть тему форума": "Close forum thread", +"Путь внутри объекта": "Path inside the object", +"ПолучитьЗадачу (хук": "GetTask (wh", +"ПолучитьВнешнийФайл": "GetExternalFile", +"ОзонЗаданиеЗагрузки": "OzonUploadTask", +"ПреобразоватьСтатус": "ConvertStatus", +"Удаляет тему форума": "Deletes a forum thread", +"СоздатьТвитСОпросом": "CreateTweetWithPoll", +"РаботаСТемамиФорума": "ForumTopicManagement", +"Архивировать товары": "Archive products", +"МассивМедиаКартинок": "MediaPictureArray", +"СоответствиеСобытия": "EventMap", +"Массив файлов видео": "Video files array", +"Опубликовать объект": "Publish object", +"Эфимерное сообщение": "Ephemeral message", +"Получает файл по ID": "Gets file by ID", +"Новый текст новости": "New post text", +"ВосстановитьКаталог": "RestoreFolder", +"ПолучитьТокенПоКоду": "GetTokenByCode", +"РаботаСОбсуждениями": "DiscussionManagement", +"БуферДвоичныхДанных": "BinaryDataBuffer", +"Удалить уведомление": "Delete notification", +"Отбор по типу файла": "Filter by file type", +"УчетРабочегоВремени": "Timekeeping", +"Получить статистику": "Get statistics", +"ПолучитьСписокСделок": "GetDealsList", +"УправлениеИНастройки": "ManagementAndSettings", +"ПолучитьНовости (хук": "GetPosts (wh", +"ОткрытьЗакрытьДиалог": "OpenCloseDialog", +"Тестовое сообщение 1": "TestMessage1", +"URL к внешнему файлу": "URL to external file", +"Новый заголовок чата": "New chat title", +"Дополнительный текст": "Additional text", +"УдалитьПодразделение": "DeleteDepartment", +"ID родительской базы": "Parent database ID", +"VK_ЗакрытьОбсуждение": "VK_CloseDiscussion", +"Получить комментарии": "Get comments", +"Проверка_БитриксФайл": "Check_BitrixFile", +"Пустой макет события": "Empty event template", +"ВКИНформацияОТоварах": "VKProductData", +"Данные описание поля": "Field description data", +"ОтправитьМедиагруппу": "SendMediaGroup", +"Создать/Удалить пост": "Create/Delete post", +"ПолучитьБлокКартинки": "GetPictureBlock", +"ТелеграмСозданиеТемы": "TelegramCreateTopic", +"ID копируемого листа": "CopiedSheetID", +"Получить поле (email": "Get field (email", +"ОтправитьГифку (Путь": "SendGif (Path", +"VK_СоздатьОбсуждение": "VK_CreateDiscussion", "СоздатьСоставнойПост": "CreateCompositePost", "ЗавершитьУчетВремени": "StopTimekeeping", "ДропбоксПространство": "DropboxSpace", @@ -3044,7 +2976,6 @@ "ОтправитьМеидагруппу": "SendMediaGroup", "Вайбер_ОтправитьФайл": "Viber_SendFile", "УдалитьСтадиюКанбана": "DeleteKanbanStage", -"Получить поле (email": "Get field (email", "ЗащищенноеСоединение": "SecureConnection", "Структура полей лида": "Structure of lead fields", "идентификатор стадии": "stage identifier", @@ -3053,57 +2984,10 @@ "ЗагрузитьФайлЧастями": "UploadFileInParts", "ДобавитьРодителяБазы": "AddDatabaseParent", "Соответствие свойств": "Properties map", -"ОтправитьГифку (Путь": "SendGif (Path", "ID элемента чеклиста": "Checklist element ID", -"Создать/Удалить пост": "Create/Delete post", -"ПолучитьСписокСделок": "GetDealsList", -"УправлениеИНастройки": "ManagementAndSettings", -"ПолучитьНовости (хук": "GetPosts (wh", -"ОткрытьЗакрытьДиалог": "OpenCloseDialog", -"Тестовое сообщение 1": "TestMessage1", -"URL к внешнему файлу": "URL to external file", -"Новый заголовок чата": "New chat title", -"Дополнительный текст": "Additional text", -"УдалитьПодразделение": "DeleteDepartment", -"ТелеграмСозданиеТемы": "TelegramCreateTopic", -"ID родительской базы": "Parent database ID", -"VK_ЗакрытьОбсуждение": "VK_CloseDiscussion", -"Получить комментарии": "Get comments", -"ID копируемого листа": "CopiedSheetID", -"Проверка_БитриксФайл": "Check_BitrixFile", -"Пустой макет события": "Empty event template", -"ВКИНформацияОТоварах": "VKProductData", -"Данные описание поля": "Field description data", -"ОтправитьМедиагруппу": "SendMediaGroup", -"ПолучитьБлокКартинки": "GetPictureBlock", -"VK_СоздатьОбсуждение": "VK_CreateDiscussion", "идентификатор сделки": "Deal identifier", -"РазмерНесжатыхДанных": "UncompressedDataSize", -"Удалить внешний файл": "Delete external file", -"Dropbox_СкачатьПапку": "Dropbox_DownloadFolder", -"КоличествоПараметров": "NumberOfParameters", -"ПолучитьПолеТелефона": "GetPhoneField", -"ОтправитьВнешнийФайл": "SendExternalFile", -"ОтправитьФайл (канал": "SendFile (channel", -"УстановитьТемуКанала": "SetChannelTopic", -"ЗаголовокАвторизации": "AuthorizationHeader", -"СтруктураОтправителя": "SenderStructure", -"РаботаСУведомлениями": "NotificationsManagment", -"ПолучитьДанныеОСайте": "GetSiteData", -"НормализованныеФайлы": "NormalizedFiles", -"ПодчиненнаяСтруктура": "SubordinateStructure", -"ИзменитьНовость (хук": "UpdatePost (wh", -"СкопироватьФайл (хук": "MakeFileCopy (wh", -"ВернутьДочерниеБлоки": "ReturnChildBlocks", -"СоответствиеВозврата": "ReturnMapping", -"Получить комментарий": "Get comment", -"Хеширование.Добавить": "Hashing.Append", -"Тестовый комментарий": "TestComment", -"Про варианты релизов": "About releases variants", -"Использовать asserts": "Use asserts", "СоответствиеЗначений": "ValueMapping", -"ПереименоватьКаталог": "RenameFolder", -"Удаляет сделку по ID": "Deletes deal by ID", +"Удалить внешний файл": "Delete external file", "ИзменитьКартинкуЧата": "ChangeChatPicture", "API Google Kалендаря": "Google Calendar API", "Идентификатор канала": "Channel ID", @@ -3123,107 +3007,149 @@ "СледующаяВложенность": "NextNesting", "ДобавитьСвойстваБазы": "AddDatabaseProperties", "Список пользователей": "User list", -"Удаляет лист из книги": "Deletes a sheet from the spreadsheet", -"Получить пользователя": "Get user", -"Массив описаний полей": "Array of field descriptions", -"Отправляет файл в чат": "Sends the file to the chat", -"Получить список лидов": "Get leads list", -"РаботаСДискомИФайлами": "StoragesAndFilesManagment", -"ПолучитьТелоКакСтроку": "GetBodyAsString", -"ЗаписатьЗначениеВФайл": "WriteValueToFile", -"УстановитьПравилаЧата": "SetChatRules", -"МассивЛишнихЭлементов": "UncorrectElements", -"РазархивироватьТовары": "UnarchiveProducts", -"двоичные данные файла": "binary data of the file", -"Получить товары по ID": "Get products by ID", -"ПолучитьСтруктуруЧата": "GetChatStructure", -"Получить внешний файл": "Get external file", -"ОтправитьДокумент (ДД": "SendDocument (DD", -"ПолучитьСписокСкладов": "GetWarehousesList", -"ПолучитьПолеСтроковое": "GetStringField", -"ПолучитьСписокКаналов": "GetChannelList", -"ID чата создания темы": "Thread creation chat ID", -"Новый текст сообщения": "New message text", -"ЗагрузитьФотоНаСервер": "UploadPhotoToServer", -"ДобавитьЗаголовокБазы": "AddDatabaseHeader", -"ДобавитьТестовыйНабор": "AddTestSet", -"Изменяет имя каталога": "Change folder name", -"ПолучитьЗначенияЯчеек": "GetCellValues", -"Идентификатор клиента": "Client identifier", -"ПолучитьЧеклистЗадачи": "GetTasksChecklist", -"Написать в обсуждение": "Write in discussion", -"СклеитьДвоичныеДанные": "UniteBinaryData", -"идентификатор статуса": "status identifier", -"Добавить внешний файл": "Add external file", -"ПолучениеДанныхТестов": "TestDataRetrieval", -"ЗагрузитьМедиаЧастями": "UploadMediaInParts", -"Создать/Изменить поле": "Create/Edit field", -"БитриксМассивОбъектов": "BitrixObjectsArray", -"АТУдалениеКомментария": "ATCommentDeleting", -"Переименовать каталог": "Rename folder", -"ID асинхронной работы": "AsynchronousJobID", -"Загрузить файл по URL": "Upload file by URL", -"ПолучитьОбновитьТокен": "GetUpdateToken", -"Дополнительный тест 3": "Additional test 3", -"ИзменитьСтадиюКанбана": "UpdateKanbansStage", -"ПолучитьИсториюКанала": "GetChannelHistory", -"VK_ПолучитьТоварыПоИД": "VK_GetProductsByID", -"Дополнительный тест 2": "Additional test 2", -"Получить таблицы базы": "Get base tables", -"Содержит wifi или gsm": "Contains wifi or gsm", -"Удаляет событие по ID": "Deletes an event by ID", -"ПолучитьИсториюЗадачи": "GetTaskHistory", -"ВК_ОтправитьСообщение": "VKAPI_SendMessage", -"МассивВариантовОпроса": "PollOptionsArray", -"ПолучитьПользователей": "GetUsers", -"СоответствиеКатегорий": "CategoryMap", -"ID целевого сообщения": "Target message ID", -"Орган выдачи паспорта": "Passport issuing authority", -"Google Workspace (ОПИ": "Google Workspace (OpenIntegrations", -"Наименование картинки": "Picture name", -"ПолучитьЗаказПоНомеру": "GetOrderByNumber", -"Заголовок приглашения": "Invitation title", -"ИзменитьЗаголовокЧата": "ChangeChatTitle", -"Обновить цены товаров": "Update products prices", -"ВК_ПолучитьСтатистику": "VKAPI_GetStatistics", -"Дополнительный тест 1": "Additional test 1", -"СоздатьОбновитьТовары": "CreateUpdateProducts", -"ID рекламной кампании": "Advertising campaign ID", -"Использование методов": "Using methods", -"Слак_ПолучитьСписокВФ": "Slack_GetExternalFileList", -"Проверка_БитриксЧисло": "Check_BitrixNumber", -"SKU уцененных товаров": "SKU of discounted products", -"Получить цены товаров": "Get products prices", -"Dropbox_ОбновитьТокен": "Dropbox_UpdateToken", -"Строка,ДвоичныеДанные": "String, BinaryData", -"СоответствиеЗаголовка": "HeaderMapping", -"Твиттер_ОбновитьТокен": "Twitter_UpdateToken", -"УдалитьСвойствоТовара": "DeleteProductProperty", -"ПреобразоватьВложения": "ConvertAttachments", -"Проверка_Соответствие": "Check_Map", -"Получить поле (флажок": "Get field (checkbox", -"В работе : checkbox": "In progress : checkbox", -"ВыполнитьСборкуМусора": "RunGarbageCollection", -"ПолучитьСписокЗаписей": "GetListOfRecords", -"Отключить звук задачи": "Mute task", -"СтруктураНаименования": "NameStructure", -"ИнтерактивныеДействия": "InteractiveActions", -"Проверка_ВКОбсуждение": "Check_VKDiscussion", -"ID Файла для отправки": "File ID to send", -"Dropbox_УдалитьОбъект": "Dropbox_DeleteObject", -"МассивВариантовВыбора": "ChoiceOptionArray", -"Создать копию объекта": "Create object copy", -"ДвоичныеДанные,Строка": "BinaryData,String", -"Добавить видео товара": "Add product video", -"ВременноеСоответствие": "TempMap", -"VK_ПолучитьСтатистику": "VK_GetStatistics", -"УдалитьСообщение (хук": "DeleteMessage (wh", -"Идентификатор объекта": "Object identifier", -"СоздатьТвитВидео (ИВФ": "CreateVideoTweet (TFN", -"ЗаписатьФайлыРелэйтед": "WriteRelatedFiles", +"Удаляет сделку по ID": "Deletes deal by ID", +"РазмерНесжатыхДанных": "UncompressedDataSize", +"ПереименоватьКаталог": "RenameFolder", +"Про варианты релизов": "About releases variants", +"Dropbox_СкачатьПапку": "Dropbox_DownloadFolder", +"КоличествоПараметров": "NumberOfParameters", +"ПолучитьПолеТелефона": "GetPhoneField", +"ОтправитьВнешнийФайл": "SendExternalFile", +"ОтправитьФайл (канал": "SendFile (channel", +"УстановитьТемуКанала": "SetChannelTopic", +"ЗаголовокАвторизации": "AuthorizationHeader", +"СтруктураОтправителя": "SenderStructure", +"РаботаСУведомлениями": "NotificationsManagment", +"ПолучитьДанныеОСайте": "GetSiteData", +"НормализованныеФайлы": "NormalizedFiles", +"ПодчиненнаяСтруктура": "SubordinateStructure", +"ИзменитьНовость (хук": "UpdatePost (wh", +"СкопироватьФайл (хук": "MakeFileCopy (wh", +"ВернутьДочерниеБлоки": "ReturnChildBlocks", +"СоответствиеВозврата": "ReturnMapping", +"Получить комментарий": "Get comment", +"Хеширование.Добавить": "Hashing.Append", +"Тестовый комментарий": "TestComment", +"Использовать asserts": "Use asserts", +"ОтправитьАудио (Путь": "SendAudio (Path", +"УправлениеЗвукомЧата": "ChatNotificationsSwitch", +"Комментарий к заказу": "Order comment", +"СоздатьТекстовыйТвит": "CreateTextTweet", +"Получение информации": "Data retrieval", +"НастройкиИИнформация": "SettingsAndInformation", +"Google Calendar (ОПИ": "Google Calendar (OpenIntegrations", +"Б24_РаботаСНовостями": "B24_PostsManagment", +"Приостановить задачу": "Pause task", +"Проверка_ВКСообщение": "Check_VKMessage", +"Размер).Равно(Истина": "Size).Equal(True", +"Проверка_ТелеграмБан": "Check_TelegramBan", +"СменитьВладельцаЧата": "ChangeChatOwner", +"ЗавершитьЗадачу (хук": "CompleteTask (wh", +"Путь или ID каталога": "Path or ID of the directory", +"СоздатьПодразделение": "CreateDepartment", +"Новый заголовок базы": "New database title", +"Наименование альбома": "Album name", +"ПереносСтрокJSON.Нет": "JSONLineBreak.None", +"ПолучитьСписокФайлов": "GetFilesList", +"Свойства базы данных": "Database properties", +"СформироватьТестыЯкс": "FormYAXTests", +"ДобавитьОписаниеБазы": "AddDatabaseDescription", +"Получить базу данных": "Get database", +"ПолучениеОбщихДанных": "GeneralDataRetrieval", +"СоответствиеВарианта": "OptionMap", +"ОтклонитьЗадачу (хук": "DisapproveTask (wh", +"ВозвращаемоеЗначение": "ReturnValue", +"ВКИнформацияОТоварах": "VKProductData", +"Описание нового поля": "Description of the new field", +"ФИО контактного лица": "Full name of contact person", +"ПолучитьТелоКакПоток": "GetBodyAsStream", +"ВКТ_УправлениеЧатами": "VKT_ChatManagment", +"ПолучитьПодборкиПоИД": "GetSelectionsByID", +"Обновленный файл.jpg": "UpdatedFile.jpg", +"ИзменитьПользователя": "UpdateUser", +"УстановитьРежимТеста": "SetTestMode", +"Скопируйте **Токен**": "Copy the **Token**", +"Проверка_БитриксПоля": "Check_BitrixFields", +"ЗагрузитьБольшойФайл": "UploadLargeFile", +"Общий вес (в граммах": "Total weight (grams", +"СоздатьПапку (корень": "CreateFolder (root", +"ПолучитьИмяФайлаТела": "GetBodyFileName", +"Будущая сделка в RUB": "Future deal in RUB", +"Аудио и видеотехника": "Audio and video", +"ЛокальныеПодкаталоги": "LocalSubfolders", +"Дата выдачи паспорта": "Date of issue of passport", +"Создать/Удалить блок": "Create/Delete block", +"Отложенное сообщение": "Sheduled message", +"Bitrix24_УдалитьФайл": "Bitrix24_DeleteFile", +"Создать пользователя": "Create user", +"предполагаемая сумма": "expected amount", +"Идентификатор товара": "Product identifier", +"Начало синхронизации": "Start synchronization", +"Dropbox_СоздатьПапку": "Dropbox_CreateFolder", +"Делает репост записи": "Reposts the record", +"ВК_ЛайкРепостКоммент": "VKAPI_LikeRepostComment", +"ПолучитьСвязанныеSKU": "GetRelatedSKUs", +"ПолучитьКаталог (хук": "GetFolder (wh", +"ВывестиДопИнформацию": "DisplayAdditionalInformation", +"ПолучитьПользователя": "GetUser", +"ответ сервера Google": "Google server response", +"ID поля для удаления": "Field ID for deletion", +"Важный документ.docx": "Imortant doc.docx", +"Неподдерживаемый тип": "Invalid type", +"Изменить аватар чата": "Change chat picture", +"БезопасноеСоединение": "SafeConnection", +"Удаляет задачу по ID": "Delete task by ID", +"Восстановить каталог": "Restore folder", +"Telegram_СкачатьФайл": "Telegram_DownloadFile", +"ЧатыИЛичныеСообщения": "ChatsAndMessages", +"Изменение публикации": "PublicationChange", +"ПрограммныйИнтерфейс": "Public", +"Тестовое сообщение 2": "TestMessage2", +"СоздатьИсторию (путь": "CreateStory (path", +"ПолучитьПолеВложения": "GetAttachmentField", +"Аннотация к картинке": "Image annotation", +"ПолучитьСписокТестов": "GetTestList", +"color=Зеленый) Метод": "color=Green) Method", +"ЗагрузитьУдалитьФайл": "UploadDeleteFile", +"Б24_РаботаСоСделками": "B24_DealsManagment", +"ПреобразоватьТелефон": "ConvertPhone", +"СоздатьТоварПодборку": "CreateProductSelection", +"МассивДвоичныхДанных": "BinaryDataArray", +"МассивСтруктурКнопок": "ArrayOfButtonStructures", +"Работа с CLI версией": "Working with CLI app", +"СоздатьСтраницуВБазу": "CreatePageInDatabase", +"СоздатьУдалитьЗаписи": "CreateDeleteRecords", +"Проверка_НоушнОбъект": "Check_NotionObject", +"СделатьФайлПубличным": "MakeFilePublic", +"Изменить комментарий": "Modify comment", +"ID страницы родителя": "Parent page ID", +"ДобавитьContentLength": "AddContentLength", +"Получить данные файла": "Get file data", +"СтруктураПользователя": "UserStructure", +"Тестовая таблица (доп": "Test table (new", +"CHAT (по приглашениям": "CHAT (private", +"СоздатьТвитСКартинкой": "CreateTweetWithImage", +"ID поля для изменения": "Field ID for updating", +"ПолучитьСтадииКанбана": "GetKanbanStages", +"УправлениеТемойФорума": "ForumTopicManagement", +"ул. Лермонтова, д. 20": "Lermontov st., b. 20", +"Получить список акций": "Get promotions list", +"Новый текст заголовка": "New title", +"Комментарий к новости": "Comment for post", +"ВыполнитьЗапросСТелом": "ExecuteRequestWithBody", +"СоответствиеАртикулов": "ArticlesMap", +"Ссылка получения кода": "Code retrieval link", +"ВКТ_ОтправкаСообщений": "VKT_MessagesSending", +"Наименование кампании": "Campaign name", +"Идентификатор таблицы": "Table identifier", +"Главное подразделение": "Main department", +"ДобавитьСтадиюКанбана": "AddKanbanStage", +"Заголовок базы данных": "Database title", +"Создает новое событие": "Creates a new event", +"наименование компании": "company name", +"ОтправлятьУведомления": "SendNotifications", "Новое название канала": "New channel name", "Удаляет заказ по UUID": "Deletes order by UUID", -"Создает новое событие": "Creates a new event", "Кнопка для клавиатуры": "Button for keyboard", "Географическая широта": "Geographic latitude", "Новое описание задачи": "New task description", @@ -3242,35 +3168,34 @@ "СуществующийУдаленный": "ExistingRemote", "Новое имя файла 2.jpg": "New file name 2.jpg", "Проверка_БитриксВремя": "Check_BitrixTime", -"наименование компании": "company name", "ОтправитьКартинку (ДД": "SendPicture (DD", -"Заголовок базы данных": "Database title", -"Главное подразделение": "Main department", -"ДобавитьContentLength": "AddContentLength", -"Проверка_ВКОбъявление": "Check_VKAd", -"ID поля для изменения": "Field ID for updating", -"CHAT (по приглашениям": "CHAT (private", -"СоздатьТвитСКартинкой": "CreateTweetWithImage", -"УправлениеТемойФорума": "ForumTopicManagement", -"Тестовая таблица (доп": "Test table (new", -"СтруктураПользователя": "UserStructure", -"Получить данные файла": "Get file data", -"ПолучитьСтадииКанбана": "GetKanbanStages", -"ул. Лермонтова, д. 20": "Lermontov st., b. 20", -"ДобавитьСтадиюКанбана": "AddKanbanStage", -"Новый текст заголовка": "New title", -"Комментарий к новости": "Comment for post", -"ВыполнитьЗапросСТелом": "ExecuteRequestWithBody", -"СоответствиеАртикулов": "ArticlesMap", -"Ссылка получения кода": "Code retrieval link", -"ВКТ_ОтправкаСообщений": "VKT_MessagesSending", -"Получить список акций": "Get promotions list", -"Идентификатор таблицы": "Table identifier", -"Наименование кампании": "Campaign name", -"ОтправлятьУведомления": "SendNotifications", "ИзменитьПараметрыЧата": "UpdateChatParameters", -"ПолучитьОписаниеФайла": "GetFileDescription", +"ЗаполнитьМассивЛистов": "FillSheetArray", "СоздатьТвитГифки (ИВФ": "CreateGifTweet (TFN", +"Сообщение с картинкой": "Message with picture", +"ИзменитьПодразделение": "UpdateDepartment", +"Удалить подразделение": "Delete department", +"ТекстПервогоСообщения": "FirstMessageText", +"Проверка_ЯДискКаталог": "Check_YaDiskFolder", +"Создать/Изменить базу": "Create/Edit database", +"Проверка_ДропБоксФайл": "Check_DropboxFile", +"Признак \"\"Это реклама": "Sign \"\"This is an ad", +"СоздатьУдалитьСобытие": "CreateDeleteEvent", +"ПоместитьФайлВКорзину": "MarkFileAsDeleted", +"Отправить медиагруппу": "Send mediagroup", +"СоздатьТоварыПоOzonID": "CreateProductByOzonID", +"ВК_СоздатьУдалитьПост": "VKAPI_CreateDeletePost", +"ПолучитьПодразделения": "GetDepartments", +"ПолучитьСписокСобытий": "GetEventList", +"Dropbox_ПолучитьТокен": "Dropbox_GetToken", +"НеобходимаяДлина Цикл": "RequiredLength Do", +"Проверка_ДропБоксТеги": "Check_DropboxTags", +"Удаляет файл на Slack": "Deletes a file on Slack", +"ЗаписатьФайлыРелэйтед": "WriteRelatedFiles", +"ПолучитьТаблицуТестов": "GetTestTable", +"Изменить пользователя": "Update user", +"ДобавитьСерверныйТест": "AddServerTest", +"ПолучитьСписокСвойств": "GetPropertyList", "Создать подразделение": "Create department", "Учет рабочего времени": "Timekeeping", "ВосстановитьФайл (хук": "RestoreFile (wh", @@ -3292,55 +3217,200 @@ "Установите приложение": "Install the application", "ЗаписатьПараметрВФайл": "WriteParameterToFile", "Получает задачу по ID": "Get task by ID", -"ПолучитьСписокСвойств": "GetPropertyList", -"ДобавитьСерверныйТест": "AddServerTest", -"Изменить пользователя": "Update user", -"ПоместитьФайлВКорзину": "MarkFileAsDeleted", -"Сообщение с картинкой": "Message with picture", -"ИзменитьПодразделение": "UpdateDepartment", -"Удалить подразделение": "Delete department", -"ТекстПервогоСообщения": "FirstMessageText", -"Проверка_ЯДискКаталог": "Check_YaDiskFolder", -"Создать/Изменить базу": "Create/Edit database", -"Проверка_ДропБоксФайл": "Check_DropboxFile", -"Признак \"\"Это реклама": "Sign \"\"This is an ad", -"СоздатьУдалитьСобытие": "CreateDeleteEvent", -"Отправить медиагруппу": "Send mediagroup", -"ПолучитьТаблицуТестов": "GetTestTable", -"СоздатьТоварыПоOzonID": "CreateProductByOzonID", -"ВК_СоздатьУдалитьПост": "VKAPI_CreateDeletePost", -"ПолучитьПодразделения": "GetDepartments", -"ПолучитьСписокСобытий": "GetEventList", -"Dropbox_ПолучитьТокен": "Dropbox_GetToken", -"НеобходимаяДлина Цикл": "RequiredLength Do", -"ЗаполнитьМассивЛистов": "FillSheetArray", -"Проверка_ДропБоксТеги": "Check_DropboxTags", -"Удаляет файл на Slack": "Deletes a file on Slack", -"Начните диалог с ботом": "Start a dialog with the bot", -"Путь к папке или файлу": "Path to folder or file", -"Получить связанные SKU": "Get related SKUs", -"ДвоичныеДанные, Строка": "BinaryData, String", -"Вернуть дочерние блоки": "Return child blocks", -"Комментарий к упаковке": "Package сommentary", -"Создает твит с опросом": "Creates a tweet with a poll", -"Получить список файлов": "Get list of files", -"Bitrix24_ПринятьЗадачу": "Bitrix24_ApproveTask", -"Создать составной пост": "Create composite post", -"Дневной лимит в рублях": "Daily limit in rubles", -"ПолучитьОписаниеТовара": "GetProductDescription", -"Б24_РаботаСПолямиЗадач": "B24_TasksFieldsManagment", -"ТелеграмУдалениеВебхук": "TelegramWebhookDeletion", -"НачатьУчетВремени (хук": "StartTimekeeping (wh", -"Проверка_ТелеграмГифка": "Check_TelegramGif", -"Адрес грузоотправителя": "Shippers address", -"ID задачи для переноса": "ID of task to move", -"ПроверитьДоступКЗадаче": "CheckTaskAccesses", -"CommonModule.OPI_Тесты": "CommonModule.OPI_Tests", -"дата начала выполнения": "start date", -"ПроверитьЗагрузкуЧасти": "CheckPartUpload", -"Структура полей товара": "Product fields structure", -"Завершает задачу по ID": "Complete task by ID", -"Цены и остатки товаров": "Prices and stocks", +"ПолучитьОписаниеФайла": "GetFileDescription", +"СоздатьТвитВидео (ИВФ": "CreateVideoTweet (TFN", +"Проверка_ВКОбъявление": "Check_VKAd", +"УдалитьСообщение (хук": "DeleteMessage (wh", +"Идентификатор клиента": "Client identifier", +"ПолучитьЧеклистЗадачи": "GetTasksChecklist", +"Написать в обсуждение": "Write in discussion", +"СклеитьДвоичныеДанные": "UniteBinaryData", +"идентификатор статуса": "status identifier", +"Добавить внешний файл": "Add external file", +"ПолучениеДанныхТестов": "TestDataRetrieval", +"ЗагрузитьМедиаЧастями": "UploadMediaInParts", +"Создать/Изменить поле": "Create/Edit field", +"ПолучитьЗначенияЯчеек": "GetCellValues", +"БитриксМассивОбъектов": "BitrixObjectsArray", +"Переименовать каталог": "Rename folder", +"ID асинхронной работы": "AsynchronousJobID", +"Загрузить файл по URL": "Upload file by URL", +"ПолучитьОбновитьТокен": "GetUpdateToken", +"Дополнительный тест 3": "Additional test 3", +"ИзменитьСтадиюКанбана": "UpdateKanbansStage", +"ПолучитьИсториюКанала": "GetChannelHistory", +"VK_ПолучитьТоварыПоИД": "VK_GetProductsByID", +"Дополнительный тест 2": "Additional test 2", +"АТУдалениеКомментария": "ATCommentDeleting", +"Изменяет имя каталога": "Change folder name", +"ДобавитьТестовыйНабор": "AddTestSet", +"ДобавитьЗаголовокБазы": "AddDatabaseHeader", +"Удаляет лист из книги": "Deletes a sheet from the spreadsheet", +"Массив описаний полей": "Array of field descriptions", +"Отправляет файл в чат": "Sends the file to the chat", +"Получить список лидов": "Get leads list", +"РаботаСДискомИФайлами": "StoragesAndFilesManagment", +"ПолучитьТелоКакСтроку": "GetBodyAsString", +"ЗаписатьЗначениеВФайл": "WriteValueToFile", +"УстановитьПравилаЧата": "SetChatRules", +"МассивЛишнихЭлементов": "UncorrectElements", +"РазархивироватьТовары": "UnarchiveProducts", +"двоичные данные файла": "binary data of the file", +"Получить товары по ID": "Get products by ID", +"ПолучитьСтруктуруЧата": "GetChatStructure", +"Получить внешний файл": "Get external file", +"ОтправитьДокумент (ДД": "SendDocument (DD", +"ПолучитьСписокСкладов": "GetWarehousesList", +"ПолучитьПолеСтроковое": "GetStringField", +"ПолучитьСписокКаналов": "GetChannelList", +"ID чата создания темы": "Thread creation chat ID", +"Новый текст сообщения": "New message text", +"ЗагрузитьФотоНаСервер": "UploadPhotoToServer", +"Получить таблицы базы": "Get base tables", +"Содержит wifi или gsm": "Contains wifi or gsm", +"Получить пользователя": "Get user", +"ПолучитьИсториюЗадачи": "GetTaskHistory", +"Твиттер_ОбновитьТокен": "Twitter_UpdateToken", +"УдалитьСвойствоТовара": "DeleteProductProperty", +"ПреобразоватьВложения": "ConvertAttachments", +"Проверка_Соответствие": "Check_Map", +"Получить поле (флажок": "Get field (checkbox", +"В работе : checkbox": "In progress : checkbox", +"ВыполнитьСборкуМусора": "RunGarbageCollection", +"Удаляет событие по ID": "Deletes an event by ID", +"Отключить звук задачи": "Mute task", +"СоответствиеЗаголовка": "HeaderMapping", +"СтруктураНаименования": "NameStructure", +"Проверка_ВКОбсуждение": "Check_VKDiscussion", +"ID Файла для отправки": "File ID to send", +"Dropbox_УдалитьОбъект": "Dropbox_DeleteObject", +"МассивВариантовВыбора": "ChoiceOptionArray", +"Создать копию объекта": "Create object copy", +"ДвоичныеДанные,Строка": "BinaryData,String", +"Добавить видео товара": "Add product video", +"ВременноеСоответствие": "TempMap", +"VK_ПолучитьСтатистику": "VK_GetStatistics", +"ИнтерактивныеДействия": "InteractiveActions", +"Строка,ДвоичныеДанные": "String, BinaryData", +"ПолучитьСписокЗаписей": "GetListOfRecords", +"Получить цены товаров": "Get products prices", +"ВК_ОтправитьСообщение": "VKAPI_SendMessage", +"Dropbox_ОбновитьТокен": "Dropbox_UpdateToken", +"МассивВариантовОпроса": "PollOptionsArray", +"ПолучитьПользователей": "GetUsers", +"СоответствиеКатегорий": "CategoryMap", +"ID целевого сообщения": "Target message ID", +"Орган выдачи паспорта": "Passport issuing authority", +"Наименование картинки": "Picture name", +"ПолучитьЗаказПоНомеру": "GetOrderByNumber", +"Заголовок приглашения": "Invitation title", +"Google Workspace (ОПИ": "Google Workspace (OpenIntegrations", +"Обновить цены товаров": "Update products prices", +"SKU уцененных товаров": "SKU of discounted products", +"ИзменитьЗаголовокЧата": "ChangeChatTitle", +"Идентификатор объекта": "Object identifier", +"Слак_ПолучитьСписокВФ": "Slack_GetExternalFileList", +"Использование методов": "Using methods", +"Проверка_БитриксЧисло": "Check_BitrixNumber", +"СоздатьОбновитьТовары": "CreateUpdateProducts", +"Дополнительный тест 1": "Additional test 1", +"ВК_ПолучитьСтатистику": "VKAPI_GetStatistics", +"ID рекламной кампании": "Advertising campaign ID", +"Возвращаемое значение:": "Returns:", +"Получить блок картинки": "Get picture block", +"Массив файлов картинок": "Image files array", +"Тесты для YaxUnit (ОПИ": "Tests for YaxUnit (OPI", +"ПолучитьСписокОбластей": "GetRegionList", +"Создайте бота Telegram": "Create a Telegram bot", +"Проверка_БитриксСписок": "Check_BitrixList", +"ДропБокс_ЗагрузитьФайл": "DropboxAPI_UploadFile", +"Географическая долгота": "Geographic longitude", +"Проверка_БитриксЗадача": "Check_BitrixTask", +"Соответствие Из Строка": "Map Of String", +"Принимает задачу по ID": "Approve task by ID", +"Открыть/Закрыть диалог": "Open/Close dialog", +"Проверка_БитриксМассив": "Check_BitrixArray", +"УстановитьИмяФайлаТела": "SetBodyFileName", +"ПолучитьЗначениеДляCLI": "GetCLIFormedValue", +"НачатьВыполнениеЗадачи": "StartTask", +"Сменить владельца чата": "Change chat owner", +"Массив URL изображений": "Array of images URLs", +"Другое описание задачи": "Another task description", +"ТелеграмИнформацияБота": "TelegramBotInformation", +"Новое описание события": "New event description", +"Изменить свойства базы": "Edit database properties", +"Проверка_ВККомментарий": "Check_VKComment", +"ДобавитьТоварВПодборку": "AddProductToCollection", +"ОтправитьДокумент (Имя": "SendDocument (name", +"ЗаписатьДвоичныеДанные": "WriteBinaryData", +"УдалитьТоварИзПодборки": "RemoveProductFromSelection", +"Число, Массив Из Число": "Number, Array Of Number", +"Получает событие по ID": "Gets an event by ID", +"ЗаписатьJSONМультипарт": "WriteJSONMultipart", +"ПолучитьХранилище (хук": "GetStorage (wh", +"Отклоняет задачу по ID": "Disapprove task by ID", +"VK_НаписатьВОбсуждение": "VK_PostToDiscussion", +"СтруктураХаракетристик": "AttributesStructure", +"Добавить файл в задачу": "Attach file to the topic", +"Массив из Строка,Число": "Array of String,Number", +"ID изменяемой страницы": "ID of the page being modified", +"ID стадии для удаления": "ID of stage to dele", +"название подразделения": "department name", +"Строка, ДвоичныеДанные": "String, BinaryData", +"ПереименоватьХранилище": "RenameStorage", +"СформироватьКлавиатуру": "FormKeyboard", +"VK_СгруппироватьТовары": "VK_GroupProducts", +"ПолучитьСписокХранилищ": "GetStoragesList", +"СоответствиеШтрихкодов": "BarcodesMap", +"ЗагрузитьВидеоНаСервер": "UploadVideoToServer", +"сообщением в этом чате": "of mesage in this chat", +"Новое имя главной темы": "New main thread name", +"Массив изображений 360": "Array of 360 images", +"ПолучитьИнформациюБота": "GetBotInformation", +"КопироватьКаталог (хук": "CopyFolder (wh", +"Получить подразделения": "Get departments", +"VK_НаписатьКомментарий": "VK_WriteComment", +"ВыполнитьЗапросБезТела": "ExecuteRequestWithoutBody", +"Работа с комментариями": "Comments managment", +"СлакПользователиКанала": "SlackChannelUsers", +"Структура полей сделки": "Deal fields structure", +"Получает заказ по UUID": "Gets the order by UUID", +"Dropbox_ПолучитьПревью": "Dropbox_GetPreview", +"ID рекламного кабинета": "Advertising account ID", +"СоответствиеПараметров": "ParameterMap", +"СтандартныеЗависимости": "StandardDependencies", +"Структура полей фильра": "Filter fields structure", +"Изменить картинку чата": "Change chat picture", +"Массив из Произвольный": "Array of Arbitrary", +"ПреобразоватьКодВТокен": "ConvertCodeToToken", +"ОтправитьСсылку (канал": "SendLink (channel", +"Bitrix24_ПолучитьТокен": "Bitrix24_GetToken", +"СоздатьПодборкуТоваров": "CreateProductCollection", +"Создать текстовый твит": "Create text tweet", +"ПолучитьОписаниеЗаказа": "GetOrderDescription", +"ОзонАПИ_РаботаСАкциями": "OzonAPI_PromotionsManagment", +"Изменить подразделение": "Update department", +"идентификатор контакта": "contact identifier", +"Установить цель канала": "Set channel purpose", +"ИзменитьСообщение (хук": "EditMessage (wh", +"Проверка_ТелеграмАудио": "Check_TelegramAudio", +"Структура полей задачи": "Task fields structure", +"УстановитьТелоИзСтроки": "SetBodyFromString", +"Сделать файл публичным": "Make file public", +"Создать/Удалить записи": "Create/Delete records", +"Отображаемое имя файла": "Displayed file name", +"Удаляет подборку по ID": "Deletes the selection by ID", +"ИзменитьТекстСообщения": "EditMessageText", +"ПолучитьДвоичныеДанные": "GetBinaryData", +"ИНН истинного продавца": "TIN of the true seller", +"Удалить стадию канбана": "ID of the stage to be deleted", +"УстановитьОписаниеЧата": "SetChatDescription", +"Работа с уведомлениями": "Notifications managment", +"Дата окончания периода": "End date of the period", +"ДропБоксПубличнаяПапка": "DropboxPublicFolder", +"ID календаря приемника": "ID of the target calendar", +"ID каталога назначения": "ID of target folder", +"ДобавитьОписаниеДанных": "AddDataDescription", "УдалитьЛишниеПоляБлока": "RemoveExtraBlockFields", "ID календаря источника": "ID of the source calendar", "Проверка_ТелеграмВидео": "Check_TelegramVideo", @@ -3360,34 +3430,34 @@ "Разархивировать товары": "Unarchive products", "Твиттер_ДанныеАккаунта": "TwitterAPI_AccountData", "Массив блоков вложений": "Array of attachments", +"Цены и остатки товаров": "Prices and stocks", +"Структура полей товара": "Product fields structure", +"ПроверитьЗагрузкуЧасти": "CheckPartUpload", +"дата начала выполнения": "start date", +"Начните диалог с ботом": "Start a dialog with the bot", +"Путь к папке или файлу": "Path to folder or file", +"Получить связанные SKU": "Get related SKUs", +"ДвоичныеДанные, Строка": "BinaryData, String", +"Вернуть дочерние блоки": "Return child blocks", +"Комментарий к упаковке": "Package сommentary", +"Создает твит с опросом": "Creates a tweet with a poll", +"Получить список файлов": "Get list of files", +"Bitrix24_ПринятьЗадачу": "Bitrix24_ApproveTask", "Загружает файл на диск": "Uploads a file to the drive", +"Создать составной пост": "Create composite post", +"ПолучитьОписаниеТовара": "GetProductDescription", +"Б24_РаботаСПолямиЗадач": "B24_TasksFieldsManagment", +"ТелеграмУдалениеВебхук": "TelegramWebhookDeletion", +"НачатьУчетВремени (хук": "StartTimekeeping (wh", +"Проверка_ТелеграмГифка": "Check_TelegramGif", +"Адрес грузоотправителя": "Shippers address", +"ID задачи для переноса": "ID of task to move", +"ПроверитьДоступКЗадаче": "CheckTaskAccesses", +"CommonModule.OPI_Тесты": "CommonModule.OPI_Tests", +"Дневной лимит в рублях": "Daily limit in rubles", "ПереименоватьФайл (хук": "RenameFile (wh", -"Проверка_БитриксИстина": "Check_BitrixTrue", +"Завершает задачу по ID": "Complete task by ID", "URL файла для отправки": "File URL", -"Проверка_БитриксСтрока": "Check_BitrixString", -"Получить список сделок": "Get deals list", -"ИзменитьИмяГлавнойТемы": "ChangeMainTopicName", -"СоздатьПост (один путь": "CreatePost (one path", -"Ремонт и строительство": "Repair and building", -"ЗагрузитьФайл (в канал": "UploadFile (to channel", -"УстановитьРежимОтладки": "SetDebugMode", -"Отправить внешний файл": "Send external file", -"Bitrix24_ОбновитьТокен": "Bitrix24_RefreshToken", -"РаботаСЧеклистамиЗадач": "TasksChecklistsManagment", -"Вайбер_ОтправитьСсылку": "Viber_SendLink", -"Получить токен по коду": "Get token by code", -"Установить тему канала": "Set channel topic", -"Загрузить/Удалить файл": "Upload/Delete file", -"Загрузить/Удалить Файл": "Upload/Delete file", -"Сообщение из автотеста": "Message from autotest", -"ВыполнитьСинхронизацию": "MakeSynchronization", -"КаталогЛоговБиблиотеки": "LibraryLogCatalog", -"HEX цвета новой стадии": "HEX of new stage color", -"ПреобразоватьЗаголовок": "ConvertHeader", -"ВК_СоздатьСсылкуТокена": "VKAPI_CreateTokenLink", -"Идентификаторы товаров": "Products identifier", -"Массив описаний блоков": "Array of block descriptions", -"Соответствие из Строка": "Map of String", "Bitrix24_УдалитьЗадачу": "Bitrix24_DeleteTask", "СоздатьПодкаталог (хук": "CreateSubfolder (wh", "Тестовый товар (другой": "Test product (another", @@ -3395,11 +3465,10 @@ "Идентификатор каталога": "Folder identifier", "Получить пользователей": "Get users", "Описание : rich_text": "Description : rich_text", -"Получает список файлов": "Gets the list of files", "ПолучитьСписокПодборок": "GetSelectionList", "РаботаСФайламиИПапками": "FileAndFolderManagement", +"Соответствие из Строка": "Map of String", "Подробная документация": "Detailed documentation", -"Массив участников чата": "Chat members array", "ДропбоксПубличнаяПапка": "DropboxPublicFolder", "ЗаполнитьДанныеПоСхеме": "FillDataBySchema", "и почитать комментарии": "and read comments", @@ -3408,202 +3477,57 @@ "Получить поле (телефон": "Get field (phone", "ПолучитьМассивПодборок": "GetSelectionArray", "пр. Ленинградский, д.4": "Ave. Leningradsky, 4", -"ДобавитьОписаниеДанных": "AddDataDescription", -"ID каталога назначения": "ID of target folder", -"ID календаря приемника": "ID of the target calendar", -"ПреобразоватьКодВТокен": "ConvertCodeToToken", -"Новое описание события": "New event description", -"ДобавитьТоварВПодборку": "AddProductToCollection", -"ОтправитьДокумент (Имя": "SendDocument (name", -"ЗаписатьДвоичныеДанные": "WriteBinaryData", -"УдалитьТоварИзПодборки": "RemoveProductFromSelection", -"Число, Массив Из Число": "Number, Array Of Number", -"Получает событие по ID": "Gets an event by ID", -"ЗаписатьJSONМультипарт": "WriteJSONMultipart", -"ПолучитьХранилище (хук": "GetStorage (wh", -"VK_НаписатьВОбсуждение": "VK_PostToDiscussion", -"VK_СгруппироватьТовары": "VK_GroupProducts", -"СтруктураХаракетристик": "AttributesStructure", -"Добавить файл в задачу": "Attach file to the topic", -"Массив из Строка,Число": "Array of String,Number", -"ID изменяемой страницы": "ID of the page being modified", -"ID стадии для удаления": "ID of stage to dele", -"название подразделения": "department name", -"Строка, ДвоичныеДанные": "String, BinaryData", -"ПереименоватьХранилище": "RenameStorage", -"СформироватьКлавиатуру": "FormKeyboard", -"Изменить свойства базы": "Edit database properties", -"Отклоняет задачу по ID": "Disapprove task by ID", -"ТелеграмИнформацияБота": "TelegramBotInformation", -"Получить блок картинки": "Get picture block", -"Массив файлов картинок": "Image files array", -"Тесты для YaxUnit (ОПИ": "Tests for YaxUnit (OPI", -"ПолучитьСписокОбластей": "GetRegionList", -"Создайте бота Telegram": "Create a Telegram bot", -"Проверка_БитриксСписок": "Check_BitrixList", -"ДропБокс_ЗагрузитьФайл": "DropboxAPI_UploadFile", -"Возвращаемое значение:": "Returns:", -"Географическая долгота": "Geographic longitude", -"Другое описание задачи": "Another task description", -"Соответствие Из Строка": "Map Of String", -"Принимает задачу по ID": "Approve task by ID", -"Открыть/Закрыть диалог": "Open/Close dialog", -"Проверка_БитриксМассив": "Check_BitrixArray", -"УстановитьИмяФайлаТела": "SetBodyFileName", -"ПолучитьЗначениеДляCLI": "GetCLIFormedValue", -"НачатьВыполнениеЗадачи": "StartTask", -"Сменить владельца чата": "Change chat owner", -"Массив URL изображений": "Array of images URLs", -"Проверка_БитриксЗадача": "Check_BitrixTask", -"Проверка_ВККомментарий": "Check_VKComment", -"ПолучитьСписокХранилищ": "GetStoragesList", -"Bitrix24_ПолучитьТокен": "Bitrix24_GetToken", -"ЗагрузитьВидеоНаСервер": "UploadVideoToServer", -"ПолучитьОписаниеЗаказа": "GetOrderDescription", -"ОзонАПИ_РаботаСАкциями": "OzonAPI_PromotionsManagment", -"Изменить подразделение": "Update department", -"идентификатор контакта": "contact identifier", -"Установить цель канала": "Set channel purpose", -"ИзменитьСообщение (хук": "EditMessage (wh", -"Проверка_ТелеграмАудио": "Check_TelegramAudio", -"Структура полей задачи": "Task fields structure", -"УстановитьТелоИзСтроки": "SetBodyFromString", -"Создать/Удалить записи": "Create/Delete records", -"ДропБоксПубличнаяПапка": "DropboxPublicFolder", -"Отображаемое имя файла": "Displayed file name", -"Удаляет подборку по ID": "Deletes the selection by ID", -"ИзменитьТекстСообщения": "EditMessageText", -"ПолучитьДвоичныеДанные": "GetBinaryData", -"ИНН истинного продавца": "TIN of the true seller", -"Удалить стадию канбана": "ID of the stage to be deleted", -"УстановитьОписаниеЧата": "SetChatDescription", -"Работа с уведомлениями": "Notifications managment", -"Дата окончания периода": "End date of the period", -"Создать текстовый твит": "Create text tweet", -"СоответствиеШтрихкодов": "BarcodesMap", -"Сделать файл публичным": "Make file public", -"СоздатьПодборкуТоваров": "CreateProductCollection", -"СлакПользователиКанала": "SlackChannelUsers", -"сообщением в этом чате": "of mesage in this chat", -"Новое имя главной темы": "New main thread name", -"Массив изображений 360": "Array of 360 images", -"ПолучитьИнформациюБота": "GetBotInformation", -"КопироватьКаталог (хук": "CopyFolder (wh", -"Получить подразделения": "Get departments", -"VK_НаписатьКомментарий": "VK_WriteComment", -"ВыполнитьЗапросБезТела": "ExecuteRequestWithoutBody", -"Работа с комментариями": "Comments managment", -"Структура полей сделки": "Deal fields structure", -"ОтправитьСсылку (канал": "SendLink (channel", -"Получает заказ по UUID": "Gets the order by UUID", -"Dropbox_ПолучитьПревью": "Dropbox_GetPreview", -"ID рекламного кабинета": "Advertising account ID", -"СоответствиеПараметров": "ParameterMap", -"СтандартныеЗависимости": "StandardDependencies", -"Структура полей фильра": "Filter fields structure", -"Изменить картинку чата": "Change chat picture", -"Массив из Произвольный": "Array of Arbitrary", -"Флаг анонимности опроса": "Survey anonymity flag", -"СоединитьДвоичныеДанные": "ConcatBinaryData", -"Bitrix24_ОтложитьЗадачу": "Bitrix24_DeferTask", -"Получить список заказов": "Get order list", -"Получить данные о сайте": "Get site data", -"и перейдите в настройки": "and go to the settings", -"ПереместитьФайлВКаталог": "MoveFileToFolder", -"ЗагрузитьФайлВХранилище": "UploadFileToStorage", -"Телеграм_ОтправитьГифку": "TelegramAPI_SendGIF", -"ВключитьУведомленияЧата": "EnableChatNotifications", -"СдэкАПИ_РаботаСЗаказами": "CDEKAPI_OrdersManagment", -"адрес электронной почты": "email address", -"Bitrix24_СерверноеВремя": "Bitrix24_ServerTime", -"Новая картинка подборки": "New selection image", -"МаксимальнаяВложенность": "MaximumNesting", -"ОтменитьПубликациюФайла": "CancelFilePublication", -"Получить структуру лида": "Get lead structure", -"ОтменитьПубликациюПапки": "CancelFolderPublication", -"УправлениеВнешнимФайлом": "ExternalFileManagement", -"ПолучитьПубличныйОбъект": "GetPublicObject", -"Установить правила чата": "Set chat rules", -"ПолучитьСтатусОбработки": "GetProcessingStatus", -"ЗагрузитьМассивВложений": "UploadAttachmentsArray", -"Слак_ПолучитьИнформацию": "SlackGetData", -"ОпределитьМетодОтправки": "DetermineSendMethod", -"Создать свойство товара": "Create product property", -"Создать обновить товары": "Create update product", -"ОтправитьСообщение (хук": "SendMessage", -"РазделитьДвоичныеДанные": "SplitBinaryData", -"ПолучитьИнформациюОБазе": "GetDatabaseInfo", -"ПолучитьИнформациюОБоте": "GetBotInformation", -"ГенераторОтчетаПокрытия": "CoverageReportGenerator", -"ЗаписатьФайлыМультипарт": "WriteMultipartFiles", -"Получить список записей": "Get list of records", -"Telegram_ОтправитьАудио": "Telegram_SendAudio", -"Bitrix24_СоздатьНовость": "Bitrix24_CreatePost", -"Идентификатор базы База": "Base identifier Base", -"Имя файла с расширением": "File name with extension", -"ПолучитьСтруктуруЗадачи": "GetTaskFieldsStructure", -"HEX нового цвета стадии": "HEX of new stage color", -"Новое название подборки": "New selection name", -"АтрибутыИХарактеристики": "AttributesAndFeatures", -"Bitrix24_УдалитьНовость": "Bitrix24_DeletePost", -"ID файла для скачивания": "File ID for downloading", -"Получить значения ячеек": "Get cell values", -"ДФ=yyyy-MM-ddTHH:mm:ssZ": "DF=yyyy-MM-ddTHH:mm:ssZ", -"ОтправитьЛокацию (канал": "SendLocation (channel", -"ПолучитьИнформациюОЧате": "GetChatInfo", -"Телеграм_ОтправитьВидео": "TelegramAPI_SendVideo", -"ПолучитьКалендарьСписка": "GetListCalendar", -"Получить поле (числовое": "Get field (numeric", -"ВключитьЗвукЗадачи (хук": "UnmuteTask (wh", -"ИсключатьАрхивированные": "ExcludeArchived", -"массив URL картинок 360": "array of 360 images URLs", -"ОзонСписокХарактеристик": "OzonAttributesList", -"ЯДиск_ПереместитьОбъект": "YDisk_MoveObject", -"ПолучитьЗначениеИзФайла": "GetValueFromFile", -"идентификатор реквизита": "prop identifier", -"Получить историю канала": "Get channel history", -"Переименовать хранилище": "Rename storage", -"Проверка_ТелеграмМассив": "Check_TelegramArray", -"ОтправитьКонтакт (канал": "SendContact (channel", -"ВывестиСправкуПоМетодам": "DisplayMethodHelp", -"Скопированный файл.jpeg": "CopiedFile.jpeg", -"ID удаляемого сообщения": "ID of message to delete", -"Проверка_ТелеграмИстина": "Check_TelegramTrue", -"СлакОтложенноеСообщение": "SlackSheduledMessage", -"ВК_СоздатьСоставнойПост": "VKAPI_CreateCompositePost", -"СформироватьМассивМедиа": "FormMediaArray", -"Проверка_ДропБоксСтатус": "Check_DropboxStatus", -"Выберите пункт External": "Choose External", -"Новое имя стадии стадии": "New stage name", -"ЗаполнитьОчиститьЯчейки": "FillClearCells", -"Непредвиденная ошибка!:": "Unexpected Error!", -"Получить структуру чата": "Get chats structure", -"УникальныйИдентификатор": "UUID", -"Добавить стадию канбана": "Add kanban stage", -"Телеграм_ОтправитьОпрос": "TelegramAPI_SendPoll", -"Лайк/Репост/Комментарий": "Like/Repost/Comment", -"Не найден входной файл!": "Input File Not Found!", -"Код формы собственности": "Form of ownership code", -"Массив Из Строка, Число": "Array of String, Number", -"Удалить выбранные файлы": "Delete selected files", -"СоздатьКомментарий (хук": "CreateComment (wh", -"УстановитьЗначенияЯчеек": "SetCellValues", -"Массив из Строка, Число": "Array of string, number", -"Наименование новой базы": "New base name", -"ГД_ЗагрузитьУдалитьФайл": "GD_UploadDeleteFile", -"Другой заголовок задачи": "Another task title", -"Получить список складов": "Get warehouses list", -"Telegram_ОтправитьВидео": "Telegram_SendVideo", -"Вайбер_ОтправитьКонтакт": "Viber_SendContact", -"Произвольный, HTTPОтвет": "Arbitrary, HTTPResponse", -"Массив вариантов опроса": "Poll options array", -"СформироватьТестыЯксCLI": "FormYAXTestsCLI", -"Создать страницу в базу": "Create page in database", -"Слак_ЗагрузитьУдалитьВФ": "Slack_UploadDeleteExternalFile", -"Bitrix24_УдалитьКаталог": "Bitrix24_DeleteFolder", -"Идентификатор категории": "Category identifier", -"признак повторного лида": "repeat lead", +"Проверка_БитриксИстина": "Check_BitrixTrue", +"Массив участников чата": "Chat members array", +"Массив описаний блоков": "Array of block descriptions", +"Получает список файлов": "Gets the list of files", +"Получить список сделок": "Get deals list", +"Проверка_БитриксСтрока": "Check_BitrixString", +"Идентификаторы товаров": "Products identifier", +"ИзменитьИмяГлавнойТемы": "ChangeMainTopicName", +"СоздатьПост (один путь": "CreatePost (one path", +"Ремонт и строительство": "Repair and building", +"ЗагрузитьФайл (в канал": "UploadFile (to channel", +"УстановитьРежимОтладки": "SetDebugMode", +"Bitrix24_ОбновитьТокен": "Bitrix24_RefreshToken", +"РаботаСЧеклистамиЗадач": "TasksChecklistsManagment", +"Вайбер_ОтправитьСсылку": "Viber_SendLink", +"Отправить внешний файл": "Send external file", +"Установить тему канала": "Set channel topic", +"ВК_СоздатьСсылкуТокена": "VKAPI_CreateTokenLink", +"Получить токен по коду": "Get token by code", +"HEX цвета новой стадии": "HEX of new stage color", +"КаталогЛоговБиблиотеки": "LibraryLogCatalog", +"ВыполнитьСинхронизацию": "MakeSynchronization", +"ПреобразоватьЗаголовок": "ConvertHeader", +"Загрузить/Удалить Файл": "Upload/Delete file", +"Загрузить/Удалить файл": "Upload/Delete file", +"Сообщение из автотеста": "Message from autotest", +"Новое значение свойства": "New property value", +"Вайбер_ОтправитьЛокацию": "Viber_SendLocation", +"Изменить заголовок чата": "Change chat title", +"НайтиПользователей (хук": "FindUsers (wh", +"Путь к объекту удаления": "Path to the object to delete", +"Б24_УчетРабочегоВремени": "B24_Timekeeping", +"ОтправитьМестоположение": "SendLocation", +"Сформировать клавиатуру": "Create keyboard", +"Новый заголовок новости": "New post title", +"ПолучитьРазделительПути": "GetPathSeparator", +"Telegram_ОтправитьОпрос": "Telegram_SendPoll", +"ПолучитьЧислоУчастников": "GetParticipantCount", +"Получить подборки по ID": "Get selections by ID", +"Путь к созаваемой папке": "Path to the created folder", +"Проверка_БитриксНовость": "Check_BitrixPost", +"ДФ=yyyy-MM-ddThh:mm:ssZ": "DF=yyyy-MM-ddThh:mm:ssZ", +"Текст первого сообщения": "Text of the first message", +"СоздатьПроизвольныйТвит": "CreateCustomTweet", +"ПолучитьСписокКаталогов": "GetDirectoriesList", +"СоздатьТоварСоСвойством": "CreateProductWithProp", +"ПолучитьПланЗадачНаДень": "GetDailyPlan", +"Телеграм_ОтправитьАудио": "TelegramAPI_SendAudio", "АТ_СоздатьУдалитьЗаписи": "AT_CreateDeleteRecords", +"Telegram_ОтправитьГифку": "Telegram_SendGif", +"VK_СоздатьСоставнойПост": "VK_CreateCompositePost", "Удаляет сообщение по ID": "Deletes a message by ID", "ПереместитьКаталог (хук": "MoveFolder (wh", "ТелеграмУстановкаВебхук": "TelegramWebhookSetup", @@ -3624,34 +3548,35 @@ "Какой ваш любимый цвет?": "What's your favorite color?", "СоздатьЗависимостьЗадач": "CreateTasksDependencies", "Получить список каналов": "Get channel list", -"Telegram_ОтправитьГифку": "Telegram_SendGif", "Bitrix24_ПолучитьЗадачу": "Bitrix24_GetTask", -"Телеграм_ОтправитьАудио": "TelegramAPI_SendAudio", -"СоздатьТоварСоСвойством": "CreateProductWithProp", -"Вайбер_ОтправитьЛокацию": "Viber_SendLocation", -"Изменить заголовок чата": "Change chat title", -"НайтиПользователей (хук": "FindUsers (wh", -"Путь к объекту удаления": "Path to the object to delete", -"Б24_УчетРабочегоВремени": "B24_Timekeeping", -"ОтправитьМестоположение": "SendLocation", -"Сформировать клавиатуру": "Create keyboard", -"Новый заголовок новости": "New post title", -"Новое значение свойства": "New property value", -"ПолучитьРазделительПути": "GetPathSeparator", -"ПолучитьПланЗадачНаДень": "GetDailyPlan", -"ПолучитьЧислоУчастников": "GetParticipantCount", -"Получить подборки по ID": "Get selections by ID", -"Путь к созаваемой папке": "Path to the created folder", -"Проверка_БитриксНовость": "Check_BitrixPost", -"ДФ=yyyy-MM-ddThh:mm:ssZ": "DF=yyyy-MM-ddThh:mm:ssZ", -"Текст первого сообщения": "Text of the first message", -"СоздатьПроизвольныйТвит": "CreateCustomTweet", -"ПолучитьСписокКаталогов": "GetDirectoriesList", -"Telegram_ОтправитьОпрос": "Telegram_SendPoll", -"VK_СоздатьСоставнойПост": "VK_CreateCompositePost", "для дальнейших действий": "for further actions", -"УдалитьКомментарий (хук": "DeleteComment (wh", +"Удалить свойство товара": "Delete product property", "Действия с обсуждениями": "Actions with discussions", +"Проверка_ДвоичныеДанные": "Check_BinaryData", +"ПолучитьСтруктуруТовара": "GetProductStructure", +"ДелегироватьЗадачу (хук": "DelegateTask (wh", +"Получить/Обновить токен": "Get/Update token", +"ОтправитьКартинку (Путь": "SendPicture (Path", +"Проверка_ДропБоксМассив": "Check_DropboxArray", +"Б24_РаботаСППолямиЗадач": "B24_TaskFieldsManagment", +"Получить чеклист задачи": "Get tasks checklist", +"Изменить стадию канбана": "Change kanban stage", +"Идентификатор хранилища": "Storage ID", +"ПараметрыЗапросаВСтроку": "RequestParametersToString", +"РаботаСЧатамиИДиалогами": "ChatsAndDialogsManagment", +"YandexDisk_СоздатьПапку": "YandexDisk_CreateFolder", +"ИзменитьАртикулыТоваров": "UpdateProductsArticles", +"ВК_СоздатьТоварПодборку": "VKAPI_CreateProductSelection", +"Пустое описание товара:": "Empty product description:", +"СпособКодированияСтроки": "StringEncodingMethod", +"признак новой сделки (Y": "new deal flag (Y", +"ИзменитьАватарЧата (URL": "ChangeChatPicture (URL", +"признак повторного лида": "repeat lead", +"ОбеспечитьПустойКаталог": "EnsureEmptyDirectory", +"Проверка_ДропБоксРабота": "Check_DropboxWork", +"УдалитьКомментарий (хук": "DeleteComment (wh", +"ТаблицаДляИспользования": "TableForUse", +"УдалитьЗависимостьЗадач": "DeleteTasksDependencies", "СоздатьЗаголовкиЗапроса": "CreateRequestHeaders", "OPI_ПреобразованиеТипов": "OPI_TypeConversion", "ИзменитьПодборкуТоваров": "EditProductCollection", @@ -3673,121 +3598,134 @@ "Массив вариантов ответа": "Array of answer options", "Наименование обсуждения": "Discussion name", "Получить список свойств": "Get property list", -"УдалитьЗависимостьЗадач": "DeleteTasksDependencies", "ID новости для удаления": "Id of post to remove", -"ТаблицаДляИспользования": "TableForUse", -"Проверка_ДропБоксРабота": "Check_DropboxWork", -"Проверка_ДвоичныеДанные": "Check_BinaryData", -"ПолучитьСтруктуруТовара": "GetProductStructure", -"ДелегироватьЗадачу (хук": "DelegateTask (wh", -"Получить/Обновить токен": "Get/Update token", -"ОтправитьКартинку (Путь": "SendPicture (Path", -"Проверка_ДропБоксМассив": "Check_DropboxArray", -"Б24_РаботаСППолямиЗадач": "B24_TaskFieldsManagment", -"Получить чеклист задачи": "Get tasks checklist", -"Изменить стадию канбана": "Change kanban stage", -"Идентификатор хранилища": "Storage ID", -"ПараметрыЗапросаВСтроку": "RequestParametersToString", -"РаботаСЧатамиИДиалогами": "ChatsAndDialogsManagment", -"YandexDisk_СоздатьПапку": "YandexDisk_CreateFolder", -"ИзменитьАртикулыТоваров": "UpdateProductsArticles", -"ВК_СоздатьТоварПодборку": "VKAPI_CreateProductSelection", -"Пустое описание товара:": "Empty product description:", -"СпособКодированияСтроки": "StringEncodingMethod", -"признак новой сделки (Y": "new deal flag (Y", -"ИзменитьАватарЧата (URL": "ChangeChatPicture (URL", -"Удалить свойство товара": "Delete product property", -"ОбеспечитьПустойКаталог": "EnsureEmptyDirectory", -"ДобавитьКомментарий (хук": "CreateComment (wh", -"Авторизуйтесь на портале": "Log in to the portal", -"ID пользователя адресата": "Recipient user ID", -"СоздатьКаталогВХранилище": "CreateStorageFolder", -"ВК_ПолучитьСписокЗаказов": "VKAPI_GetOrderList", -"ВК_ПолучитьСписокТоваров": "VKAPI_GetProductList", -"Ноушн_СоздатьУдалитьБлок": "Notion_CreateDeleteBlock", -"Получить заказ по номеру": "Get order by number", -"СоздатьПользователя (хук": "CreateUser (wh", -"ПолучитьКодПодтверждения": "GetConfirmationCode", -"Загрузить фото на сервер": "Upload photo to server", -"ПолучитьИнформациюОФайле": "GetFileInformation", -"Новый тестовый заголовок": "NewTestTitle", -"Bitrix24_ЗавершитьЗадачу": "Bitrix24_CompleteTask", -"Тип чата OPEN (публичный": "Chat type OPEN (public", -"Получить список областей": "Get region list", -"ОтправитьСообщение (json": "SendMessage (json", -"Ссылка (URL) под записью": "Link (URL) under the post", -"СоздатьТоварСоСвойствами": "CreateProductWithProperties", -"БитриксДоступныеДействия": "BitrixAvailableActions", -"ПоместитьКаталогВКорзину": "MarkFolderAsDeleted", -"НачатьНаблюдатьЗаЗадачей": "StartWatchingTask", -"Создает новое обсуждение": "Creates a new discussion", -"Данные файл для загрузки": "Data file for upload", -"Путь к объекту оригинала": "Path to the original object", -"Получить список подборок": "Get selection list", -"РазложитьОбъектыПодробно": "BreakDownObjectsInDetail", -"СформироватьТестыАссертс": "FormAssertsTests", -"Для работы через Webhook": "To work via Webhook", -"Изменить текст сообщения": "Change the message text", -"УбратьЗадачуИзИзбранного": "RemoveTaskFromFavorites", -"ПриостановитьУчетВремени": "PauseTimekeeping", -"ОпределитьТекущуюКоманду": "DetermineCurrentCommand", -"ВывестиНачальнуюСтраницу": "DisplayStartPage", -"Адрес истинного продавца": "The address of the true seller", -"ДропБокс_ПолучитьАккаунт": "DropboxAPI_GetAccount", -"ID файла для копирования": "Original file ID", -"ВК_ПолучитьСписокСвойств": "VKAPI_GetPropertyList", -"Путь к целевому каталогу": "Path to the target directory", -"Проверка_ТелеграмКонтакт": "Check_TelegramContact", -"СоздатьУдалитьТемуФорума": "CreateDeleteForumTopic", -"ОтключитьЗвукЗадачи (хук": "MuteTask (wh", -"ИзменитьСвойстваСтраницы": "EditPageProperties", -"ID товаров для архивации": "Product IDs for archiving", -"Новое описание календаря": "New calendar description", -"ДобавитьРодителяСтраницы": "AddPageParent", -"СоздатьРекламнуюКампанию": "CreateAdvertisingCampaign", -"Проверка_БитриксВложение": "Check_BitrixAttachment", -"СоздатьСсылкуПриглашение": "CreateInvitationLink", -"ОбработатьОшибочныйВывод": "HandleErrorOutput", -"Получить поле (строковое": "Get field (string", -"Использовать \"./internal": "Use \"./internal", -"ПреобразоватьФайлыВМедиа": "ConvertFilesToMedia", -"СоздатьАрхивироватьКанал": "CreateArchiveChannel", -"Блоки в документации API": "Blocks at API documentation", -"Новая рекламная кампания": "New ads campaign", -"ОтключитьУведомленияЧата": "DisableChatNotifications", -"Subsystem.OPI_Интеграция": "Subsystem.OPI_Integrations", -"ДобавитьФайлВЗадачу (хук": "AttachFileToTopic (wh", -"D:\\GD\\Мой диск\\data.json": "D:\\GD\\My Drive\\data.json", -"Файл источник обновления": "File source for update", -"СоздатьДлиннуюКлавиатуру": "CreateLongKeyboard", -"Секретный ключ (Password": "Secret key (Password", -"ПолучитьКатегорииТоваров": "GetProductCategories", -"ПолучитьДвоичныеИлиПоток": "GetBinaryOrStream", -"Поместить файл в корзину": "Mark file as deleted", -"Bitrix24_ПолучитьНовости": "Bitrix24_GetPosts", -"Bitrix24_ИзменитьНовость": "Bitrix24_UpdatePost", -"Откладывает задачу по ID": "Defer task by ID", -"Установить описание чата": "Set chat description", -"Строка, Массив из Строка": "String, Array of String", -"ОписаниеПримитивногоПоля": "PrimitiveFieldDescription", -"ПолучитьСписокРазрешений": "GetPermissionsList", -"ПолучитьИнформациюОДиске": "GetDiskInformation", -"Bitrix24_ОтклонитьЗадачу": "Bitrix24_DisapproveTask", -"Проверка_ВКГруппаТоваров": "Check_VKProductsGroup", -"СохранитьУдалитьКартинку": "SaveDeleteImage", -"ДобавитьКалендарьВСписок": "AddCalendarToList", -"Начать выполнение задачи": "Start a task", -"ПолучитьСтатистикуПостов": "GetPostStatistics", -"ID целевого пользователя": "Target user ID", +"Идентификатор категории": "Category identifier", +"Не найден входной файл!": "Input File Not Found!", +"Слак_ЗагрузитьУдалитьВФ": "Slack_UploadDeleteExternalFile", +"Создать свойство товара": "Create product property", +"Создать обновить товары": "Create update product", +"ОтправитьСообщение (хук": "SendMessage", +"РазделитьДвоичныеДанные": "SplitBinaryData", +"ПолучитьИнформациюОБазе": "GetDatabaseInfo", +"ПолучитьИнформациюОБоте": "GetBotInformation", +"ГенераторОтчетаПокрытия": "CoverageReportGenerator", +"ЗаписатьФайлыМультипарт": "WriteMultipartFiles", +"Получить список записей": "Get list of records", +"Telegram_ОтправитьАудио": "Telegram_SendAudio", +"Bitrix24_СоздатьНовость": "Bitrix24_CreatePost", +"Идентификатор базы База": "Base identifier Base", +"Имя файла с расширением": "File name with extension", +"ПолучитьСтруктуруЗадачи": "GetTaskFieldsStructure", +"HEX нового цвета стадии": "HEX of new stage color", +"Новое название подборки": "New selection name", +"АтрибутыИХарактеристики": "AttributesAndFeatures", +"Bitrix24_УдалитьНовость": "Bitrix24_DeletePost", +"ID файла для скачивания": "File ID for downloading", +"Получить значения ячеек": "Get cell values", +"ДФ=yyyy-MM-ddTHH:mm:ssZ": "DF=yyyy-MM-ddTHH:mm:ssZ", +"ОпределитьМетодОтправки": "DetermineSendMethod", +"ОтправитьЛокацию (канал": "SendLocation (channel", +"Слак_ПолучитьИнформацию": "SlackGetData", +"ПолучитьСтатусОбработки": "GetProcessingStatus", +"Bitrix24_УдалитьКаталог": "Bitrix24_DeleteFolder", +"Флаг анонимности опроса": "Survey anonymity flag", +"СоединитьДвоичныеДанные": "ConcatBinaryData", +"Bitrix24_ОтложитьЗадачу": "Bitrix24_DeferTask", +"Получить список заказов": "Get order list", +"Получить данные о сайте": "Get site data", +"и перейдите в настройки": "and go to the settings", +"ПереместитьФайлВКаталог": "MoveFileToFolder", +"ЗагрузитьФайлВХранилище": "UploadFileToStorage", +"Телеграм_ОтправитьГифку": "TelegramAPI_SendGIF", +"СдэкАПИ_РаботаСЗаказами": "CDEKAPI_OrdersManagment", +"адрес электронной почты": "email address", +"Bitrix24_СерверноеВремя": "Bitrix24_ServerTime", +"Новая картинка подборки": "New selection image", +"МаксимальнаяВложенность": "MaximumNesting", +"ОтменитьПубликациюФайла": "CancelFilePublication", +"Получить структуру лида": "Get lead structure", +"ОтменитьПубликациюПапки": "CancelFolderPublication", +"УправлениеВнешнимФайлом": "ExternalFileManagement", +"ПолучитьПубличныйОбъект": "GetPublicObject", +"Установить правила чата": "Set chat rules", +"ЗагрузитьМассивВложений": "UploadAttachmentsArray", +"ПолучитьИнформациюОЧате": "GetChatInfo", +"ВключитьУведомленияЧата": "EnableChatNotifications", +"ПолучитьКалендарьСписка": "GetListCalendar", +"УникальныйИдентификатор": "UUID", +"Добавить стадию канбана": "Add kanban stage", +"Телеграм_ОтправитьОпрос": "TelegramAPI_SendPoll", +"Лайк/Репост/Комментарий": "Like/Repost/Comment", +"Код формы собственности": "Form of ownership code", +"Массив Из Строка, Число": "Array of String, Number", +"Удалить выбранные файлы": "Delete selected files", +"СоздатьКомментарий (хук": "CreateComment (wh", +"УстановитьЗначенияЯчеек": "SetCellValues", +"Получить структуру чата": "Get chats structure", +"Массив из Строка, Число": "Array of string, number", +"Наименование новой базы": "New base name", +"ГД_ЗагрузитьУдалитьФайл": "GD_UploadDeleteFile", +"Другой заголовок задачи": "Another task title", +"Telegram_ОтправитьВидео": "Telegram_SendVideo", +"Вайбер_ОтправитьКонтакт": "Viber_SendContact", +"Произвольный, HTTPОтвет": "Arbitrary, HTTPResponse", +"Массив вариантов опроса": "Poll options array", +"СформироватьТестыЯксCLI": "FormYAXTestsCLI", +"Телеграм_ОтправитьВидео": "TelegramAPI_SendVideo", +"Создать страницу в базу": "Create page in database", +"Непредвиденная ошибка!:": "Unexpected Error!", +"Получить список складов": "Get warehouses list", +"Новое имя стадии стадии": "New stage name", +"ЗаполнитьОчиститьЯчейки": "FillClearCells", +"ВключитьЗвукЗадачи (хук": "UnmuteTask (wh", +"ИсключатьАрхивированные": "ExcludeArchived", +"массив URL картинок 360": "array of 360 images URLs", +"Получить поле (числовое": "Get field (numeric", +"ЯДиск_ПереместитьОбъект": "YDisk_MoveObject", +"ПолучитьЗначениеИзФайла": "GetValueFromFile", +"идентификатор реквизита": "prop identifier", +"Получить историю канала": "Get channel history", +"Переименовать хранилище": "Rename storage", +"Проверка_ТелеграмМассив": "Check_TelegramArray", +"ОзонСписокХарактеристик": "OzonAttributesList", +"ВывестиСправкуПоМетодам": "DisplayMethodHelp", +"ОтправитьКонтакт (канал": "SendContact (channel", +"Проверка_ДропБоксСтатус": "Check_DropboxStatus", +"ВК_СоздатьСоставнойПост": "VKAPI_CreateCompositePost", +"СлакОтложенноеСообщение": "SlackSheduledMessage", +"СформироватьМассивМедиа": "FormMediaArray", +"Проверка_ТелеграмИстина": "Check_TelegramTrue", +"ID удаляемого сообщения": "ID of message to delete", +"Скопированный файл.jpeg": "CopiedFile.jpeg", +"Выберите пункт External": "Choose External", +"Создать подборку товаров": "Create product selection", +"Наименование нового поля": "New field name", +"СинхронизироватьКаталоги": "SynchronizeFolders", +"УправлениеПользователями": "UsersManagment", +"VK_СоздатьСвойствоТовара": "VK_CreateProductProperty", +"Создать товар и подборку": "Create product and selection", +"Проверка_ДропбоксАккаунт": "Check_DropboxAccount", +"Вайбер_ОтправкаСообщений": "Viber_MessagesSending", +"ОзонАПИ_РаботаСоСкладами": "OzonAPI_WarehousesManagment", +"Строка, Массив Из Строка": "String, Array of String", +"Изменить свойство товара": "Edit product property", +"ДобавитьПараметрыКоманды": "AddCommandParameters", +"Новый каталог размещения": "New parent directory", +"Признак рекламного поста": "Sign of an advertising post", +"Отправить местоположение": "Send location", +"НаправлениеПоиска.СКонца": "SearchDirection.FromEnd", +"ПолучитьСписокЗадач (хук": "GetTasksList (wh", +"Dropbox_КопироватьОбъект": "Dropbox_CopyObject", +"ПолучитьПараметрыТвиттер": "GetTwitterParameters", "НормализоватьАвторизацию": "NormalizeAuth", +"Создать/Изменить таблицу": "Create/Edit table", "Получить описание заказа": "Get order description", "ПолучитьСписокКалендарей": "GetCalendarList", "Набор тестов для YAxUnit": "Test suite for YAxUnit", "Создает каталог на диске": "Creates a directory on the disk", "РаботаСУдаленнымиФайлами": "ExternalFilesManagement", +"СоздатьВысокуюКлавиатуру": "CreateTallKeyboard", "Б24_РаботаСКомментариями": "B24_CommentsManagment", -"Dropbox_КопироватьОбъект": "Dropbox_CopyObject", -"ВосстановитьКаталог (хук": "RestoreFolder (wh", "Метод в документации API": "Method at API documentation", "ставка ндс, например 0.2": "VAT rate, e.g. 0.2", "Другие товары сообщества": "Other items", @@ -3795,29 +3733,30 @@ "Массив заголовков кнопок": "Array of button titles", "ПолучитьСписокЛидов (хук": "GetLeadsList (wh", "АргументыКоманднойСтроки": "CommandLineArguments", -"ПолучитьПараметрыТвиттер": "GetTwitterParameters", -"СоздатьВысокуюКлавиатуру": "CreateTallKeyboard", -"ПолучитьСписокЗадач (хук": "GetTasksList (wh", -"Создать подборку товаров": "Create product selection", -"Проверка_ДропбоксАккаунт": "Check_DropboxAccount", -"СинхронизироватьКаталоги": "SynchronizeFolders", -"УправлениеПользователями": "UsersManagment", -"VK_СоздатьСвойствоТовара": "VK_CreateProductProperty", -"Создать товар и подборку": "Create product and selection", -"Наименование нового поля": "New field name", -"НаправлениеПоиска.СКонца": "SearchDirection.FromEnd", -"ОзонАПИ_РаботаСоСкладами": "OzonAPI_WarehousesManagment", -"Строка, Массив Из Строка": "String, Array of String", -"Вайбер_ОтправкаСообщений": "Viber_MessagesSending", -"Изменить свойство товара": "Edit product property", -"ДобавитьПараметрыКоманды": "AddCommandParameters", -"Новый каталог размещения": "New parent directory", -"Отправить местоположение": "Send location", -"Признак рекламного поста": "Sign of an advertising post", -"Создать/Изменить таблицу": "Create/Edit table", +"ВосстановитьКаталог (хук": "RestoreFolder (wh", "ПреобразоватьДанныеФайла": "ConvertFileData", -"Выбрать пункт **Другое**": "Select **Other**", +"РаботаСПодборкамиТоваров": "ProductSelectionManagement", "Удалено %1 лишних файлов": "Removed %1 unnecessary files", +"ГК_СоздатьУдалитьСобытие": "GC_CreateDeleteEvent", +"УдалитьКалендарьИзСписка": "DeleteCalendarFromList", +"СоздатьТвитКартинки (ИВФ": "CreateImageTweet (TFN", +"Получить данные аккаунта": "Get account data", +"ДобавитьЗадачуВИзбранное": "AddTaskToFavorites", +"ГК_ПолучитьСписокСобытий": "GC_GetEventList", +"UUID заказа для удаления": "Order UUID for deletion", +"Получить информацию бота": "Get bot information", +"Получить список хранилищ": "Get list of storages", +"ДобавитьПараметрКартинки": "AddImageParameter", +"Вайбер_ОтправитьКартинку": "Viber_SendImage", +"VK_ПолучитьСписокЗаказов": "VK_GetOrderList", +"ОтправитьКартинку (канал": "SendPicture (channel", +"ID файла для перемещения": "File ID", +"ID целевого пользователя": "Target user ID", +"ID элемента для удаления": "ID of deleted element", +"Массив товаров или товар": "Array of products or product", +"VK_ПолучитьСписокТоваров": "VK_GetProductList", +"Загрузить файл в каталог": "Upload file to the folder", +"ТекущаяУниверсальнаяДата": "CurrentUniversalDate", "Bitrix24_ПолучитьКаталог": "Bitrix24_GetFolder", "ИзменитьАватарЧата (Путь": "ChangeChatPicture (Path", "VK_ПолучитьСписокСвойств": "VK_GetPropertyList", @@ -3835,123 +3774,114 @@ "Bitrix24_СкопироватьФайл": "Bitrix24_MakeFileCopy", "Создает пустой календарь": "Creates an empty calendar", "СохранитьКартинкуВАльбом": "SaveImageToAlbum", -"ТекущаяУниверсальнаяДата": "CurrentUniversalDate", -"Загрузить файл в каталог": "Upload file to the folder", -"VK_ПолучитьСписокТоваров": "VK_GetProductList", -"РаботаСПодборкамиТоваров": "ProductSelectionManagement", -"Получить информацию бота": "Get bot information", -"ГК_СоздатьУдалитьСобытие": "GC_CreateDeleteEvent", -"УдалитьКалендарьИзСписка": "DeleteCalendarFromList", -"СоздатьТвитКартинки (ИВФ": "CreateImageTweet (TFN", -"Получить данные аккаунта": "Get account data", -"ДобавитьЗадачуВИзбранное": "AddTaskToFavorites", -"ГК_ПолучитьСписокСобытий": "GC_GetEventList", -"UUID заказа для удаления": "Order UUID for deletion", -"Получить список хранилищ": "Get list of storages", -"Массив товаров или товар": "Array of products or product", -"ДобавитьПараметрКартинки": "AddImageParameter", -"Вайбер_ОтправитьКартинку": "Viber_SendImage", -"VK_ПолучитьСписокЗаказов": "VK_GetOrderList", -"ОтправитьКартинку (канал": "SendPicture (channel", -"ID файла для перемещения": "File ID", -"ID элемента для удаления": "ID of deleted element", -"ПолучитьСписокФайловПапки": "GetListOfFolderFiles", -"Новое наименование стадии": "New stages name", -"НаправлениеПоиска.СНачала": "SearchDirection.FromBegin", -"CommonModule.OPI_ТестыCLI": "CommonModule.OPI_TestsCLI", -"Проверка_ТелеграмДокумент": "Check_TelegramDocument", -"РаботаСФайламиИКаталогами": "FileAndDirectoryManagement", -"Получить описание события": "Get event description", -"ОбновитьКоличествоТоваров": "UpdateProductsStocks", -"Получить структуру товара": "Get product structure", -"УправлениеПодразделениями": "DepartmentsManagment", -"Изменить имя главной темы": "Change main topic name", -"Изменяет существующий лид": "Modifies an existing lead", -"УдалитьТрудозатратыЗадачи": "DeleteTaskTimeAccounting", -"РаботаСРекламнымКабинетом": "AdAccountManagement", -"VK_УдалитьТоварИзПодборки": "VK_RemoveProductFromCollection", -"VK_ДобавитьТоварВПодборку": "VK_AddProductToCollection", -"ОчиститьОсновнойКалендарь": "ClearMainCalendar", -"Получить структуру сделки": "Get deal structure", -"Создать произвольный твит": "Create custom tweet", -"ПолучитьСсылкуАвторизации": "GetAuthorizationLink", -"МобильноеПриложениеКлиент": "MobileAppClient", -"ИзменитьКомментарийЗадачи": "UpdateTaskComment", -"Создать товары по Ozon ID": "Create products by Ozon ID", -"Номер рекламной категории": "Advertising category number", -"ПолучитьИнформациюОКанале": "GetChannelInformation", -"openintegrations.dev/docs": "en.openintegrations.dev/docs", -"Использовать \"../../tools": "Use \"../../tools", -"VK_ЗагрузитьВидеоНаСервер": "VK_UploadVideoToServer", -"Трудозатраты по обработке": "Time spent on work", -"УдалитьСтадиюКанбана (хук": "DeleteKanbanStage (wh", -"Ссылка на последний релиз": "To the latest release", -"ЗавершитьУчетВремени (хук": "StopTimekeeping (wh", -"VK_СоздатьПодборкуТоваров": "VK_CreateProductCollection", -"Тип дополнительной услуги": "Type of additional service", -"УдалитьПодразделение (хук": "DeleteDepartment (wh", -"См. ПолучитьОписаниеФайла": "See GetFileDescription", -"Соответствие файлов: Ключ": "Map: Key", -"Загрузить массив вложений": "Upload attachments array", -"ПолучитьСписокФайлов (все": "GetFilesList (full", -"УстановитьБезопасныйРежим": "SetSafeMode", -"Проверка_БитриксХранилища": "Check_BitrixStorage", -"Изменить подборку товаров": "Edit product selection", -"Обновленное описание базы": "Updated base description", -"ПолучитьСписокФайлов (Все": "GetFilesList (All", -"Заголовок файла для Slack": "File title for Slack", -"Telegram_УдалитьСообщение": "Telegram_DeleteMessage", -"признак доступен для всех": "feature is available for all", -"ID элемента для получения": "Element ID", -"СменитьВладельцаЧата (хук": "ChangeChatOwner (wh", -"Включить уведомления чата": "Enable chat notifications", -"Получить число участников": "Get participant count", -"ID сообщения для удаления": "ID of the message to be deleted", -"ДействияПубличныхОбъектов": "PublicObjectActions", -"Твиттер_СоздатьТвитСВидео": "Twitter_CreateTweetWithVideo", -"VK_ИзменитьСвойствоТовара": "VK_EditProductProperty", -"Изменить артикулы товаров": "Update products articles", -"ПолучитьКаталогФайловЧата": "GetChatFilesFolder", -"VK_ПолучитьСписокПодборок": "VK_GetSelectionList", -"Проверка_ДропбоксУчастник": "Check_DropboxMember", -"Отменить публикацию папки": "Unpublish folder", -"VK_СформироватьКлавиатуру": "VK_FormKeyboard", -"Идентификатор типа товара": "Item type identifier", -"ID удаляемого комментария": "ID of comment to remove", -"ВК_ПолучитьСписокПодборок": "VKAPI_GetSelectionList", -"Создать/Удалить календарь": "Create/Delete calendar", -"ДобавитьИдентификаторЧата": "AddChatIdentifier", -"Проверить доступ к задаче": "Check task acesses for users", -"Telegram_ОтправитьКонтакт": "Telegram_SendContact", -"Устанавливает тему канала": "Sets the channel topic", -"Coverage_ЗапускВсехТестов": "Coverage_StartAllTests", -"Загрузить видео на сервер": "Upload video to server", -"ПолучитьИнформациюОТоваре": "GetProductInformation", -"СоответствиеКомандМодулей": "ModuleCommandMapping", -"ЭкранированиеСимволовJSON": "JSONCharactersEscapeMode", -"Создает новую базу данных": "Creates a new database", -"ОформитьКлиентскийВозврат": "CreateCustomerRefund", -"Некорректный вид отправки": "Incorrect sending view", -"Преобразование типов (ОПИ": "Type conversion (OpenIntegrations", -"ПолучитьПользователя (хук": "GetUser (wh", -"Получить календарь списка": "Get list calendar", -"Копирует файл или каталог": "Copies file or directory", -"Получить структуру задачи": "Get task fields structure", -"ПолучитьКомменатрийЗадачи": "GetTaskComment", -"ПоказыватьВыводНемедленно": "ShowOutputImmediately", -"Добавить товар в подборку": "Add product to selection", -"РаботаСоСпискомКалендарей": "CalendarListManagement", -"ПолучитьСписокРезультатов": "GetResultsList", -"ДобавитьПользователейВЧат": "AddUsersToChat", -"Dropbox_ПереместитьОбъект": "Dropbox_MoveObject", -"Слак_ЗагрузитьУдалитьФайл": "Slack_UploadDeleteFile", -"Идентификатор комментария": "Comment identifier", -"Преобразовать код в токен": "Convert code to token", -"Путь назначения для копии": "Destination path for the copy", +"Выбрать пункт **Другое**": "Select **Other**", +"ПолучитьСтатистикуПостов": "GetPostStatistics", +"Bitrix24_ОтклонитьЗадачу": "Bitrix24_DisapproveTask", +"ДобавитьКалендарьВСписок": "AddCalendarToList", +"ПоместитьКаталогВКорзину": "MarkFolderAsDeleted", +"НачатьНаблюдатьЗаЗадачей": "StartWatchingTask", +"Создает новое обсуждение": "Creates a new discussion", +"Данные файл для загрузки": "Data file for upload", +"Путь к объекту оригинала": "Path to the original object", +"Получить список подборок": "Get selection list", +"РазложитьОбъектыПодробно": "BreakDownObjectsInDetail", +"БитриксДоступныеДействия": "BitrixAvailableActions", +"СформироватьТестыАссертс": "FormAssertsTests", +"Изменить текст сообщения": "Change the message text", +"УбратьЗадачуИзИзбранного": "RemoveTaskFromFavorites", +"ПриостановитьУчетВремени": "PauseTimekeeping", +"ОпределитьТекущуюКоманду": "DetermineCurrentCommand", +"ВывестиНачальнуюСтраницу": "DisplayStartPage", +"Адрес истинного продавца": "The address of the true seller", +"ДропБокс_ПолучитьАккаунт": "DropboxAPI_GetAccount", +"Для работы через Webhook": "To work via Webhook", +"ID файла для копирования": "Original file ID", +"СоздатьТоварСоСвойствами": "CreateProductWithProperties", +"Получить список областей": "Get region list", +"Начать выполнение задачи": "Start a task", +"ДобавитьКомментарий (хук": "CreateComment (wh", +"Авторизуйтесь на портале": "Log in to the portal", +"ID пользователя адресата": "Recipient user ID", +"СоздатьКаталогВХранилище": "CreateStorageFolder", +"ВК_ПолучитьСписокЗаказов": "VKAPI_GetOrderList", +"ВК_ПолучитьСписокТоваров": "VKAPI_GetProductList", +"Ссылка (URL) под записью": "Link (URL) under the post", +"Ноушн_СоздатьУдалитьБлок": "Notion_CreateDeleteBlock", +"СоздатьПользователя (хук": "CreateUser (wh", +"ПолучитьКодПодтверждения": "GetConfirmationCode", +"Загрузить фото на сервер": "Upload photo to server", +"ПолучитьИнформациюОФайле": "GetFileInformation", +"Новый тестовый заголовок": "NewTestTitle", +"Bitrix24_ЗавершитьЗадачу": "Bitrix24_CompleteTask", +"Тип чата OPEN (публичный": "Chat type OPEN (public", +"Получить заказ по номеру": "Get order by number", +"ВК_ПолучитьСписокСвойств": "VKAPI_GetPropertyList", +"ОтправитьСообщение (json": "SendMessage (json", +"Проверка_ТелеграмКонтакт": "Check_TelegramContact", +"Файл источник обновления": "File source for update", +"СоздатьДлиннуюКлавиатуру": "CreateLongKeyboard", +"Секретный ключ (Password": "Secret key (Password", +"ПолучитьКатегорииТоваров": "GetProductCategories", +"ПолучитьДвоичныеИлиПоток": "GetBinaryOrStream", +"Поместить файл в корзину": "Mark file as deleted", +"Bitrix24_ПолучитьНовости": "Bitrix24_GetPosts", +"D:\\GD\\Мой диск\\data.json": "D:\\GD\\My Drive\\data.json", +"Откладывает задачу по ID": "Defer task by ID", +"Строка, Массив из Строка": "String, Array of String", +"ОписаниеПримитивногоПоля": "PrimitiveFieldDescription", +"ПолучитьСписокРазрешений": "GetPermissionsList", +"ПолучитьИнформациюОДиске": "GetDiskInformation", +"Проверка_ВКГруппаТоваров": "Check_VKProductsGroup", +"Путь к целевому каталогу": "Path to the target directory", +"СохранитьУдалитьКартинку": "SaveDeleteImage", +"Установить описание чата": "Set chat description", +"ДобавитьФайлВЗадачу (хук": "AttachFileToTopic (wh", +"Bitrix24_ИзменитьНовость": "Bitrix24_UpdatePost", +"ДобавитьРодителяСтраницы": "AddPageParent", +"СоздатьУдалитьТемуФорума": "CreateDeleteForumTopic", +"ИзменитьСвойстваСтраницы": "EditPageProperties", +"ID товаров для архивации": "Product IDs for archiving", +"Новое описание календаря": "New calendar description", +"СоздатьРекламнуюКампанию": "CreateAdvertisingCampaign", +"Проверка_БитриксВложение": "Check_BitrixAttachment", +"Subsystem.OPI_Интеграция": "Subsystem.OPI_Integrations", +"СоздатьСсылкуПриглашение": "CreateInvitationLink", +"Получить поле (строковое": "Get field (string", +"Использовать \"./internal": "Use \"./internal", +"ПреобразоватьФайлыВМедиа": "ConvertFilesToMedia", +"СоздатьАрхивироватьКанал": "CreateArchiveChannel", +"Блоки в документации API": "Blocks at API documentation", +"Новая рекламная кампания": "New ads campaign", +"ОтключитьУведомленияЧата": "DisableChatNotifications", +"ОбработатьОшибочныйВывод": "HandleErrorOutput", +"ОтключитьЗвукЗадачи (хук": "MuteTask (wh", +"ИзменитьНаименованиеКниги": "EditSpreadsheetTitle", +"ИзменитьКартинкуЧата (хук": "ChangeChatPicture (wh", +"ДобавитьЗаголовокСтраницы": "AddPageHeader", +"идентификатор темы форума": "forum topic identifier", +"ПолучениеДанныхИНастройка": "DataRetrievalAndSettings", +"Слак_ОткрытьЗакрытьДиалог": "Slack_OpenCloseDialog", +"ПереименоватьКаталог (хук": "RenameFolder (wh", +"ОтправитьОписанияОбъектов": "SendObjectsDescription", +"СоздатьУдалитьКомментарий": "CreateDeleteComment", +"идентификатор направления": "direction identifier", +"Проверка_БитриксРезультат": "Check_BitrixResult", +"ID задачи источника связи": "From task ID", +"Получить публичный объект": "Get public object", +"ID пользователей(я) Viber": "Viber User(s) ID", +"Статус : Соответствие": "Status : Map", +"Как EDT проект расширения": "As an EDT extension project", +"Открытый Пакет Интеграций": "Open Integrations Package", +"Dropbox_ОпубликоватьПапку": "Dropbox_PublishFolder", +"Телеграм_ОтправитьКонтакт": "TelegramAPI_SendContact", +"Удаляет комментарий по ID": "Deletes comment by ID", +"Подчиненное подразделение": "Subordinate department", +"ПолучитьПользователейЧата": "GetChatMembers", +"Команда + \"\"#color=Бирюза": "Command + \"\"#color=Aqua", +"Проверка_ТелеграмКартинка": "Check_TelegramImage", "ОтправитьУдалитьЭфемерное": "SendDeleteEphemeral", "UUID заказа для изменение": "Order UUID for updating", "Архивирует активный канал": "Archives an active channel", -"ПолучитьПользователейЧата": "GetChatMembers", "БитриксСписокКомментариев": "BitrixCommentsList", "Установить значения ячеек": "Set cell values", "ID записи о трудозатратах": "Time record ID", @@ -3967,33 +3897,33 @@ "Удаляет уведомление по ID": "Delete notification by ID", "Управление пользователями": "Users managment", "Тестовый товар измененный": "EditedTestProduct", -"Команда + \"\"#color=Бирюза": "Command + \"\"#color=Aqua", "МобильноеПриложениеСервер": "MobileAppServer", -"Подчиненное подразделение": "Subordinate department", -"Телеграм_ОтправитьКонтакт": "TelegramAPI_SendContact", -"ОтправитьОписанияОбъектов": "SendObjectsDescription", -"Слак_ОткрытьЗакрытьДиалог": "Slack_OpenCloseDialog", -"ПолучениеДанныхИНастройка": "DataRetrievalAndSettings", -"СоздатьУдалитьКомментарий": "CreateDeleteComment", -"ДобавитьЗаголовокСтраницы": "AddPageHeader", -"ИзменитьКартинкуЧата (хук": "ChangeChatPicture (wh", -"ИзменитьНаименованиеКниги": "EditSpreadsheetTitle", -"ПереименоватьКаталог (хук": "RenameFolder (wh", -"идентификатор направления": "direction identifier", -"Удаляет комментарий по ID": "Deletes comment by ID", -"ID задачи источника связи": "From task ID", -"Получить публичный объект": "Get public object", -"ID пользователей(я) Viber": "Viber User(s) ID", -"Статус : Соответствие": "Status : Map", -"Как EDT проект расширения": "As an EDT extension project", -"Проверка_БитриксРезультат": "Check_BitrixResult", -"Открытый Пакет Интеграций": "Open Integrations Package", -"Dropbox_ОпубликоватьПапку": "Dropbox_PublishFolder", -"идентификатор темы форума": "forum topic identifier", -"Проверка_ТелеграмКартинка": "Check_TelegramImage", "Добавить/Удалить картинку": "Add/Delete image", -"URL для установки Webhook": "URL for setting up Webhook", +"ДропБокс_РаботаСДоступами": "DropboxAPI_AccessManagement", "Изменить календарь списка": "Edit list calendar", +"ВосстановитьОбъектКВерсии": "RestoreObjectToVersion", +"Описание тестового товара": "Test item description", +"СоздатьПодразделение (хук": "CreateDepartment (wh", +"Удалить зависимость задач": "Delete tasks dependencies", +"Bitrix24_ВосстановитьФайл": "Bitrix24_RestoreFile", +"Структура JSON полей базы": "The structure of the JSON database fields", +"Новое имя стадии стадии 2": "New stage name 2", +"Тестовый комментарий (изм": "Test comment (change", +"Синхронизировать каталоги": "Synchronize folders", +"ID задачи приемника связи": "To task ID", +"ИзменитьПользователя (хук": "UpdateUser (wh", +"ДобавитьКомментарийЗадачи": "AddTaskComment", +"Отменить публикацию файла": "Unpublish file", +"УдалитьПоследниеСообщения": "DeleteLastMessages", +"Получить список каталогов": "Get list of directories", +"Наименование новой стадии": "New stage name", +"Заполнить/Очистить ячейки": "Fill/Clear cells", +"Ноушн_СоздатьИзменитьБазу": "Notion_CreateEditDatabase", +"Путь назначения для копии": "Destination path for the copy", +"дата последнего изменения": "date of last modification", +"URL для установки Webhook": "URL for setting up Webhook", +"ОтправитьУдалитьСообщение": "SendDeleteMessage", +"ВыполнитьЗапросМультипарт": "ExecuteMultipartRequest", "Преобразование типов (OPI": "Type conversion (OPI", "Атрибуты и характеристики": "Attributes and features", "Создать зависимость задач": "Create tasks dependencies", @@ -4013,140 +3943,154 @@ "Создает пост с картинками": "Creates a post with images", "Установить заголовок чата": "Set chat title", "Дополнительный тип заказа": "Additional order type", -"ВыполнитьЗапросМультипарт": "ExecuteMultipartRequest", "OPI_ПолучениеДанныхТестов": "OPI_TestDataRetrieval", -"ОтправитьУдалитьСообщение": "SendDeleteMessage", -"дата последнего изменения": "date of last modification", -"ВосстановитьОбъектКВерсии": "RestoreObjectToVersion", -"Описание тестового товара": "Test item description", -"СоздатьПодразделение (хук": "CreateDepartment (wh", -"Удалить зависимость задач": "Delete tasks dependencies", -"Bitrix24_ВосстановитьФайл": "Bitrix24_RestoreFile", -"Структура JSON полей базы": "The structure of the JSON database fields", -"Новое имя стадии стадии 2": "New stage name 2", -"Тестовый комментарий (изм": "Test comment (change", -"Синхронизировать каталоги": "Synchronize folders", -"ID задачи приемника связи": "To task ID", -"ИзменитьПользователя (хук": "UpdateUser (wh", -"ДобавитьКомментарийЗадачи": "AddTaskComment", -"Отменить публикацию файла": "Unpublish file", -"ДропБокс_РаботаСДоступами": "DropboxAPI_AccessManagement", -"УдалитьПоследниеСообщения": "DeleteLastMessages", -"Получить список каталогов": "Get list of directories", -"Наименование новой стадии": "New stage name", +"Преобразовать код в токен": "Convert code to token", "ОбновитьИзображенияТовара": "UpdateProductImages", -"Заполнить/Очистить ячейки": "Fill/Clear cells", -"Ноушн_СоздатьИзменитьБазу": "Notion_CreateEditDatabase", -"Добавляет товар в подборку": "Adds a product to the selection", -"Полужирный текст сообщения": "Bold text", -"ВывестиСправкуПоПараметрам": "DisplayParameterHelp", -"ЗагрузитьФайлВКаталог (хук": "UploadFileToFolder (wh", -"СлужебныеПроцедурыИФункции": "Private", -"Получить информацию о базе": "Get database info", -"СлужебныеПроцедурыИфункции": "ServiceProceduresAndFunctions", -"Вайбер_ПолучениеИнформации": "Viber_DataRetrieval", -"ДобавитьСтадиюКанбана (хук": "AddKanbanStage (wh", -"ОткрытьТемуФорума (главная": "OpenForumTopic (main", -"КраткоеПредставлениеОшибки": "BriefErrorRepresentation", -"ПолучитьРезультатОбработки": "GetProcessingResult", -"Документация Neocities API": "Neocities API docs", -"ЗаполнитьПоляЗапросаТовара": "FillProductRequestFields", -"Создать/Архивировать канал": "Create/Archive channel", -"Bitrix24_ВозобновитьЗадачу": "Bitrix24_RenewTask", -"Получить список календарей": "Get list of calendars", -"Отключить уведомления чата": "Disable chat notifications", -"Мне больше нравится желтый": "I like yellow more", -"Дата установки трудозатрат": "Date the record was set", -"ВывестиСообщениеИсключения": "DisplayExceptionMessage", -"Bitrix24_КопироватьКаталог": "Bitrix24_CopyFolder", -"Получить информацию канала": "Get channel info", -"Telegram_СоздатьТемуФорума": "Telegram_CreateForumTopic", -"Очищает значение в ячейках": "Clears the value in cells", -"ОдобритьЗаявкуНаВступление": "ApprovePending", -"Путь сохранения на Dropbox": "Save path on Dropbox", -"ПолучитьИнформациюОТоварах": "GetProductsInformation", -"ЗагрузкаИОбновлениеТоваров": "UploadingAndUpdatingProducts", -"Сформировать блок картинку": "Generate image block", -"ИсключитьПользователейЧата": "RemoveChatMembers", -"ПолучитьПодразделения (хук": "GetDepartments (wh", -"ПреобразоватьПользователей": "ConvertUsers", -"VK_СоздатьТоварСоСвойством": "VK_CreateProductWithProp", -"Проверка_ТелеграмСообщение": "Check_TelegramMessage", -"СформироватьЗначенияВыбора": "FormSelectionValues", -"Структура Из КлючИЗначение": "Structure of KeyAndValue", -"ПолучитьИсториюЗадачи (хук": "GetTaskHistory (wh", -"ПолучитьВнешнююСсылкуФайла": "GetFileExternalLink", -"ИзменитьСтадиюКанбана (хук": "UpdateKanbansStage (wh", -"Локальный каталог источник": "Local source catalog", -"массив URL картинок товара": "array of product images URLs", -"Скрыть главную тему форума": "Hide main forum thread", -"СформироватьКнопкуДействия": "MakeActionButton", -"Отключает уведомлений чата": "Disable chat notifications", -"Telegram_ОткрытьТемуФорума": "Telegram_OpenForumTopic", -"Структура из КлючИЗначение": "Structure of KeyAndValue", -"ДропБокс_СоздатьУдалитьТег": "DropboxAPI_CreateDeleteTag", -"Скопируйте новый **токен**": "Copy the new **token**", -"ИзменитьСтатусПользователя": "ChangeUserStatus", -"ПолучитьСсылкуНаСкачивание": "GetDownloadLink", -"ОтправитьСообщение (диалог": "SendMessage (dialog", -"Массив соответствий файлов": "Array of file mappings", -"ПолучитьТрудозатратыЗадачи": "GetTaskTimeAccounting", -"ПолучитьИнформациюОбУценке": "GetDiscountInformation", -"УдалитьПустыеКлючиЗначения": "RemoveEmptyKeyValues", -"другие увед. будут удалены": "another notif. will be deleted", -"ПолучитьСтатусУчетаВремени": "GetTimekeepingStatus", -"ID оригинального сообщения": "Original message ID", -"Получить статистику постов": "Get post statistics", -"Bitrix24_СоздатьПодкаталог": "Bitrix24_CreateSubfolder", -"Telegram_ОтправитьКартинку": "Telegram_SendPicture", -"Телеграм_ОтправитьКартинку": "TelegramAPI_SendImage", -"ПолучитьДанныеПользователя": "GetUserData", -"Если вам необходим чат-бот": "If you need a chatbot", -"ПолучитьСтадииКанбана (хук": "GetKanbanStages (wh", -"Telegram_УстановитьWebhook": "Telegram_SetWebhook", -"ИмяФайла, Вид + Расширение": "FileName, View + Extension", -"ИзменитьТрудозатратыЗадачи": "UpdateTaskTimeAccounting", -"Dropbox_ПолчитьСписокТегов": "Dropbox_GetTagList", -"ПолучитьИмяВременногоФайла": "GetTempFileName", -"Получить информацию о чате": "Get information about the chat room", -"Получить код подтверждения": "Get confirmation code", -"ОжидатьЗавершенияОбработки": "WaitForProcessingCompletion", -"ПолучитьЗначенияРекурсивно": "GetValuesRecursively", -"Наименование новой таблицы": "New table name", -"Число знаков после запятой": "Number of decimal places", -"Проверка_ВКВариантСвойства": "Check_VKPropVariant", -"Это сообщение было удалено": "This message was deleted", -"ЯДиск_ПолучитьСписокФайлов": "YDisk_GetFileList", -"ДобавитьПользователяКФайлу": "AddUserToFile", -"признак повторного лида (Y": "reused lead flag (Y", -"ДобавитьКомментарийНовости": "AddPostComment", -"ИзменитьПодразделение (хук": "UpdateDepartment (wh", -"ИзменитьЗаголовокЧата (хук": "ChangeChatTitle (wh", -"Telegram_УдалитьТемуФорума": "Telegram_DeleteForumTopic", -"Создать ссылку-приглашение": "Create invitation link", -"Телефон истинного продавца": "The true sellers phone number", -"Создать рекламную кампанию": "Create advertising campaign", -"ЗакрытьТемуФорума (главная": "CloseForumTopic (main", -"ГК_СоздатьУдалитьКалендарь": "GC_CreateDeleteCalendar", -"ГД_ПолучитьСписокКаталогов": "GD_GetCatalogList", +"Слак_ЗагрузитьУдалитьФайл": "Slack_UploadDeleteFile", +"Номер рекламной категории": "Advertising category number", +"ПолучитьИнформациюОКанале": "GetChannelInformation", +"openintegrations.dev/docs": "en.openintegrations.dev/docs", +"Использовать \"../../tools": "Use \"../../tools", +"VK_ЗагрузитьВидеоНаСервер": "VK_UploadVideoToServer", +"Трудозатраты по обработке": "Time spent on work", +"УдалитьСтадиюКанбана (хук": "DeleteKanbanStage (wh", +"Ссылка на последний релиз": "To the latest release", +"ЗавершитьУчетВремени (хук": "StopTimekeeping (wh", +"VK_СоздатьПодборкуТоваров": "VK_CreateProductCollection", +"Тип дополнительной услуги": "Type of additional service", +"УдалитьПодразделение (хук": "DeleteDepartment (wh", +"См. ПолучитьОписаниеФайла": "See GetFileDescription", +"Соответствие файлов: Ключ": "Map: Key", +"Загрузить массив вложений": "Upload attachments array", +"ПолучитьСписокФайлов (все": "GetFilesList (full", +"УстановитьБезопасныйРежим": "SetSafeMode", +"Проверка_БитриксХранилища": "Check_BitrixStorage", +"Изменить подборку товаров": "Edit product selection", +"Создать товары по Ozon ID": "Create products by Ozon ID", +"Обновленное описание базы": "Updated base description", +"ИзменитьКомментарийЗадачи": "UpdateTaskComment", +"ПолучитьСсылкуАвторизации": "GetAuthorizationLink", +"ПолучитьСписокФайловПапки": "GetListOfFolderFiles", +"Новое наименование стадии": "New stages name", +"Идентификатор комментария": "Comment identifier", +"НаправлениеПоиска.СНачала": "SearchDirection.FromBegin", +"CommonModule.OPI_ТестыCLI": "CommonModule.OPI_TestsCLI", +"Проверка_ТелеграмДокумент": "Check_TelegramDocument", +"РаботаСФайламиИКаталогами": "FileAndDirectoryManagement", +"Получить описание события": "Get event description", +"ОбновитьКоличествоТоваров": "UpdateProductsStocks", +"Получить структуру товара": "Get product structure", +"Изменить имя главной темы": "Change main topic name", +"Изменяет существующий лид": "Modifies an existing lead", +"УдалитьТрудозатратыЗадачи": "DeleteTaskTimeAccounting", +"РаботаСРекламнымКабинетом": "AdAccountManagement", +"VK_УдалитьТоварИзПодборки": "VK_RemoveProductFromCollection", +"VK_ДобавитьТоварВПодборку": "VK_AddProductToCollection", +"ОчиститьОсновнойКалендарь": "ClearMainCalendar", +"Получить структуру сделки": "Get deal structure", +"Создать произвольный твит": "Create custom tweet", +"МобильноеПриложениеКлиент": "MobileAppClient", +"ПолучитьСписокФайлов (Все": "GetFilesList (All", +"УправлениеПодразделениями": "DepartmentsManagment", +"Telegram_УдалитьСообщение": "Telegram_DeleteMessage", +"Загрузить видео на сервер": "Upload video to server", +"ПолучитьИнформациюОТоваре": "GetProductInformation", +"СоответствиеКомандМодулей": "ModuleCommandMapping", +"ЭкранированиеСимволовJSON": "JSONCharactersEscapeMode", +"Создает новую базу данных": "Creates a new database", +"ОформитьКлиентскийВозврат": "CreateCustomerRefund", +"Некорректный вид отправки": "Incorrect sending view", +"Преобразование типов (ОПИ": "Type conversion (OpenIntegrations", +"ПолучитьПользователя (хук": "GetUser (wh", +"Получить календарь списка": "Get list calendar", +"Копирует файл или каталог": "Copies file or directory", +"Получить структуру задачи": "Get task fields structure", +"ПолучитьКомменатрийЗадачи": "GetTaskComment", +"Добавить товар в подборку": "Add product to selection", +"РаботаСоСпискомКалендарей": "CalendarListManagement", +"ПолучитьСписокРезультатов": "GetResultsList", +"ДобавитьПользователейВЧат": "AddUsersToChat", +"Dropbox_ПереместитьОбъект": "Dropbox_MoveObject", +"Заголовок файла для Slack": "File title for Slack", +"Coverage_ЗапускВсехТестов": "Coverage_StartAllTests", +"Устанавливает тему канала": "Sets the channel topic", +"ПоказыватьВыводНемедленно": "ShowOutputImmediately", +"Проверить доступ к задаче": "Check task acesses for users", +"признак доступен для всех": "feature is available for all", +"Telegram_ОтправитьКонтакт": "Telegram_SendContact", +"ID элемента для получения": "Element ID", +"СменитьВладельцаЧата (хук": "ChangeChatOwner (wh", +"Включить уведомления чата": "Enable chat notifications", +"ID сообщения для удаления": "ID of the message to be deleted", +"ДействияПубличныхОбъектов": "PublicObjectActions", +"Твиттер_СоздатьТвитСВидео": "Twitter_CreateTweetWithVideo", +"VK_ИзменитьСвойствоТовара": "VK_EditProductProperty", +"Изменить артикулы товаров": "Update products articles", +"Получить число участников": "Get participant count", +"ПолучитьКаталогФайловЧата": "GetChatFilesFolder", +"VK_ПолучитьСписокПодборок": "VK_GetSelectionList", +"Проверка_ДропбоксУчастник": "Check_DropboxMember", +"Отменить публикацию папки": "Unpublish folder", +"VK_СформироватьКлавиатуру": "VK_FormKeyboard", +"ДобавитьИдентификаторЧата": "AddChatIdentifier", +"Идентификатор типа товара": "Item type identifier", +"ID удаляемого комментария": "ID of comment to remove", +"ВК_ПолучитьСписокПодборок": "VKAPI_GetSelectionList", +"Создать/Удалить календарь": "Create/Delete calendar", "ДобавитьТрудозатратыЗадачи": "AddTaskTimeAccounting", "Ноушн_СоздатьСтраницуВБазу": "Notion_CreatePageInDatabase", "Структура заполнения опции": "Data structure for option", "ПолучитьЧеклистЗадачи (хук": "GetTasksChecklist (wh", "Получает схему таблиц базы": "Gets the schema of base tables", "Бренд на иностранном языке": "Brand in a foreign language", -"ОтправитьМедиагруппу (доки": "SendMediaGroup (docs", +"СоздатьРекламноеОбъявление": "CreateAd", "ID чата для отправки файла": "Chat ID for sending", "Управление подразделениями": "Departments managment", -"СоздатьРекламноеОбъявление": "CreateAd", +"разрешение на методы Drive": "Drive methods permission", "ПолучитьСтруктуруЛида (хук": "GetLeadStructure (wh", "Слак_ПолучитьСписокКаналов": "Slack_GetChannelList", +"ГД_ПолучитьСписокКаталогов": "GD_GetCatalogList", "ПолучитьДанныеОСайте (Сайт": "GetSiteData (Site", -"разрешение на методы Drive": "Drive methods permission", +"ОтправитьМедиагруппу (доки": "SendMediaGroup (docs", +"ГК_СоздатьУдалитьКалендарь": "GC_CreateDeleteCalendar", +"ДобавитьПользователяКФайлу": "AddUserToFile", +"Создать рекламную кампанию": "Create advertising campaign", +"ПолучитьЗначенияРекурсивно": "GetValuesRecursively", "Загрузить файл в хранилище": "Upload file to a storage", +"Наименование новой таблицы": "New table name", +"Число знаков после запятой": "Number of decimal places", +"Проверка_ВКВариантСвойства": "Check_VKPropVariant", +"Это сообщение было удалено": "This message was deleted", +"ЗакрытьТемуФорума (главная": "CloseForumTopic (main", +"ЯДиск_ПолучитьСписокФайлов": "YDisk_GetFileList", +"ДобавитьКомментарийНовости": "AddPostComment", +"ИзменитьПодразделение (хук": "UpdateDepartment (wh", +"ИзменитьЗаголовокЧата (хук": "ChangeChatTitle (wh", +"Telegram_УдалитьТемуФорума": "Telegram_DeleteForumTopic", +"Создать ссылку-приглашение": "Create invitation link", +"Телефон истинного продавца": "The true sellers phone number", +"признак повторного лида (Y": "reused lead flag (Y", "Dropbox_ЗагрузитьФайлПоURL": "Dropbox_UploadFileByURL", -"Телеграм_ОтправитьДокумент": "TelegramAPI_SendDocument", +"ЧислоСтандартныхПараметров": "NumberOfStandardParameters", "НормализоватьТекстовыйВвод": "NormalizeTextInput", +"ДобавитьВидеообложкуТовара": "AddProductVideoCover", +"ТекущийПуть, ТекущиеДанные": "CurrentPath, CurrentData", +"Проверка_ВККартинкаАльбома": "Check_VKAlbumPicture", +"URL к видео для добавления": "URL of the video", +"Телеграм_УстановитьWebhook": "TelegramAPI_SetWebhook", +"Получает комментарий по ID": "Gets comment by ID", +"ГТ_ЗаполнитьОчиститьЯчейки": "GT_FillClearCells", +"ОбработатьТабуляциюСправки": "HandleHelpTabulation", +"Наименование подразделения": "Department name", +"ОтправитьУведомлениеОВводе": "SendWritingNotification", +"ПолучитьПользователей (хук": "GetUsers (wh", +"МинимальныйРазмерДляПотока": "MinimumStreamSize", +"Bitrix24_ПереименоватьФайл": "Bitrix24_RenameFile", +"ОжидатьЗавершенияОбработки": "WaitForProcessingCompletion", +"ПоместитьФайлВКорзину (хук": "MarkFileAsDeleted (wh", +"Telegram_ОтправитьДокумент": "Telegram_SendDocument", +"Telegram_ЗакрытьТемуФорума": "Telegram_CloseForumTopic", +"VK_ИзменитьПодборкуТоваров": "VK_EditProductCollection", "УдалитьПустыеПоляКоллекции": "RemoveEmptyCollectionFields", "ПолучитьСписокКомментариев": "GetCommentList", "ПолучитьЗначенияЯчеек (все": "GetCellValues (all", @@ -4162,46 +4106,166 @@ "ПреобразоватьВариантВыбора": "ConvertSelectionOption", "ЯДиск_ЗагрузитьУдалитьФайл": "YDisk_UploadDeleteFile", "Приостановить учет времени": "Stop timekeeping", -"VK_ИзменитьПодборкуТоваров": "VK_EditProductCollection", -"Telegram_ЗакрытьТемуФорума": "Telegram_CloseForumTopic", -"Telegram_ОтправитьДокумент": "Telegram_SendDocument", -"ГТ_ЗаполнитьОчиститьЯчейки": "GT_FillClearCells", -"ДобавитьВидеообложкуТовара": "AddProductVideoCover", -"ЧислоСтандартныхПараметров": "NumberOfStandardParameters", -"ТекущийПуть, ТекущиеДанные": "CurrentPath, CurrentData", -"Проверка_ВККартинкаАльбома": "Check_VKAlbumPicture", -"URL к видео для добавления": "URL of the video", -"Телеграм_УстановитьWebhook": "TelegramAPI_SetWebhook", -"Получает комментарий по ID": "Gets comment by ID", -"ОбработатьТабуляциюСправки": "HandleHelpTabulation", -"ПоместитьФайлВКорзину (хук": "MarkFileAsDeleted (wh", -"Наименование подразделения": "Department name", +"Телеграм_ОтправитьДокумент": "TelegramAPI_SendDocument", +"Получить код подтверждения": "Get confirmation code", "Изменить свойства страницы": "Edit page properties", -"ОтправитьУведомлениеОВводе": "SendWritingNotification", -"ПолучитьПользователей (хук": "GetUsers (wh", -"МинимальныйРазмерДляПотока": "MinimumStreamSize", -"Bitrix24_ПереименоватьФайл": "Bitrix24_RenameFile", -"ID стены расположения поста": "ID of the wall where the post is located", -"Ноушн_ПолучитьПользователей": "Notion_GetUsers", -"Создает новое подразделение": "Creates a new department", -"ПолучитьСписокФайлов (Отбор": "GetFilesList (Filter", -"ПолучитьИнформациюОКаталоге": "GetFolderInformation", -"НастройкиСовместногоДоступа": "SharedAccessSettings", -"ЗащищенноеСоединениеOpenSSL": "OpenSSLSecureConnection", -"Разложить JSON на параметры": "Parse JSON to Parameters", -"Получить количество товаров": "Get products stocks", -"Bitrix24_УдалитьКомментарий": "Bitrix24_DeleteComment", -"ОтправитьГолосовоеСообщение": "SendVoice", -"ПолучитьСписокХранилищ (хук": "GetStoragesList (wh", -"Массив соответствий товаров": "Array of product maps", -"Получить комменатрий задачи": "Get task comment", -"Добавить комментарий задачи": "Add comment to task", -"Bitrix24_СоздатьКомментарий": "Bitrix24_CreateComment", -"Bitrix24_СкопироватьКаталог": "Bitrix24_MakeFolderCopy", -"Описание структур см. здесь": "Structure description at", -"Б24_УправленеПользователями": "B24_UsersManagment", -"Bitrix24_ПереместитьКаталог": "Bitrix24_MoveFolder", -"Изменить комментарий задачи": "Update task comment", +"ПолучитьИмяВременногоФайла": "GetTempFileName", +"Дата установки трудозатрат": "Date the record was set", +"ВывестиСообщениеИсключения": "DisplayExceptionMessage", +"Bitrix24_КопироватьКаталог": "Bitrix24_CopyFolder", +"Получить информацию канала": "Get channel info", +"Telegram_СоздатьТемуФорума": "Telegram_CreateForumTopic", +"Очищает значение в ячейках": "Clears the value in cells", +"Мне больше нравится желтый": "I like yellow more", +"ОдобритьЗаявкуНаВступление": "ApprovePending", +"ПолучитьИнформациюОТоварах": "GetProductsInformation", +"ЗагрузкаИОбновлениеТоваров": "UploadingAndUpdatingProducts", +"Сформировать блок картинку": "Generate image block", +"ИсключитьПользователейЧата": "RemoveChatMembers", +"ПолучитьПодразделения (хук": "GetDepartments (wh", +"ПреобразоватьПользователей": "ConvertUsers", +"Путь сохранения на Dropbox": "Save path on Dropbox", +"Отключить уведомления чата": "Disable chat notifications", +"Получить список календарей": "Get list of calendars", +"Создать/Архивировать канал": "Create/Archive channel", +"Получить информацию о чате": "Get information about the chat room", +"Добавляет товар в подборку": "Adds a product to the selection", +"Полужирный текст сообщения": "Bold text", +"ВывестиСправкуПоПараметрам": "DisplayParameterHelp", +"ЗагрузитьФайлВКаталог (хук": "UploadFileToFolder (wh", +"СлужебныеПроцедурыИФункции": "Private", +"Получить информацию о базе": "Get database info", +"СлужебныеПроцедурыИфункции": "ServiceProceduresAndFunctions", +"Вайбер_ПолучениеИнформации": "Viber_DataRetrieval", +"ДобавитьСтадиюКанбана (хук": "AddKanbanStage (wh", +"ОткрытьТемуФорума (главная": "OpenForumTopic (main", +"КраткоеПредставлениеОшибки": "BriefErrorRepresentation", +"ПолучитьРезультатОбработки": "GetProcessingResult", +"Документация Neocities API": "Neocities API docs", +"ЗаполнитьПоляЗапросаТовара": "FillProductRequestFields", +"VK_СоздатьТоварСоСвойством": "VK_CreateProductWithProp", +"Проверка_ТелеграмСообщение": "Check_TelegramMessage", +"Bitrix24_ВозобновитьЗадачу": "Bitrix24_RenewTask", +"Структура Из КлючИЗначение": "Structure of KeyAndValue", +"другие увед. будут удалены": "another notif. will be deleted", +"ПолучитьСтатусУчетаВремени": "GetTimekeepingStatus", +"ID оригинального сообщения": "Original message ID", +"Получить статистику постов": "Get post statistics", +"Bitrix24_СоздатьПодкаталог": "Bitrix24_CreateSubfolder", +"Telegram_ОтправитьКартинку": "Telegram_SendPicture", +"УдалитьПустыеКлючиЗначения": "RemoveEmptyKeyValues", +"Телеграм_ОтправитьКартинку": "TelegramAPI_SendImage", +"Если вам необходим чат-бот": "If you need a chatbot", +"ПолучитьСтадииКанбана (хук": "GetKanbanStages (wh", +"Telegram_УстановитьWebhook": "Telegram_SetWebhook", +"ИмяФайла, Вид + Расширение": "FileName, View + Extension", +"ИзменитьТрудозатратыЗадачи": "UpdateTaskTimeAccounting", +"СформироватьЗначенияВыбора": "FormSelectionValues", +"ПолучитьДанныеПользователя": "GetUserData", +"ПолучитьИнформациюОбУценке": "GetDiscountInformation", +"Dropbox_ПолчитьСписокТегов": "Dropbox_GetTagList", +"Отключает уведомлений чата": "Disable chat notifications", +"ПолучитьВнешнююСсылкуФайла": "GetFileExternalLink", +"ИзменитьСтадиюКанбана (хук": "UpdateKanbansStage (wh", +"Локальный каталог источник": "Local source catalog", +"массив URL картинок товара": "array of product images URLs", +"ПолучитьТрудозатратыЗадачи": "GetTaskTimeAccounting", +"Скрыть главную тему форума": "Hide main forum thread", +"СформироватьКнопкуДействия": "MakeActionButton", +"ПолучитьИсториюЗадачи (хук": "GetTaskHistory (wh", +"Структура из КлючИЗначение": "Structure of KeyAndValue", +"ДропБокс_СоздатьУдалитьТег": "DropboxAPI_CreateDeleteTag", +"Скопируйте новый **токен**": "Copy the new **token**", +"ИзменитьСтатусПользователя": "ChangeUserStatus", +"ПолучитьСсылкуНаСкачивание": "GetDownloadLink", +"ОтправитьСообщение (диалог": "SendMessage (dialog", +"Массив соответствий файлов": "Array of file mappings", +"Telegram_ОткрытьТемуФорума": "Telegram_OpenForumTopic", +"VK_СохранитьКартинкуВАльбом": "VK_SavePictureToAlbum", +"ЗаписатьБуферДвоичныхДанных": "WriteBinaryDataBuffer", +"ГК_ПолучитьСписокКалендарей": "GC_GetCalendarList", +"ИсключитьПользователяИзЧата": "DeleteUserFromChat", +"Telegram_ИзменитьТемуФорума": "Telegram_EditForumTopic", +"Очистить основной календарь": "Clear primary calendar", +"цена товара с учётом скидок": "product price with discounts", +"URL для перехода в браузере": "URL for browser transition", +"СформироватьОписаниеТаблицы": "GenerateTableDescription", +"Добавить календарь в список": "Add calendar to list", +"ПолучитьСтруктуруЦеныТовара": "GetProductPriceStructure", +"ID пользователя исполнителя": "ID of responsible user", +"ОчиститьКоллекциюРекурсивно": "ClearCollectionRecursively", +"Отправить/Удалить эфемерное": "Send/Delete ephemeral", +"Массив соответствий событий": "Array of event maps", +"ПолучитьОтложенныеСообщения": "GetScheduledMessages", +"ДобавитьПолучателейКНовости": "AddPostRecipients", +"Временная отметка сообщения": "Message timestamp", +"Получить информацию о файле": "Get information about file", +"Удалить календарь из списка": "Remove calendar from list", +"Добавить задачу в избранное": "Add task to favorites list", +"НачатьВыполнениеЗадачи (хук": "StartTask (wh", +"ДобавитьПараметрФлагКоманды": "AddCommandFlagParameter", +"Задача изменена, расходимся": "The task has been changed, let's split up", +"ОтклонитьЗаявкуНаВступление": "DisapprovePending", +"Код населенного пункта СДЭК": "CDEC locality code", +"Проверка_БитриксАвторизация": "Check_BitrixAuth", +"ПолучитьИнформациюОСтранице": "GetPageInfo", +"Убрать задачу из избранного": "Remove task from favorites list", +"Помечает новость как важную": "Mark post as important", +"Методы интеграции с VK (ОПИ": "VK integration methods (OPI", +"ПолучитьОнлайнПользователей": "GetOnlineUsers", +"разрешение на методы Sheets": "Sheets methods permission", +"ПреобразоватьЗначениеПоТипу": "ConvertValueByType", +"!OInt МБайт = КБайт * КБайт": "!OInt MB = KB * KB", +"Создает историю из картинки": "Creates a story from an image", +"ПолучитьСтатусЗагрузкиПоURL": "GetUploadStatusByURL", +"ПолучитьСписокВнешнихФайлов": "GetExternalFileList", +"СформироватьТестыАссертсCLI": "FormAssertsTestsCLI", +"ПолучитьСписокПользователей": "GetUserList", +"Поместить каталог в корзину": "Mark folder as deleted", +"СоздатьТвитГифки (одиночная": "CreateGifTweet (single", +"Dropbox_ПолучитьСписокТегов": "Dropbox_GetTagList", +"Эта база была создана из 1С": "This base is from 1C", +"ОтправитьДокумент (с именем": "SendDocument (with name", +"Новое наименование каталога": "New folders name", +"ЗаписатьПараметрыМультипарт": "WriteMultipartParameters", +"УправлениеЭлементомЧеклиста": "ChecklistElementManagment", +"Новый импортированный товар": "New imported product", +"Telegram_ПереслатьСообщение": "Telegram_ForwardMessage", +"Создать/Удалить кооментарий": "Create/Delete Comment", +"СформироватьМассивИменЯчеек": "FormCellNameArray", +"Создать/Удалить тему форума": "Create/Delete forum topic", +"НоушнАпи_СоздатьУдалитьБлок": "NotionAPI_CreateDeleteBlock", +"Получает информацию о файле": "Gets information about the file", +"Имя поля БД c обычным типом": "Name of field with regular type", +"ПолучитьСсылкуДляСкачивания": "GetDownloadLink", +"VK_СоздатьРекламнуюКампанию": "VK_CreateAdCampaign", +"Телеграм_ПолучитьОбновления": "TelegramAPI_GetUpdates", +"ID задачи добавления товара": "Add product task ID", +"Сохранить картинку в альбом": "Save image to album", +"ДобавитьПользователейКПапке": "AddUsersToFolder", +"Bitrix24_ДелегироватьЗадачу": "Bitrix24_DelegateTask", +"ДропБокс_ЗагрузитьФайлПоURL": "DropboxAPI_UploadFileByURL", +"ПолучитьСписокВерсийОбъекта": "GetObjectVersionList", +"Telegram_ОткрепитьСообщение": "Telegram_UnpinMessage", +"дата публикации комментария": "comment publication date", +"Оформить клиентский возврат": "Create customer refund", +"ИзменитьМетаданныеКалендаря": "EditCalendarMetadata", +"Создать каталог в хранилище": "Create folder at the storage", +"ПереслатьГолосовоеСообщение": "ResendVoice", +"ВК_СоздатьТоварСоСвойствами": "VKAPI_CreateProductWithProperties", +"Удаляет сообщение в диалоге": "Deletes a dialog message", +"Создать товар со свойствами": "Create product with properties", +"Начать наблюдать за задачей": "Start watching a task", +"Изменить наименование книги": "Change spreadsheet name", +"ВыгнатьПользователяИзКанала": "KickUserFromChannel", +"УправлениеПубличнымДоступом": "ManagePublicAccess", +"идентификатор соисполнителя": "co-executor identifier", +"Проверка_ДропБоксМетаданные": "Check_DropboxMetadata", +"Удалить трудозатраты задачи": "Delete task time accounting", +"ПолучитьИнформациюОбОбъекте": "GetObjectInformation", +"VK_ПолучитьСтатистикуПостов": "VK_GetPostStatistics", +"ОтветитьНаСобытиеКлавиатуры": "AnswerButtonEvent", +"ЗакрепитьОткрепитьСообщение": "PinUnpinMessage", "Отменить публикацию объекта": "Unpublish object", "Получить информацию о диске": "Get disk information", "Твиттер_СоздатьТвитСОпросом": "Twitter_CreateTweetWithPoll", @@ -4219,32 +4283,31 @@ "Telegram_ПолучитьОбновления": "Telegram_GetUpdates", "Отправить/Удалить сообщение": "Send/Delete message", "ID альбома, если необходимо": "Album ID, if necessary", +"Изменить комментарий задачи": "Update task comment", "Обновить изображения товара": "Update product images", +"Bitrix24_ПереместитьКаталог": "Bitrix24_MoveFolder", +"Описание структур см. здесь": "Structure description at", +"ID стены расположения поста": "ID of the wall where the post is located", +"Ноушн_ПолучитьПользователей": "Notion_GetUsers", +"Создает новое подразделение": "Creates a new department", +"ПолучитьСписокФайлов (Отбор": "GetFilesList (Filter", +"ПолучитьИнформациюОКаталоге": "GetFolderInformation", +"НастройкиСовместногоДоступа": "SharedAccessSettings", +"ЗащищенноеСоединениеOpenSSL": "OpenSSLSecureConnection", +"Разложить JSON на параметры": "Parse JSON to Parameters", +"Получить количество товаров": "Get products stocks", +"Bitrix24_УдалитьКомментарий": "Bitrix24_DeleteComment", +"Удаляет подразделение по ID": "Delets department by ID", +"ПолучитьСписокХранилищ (хук": "GetStoragesList (wh", +"Массив соответствий товаров": "Array of product maps", +"Получить комменатрий задачи": "Get task comment", +"Добавить комментарий задачи": "Add comment to task", +"Bitrix24_СоздатьКомментарий": "Bitrix24_CreateComment", +"Bitrix24_СкопироватьКаталог": "Bitrix24_MakeFolderCopy", +"Б24_УправленеПользователями": "B24_UsersManagment", "Telegram_ЗакрепитьСообщение": "Telegram_PinMessage", -"Bitrix24_ВключитьЗвукЗадачи": "Bitrix24_UnmuteTask", +"ОтправитьГолосовоеСообщение": "SendVoice", "Путь к файлу для скачивания": "Path to the file for downloading", -"ВК_ПолучитьСтатистикуПостов": "VKAPI_GetPostStatistics", -"Путь к публикуемому объекту": "Path to the object to be published", -"ОзонАПИ_ЦеныИОстаткиТоваров": "OzonAPI_PricesAndStocks", -"ПроверитьДоступКЗадаче (хук": "CheckTaskAccesses (wh", -"Телеграм_ПереслатьСообщение": "TelegramAPI_ForwardMessage", -"ID уведомления для удаления": "Notification ID", -"Включает уведомления в чате": "Enable chat notifications", -"ВК_ПолучитьКатегорииТоваров": "VKAPI_GetProductCategories", -"OPI получение данных тестов": "OPI test data retrieval", -"Проверка_ВКСтатистикаПостов": "Check_VKPostsStatistic", -"ПолучитьАдминистраторовЧата": "GetChatAdmins", -"Методы работы с Notion (ОПИ": "Notion methods (OPI", -"Получить план задач на день": "Get users daily tasks plan", -"ОтправитьТекстовоеСообщение": "SendTextMessage", -"Структура JSON данных ячеек": "The structure of the JSON cells data", -"СоздатьТвитВидео (одиночная": "CreateVideoTweet (single", -"НайтиЗначенияХарактеристики": "SearchAttributeValue", -"ПолучитьСодержимоеХранилища": "GetStorageObjects", -"Код со страницы авторизации": "Code from the authorization page", -"!OInt ВыполнитьСборкуМусора": "!OInt RunGarbageCollection", -"Проверка_БитриксКомментарий": "Check_BitrixComment", -"ПолучитьМетаданныеКалендаря": "GetCalendarMetadata", "Создет новое поле в таблице": "Creates a new field in the table", "ID целевой стены или группы": "ID of the target wall or group", "Получить пользователей чата": "Get chat members", @@ -4256,903 +4319,876 @@ "ДобавитьПользователейКФайлу": "AddUsersToFile", "ДополнитьКомплексныйАтрибут": "CompleteComplexAttribute", "Ключ > ID, Значение > Emoji": "Key > ID, Value > Emoji", -"Удалить картинку из альбома": "Deletes an image from the album", "ВК_СоздатьРекламнуюКампанию": "VKAPI_CreateAdCampaign", -"ОтветитьНаСобытиеКлавиатуры": "AnswerButtonEvent", "ОтправитьЭфемерноеСообщение": "SendEphemeralMessage", "ВернутьСтандартныеПараметры": "ReturnStandardParameters", "Тип отправляемого сообщения": "TypeOfSentMessage", "Обновить количество товаров": "Update products stocks", -"ЗакрепитьОткрепитьСообщение": "PinUnpinMessage", -"Удаляет подразделение по ID": "Delets department by ID", -"VK_ПолучитьСтатистикуПостов": "VK_GetPostStatistics", -"Создать/Удалить тему форума": "Create/Delete forum topic", -"НачатьВыполнениеЗадачи (хук": "StartTask (wh", -"ДобавитьПараметрФлагКоманды": "AddCommandFlagParameter", -"Задача изменена, расходимся": "The task has been changed, let's split up", -"ОтклонитьЗаявкуНаВступление": "DisapprovePending", -"Код населенного пункта СДЭК": "CDEC locality code", -"Проверка_БитриксАвторизация": "Check_BitrixAuth", -"ПолучитьИнформациюОСтранице": "GetPageInfo", -"Убрать задачу из избранного": "Remove task from favorites list", -"Помечает новость как важную": "Mark post as important", -"Методы интеграции с VK (ОПИ": "VK integration methods (OPI", -"ПолучитьОнлайнПользователей": "GetOnlineUsers", -"Удалить календарь из списка": "Remove calendar from list", -"разрешение на методы Sheets": "Sheets methods permission", -"ПреобразоватьЗначениеПоТипу": "ConvertValueByType", -"!OInt МБайт = КБайт * КБайт": "!OInt MB = KB * KB", -"Создает историю из картинки": "Creates a story from an image", -"ПолучитьСтатусЗагрузкиПоURL": "GetUploadStatusByURL", -"ПолучитьСписокВнешнихФайлов": "GetExternalFileList", -"Добавить задачу в избранное": "Add task to favorites list", -"СформироватьТестыАссертсCLI": "FormAssertsTestsCLI", -"Получить информацию о файле": "Get information about file", -"ПолучитьОтложенныеСообщения": "GetScheduledMessages", -"ИсключитьПользователяИзЧата": "DeleteUserFromChat", -"Telegram_ИзменитьТемуФорума": "Telegram_EditForumTopic", -"цена товара с учётом скидок": "product price with discounts", -"VK_СохранитьКартинкуВАльбом": "VK_SavePictureToAlbum", -"ЗаписатьБуферДвоичныхДанных": "WriteBinaryDataBuffer", -"Очистить основной календарь": "Clear primary calendar", -"URL для перехода в браузере": "URL for browser transition", -"Временная отметка сообщения": "Message timestamp", -"Добавить календарь в список": "Add calendar to list", -"ПолучитьСтруктуруЦеныТовара": "GetProductPriceStructure", -"ID пользователя исполнителя": "ID of responsible user", -"ОчиститьКоллекциюРекурсивно": "ClearCollectionRecursively", -"Отправить/Удалить эфемерное": "Send/Delete ephemeral", -"Массив соответствий событий": "Array of event maps", -"СформироватьОписаниеТаблицы": "GenerateTableDescription", -"ДобавитьПолучателейКНовости": "AddPostRecipients", -"ГК_ПолучитьСписокКалендарей": "GC_GetCalendarList", -"ПолучитьСписокПользователей": "GetUserList", -"ВК_СоздатьТоварСоСвойствами": "VKAPI_CreateProductWithProperties", -"СоздатьТвитГифки (одиночная": "CreateGifTweet (single", -"ДропБокс_ЗагрузитьФайлПоURL": "DropboxAPI_UploadFileByURL", -"ПолучитьСписокВерсийОбъекта": "GetObjectVersionList", -"Telegram_ОткрепитьСообщение": "Telegram_UnpinMessage", -"дата публикации комментария": "comment publication date", -"Оформить клиентский возврат": "Create customer refund", -"ИзменитьМетаданныеКалендаря": "EditCalendarMetadata", -"Создать каталог в хранилище": "Create folder at the storage", -"ПереслатьГолосовоеСообщение": "ResendVoice", -"Удаляет сообщение в диалоге": "Deletes a dialog message", -"ПолучитьИнформациюОбОбъекте": "GetObjectInformation", -"Создать товар со свойствами": "Create product with properties", -"Начать наблюдать за задачей": "Start watching a task", -"Изменить наименование книги": "Change spreadsheet name", -"ВыгнатьПользователяИзКанала": "KickUserFromChannel", -"УправлениеПубличнымДоступом": "ManagePublicAccess", -"идентификатор соисполнителя": "co-executor identifier", -"Проверка_ДропБоксМетаданные": "Check_DropboxMetadata", -"Удалить трудозатраты задачи": "Delete task time accounting", -"Bitrix24_ДелегироватьЗадачу": "Bitrix24_DelegateTask", -"ДобавитьПользователейКПапке": "AddUsersToFolder", -"Сохранить картинку в альбом": "Save image to album", -"ID задачи добавления товара": "Add product task ID", -"Dropbox_ПолучитьСписокТегов": "Dropbox_GetTagList", -"Эта база была создана из 1С": "This base is from 1C", -"ОтправитьДокумент (с именем": "SendDocument (with name", -"Новое наименование каталога": "New folders name", -"ЗаписатьПараметрыМультипарт": "WriteMultipartParameters", -"УправлениеЭлементомЧеклиста": "ChecklistElementManagment", -"Новый импортированный товар": "New imported product", -"Telegram_ПереслатьСообщение": "Telegram_ForwardMessage", -"Создать/Удалить кооментарий": "Create/Delete Comment", -"СформироватьМассивИменЯчеек": "FormCellNameArray", -"Поместить каталог в корзину": "Mark folder as deleted", -"НоушнАпи_СоздатьУдалитьБлок": "NotionAPI_CreateDeleteBlock", -"Получает информацию о файле": "Gets information about the file", -"Имя поля БД c обычным типом": "Name of field with regular type", -"ПолучитьСсылкуДляСкачивания": "GetDownloadLink", -"VK_СоздатьРекламнуюКампанию": "VK_CreateAdCampaign", -"Телеграм_ПолучитьОбновления": "TelegramAPI_GetUpdates", -"ПолучитьЗаголовокАвторизации": "GetAuthorizationHeader", -"Добавить трудозатраты задачи": "Add task time accounting", -"Загрузить/Удалить внеш. файл": "Upload/Delete external file", -"ID каталога размещения копии": "ID of copy destination folder", -"ПреобразоватьПараметрВСтроку": "ConvertParameterToString", -"Отправить группу медиафайлов": "Send media group", -"УстановитьСтатусПользователя": "SetUserStatus", -"Массив соответствий подборок": "Array of selection maps", -"ПолучитьСтандартныеПараметры": "GetStandardParameters", -"Массив сформированных кнопок": "Array of formed buttons", -"Добавить пользователей в чат": "Add users to chat", -"УдалитьСообщение (отложенное": "DeleteMessage (scheduled", -"ПолучитьДоступныеТоварыАкции": "GetAvailablePromoProducts", -"ID сообщения для закрепления": "ID of the message to be pinned", -"Получить трудозатраты задачи": "Get task time accounting", -"Получить список внеш. файлов": "Get external file list", -"ПолучитьСтруктуруКомментария": "GetCommentStructure", -"Получить статус пользователя": "Get user status", -"Новый текст пункта чек-листа": "New elements text", -"ПолучитьСтруктуруСделки (хук": "GetDealStructure (wh", -"Добавить комментарий новости": "Add comment to post", -"C:\\GDrive\\Мой диск\\data.json": "C:\\GDrive\\My Drive\\data.json", -"ГВ_ПолучитьСсылкуАвторизации": "GV_GetAuthorizationLink", -"Изменяет сообщение в диалоге": "Edit dialog message content", -"Добавляет новый лист в книгу": "Adds a new sheet to the spreadsheet", -"Изменить трудозатраты задачи": "Update task time accounting", -"ПолучитьНаборыЛокальныхПутей": "GetLocalPathsSets", -"Изменяет существующую задачу": "Update a task", -"Слак_ПолучитьИнформациюОБоте": "Slack_GetBotInfo", -"ГД_СоздатьУдалитьКомментарий": "GD_CreateDeleteComment", -"Bitrix24_ДобавитьФайлВЗадачу": "Bitrix24_AttachFileToTopic", -"Получить информацию о товаре": "Get product information", -"Другой комментарий к новости": "Another comment", -"Bitrix24_ПолучитьСписокЗадач": "Bitrix24_GetTasksList", -"HEX основного цвета (#ffffff": "HEX primary color (#ffffff", -"Изменить статус пользователя": "Change user status", -"ОтветитьНаЗаявкуНаВступление": "ResolvePending", -"Изменяет данные пользователя": "Updates user data", -"Тестовый товар (со свойством": "Test product (with prop", -"Проверка_ТелеграмМедиагруппа": "Check_TelegramMediaGroup", -"Добро пожаловать в новый чат": "Welcome to new chat", -"ПолучитьТекущегоПользователя": "GetCurrentUser", -"HEX цвет кнопок с # в начале": "HEX color of buttons with # at the beginning", -"ПереместитьФайлВКаталог (хук": "MoveFileToFolder (wh", -"УдалитьПустыеЭлементыМассива": "RemoveEmptyArrayElements", -"СледующаяВложенностьДоступна": "NextNestingAvailable", -"Получить каталог файлов чата": "Get chat files folder", -"ОтправитьСообщение (картинка": "SendMessage (picture", -"Новое наименование хранилища": "New storage name", -"Получить ссылку на сообщение": "Get message link", -"БитриксНастройкиУчетаВремени": "BitrixTimekeepingSettings", -"Получает информацию о канале": "Gets information about the channel", -"идентификатор ответственного": "responsible person identifier", -"УдалитьВариантСвойстваТовара": "DeleteProductPropertyVariant", -"Bitrix24_ДобавитьКомментарий": "Bitrix24_CreateComment", -"Методы работы с Twitter (ОПИ": "Twitter methods (OPI", -"JSON файлов или путь к .json": "File JSON or path to .json", -"ПодробноеПредставлениеОшибки": "DetailErrorDescription", -"Bitrix24_ВосстановитьКаталог": "Bitrix24_RestoreFolder", -"ПолучитьСписокАватаровФорума": "GetForumAvatarsList", -"УдалитьЗависимостьЗадач (хук": "DeleteTasksDependencies (wh", -"СоздатьЗависимостьЗадач (хук": "CreateTasksDependencies (wh", -"РаботаСМетаданнымиКалендарей": "CalendarMetadataManagement", -"ЗагрузитьФайлВХранилище (хук": "UploadFileToStorage (wh", -"ID сообщения для открепления": "ID of the message to be unpinned", -"Получить данные пользователя": "Get user data", -"Исключить пользователей чата": "Remove chat members", -"идентификатор рабочей группы": "workgroup identifier", -"Найти вкладку \"Работа с API\"": "Find the 'API usage' tab", -"ПрекратитьНаблюдатьЗаЗадачей": "StopWatchingTask", -"ЗагрузитьКодыАктивацииТовара": "UploadProductActivationCodes", -"Bitrix24_ПриостановитьЗадачу": "Bitrix24_PauseTask", -"ВключитьУведомленияЧата (хук": "EnableChatNotifications (wh", -"URL картинки иконки страницы": "URL of the page icon image", -"Скрыть/Показать главную тему": "Hide/Show main topic", -"УстановитьРеакциюНаСообщение": "SetMessageReaction", -"Получить информацию о канале": "Get channel information", -"страницу создания приложения": "app creation page", +"Bitrix24_ВключитьЗвукЗадачи": "Bitrix24_UnmuteTask", +"ПолучитьМетаданныеКалендаря": "GetCalendarMetadata", +"Проверка_БитриксКомментарий": "Check_BitrixComment", +"Удалить картинку из альбома": "Deletes an image from the album", +"Код со страницы авторизации": "Code from the authorization page", +"ВК_ПолучитьСтатистикуПостов": "VKAPI_GetPostStatistics", +"!OInt ВыполнитьСборкуМусора": "!OInt RunGarbageCollection", +"Путь к публикуемому объекту": "Path to the object to be published", +"ОзонАПИ_ЦеныИОстаткиТоваров": "OzonAPI_PricesAndStocks", +"Телеграм_ПереслатьСообщение": "TelegramAPI_ForwardMessage", +"ID уведомления для удаления": "Notification ID", +"Включает уведомления в чате": "Enable chat notifications", +"ВК_ПолучитьКатегорииТоваров": "VKAPI_GetProductCategories", +"OPI получение данных тестов": "OPI test data retrieval", +"ПроверитьДоступКЗадаче (хук": "CheckTaskAccesses (wh", +"ПолучитьАдминистраторовЧата": "GetChatAdmins", +"Методы работы с Notion (ОПИ": "Notion methods (OPI", +"Получить план задач на день": "Get users daily tasks plan", +"ОтправитьТекстовоеСообщение": "SendTextMessage", +"ПолучитьСодержимоеХранилища": "GetStorageObjects", +"Структура JSON данных ячеек": "The structure of the JSON cells data", +"СоздатьТвитВидео (одиночная": "CreateVideoTweet (single", +"Проверка_ВКСтатистикаПостов": "Check_VKPostsStatistic", +"НайтиЗначенияХарактеристики": "SearchAttributeValue", "признак доступен для всех (Y": "feature is available for all (Y", "УдалитьЭлементЧеклистаЗадачи": "DeleteTasksChecklistElement", "Работа с польз. полями задач": "Working with custom task fields", "СоздатьСсылкуПолученияТокена": "CreateTokenRetrievalLink", "Получить список файлов папки": "Get list of folder files", -"Показать главную тему форума": "Show main forum thread", -"Твиттер_СоздатьТекстовыйТвит": "Twitter_CreateTextTweet", "Идентификатор/артикул товара": "Product ID/article", +"Твиттер_СоздатьТекстовыйТвит": "Twitter_CreateTextTweet", "массив обновляемых атрибутов": "array of updatable attributes", "Получить список комментариев": "Get list of comments", +"страницу создания приложения": "app creation page", "ИзменитьИмяГлавнойТемыФорума": "EditMainForumTopicName", -"Добавляет новый внешний файл": "Adds a new external file", -"ПолучитьСтруктуруЗадачи (хук": "GetTaskFieldsStructure (wh", -"Аватар чата в base64 формате": "Base64 chat picture", -"Создает новую таблицу в базе": "Creates a new table in the base", -"ПреобразоватьBase64ВДвоичные": "ConvertBase64ToBinary", -"Получает описание поля с URL": "Gets the description of a URL field", -"Время ожидания новых событий": "Waiting time for new events", -"Изменяет существующую сделку": "Modifies an existing deal", -"ПолучитьИнформациюОбАккаунте": "GetAccountInformation", -"Проверка_ТелеграмПриглашение": "Check_TelegramInvitation", -"НоушнАпи_СоздатьИзменитьБазу": "NotionAPI_CreateUpdateBase", -"Наименование нового каталога": "Name of new folder", -"ПолучитьПланЗадачНаДень (хук": "GetDailyPlan (wh", -"Б24_УправлениеПользователями": "B2_UsersManagment", -"CommonModule.OPI_Инструменты": "CommonModule.OPI_Tools", -"Создать рекламное объявление": "Create advertising post", -"Сформировать кнопку действия": "Make action button", -"Добавить видеообложку товара": "Add product video cover", -"Объявленная стоимость товара": "Declared product price", -"Новый массив блоков вложений": "New blocks array", -"Восстановить объект к версии": "Restore object to version", -"ПолучитьСписокИконокАватаров": "GetAvatarIconList", -"ПолучитьСоответствиеКартинки": "GetImageMap", -"JSON массива описаний блоков": "JSON array of block descriptions", -"Проверка_БитриксНеопределено": "Check_BitrixUndefined", -"Скрывает главную тему форума": "Hides the main forum thread", -"Эти токены обновлять не надо": "These tokens do not need to be updated", -"ПолучитьСписокОпубликованных": "GetPublishedList", -"Обсуждаем: какой цвет лучше?": "Discussing: Which color is better?", -"Создает комментарий к задаче": "Create new comment to the task", -"Bitrix24_ОтключитьЗвукЗадачи": "Bitrix24_MuteTask", +"Показать главную тему форума": "Show main forum thread", +"Получить информацию о канале": "Get channel information", +"Найти вкладку \"Работа с API\"": "Find the 'API usage' tab", +"Скрыть/Показать главную тему": "Hide/Show main topic", +"URL картинки иконки страницы": "URL of the page icon image", +"ВключитьУведомленияЧата (хук": "EnableChatNotifications (wh", +"Bitrix24_ПриостановитьЗадачу": "Bitrix24_PauseTask", "Затраченное время в секундах": "Time spent in seconds", -"Получает структуру полей чата": "Get chat fields structure", -"Отправить голосовое сообщение": "Send voice", -"Получить администраторов чата": "Get chat admins", -"Отправить текстовое сообщение": "Send text message", -"ПолучитьЗапросыВступленияЧата": "GetChatJoinRequests", -"Имя пользователя (опционально": "Users name (optional", -"Отбор по ID каталога родителя": "Filter by parent directory ID", -"ПолучитьТелоКакДвоичныеДанные": "GetBodyAsBinaryData", -"Структура JSON данных объекта": "The structure of the JSON object data", -"VK_СоздатьРекламноеОбъявление": "VK_CreateAd", -"Твиттер_СоздатьТвитСКартинкой": "Twitter_CreateTweetWithImage", -"УбратьЗадачуИзИзбранного (хук": "RemoveTaskFromFavorites (wh", -"Получить хранилище приложения": "Get storage for application data", -"ЗаблокироватьПользователяЧата": "BlockChatUser", -"Получить информацию о товарах": "Get products informations", -"Проверка_ВКИнформацияОТоварах": "Check_VKProductData", -"Получить список пользователей": "Get user list", -"Изменяет существующее событие": "Edits an existing event", -"Создает твит с видеовложением": "Creates a tweet with a video attachment", -"ПолучитьКонтентРейтингТоваров": "GetProductsContentRating", -"ПригласитьПользователейВКанал": "InviteUsersToChannel", -"Уникальный идентификатор ФИАС": "Unique FIAS identifier", -"Telegram_ОтправитьМеидагруппу": "Telegram_SendMediaGroup", -"ДобавитьЗадачуВИзбранное (хук": "StopWatchingTask (wh", -"ПолучитьНастройкиУчетаВремени": "GetTimekeepingSettings", -"Переслать голосовое сообщение": "Resend voice", -"Описания полей в документации": "Field descriptions in the documentation", -"Получает список доступных баз": "Gets the list of available bases", -"ID подразделения для удаления": "Department ID for deletion", -"СформироватьМассивДанныхЯчеек": "FormCellDataArray", -"Проверка_ВКИНформацияОТоварах": "Check_VKProductData", -"ПриостановитьУчетВремени (хук": "StopTimekeeping (wh", -"разрешение на методы Calendar": "Calendar methods permission", -"CommonModule.OPI_Криптография": "CommonModule.OPI_Cryptography", -"Альтернативный текст картинки": "Alternate text of the image", -"Соответствие Из КлючИЗначение": "Map Of KeyAndValue", -"Ошибка в данных описания поля": "Error in field description data", -"ПолучитьСтатусДобавленияКодов": "GetCodesUploadStatus", -"Получить информацию об уценке": "Get discount information", -"**Открытый пакет интеграций**": "**Open Integrations Package**", -"От лица группы. Должен быть 1": "On behalf of the group. It should be set to 1", -"ОтключитьУведомленияЧата (хук": "DisableChatNotifications (wh", -"ПолучитьСтруктуруФильтраЗадач": "GetTasksFilterStructure", -"Ноушн_ПолучитьИнформациюОБазе": "Notion_GetDatabaseInfo", -"Получить данные о базе данных": "Get database information", -"Создать системное уведомление": "Create system notification", -"ПоместитьКаталогВКорзину (хук": "MarkFolderAsDeleted (wh", -"УдалитьРезультатИзКомментария": "DeleteResultFromComment", -"Приостанавливает задачу по ID": "Pause a task by ID", -"ПолучитьИнформациюОФайле (хук": "GetFileInformation (wh", -"ПолучитьЛимитыРаботыСТоварами": "GetProductsRequestsLimits", -"Удаляет внешний файл из Slack": "Deletes an external file from Slack", -"URL картинки обложки страницы": "URL of the page cover image", -"ID пользователя для изменения": "User ID", -"Отправить уведомление о вводе": "Send write notification", -"ИзменитьВариантСвойстваТовара": "EditProductPropertyVariant", -"Отправить эфемерное сообщение": "Send ephemeral message", -"Удаляет ранее созданный товар": "Deletes a previously created product", -"Массив соответствий каталогов": "Array of directory mappings", -"ПолучитьСтурктуруПользователя": "GetUserFieldsStructure", -"СлужебныйПрограммныйИнтерфейс": "Internal", -"Б24_УправлениеПодразделениями": "B24_DepartmentsManagment", -"СоздатьЗаголовокАвторизацииV1": "CreateAuthorizationHeaderV1", -"Получить статистику по постам": "Get post statistics", -"ID товаров для восстановления": "Product IDs for recovery", -"ID руководителя подразделения": "ID of department manager", -"Добавить пользователя к файлу": "Add user to file", -"Набор изменяемых полей заказа": "Set of changing order fields", -"ИзменитьЭлементЧеклистаЗадачи": "UpdateTasksChecklistElement", -"ID каталога нового размещения": "ID of new destination folder", -"ID блока или сам блок образец": "Block ID or block sample itself", -"Закрывает существующий диалог": "Closes an existing dialog", -"Создает новую новость в ленте": "Create a new post at news feed", -"Получить ссылку на скачивание": "Get download link", +"ЗагрузитьКодыАктивацииТовара": "UploadProductActivationCodes", +"ПрекратитьНаблюдатьЗаЗадачей": "StopWatchingTask", +"идентификатор рабочей группы": "workgroup identifier", +"Исключить пользователей чата": "Remove chat members", +"Получить данные пользователя": "Get user data", +"ID сообщения для открепления": "ID of the message to be unpinned", +"ЗагрузитьФайлВХранилище (хук": "UploadFileToStorage (wh", +"Добавляет новый внешний файл": "Adds a new external file", +"УстановитьРеакциюНаСообщение": "SetMessageReaction", +"ПолучитьСтруктуруЗадачи (хук": "GetTaskFieldsStructure (wh", +"ПолучитьСписокИконокАватаров": "GetAvatarIconList", +"Создает новую таблицу в базе": "Creates a new table in the base", +"РаботаСМетаданнымиКалендарей": "CalendarMetadataManagement", +"Bitrix24_ОтключитьЗвукЗадачи": "Bitrix24_MuteTask", +"Создает комментарий к задаче": "Create new comment to the task", +"Обсуждаем: какой цвет лучше?": "Discussing: Which color is better?", +"ПолучитьСписокОпубликованных": "GetPublishedList", +"Эти токены обновлять не надо": "These tokens do not need to be updated", +"Скрывает главную тему форума": "Hides the main forum thread", +"Проверка_БитриксНеопределено": "Check_BitrixUndefined", +"JSON массива описаний блоков": "JSON array of block descriptions", +"ПолучитьСоответствиеКартинки": "GetImageMap", +"Восстановить объект к версии": "Restore object to version", +"Новый массив блоков вложений": "New blocks array", +"Объявленная стоимость товара": "Declared product price", +"Добавить видеообложку товара": "Add product video cover", +"Сформировать кнопку действия": "Make action button", +"Создать рекламное объявление": "Create advertising post", +"CommonModule.OPI_Инструменты": "CommonModule.OPI_Tools", +"Б24_УправлениеПользователями": "B2_UsersManagment", +"ПолучитьПланЗадачНаДень (хук": "GetDailyPlan (wh", +"Наименование нового каталога": "Name of new folder", +"НоушнАпи_СоздатьИзменитьБазу": "NotionAPI_CreateUpdateBase", +"Проверка_ТелеграмПриглашение": "Check_TelegramInvitation", +"ПолучитьИнформациюОбАккаунте": "GetAccountInformation", +"Изменяет существующую сделку": "Modifies an existing deal", +"Время ожидания новых событий": "Waiting time for new events", +"Получает описание поля с URL": "Gets the description of a URL field", +"ПреобразоватьBase64ВДвоичные": "ConvertBase64ToBinary", +"Аватар чата в base64 формате": "Base64 chat picture", +"СоздатьЗависимостьЗадач (хук": "CreateTasksDependencies (wh", +"Получить ссылку на сообщение": "Get message link", +"ПолучитьСписокАватаровФорума": "GetForumAvatarsList", +"ПолучитьНаборыЛокальныхПутей": "GetLocalPathsSets", +"Изменить трудозатраты задачи": "Update task time accounting", +"Добавляет новый лист в книгу": "Adds a new sheet to the spreadsheet", +"Изменяет сообщение в диалоге": "Edit dialog message content", +"ГВ_ПолучитьСсылкуАвторизации": "GV_GetAuthorizationLink", +"C:\\GDrive\\Мой диск\\data.json": "C:\\GDrive\\My Drive\\data.json", +"Добавить комментарий новости": "Add comment to post", +"ПолучитьСтруктуруСделки (хук": "GetDealStructure (wh", +"Новый текст пункта чек-листа": "New elements text", +"Получить статус пользователя": "Get user status", +"ПолучитьСтруктуруКомментария": "GetCommentStructure", +"Получить список внеш. файлов": "Get external file list", +"Получить трудозатраты задачи": "Get task time accounting", +"ID сообщения для закрепления": "ID of the message to be pinned", +"ПолучитьДоступныеТоварыАкции": "GetAvailablePromoProducts", +"УдалитьСообщение (отложенное": "DeleteMessage (scheduled", +"Добавить пользователей в чат": "Add users to chat", +"Массив сформированных кнопок": "Array of formed buttons", +"ПолучитьСтандартныеПараметры": "GetStandardParameters", +"Массив соответствий подборок": "Array of selection maps", +"УстановитьСтатусПользователя": "SetUserStatus", +"Отправить группу медиафайлов": "Send media group", +"ПреобразоватьПараметрВСтроку": "ConvertParameterToString", +"ID каталога размещения копии": "ID of copy destination folder", +"Загрузить/Удалить внеш. файл": "Upload/Delete external file", +"Добавить трудозатраты задачи": "Add task time accounting", +"УдалитьЗависимостьЗадач (хук": "DeleteTasksDependencies (wh", +"Изменяет существующую задачу": "Update a task", +"Слак_ПолучитьИнформациюОБоте": "Slack_GetBotInfo", +"ПолучитьЗаголовокАвторизации": "GetAuthorizationHeader", +"Bitrix24_ДобавитьФайлВЗадачу": "Bitrix24_AttachFileToTopic", +"Bitrix24_ВосстановитьКаталог": "Bitrix24_RestoreFolder", +"ПодробноеПредставлениеОшибки": "DetailErrorDescription", +"JSON файлов или путь к .json": "File JSON or path to .json", +"Методы работы с Twitter (ОПИ": "Twitter methods (OPI", +"Bitrix24_ДобавитьКомментарий": "Bitrix24_CreateComment", +"УдалитьВариантСвойстваТовара": "DeleteProductPropertyVariant", +"идентификатор ответственного": "responsible person identifier", +"ГД_СоздатьУдалитьКомментарий": "GD_CreateDeleteComment", +"БитриксНастройкиУчетаВремени": "BitrixTimekeepingSettings", +"Новое наименование хранилища": "New storage name", +"ОтправитьСообщение (картинка": "SendMessage (picture", +"Получить каталог файлов чата": "Get chat files folder", +"СледующаяВложенностьДоступна": "NextNestingAvailable", +"Получает информацию о канале": "Gets information about the channel", +"ПереместитьФайлВКаталог (хук": "MoveFileToFolder (wh", +"Получить информацию о товаре": "Get product information", +"УдалитьПустыеЭлементыМассива": "RemoveEmptyArrayElements", +"Другой комментарий к новости": "Another comment", +"Bitrix24_ПолучитьСписокЗадач": "Bitrix24_GetTasksList", +"Изменить статус пользователя": "Change user status", +"ОтветитьНаЗаявкуНаВступление": "ResolvePending", +"HEX основного цвета (#ffffff": "HEX primary color (#ffffff", +"Тестовый товар (со свойством": "Test product (with prop", +"Проверка_ТелеграмМедиагруппа": "Check_TelegramMediaGroup", +"Добро пожаловать в новый чат": "Welcome to new chat", +"ПолучитьТекущегоПользователя": "GetCurrentUser", +"HEX цвет кнопок с # в начале": "HEX color of buttons with # at the beginning", +"Изменяет данные пользователя": "Updates user data", +"ID Файла голосового сообщения": "File ID of voice message", "СоздатьКаталогВХранилище (хук": "CreateStorageFolder (wh", "Проверка_ДропбоксПространство": "Check_DropboxSpace", "ID подборки, если нужен отбор": "Selection ID, if filtering is needed", -"ID Файла голосового сообщения": "File ID of voice message", "ДобавитьЭлементЧеклистаЗадачи": "AddTasksChecklistElement", -"ДобавитьВариантСвойстваТовара": "AddProductPropertyVariant", +"Получить содержимое хранилища": "Get a list of child storage objects", "Изменяет картинку аватар чата": "Changes the chat avatar picture", "ПолучитьВнешнююСсылкуКаталога": "GetFolderExternalLink", "Мобильные телефоны и планшеты": "Mobile phones and tablets", "Проверка_ТелеграмСозданиеТемы": "Check_TelegramCreateTopic", -"Получить содержимое хранилища": "Get a list of child storage objects", +"ДобавитьВариантСвойстваТовара": "AddProductPropertyVariant", +"Получить ссылку на скачивание": "Get download link", +"СлужебныйПрограммныйИнтерфейс": "Internal", +"Закрывает существующий диалог": "Closes an existing dialog", +"ID блока или сам блок образец": "Block ID or block sample itself", +"ID каталога нового размещения": "ID of new destination folder", +"ИзменитьЭлементЧеклистаЗадачи": "UpdateTasksChecklistElement", +"Набор изменяемых полей заказа": "Set of changing order fields", +"Добавить пользователя к файлу": "Add user to file", +"ID руководителя подразделения": "ID of department manager", +"ID товаров для восстановления": "Product IDs for recovery", +"Получить статистику по постам": "Get post statistics", +"СоздатьЗаголовокАвторизацииV1": "CreateAuthorizationHeaderV1", +"Б24_УправлениеПодразделениями": "B24_DepartmentsManagment", "Bitrix24_ПереименоватьКаталог": "Bitrix24_RenameFolder", +"Создает новую новость в ленте": "Create a new post at news feed", "ОбновитьХарактеристикиТоваров": "UpdateProductsAttributes", -"Закрепить/Открепить сообщение": "Pin/Unpin message", -"Получить отложенные сообщения": "Get scheduled messages", -"Получить статус учета времени": "Get timekeeping status", -"ПеренестиЗадачуВСтадиюКанбана": "MoveTaskToKanbanStage", -"Структура JSON данных события": "The structure of the JSON event data", -"app_id из настроек приложения": "app_id from application settings", -"Телеграм_ОтправитьМедиагруппу": "TelegramAPI_SendMediaGroup", -"ПолучитьСписокРабочихОбластей": "GetWorkspaceList", -"Дополнить комплексный атрибут": "Complete the complex attribute", -"СоздатьРезультатИзКомментария": "CreateResultFromComment", -"Загрузка и обновление товаров": "Uploading and updating products", -"Email для оповещений RFC 2822": "Email for alerts as RFC 2822", -"Соответствие из КлючИЗначение": "Map of KeyAndValue", -"НачатьНаблюдатьЗаЗадачей (хук": "StartWatchingTask (wh", "Получить внешнюю ссылку файла": "Get external link for a file", -"ПараметрыЗапросаВСоответствие": "RequestParametersToMap", -"Отправляет сообщение в диалог": "Send message to dialog", -"JSON описание товара или путь": "JSON description of the product or path", -"Найти значения характеристики": "Search attribute value", -"ПолучитьСтруктуруФильтраЛидов": "GetLeadFilterStructure", -"ПолучитьЭлементЧеклистаЗадачи": "GetTasksChecklistElement", -"Изменяет текст заголовка чата": "Change text of chat title", -"ID пользователя для получения": "User ID", -"УдалитьКомментарийЗадачи (хук": "DeleteTaskComment (wh", -"Слак_СоздатьАрхивироватьКанал": "Slack_CreateArchiveChannel", -"СоздатьЗаголовокАвторизацииV2": "CreateAuthorizationHeaderV2", -"Одобрить заявку на вступление": "Approve pending", +"Получить отложенные сообщения": "Get scheduled messages", +"ПолучитьСтурктуруПользователя": "GetUserFieldsStructure", "Получить онлайн пользователей": "Get online users", -"Слак_ОтправитьУдалитьЭфемерное": "Slack_SendDeleteEphemeral", -"ID чата для отправки сообщения": "Chat ID for message sending", -"ЗаполнитьПараметрыЗагрузкиФото": "FillPhotoUploadParameters", -"ПолучитьКаталогФайловЧата (хук": "GetChatFilesFolder", -"Дополнительный текст сообщения": "Additional message text", -"Текст комментария трудозатраты": "Comment text", -"Отметить пункт как выполненный": "Mark as completed", -"ПолучитьСтатусДобавленияТовара": "GetProductCreationStatus", -"Удаляет ранее созданный альбом": "Deletes a previously created album", -"УдалитьТрудозатратыЗадачи (хук": "DeleteTaskTimeAccounting (wh", -"Один или несколько SKU товаров": "One or array of SKUs", -"УдалитьУведомление (приложение": "DeleteNotification (app", -"ЯДиск_ПолучитьИнформациюОДиске": "YDisk_GetDiskInfo", -"Копирует один каталог в другой": "Copy one folder to another", -"СохранитьПубличныйОбъектНаДиск": "SavePublicObjectToDisk", -"Получить структуру цены товара": "Get product price structure", -"СохранитьКартинкуВАльбом (путь": "SavePictureToAlbum (path", -"ПолучитьДвоичныеДанныеИзСтроки": "GetBinaryDataFromString", -"ВыполнитьЭлементЧеклистаЗадачи": "CompleteTasksChecklistElement", -"Получить текущего пользователя": "Get current user", +"Одобрить заявку на вступление": "Approve pending", +"СоздатьЗаголовокАвторизацииV2": "CreateAuthorizationHeaderV2", +"Слак_СоздатьАрхивироватьКанал": "Slack_CreateArchiveChannel", +"УдалитьКомментарийЗадачи (хук": "DeleteTaskComment (wh", +"ID пользователя для получения": "User ID", +"Изменяет текст заголовка чата": "Change text of chat title", +"ПолучитьЭлементЧеклистаЗадачи": "GetTasksChecklistElement", +"ПолучитьСтруктуруФильтраЛидов": "GetLeadFilterStructure", +"Найти значения характеристики": "Search attribute value", +"JSON описание товара или путь": "JSON description of the product or path", +"Закрепить/Открепить сообщение": "Pin/Unpin message", +"Отправляет сообщение в диалог": "Send message to dialog", +"НачатьНаблюдатьЗаЗадачей (хук": "StartWatchingTask (wh", +"Соответствие из КлючИЗначение": "Map of KeyAndValue", +"Email для оповещений RFC 2822": "Email for alerts as RFC 2822", +"Загрузка и обновление товаров": "Uploading and updating products", +"СоздатьРезультатИзКомментария": "CreateResultFromComment", +"Дополнить комплексный атрибут": "Complete the complex attribute", +"ПолучитьСписокРабочихОбластей": "GetWorkspaceList", +"Телеграм_ОтправитьМедиагруппу": "TelegramAPI_SendMediaGroup", +"app_id из настроек приложения": "app_id from application settings", +"Структура JSON данных события": "The structure of the JSON event data", +"ПеренестиЗадачуВСтадиюКанбана": "MoveTaskToKanbanStage", +"Получить статус учета времени": "Get timekeeping status", +"ПараметрыЗапросаВСоответствие": "RequestParametersToMap", +"Массив соответствий каталогов": "Array of directory mappings", +"Удаляет внешний файл из Slack": "Deletes an external file from Slack", +"Отправить эфемерное сообщение": "Send ephemeral message", +"Переслать голосовое сообщение": "Resend voice", +"ПолучитьНастройкиУчетаВремени": "GetTimekeepingSettings", +"ДобавитьЗадачуВИзбранное (хук": "StopWatchingTask (wh", +"Telegram_ОтправитьМеидагруппу": "Telegram_SendMediaGroup", +"Уникальный идентификатор ФИАС": "Unique FIAS identifier", +"ПригласитьПользователейВКанал": "InviteUsersToChannel", +"ПолучитьКонтентРейтингТоваров": "GetProductsContentRating", +"Создает твит с видеовложением": "Creates a tweet with a video attachment", +"Изменяет существующее событие": "Edits an existing event", +"Получить список пользователей": "Get user list", +"Проверка_ВКИнформацияОТоварах": "Check_VKProductData", +"Получить информацию о товарах": "Get products informations", +"Описания полей в документации": "Field descriptions in the documentation", +"ЗаблокироватьПользователяЧата": "BlockChatUser", +"УбратьЗадачуИзИзбранного (хук": "RemoveTaskFromFavorites (wh", +"Твиттер_СоздатьТвитСКартинкой": "Twitter_CreateTweetWithImage", +"VK_СоздатьРекламноеОбъявление": "VK_CreateAd", +"Структура JSON данных объекта": "The structure of the JSON object data", +"ПолучитьТелоКакДвоичныеДанные": "GetBodyAsBinaryData", +"Отбор по ID каталога родителя": "Filter by parent directory ID", +"Имя пользователя (опционально": "Users name (optional", +"Удаляет ранее созданный товар": "Deletes a previously created product", +"Отправить текстовое сообщение": "Send text message", +"Получить администраторов чата": "Get chat admins", +"Отправить голосовое сообщение": "Send voice", +"Получает структуру полей чата": "Get chat fields structure", +"Получить хранилище приложения": "Get storage for application data", +"Получает список доступных баз": "Gets the list of available bases", +"ПолучитьЗапросыВступленияЧата": "GetChatJoinRequests", +"СформироватьМассивДанныхЯчеек": "FormCellDataArray", +"ID подразделения для удаления": "Department ID for deletion", +"ИзменитьВариантСвойстваТовара": "EditProductPropertyVariant", +"Отправить уведомление о вводе": "Send write notification", +"URL картинки обложки страницы": "URL of the page cover image", +"ПолучитьЛимитыРаботыСТоварами": "GetProductsRequestsLimits", +"ПолучитьИнформациюОФайле (хук": "GetFileInformation (wh", +"Приостанавливает задачу по ID": "Pause a task by ID", +"УдалитьРезультатИзКомментария": "DeleteResultFromComment", +"ПоместитьКаталогВКорзину (хук": "MarkFolderAsDeleted (wh", +"Создать системное уведомление": "Create system notification", +"Получить данные о базе данных": "Get database information", +"Ноушн_ПолучитьИнформациюОБазе": "Notion_GetDatabaseInfo", +"ID пользователя для изменения": "User ID", +"ОтключитьУведомленияЧата (хук": "DisableChatNotifications (wh", +"ПолучитьСтруктуруФильтраЗадач": "GetTasksFilterStructure", +"ПриостановитьУчетВремени (хук": "StopTimekeeping (wh", +"CommonModule.OPI_Криптография": "CommonModule.OPI_Cryptography", +"Альтернативный текст картинки": "Alternate text of the image", +"Соответствие Из КлючИЗначение": "Map Of KeyAndValue", +"разрешение на методы Calendar": "Calendar methods permission", +"ПолучитьСтатусДобавленияКодов": "GetCodesUploadStatus", +"Получить информацию об уценке": "Get discount information", +"**Открытый пакет интеграций**": "**Open Integrations Package**", +"От лица группы. Должен быть 1": "On behalf of the group. It should be set to 1", +"Ошибка в данных описания поля": "Error in field description data", +"Проверка_ВКИНформацияОТоварах": "Check_VKProductData", +"ДропБокс_ПолучитьОбновитьТокен": "DropboxAPI_GetUpdateToken", +"ПолучитьОписаниеЗаказа (Пустая": "GetOrderDescription (Empty", +"Идентификатор записи в таблице": "Record identifier in the table", +"ИзменитьКомментарийЗадачи (хук": "UpdateTaskComment (wh", +"Получить список опубликованных": "Get published list", +"Исключить пользователя из чата": "Delete user from chat", +"Имя поля БД с выбором значения": "Name of field with a value selection", +"Получить описание файла !NOCLI": "Get file description !NOCLI", +"РазблокироватьПользователяЧата": "UnblockChatUser", +"ОтправитьМестоположение (канал": "SendLocation (channel", +"Ответить на событие клавиатуры": "Answer button event", +"Нельзя замешивать разные типы!": "Different types cannot be mixed!", +"МаксимальныйУровеньВложенности": "MaximumNestingLevel", +"ПолучитьЗначенияХарактеристики": "GetAttributeValues", +"Получить список внешних файлов": "Get list of external files", +"ПолучитьСписокТегов (одиночный": "GetTagList (single", +"Добавить получателей к новости": "Add new recipients to a post", +"file\"\" + ИспользуемоеИмя, Файл": "file\"\" + DisplayedName, File", +"ДобавитьПользователейВЧат (хук": "AddUsersToChat (wh", +"Bitrix24_ПолучитьИсториюЗадачи": "Bitrix24_GetTaskHistory", +"Методы интеграции с Viber (ОПИ": "Viber integration methods (OPI", +"Путь или набору путей к файлам": "Path or set of paths to the files", +"НоушнАпи_ПолучитьПользователей": "NotionAPI_GetUsers", +"Получить список версий объекта": "Get list of object versions", +"Получает информацию о каталоге": "Get folder information", +"Идентификатор удаляемого листа": "IdentifierOfSheetToDelete", +"Добавить пользователей к папке": "Add users to folder", +"Параметр дополнительной услуги": "Additional service parameter", +"Создать/Удалить составной пост": "Create/Delete composite post", +"КоличествоПараметров - 1 Тогда": "NumberOfParameters - 1 Then", +"Структура JSON данных страницы": "The structure of the JSON page data", +"Проверка_БитриксМассивОбъектов": "Check_BitrixObjectsArray", +"СоздатьПерсональноеУведомление": "CreatePersonalNotification", +"Идентификатор удаляемого файла": "ID of removing file", +"Структура, Массив из Структура": "Structure, Array of Structure", +"Проверка_БитриксМассивНовостей": "Check_BitrixPostsArray", +"Получить информацию об объекте": "Get object information", +"Идентификатор клиента (Account": "Client identifier (Account", +"Получить список сообщений чата": "Get chat messages list", +"Получить информацию о странице": "Get page info", +"ДобавитьКомментарийЗадачи (хук": "AddTaskComment (wh", +"file|\" + ИспользуемоеИмя, Файл": "file|\" + DisplayedName, File", +"Добавить пользователей к файлу": "Add users to file", +"ПолучитьСписокРезультатов (хук": "GetResultsList (wh", +"JSON описания или путь к .json": "JSON description or path to .json", +"Получить информацию о каталоге": "Get information about folder", +"ПолучитьСтрокуИзДвоичныхДанных": "GetStringFromBinaryData", +"Удаляет файл или каталог по ID": "Deletes file or directory by ID", +"Целевой путь создания каталога": "Target path for creating the directory", +"Выгнать пользователя из канала": "Kick user from channel", +"Bitrix24_ЗагрузитьФайлВКаталог": "Bitrix24_UploadFileToFolder", "тип: employee, extranet, email": "type: employee, extranet, email", +"Получить текущего пользователя": "Get current user", +"ВыполнитьЭлементЧеклистаЗадачи": "CompleteTasksChecklistElement", +"ПолучитьДвоичныеДанныеИзСтроки": "GetBinaryDataFromString", +"СохранитьКартинкуВАльбом (путь": "SavePictureToAlbum (path", +"Получить структуру цены товара": "Get product price structure", +"СохранитьПубличныйОбъектНаДиск": "SavePublicObjectToDisk", +"Копирует один каталог в другой": "Copy one folder to another", +"ЯДиск_ПолучитьИнформациюОДиске": "YDisk_GetDiskInfo", +"Один или несколько SKU товаров": "One or array of SKUs", +"УдалитьТрудозатратыЗадачи (хук": "DeleteTaskTimeAccounting (wh", +"Удаляет ранее созданный альбом": "Deletes a previously created album", +"ПолучитьСтатусДобавленияТовара": "GetProductCreationStatus", +"Отметить пункт как выполненный": "Mark as completed", +"Текст комментария трудозатраты": "Comment text", +"Дополнительный текст сообщения": "Additional message text", +"ПолучитьКаталогФайловЧата (хук": "GetChatFilesFolder", +"ЗаполнитьПараметрыЗагрузкиФото": "FillPhotoUploadParameters", +"ID чата для отправки сообщения": "Chat ID for message sending", +"Слак_ОтправитьУдалитьЭфемерное": "Slack_SendDeleteEphemeral", +"Техническое наименование видео": "Technical name of the video", "Установить статус пользователя": "Set user status", "электронная почта заполнена (Y": "Email is filled (Y", -"Ноушн_ИзменитьСвойстваСтраницы": "Notion_EditPageProperties", +"УдалитьУведомление (приложение": "DeleteNotification (app", "Bitrix24_ПоместитьФайлВКорзину": "Bitrix24_MarkFileAsDeleted", -"УстановитьТелоИзДвоичныхДанных": "SetBodyFromBinaryData", -"Методы работы с Yandex ID (ОПИ": "Yandex ID methods (OPI", -"ПолучитьУчаствующиеТоварыАкции": "GetCurrentPromoProducts", -"ПолучитьСтруктуруФильтраСделок": "GetDealsFilterStructure", -"ПолучитьКомменатрийЗадачи (хук": "GetTaskComment (wh", -"ОтправитьСообщение (отложенное": "SendMessage (scheduled", -"Задача невыполнима, расходимся": "Task impossible, let's split up", -"Отклонить заявку на вступление": "Disapprove pending", -"Получить ссылку для скачивания": "Get download link", -"Задача изменена, не расходимся": "The task has been changed, do not split up", -"Изменяет ранее созданный товар": "Edits a previously created product", -"Получить структуру комментария": "Get comment structure", -"ID родительского подразделения": "ID of parent department", -"Слак_ОтправитьУдалитьСообщение": "Slack_SendDeleteMessage", -"ID события календаря источника": "ID of the source calendar event", -"Размер файла в случае отправке": "File size in case of sending", -"ID пользователя для блокировки": "User ID to be blocked", -"СформироватьСтрокуВызоваМетода": "FormMethodCallString", -"СоздатьТвитКартинки (одиночная": "CreateImageTweet (single", -"ТолстыйКлиентОбычноеПриложение": "ThickClientOrdinaryApplication", -"Выгнать пользователя из канала": "Kick user from channel", +"Ноушн_ИзменитьСвойстваСтраницы": "Notion_EditPageProperties", "ПолучитьСписокКатегорийТоваров": "GetProductCategoryList", +"ТолстыйКлиентОбычноеПриложение": "ThickClientOrdinaryApplication", +"СоздатьТвитКартинки (одиночная": "CreateImageTweet (single", +"СформироватьСтрокуВызоваМетода": "FormMethodCallString", +"ID пользователя для блокировки": "User ID to be blocked", +"Размер файла в случае отправке": "File size in case of sending", +"ID события календаря источника": "ID of the source calendar event", +"Слак_ОтправитьУдалитьСообщение": "Slack_SendDeleteMessage", +"ID родительского подразделения": "ID of parent department", +"Получить структуру комментария": "Get comment structure", "УправлениеСостояниемТемыФорума": "ManageForumThreadState", -"Bitrix24_ЗагрузитьФайлВКаталог": "Bitrix24_UploadFileToFolder", -"Техническое наименование видео": "Technical name of the video", -"Целевой путь создания каталога": "Target path for creating the directory", -"Идентификатор удаляемого листа": "IdentifierOfSheetToDelete", -"Методы интеграции с Viber (ОПИ": "Viber integration methods (OPI", -"file\"\" + ИспользуемоеИмя, Файл": "file\"\" + DisplayedName, File", -"Добавить получателей к новости": "Add new recipients to a post", -"ПолучитьСписокТегов (одиночный": "GetTagList (single", -"Ответить на событие клавиатуры": "Answer button event", -"Получить список внешних файлов": "Get list of external files", -"ПолучитьЗначенияХарактеристики": "GetAttributeValues", -"МаксимальныйУровеньВложенности": "MaximumNestingLevel", -"Нельзя замешивать разные типы!": "Different types cannot be mixed!", -"Путь или набору путей к файлам": "Path or set of paths to the files", -"Идентификатор записи в таблице": "Record identifier in the table", -"ОтправитьМестоположение (канал": "SendLocation (channel", -"РазблокироватьПользователяЧата": "UnblockChatUser", -"Получить описание файла !NOCLI": "Get file description !NOCLI", -"Имя поля БД с выбором значения": "Name of field with a value selection", -"Исключить пользователя из чата": "Delete user from chat", -"Получить список опубликованных": "Get published list", -"ИзменитьКомментарийЗадачи (хук": "UpdateTaskComment (wh", -"ПолучитьОписаниеЗаказа (Пустая": "GetOrderDescription (Empty", -"ДропБокс_ПолучитьОбновитьТокен": "DropboxAPI_GetUpdateToken", -"Bitrix24_ПолучитьИсториюЗадачи": "Bitrix24_GetTaskHistory", -"НоушнАпи_ПолучитьПользователей": "NotionAPI_GetUsers", -"Проверка_БитриксМассивНовостей": "Check_BitrixPostsArray", -"Получает информацию о каталоге": "Get folder information", -"ПолучитьСтрокуИзДвоичныхДанных": "GetStringFromBinaryData", -"Получить информацию о каталоге": "Get information about folder", -"JSON описания или путь к .json": "JSON description or path to .json", -"ПолучитьСписокРезультатов (хук": "GetResultsList (wh", -"Добавить пользователей к файлу": "Add users to file", -"file|\" + ИспользуемоеИмя, Файл": "file|\" + DisplayedName, File", -"ДобавитьКомментарийЗадачи (хук": "AddTaskComment (wh", -"Получить информацию о странице": "Get page info", -"Получить список сообщений чата": "Get chat messages list", -"Идентификатор клиента (Account": "Client identifier (Account", -"Удаляет файл или каталог по ID": "Deletes file or directory by ID", -"Получить список версий объекта": "Get list of object versions", -"Получить информацию об объекте": "Get object information", -"Структура, Массив из Структура": "Structure, Array of Structure", -"Идентификатор удаляемого файла": "ID of removing file", -"СоздатьПерсональноеУведомление": "CreatePersonalNotification", -"Проверка_БитриксМассивОбъектов": "Check_BitrixObjectsArray", -"Структура JSON данных страницы": "The structure of the JSON page data", -"КоличествоПараметров - 1 Тогда": "NumberOfParameters - 1 Then", -"Создать/Удалить составной пост": "Create/Delete composite post", -"Параметр дополнительной услуги": "Additional service parameter", -"Добавить пользователей к папке": "Add users to folder", -"ДобавитьПользователейВЧат (хук": "AddUsersToChat (wh", -"Путь назначение для перемещения": "Destination path for moving", -"Привязывает штрихкоды к товарам": "Binds barcodes to products", -"VK_СоздатьСсылкуПолученияТокена": "VK_CreateTokenRetrievalLink", -"Создает пустую подборку товаров": "Creates an empty product selection", -"Создать ссылку получения токена": "Create token retrieval link", -"МинимальныйРазмер).Равно(Истина": "MinimumSize).Equal(True", -"Функция вернула пустое значение": "Function Returned Empty Value", -"ИзменитьСтатусПользователя (хук": "ChangeUserStatus (wh", -"Проверка_ТелеграмУдалениеВебхук": "Check_TelegramWebhookDeletion", -"Массив из Строка,ДвоичныеДанные": "Array of String, BinaryData", -"Получить список аватаров форума": "Get forum avatars list", -"Проверка_ТелеграмИнформацияБота": "Check_TelegramBotInformation", -"ОзонАПИ_АтрибутыИХарактеристики": "OzonAPI_AttributesAndFeatures", -"ИзменитьТрудозатратыЗадачи (хук": "UpdateTaskTimeAccounting (wh", -"Стойка для акустической системы": "Speaker stand", -"Коды активации цифрового товара": "Digital product activation codes", -"ID чата оригинального сообщения": "Chat ID of the original message", -"Dropbox_ОтменитьПубликациюФайла": "Dropbox_CancelFilePublication", -"Не удалось записать файл лога!:": "Failed to write log file!:", -"Bitrix24_ПереименоватьХранилище": "Bitrix24_RenameStorage", -"Добавляет текущего бота в канал": "Adds the current bot to the channel", -"Получить стурктуру пользователя": "Get user fields structure", -"маркетинговый цвет для картинок": "marketing color for pictures", -"Действия с публичными объектами": "Actions with public objects", -"Двоичные данные или пути к фото": "Binary Data or Photo Paths", -"Добавляет комментарий к новости": "Adds a comment to the post", -"Описание тестового события (изм": "Test event description (change", -"ОтправитьСообщение (json массив": "SendMessage (json array", -"только конкретному пользователю": "only to a specific user", -"Dropbox_ОтменитьПубликациюПапки": "Dropbox_CancelFolderPublication", -"Bitrix24_НачатьВыполнениеЗадачи": "Bitrix24_StartTask", -"Получает информацию об аккаунте": "Gets account information", -"ДобавитьКомментарийНовости (хук": "AddPostComment (wh", -"ID сообщения для редактирования": "Message ID for editing", -"ПолучитьСтруктуруФильтраТоваров": "GetProductsFilterStructure", -"Проверка_ТелеграмМестоположение": "Check_TelegramLocation", -"идентификатор привязанного лида": "linked lead identifier", -"Удаляет текущего бота из канала": "Removes the current bot from the channel", -"Получить список иконок-аватаров": "Get avatar icon list", -"ПолучитьСписокТрудозатратЗадачи": "GetTaskTimeAccountingList", -"ЗагрузитьПоАдресуПолучитьОбъект": "UploadByUrlAndGetObject", -"ПолучитьХарактеристикиКатегории": "GetCategoryAttributes", -"Telegram_ПолучитьИнформациюБота": "Telegram_GetBotInformation", -"Войдите в свой аккаунт на сайте": "Login to", -"Получить доступные товары акции": "Get available promo products", -"https://en.openintegrations.dev": "https://openintegrations.dev", -"Телеграм_ПолучитьИнформациюБота": "TelegramAPI_GetBotInfo", -"Создает пустой каталог на диске": "Creates an empty directory on the drive", -"Загружает файл на сервера Slack": "Uploads a file to Slack servers", -"Телеграм_ИзменитьИмяГлавнойТемы": "TelegramAPI_ChangeMainTopicName", -"Bitrix24_ПолучитьСписокХранилищ": "Bitrix24_GetStoragesList", -"СформироватьСсылкуПолученияКода": "FormCodeRetrievalLink", -"ОтметитьСообщениеКакПрочитанное": "MarkMessageAsReaded", -"ИзменитьТекстСообщения (простое": "EditMessageText (simple", -"Целевой путь для нового объекта": "Target path for the new object", -"Задача выполнима, не расходимся": "Task uninpossible, don't split up", -"ПолучитьСписокПользователейЧата": "GetChatUsers", -"Идентификатор каталога родителя": "Parent folder identifier", -"Заблокировать пользователя чата": "Block chat user", -"ПарсерАргументовКоманднойСтроки": "CommandLineArgumentParser", -"Целевой путь файла на Neocities": "File path on Neocities", -"ЯДиск_ДействияПубличныхОбъектов": "YDisk_PublicObjectActions", -"Двоичные данные или путь к фото": "Binary data or path to photo", -"Установить реакцию на сообщение": "Set message reaction", -"ПолучитьЗначениеДляCLI(Значение": "GetCLIFormedValue(Value", -"ПолучитьСписокСобытийРекурсивно": "GetEventsListRecursively", -"Загрузить коды активации товара": "Upload product activations codes", -"ПолучитьСтатусПользователя (хук": "GetUserStatus (wh", -"Удалить вариант свойства товара": "Delete product property variant", -"Удаляет каталог с подкаталогами": "Remove folder with subfolders", -"ПолучитьСтатусУчетаВремени (хук": "GetTimekeepingStatus (wh", -"ОтправитьОпрос (строчный массив": "SendPoll (string array", +"УстановитьТелоИзДвоичныхДанных": "SetBodyFromBinaryData", +"Задача изменена, не расходимся": "The task has been changed, do not split up", +"Получить ссылку для скачивания": "Get download link", +"Отклонить заявку на вступление": "Disapprove pending", +"Задача невыполнима, расходимся": "Task impossible, let's split up", +"ОтправитьСообщение (отложенное": "SendMessage (scheduled", +"ПолучитьКомменатрийЗадачи (хук": "GetTaskComment (wh", +"ПолучитьСтруктуруФильтраСделок": "GetDealsFilterStructure", +"ПолучитьУчаствующиеТоварыАкции": "GetCurrentPromoProducts", +"Методы работы с Yandex ID (ОПИ": "Yandex ID methods (OPI", +"Изменяет ранее созданный товар": "Edits a previously created product", "ПолучитьСписокТоваровРекурсивно": "GetProductListRecursively", "Проверка_ДропБоксПубличнаяПапка": "Check_DropboxPublicFolder", "ID задачи для добавления затрат": "ID of task for time accounting", "Новые трудозатраты по обработке": "New time record", -"ПолучитьСписокЗаказовРекурсивно": "GetOrderListRecursively", +"Исключает пользователей из чата": "Removes users from the chat", "Обновляет двоичные данные файла": "Updates file binary data", "идентификатор предыдущей задачи": "previous task identifier", "Получает список каталогов диска": "Gets the list of drive directories", +"ОтправитьОпрос (строчный массив": "SendPoll (string array", "Сохраните сгенерированный токен": "Save the generated token", -"Исключает пользователей из чата": "Removes users from the chat", +"ПолучитьСписокЗаказовРекурсивно": "GetOrderListRecursively", +"ПолучитьСтатусУчетаВремени (хук": "GetTimekeepingStatus (wh", +"ПолучитьЗначениеДляCLI(Значение": "GetCLIFormedValue(Value", +"Удалить вариант свойства товара": "Delete product property variant", +"ПолучитьСтатусПользователя (хук": "GetUserStatus (wh", +"Загрузить коды активации товара": "Upload product activations codes", +"ПолучитьСписокСобытийРекурсивно": "GetEventsListRecursively", +"Установить реакцию на сообщение": "Set message reaction", +"Двоичные данные или путь к фото": "Binary data or path to photo", +"ЯДиск_ДействияПубличныхОбъектов": "YDisk_PublicObjectActions", +"Целевой путь файла на Neocities": "File path on Neocities", +"ПарсерАргументовКоманднойСтроки": "CommandLineArgumentParser", +"Идентификатор каталога родителя": "Parent folder identifier", +"Удаляет каталог с подкаталогами": "Remove folder with subfolders", "ОтправитьУведомлениеОВводе (хук": "SendWritingNotification (wh", -"См.ПолучитьСтандартныеПараметры": "See GetStandardParameters", -"ID пользователей для добавления": "New members IDs", -"ПолучитьВнешнююСсылкуФайла (хук": "GetFileExternalLink (wh", -"ДобавитьТрудозатратыЗадачи (хук": "AddTaskTimeAccounting (wh", -"Copyright (c) 2019, ООО 1С-Софт": "Copyright (c) 2019, LLC 1C-Soft", -"ПолучитьТрудозатратыЗадачи (хук": "GetTaskTimeAccounting (wh", -"Создает заказ по описанию полей": "Creates an order based on field descriptions", -"Загружает файл на облачный диск": "Uploads a file to the cloud drive", -"Проверка_ДропбоксПубличнаяПапка": "Check_DropboxPublicFolder", -"ID первого справочника в ответе": "ID of the first catalog in the response", -"Обновить характеристики товаров": "Update products attributes", -"Восстанавливает файл из корзины": "Restore file from recycle bin", -"Создает твит с вложением-гифкой": "Creates a tweet with a gif attachment", -"Получить статус загрузки по URL": "Get upload status by URL", -"Отправка в канал или в чат бота": "Sending to channel or bot chat", -"Получает значения ячеек таблицы": "Gets cell values of the table", -"ПреобразоватьМножественныйВыбор": "ConvertMultipleChoice", -"Служебный программный интерфейс": "Service", -"Наименование истинного продавца": "Name of the true seller", -"ПолучитьСтруктуруОстатковТовара": "GetProductStocksStructure", -"VK_УдалитьВариантСвойстваТовара": "VK_DeleteProductPropertyVariant", -"Быстрый переход по документации": "Fast navigation", -"Получить информацию об аккаунте": "Get account information", "Bitrix24_ПроверитьДоступКЗадаче": "Bitrix24_CheckTaskAccesses", -"Удалить элемент чеклиста задачи": "Delete tasks checklist element", -"Прекратить наблюдать за задачей": "Stop watching the task", +"ID пользователей для добавления": "New members IDs", "Получить ссылку для авторизации": "Get authorization link", -"Получить элемент чеклиста задачи": "Get tasks checklist element", -"Получить значения характеристики": "Get attribute values", -"Возвращает в работу задачу по ID": "Returns a task to work by ID", -"См.ДобавитьВариантСвойстваТовара": "See AddPropertyVariant", -"Номер сопроводительной накладной": "Number of the accompanying consignment note", -"ОзонСписокЗначенийХарактеристики": "OzonListOfAttributesValues", -"Идентификатор файла или каталога": "Identifier of the file or folder", -"Получает список складов компании": "Gets compnay warehouses list", -"СоздатьСистемноеУведомление (хук": "CreateSystemNotification (wh", -"Путь к удаляемой папке или файлу": "Path to the folder or file to be deleted", -"Удаляет объект по заданному пути": "Deletes an object at the specified path", -"ПолучитьСписокСообщенийЧата (хук": "GetChatMessagesList (wh", -"Получить запросы вступления чата": "Get chat join requests", -"ОтправитьГолосовоеСообщение (URL": "SendVoice (URL", -"Client ID из настроек приложения": "Client ID from app settings", -"Устанавливает новые правила чата": "Sets new chat rules", -"Идентификатор изменяемого товара": "Identifier of the product being edited", -"Обновить товар по Ozon ID нельзя": "It is not possible to update a product fields by Ozon ID", -"Получить настройки учета времени": "Get timekeeping settings", -"Коллекция, дополненная атрибутом": "A collection enhanced with a new attribute", -"ИсключитьПользователяИзЧата (хук": "DeleteUserFromChat (wh", -"Telegram_ОтправитьМестоположение": "Telegram_SendLocation", -"Отправка в канал или чат с ботом": "Sending to channel or bot chat", -"Получить внешнюю ссылку каталога": "Get external link for folder", -"Телеграм_ПолучитьЧислоУчастников": "TelegramAPI_GetMemberCount", +"Прекратить наблюдать за задачей": "Stop watching the task", +"Удалить элемент чеклиста задачи": "Delete tasks checklist element", +"ПолучитьСписокПользователейЧата": "GetChatUsers", +"Получить информацию об аккаунте": "Get account information", +"Быстрый переход по документации": "Fast navigation", +"VK_УдалитьВариантСвойстваТовара": "VK_DeleteProductPropertyVariant", +"ПолучитьСтруктуруОстатковТовара": "GetProductStocksStructure", +"Наименование истинного продавца": "Name of the true seller", +"Служебный программный интерфейс": "Service", +"ПреобразоватьМножественныйВыбор": "ConvertMultipleChoice", +"Получает значения ячеек таблицы": "Gets cell values of the table", +"Отправка в канал или в чат бота": "Sending to channel or bot chat", +"Получить статус загрузки по URL": "Get upload status by URL", +"Создает твит с вложением-гифкой": "Creates a tweet with a gif attachment", +"Восстанавливает файл из корзины": "Restore file from recycle bin", +"Обновить характеристики товаров": "Update products attributes", +"ID первого справочника в ответе": "ID of the first catalog in the response", +"Проверка_ДропбоксПубличнаяПапка": "Check_DropboxPublicFolder", +"Загружает файл на облачный диск": "Uploads a file to the cloud drive", +"Создает заказ по описанию полей": "Creates an order based on field descriptions", +"ПолучитьТрудозатратыЗадачи (хук": "GetTaskTimeAccounting (wh", +"Copyright (c) 2019, ООО 1С-Софт": "Copyright (c) 2019, LLC 1C-Soft", +"ДобавитьТрудозатратыЗадачи (хук": "AddTaskTimeAccounting (wh", +"ПолучитьВнешнююСсылкуФайла (хук": "GetFileExternalLink (wh", +"См.ПолучитьСтандартныеПараметры": "See GetStandardParameters", +"Задача выполнима, не расходимся": "Task uninpossible, don't split up", +"Заблокировать пользователя чата": "Block chat user", +"ИзменитьТекстСообщения (простое": "EditMessageText (simple", +"Действия с публичными объектами": "Actions with public objects", +"маркетинговый цвет для картинок": "marketing color for pictures", +"Получить стурктуру пользователя": "Get user fields structure", +"Добавляет текущего бота в канал": "Adds the current bot to the channel", +"Bitrix24_ПереименоватьХранилище": "Bitrix24_RenameStorage", +"Не удалось записать файл лога!:": "Failed to write log file!:", +"Dropbox_ОтменитьПубликациюФайла": "Dropbox_CancelFilePublication", +"ID чата оригинального сообщения": "Chat ID of the original message", +"Коды активации цифрового товара": "Digital product activation codes", +"Стойка для акустической системы": "Speaker stand", +"ОзонАПИ_АтрибутыИХарактеристики": "OzonAPI_AttributesAndFeatures", +"Двоичные данные или пути к фото": "Binary Data or Photo Paths", +"Проверка_ТелеграмИнформацияБота": "Check_TelegramBotInformation", +"Массив из Строка,ДвоичныеДанные": "Array of String, BinaryData", +"Проверка_ТелеграмУдалениеВебхук": "Check_TelegramWebhookDeletion", +"ИзменитьСтатусПользователя (хук": "ChangeUserStatus (wh", +"Функция вернула пустое значение": "Function Returned Empty Value", +"МинимальныйРазмер).Равно(Истина": "MinimumSize).Equal(True", +"Создать ссылку получения токена": "Create token retrieval link", +"Создает пустую подборку товаров": "Creates an empty product selection", +"VK_СоздатьСсылкуПолученияТокена": "VK_CreateTokenRetrievalLink", +"Привязывает штрихкоды к товарам": "Binds barcodes to products", +"Путь назначение для перемещения": "Destination path for moving", +"Целевой путь для нового объекта": "Target path for the new object", +"Получить список аватаров форума": "Get forum avatars list", +"Добавляет комментарий к новости": "Adds a comment to the post", +"ИзменитьТрудозатратыЗадачи (хук": "UpdateTaskTimeAccounting (wh", +"ОтправитьСообщение (json массив": "SendMessage (json array", +"ОтметитьСообщениеКакПрочитанное": "MarkMessageAsReaded", +"Описание тестового события (изм": "Test event description (change", +"СформироватьСсылкуПолученияКода": "FormCodeRetrievalLink", +"Bitrix24_ПолучитьСписокХранилищ": "Bitrix24_GetStoragesList", +"Телеграм_ИзменитьИмяГлавнойТемы": "TelegramAPI_ChangeMainTopicName", +"Загружает файл на сервера Slack": "Uploads a file to Slack servers", +"Создает пустой каталог на диске": "Creates an empty directory on the drive", +"Телеграм_ПолучитьИнформациюБота": "TelegramAPI_GetBotInfo", +"Получить доступные товары акции": "Get available promo products", +"Войдите в свой аккаунт на сайте": "Login to", +"Telegram_ПолучитьИнформациюБота": "Telegram_GetBotInformation", +"ПолучитьХарактеристикиКатегории": "GetCategoryAttributes", +"ЗагрузитьПоАдресуПолучитьОбъект": "UploadByUrlAndGetObject", +"https://en.openintegrations.dev": "https://openintegrations.dev", +"Dropbox_ОтменитьПубликациюПапки": "Dropbox_CancelFolderPublication", +"только конкретному пользователю": "only to a specific user", +"ПолучитьСписокТрудозатратЗадачи": "GetTaskTimeAccountingList", +"Bitrix24_НачатьВыполнениеЗадачи": "Bitrix24_StartTask", +"Получает информацию об аккаунте": "Gets account information", +"ID сообщения для редактирования": "Message ID for editing", +"ДобавитьКомментарийНовости (хук": "AddPostComment (wh", +"Проверка_ТелеграмМестоположение": "Check_TelegramLocation", +"идентификатор привязанного лида": "linked lead identifier", +"Удаляет текущего бота из канала": "Removes the current bot from the channel", +"Получить список иконок-аватаров": "Get avatar icon list", +"ПолучитьСтруктуруФильтраТоваров": "GetProductsFilterStructure", +"Поле с типом title - обязательно": "Title field required", +"Получить список рабочих областей": "Get workspace list", +"Новое имя файла (если необходимо": "New file name (if necessary", +"РазмерЧасти И ТипЗнч(Файл) = Тип": "ChunkSize And TypeOf(File) = Type", +"идентификатор автора комментария": "comment author identifier", +"Telegram_СкрытьГлавнуюТемуФорума": "Telegram_HideMainForumTopic", +"УдалитьВыбранныеФайлы (каталог 1": "DeleteSelectedFiles (folder 1", +"ВозобновитьЭлементЧеклистаЗадачи": "RenewTasksChecklistElement", +"ОдобритьЗаявкуНаВступление (один": "ApprovePending (single", +"Создает страницу в базе-родителе": "Creates a page in the parent database", +"Текст %F0%9F%A5%9D и emoji \\(10%": "Text %F0%9F%A5%9D and emoji \\(10%", +"Получить структуру фильтра задач": "Get structure of tasks filter", +"Проверка_ТелеграмУстановкаВебхук": "Check_TelegramWebhookSetup", +"Telegram_ПолучитьЧислоУчастников": "Telegram_GetParticipantCount", +"АрхивироватьТовары (для удаления": "ArchiveProducts (for deleting", +"Получает описание поля типа дата": "Gets the description of a date field", +"Загрузить массив вложений !NOCLI": "Upload attachments array !NOCLI", +"Обновляет токен по Refresh token": "Updates token by Refresh token", +"Пригласить пользователей в канал": "Invite users to channel", +"ДобавитьДополнительныеФотоТовара": "AddAdditionalProductPhotos", +"Добавить элемент чеклиста задачи": "Add tasks checklist element", +"ДобавитьПолучателейКНовости (хук": "AddPostRecipients (wh", +"Отправляет гифку в чат или канал": "Sends a GIF to a chat or channel", +"ПолучитьСписокОбъектовРекурсивно": "GetObjectsListRecursively", +"Создать персональное уведомление": "Create personal notification", +"Массив ячеек вида А1 для очистки": "Array of cells like A1 to be cleared", +"E-mail пользователя (опционально": "Users email (optional", +"Тип аудиофайла: aac, ogg или m4a": "Audio type: aac, ogg or m4a", +"Bitrix24_ЗагрузитьФайлВХранилище": "Bitrix24_UploadFileToStorage", +"Телеграм_ОтправитьМестоположение": "TelegramAPI_SendLocation", +"ПолучитьИнформациюОКаталоге (хук": "GetFolderInformation (wh", +"Выбрать в меню команду */newbot*": "Choose */newbot* command", +"Удалить результат из комментария": "Delete result from comment", +"Получает текущее серверное время": "Get current server time", +"ВыполнитьЗапросСДвоичнымиДанными": "ExecuteRequestWithBinaryData", +"Проверка_БитриксСтрока(Результат": "Check_BitrixString(Result", +"ПолучитьСодержимоеХранилища (хук": "GetStorageObjects (wh", +"VK_ИзменитьВариантСвойстваТовара": "VK_EditProductPropertyVariant", +"Bitrix24_ПереместитьФайлВКаталог": "Bitrix24_MoveFileToFolder", +"ПолучитьСписокКомментариевЗадачи": "GetTaskCommentsList", +"Изменяет имя существующего файла": "Changes the name of an existing file", +"JSON клавиатуры или путь к .json": "Keyboard JSON or path to .json", +"ПриостановитьРекламноеОбъявление": "PauseAdvertising", +"Изменить элемент чеклиста задачи": "Update tasks checklist element", +"Bitrix24_ПолучитьСтруктуруЗадачи": "Bitrix24_GetTaskFieldsStructure", +"Добавить вариант свойства товара": "Add product property variant", +"Количество возвращаемых объектов": "Number of returned objects", +"ПолучитьСписокОтветовНаСообщение": "GetMessageReplyList", +"Новый полужирный текст сообщения": "New bold message text", +"Создать результат из комментария": "Create result from comment", +"Методы работы с Yandex Disk (ОПИ": "Yandex Disk methods (OPI", +"Слак_ПолучитьСписокПользователей": "Slack_GetUserList", +"Ошибка в данных коллекции таблиц": "Error in table collection data", +"Разблокировать пользователя чата": "Unblock chat user", +"Получает список подборок товаров": "Gets the list of product selections", +"Закрывает или удаляет обсуждение": "Close or delete discussion", +"Удаляет объект с облачного диска": "Deletes an object from the cloud drive", +"ПолучитьСписокАльбомовРекурсивно": "GetAlbumListRecursively", +"Удаляет товары без SKU из архива": "Deletes products without SKU from archive", "Начинает выполнение задачи по ID": "Start a task by ID", +"Телеграм_ПолучитьЧислоУчастников": "TelegramAPI_GetMemberCount", +"Получить внешнюю ссылку каталога": "Get external link for folder", +"Отправка в канал или чат с ботом": "Sending to channel or bot chat", +"Telegram_ОтправитьМестоположение": "Telegram_SendLocation", +"ИсключитьПользователяИзЧата (хук": "DeleteUserFromChat (wh", +"Коллекция, дополненная атрибутом": "A collection enhanced with a new attribute", +"Получить настройки учета времени": "Get timekeeping settings", +"Обновить товар по Ozon ID нельзя": "It is not possible to update a product fields by Ozon ID", +"Идентификатор изменяемого товара": "Identifier of the product being edited", +"Устанавливает новые правила чата": "Sets new chat rules", +"Client ID из настроек приложения": "Client ID from app settings", "ПолучитьСписокРекламныхКатегорий": "GetAdvertisingCategoryList", +"ОтправитьГолосовоеСообщение (URL": "SendVoice (URL", +"ПолучитьСписокСообщенийЧата (хук": "GetChatMessagesList (wh", +"Удаляет объект по заданному пути": "Deletes an object at the specified path", +"Путь к удаляемой папке или файлу": "Path to the folder or file to be deleted", +"СоздатьСистемноеУведомление (хук": "CreateSystemNotification (wh", +"Идентификатор файла или каталога": "Identifier of the file or folder", +"ОзонСписокЗначенийХарактеристики": "OzonListOfAttributesValues", +"Номер сопроводительной накладной": "Number of the accompanying consignment note", +"См.ДобавитьВариантСвойстваТовара": "See AddPropertyVariant", +"Возвращает в работу задачу по ID": "Returns a task to work by ID", +"Получить значения характеристики": "Get attribute values", +"Получить элемент чеклиста задачи": "Get tasks checklist element", +"!OInt Сообщить(СообщениеУдаления": "!OInt Message(DeletingMessage", +"Получить запросы вступления чата": "Get chat join requests", "Ноушн_ПолучитьДанныеПользователя": "Notion_GetUserData", -"ПолучитьСтруктуруФильтраКаталога": "GetFolderFilterStructure", +"Получает список складов компании": "Gets compnay warehouses list", "УдалитьВыбранныеФайлы (каталог 2": "DeleteSelectedFiles (folder 2", -"Изменяет имя главной темы форума": "Edits the name of the main forum thread", +"ПолучитьСтруктуруФильтраКаталога": "GetFolderFilterStructure", +"ПолучитьДочерниеЭлементыКаталога": "GetFolderItems", +"ДобавитьПользователейКФайлу (доп": "AddUsersToFile (new", +"Возвращает структуру блока по ID": "Returns the block structure by ID", +"ПолучитьСписокВнешнихФайлов (все": "GetExternalFileList (full", +"Получить описание события !NOCLI": "Get event description !NOCLI", +"См. ПолучитьСписокИконокАватаров": "See GetAvatarIconList", +"ОпределитьМетодУправленияФорумом": "DetermineForumManagementMethod", +"Отправляет видео в чат или канал": "Sends a video to a chat or channel", +"Изменить вариант свойства товара": "Edit product property variant", +"ТекущаяОбласть + \"\"#color=Бирюза": "CurrentArea + \"\"#color=Aqua", +"Для автоматизации ведения канала": "For automating channel management", +"Получить структуру фильтра лидов": "Get lead filter structure", +"Изменить имя главной темы форума": "Edit main forum thread name", +"Получить контент рейтинг товаров": "Get products content rating", +"Вайбер_ПолучитьИнформациюОКанале": "Viber_GetChannelInfo", "VK_ДобавитьВариантСвойстваТовара": "VK_AddProductPropertyVariant", "УстановитьСкидкуНаУцененныйТовар": "SetProductDiscount", -"Получить описание товара. !NOCLI": "Get product description. !NOCLI", +"Изменяет имя главной темы форума": "Edits the name of the main forum thread", "Слак_ПолучитьОтложенныеСообщения": "Slack_GetScheduledMessages", "ПолучитьСписокХранилищПриложения": "GetAppStoragesList", -"МинимальныйРазмерДляПотока Тогда": "MinimumStreamSize Then", +"Получить описание товара. !NOCLI": "Get product description. !NOCLI", "ЯДиск_ПолучитьСсылкуНаСкачивание": "YDisk_GetDownloadLink", "О клавиатурах в документации API": "About keyboards in the API documentation", "Массив из Строка, ДвоичныеДанные": "Array of String, BinaryData", "Получить статус добавления кодов": "Get codes upload status", -"Получить контент рейтинг товаров": "Get products content rating", -"Вайбер_ПолучитьИнформациюОКанале": "Viber_GetChannelInfo", -"Получить структуру фильтра лидов": "Get lead filter structure", -"Для автоматизации ведения канала": "For automating channel management", -"ТекущаяОбласть + \"\"#color=Бирюза": "CurrentArea + \"\"#color=Aqua", -"Изменить вариант свойства товара": "Edit product property variant", -"Отправляет видео в чат или канал": "Sends a video to a chat or channel", -"ОпределитьМетодУправленияФорумом": "DetermineForumManagementMethod", -"См. ПолучитьСписокИконокАватаров": "See GetAvatarIconList", -"Получить описание события !NOCLI": "Get event description !NOCLI", -"Изменить имя главной темы форума": "Edit main forum thread name", -"ПолучитьСписокВнешнихФайлов (все": "GetExternalFileList (full", -"Возвращает структуру блока по ID": "Returns the block structure by ID", -"ДобавитьПользователейКФайлу (доп": "AddUsersToFile (new", -"ПолучитьДочерниеЭлементыКаталога": "GetFolderItems", -"Удаляет товары без SKU из архива": "Deletes products without SKU from archive", -"!OInt Сообщить(СообщениеУдаления": "!OInt Message(DeletingMessage", -"Удаляет объект с облачного диска": "Deletes an object from the cloud drive", -"Телеграм_ОтправитьМестоположение": "TelegramAPI_SendLocation", -"Проверка_ТелеграмУстановкаВебхук": "Check_TelegramWebhookSetup", -"ПолучитьСписокОбъектовРекурсивно": "GetObjectsListRecursively", -"Отправляет гифку в чат или канал": "Sends a GIF to a chat or channel", -"ДобавитьПолучателейКНовости (хук": "AddPostRecipients (wh", -"Добавить элемент чеклиста задачи": "Add tasks checklist element", -"ПолучитьСписокАльбомовРекурсивно": "GetAlbumListRecursively", -"Пригласить пользователей в канал": "Invite users to channel", -"Обновляет токен по Refresh token": "Updates token by Refresh token", -"Загрузить массив вложений !NOCLI": "Upload attachments array !NOCLI", -"Получает описание поля типа дата": "Gets the description of a date field", -"АрхивироватьТовары (для удаления": "ArchiveProducts (for deleting", -"Telegram_ПолучитьЧислоУчастников": "Telegram_GetParticipantCount", -"Массив ячеек вида А1 для очистки": "Array of cells like A1 to be cleared", -"Получить структуру фильтра задач": "Get structure of tasks filter", -"Создает страницу в базе-родителе": "Creates a page in the parent database", -"Получить список рабочих областей": "Get workspace list", -"Новое имя файла (если необходимо": "New file name (if necessary", -"РазмерЧасти И ТипЗнч(Файл) = Тип": "ChunkSize And TypeOf(File) = Type", -"Поле с типом title - обязательно": "Title field required", -"идентификатор автора комментария": "comment author identifier", -"Текст %F0%9F%A5%9D и emoji \\(10%": "Text %F0%9F%A5%9D and emoji \\(10%", -"УдалитьВыбранныеФайлы (каталог 1": "DeleteSelectedFiles (folder 1", -"ВозобновитьЭлементЧеклистаЗадачи": "RenewTasksChecklistElement", -"ОдобритьЗаявкуНаВступление (один": "ApprovePending (single", -"Telegram_СкрытьГлавнуюТемуФорума": "Telegram_HideMainForumTopic", -"Создать персональное уведомление": "Create personal notification", -"E-mail пользователя (опционально": "Users email (optional", -"JSON клавиатуры или путь к .json": "Keyboard JSON or path to .json", -"Bitrix24_ЗагрузитьФайлВХранилище": "Bitrix24_UploadFileToStorage", -"Получает список подборок товаров": "Gets the list of product selections", -"Разблокировать пользователя чата": "Unblock chat user", -"Ошибка в данных коллекции таблиц": "Error in table collection data", -"Слак_ПолучитьСписокПользователей": "Slack_GetUserList", -"Методы работы с Yandex Disk (ОПИ": "Yandex Disk methods (OPI", -"Создать результат из комментария": "Create result from comment", -"Новый полужирный текст сообщения": "New bold message text", -"ПолучитьСписокОтветовНаСообщение": "GetMessageReplyList", -"Количество возвращаемых объектов": "Number of returned objects", -"Добавить вариант свойства товара": "Add product property variant", -"Bitrix24_ПолучитьСтруктуруЗадачи": "Bitrix24_GetTaskFieldsStructure", -"Изменить элемент чеклиста задачи": "Update tasks checklist element", -"Закрывает или удаляет обсуждение": "Close or delete discussion", -"ПриостановитьРекламноеОбъявление": "PauseAdvertising", -"Изменяет имя существующего файла": "Changes the name of an existing file", -"ПолучитьСписокКомментариевЗадачи": "GetTaskCommentsList", -"Bitrix24_ПереместитьФайлВКаталог": "Bitrix24_MoveFileToFolder", -"VK_ИзменитьВариантСвойстваТовара": "VK_EditProductPropertyVariant", -"ПолучитьСодержимоеХранилища (хук": "GetStorageObjects (wh", -"Проверка_БитриксСтрока(Результат": "Check_BitrixString(Result", -"ВыполнитьЗапросСДвоичнымиДанными": "ExecuteRequestWithBinaryData", -"Получает текущее серверное время": "Get current server time", -"Удалить результат из комментария": "Delete result from comment", -"Выбрать в меню команду */newbot*": "Choose */newbot* command", -"ПолучитьИнформациюОКаталоге (хук": "GetFolderInformation (wh", -"Тип аудиофайла: aac, ogg или m4a": "Audio type: aac, ogg or m4a", -"ДобавитьДополнительныеФотоТовара": "AddAdditionalProductPhotos", -"Обновляет токен по Refresh токену": "Update token by refresh token", -"Закрепляет сообщение в шапке чата": "Pins a message in the chat header", -"Проверка_БитриксСписокРезультатов": "Check_BitrixResultsList", -"Вайбер_ПолучитьДанныеПользователя": "Viber_GetUserData", -"Получить список категорий товаров": "Get a list of product categories", -"Устанавливает новое описание чата": "Sets new chat description", -"Вес (за единицу товара, в граммах": "Weight (per unit, grams", -"УдалитьЭлементЧеклистаЗадачи (хук": "DeleteTasksChecklistElement (wh", -"Bitrix24_НачатьНаблюдатьЗаЗадачей": "Bitrix24_StartWatchingTask", -"Получить лимиты работы с товарами": "Get products requests limits", -"Dropbox_ПолучитьСписокФайловПапки": "Dropbox_GetFolderFileList", -"v1.1. Поэтому что-то нужно делать": "v1.1. Therefore, something needs to be done", -"Bitrix24_УбратьЗадачуИзИзбранного": "Bitrix24_RemoveTaskFromFavorites", -"Путь помещения загруженного файла": "Path to place the downloaded file", -"Перенести задачу в стадию канбана": "Move task to kanban stage", -"УстановитьРеакциюНаСообщение (хук": "SetMessageReaction (wh", -"Отступ получения элементов списка": "Offst of items list", -"ОтметитьСообщениеКакНепрочитанное": "MarkMessageAsUnreaded", -"Bitrix24_ПоместитьКаталогВКорзину": "Bitrix24_MarkFolderAsDeleted", -"Отправляет в чат статус Вам пишут": "Send Writing... status to dialog", -"Методы интеграции с Telegram (ОПИ": "Telegram integration methods (OPI", -"ОтклонитьЗаявкуНаВступление (один": "DisapprovePending (single", -"ОтправитьТекстовоеСообщение (HTML": "SendTextMessage (HTML", -"Скачивает файл по указанному пути": "Downloads a file at the specified path", -"Получает список доступных каналов": "Gets a list of available channels", -"Выполнить элемент чеклиста задачи": "Complete tasks checklist element", -"Введите название вашей интеграции": "Enter the name of your integration", -"Структура JSON данных авторизации": "The structure of the JSON authentication data", -"Bitrix24_УдалитьКомментарийЗадачи": "Bitrix24_DeleteTaskComment", -"Dropbox_ВосстановитьОбъектКВерсии": "Dropbox_RestoreObjectToVersion", -"Code из авторизации через браузер": "Code from browser auth page", -"Ноушн_ПолучитьИнформациюОСтранице": "Notion_GetPageInfo", -"Базы данных и электронные таблицы": "Databases and spreadsheets", -"Телеграм_СоздатьСсылкуПриглашение": "TelegramAPI_CreateInvitationLink", -"УстановитьСтатусПользователя (хук": "SetUserStatus (wh", -"ID первого загруженного сообщения": "ID of first message", -"Получить участвующие товары акции": "Get current promo products", -"Изменяет текст комментария задачи": "Changes task comment text", -"JSON авторизации или путь к .json": "Authorization JSON or path to .json", -"Отправляет файл диска в чат по ID": "Send disk file to chat", -"ИзменитьАртикулыТоваров (обратный": "UpdateProductsArticles (reverse", -"ПолучитьСписокПользователейКанала": "GetChannelUserList", -"Проверка_БитриксДоступныеДействия": "Check_BitrixAvailableActions", -"Telegram_СоздатьСсылкуПриглашение": "Telegram_CreateInviteLink", -"ПолучитьТекущегоПользователя (хук": "GetCurrentUser (wh", -"VK_ПолучитьСписокКатегорийТоваров": "VK_GetProductCategoryList", -"Устанавливает новую картинку чата": "Setup new chat picture", -"Dropbox_ПолучитьСсылкуАвторизации": "Dropbox_GetAuthorizationLink", -"Наименование на иностранном языке": "Foreign language name", -"Создает опрос с вариантами ответа": "Creates a poll with answer options", -"Получает информацию о файле по ID": "Get information about file by ID", -"Запрос, приходящий на http-сервис": "Request coming to the http service", -"Телеграм_СоздатьУдалитьТемуФорума": "TelegramAPI_CreateDeleteForumTopic", -"Получить структуру фильтра сделок": "Get deals filter structure", -"Метод проверки статуса добавления": "Uploading status check", -"идентификатор родительской задачи": "parent task identifier", -"Получить характеристики категории": "Get category attributes", -"ПолучитьСписокОтложенныхСообщений": "GetDelayedMessageList", -"Получает список участников далога": "Get chat members list", +"МинимальныйРазмерДляПотока Тогда": "MinimumStreamSize Then", "ОтправитьГолосовоеСообщение (Путь": "SendVoice (Path", "ПолучитьСоответствиеКомандМодулей": "GetCommandModuleMapping", +"Получает список участников далога": "Get chat members list", +"ПолучитьСписокОтложенныхСообщений": "GetDelayedMessageList", +"Получить характеристики категории": "Get category attributes", +"идентификатор родительской задачи": "parent task identifier", +"Метод проверки статуса добавления": "Uploading status check", +"Получить структуру фильтра сделок": "Get deals filter structure", +"Dropbox_ПолучитьСсылкуАвторизации": "Dropbox_GetAuthorizationLink", +"Запрос, приходящий на http-сервис": "Request coming to the http service", +"Получает информацию о файле по ID": "Get information about file by ID", +"Создает опрос с вариантами ответа": "Creates a poll with answer options", +"Наименование на иностранном языке": "Foreign language name", +"Устанавливает новую картинку чата": "Setup new chat picture", +"VK_ПолучитьСписокКатегорийТоваров": "VK_GetProductCategoryList", "сериализованный JSON ответа от VK": "serialized JSON response from VK", +"ПолучитьТекущегоПользователя (хук": "GetCurrentUser (wh", +"Телеграм_СоздатьУдалитьТемуФорума": "TelegramAPI_CreateDeleteForumTopic", "Bitrix24_ДобавитьЗадачуВИзбранное": "Bitrix24_AddTaskToFavorites", -"Открепляет сообщение в шапке чата": "Unpins a message in the chat header", -"Получить статус добавления товара": "Get product creation status", -"Bitrix24_СоздатьКаталогВХранилище": "Bitrix24_CreateStorageFolder", -"Действие над задачей не разрешено": "Action on the task is not allowed", -"Идентификатор удаляемого каталога": "ID of folder to be deleted", -"URL к видеообложке для добавления": "URL of the video cover", -"ПрекратитьНаблюдатьЗаЗадачей (хук": "StopWatchingTask (wh", -"Получает историю изменений задачи": "Get history of task changing", -"Ссылка на страницу сайта магазина": "Link to the store's website page", -"ПолучитьДвоичныеДанныеИзHexСтроки": "GetBinaryDataFromHexString", -"УдалитьПользовательскоеПолеЗадачи": "DeleteCustomTaskField", -"Твиттер_ПолучитьСсылкуАвторизации": "Twitter_GetAuthorizationLink", -"Получает информацию о книге по ID": "Gets information about the spreadsheet by ID", "РежимВосстановленияПутейФайловZIP": "ZIPRestoreFilePathsMode", -"ВыполнитьЗапросМультипартРелэйтед": "ExecuteMultipartRelatedRequest", -"Предпочтительное хранение токенов": "Preferred token storage", -"Bitrix24_ПолучитьИнформациюОФайле": "Bitrix24_GetFileInformation", -"ПолучитьHexСтрокуИзДвоичныхДанных": "GetHexStringFromBinaryData", -"Структура JSON данных медиагруппы": "The structure of the JSON media group data", +"Получить статус добавления товара": "Get product creation status", +"Telegram_СоздатьСсылкуПриглашение": "Telegram_CreateInviteLink", "ПолучитьСписокПросмотревшихВажное": "GetImportantPostViewers", -"Восстанавливает каталог из корзины": "Resotre folder form recycle bin", -"ДропБокс_ПолучитьСписокФайловПапки": "DropboxAPI_GetFolderFileList", -"ИзменитьПользовательскоеПолеЗадачи": "UpdateCustomTaskField", -"ИзменитьЭлементЧеклистаЗадачи (хук": "UpdateTasksChecklistElement (wh", -"Переносит выбранные товары в архив": "Moves selected items to the archive", -"ПеренестиЗадачуВСтадиюКанбана (хук": "MoveTaskToKanbanStage (wh", -"Количество единиц товара (в штуках": "Number of units (pcs", -"Соответствие изменяемых параметров": "Map of editable parameters", -"Bitrix24_ИзменитьКомментарийЗадачи": "Bitrix24_UpdateTaskComment", -"ЗаписатьПобитовоеИсключительноеИли": "WriteBitwiseXor", -"ДобавитьПозиционныйПараметрКоманды": "AddPositionalCommandParameter", -"ОтправитьТекстовоеСообщение (emoji": "SendTextMessage (emoji", -"ПолучитьСписокПользователейДиалога": "GetChatMembersList", -"Устанавливает новый заголовок чата": "Sets new chat title", -"ФайлЛога = Новый Файл(ПутьКФайлу": "LogFile = New File(FilePath", -"querry из Telegram.WebApp.initData": "Query from Telegram.WebApp.initData", -"Начинает учет времени пользователя": "Starts user timekeeping", -"Создает твит с картинкой вложением": "Creates a tweet with an image attachment", -"ОтправитьТекстовоеСообщение (канал": "SendTextMessage (channel", -"ДобавитьИменованныйПараметрКоманды": "AddNamedCommandParameter", -"СформироватьПараметрыЗагрузкиФайла": "FormFileUploadParameters", -"ПолучитьЭлементЧеклистаЗадачи (хук": "GetTasksChecklistElement (wh", -"УдалитьРезультатИзКомментария (хук": "Delete result from comment", -"Скачивает файл с серверов Telegram": "Download file from Telegram servers", -"Массив данных статистики по постам": "Array of post statistics data", -"ПолучитьСокращеннуюСтруктуруТовара": "GetSimplifiedProductStructure", -"Получает описание поля типа булево": "Gets the description of a boolean field", -"Bitrix24_ПолучитьКомменатрийЗадачи": "Bitrix24_GetTaskComment", -"Bitrix24_ДобавитьКомментарийЗадачи": "Bitrix24_AddTaskComment", -"ПРЕОБРАЗОВАТЬBASE64ВДВОИЧНЫЕДАННЫЕ": "CONVERTBASE64TOBINARY", -"Получает список результатов задачи": "Gets results list for task", -"ПолучитьПользовательскоеПолеЗадачи": "GetCustomTaskField", -"Расширение файла в случае отправки": "File extension in case of sending", -"Путь для сохранение файла на Диске": "Path for saving the file to disk", -"HEX дополнительного цвета (#ffffff": "HEX secondary color (#ffffff", -"Выберите имя и добавьте разрешения": "Select a name and add permissions", -"Вайбер_ПолучитьОнлайнПользователей": "Viber_GetOnlineUsers", -"Получает список пользователей чата": "Gets the list of chat members", -"Изменяет свойства подборки товаров": "Edits the properties of a product selection", -"Получает токен по коду авторизации": "Get token by auth code", -"СоздатьРезультатИзКомментария (хук": "CreateResultFromComment (wh", -"ЯДиск_ПолучитьСписокОпубликованных": "YDisk_GetPublishedList", -"Добавляет видео к атрибутам товара": "Adds video to product attributes", -"Получает данные пользователя по ID": "Gets user data by ID", -"Bitrix24_ПолучитьСписокРезультатов": "Bitrix24_GetResultsList", -"ДобавитьЭлементЧеклистаЗадачи (хук": "AddTasksChecklistElement (wh", -"Переадресация И Ответ.КодСостояния": "Redirection And Response.StatusCode", -"Текст (заголовок) пункта чек листа": "Text (title) of checklist element", -"Получить структуру остатков товара": "Get product stocks structure", -"JSON - передается как путь к файлу": "JSON is passed as a path to a .json file", -"ID товаров для создания штрихкодов": "Products IDs for barcodes creating", -"Удаляет элемент из чеклиста задачи": "Deletes element from tasks checklist", -"необходимо будет ввести в браузере": "you will need to enter in the browser", -"Телеграм_СкрытьПоказатьГлавнуюТему": "TelegramAPI_HideShowMainTopic", -"Получает список товаров сообщества": "Gets the community's product list", -"Текст лицензии доступен по ссылке:": "License text available at:", -"ПолучитьНастройкиУчетаВремени (хук": "GetTimekeepingSettings (wh", -"Выберите пункт **Входящий вебхук**": "Select **Incoming Webhook**", -"ТолстыйКлиентУправляемоеПриложение": "ThickClientManagedApplication", +"Структура JSON данных медиагруппы": "The structure of the JSON media group data", +"ПолучитьHexСтрокуИзДвоичныхДанных": "GetHexStringFromBinaryData", +"Bitrix24_ПолучитьИнформациюОФайле": "Bitrix24_GetFileInformation", +"Предпочтительное хранение токенов": "Preferred token storage", +"ВыполнитьЗапросМультипартРелэйтед": "ExecuteMultipartRelatedRequest", +"Получает информацию о книге по ID": "Gets information about the spreadsheet by ID", +"Открепляет сообщение в шапке чата": "Unpins a message in the chat header", +"Твиттер_ПолучитьСсылкуАвторизации": "Twitter_GetAuthorizationLink", +"ПолучитьДвоичныеДанныеИзHexСтроки": "GetBinaryDataFromHexString", +"Ссылка на страницу сайта магазина": "Link to the store's website page", +"Получает историю изменений задачи": "Get history of task changing", +"ПрекратитьНаблюдатьЗаЗадачей (хук": "StopWatchingTask (wh", +"URL к видеообложке для добавления": "URL of the video cover", +"Идентификатор удаляемого каталога": "ID of folder to be deleted", +"Действие над задачей не разрешено": "Action on the task is not allowed", +"Bitrix24_СоздатьКаталогВХранилище": "Bitrix24_CreateStorageFolder", +"УдалитьПользовательскоеПолеЗадачи": "DeleteCustomTaskField", +"Проверка_БитриксДоступныеДействия": "Check_BitrixAvailableActions", +"Телеграм_СоздатьСсылкуПриглашение": "TelegramAPI_CreateInvitationLink", +"ИзменитьАртикулыТоваров (обратный": "UpdateProductsArticles (reverse", +"ОтметитьСообщениеКакНепрочитанное": "MarkMessageAsUnreaded", +"Отступ получения элементов списка": "Offst of items list", +"УстановитьРеакциюНаСообщение (хук": "SetMessageReaction (wh", +"Перенести задачу в стадию канбана": "Move task to kanban stage", +"Путь помещения загруженного файла": "Path to place the downloaded file", +"Bitrix24_УбратьЗадачуИзИзбранного": "Bitrix24_RemoveTaskFromFavorites", +"v1.1. Поэтому что-то нужно делать": "v1.1. Therefore, something needs to be done", +"Получить лимиты работы с товарами": "Get products requests limits", +"Bitrix24_ПоместитьКаталогВКорзину": "Bitrix24_MarkFolderAsDeleted", +"Bitrix24_НачатьНаблюдатьЗаЗадачей": "Bitrix24_StartWatchingTask", +"Вес (за единицу товара, в граммах": "Weight (per unit, grams", +"Устанавливает новое описание чата": "Sets new chat description", +"Получить список категорий товаров": "Get a list of product categories", +"Вайбер_ПолучитьДанныеПользователя": "Viber_GetUserData", +"Проверка_БитриксСписокРезультатов": "Check_BitrixResultsList", +"Закрепляет сообщение в шапке чата": "Pins a message in the chat header", +"Обновляет токен по Refresh токену": "Update token by refresh token", +"ПолучитьСписокПользователейКанала": "GetChannelUserList", +"УдалитьЭлементЧеклистаЗадачи (хук": "DeleteTasksChecklistElement (wh", +"Отправляет в чат статус Вам пишут": "Send Writing... status to dialog", +"Dropbox_ПолучитьСписокФайловПапки": "Dropbox_GetFolderFileList", +"ОтклонитьЗаявкуНаВступление (один": "DisapprovePending (single", +"Методы интеграции с Telegram (ОПИ": "Telegram integration methods (OPI", +"JSON авторизации или путь к .json": "Authorization JSON or path to .json", +"Изменяет текст комментария задачи": "Changes task comment text", +"Получить участвующие товары акции": "Get current promo products", +"ID первого загруженного сообщения": "ID of first message", +"УстановитьСтатусПользователя (хук": "SetUserStatus (wh", +"Базы данных и электронные таблицы": "Databases and spreadsheets", +"Ноушн_ПолучитьИнформациюОСтранице": "Notion_GetPageInfo", +"Code из авторизации через браузер": "Code from browser auth page", +"Отправляет файл диска в чат по ID": "Send disk file to chat", +"ОтправитьТекстовоеСообщение (HTML": "SendTextMessage (HTML", +"Bitrix24_УдалитьКомментарийЗадачи": "Bitrix24_DeleteTaskComment", +"Структура JSON данных авторизации": "The structure of the JSON authentication data", +"Введите название вашей интеграции": "Enter the name of your integration", +"Выполнить элемент чеклиста задачи": "Complete tasks checklist element", +"Получает список доступных каналов": "Gets a list of available channels", +"Скачивает файл по указанному пути": "Downloads a file at the specified path", +"Dropbox_ВосстановитьОбъектКВерсии": "Dropbox_RestoreObjectToVersion", "Закрывает тему для новых сообщений": "Closes the thread for new messages", "Временная отметка или ID сообщения": "Timestamp or message ID", "Сохранить публичный объект на диск": "Save public object to disk", -"Telegram_ПоказатьГлавнуюТемуФорума": "Telegram_ShowMainForumTopic", -"ПолучитьСтурктуруПользователя (хук": "GetUserFieldsStructure (wh", -"ОзонАПИ_ЗагрузкаИОбновлениеТоваров": "OzonAPI_UploadingAndUpdatingProducts", "Вайбер_ОтправитьТекстовоеСообщение": "Viber_SendTextMessage", +"ПолучитьСтурктуруПользователя (хук": "GetUserFieldsStructure (wh", +"ТолстыйКлиентУправляемоеПриложение": "ThickClientManagedApplication", +"ОзонАПИ_ЗагрузкаИОбновлениеТоваров": "OzonAPI_UploadingAndUpdatingProducts", +"Telegram_ПоказатьГлавнуюТемуФорума": "Telegram_ShowMainForumTopic", +"Выберите пункт **Входящий вебхук**": "Select **Incoming Webhook**", +"Удаляет элемент из чеклиста задачи": "Deletes element from tasks checklist", +"Получает список товаров сообщества": "Gets the community's product list", +"Телеграм_СкрытьПоказатьГлавнуюТему": "TelegramAPI_HideShowMainTopic", +"необходимо будет ввести в браузере": "you will need to enter in the browser", +"ID товаров для создания штрихкодов": "Products IDs for barcodes creating", +"JSON - передается как путь к файлу": "JSON is passed as a path to a .json file", +"Получить структуру остатков товара": "Get product stocks structure", +"Текст (заголовок) пункта чек листа": "Text (title) of checklist element", +"Переадресация И Ответ.КодСостояния": "Redirection And Response.StatusCode", +"ПолучитьНастройкиУчетаВремени (хук": "GetTimekeepingSettings (wh", "Праздники и памятные даты Беларуси": "Holidays and memorable dates in Belarus", -"Идентификатор объекта для удаления": "Identifier of the object to delete", -"ОбработатьДанные Telegram Mini App": "Process Telegram Mini App data", -"Получить список пользователей чата": "Get chats users", -"Приостановить рекламное объявление": "Pause advertising post", -"Отметить сообщение как прочитанное": "Mark message as readed", -"Устанавливает значения ячеек листа": "Sets sheet cell values", -"Сформировать ссылку получения кода": "Generate code retrieval link", -"Проверка_БитриксСписокКомментариев": "Check_BitrixCommentsList", -"ПолучитьСписокКалендарейРекурсивно": "GetCalendarsListRecursively", -"ОпределитьМетодЗагрузкиИзображений": "DetermineImageUploadMethod", -"См. ПолучитьСписокКатегорийТоваров": "See GetProductCategoryList", -"Получить список трудозатрат задачи": "Get task time accounting list", -"Получить структуру фильтра товаров": "Get products filter structure", -"Идентификатор обновляемого объекта": "Identifier of the object to update", -"ДобавитьПользовательскоеПолеЗадачи": "AddCustomTaskField", -"Сохраните ClientID и Client Secret": "Save ClientID and Client Secret", -"ID целевого чата или IDЧата*IDТемы": "Target chat ID or ChatID*TopicID", -"ОтправитьТекстовоеСообщение (форум": "SendTextMessage (forum", -"ПолучитьВнешнююСсылкуКаталога (хук": "GetFolderExternalLink (wh", -"Bitrix24_ПолучитьСсылкуАвторизации": "Bitrix24_GetAuthLink", "Создает пустой каталог в хранилище": "Create new foldera at the storage", -"Прикрепляет файл к выбранной задаче": "Attaches a file to the selected task", -"Идентификатор каталога для загрузки": "Folder identifier", -"ВыполнитьЭлементЧеклистаЗадачи (хук": "CompleteTasksChecklistElement (wh", -"ПолучитьСтатусДобавленияТовара (хар": "GetProductCreationStatus (att", -"Dropbox_ДобавитьПользователейКПапке": "Dropbox_AddUsersToFolder", -"Получить структуру фильтра каталога": "Get fields structure for folder items filter", -"Получает информацию о диалоге по ID": "Get chat data by ID", -"Получает информацию событиях канала": "Gets information about channel events", -"Кнопки к сообщению, если необходимо": "Buttons to the message if necessary", -"Отправляет картинку в чат или канал": "Sends an image to a chat or channel", -"Загружает переданный файл в каталог": "Upload local file to the folder", -"Токен, полученный от widget.cdek.ru": "Token received from widget.cdek.ru", -"Получить список комментариев задачи": "Get comments list for a task", -"ПолучитьБуферДвоичныхДанныхИзСтроки": "GetBinaryDataBufferFromString", -"СоздатьПерсональноеУведомление (хук": "CreatePersonalNotification", -"ПолучитьСтатусАсинхронногоИзменения": "GetAsynchronousChangeStatus", -"ID родительского блока или страницы": "Parent block or page ID", -"Банит пользователя в выбранном чате": "Bans a user in the selected chat", -"Как OneScript пакет расширения ospx": "As a OneScript extension package in ospx format", -"Открывает ранее закрытое обсуждение": "Opens a previously closed discussion", -"Возобновить элемент чеклиста задачи": "Renew tasks checklist element", -"Создает сокращенный URL из обычного": "Creates a shortened URL from a regular one", -"Dropbox_ДобавитьПользователейКФайлу": "Dropbox_AddUsersToFile", -"Функции формирования описаний полей": "Functions for generating field descriptions", -"Выберите пункт создания нового бота": "Select the option to create a new bot", -"Получает информацию о внешнем файле": "Gets information about the external file", -"Получить дочерние элементы каталога": "Get folder child elements", -"сериализованный JSON ответа от CDEK": "serialized JSON response from CDEK", -"Получает массив календарей аккаунта": "Gets an array of account calendars", -"Dropbox_ПолучитьСтатусЗагрузкиПоURL": "Dropbox_GetUploadStatusByURL", -"Типы: audio, document, photo, video": "Types: audio, document, photo, video", -"ПолучитьСтатусДобавленияТовара (SKU": "GetProductCreationStatus (SKU", -"Изменяет свойства существующей базы": "Edits properties of an existing database", -"Идентификатор рабочего пространства": "Workspace identifier", -"Отправляет документ в чат или канал": "Sends a document to a chat or channel", -"VK_ПриостановитьРекламноеОбъявление": "VK_PauseAdvertising", -"ПолучитьСсылкуАвторизацииПриложения": "GetAppAuthLink", -"YandexDisk_ПолучитьИнформациюОДиске": "YandexDisk_GetDiskInfo", -"ID пользователя, затратившего время": "ID of user for time accounting", -"Дата указывается в формате ISO 8601": "Dates are specified in ISO 8601 format", -"ПолучитьПараметрыАвторизацииТвиттер": "GetTwitterAuthData", -"Планирование и управление проектами": "Planning and projects managment", +"ОбработатьДанные Telegram Mini App": "Process Telegram Mini App data", +"ДобавитьЭлементЧеклистаЗадачи (хук": "AddTasksChecklistElement (wh", +"Bitrix24_ПолучитьСсылкуАвторизации": "Bitrix24_GetAuthLink", +"ПолучитьВнешнююСсылкуКаталога (хук": "GetFolderExternalLink (wh", +"ОтправитьТекстовоеСообщение (форум": "SendTextMessage (forum", +"ID целевого чата или IDЧата*IDТемы": "Target chat ID or ChatID*TopicID", +"Сохраните ClientID и Client Secret": "Save ClientID and Client Secret", +"ДобавитьПользовательскоеПолеЗадачи": "AddCustomTaskField", +"Идентификатор обновляемого объекта": "Identifier of the object to update", +"Получить структуру фильтра товаров": "Get products filter structure", +"Получить список трудозатрат задачи": "Get task time accounting list", +"См. ПолучитьСписокКатегорийТоваров": "See GetProductCategoryList", +"ОпределитьМетодЗагрузкиИзображений": "DetermineImageUploadMethod", +"ПолучитьСписокКалендарейРекурсивно": "GetCalendarsListRecursively", +"Проверка_БитриксСписокКомментариев": "Check_BitrixCommentsList", +"Сформировать ссылку получения кода": "Generate code retrieval link", +"Устанавливает значения ячеек листа": "Sets sheet cell values", +"Отметить сообщение как прочитанное": "Mark message as readed", +"Приостановить рекламное объявление": "Pause advertising post", +"Получить список пользователей чата": "Get chats users", +"Идентификатор объекта для удаления": "Identifier of the object to delete", +"Bitrix24_ПолучитьСписокРезультатов": "Bitrix24_GetResultsList", +"Текст лицензии доступен по ссылке:": "License text available at:", +"Добавляет видео к атрибутам товара": "Adds video to product attributes", +"ОтправитьТекстовоеСообщение (канал": "SendTextMessage (channel", +"Создает твит с картинкой вложением": "Creates a tweet with an image attachment", +"Начинает учет времени пользователя": "Starts user timekeeping", +"querry из Telegram.WebApp.initData": "Query from Telegram.WebApp.initData", +"ФайлЛога = Новый Файл(ПутьКФайлу": "LogFile = New File(FilePath", +"Устанавливает новый заголовок чата": "Sets new chat title", +"ПолучитьСписокПользователейДиалога": "GetChatMembersList", +"ОтправитьТекстовоеСообщение (emoji": "SendTextMessage (emoji", +"ДобавитьПозиционныйПараметрКоманды": "AddPositionalCommandParameter", +"ЗаписатьПобитовоеИсключительноеИли": "WriteBitwiseXor", +"Bitrix24_ИзменитьКомментарийЗадачи": "Bitrix24_UpdateTaskComment", +"Соответствие изменяемых параметров": "Map of editable parameters", +"Количество единиц товара (в штуках": "Number of units (pcs", +"Переносит выбранные товары в архив": "Moves selected items to the archive", +"ИзменитьЭлементЧеклистаЗадачи (хук": "UpdateTasksChecklistElement (wh", +"ИзменитьПользовательскоеПолеЗадачи": "UpdateCustomTaskField", +"ДропБокс_ПолучитьСписокФайловПапки": "DropboxAPI_GetFolderFileList", +"Восстанавливает каталог из корзины": "Resotre folder form recycle bin", +"Получает данные пользователя по ID": "Gets user data by ID", +"ДобавитьИменованныйПараметрКоманды": "AddNamedCommandParameter", +"СформироватьПараметрыЗагрузкиФайла": "FormFileUploadParameters", +"ПеренестиЗадачуВСтадиюКанбана (хук": "MoveTaskToKanbanStage (wh", +"УдалитьРезультатИзКомментария (хук": "Delete result from comment", +"ЯДиск_ПолучитьСписокОпубликованных": "YDisk_GetPublishedList", +"ПолучитьЭлементЧеклистаЗадачи (хук": "GetTasksChecklistElement (wh", +"СоздатьРезультатИзКомментария (хук": "CreateResultFromComment (wh", +"Получает токен по коду авторизации": "Get token by auth code", +"Получает список пользователей чата": "Gets the list of chat members", +"Вайбер_ПолучитьОнлайнПользователей": "Viber_GetOnlineUsers", +"Выберите имя и добавьте разрешения": "Select a name and add permissions", +"HEX дополнительного цвета (#ffffff": "HEX secondary color (#ffffff", +"Путь для сохранение файла на Диске": "Path for saving the file to disk", +"Расширение файла в случае отправки": "File extension in case of sending", +"Изменяет свойства подборки товаров": "Edits the properties of a product selection", +"ПолучитьПользовательскоеПолеЗадачи": "GetCustomTaskField", +"Получает список результатов задачи": "Gets results list for task", +"ПРЕОБРАЗОВАТЬBASE64ВДВОИЧНЫЕДАННЫЕ": "CONVERTBASE64TOBINARY", +"Bitrix24_ДобавитьКомментарийЗадачи": "Bitrix24_AddTaskComment", +"Bitrix24_ПолучитьКомменатрийЗадачи": "Bitrix24_GetTaskComment", +"Получает описание поля типа булево": "Gets the description of a boolean field", +"ПолучитьСокращеннуюСтруктуруТовара": "GetSimplifiedProductStructure", +"Скачивает файл с серверов Telegram": "Download file from Telegram servers", +"Массив данных статистики по постам": "Array of post statistics data", +"Если Не ФайлЛога.Существует() Тогда": "If Not LogFile.Exists() Then", +"Получить список хранилищ приложения": "Get list of storages, available for current app", +"РаботаСПользовательскимиПолямиЗадач": "CustomsTasksFieldsManagment", +"Удаляет задачу из списка избранного": "Delete task from favorites list", +"Изменяет существующее подразделение": "Update an existing department", +"Получает основную информацию о боте": "Gets basic information about the bot", "Нажать \"Создать ключ\" и забрать его": "Click on 'Create key' and retrieve it", "Строка,Число,Массив из Строка,Число": "String,Number,Array of String,Number", -"Получает основную информацию о чате": "Gets basic information about the chat", -"Получает основную информацию о боте": "Gets basic information about the bot", -"Изменяет существующее подразделение": "Update an existing department", -"Удаляет задачу из списка избранного": "Delete task from favorites list", -"РаботаСПользовательскимиПолямиЗадач": "CustomsTasksFieldsManagment", -"Получить список хранилищ приложения": "Get list of storages, available for current app", -"Если Не ФайлЛога.Существует() Тогда": "If Not LogFile.Exists() Then", +"YandexDisk_ПолучитьИнформациюОДиске": "YandexDisk_GetDiskInfo", +"Планирование и управление проектами": "Planning and projects managment", +"ПолучитьПараметрыАвторизацииТвиттер": "GetTwitterAuthData", +"Дата указывается в формате ISO 8601": "Dates are specified in ISO 8601 format", "Наименование создаваемого календаря": "Name of the created calendar", +"ID пользователя, затратившего время": "ID of user for time accounting", +"Получает основную информацию о чате": "Gets basic information about the chat", "Тег уникальности Если уже существет": "Uniqueness Tag. If already exist", -"Получает дочерние элементы каталога": "Get folder child elements", -"Dropbox_ПолучитьСписокВерсийОбъекта": "Dropbox_GetObjectVersionList", -"ID темы. Главная, если не заполнено": "Thread ID. Main if not filled", -"Имя листа (первый лист по умолчанию": "Sheet name (first sheet by default", -"Завершает учет времени пользователя": "Stops user timekeeping", -"Тэг уникальности Если уже существет": "Uniqueness Tag. If already exist", -"Обработать данные Telegram Mini App": "Process Telegram Mini App data", -"Bitrix24_ПолучитьВнешнююСсылкуФайла": "Bitrix24_GetFileExternalLink", -"Dropbox_ПолучитьИнформациюОбОбъекте": "Dropbox_GetObjectInformation", "информация об ошибках синхронизации": "synchronization error information", -"Структура JSON данных массива полей": "The structure of the JSON array of fields data", -"Bitrix24_ДобавитьКомментарийНовости": "Bitrix24_AddPostComment", -"Создаёт товар по указанному Ozon ID": "Creates a product by specified Ozon ID", -"Получить список рекламных категорий": "Get a list of advertising categories", -"ПроверитьЗагрузкуИзображенийТоваров": "CheckProductsImagesUpload", -"Получает информацию о текущем диске": "Gets information about the current disk", +"Dropbox_ПолучитьСписокВерсийОбъекта": "Dropbox_GetObjectVersionList", "идентификатор товара в системе Ozon": "product identifier in the Ozon system", +"ПолучитьСсылкуАвторизацииПриложения": "GetAppAuthLink", +"Получает информацию о текущем диске": "Gets information about the current disk", +"ПроверитьЗагрузкуИзображенийТоваров": "CheckProductsImagesUpload", +"Получить список рекламных категорий": "Get a list of advertising categories", +"Создаёт товар по указанному Ozon ID": "Creates a product by specified Ozon ID", +"Получает дочерние элементы каталога": "Get folder child elements", +"Bitrix24_ДобавитьКомментарийНовости": "Bitrix24_AddPostComment", +"Dropbox_ПолучитьИнформациюОбОбъекте": "Dropbox_GetObjectInformation", +"Обработать данные Telegram Mini App": "Process Telegram Mini App data", +"Тэг уникальности Если уже существет": "Uniqueness Tag. If already exist", +"Завершает учет времени пользователя": "Stops user timekeeping", +"Имя листа (первый лист по умолчанию": "Sheet name (first sheet by default", +"ID темы. Главная, если не заполнено": "Thread ID. Main if not filled", +"Структура JSON данных массива полей": "The structure of the JSON array of fields data", +"VK_ПриостановитьРекламноеОбъявление": "VK_PauseAdvertising", +"Bitrix24_ПолучитьВнешнююСсылкуФайла": "Bitrix24_GetFileExternalLink", +"Идентификатор рабочего пространства": "Workspace identifier", +"ПолучитьБуферДвоичныхДанныхИзСтроки": "GetBinaryDataBufferFromString", +"Получить список комментариев задачи": "Get comments list for a task", +"Токен, полученный от widget.cdek.ru": "Token received from widget.cdek.ru", +"Загружает переданный файл в каталог": "Upload local file to the folder", +"Кнопки к сообщению, если необходимо": "Buttons to the message if necessary", +"Получает информацию событиях канала": "Gets information about channel events", +"СоздатьПерсональноеУведомление (хук": "CreatePersonalNotification", +"Получает информацию о диалоге по ID": "Get chat data by ID", +"Dropbox_ДобавитьПользователейКПапке": "Dropbox_AddUsersToFolder", +"ПолучитьСтатусДобавленияТовара (хар": "GetProductCreationStatus (att", +"ВыполнитьЭлементЧеклистаЗадачи (хук": "CompleteTasksChecklistElement (wh", +"Идентификатор каталога для загрузки": "Folder identifier", +"Прикрепляет файл к выбранной задаче": "Attaches a file to the selected task", +"Отправляет документ в чат или канал": "Sends a document to a chat or channel", +"Получить структуру фильтра каталога": "Get fields structure for folder items filter", +"ПолучитьСтатусАсинхронногоИзменения": "GetAsynchronousChangeStatus", +"Отправляет картинку в чат или канал": "Sends an image to a chat or channel", +"Банит пользователя в выбранном чате": "Bans a user in the selected chat", +"Изменяет свойства существующей базы": "Edits properties of an existing database", +"ID родительского блока или страницы": "Parent block or page ID", +"Типы: audio, document, photo, video": "Types: audio, document, photo, video", +"Dropbox_ПолучитьСтатусЗагрузкиПоURL": "Dropbox_GetUploadStatusByURL", +"Получает массив календарей аккаунта": "Gets an array of account calendars", +"сериализованный JSON ответа от CDEK": "serialized JSON response from CDEK", +"Получить дочерние элементы каталога": "Get folder child elements", +"Получает информацию о внешнем файле": "Gets information about the external file", +"ПолучитьСтатусДобавленияТовара (SKU": "GetProductCreationStatus (SKU", +"Функции формирования описаний полей": "Functions for generating field descriptions", +"Dropbox_ДобавитьПользователейКФайлу": "Dropbox_AddUsersToFile", +"Создает сокращенный URL из обычного": "Creates a shortened URL from a regular one", +"Возобновить элемент чеклиста задачи": "Renew tasks checklist element", +"Открывает ранее закрытое обсуждение": "Opens a previously closed discussion", +"Как OneScript пакет расширения ospx": "As a OneScript extension package in ospx format", +"Выберите пункт создания нового бота": "Select the option to create a new bot", +"Telegram_ОтправитьТекстовоеСообщение": "Telegram_SendTextMessage", +"Получить список просмотревших важное": "Get list of important post viewers", +"Внешний текстовый идентификатор поля": "Text identifier for external integration", +"Получает общее число участников чата": "Gets the total number of chat participants", +"Установить скидку на уцененный товар": "Set product discount", +"ПолучитьBase64СтрокуИзДвоичныхДанных": "GetBase64StringFromBinaryData", +"Результат чтения JSON ответа сервера": "Result of reading the JSON response from the server", +"Загружает файл в выбранное хранилище": "Upload file to storage root", +"Удалить пользовательское поле задачи": "Delete custom task field", +"Отправляет текстовое сообщение в чат": "Sends a text message to a chat", +"Отправляет аудиофайл в чат или канал": "Sends an audio file to a chat or channel", +"ПолучитьОписанияХарактеристикТоваров": "GetProductsAttributesData", +"Код тарифа (из доступных по договору": "Tariff code (from those available under the contract", +"Удаляет пользовательское поле задачи": "Deletes a custom task field", +"Dropbox_ПолучитьИнформациюОбАккаунте": "Dropbox_GetAccountInformation", +"Отправляет сообщение в выбранный час": "Sends a message at a selected hour", +"ПолучитьСписокОпубликованныхОбъектов": "GetPublishedObjectsList", +"Получает структуру полей комментария": "Get comment fields structure", +"Телеграм_ОтправитьТекстовоеСообщение": "TelegramAPI_SendTextMessage", +"Возвращает список заказов сообщества": "Returns the community's order list", +"Изменяет пользователя владельца чата": "Change chat owner", +"!OInt ОсвободитьОбъект(ТекущиеДанные": "!OInt FreeObject(CurrentData", +"Начинает наблюдение за задачей по ID": "Start watching a task by ID", +"ПолучитьСписокПользователейЧата (хук": "GetChatUsers (wh", +"Получить список отложенных сообщений": "Get list of delayed messages", +"Признак типа заказа Интернет магазин": "Flag of Online store order type", +"ОтправитьТекстовоеСообщение (простое": "SendTextMessage (simple", +"На конце URL должен быть ваш ID бота": "At the end of the URL should be your bot ID", +"Удаляет существующее свойство товара": "Deletes the existing product property", +"Модули непосредственной работы с API": "Modules for direct interaction with APIs", +"Bitrix24_ПолучитьИнформациюОКаталоге": "Bitrix24_GetFolderInformation", +"ПолучитьСоответствиеПараметровТовара": "GetProductParameterMapping", +"Устанавливает цель (описание) канала": "Sets the channel purpose (description)", +"URL = ПараметрыФункции[\"Bitrix24_URL": "URL = FunctionParameters[\"Bitrix24_URL", +"Добавляет задачу в список избранного": "Add task to favorites list", +"сериализованный JSON ответа от Viber": "serialized JSON response from Viber", "Телеграм_ЗакрепитьОткрепитьСообщение": "TelegramAPI_PinUnpinMessage", "Получает статистику в разрезе постов": "Gets statistics in terms of posts", -"Главный в группе, если есть в группе": "Main in the group, if exists in the group", +"ID последнего прочитанного сообщения": "Id of last readed message", "CommonModule.OPI_ПреобразованиеТипов": "CommonModule.OPI_TypeConversion", "ПолучитьКоличествоПодписчиковТоваров": "GetProductSubscribersCount", "Строка,Соответствие Из КлючИЗначение": "String, Map Of KeyAndValue", @@ -5165,61 +5201,53 @@ "Отключает режим Без звука для задачи": "Unmute task by ID", "Перемещает объект по выбранному пути": "Moves an object to the selected path", "Client secret из настроек приложения": "Client secret from app settings", -"Удаляет комментарий к записи таблицы": "Deletes a comment for a table record", +"Главный в группе, если есть в группе": "Main in the group, if exists in the group", "Отметить сообщение как непрочитанное": "Mark message as unreaded", -"Получить список пользователей канала": "Get channel user list", -"Bitrix24_ПолучитьХранилищеПриложения": "Bitrix24_GetAppStorage", -"ОтметитьСообщениеКакПрочитанное (хук": "MarkMessageAsReaded (wh", -"Идентификатор хранилища для загрузки": "Storage id", -"Получает информацию о странице по ID": "Gets information about the page by ID", -"Путь к опубликованному ранее объекту": "Path to the previously published object", -"Получить список ответов на сообщение": "Get list of message replies", -"ПолучитьДеревоКатегорийИТиповТоваров": "GetCategoriesAndProductTypesTree", -"!OInt Сообщить(\"Начало синхронизации": "!OInt Message(\"Start synchronization", -"Отправляет опрос с вариантами ответа": "Sends a poll with answer options", -"сериализованный JSON ответа от Slack": "serialized JSON response from Slack", -"ПолучитьСписокТрудозатратЗадачи (хук": "GetTaskTimeAccountingList (wh", -"Добавляет задачу в список избранного": "Add task to favorites list", -"ПолучитьСтруктуруФильтраКомментариев": "GetCommentsFilterStructure", +"Удаляет комментарий к записи таблицы": "Deletes a comment for a table record", "Получает список администраторов чата": "Gets the list of chat administrators", -"сериализованный JSON ответа от Viber": "serialized JSON response from Viber", -"ID последнего прочитанного сообщения": "Id of last readed message", -"URL = ПараметрыФункции[\"Bitrix24_URL": "URL = FunctionParameters[\"Bitrix24_URL", -"Получает структуру полей комментария": "Get comment fields structure", -"ПолучитьОписанияХарактеристикТоваров": "GetProductsAttributesData", -"Отправляет аудиофайл в чат или канал": "Sends an audio file to a chat or channel", -"Отправляет текстовое сообщение в чат": "Sends a text message to a chat", -"Результат чтения JSON ответа сервера": "Result of reading the JSON response from the server", -"Удалить пользовательское поле задачи": "Delete custom task field", -"Загружает файл в выбранное хранилище": "Upload file to storage root", -"Удаляет пользовательское поле задачи": "Deletes a custom task field", -"ПолучитьBase64СтрокуИзДвоичныхДанных": "GetBase64StringFromBinaryData", -"Установить скидку на уцененный товар": "Set product discount", -"Получает общее число участников чата": "Gets the total number of chat participants", -"Внешний текстовый идентификатор поля": "Text identifier for external integration", -"Получить список просмотревших важное": "Get list of important post viewers", -"Telegram_ОтправитьТекстовоеСообщение": "Telegram_SendTextMessage", -"Код тарифа (из доступных по договору": "Tariff code (from those available under the contract", -"Dropbox_ПолучитьИнформациюОбАккаунте": "Dropbox_GetAccountInformation", -"Устанавливает цель (описание) канала": "Sets the channel purpose (description)", -"ПолучитьСписокОпубликованныхОбъектов": "GetPublishedObjectsList", -"ПолучитьСоответствиеПараметровТовара": "GetProductParameterMapping", -"Bitrix24_ПолучитьИнформациюОКаталоге": "Bitrix24_GetFolderInformation", -"Модули непосредственной работы с API": "Modules for direct interaction with APIs", -"Удаляет существующее свойство товара": "Deletes the existing product property", -"На конце URL должен быть ваш ID бота": "At the end of the URL should be your bot ID", -"ОтправитьТекстовоеСообщение (простое": "SendTextMessage (simple", -"Признак типа заказа Интернет магазин": "Flag of Online store order type", -"Получить список отложенных сообщений": "Get list of delayed messages", -"ПолучитьСписокПользователейЧата (хук": "GetChatUsers (wh", -"Начинает наблюдение за задачей по ID": "Start watching a task by ID", -"!OInt ОсвободитьОбъект(ТекущиеДанные": "!OInt FreeObject(CurrentData", -"Изменяет пользователя владельца чата": "Change chat owner", -"Возвращает список заказов сообщества": "Returns the community's order list", -"Телеграм_ОтправитьТекстовоеСообщение": "TelegramAPI_SendTextMessage", -"Отправляет сообщение в выбранный час": "Sends a message at a selected hour", +"ПолучитьСписокТрудозатратЗадачи (хук": "GetTaskTimeAccountingList (wh", +"сериализованный JSON ответа от Slack": "serialized JSON response from Slack", +"Отправляет опрос с вариантами ответа": "Sends a poll with answer options", +"!OInt Сообщить(\"Начало синхронизации": "!OInt Message(\"Start synchronization", +"ПолучитьДеревоКатегорийИТиповТоваров": "GetCategoriesAndProductTypesTree", +"ПолучитьСтруктуруФильтраКомментариев": "GetCommentsFilterStructure", +"Путь к опубликованному ранее объекту": "Path to the previously published object", +"Получает информацию о странице по ID": "Gets information about the page by ID", +"Идентификатор хранилища для загрузки": "Storage id", +"ОтметитьСообщениеКакПрочитанное (хук": "MarkMessageAsReaded (wh", +"Bitrix24_ПолучитьХранилищеПриложения": "Bitrix24_GetAppStorage", +"Получить список ответов на сообщение": "Get list of message replies", +"Получить список пользователей канала": "Get channel user list", +"сериализованный JSON ответа от Google": "serialized JSON response from Google", +"Закрепляет выбранное сообщение в чате": "Pins the selected message in the chat room", +"ID свойства, куда добавляется вариант": "Property ID where the variant is added", +"Структура JSON данных описания таблиц": "The structure of the JSON table properties data", +"Копирует лист из одной книги в другую": "Copies a sheet from one spreadsheet to another", +"Telegram_ИзменитьИмяГлавнойТемыФорума": "Telegram_ChangeMainTopicName", +"Текст %%F0%%9F%%A%5%9D и emoji \\(10%%": "Text %%F0%%9F%%A5%%9D and emoji \\(10%%", +"ID версии (ревизии) для востановления": "ID of the version (revision) for restoration", +"Удаляет сообщение канала по timestamp": "Deletes a channel message by timestamp", +"Получает статус загрузки файла по URL": "Gets the upload status of the file by URL", +"ВозобновитьЭлементЧеклистаЗадачи (хук": "RenewTasksChecklistElement (wh", +"Прекращает наблюдение за задчей по ID": "Stop watching a task by ID", +"ПолучитьДочерниеЭлементыКаталога (хук": "GetFolderItems (wh", +"Получает описание поля файлового типа": "Gets the description of a file field", +"ПолучитьСтруктуруФильтраПользователей": "GetUserFilterStructure", +"Архивировать страницу или нет (булево": "Archive page or not (boolean", +"ЯДиск_ЗагрузитьПоАдресуПолучитьОбъект": "YDisk_UploadByUrlAndGetObject", +"Перемещает событие в другой календарь": "Moves an event to another calendar", +"Изменить пользовательское поле задачи": "Update custom task field", +"ID пользователей для проверки доступа": "User IDs for access checking", +"ID послднего непрочитанного сообщения": "ID of last unreaded message", +"сериализованный JSON ответа от Notion": "serialized JSON response from Notion", +"Bitrix24_ПрекратитьНаблюдатьЗаЗадачей": "Bitrix24_StopWatchingTask", +"Рассмотрим получение каждого значения": "Let's consider obtaining of each value", +"Получить пользовательское поле задачи": "Gets a custom task field", +"Получить список пользователей диалога": "Get chat members list", +"ID сообщения на которое надо ответить": "Reply to message ID", +"ПолучитьСтруктуруФильтраКаталога (хук": "GetFolderFilterStructure (wh", +"СформироватьКлавиатуруПоМассивуКнопок": "FormKeyboardFromButtonArray", "Для работы через Локальное приложение": "To work via Local Application", -"ПолучитьСписокХранилищПриложения (хук": "GetAppStoragesList (wh", "Возвращает выбранные товары из архива": "Returns selected items from the archive", "Телеграм_ПолучитьСписокАватаровФорума": "TelegramAPI_GetForumAvatarsList", "Добавить пользовательское поле задачи": "Add custom task field", @@ -5227,55 +5255,55 @@ "Массивы - передаются как строки вида ": "Arrays are passed as strings in the form", "Изменяет пользовательское поле задачи": "Updates a custom task field data", "Получает информацию о хранилище по ID": "Get information about storage", +"Для отображения скидки/изменения цены": "For displaying discount/changing price", "Telegram_ПолучитьСписокАватаровФорума": "Telegram_GetForumAvatarList", "СформироватьКлавиатуруИзМассиваКнопок": "CreateKeyboardFromArrayButton", "0 И ЗначениеЗаполнено(Страница) Тогда": "0 And ValueIsFilled(Page) Then", "Изменяет существующее свойство товара": "Edits the existing product property", -"URL, который нужно открыть в браузере": "the URL that needs to be opened in the browser", +"ПолучитьСписокХранилищПриложения (хук": "GetAppStoragesList (wh", "Структура JSON данных описания товара": "The structure of the JSON product description data", -"Если вам необходимо управлять каналом": "If you need to manage a channel", -"Пример указания параметра типа массив": "Example of specifying a parameter of array type", -"Получает описание поля числового типа": "Gets the description of a numeric field", -"ПолучитьСписокКомментариевЗадачи (хук": "GetTaskCommentsList (wh", -"ПреобразоватьДанныеСПолучениемРазмера": "ConvertDataWithSizeRetrieval", -"сериализованный JSON ответа от Yandex": "serialized JSON response from Yandex", -"Получает информацию о календаре по ID": "Gets calendar information by ID", -"Массив соответствий данных календарей": "Array of calendar data mappings", -"Получить сокращенную структуру товара": "Get simplified product structure", +"URL, который нужно открыть в браузере": "the URL that needs to be opened in the browser", "Получает информацию о файле по его ID": "Gets information about a file by ID", +"Получить сокращенную структуру товара": "Get simplified product structure", +"Массив соответствий данных календарей": "Array of calendar data mappings", +"Получает информацию о календаре по ID": "Gets calendar information by ID", "Пример структуры/соответствия свойств": "Example structure/property map", -"СформироватьКлавиатуруПоМассивуКнопок": "FormKeyboardFromButtonArray", -"Для отображения скидки/изменения цены": "For displaying discount/changing price", -"ID сообщения на которое надо ответить": "Reply to message ID", -"Получить пользовательское поле задачи": "Gets a custom task field", -"Удаляет сообщение канала по timestamp": "Deletes a channel message by timestamp", -"ID версии (ревизии) для востановления": "ID of the version (revision) for restoration", -"Текст %%F0%%9F%%A%5%9D и emoji \\(10%%": "Text %%F0%%9F%%A5%%9D and emoji \\(10%%", -"Копирует лист из одной книги в другую": "Copies a sheet from one spreadsheet to another", -"Telegram_ИзменитьИмяГлавнойТемыФорума": "Telegram_ChangeMainTopicName", -"ВозобновитьЭлементЧеклистаЗадачи (хук": "RenewTasksChecklistElement (wh", -"Структура JSON данных описания таблиц": "The structure of the JSON table properties data", -"ID свойства, куда добавляется вариант": "Property ID where the variant is added", -"Закрепляет выбранное сообщение в чате": "Pins the selected message in the chat room", -"сериализованный JSON ответа от Google": "serialized JSON response from Google", -"Получает статус загрузки файла по URL": "Gets the upload status of the file by URL", -"Прекращает наблюдение за задчей по ID": "Stop watching a task by ID", -"Получить список пользователей диалога": "Get chat members list", -"Получает описание поля файлового типа": "Gets the description of a file field", -"ПолучитьСтруктуруФильтраПользователей": "GetUserFilterStructure", -"Архивировать страницу или нет (булево": "Archive page or not (boolean", -"ПолучитьСтруктуруФильтраКаталога (хук": "GetFolderFilterStructure (wh", -"ЯДиск_ЗагрузитьПоАдресуПолучитьОбъект": "YDisk_UploadByUrlAndGetObject", -"Перемещает событие в другой календарь": "Moves an event to another calendar", -"Изменить пользовательское поле задачи": "Update custom task field", -"ПолучитьДочерниеЭлементыКаталога (хук": "GetFolderItems (wh", -"ID пользователей для проверки доступа": "User IDs for access checking", -"ID послднего непрочитанного сообщения": "ID of last unreaded message", -"сериализованный JSON ответа от Notion": "serialized JSON response from Notion", -"Bitrix24_ПрекратитьНаблюдатьЗаЗадачей": "Bitrix24_StopWatchingTask", -"Рассмотрим получение каждого значения": "Let's consider obtaining of each value", +"ПреобразоватьДанныеСПолучениемРазмера": "ConvertDataWithSizeRetrieval", +"ПолучитьСписокКомментариевЗадачи (хук": "GetTaskCommentsList (wh", +"Получает описание поля числового типа": "Gets the description of a numeric field", +"Пример указания параметра типа массив": "Example of specifying a parameter of array type", +"Если вам необходимо управлять каналом": "If you need to manage a channel", +"сериализованный JSON ответа от Yandex": "serialized JSON response from Yandex", +"Получает список тегов выбранных файлов": "Gets the list of tags of the selected files", +"Сохраняет картинку в альбом сообщества": "Saves an image to the community album", +"Истина > Деактивация, Ложь > Активация": "True > Deactivation, False > Activation", +"Bitrix24_СоздатьРезультатИзКомментария": "Bitrix24_CreateResultFromComment", +"РаботаСКомментариямиИРезультатамиЗадач": "CommentsAndResultsManagment", +"Получить элемент чеклиста задачи по ID": "Gets tasks checklist element by ID", +"Признак удаления отложенного сообщения": "Indicator of deleting a delayed message", +"Структура авторизации или путь к .json": "Auth data or path to .json file", +"Получить список подборок по массиву ID": "Gets the list of selections by array of IDs", +"сериализованный JSON ответа от Dropbox": "serialized JSON response from Dropbox", +"название лида (можно искать по шаблону": "lead name (can be searched by template", +"Первое приветственное сообщение в чате": "First chat message", +"Ключ > SKU товара, Значение > Штрихкод": "Key > product SKU, Value > barcode", +"Bitrix24_ПолучитьВнешнююСсылкуКаталога": "Bitrix24_GetFolderExternalLink", +"Создает твит с произвольным содержимым": "Creates a tweet with custom content", +"CommonModule.OPI_ПолучениеДанныхТестов": "CommonModule.OPI_TestDataRetrieval", +"Строка, Число, Массив Из Строка, Число": "String, Number, Array of String, Number", +"Изменяет артикулы существующих товаров": "Modifies articles of existing products", +"Получить ссылку авторизации приложения": "Get app authentication link", +"Bitrix24_УдалитьРезультатИзКомментария": "Bitrix24_DeleteResultFromComment", +"НачалоКодовОшибок И Ответ.КодСостояния": "StartOfErrorCodes And Response.StatusCode", +"Некорректный статус управления форумом": "Incorrect forum management status", +"Получает список свойств товаров группы": "Gets the list of properties of group products", +"Получить статус асинхронного изменения": "Get asynchronous change status", +"Получает список файлов бота или канала": "Gets a list of files of the bot or channel", +"Перемещает один каталог внутрь другого": "Moves one folder inside another", +"Код тарифа (подробнее см. приложение 1": "Tariff code", +"Получает описание поля строкового типа": "Gets the description of a string field", "сериализованный JSON ответа от Twitter": "serialized JSON response from Twitter", -"Получает список всех событий календаря": "Gets the list of all calendar events", +"Смещение в списке получаемых сообщений": "Offset in the list of received messages", "ОтметитьСообщениеКакНепрочитанное (хук": "MarkMessageAsUnreaded", "CLI версия Открытого пакета интеграций": "CLI version of OpenIntegrations", "единица измерения для веса, например g": "unit of measurement for weight, e.g. g", @@ -5286,7 +5314,7 @@ "Формирует клавиатуру по массиву кнопок": "Forms a keyboard from an array of buttons", "Проверить загрузку изображений товаров": "Check products images upload", "Проверка_ОзонДобавлениеКодов(Результат": "Check_OzonCodesUpload(Result", -"'Красный', 'Желтый','Зеленый' ,'Синий'": "'Red', 'Yellow', 'Green', 'Blue'", +"Получает список всех событий календаря": "Gets the list of all calendar events", "Получить app_id на странице приложения": "Get app_id at the application page", "tests/Modules/internal/OPI_ТестыCLI.os": "tests/Modules/internal/OPI_TestsCLI.os", "Проверка_ОзонЗаданиеЗагрузки(Результат": "Check_OzonUploadTask(Result", @@ -5297,38 +5325,35 @@ "ПолучитьСписокПросмотревшихВажное (хук": "GetImportantPostViewers (wh", "Генерирует новые штрихкоды для товаров": "Generates new barcodes for products", "УдалитьПользовательскоеПолеЗадачи (хук": "DeleteCustomTaskField (wh", -"Код тарифа (подробнее см. приложение 1": "Tariff code", "Удалить полностью (Истина) или закрыть": "Delete completely (True) or close", -"Получает описание поля строкового типа": "Gets the description of a string field", -"Смещение в списке получаемых сообщений": "Offset in the list of received messages", -"Перемещает один каталог внутрь другого": "Moves one folder inside another", -"Получить статус асинхронного изменения": "Get asynchronous change status", -"сериализованный JSON ответа от Dropbox": "serialized JSON response from Dropbox", -"Структура авторизации или путь к .json": "Auth data or path to .json file", -"Признак удаления отложенного сообщения": "Indicator of deleting a delayed message", -"РаботаСКомментариямиИРезультатамиЗадач": "CommentsAndResultsManagment", -"Получить элемент чеклиста задачи по ID": "Gets tasks checklist element by ID", -"название лида (можно искать по шаблону": "lead name (can be searched by template", -"Bitrix24_СоздатьРезультатИзКомментария": "Bitrix24_CreateResultFromComment", -"Истина > Деактивация, Ложь > Активация": "True > Deactivation, False > Activation", -"Сохраняет картинку в альбом сообщества": "Saves an image to the community album", -"Получает список тегов выбранных файлов": "Gets the list of tags of the selected files", -"Получить список подборок по массиву ID": "Gets the list of selections by array of IDs", -"Первое приветственное сообщение в чате": "First chat message", -"Получает список файлов бота или канала": "Gets a list of files of the bot or channel", -"Bitrix24_ПолучитьВнешнююСсылкуКаталога": "Bitrix24_GetFolderExternalLink", -"Создает твит с произвольным содержимым": "Creates a tweet with custom content", -"CommonModule.OPI_ПолучениеДанныхТестов": "CommonModule.OPI_TestDataRetrieval", -"Строка, Число, Массив Из Строка, Число": "String, Number, Array of String, Number", -"Ключ > SKU товара, Значение > Штрихкод": "Key > product SKU, Value > barcode", -"Изменяет артикулы существующих товаров": "Modifies articles of existing products", -"Получить ссылку авторизации приложения": "Get app authentication link", -"Bitrix24_УдалитьРезультатИзКомментария": "Bitrix24_DeleteResultFromComment", -"НачалоКодовОшибок И Ответ.КодСостояния": "StartOfErrorCodes And Response.StatusCode", -"Некорректный статус управления форумом": "Incorrect forum management status", -"Получает список свойств товаров группы": "Gets the list of properties of group products", +"'Красный', 'Желтый','Зеленый' ,'Синий'": "'Red', 'Yellow', 'Green', 'Blue'", +"идентификатор товара в системе продавца": "product identifier in the sellers system", +"ПолучитьСписокПользователейДиалога (хук": "GetChatMembersList", +"Дата отправки для отложенного сообщения": "Sending date for delayed message", +"Исключает текущего пользователя из чата": "Removes the current user from the chat room", +"Добавляет новый элемент чеклиста задачи": "Adds new element of tasks checklist", +"Зайти в раздел \"Управление\" в группе ВК": "Go to the 'Manage' section in the VK group", +"Создает каталог внутри другого каталога": "Create new folder inside another folder", +"сериализованный JSON ответа от Telegram": "serialized JSON response from Telegram", +"дата перемещения лида на текущую стадию": "date of moving the lead to the current stage", +"Получить описания харакетристик товаров": "Get products attributes data", +"Получить список опубликованных объектов": "Get list of published objects", +"Проверяет работоспособность токена бота": "Checks if the bot token is functional", +"Изменяет текст сущесствующего сообщения": "Changes the text of an existing message", +"Получает список опубликованных объектов": "Gets a list of published objects", +"Получить структуру фильтра комментариев": "Get structure of comments filter", +"HTTPОтвет, Произвольный, ДвоичныеДанные": "HTTPResponse, Arbitrary, BinaryData", +"ПолучитьПользовательскоеПолеЗадачи (хук": "GetCustomTaskField (wh", +"Перезаписывать файл при конфликте путей": "Overwrite file in case of path conflicts", +"сериализованный JSON ответа от Bitrix24": "serialized JSON of answer from Bitrix24 API", +"Bitrix24_ОтклонитьЗадачу(ПараметрыТеста": "Bitrix24_DisapproveTask(TestParameters", +"Путь к оригинальному файлу или каталогу": "Path to the original file or directory", +"Сохраните **ключ** и **код** приложения": "Save the **application key** and **application code**", +"ID существующей группы, если необходимо": "ID of the existing group, if needed", +"ПолучитьДанныеИспользованияПространства": "GetSpaceUsageData", +"сериализованный JSON ответа от Airtable": "serialized JSON response from Airtable", "URL, путь или данные файла для загрузки": "URL, path or file data", -"Создает результат задачи из комментария": "Create task result from comment", +"ПолучитьИнформациюОбАккаунте (сторонний": "GetAccountInformation (third-party", "Изменяет состав существующего сообщения": "Edits the content of an existing message", "Выберите пункт **Локальное приложение**": "Select **Local Application**", "URL = ПараметрыФункции[\"Bitrix24_URL": "URL = FunctionParameters[\"Bitrix24_URL", @@ -5337,51 +5362,47 @@ "ИзменитьПользовательскоеПолеЗадачи (хук": "UpdateCustomTaskField (wh", "Получает контент рейтинг товаров по SKU": "Gets products content rating by SKU", "ОчиститьСписокЗакрепленныхСообщенийТемы": "ClearThreadPinnedMessagesList", -"Изменяет текст элемента чеклиста задачи": "Updates text of element of tasks checklist", +"Создает результат задачи из комментария": "Create task result from comment", "сериализованный JSON ответа от Bitrxi24": "serialized JSON of answer from Bitrix24 API", -"Получить количество подписчиков товаров": "Get product subscribers count", -"Общие модули проекта бывают двух видов:": "The project's common modules come in two types:", -"ПолучитьДанныеИспользованияПространства": "GetSpaceUsageData", -"Скопируйте код из URL после авторизации": "Copy the code from the URL after authorization", -"device_code из ПолучитьКодПодтверждения": "device_code from GetConfirmationCode", -"Габариты упаковки. Длина (в сантиметрах": "Package Dimensions. Length (cm", -"Удаляет существующий комментарий задачи": "Delete task comment by ID", -"Изменяет свойства существующей страницы": "Changes the properties of an existing page", +"Изменяет текст элемента чеклиста задачи": "Updates text of element of tasks checklist", "сериализованный JSON ответа от VK Teams": "serialized JSON response from VK Teams", -"сериализованный JSON ответа от Airtable": "serialized JSON response from Airtable", -"ПолучитьИнформациюОбАккаунте (сторонний": "GetAccountInformation (third-party", -"ID существующей группы, если необходимо": "ID of the existing group, if needed", -"Путь к оригинальному файлу или каталогу": "Path to the original file or directory", -"Исключает текущего пользователя из чата": "Removes the current user from the chat room", -"Создает каталог внутри другого каталога": "Create new folder inside another folder", -"Зайти в раздел \"Управление\" в группе ВК": "Go to the 'Manage' section in the VK group", -"Добавляет новый элемент чеклиста задачи": "Adds new element of tasks checklist", -"дата перемещения лида на текущую стадию": "date of moving the lead to the current stage", -"Дата отправки для отложенного сообщения": "Sending date for delayed message", -"ПолучитьСписокПользователейДиалога (хук": "GetChatMembersList", -"идентификатор товара в системе продавца": "product identifier in the sellers system", -"сериализованный JSON ответа от Telegram": "serialized JSON response from Telegram", -"Получить описания харакетристик товаров": "Get products attributes data", -"Сохраните **ключ** и **код** приложения": "Save the **application key** and **application code**", -"Проверяет работоспособность токена бота": "Checks if the bot token is functional", -"Изменяет текст сущесствующего сообщения": "Changes the text of an existing message", -"Получает список опубликованных объектов": "Gets a list of published objects", -"Получить структуру фильтра комментариев": "Get structure of comments filter", -"Получить список опубликованных объектов": "Get list of published objects", -"HTTPОтвет, Произвольный, ДвоичныеДанные": "HTTPResponse, Arbitrary, BinaryData", -"ПолучитьПользовательскоеПолеЗадачи (хук": "GetCustomTaskField (wh", -"Перезаписывать файл при конфликте путей": "Overwrite file in case of path conflicts", -"сериализованный JSON ответа от Bitrix24": "serialized JSON of answer from Bitrix24 API", -"Bitrix24_ОтклонитьЗадачу(ПараметрыТеста": "Bitrix24_DisapproveTask(TestParameters", +"Удаляет существующий комментарий задачи": "Delete task comment by ID", +"Габариты упаковки. Длина (в сантиметрах": "Package Dimensions. Length (cm", +"Изменяет свойства существующей страницы": "Changes the properties of an existing page", +"Скопируйте код из URL после авторизации": "Copy the code from the URL after authorization", +"Общие модули проекта бывают двух видов:": "The project's common modules come in two types:", +"Получить количество подписчиков товаров": "Get product subscribers count", +"device_code из ПолучитьКодПодтверждения": "device_code from GetConfirmationCode", +"Массив вариантов опроса, если необходимо": "Array of poll options, if necessary", +"Код страны в формате ISO_3166-1_alpha-2": "Country code in the ISO_3166-1_alpha-2 format", +"Проверка_БитриксСтрока(Результат); SKIP": "Check_BitrixString(Result); SKIP", +"Добавляет список файлов к полям каталога": "Adds a list of files to the directory fields", +"ID публичного каталога (shared folder ID": "ID of the public catalog (shared folder ID", +"Создает комментарий к файлу или каталогу": "Creates a comment for a file or directory", +"Изменяет наименование существующей книги": "Changes the name of the existing spreadsheet", +"IDЗадания = Результат[\"result\"][\"task_id": "TaskID = Result[\"result\"][\"task_id", +"ПолучитьСтруктуруОбновленияХарактеристик": "GetAttributesUpdateStructure", +"Габариты упаковки. Ширина (в сантиметрах": "Package Dimensions. Width (cm", +"tools/Modules/OPI_ПреобразованиеТипов.os": "tools/Modules/OPI_TypeConversion.os", +"Блокирует выбранного пользователя в чате": "Blocks the selected user in chat", +"Добавляет стабию канбана или Моего плана": "Add new stage of kanban or My Plan", +"ПолучитьДеревоКатегорийИТиповТоваров (EN": "GetCategoriesAndProductTypesTree (EN", +"Загружает файл на диск по заданному пути": "Uploads a file to disk at the specified path", +"Получает информацию о файле или каталоге": "Gets information about a file or directory", +"ПолучитьСоответствиеРазделовТестирования": "GetTestingSectionMapping", +"Удаляет текстовый тег файла или каталога": "Deletes the text tag of a file or directory", +"Получает информацию о пользователе по ID": "Gets user information by ID", +"Получить структуру фильтра пользователей": "Get user filter structure", +"Идентификатор товара в системе Ozon (SKU": "Product identifier in the Ozon system (SKU", +"Изменяет текст существующего комментария": "Changes the text of an existing comment", "Получает список пользователей чата по ID": "Gets the list of chat users by ID", "Токен = ПараметрыФункции[\"Bitrix24_Token": "Token = FunctionParameters[\"Bitrix24_Token", "Габариты упаковки. Высота (в сантиметрах": "Package Dimensions. Height (cm", -"ID пользователя для отправки уведомления": "User ID for sending the notification", "сериализованный JSON ответа от Neocities": "serialized JSON response from Neocities", "Удаляет запись о трудозатратах из задачи": "Deletes record of time accounting", "Получает цены товаров с фильтром или без": "Gets products prices with or without filter", "ПолучитьЗаблокированныхПользователейЧата": "GetChatBlockedUsers", -"Массив идентификаторов вида photo123_123": "Array of identifiers like photo123_123", +"ID пользователя для отправки уведомления": "User ID for sending the notification", "Удаляет ранее созданный вариант свойства": "Deletes the previously created product property variant", "Получает каталог для хранения фйлов чата": "Get information about folder for chat files", "Скачивает файл по указанному пути или ID": "Downloads a file by the specified path or ID", @@ -5389,69 +5410,20 @@ "ID характеристики для получения значений": "Attribute IDs for obtaining values", "Устанавливает режим Без звука для задачи": "Mute task by ID", "Введите имя нового приложения и выберите": "Enter a name for the new application and select", +"Массив идентификаторов вида photo123_123": "Array of identifiers like photo123_123", "Удаляет календарь из списка пользователя": "Removes a calendar from the user's list", -"Идентификатор товара в системе Ozon (SKU": "Product identifier in the Ozon system (SKU", -"Изменяет текст существующего комментария": "Changes the text of an existing comment", -"Получает информацию о пользователе по ID": "Gets user information by ID", -"Получить структуру фильтра пользователей": "Get user filter structure", -"Массив вариантов опроса, если необходимо": "Array of poll options, if necessary", -"Проверка_БитриксСтрока(Результат); SKIP": "Check_BitrixString(Result); SKIP", -"Добавляет список файлов к полям каталога": "Adds a list of files to the directory fields", -"ID публичного каталога (shared folder ID": "ID of the public catalog (shared folder ID", -"Создает комментарий к файлу или каталогу": "Creates a comment for a file or directory", -"Изменяет наименование существующей книги": "Changes the name of the existing spreadsheet", -"Код страны в формате ISO_3166-1_alpha-2": "Country code in the ISO_3166-1_alpha-2 format", -"IDЗадания = Результат[\"result\"][\"task_id": "TaskID = Result[\"result\"][\"task_id", -"Удаляет текстовый тег файла или каталога": "Deletes the text tag of a file or directory", -"Габариты упаковки. Ширина (в сантиметрах": "Package Dimensions. Width (cm", -"tools/Modules/OPI_ПреобразованиеТипов.os": "tools/Modules/OPI_TypeConversion.os", -"Блокирует выбранного пользователя в чате": "Blocks the selected user in chat", -"ПолучитьСтруктуруОбновленияХарактеристик": "GetAttributesUpdateStructure", -"Добавляет стабию канбана или Моего плана": "Add new stage of kanban or My Plan", -"ПолучитьДеревоКатегорийИТиповТоваров (EN": "GetCategoriesAndProductTypesTree (EN", -"Загружает файл на диск по заданному пути": "Uploads a file to disk at the specified path", -"Получает информацию о файле или каталоге": "Gets information about a file or directory", -"ПолучитьСоответствиеРазделовТестирования": "GetTestingSectionMapping", -"Получает список доступных хранилищ файлов": "Get list of available files storages", -"См. СформироватьКлавиатуруПоМассивуКнопок": "See GenerateKeyboardFromArray", -"URL = ПараметрыФункции[\"Bitrix24_Domain": "URL = FunctionParameters[\"Bitrix24_URL", -"ID чата источника оригинального сообщения": "Source chat ID", -"Путь или несколько путей удаляемых файлов": "Path or multiple paths of the files to be deleted", -"идентификатор автора последнего изменения": "author ID of the last change", -"Необходимость сформировать печатную форму": "Need to generate a document", -"Кодировка, в которой записаны JSON данные": "Encoding of JSON Data", -"Перейдите в **[основной интерфейс Notion]": "Go to the **[main interface of Notion]", -"Bitrix24_ПолучитьДочерниеЭлементыКаталога": "Bitrix24_GetFolderItems", -"Изменяет свойства существуещего календаря": "Edits properties of an existing calendar", -"Получить дерево категорий и типов товаров": "Get categories and product types tree", -"Делегирует задачу на другого пользователя": "Delegate task to another user", -"Артикулы: Ключ > старый, Значение > новый": "Articles: Key > current, Value > new", -"Сформировать клавиатуру по массиву кнопок": "Generate keyboard from array of buttons", -"Добавляет указанных пользователей в канал": "Adds specified users to the channel", -"ОбработкаВходящегоЗапросаПослеАвторизации": "HandleIncomingRequestAfterAuthorization", -"дата перемещения сделки на текущую стадию": "date of moving the deal to the current stage", -"Сформировать клавиатуру из массива кнопок": "Create a keyboard from an array of buttons", -"См. СформироватьКлавиатуруИзМассиваКнопок": "See CreateKeyboardFromArrayButton", -"Признак исключения архивированных каналов": "Indicator of excluding archived channels", -"|--------[через 2 ч.]-------------------|": "|--------[after 2 hrs.]-------------------|", -"Возвращает URL для авторизации в браузере": "Returns URL for browser authorization", -"и пройдите процедуру создания нового бота": "and follow the procedure to create a new bot", -"действия будут выполняться от лица группы": "actions will be performed on behalf of the group", -"Новые или изменяемые свойства базы данных": "New or modified database properties", -"Массив двоичных данных или путей к файлам": "Array of binary data or file paths", -"Получает список записей выбранной таблицы": "Gets the list of records of the selected table", -"ПолучитьСсылкуСкачиванияПубличногоОбъекта": "GetDownloadLinkForPublicObject", -"ID цитируемого сообщения, если необходимо": "Replying message id if necessary", -"Удаляет указанного пользователя из канала": "Removes specified user from channel", -"Получает список элементов чеклиста задачи": "Gets the list of elements on the task checklist", -"Тип отправителя: LEGAL_ENTITY, INDIVIDUAL": "Sender type: LEGAL_ENTITY, INDIVIDUAL", -"Получает описание поля с номером телефона": "Gets the description of a phone number field", -"Стиль кнопки: primary, attention или base": "Button style: primary, attention or base", -"название лида (можно искать по шаблону [%": "lead name (can be searched using the template [%", "Создает комментарий под выбранной записью": "Creates a comment under the selected record", +"название лида (можно искать по шаблону [%": "lead name (can be searched using the template [%", +"Стиль кнопки: primary, attention или base": "Button style: primary, attention or base", +"Получает описание поля с номером телефона": "Gets the description of a phone number field", +"ID цитируемого сообщения, если необходимо": "Replying message id if necessary", +"Получает список элементов чеклиста задачи": "Gets the list of elements on the task checklist", +"Удаляет указанного пользователя из канала": "Removes specified user from channel", +"ПолучитьСсылкуСкачиванияПубличногоОбъекта": "GetDownloadLinkForPublicObject", "Публикует объект диска в публичный доступ": "Publishes the disk object for public access", +"Тип отправителя: LEGAL_ENTITY, INDIVIDUAL": "Sender type: LEGAL_ENTITY, INDIVIDUAL", "Bitrix24_ПолучитьСписокКомментариевЗадачи": "Bitrix24_GetTaskCommentsList", -"Добавляет видеообложку к атрибутам товара": "Adds a video cover to the product attributes", +"ПолучитьСписокПользовательскихПолейЗадачи": "GetCustomTaskFieldsList", "Как отдельный файл расширения формата cfe": "As a standalone extension file in cfe format", "Изменяет значения полей выбранного заказа": "Changes the field values of the selected order", "Изменяет наименование и|или описание базы": "Changes the name and/or description of the base", @@ -5460,60 +5432,69 @@ "Bitrix24_ПолучитьСтруктуруФильтраКаталога": "Bitrix24_GetFolderFilterStructure", "Создает пустой каталог по выбранному пути": "Creates an empty directory at the selected path", "Bitrix24_ПолучитьСписокХранилищПриложения": "Bitrix24_GetAppStoragesList", -"ПолучитьСписокПользовательскихПолейЗадачи": "GetCustomTaskFieldsList", -"С вложениями (в примере: блок с картинкой": "With attachments (picture block in the example", -"Получает список всех комментариев объекта": "Gets the list of all comments of the object", "Удаляет новость из ленты по выбранному ID": "Remove post from a news feed", +"Получает список всех комментариев объекта": "Gets the list of all comments of the object", +"Получает список записей выбранной таблицы": "Gets the list of records of the selected table", +"Добавляет видеообложку к атрибутам товара": "Adds a video cover to the product attributes", +"Массив двоичных данных или путей к файлам": "Array of binary data or file paths", +"С вложениями (в примере: блок с картинкой": "With attachments (picture block in the example", +"действия будут выполняться от лица группы": "actions will be performed on behalf of the group", +"Новые или изменяемые свойства базы данных": "New or modified database properties", +"Получает список доступных хранилищ файлов": "Get list of available files storages", +"См. СформироватьКлавиатуруПоМассивуКнопок": "See GenerateKeyboardFromArray", +"URL = ПараметрыФункции[\"Bitrix24_Domain": "URL = FunctionParameters[\"Bitrix24_URL", +"ID чата источника оригинального сообщения": "Source chat ID", +"идентификатор автора последнего изменения": "author ID of the last change", +"Необходимость сформировать печатную форму": "Need to generate a document", +"Кодировка, в которой записаны JSON данные": "Encoding of JSON Data", +"Перейдите в **[основной интерфейс Notion]": "Go to the **[main interface of Notion]", +"Bitrix24_ПолучитьДочерниеЭлементыКаталога": "Bitrix24_GetFolderItems", +"Изменяет свойства существуещего календаря": "Edits properties of an existing calendar", +"Получить дерево категорий и типов товаров": "Get categories and product types tree", +"Путь или несколько путей удаляемых файлов": "Path or multiple paths of the files to be deleted", +"Артикулы: Ключ > старый, Значение > новый": "Articles: Key > current, Value > new", +"Делегирует задачу на другого пользователя": "Delegate task to another user", +"и пройдите процедуру создания нового бота": "and follow the procedure to create a new bot", +"Возвращает URL для авторизации в браузере": "Returns URL for browser authorization", +"|--------[через 2 ч.]-------------------|": "|--------[after 2 hrs.]-------------------|", +"См. СформироватьКлавиатуруИзМассиваКнопок": "See CreateKeyboardFromArrayButton", +"Признак исключения архивированных каналов": "Indicator of excluding archived channels", +"Сформировать клавиатуру из массива кнопок": "Create a keyboard from an array of buttons", +"дата перемещения сделки на текущую стадию": "date of moving the deal to the current stage", +"ОбработкаВходящегоЗапросаПослеАвторизации": "HandleIncomingRequestAfterAuthorization", +"Добавляет указанных пользователей в канал": "Adds specified users to the channel", +"Сформировать клавиатуру по массиву кнопок": "Generate keyboard from array of buttons", +"Ошибка преобразовани данных параметра JSON": "JSON Parameter Data Conversion Error", +"Ввести название приложения и выбрать пункт": "Enter the application name and select the ", +"ID поста, используемого в качетсве рекламы": "ID of the post used for advertising", +"Отправляет внейшний файл по списку каналов": "Sends an external file to a list of channels", +"необходимо будет передать в другую функцию": "you will need to pass to another function", +"tools/Modules/OPI_ПолучениеДанныхТестов.os": "tools/Modules/OPI_TestDataRetrieval.os", +"Bitrix24_ПолучитьСписокПросмотревшихВажное": "Bitrix24_GetImportantPostViewers", +"Получает постоянный UTL к сообщению канала": "Gets a permanent URL to the channel message", +"Получает информацию о текущем пользователе": "Get current user data", +"Установите Webhook. См. Установить Webhook": "Set webhook (see Set webhook)", +"Отправляет файл (документ) в чат или канал": "Sends a file (document) to a chat or channel", +"Создает системное уведомление пользователю": "Creates a system notification to the user", +"Получает статус учета времени пользователя": "Gets user timekeeping status", +"Идентификаторы товаров в системе Ozon (SKU": "Products identifiers in the Ozon system (SKU", +"Получает список товаров с фильтром или без": "Gets a list of products with or without filter", +"Структура полей товара с добавленным видео": "Structure of product fields with added video", +"Разбанивает забаненного ранее пользователя": "Unbans a previously banned user", "JSON клавиатуры. См.СформироватьКлавиатуру": "JSON keyboard. See FormKeyboard", "Получить данные использования пространства": "Get space usage data", "Перемещает файл в корзину удаляемых файлов": "Move file to recycle bin", "Создает зависимость одной задачи от другой": "Creates the dependency of one task to another", "Удаляет зависимость одной задачи от другой": "Removes the dependency of one task to another", "Сформировать клавиатуру из массива кнопок:": "Create a keyboard from an array of buttons:", -"Получает пустой макет для создания события": "Gets an empty layout to create the event", +"Приостанавливает учет времени пользователя": "Pauses user timekeeping", "Обновляет характеристики выбранных товаров": "Updates the attributes of the selected items", "Отменяет режим общего доступа для каталога": "Cancels the public access mode for the directory", "Очищает список событий основного календаря": "Clears the event list of the primary calendar", "Добавляет новый товар в каталог сообщества": "Adds a new product to the community's catalog", "Отображать ответ как предупреждение (alert": "Display the answer as an alert", "ОтправитьТекстовоеСообщение (текст и emoji": "SendTextMessage (text and emoji", -"Разбанивает забаненного ранее пользователя": "Unbans a previously banned user", -"Приостанавливает учет времени пользователя": "Pauses user timekeeping", -"Получает список товаров с фильтром или без": "Gets a list of products with or without filter", -"Получает статус учета времени пользователя": "Gets user timekeeping status", -"необходимо будет передать в другую функцию": "you will need to pass to another function", -"Ввести название приложения и выбрать пункт": "Enter the application name and select the ", -"ID поста, используемого в качетсве рекламы": "ID of the post used for advertising", -"Отправляет внейшний файл по списку каналов": "Sends an external file to a list of channels", -"Ошибка преобразовани данных параметра JSON": "JSON Parameter Data Conversion Error", -"tools/Modules/OPI_ПолучениеДанныхТестов.os": "tools/Modules/OPI_TestDataRetrieval.os", -"Идентификаторы товаров в системе Ozon (SKU": "Products identifiers in the Ozon system (SKU", -"Получает постоянный UTL к сообщению канала": "Gets a permanent URL to the channel message", -"Получает информацию о текущем пользователе": "Get current user data", -"Установите Webhook. См. Установить Webhook": "Set webhook (see Set webhook)", -"Структура полей товара с добавленным видео": "Structure of product fields with added video", -"Отправляет файл (документ) в чат или канал": "Sends a file (document) to a chat or channel", -"Bitrix24_ПолучитьСписокПросмотревшихВажное": "Bitrix24_GetImportantPostViewers", -"Создает системное уведомление пользователю": "Creates a system notification to the user", -"Очистить список закрепленных сообщений темы": "Clear thread's pinned messages list", -"Получает описание товара по идентификаторам": "Get product description by IDs", -"конкретное значение при указании имени поля": "Specific Value When Specifying Field Name", -"Получает структуру стандартных полей товара": "Gets the structure of product standard fields", -"Релизы библиотеки выходят в пяти вариантах:": "The library releases come in five variants:", -"Открытый пакет интеграций с популярными API": "Open integrations package with popular API aboard", -"Отправляет ранее загруженный файл по его ID": "Sends a previously uploaded file by ID", -"Получить структуру обновления характеристик": "Get attributes update structure", -"Получает внешнюю ссылку для доступа к файлу": "Get external link to file", -"Удаляет ранее добавленный товар из подборки": "Removes a previously added product from the selection", -"Получает список отложенных сообщений канала": "Gets a list of delayed channel messages", -"Создает новый чат на основе структуры полей": "Creates a new chat based on the field structure", -"Время удержания соединения для Long Polling": "Connection hold time for Long Polling", -"Красный, желтый, синий или какой-то другой?": "Red, yellow, blue, or some other?", -"Получить заблокированных пользователей чата": "Get chat blocked users", -"Массив доступов по задачам, если необходимо": "Rights array if required", -"Используется в т-нии 2-х часов для запросов": "2 hrs. lifetime", -"ПолучитьБуферДвоичныхДанныхИзДвоичныхДанных": "GetBinaryDataBufferFromBinaryData", -"Токен = ПараметрыФункции[\"Bitrix24_Token": "Token = FunctionParameters[\"Bitrix24_Token", +"Получает пустой макет для создания события": "Gets an empty layout to create the event", "Получает описание поля с электронной почтой": "Gets the description of an email field", "Ошибка типа значения соответствия артикулов": "Article value type error ", "Получает информацию о товарах по массиву ID": "Gets information about products by array of IDs", @@ -5521,360 +5502,380 @@ "Обновляет v2 токен при помощи refresh_token": "Updates the v2 token using the refresh_token", "ID файла, к которому предоставляется доступ": "ID of the file to be accessed", "название сделки (можно искать по шаблону [%": "deal name (can be searched using the template [%", -"Авторизоваться в браузере по ссылке из п.1.": "Authorize in the browser using the link from step 1", -"название задачи (можно искать по шаблону [%": "task name (can be searched using the template [%", "Получает информацию о папке или файле по ID": "Gets information about a folder or file by ID", +"название задачи (можно искать по шаблону [%": "task name (can be searched using the template [%", "Текстовый идентификатор (наименование) поля": "Text identifier (name) of the field", "Добавляет пользователей в чат по массиву ID": "Adds users to the chat by ID array", "единица измерения для размеров, например mm": "unit of measure for sizes, e.g. mm", -"Ошибка получения данных булево из параметра": "Error getting boolean data from parameter", +"Токен = ПараметрыФункции[\"Bitrix24_Token": "Token = FunctionParameters[\"Bitrix24_Token", "Переносит задачу в выбранную стадию канбана": "Move task to another kanban stage", +"Авторизоваться в браузере по ссылке из п.1.": "Authorize in the browser using the link from step 1", +"Ошибка получения данных булево из параметра": "Error getting boolean data from parameter", +"ПолучитьБуферДвоичныхДанныхИзДвоичныхДанных": "GetBinaryDataBufferFromBinaryData", +"Массив доступов по задачам, если необходимо": "Rights array if required", +"Используется в т-нии 2-х часов для запросов": "2 hrs. lifetime", +"Очистить список закрепленных сообщений темы": "Clear thread's pinned messages list", +"Получает описание товара по идентификаторам": "Get product description by IDs", +"конкретное значение при указании имени поля": "Specific Value When Specifying Field Name", +"Получает структуру стандартных полей товара": "Gets the structure of product standard fields", +"Открытый пакет интеграций с популярными API": "Open integrations package with popular API aboard", +"Отправляет ранее загруженный файл по его ID": "Sends a previously uploaded file by ID", +"Релизы библиотеки выходят в пяти вариантах:": "The library releases come in five variants:", +"Получает внешнюю ссылку для доступа к файлу": "Get external link to file", +"Удаляет ранее добавленный товар из подборки": "Removes a previously added product from the selection", +"Получает список отложенных сообщений канала": "Gets a list of delayed channel messages", +"Создает новый чат на основе структуры полей": "Creates a new chat based on the field structure", +"Время удержания соединения для Long Polling": "Connection hold time for Long Polling", +"Красный, желтый, синий или какой-то другой?": "Red, yellow, blue, or some other?", +"Получить заблокированных пользователей чата": "Get chat blocked users", +"Получить структуру обновления характеристик": "Get attributes update structure", +"Приостанавливает показ рекламного объявления": "Pauses the display of the advertising post", +"Получает шаблон описания для создания товара": "Gets the description template for creating a product", +"ID последнего обработанного до этого события": "ID of the last event processed before this event", +"Загружает файлы на сервер и возвращает их ID": "Uploads files to the server and returns their IDs", +"Показывает ранее скрытую главную тему форума": "Shows a previously hidden main forum thread", +"Авторизоваться через ВК и подтвердить доступ": "Authorize through VK and confirm access", +"Получает список акций, доступных для участия": "Gets a list of available promotions", +"Изменяет цвет чата для мобильного приложения": "Chat chat color for mobile app", +"ПолучитьДвоичныеДанныеИзБуфераДвоичныхДанных": "GetBinaryDataFromBinaryDataBuffer", +"ID пользователя или нескольких пользователей": "Usesr ID or array of users IDs", +"Похоже, что в ответе пришли двоичные данные!": "It Seems Binary Data Was Received in Response!", +"не получится (access_token тоже не получится": "won't work (access_token won't work either", +"Сумма наложенного платежа, в том числе и НДС": "Amount of cash on delivery, including VAT", +"Копирует файл или каталог по выбранному пути": "Copies a file or directory to the selected path", +"Создает рекламное объявление на основе поста": "Creates an advertising post based on a post", +"Флаг использования API для тестовых запросов": "Flag to use test API for requests", +"Удалить объект без возможности востановления": "Delete object without the possibility of recovery", +"Bitrix24_ПолучитьСсылкуАвторизацииПриложения": "Bitrix24_GetAppAuthLink", +"По этой ссылке необходимо перейти в браузере": "You need to follow this link in your browser", "Получает структуру для отбора списка товаров": "Gets the structure for selecting the list of products", -"Преобразует файл с Base64 строкой в бинарный": "Convert Base64 String to Binary File", "Этот раздел посвящен библиотеке для работы с": "This section is dedicated to the library for working with", "Получает список запросов на вступление в чат": "Gets a list of requests to join the chat room", "Добавляет вариант для существующего свойства": "Adds a variant for an existing property", "Перейдите на [главную страницу Google Cloud]": "Go to the [Google Cloud Console]", "Создает ссылку для вступления в закрытый чат": "Creates a link for joining a closed chat", -"Ключ разработчика (для разработчиков модулей": "Developer key (for module developers", +"Преобразует файл с Base64 строкой в бинарный": "Convert Base64 String to Binary File", "Загружает одиночный файл на сервер Neocities": "Upload single file to Neocities", "Получает новый токен на основе рефреш токена": "Gets a new token based on the refresh token", "Изменяет цены однного или нескольких товаров": "Changes the price of one or more items", "Получает товары, доступные в выбранной акции": "Gets the products available in the selected promotion", "Переводит каталог в режим публичного доступа": "Sets the directory to public access mode", "URL = ПараметрыФункции[\"Bitrix24_Domain": "URL = FunctionParameters[\"Bitrix24_UR", -"Bitrix24_ПолучитьСсылкуАвторизацииПриложения": "Bitrix24_GetAppAuthLink", -"По этой ссылке необходимо перейти в браузере": "You need to follow this link in your browser", -"Флаг использования API для тестовых запросов": "Flag to use test API for requests", -"Изменяет цвет чата для мобильного приложения": "Chat chat color for mobile app", -"Получает шаблон описания для создания товара": "Gets the description template for creating a product", -"ID последнего обработанного до этого события": "ID of the last event processed before this event", -"Загружает файлы на сервер и возвращает их ID": "Uploads files to the server and returns their IDs", -"Показывает ранее скрытую главную тему форума": "Shows a previously hidden main forum thread", -"Авторизоваться через ВК и подтвердить доступ": "Authorize through VK and confirm access", -"Приостанавливает показ рекламного объявления": "Pauses the display of the advertising post", -"Получает список акций, доступных для участия": "Gets a list of available promotions", -"Создает рекламное объявление на основе поста": "Creates an advertising post based on a post", -"ПолучитьДвоичныеДанныеИзБуфераДвоичныхДанных": "GetBinaryDataFromBinaryDataBuffer", -"ID пользователя или нескольких пользователей": "Usesr ID or array of users IDs", -"Удалить объект без возможности востановления": "Delete object without the possibility of recovery", -"не получится (access_token тоже не получится": "won't work (access_token won't work either", -"Сумма наложенного платежа, в том числе и НДС": "Amount of cash on delivery, including VAT", -"Копирует файл или каталог по выбранному пути": "Copies a file or directory to the selected path", -"Похоже, что в ответе пришли двоичные данные!": "It Seems Binary Data Was Received in Response!", -"Атрибуты, индивидуальные для разных категорий": "Attributes individualized for different categories", -"Получает список пользователей рабочей области": "Gets a list of users in the workspace", -"зарегистрироваться и создать новое приложение": "register, and create a new application", -"Выберите необходимый сайт из списка и нажмите": "Select the site from the list and click", -"Возвращает структура клавиатуры для сообщений": "Returns a keyboard structure for messages", -"Не удалось получить информацию из json медиа!": "Failed to Retrieve Information from JSON media!", -"Раскомментировать, если выполняется OneScript": "Uncomment if OneScript is executed", -"Изменяет данные записи о трудозатратах задачи": "Update time accounting record data", -"Удалить последние сообщения перед блокировкой": "Delete last messages before blocking", -"Получить список пользовательских полей задачи": "Get list of custom task fields", -"Получает токен авторизации по логину и паролю": "Receives authorization token by login and password", -"Цены товаров. См. ПолучитьСтруктуруЦеныТовара": "Products prices. See GetProductPriceStructure", -"Требования: платформа 1С версии 8.3.10 и выше": "Requirements: 1C platform version 8.3.10 and above", +"Ключ разработчика (для разработчиков модулей": "Developer key (for module developers", "Повторно открывает ранее закрытую тему форума": "Reopens a previously closed forum thread", "Даты - передаются как строки формата ISO 8601": "Dates are passed as strings in ISO 8601 format", "Копирует файл из одного расположения в другое": "Copy file from one destination to another", "Получить ссылку скачивания публичного объекта": "Get download link for public object", -"Идентификатор новой подборки, если необходимо": "Identifier of the new selection, if needed", +"Получает настройки учета времени пользователя": "Gets user timekeeping settings", "Перемещает каталог в корзину удаляемых файлов": "Move folder to recycle bin", "Сумма НДС, включённая в доп. сбор за доставку": "VAT included in additional delivery charge", -"Получает настройки учета времени пользователя": "Gets user timekeeping settings", "Создает персональное уведомление пользователю": "Creates a personal notification to the user", -"Проверяет доступность задачи для пользователей": "Checks the availability of the task for users", -"Получает информацию о комментарии задачи по ID": "Gets task comment data by ID", -"ПолучитьСписокПользовательскихПолейЗадачи (хук": "GetCustomTaskFieldsList (wh", -"Скрыть старые сообщения от новых пользователей": "Hide old messages from new members", -"Открепляет ранее закрепленное сообщение в чате": "Unpins a previously pinned chat message", -"URL, по которому необходимо перейти в браузере": "URL to go to in the browser", -"Список адресов почты добавляемых пользователей": "List of email addresses of users being added", -"Устанавливает или снимает реакцию на сообщение": "Set or remove reaction mark on the message", -"Истина > отправляет файлы отдельными запросами": "True > sends files in separate requests", -"Клавиатура под сообщением или на нижней панели": "Keyboard under the message or on the bottom panel", -"Сумма дополнительного сбора (в том числе и НДС": "Amount of additional fee (including VAT", -"Токен авторизации, если используется не вебхук": "Access token, when app auth method used", -"Порог стоимости товара в целых единицах валюты": "Threshold for the value of goods in whole units of currency", -"Отправляет контакт с именем и номером телефона": "Sends a contact with name and phone number", -"Создает нового пользователя по структуре полей": "Create new user by fields structure", -"Получает товары, участвующие в выбранной акции": "Gets the products featured in the selected promotion", -"Получает список записей о трудозатратах задачи": "Get list of time accounting records for task", -"Число последних версий объекта для отображения": "Number of the latest versions of the object to display", +"Требования: платформа 1С версии 8.3.10 и выше": "Requirements: 1C platform version 8.3.10 and above", +"Идентификатор новой подборки, если необходимо": "Identifier of the new selection, if needed", +"Цены товаров. См. ПолучитьСтруктуруЦеныТовара": "Products prices. See GetProductPriceStructure", +"Получает токен авторизации по логину и паролю": "Receives authorization token by login and password", +"Получить список пользовательских полей задачи": "Get list of custom task fields", +"Удалить последние сообщения перед блокировкой": "Delete last messages before blocking", +"Изменяет данные записи о трудозатратах задачи": "Update time accounting record data", +"Раскомментировать, если выполняется OneScript": "Uncomment if OneScript is executed", +"Не удалось получить информацию из json медиа!": "Failed to Retrieve Information from JSON media!", +"Возвращает структура клавиатуры для сообщений": "Returns a keyboard structure for messages", +"Выберите необходимый сайт из списка и нажмите": "Select the site from the list and click", +"зарегистрироваться и создать новое приложение": "register, and create a new application", +"Получает список пользователей рабочей области": "Gets a list of users in the workspace", +"Атрибуты, индивидуальные для разных категорий": "Attributes individualized for different categories", "Идентификатор callback query полученного ботом": "Identifier of the callback query received by the bot", "Адрес обработки запросов от Telegram (с https:": "Request handling address from Telegram (with https:", "Получает общую статистику сообщества за период": "Gets the overall community statistics for a period", "Отправляет текстовое сообщение в чат или канал": "Sends a text message to a chat or channel", "Получает внешнюю ссылку для доступа к каталогу": "Get external link to folder", "Ошибка получения двоичных данных из параметра:": "Error getting binary data from parameter:", -"минимальная цена товара после применения акций": "minimum price of product after promotions have been applied", +"Набор полей заказа. См. ПолучитьОписаниеЗаказа": "Set of order fields. See GetOrderDescription", "Удаляет указанное сообщение из чата или канала": "Delete message from chat or channel", "Загружает несколько файлов на сервер Neocities": "Uploads multiple files to Neocities", -"Получает статус (онлайн) текущего пользователя": "Gets the status (online) of the current user", -"Набор полей заказа. См. ПолучитьОписаниеЗаказа": "Set of order fields. See GetOrderDescription", +"НачалоКодовУспеха И ОтветПроверки.КодСостояния": "StartOfSuccessCodes And CheckResponse.StatusCode", +"Число последних версий объекта для отображения": "Number of the latest versions of the object to display", "сериализованный JSON ответа от Ozon Seller API": "serialized JSON response from Ozon Seller API", "Формирует ссылку для авторизации через браузер": "Forms a link for authorization via the browser", -"НачалоКодовУспеха И ОтветПроверки.КодСостояния": "StartOfSuccessCodes And CheckResponse.StatusCode", -"Путь к объекту, тег которого необходимо удалить": "Path to the object whose tag needs to be deleted", -"Получает список файлов с или без отбора по типу": "Gets a list of files with or without filtering by type", -"Массив имен для добавления новых листов в книгу": "Array of names to add new sheets to the spreadsheet", -"ID пользователя для учета. Текущий по умолчанию": "Users ID. Current by default", -"Получает информацию о товаре по идентификаторам": "Gets product information by identifiers", -"Отправляет URL с предпросмотром в чат или канал": "Sends a URL with a preview to a chat or channel", -"Файлы для загрузки: Ключ > путь на NC, Значение": "Files: Key > destination path on NC, Value", -"Получает информацию о пользователях для диалога": "Get users information for dialog", -"Наименование файла с расширением для сохранения": "File name with extension", -"Токен авторизации, если используется не веб-хук": "Access token, when app auth method used", -"Пользователь или пользователи чата для удаления": "The member or members of the chat room to remove", -"Dropbox_ПолучитьДанныеИспользованияПространства": "Dropbox_GetSpaceUsageData", -"Создает кампанию в выбранном рекламном кабинете": "Creates a campaign in the selected advertising account", -"название задачи (можно искать по шаблону [%_])>": "task name (can be searched using the template [%_])>", +"минимальная цена товара после применения акций": "minimum price of product after promotions have been applied", +"Получает список записей о трудозатратах задачи": "Get list of time accounting records for task", +"Получает статус (онлайн) текущего пользователя": "Gets the status (online) of the current user", +"Создает нового пользователя по структуре полей": "Create new user by fields structure", +"Получает товары, участвующие в выбранной акции": "Gets the products featured in the selected promotion", +"Проверяет доступность задачи для пользователей": "Checks the availability of the task for users", +"ПолучитьСписокПользовательскихПолейЗадачи (хук": "GetCustomTaskFieldsList (wh", +"Скрыть старые сообщения от новых пользователей": "Hide old messages from new members", +"Открепляет ранее закрепленное сообщение в чате": "Unpins a previously pinned chat message", +"URL, по которому необходимо перейти в браузере": "URL to go to in the browser", +"Список адресов почты добавляемых пользователей": "List of email addresses of users being added", +"Получает информацию о комментарии задачи по ID": "Gets task comment data by ID", +"Истина > отправляет файлы отдельными запросами": "True > sends files in separate requests", +"Клавиатура под сообщением или на нижней панели": "Keyboard under the message or on the bottom panel", +"Сумма дополнительного сбора (в том числе и НДС": "Amount of additional fee (including VAT", +"Токен авторизации, если используется не вебхук": "Access token, when app auth method used", +"Порог стоимости товара в целых единицах валюты": "Threshold for the value of goods in whole units of currency", +"Отправляет контакт с именем и номером телефона": "Sends a contact with name and phone number", +"Устанавливает или снимает реакцию на сообщение": "Set or remove reaction mark on the message", "OInt/tests/Modules/Coverage_ЗапускВсехТестов.os": "OInt/tests/Modules/Coverage_RunAllTests.os", "Массив или одна структура полей описания товара": "Array or one structure of product description fields", "Структура полей чата. См. ПолучитьСтруктуруЧата": "Chat fields structure. See GetChatStructure", "Получает календарь из списка пользователя по ID": "Gets a calendar from the user's list by ID", "Перейдите на [страницу Календаря в Marketplace]": "Go to the [Calendar page on the Marketplace]", -"Получает список подразделений по ID или фильтру": "Gets a list of departments by ID or filter", -"Структура полей лида (см. ПолучитьСтруктуруЛида": "Lead fields structure (see GetLeadStructure", "Добавьте необходимые для ваших целей разрешения": "Add the permissions required for your purposes", -"Получает список комментариев к записи в таблице": "Gets the list of comments for a record in the table", +"Структура полей лида (см. ПолучитьСтруктуруЛида": "Lead fields structure (see GetLeadStructure", "Перемещает файл из одного расположения в другое": "Move file from one destination to another", "Получает список пользователей указанного канала": "Gets a list of users in the specified channel", -"Получает данные строки таблицы по идентификатору": "Gets row data of the table by identifier", -"ОчиститьСписокЗакрепленныхСообщенийТемы (главная": "ClearPinnedMessagesList (main", -"Создает новый блок на основе существующего блока": "Creates a new block based on an existing block", -"Вид обработки текста (HTML, Markdown, MarkdownV2": "Text processing type (HTML, Markdown, MarkdownV2", -"Созвращает список дочерних блоков блока-родителя": "Returns list of child blocks of parent block", -"Помечает элемент чеклиста задачи как выполненный": "Mark an element as completed", -"Добавляет сообщение в обсуждение от имени группы": "Adds a message to the discussion on behalf of the group", -"Истина > в макете будут только обязательные поля": "True > only required fields will be in the set", -"Получает список пользовательских полей для задач": "Gets list of custom task fields", -"Удаление заказа](@api-docs.cdek.ru/29924487.html": "Deleting an order](@api-docs.cdek.ru/29924487.html", -"Отбор файлов по каталогу. Все, если не заполнено": "Selection of files by catalog. All if not filled in", -"Сформируйте ссылку и перейдите по ней в браузере": "Form a link and click on it in your browser", -"Забрать токен из параметра URL в адресной строке": "Retrieve the token from the URL parameter in the address bar", -"Отклоняет вступление пользователя в закрытый чат": "Rejects the user's request to join a private chat room", -"Некорректный метод! Проверьте правильность ввода": "Incorrect method! Check input correctness", +"название задачи (можно искать по шаблону [%_])>": "task name (can be searched using the template [%_])>", +"Получает список подразделений по ID или фильтру": "Gets a list of departments by ID or filter", +"Создает кампанию в выбранном рекламном кабинете": "Creates a campaign in the selected advertising account", +"Получает список комментариев к записи в таблице": "Gets the list of comments for a record in the table", +"Пользователь или пользователи чата для удаления": "The member or members of the chat room to remove", +"Путь к объекту, тег которого необходимо удалить": "Path to the object whose tag needs to be deleted", +"Получает список файлов с или без отбора по типу": "Gets a list of files with or without filtering by type", +"Массив имен для добавления новых листов в книгу": "Array of names to add new sheets to the spreadsheet", +"ID пользователя для учета. Текущий по умолчанию": "Users ID. Current by default", +"Получает информацию о товаре по идентификаторам": "Gets product information by identifiers", +"Dropbox_ПолучитьДанныеИспользованияПространства": "Dropbox_GetSpaceUsageData", +"Файлы для загрузки: Ключ > путь на NC, Значение": "Files: Key > destination path on NC, Value", +"Получает информацию о пользователях для диалога": "Get users information for dialog", +"Наименование файла с расширением для сохранения": "File name with extension", +"Токен авторизации, если используется не веб-хук": "Access token, when app auth method used", +"Отправляет URL с предпросмотром в чат или канал": "Sends a URL with a preview to a chat or channel", "Удаляет ранее созданный результат из комментария": "Deletes task result, created from a comment", "Лимит пользователей (бесконечно, если не указано": "User limit (infinite if not specified", "Идентификатор товара в системе продавца (Артикул": "Item identifier in the vendor's system (Article", "Массив или одна структура полей атрибутов товара": "Array or one structure of product attribute fields", "Telegram_ОчиститьСписокЗакрепленныхСообщенийТемы": "Telegram_ClearPinnedMessagesList", -"пользователь, последним изменивший статус задачи": "the user who last changed the task status", -"Истина > сортировать по дате, Ложь > по алфавиту": "True > sort by date, False > alphabetically", "Вы можете передать до 100 идентификаторов за раз": "You can pass up to 100 identifiers at a time", +"Истина > сортировать по дате, Ложь > по алфавиту": "True > sort by date, False > alphabetically", "Получает токен по коду из авторизации в бразуере": "Gets token by code from browser authorization", "двоичные данные zip архива с содержимым каталога": "binary data of the zip archive with the contents of the directory", -"URL, который будет открыт клиентским приложением": "URL to be opened by the client application", +"Некорректный метод! Проверьте правильность ввода": "Incorrect method! Check input correctness", "Маркер продолжения списка из предыдущего запроса": "Next page marker from the previous request", -"tools/Modules/internal/Modules/OPI_Инструменты.os": "tools/Modules/internal/Modules/OPI_Tools.os", -"Изменение заказа](@api-docs.cdek.ru/36981178.html": "Change of order](@api-docs.cdek.ru/36981178.html", -"Твиттер не смог обработать загруженное вами видео": "Twitter could not process the video you uploaded", -"Получает план задач на день текущего пользователя": "Gets the task plan for the current users day", -"Получает список доступных значений характеристики": "Gets the list of available values of the attribute", -"Изменяет информацию о количестве товара в наличии": "Changes the information about the stock amount of a product", -"Получает список файлов с отбором каталога или без": "Gets a list of files with or without directory selection", -"Фильтр. См. ПолучитьСтруктуруФильтраПользователей": "Filter. See GetUserFilterStructure", -"только задачи, которые не являются подзадачами (Y": "only tasks that are not subtasks (Y", -"Идентификатор или массив индентификаторов записей": "Identifier or array of record identifiers", -"Обновляет изображения и маркетинговый цвет товара": "Update images and marketing color", +"пользователь, последним изменивший статус задачи": "the user who last changed the task status", +"URL, который будет открыт клиентским приложением": "URL to be opened by the client application", +"Забрать токен из параметра URL в адресной строке": "Retrieve the token from the URL parameter in the address bar", +"Сформируйте ссылку и перейдите по ней в браузере": "Form a link and click on it in your browser", +"Отклоняет вступление пользователя в закрытый чат": "Rejects the user's request to join a private chat room", +"ОчиститьСписокЗакрепленныхСообщенийТемы (главная": "ClearPinnedMessagesList (main", +"Создает новый блок на основе существующего блока": "Creates a new block based on an existing block", +"Вид обработки текста (HTML, Markdown, MarkdownV2": "Text processing type (HTML, Markdown, MarkdownV2", +"Созвращает список дочерних блоков блока-родителя": "Returns list of child blocks of parent block", +"Получает данные строки таблицы по идентификатору": "Gets row data of the table by identifier", +"Добавляет сообщение в обсуждение от имени группы": "Adds a message to the discussion on behalf of the group", +"Истина > в макете будут только обязательные поля": "True > only required fields will be in the set", +"Получает список пользовательских полей для задач": "Gets list of custom task fields", +"Удаление заказа](@api-docs.cdek.ru/29924487.html": "Deleting an order](@api-docs.cdek.ru/29924487.html", +"Отбор файлов по каталогу. Все, если не заполнено": "Selection of files by catalog. All if not filled in", +"Помечает элемент чеклиста задачи как выполненный": "Mark an element as completed", "Зайдите в приложение Viber и создайте новый канал": "Open the Viber app and create a new channel", -"Отменяет публикацию ранее опубликованного объекта": "Unpublishes a previously published object", -"Источник: https:github.com/vbondarevsky/Connector": "Source: https:github.com/vbondarevsky/Connector", -"Вид загрузки (Пост, Товар, История, Опрос, Прочее": "Upload type (Post, Product, Story, Poll, Other", -"Тип вложений: tweet_video, tweet_image, tweet_gif": "Attachment type: tweet_video, tweet_image, tweet_gif", -"Путь к каталогу. Необязателен, если указан курсор": "Path to the directory. Optional if the cursor is specified", -"Преобразует файл с Base64 строкой в бинарный файл": "Convert file with Base64 string to binary file", "Путь внутри публичного каталога (только для папок": "Path within public catalog (folders only", +"Преобразует файл с Base64 строкой в бинарный файл": "Convert file with Base64 string to binary file", +"Путь к каталогу. Необязателен, если указан курсор": "Path to the directory. Optional if the cursor is specified", +"Тип вложений: tweet_video, tweet_image, tweet_gif": "Attachment type: tweet_video, tweet_image, tweet_gif", +"Вид загрузки (Пост, Товар, История, Опрос, Прочее": "Upload type (Post, Product, Story, Poll, Other", "ID подборка для помещения товара, если необходимо": "Selection ID for placing the product, if needed", -"Добавляет новый текстовый тег к файлу или каталогу": "Add new tag to file or folder", -"ID асинхронной работы из ответа ЗагрузитьФайлПоURL": "ID of async jsob from UploadFileByURL response", -"tools/Modules/internal/Modules/OPI_Криптография.os": "tools/Modules/internal/Modules/OPI_Cryptography.os", -"Не удалось привести структуру значений к коллекции": "Failed to convert the structure of values to a collection", -"Переслыает существующее сообщение в текущий диалог": "Forwards an existing message to the current dialog box", -"Тип чата OPEN (публичный) | CHAT (по приглашениям)": "Chat type OPEN (Public) | CHAT (Private)", -"Код ПВЗ СДЭК для самостоятельного привоза клиентом": "Code of CDEK POZ for self carriage by the customer", -"Получает список заблокированных пользователей чата": "Gets the list of blocked chat users", -"Получает список пользователей по заданному фильтру": "Gets the list of users according to the specified filter", -"Создает новое свойство для использования в товарах": "Creates a new property for use in products", -"Код страны производителя товара ISO_3166-1_alpha-2": "Country code of the product manufacturer as ISO_3166-1_alpha-2", -"ID блока, после которого необходимо встаивть новый": "Block ID after which to insert the new one", -"Получает информацию о пользовательском поле задачи": "Get custom task field data", +"Источник: https:github.com/vbondarevsky/Connector": "Source: https:github.com/vbondarevsky/Connector", +"Отменяет публикацию ранее опубликованного объекта": "Unpublishes a previously published object", +"Обновляет изображения и маркетинговый цвет товара": "Update images and marketing color", +"Изменяет информацию о количестве товара в наличии": "Changes the information about the stock amount of a product", +"только задачи, которые не являются подзадачами (Y": "only tasks that are not subtasks (Y", +"Фильтр. См. ПолучитьСтруктуруФильтраПользователей": "Filter. See GetUserFilterStructure", +"Получает список файлов с отбором каталога или без": "Gets a list of files with or without directory selection", +"Получает список доступных значений характеристики": "Gets the list of available values of the attribute", +"Получает план задач на день текущего пользователя": "Gets the task plan for the current users day", +"Твиттер не смог обработать загруженное вами видео": "Twitter could not process the video you uploaded", +"Изменение заказа](@api-docs.cdek.ru/36981178.html": "Change of order](@api-docs.cdek.ru/36981178.html", +"tools/Modules/internal/Modules/OPI_Инструменты.os": "tools/Modules/internal/Modules/OPI_Tools.os", +"Идентификатор или массив индентификаторов записей": "Identifier or array of record identifiers", "Некорректная команда! Проверьте правильность ввода": "Incorrect command! Check input correctness", "Данные заполнения, где ключ это имя ячейки вида A1": "Fill data where the key is the cell name like A1", "Запрещает доступ к файлу для внешних пользователей": "Prohibits access to the file for external users", "Удаляет одну или массив записей по идентификаторам": "Deletes one or an array of records by identifiers", -"Комплект защитных плёнок для X3 NFC. Темный хлопок": "Protective film set for X3 NFC. Dark cotton", +"Номер заказа в ИС Клиента (uuid, если не заполнено": "Order number in the customers system (uuid, if not filled in", "URL = ПараметрыФункции[\"Bitrix24_Domain": "URL = FunctionParameters[\"Bitrix24_Domain", "Идентификаторы товаров в системе продавца (Артикул": "Item identifiers in the vendor's system (Article", -"Номер заказа в ИС Клиента (uuid, если не заполнено": "Order number in the customers system (uuid, if not filled in", -"Путь к объекту, для которого необходимо создать тег": "Path to the object for which the tag needs to be created", -"Структура полей задачи (см. ПолучитьСтруктуруЗадачи": "Task fields structure (see GetTaskFieldsStructure", -"Код региона СДЭК, уточняющий параметр для поля city": "CDEK region code, specifying parameter for the city field", -"Код офиса СДЭК, на который будет доставлена посылка": "Code of CDEK office to which the package will be delivered", -"Устанавливает статус (онлайн) текущего пользователя": "Sets the status (online) of the current user", -"Коннектор: удобный HTTP-клиент для 1С:Предприятие 8": "Connector: convenient HTTP client for 1C:Enterprise 8", -"Регистрация заказа](@api-docs.cdek.ru/29923926.html": "Order registration](@api-docs.cdek.ru/29923926.html", -"Получает шаблон пустого описания для загрузки файла": "Gets a blank description template for uploading a file", -"Подтверждает вступление пользователя в закрытый чат": "Confirms the user's request to join a private chat room", -"Смещение для получение объектов не из начала списка": "Offset for getting objects not from the beginning of the list", -"(Дополнительно) Определитесь с целью взаимодействия": "(Optional) Determine the purpose of the interaction", -"Структура полей сделки (см. ПолучитьСтруктуруСделки": "Deal fields structure (see. GetDealStructure", -"Название региона, уточняющий параметр для поля city": "Region name, specifying parameter for the city field", +"Получает информацию о пользовательском поле задачи": "Get custom task field data", +"Комплект защитных плёнок для X3 NFC. Темный хлопок": "Protective film set for X3 NFC. Dark cotton", +"Код страны производителя товара ISO_3166-1_alpha-2": "Country code of the product manufacturer as ISO_3166-1_alpha-2", +"ID блока, после которого необходимо встаивть новый": "Block ID after which to insert the new one", +"Получает список пользователей по заданному фильтру": "Gets the list of users according to the specified filter", +"Получает список заблокированных пользователей чата": "Gets the list of blocked chat users", +"Код ПВЗ СДЭК для самостоятельного привоза клиентом": "Code of CDEK POZ for self carriage by the customer", +"Тип чата OPEN (публичный) | CHAT (по приглашениям)": "Chat type OPEN (Public) | CHAT (Private)", +"Переслыает существующее сообщение в текущий диалог": "Forwards an existing message to the current dialog box", +"Не удалось привести структуру значений к коллекции": "Failed to convert the structure of values to a collection", +"tools/Modules/internal/Modules/OPI_Криптография.os": "tools/Modules/internal/Modules/OPI_Cryptography.os", +"ID асинхронной работы из ответа ЗагрузитьФайлПоURL": "ID of async jsob from UploadFileByURL response", +"Добавляет новый текстовый тег к файлу или каталогу": "Add new tag to file or folder", +"Создает новое свойство для использования в товарах": "Creates a new property for use in products", "В меню создания бота заполните все необходимые поля": "In the bot creation menu, fill in all the required fields", "Коллекция файлов: Ключ > Файл, Значение > Тип медиа": "File collection: Key > File, Value > Media Type", "цена до скидок; укажите значение 0, если скидок нет": "price before discounts; specify 0 if no discounts are available", "Очищает список закрепленных сообщений в теме форума": "Clears the list of pinned messages in the forum thread", "Регистрация отказа](@api-docs.cdek.ru/55327658.html": "Registration of refusal](@api-docs.cdek.ru/55327658.html", -"Данные авторизации. См.ПолучитьСтандартныеПараметры": "Authorization data. See GetStandardParameters", +"Ссылка на сайт интернет-магазина с описанием товара": "Link to the website of the online store with the description of the product", "Изменяет свойства календаря из списка пользователей": "Edits the properties of a calendar from the user's list", "Получает информацию о сайте по его имени или токену": "Gets information about a site by its name or token", -"N) - парсить или нет комментарии на наличие смайлов": "N) - parse comments for emoticons or not", "автоприменения стратегий цены: ENABLED или DISABLED": "auto application of price strategies: ENABLED or DISABLED", -"Ссылка на сайт интернет-магазина с описанием товара": "Link to the website of the online store with the description of the product", +"Данные авторизации. См.ПолучитьСтандартныеПараметры": "Authorization data. See GetStandardParameters", +"Название региона, уточняющий параметр для поля city": "Region name, specifying parameter for the city field", +"N) - парсить или нет комментарии на наличие смайлов": "N) - parse comments for emoticons or not", +"(Дополнительно) Определитесь с целью взаимодействия": "(Optional) Determine the purpose of the interaction", +"Путь к объекту, для которого необходимо создать тег": "Path to the object for which the tag needs to be created", +"Структура полей сделки (см. ПолучитьСтруктуруСделки": "Deal fields structure (see. GetDealStructure", +"Код региона СДЭК, уточняющий параметр для поля city": "CDEK region code, specifying parameter for the city field", +"Код офиса СДЭК, на который будет доставлена посылка": "Code of CDEK office to which the package will be delivered", +"Устанавливает статус (онлайн) текущего пользователя": "Sets the status (online) of the current user", +"Структура полей задачи (см. ПолучитьСтруктуруЗадачи": "Task fields structure (see GetTaskFieldsStructure", +"Регистрация заказа](@api-docs.cdek.ru/29923926.html": "Order registration](@api-docs.cdek.ru/29923926.html", +"Получает шаблон пустого описания для загрузки файла": "Gets a blank description template for uploading a file", +"Подтверждает вступление пользователя в закрытый чат": "Confirms the user's request to join a private chat room", +"Смещение для получение объектов не из начала списка": "Offset for getting objects not from the beginning of the list", +"Коннектор: удобный HTTP-клиент для 1С:Предприятие 8": "Connector: convenient HTTP client for 1C:Enterprise 8", +"Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС": "VAT rate (value - 0, 10, 12, 20, null - no VAT", +"Проверяет загрузку изображений по массиву ID товаров": "Check images upload by products IDs", +"Отправляет аудиофайл в качестве голосового сообщения": "Sends an audio file as a voice message", +"Значение или массив значений для добавления в values": "Value or array of values to add to Values field", +"Написать сообщение пользователю в диалоге сообщества": "Write a message to a user in the community's dialog", +"Название города, уточняющий параметр для postal_code": "City name, specifying parameter for postal_code", +"Структура комплексного атрибута или структура товара": "Complex attribute structure or product structure", +"Обрабатывает данные TMA и опредеяет их достоверность": "Processes TMA data and determines its validity", +"Здесь собрано определение данных для работы с VK API": "Here is a collection of data definitions for working with the VK API", +"Истина > кнопки выводятся в столбик, Ложь > в строку": "True > buttons are displayed in a column, False > in a row", +"Описание таблиц: Ключ > имя, Значение > массив полей": "Table description: Key > name, Value > array of fields", "Информация о заказе](@api-docs.cdek.ru/29923975.html": "Order information](@api-docs.cdek.ru/29923975.html", "ID чата (chatXXX) или пользователя (XXX) для диалога": "Chat ID (as chatXXX) or User ID (as XXX)", "только задачи, которые не являются подзадачами (Y|N)": "only tasks that are not subtasks (Y|N)", -"Отправляет географические координаты в чат или канал": "Sends geographic coordinates to a chat or channel", +"Основное измерение при заполнении диапазона массивом": "Main dimension when filling the array range", "Скачивает zip архив с содержимым указанного каталога": "Downloads a zip archive with the contents of the specified directory", "включение автоприменения акций: ENABLED или DISABLED": "Enable auto application of shares: ENABLED or DISABLED", "Загружает файл на диск, забирая его по заданному URL": "Downloads a file to disk from the specified URL", -"Описание таблиц: Ключ > имя, Значение > массив полей": "Table description: Key > name, Value > array of fields", -"Основное измерение при заполнении диапазона массивом": "Main dimension when filling the array range", -"Здесь собрано определение данных для работы с VK API": "Here is a collection of data definitions for working with the VK API", -"Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС": "VAT rate (value - 0, 10, 12, 20, null - no VAT", -"Обрабатывает данные TMA и опредеяет их достоверность": "Processes TMA data and determines its validity", -"Структура комплексного атрибута или структура товара": "Complex attribute structure or product structure", -"Название города, уточняющий параметр для postal_code": "City name, specifying parameter for postal_code", -"Написать сообщение пользователю в диалоге сообщества": "Write a message to a user in the community's dialog", -"Значение или массив значений для добавления в values": "Value or array of values to add to Values field", -"Отправляет аудиофайл в качестве голосового сообщения": "Sends an audio file as a voice message", -"Проверяет загрузку изображений по массиву ID товаров": "Check images upload by products IDs", -"Истина > кнопки выводятся в столбик, Ложь > в строку": "True > buttons are displayed in a column, False > in a row", +"Отправляет географические координаты в чат или канал": "Sends geographic coordinates to a chat or channel", +"Добавляет новые группы или пользователей в получатели": "Adds new groups or users to the recipients", +"Введите имя и выберите Application type - Desktop app": "Enter the name and choose Application type - Desktop app", +"Получает информацию о стадиях Канбана или Моего плана": "Get kanban (My Plan) stages info", +"Определяет доступ к файлу для сторонних пользователей": "Defines access to the file for third-party users", +"Получает статус добавления нового товара по ID задачи": "Gets the status of adding a new product by task ID", +"Удаляет файл или несколько файлов с сервера Neocities": "Deletes a file or multiple files from Neocities", +"Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок": "Keyboard. See FormKeyboardFromButtonArray", +"Отправляет контакт с номером телефона в чат или канал": "Sends a contact with a phone number to a chat or channel", +"Возвращает категории и типы для товаров в виде дерева": "Returns the categories and types for products in a tree view", +"Получает информацию о записи трудозатрат задачи по ID": "Get time accounting record data", +"Ключ > имя файла, значение > путь или двоичные данные": "Key > file name, value > path or binary data", +"OneScript: ./OInt/tests/Modules/internal/OPI_Тесты.os": "OneScript: ./OInt/tests/Modules/internal/OPI_Tests.os", +"Мировая гигокорпорация Илона Маска, кстати, напоминаю": "The world gigacorporation of Elon Musk, by the way, a reminder", "авторизоваться и ввести свои данные физ. или юр. лица": "authorize and enter your personal or company information", -"В одном запросе можно передать до 500 идентификаторов": "Up to 500 identifiers can be passed in one request", +"Отображаемое имя файла c расширением, если необходимо": "Custom displayed file name with extension, if necessary", "Отбор элементов (См. ПолучитьСтруктуруФильтраКаталога": "Items filter (see GetFolderFilterStructure", "Определяет доступ к файлу для стороннего пользователя": "Defines access to the file for an external user", -"Авторизация клиентов](@api-docs.cdek.ru/29923918.html": "Client authorization](@api-docs.cdek.ru/29923918.html", +"В одном запросе можно передать до 500 идентификаторов": "Up to 500 identifiers can be passed in one request", "Генерирует ссылку авторизации для перехода в браузере": "Generates an authorization link for browser transition", "Для работы с Twitter API необходимо перейти по адресу": "To work with the Twitter API, you need to go to the following address:", "Возвращает список пользователей рабочего пространства": "Returns a list of workspace users", "Клиентские возвраты](@api-docs.cdek.ru/122762174.html": "Customer returns](@api-docs.cdek.ru/122762174.html", -"Мировая гигокорпорация Илона Маска, кстати, напоминаю": "The world gigacorporation of Elon Musk, by the way, a reminder", -"OneScript: ./OInt/tests/Modules/internal/OPI_Тесты.os": "OneScript: ./OInt/tests/Modules/internal/OPI_Tests.os", -"Отображаемое имя файла c расширением, если необходимо": "Custom displayed file name with extension, if necessary", -"Введите имя и выберите Application type - Desktop app": "Enter the name and choose Application type - Desktop app", -"Получает информацию о записи трудозатрат задачи по ID": "Get time accounting record data", -"Возвращает категории и типы для товаров в виде дерева": "Returns the categories and types for products in a tree view", -"Отправляет контакт с номером телефона в чат или канал": "Sends a contact with a phone number to a chat or channel", -"Клавиатура. См. СформироватьКлавиатуруПоМассивуКнопок": "Keyboard. See FormKeyboardFromButtonArray", -"Удаляет файл или несколько файлов с сервера Neocities": "Deletes a file or multiple files from Neocities", -"Получает статус добавления нового товара по ID задачи": "Gets the status of adding a new product by task ID", -"Определяет доступ к файлу для сторонних пользователей": "Defines access to the file for third-party users", -"Получает информацию о стадиях Канбана или Моего плана": "Get kanban (My Plan) stages info", -"Ключ > имя файла, значение > путь или двоичные данные": "Key > file name, value > path or binary data", -"Добавляет новые группы или пользователей в получатели": "Adds new groups or users to the recipients", -"Получает список внешних файлов пользователя или канала": "Gets a list of external files of a user or channel", -"ID аккаунта. Текущий аккаунт токена, если не заполнено": "Account ID. Current token account if not filled", -"Перезаписывать если файл с таким именем уже существует": "Overwrite if a file with the same name already exists", -"Отправляет ранее загруженное голосовое сообщение по ID": "Sends a previously uploaded voice message by ID", -"Изменяет имя и|или описание существующего поля таблицы": "Changes the name and/or description of an existing table field", -"Добавляет существующий календарь в список пользователя": "Adds an existing calendar to the user's list", -"Вид разметки для текста сообщения: MarkdownV2 или HTML": "Markup type for message text: MarkdownV2 or HTML", -"Как CLI приложение для Windows и Linux (exe, rpm, deb)": "As a CLI application for Windows and Linux (exe, rpm, deb)", -"Группирует товары на основе одинаковых наборов свойств": "Groups products based on similar sets of properties", -"Файлы для загрузки: Ключ > путь на NC, Значение > Файл": "Files: Key > destination path on NC, Value > file", +"Авторизация клиентов](@api-docs.cdek.ru/29923918.html": "Client authorization](@api-docs.cdek.ru/29923918.html", "Данные пользователя. См. ПолучитьСтурктуруПользователя": "New user data. See. GetUserFieldsStructure", -"Получает информацию об объекте диска по заданному пути": "Gets information about a disk object at the specified path", -"Получает структуру с описанием полей для создания лида": "Gets a structure with field descriptions for creating a lead", -"ID стадии, после которой необходимо вставить выбранную": "Stage ID, after which the selected stage should be inserted", -"Перемещает объект по заданному пути и пути к оригиналу": "Moves the object to the specified path and path to the original", "Удаленный каталог приемника. Корень, если не заполнено": "Remote receiver catalog. Root by default", -"ID пользователя. Ответ на все заявки, если не заполнено": "User ID. For all active requests if not filled in", -"Идентификатор файла или каталога размещения комментария": "Identifier of the file or directory where the comment is located", -"и выбор конкретного проекта из списка (значек c ключем)": "and chosing of project from list (key icon)", -"Получает структуру с описанем полей для создания задачи": "Gets a structure with a description of the fields for creating a task", -"Предоставляет стороннии пользователям доступ к каталогу": "Grants external users access to the directory", -"ID последнего значения (last_id) из предыдущего запроса": "ID of the last value (last_id) from the previous response", -"Разблокирует ранее заблокированного пользователя в чате": "Unblocks a previously blocked user in the chat room", -"Создает отказ по заказу для возврата в интернет магазин": "Creates an order refusal to return to the online store", -"Код активации привязывается к карточке цифрового товара": "The activation code is linked to the digital product card", -"Дата окончания жизни ссылки (безсрочно, если не указано": "Link expiration date (permanent if not specified", -"идентификатор автора перемещения лида на текущую стадию": "identifier of the author of moving the lead to the current stage", -"ID файла, загруженного при помощи ЗагрузитьФайлВКаталог": "File ID from UploadFileToFolder method", +"Перемещает объект по заданному пути и пути к оригиналу": "Moves the object to the specified path and path to the original", +"ID стадии, после которой необходимо вставить выбранную": "Stage ID, after which the selected stage should be inserted", +"Получает структуру с описанием полей для создания лида": "Gets a structure with field descriptions for creating a lead", +"Получает информацию об объекте диска по заданному пути": "Gets information about a disk object at the specified path", +"Файлы для загрузки: Ключ > путь на NC, Значение > Файл": "Files: Key > destination path on NC, Value > file", +"Группирует товары на основе одинаковых наборов свойств": "Groups products based on similar sets of properties", +"Как CLI приложение для Windows и Linux (exe, rpm, deb)": "As a CLI application for Windows and Linux (exe, rpm, deb)", +"Вид разметки для текста сообщения: MarkdownV2 или HTML": "Markup type for message text: MarkdownV2 or HTML", +"Добавляет существующий календарь в список пользователя": "Adds an existing calendar to the user's list", +"Изменяет имя и|или описание существующего поля таблицы": "Changes the name and/or description of an existing table field", +"Отправляет ранее загруженное голосовое сообщение по ID": "Sends a previously uploaded voice message by ID", +"Перезаписывать если файл с таким именем уже существует": "Overwrite if a file with the same name already exists", +"ID аккаунта. Текущий аккаунт токена, если не заполнено": "Account ID. Current token account if not filled", +"Получает список внешних файлов пользователя или канала": "Gets a list of external files of a user or channel", "Блок как соответствие. С ним можно свершать манипуляции": "Block as map. Can be changed", +"ID файла, загруженного при помощи ЗагрузитьФайлВКаталог": "File ID from UploadFileToFolder method", +"идентификатор автора перемещения лида на текущую стадию": "identifier of the author of moving the lead to the current stage", +"Дата окончания жизни ссылки (безсрочно, если не указано": "Link expiration date (permanent if not specified", +"Код активации привязывается к карточке цифрового товара": "The activation code is linked to the digital product card", +"Создает отказ по заказу для возврата в интернет магазин": "Creates an order refusal to return to the online store", "Перезаписывать, если файл с таким именем уже существует": "Overwrite if a file with the same name already exists", -"Количество возвращаемых вложенных объектов (для каталога": "Number of returned nested objects (for catalog", -"Нажмите **Create App** и выберите пункт **From scratch**": "Click **Create App** and choose **From scratch**", -"Получает прямую ссылку для скачивания публичного объекта": "Gets a direct link to download the public object", -"Как XML файлы расширения для загрузки через конфигуратор": "As XML extension files for loading via the configurator", -"Отправляет сообщение, которое приходит в канал, но видно": "Sends a message that arrives in the channel but is visible", -"Получает статус асинхронной работы по изменению доступов": "Get async job status for access changes", -"Получает информацию о товарах по массиву идентификаторов": "Gets information about products by an array of identifiers", -"Загружает коды активации для цифрового товара или услуги": "Uploads activation codes for a digital product or service", -"Полчает список комментариев пользователей к задаче по ID": "Get user comments list for a task", -"Нажимайте далее и Save and continue на последней вкладке": "Click on Next and then Save and continue on the last tab", -"Получает информацию об опубликованном объекте по его URL": "Gets information about the published object by its URL", -"Создает дочернюю страницу над другой страницей-родителем": "Creates a child page above another parent page", -"Получает количество товаров в остатке с фильтром или без": "Gets the number of items in the balance with or without filtering", -"Удаляет стадию канбана, при условии, что в ней нет задач": "Removes a kanban stage, provided there are no tasks in it", -"Добавляет дополнительные поля информации для медиафайлов": "Add information fields for mediafiles", -"OneScript: ./OInt/tests/Modules/internal/OPI_ТестыCLI.os": "OneScript: ./OInt/tests/Modules/internal/OPI_TestsCLI.os", -"Получает структуру с описанием полей для создания сделки": "Gets a structure with field descriptions for creating a deal", -"Изменяет значение варианта существующего свойства товара": "Edits the value of an existing product property variant", +"ID последнего значения (last_id) из предыдущего запроса": "ID of the last value (last_id) from the previous response", +"Предоставляет стороннии пользователям доступ к каталогу": "Grants external users access to the directory", +"Получает структуру с описанем полей для создания задачи": "Gets a structure with a description of the fields for creating a task", +"и выбор конкретного проекта из списка (значек c ключем)": "and chosing of project from list (key icon)", +"Идентификатор файла или каталога размещения комментария": "Identifier of the file or directory where the comment is located", +"ID пользователя. Ответ на все заявки, если не заполнено": "User ID. For all active requests if not filled in", +"Разблокирует ранее заблокированного пользователя в чате": "Unblocks a previously blocked user in the chat room", "Здесь собрано определение данных, необходимых для работы": "The definition of the data required for the work is collected here", +"Изменяет значение варианта существующего свойства товара": "Edits the value of an existing product property variant", +"Получает структуру с описанием полей для создания сделки": "Gets a structure with field descriptions for creating a deal", +"OneScript: ./OInt/tests/Modules/internal/OPI_ТестыCLI.os": "OneScript: ./OInt/tests/Modules/internal/OPI_TestsCLI.os", +"Добавляет дополнительные поля информации для медиафайлов": "Add information fields for mediafiles", +"Удаляет стадию канбана, при условии, что в ней нет задач": "Removes a kanban stage, provided there are no tasks in it", +"Получает количество товаров в остатке с фильтром или без": "Gets the number of items in the balance with or without filtering", +"Создает дочернюю страницу над другой страницей-родителем": "Creates a child page above another parent page", +"Получает информацию об опубликованном объекте по его URL": "Gets information about the published object by its URL", +"Получает информацию о товарах по массиву идентификаторов": "Gets information about products by an array of identifiers", +"Полчает список комментариев пользователей к задаче по ID": "Get user comments list for a task", +"Загружает коды активации для цифрового товара или услуги": "Uploads activation codes for a digital product or service", +"Получает статус асинхронной работы по изменению доступов": "Get async job status for access changes", +"Отправляет сообщение, которое приходит в канал, но видно": "Sends a message that arrives in the channel but is visible", +"Как XML файлы расширения для загрузки через конфигуратор": "As XML extension files for loading via the configurator", +"Получает прямую ссылку для скачивания публичного объекта": "Gets a direct link to download the public object", +"Количество возвращаемых вложенных объектов (для каталога": "Number of returned nested objects (for catalog", "Соответствие данных с результатом проверки в поле passed": "Map of data with the result of verification in the passed field", -"Получает список рабочих областей, в которых подключен бот": "Gets a list of workspaces where the bot is connected", -"Получает макет для создания заказа в функции СоздатьЗаказ": "Gets the layout of order for the CreateOrder function", -"идентификатор автора перемещения сделки на текущую стадию": "identifier of the author of moving the deal to the current stage", -"Получает токен на основе идентификатора аккаунта и пароля": "Gets a token based on account ID and password", -"Удаляет публичный URL у файла. Требует токен пользователя": "Removes the public URL from the file. Requires user token", -"Структура отбора лидов (см. ПолучитьСтруктуруФильтраЛидов": "Lead filter structure (see GetLeadFilterStructure", -"Идентификатор объекта, для которого необходим комментарий": "Identifier of the object that needs a comment", +"Нажимайте далее и Save and continue на последней вкладке": "Click on Next and then Save and continue on the last tab", +"Нажмите **Create App** и выберите пункт **From scratch**": "Click **Create App** and choose **From scratch**", "Подпись в форме. Ключ: en или ru, Значение: Текст подписи": "Form label. Key: en or ru, Value: Lable text", -"Оформляет клиентский возврат для заказа интернет магазина": "Processes customer returns for online store orders", -"Структура отбора задач (см. ПолучитьСтруктуруФильтраЗадач": "Structure of task filter (see GetTaskFieldsStructure", "Создает новую тему в группе с включенным функционалом тем": "Creates a new thread in the group with theme functionality enabled", -"Пересылает сообщение между чатами или в рамках одного чата": "Forwards a message between chats or within a chat", -"OneScript: ./OInt/tools/Modules/OPI_ПреобразованиеТипов.os": "OneScript: ./OInt/tools/Modules/OPI_TypeConversion.os", -"Запрещает редактирование файла для стороннего пользователя": "Prohibits file editing for the external user", -"app_id - ID приложения. Для создания приложения необходимо": "app_id - Application ID. To create an application, you need to", -"Структура отбора (см. ПолучитьСтруктуруФильтраКомментариев": "Comments filter structure (see GetCommentsFilterStructure", -"Создает копию объекта по заданному пути и пути к оригиналу": "Creates a copy of the object at the specified path and path to the original", -"Получает описания характеристик товаров с фильтром или без": "Retrieves product attributes descriptions with or without filtering", -"Константы.TwitterToken.Установить(ОтветТокен[\"access_token": "Constants.TwitterToken.Set(ResponseToken[\"access_token", +"Идентификатор объекта, для которого необходим комментарий": "Identifier of the object that needs a comment", +"Оформляет клиентский возврат для заказа интернет магазина": "Processes customer returns for online store orders", +"Структура отбора лидов (см. ПолучитьСтруктуруФильтраЛидов": "Lead filter structure (see GetLeadFilterStructure", +"Структура отбора задач (см. ПолучитьСтруктуруФильтраЗадач": "Structure of task filter (see GetTaskFieldsStructure", +"Получает токен на основе идентификатора аккаунта и пароля": "Gets a token based on account ID and password", +"идентификатор автора перемещения сделки на текущую стадию": "identifier of the author of moving the deal to the current stage", +"Получает макет для создания заказа в функции СоздатьЗаказ": "Gets the layout of order for the CreateOrder function", +"Удаляет публичный URL у файла. Требует токен пользователя": "Removes the public URL from the file. Requires user token", +"Получает список рабочих областей, в которых подключен бот": "Gets a list of workspaces where the bot is connected", "OPI_ПолучениеДанныхТестов.Проверка_БитриксСтрока(Результат": "OPI_TestDataRetrieval.Check_BitrixString(Result", +"Константы.TwitterToken.Установить(ОтветТокен[\"access_token": "Constants.TwitterToken.Set(ResponseToken[\"access_token", +"Получает описания характеристик товаров с фильтром или без": "Retrieves product attributes descriptions with or without filtering", +"Создает копию объекта по заданному пути и пути к оригиналу": "Creates a copy of the object at the specified path and path to the original", "Загружает фото на сервер для его дальнейшего использования": "Uploads photo to server for further use", -"Истина > служебные поля удаляются, остается только сам блок": "True > service fields are deleted, only the block itself remains", -"Получает PDF или HTML превью объекта (только для токументов": "Gets PDF or HTML preview of the object (for documents only", -"Код, полученный из авторизации См.ПолучитьСсылкуАвторизации": "Code obtained from authorization See GetAuthorizationLink", -"Структура отбора сделок (см. ПолучитьСтруктуруФильтраСделок": "Deals filter structure (see. GetDealsFilterStructure", -"Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров": "Product selection filter. See GetProductsFilterStructure", -"Создает публичный URL для файла. Требует токен пользователя": "Creates a public URL for the file. Requires user token", -"Вы можете переопределять их, передавая в качестве параметра": "You can override them by passing them as a parameter", -"Перейдите **[в раздел интеграций портала для разработчиков]": "Go to the **[section of integrations of the developer portal]", -"Массив или одна сокращенная структура полей описания товара": "Array or one simplified structure of product fields", -"Созданного вами бота теперь можно применить двумя способами": "The bot you created can now be used in two ways", +"app_id - ID приложения. Для создания приложения необходимо": "app_id - Application ID. To create an application, you need to", +"Запрещает редактирование файла для стороннего пользователя": "Prohibits file editing for the external user", +"OneScript: ./OInt/tools/Modules/OPI_ПреобразованиеТипов.os": "OneScript: ./OInt/tools/Modules/OPI_TypeConversion.os", +"Пересылает сообщение между чатами или в рамках одного чата": "Forwards a message between chats or within a chat", +"Структура отбора (см. ПолучитьСтруктуруФильтраКомментариев": "Comments filter structure (see GetCommentsFilterStructure", "Для начала работы необходимо получить токен доступа к диску": "To start working, you need to obtain an access token for the disk", -"Получает заказ по номеру СДЭК или внутреннему номеру клиента": "Receives the order by CDEK number or number from customer IB", -"OneScript: ./OInt/tools/Modules/OPI_ПолучениеДанныхТестов.os": "OneScript: ./OInt/tools/Modules/OPI_TestDataRetrieval.os", -"Формирует картинку для отправки в функции ОтправитьСообщение": "Make picture block for SendMessage method", -"Основная структура полей товара. См. ПолучитьСтруктуруТовара": "The basic structure of the product fields. See GetProductStructure", -"Отредактируйте товар, чтобы опубликовать в Маркете ВКонтакте": "Moderation", +"Созданного вами бота теперь можно применить двумя способами": "The bot you created can now be used in two ways", +"Массив или одна сокращенная структура полей описания товара": "Array or one simplified structure of product fields", +"Перейдите **[в раздел интеграций портала для разработчиков]": "Go to the **[section of integrations of the developer portal]", +"Вы можете переопределять их, передавая в качестве параметра": "You can override them by passing them as a parameter", +"Фильтр выборки товаров. См. ПолучитьСтруктуруФильтраТоваров": "Product selection filter. See GetProductsFilterStructure", +"Структура отбора сделок (см. ПолучитьСтруктуруФильтраСделок": "Deals filter structure (see. GetDealsFilterStructure", +"Код, полученный из авторизации См.ПолучитьСсылкуАвторизации": "Code obtained from authorization See GetAuthorizationLink", +"Получает PDF или HTML превью объекта (только для токументов": "Gets PDF or HTML preview of the object (for documents only", +"Истина > служебные поля удаляются, остается только сам блок": "True > service fields are deleted, only the block itself remains", +"Создает публичный URL для файла. Требует токен пользователя": "Creates a public URL for the file. Requires user token", "Название района региона, уточняющий параметр для поля region": "Name of the region's district, specifying parameter for the region field", "механизм загрузки файлов и некоторые другие из старой версии": "file upload mechanism and some others from the old version", "Имя поля для получения. Выводит весь список, если не указано": "Field name to retrieve. Displays the entire list if not specified", -"Константы.TwitterRefresh.Установить(ОтветТокен[\"refresh_token": "Constants.TwitterRefresh.Set(ResponseToken[\"refresh_token", -"Добавляет новое пользовательское поле для добавления в задачу": "Adds a new custom field to be added to the task", -"Получает характеристики для указанной категории и типа товара": "Gets the characteristics for the specified category and product type", -"Иднтификатор следующей страницы данных из предыдущего запроса": "Next page identifier of data from the previous request", -"Изменяет свойства существующей стадии канбана или Моего плана": "Changes the properties of the existing kanban or My plan stage", -"Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено": "String, Arbitrary, HTTPResponse, BinaryData, Undefined", -"Смещение для получение вложенных объектов не из начала списка": "Offset for getting nested objects not from the beginning of the list", -"Массив описаний остатков. См. ПолучитьСтруктуруОстатковТовара": "Array of stocks data. See GetProductStocksStructure", -"Указатель из предыдущего запроса, если строк результата > 100": "Pointer from the previous request, if the result rows > 100", +"Отредактируйте товар, чтобы опубликовать в Маркете ВКонтакте": "Moderation", +"OneScript: ./OInt/tools/Modules/OPI_ПолучениеДанныхТестов.os": "OneScript: ./OInt/tools/Modules/OPI_TestDataRetrieval.os", +"Формирует картинку для отправки в функции ОтправитьСообщение": "Make picture block for SendMessage method", +"Получает заказ по номеру СДЭК или внутреннему номеру клиента": "Receives the order by CDEK number or number from customer IB", +"Основная структура полей товара. См. ПолучитьСтруктуруТовара": "The basic structure of the product fields. See GetProductStructure", "Открывает новый диалог с одним или несколькими пользователями": "Opens a new dialog with one or more users", +"Массив описаний остатков. См. ПолучитьСтруктуруОстатковТовара": "Array of stocks data. See GetProductStocksStructure", +"Смещение для получение вложенных объектов не из начала списка": "Offset for getting nested objects not from the beginning of the list", +"Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено": "String, Arbitrary, HTTPResponse, BinaryData, Undefined", +"Указатель из предыдущего запроса, если строк результата > 100": "Pointer from the previous request, if the result rows > 100", +"Иднтификатор следующей страницы данных из предыдущего запроса": "Next page identifier of data from the previous request", +"Получает характеристики для указанной категории и типа товара": "Gets the characteristics for the specified category and product type", +"Добавляет новое пользовательское поле для добавления в задачу": "Adds a new custom field to be added to the task", +"Константы.TwitterRefresh.Установить(ОтветТокен[\"refresh_token": "Constants.TwitterRefresh.Set(ResponseToken[\"refresh_token", +"Изменяет свойства существующей стадии канбана или Моего плана": "Changes the properties of the existing kanban or My plan stage", +"Получает структуру цены товара для функции ОбновитьЦеныТоваров": "Gets the product price structure for the UpdateProductsPrices function", "Отступ от начала списка для полчения задач > 50 шт. рекурсивно": "Offset of tasks list", "Формирует блок файла для отправки в функции ОтправитьСообщение": "Make file block for SendMessage method", "Отмечает все сообщения во всех доступных чатах как прочитанные": "Mark all message as readed", @@ -5884,426 +5885,425 @@ "Для вызова этого метода бот должен быть администратором в чате": "To call this method, the bot must be an administrator in the chat room", "Получает статус добавления кодов цифрового товара по ID задачи": "Gets the status of digital item codes upload by task ID", "ID группы или пользователя владельца канбан. Свой по умолчанию": "ID of kanban owner (group or user)", -"Получает структуру цены товара для функции ОбновитьЦеныТоваров": "Gets the product price structure for the UpdateProductsPrices function", -"Создает новый лид по структуре полей (см. ПолучитьСтруктуруЛида": "Creates a new lead by fields structure (see GetLeadStructure", -"Отступ от начала списка для получения лидов > 50 шт. рекурсивно": "Offset from the beginning of the list to get leads > 50 recursively", +"Получает статус пользователя или нескольких пользователей по ID": "Gets the status of a user or multiple users by ID", +"Получает единый SKU по старым идентификаторам SKU FBS и SKU FBO": "Gets a single SKU from the old SKU FBS and SKU FBO identifiers", +"Игнорируем проверку целостности архива, просто читаем результат": "Ignore archive integrity check, just read the result", +"Активирует или деактивирует (увольняет) выбранного пользователя": "Activates or deactivates (fire) the selected user", "Восстанавливает состояние объекта к необходимой версии (ревизии": "Restores object state to required version (revision", "Создает копию локального каталога по выбранному пути на сервере": "Creates a copy of the local directory at the selected path on the Neocities server", "Первая картинка в массиве картинок (поле images) будет основной": "The first image in the image array (images field) will be the main image", -"Активирует или деактивирует (увольняет) выбранного пользователя": "Activates or deactivates (fire) the selected user", -"Получает единый SKU по старым идентификаторам SKU FBS и SKU FBO": "Gets a single SKU from the old SKU FBS and SKU FBO identifiers", -"Получает статус пользователя или нескольких пользователей по ID": "Gets the status of a user or multiple users by ID", -"Игнорируем проверку целостности архива, просто читаем результат": "Ignore archive integrity check, just read the result", -"Получает массив сообщений, которые являются ответом на указанное": "Gets an array of messages that are replies to the specified", -"Отступ от начала списка для получения сделок > 50 шт. рекурсивно": "Offset from the beginning of the list to retrieve deals > 50 pcs recursively", -"Позволяет получать стадии без проверки прав (для администраторов": "Allows you to get stages without checking permissions (for administrators", -"OPI_ПолучениеДанныхТестов.Проверка_ОзонЗаданиеЗагрузки(Результат": "OPI_TestDataRetrieval.Check_OzonUploadTask(Result", -"URL внешнего вебхука или адрес Bitrix24 при использовании токена": "URL of webhook or a Bitrix24 domain, when token used", -"OPI_ПолучениеДанныхТестов.Проверка_ОзонДобавлениеКодов(Результат": "OPI_TestDataRetrieval.Check_OzonCodesUpload(Result", -"Массив ячеек вида А1 для получения (весь лист, если не заполнено": "Array of A1 type cells to get (whole sheet if not filled", -"P.S Далее часто упоминается \"страница настроек Twitter Developer": "P.S The following is often referred to as the \"Twitter Developer settings page", -"Удаляет URL обработчика событий бота для работы в режиме Webhook": "Deletes the bot event handler URL for webhook operation", -"Добавляет информацию о затраченном времени пользователя в задачу": "Adds information about the user's time spent to the task", -"Набор или массив наборов пар Ключ : Значение > Поле : Показатель": "Set or array of sets of pairs Key : Value > Field : FieldValue", +"Отступ от начала списка для получения лидов > 50 шт. рекурсивно": "Offset from the beginning of the list to get leads > 50 recursively", +"Создает новый лид по структуре полей (см. ПолучитьСтруктуруЛида": "Creates a new lead by fields structure (see GetLeadStructure", "Цвет чата: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA": "Chat color: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA", -"Клавиатура, если нужна, см. СформироватьКлавиатуруИзМассиваКнопок": "Keyboard, if needed, see CreateKeyboardFromArrayButton", -"Получает список файлов и каталогов, находящихся в корне хранилища": "Get a list of files and folders, located at the root of the storage", -"После создания приложения можно заполнить необходимые данные в 1С": "After creating the application, you can fill in the necessary data in 1C", -"Сохраните **ClientID** и **Client secret** со страницы приложения": "Save **ClientID** and **ClientSecret** from the application page", -"Метод + РазделительBat + СтрСоединить(МассивОпций, РазделительBat": "Method + BatSeparator + StrConcat(OptionsArray, BatSeparator", -"URL внешнего веб-хука или адрес Bitrix24 при использовании токена": "URL of webhook or a Bitrix24 domain, when token used", -"Позволяет добавлять стадии без проверки прав (для администраторов": "Allows you to add stages without checking permissions (for administrators", -"Получает нвости или одну новость с отобором по ID или доступности": "Gen post or array of post with ID or rights selection", +"Набор или массив наборов пар Ключ : Значение > Поле : Показатель": "Set or array of sets of pairs Key : Value > Field : FieldValue", +"Добавляет информацию о затраченном времени пользователя в задачу": "Adds information about the user's time spent to the task", +"Удаляет URL обработчика событий бота для работы в режиме Webhook": "Deletes the bot event handler URL for webhook operation", +"P.S Далее часто упоминается \"страница настроек Twitter Developer": "P.S The following is often referred to as the \"Twitter Developer settings page", +"Массив ячеек вида А1 для получения (весь лист, если не заполнено": "Array of A1 type cells to get (whole sheet if not filled", +"OPI_ПолучениеДанныхТестов.Проверка_ОзонДобавлениеКодов(Результат": "OPI_TestDataRetrieval.Check_OzonCodesUpload(Result", +"URL внешнего вебхука или адрес Bitrix24 при использовании токена": "URL of webhook or a Bitrix24 domain, when token used", +"OPI_ПолучениеДанныхТестов.Проверка_ОзонЗаданиеЗагрузки(Результат": "OPI_TestDataRetrieval.Check_OzonUploadTask(Result", +"Позволяет получать стадии без проверки прав (для администраторов": "Allows you to get stages without checking permissions (for administrators", +"Отступ от начала списка для получения сделок > 50 шт. рекурсивно": "Offset from the beginning of the list to retrieve deals > 50 pcs recursively", +"Получает массив сообщений, которые являются ответом на указанное": "Gets an array of messages that are replies to the specified", "Получает структурау полей для создания или изменения пользователя": "Gets the field structure for creating or modifying user information", -"Идентификатор следующей страницы списка баз из перыдудщего запроса": "Next page identifier of the base list from the previous request", -"ID стадии, после которой необходимо вставить новую (в начало по ум": "ID of the stage after which a new stage should be inserted (at the beginning by default", -"Тег уникальности Если уже существет, то другие увед. будут удалены": "Uniqueness Tag. If already exist, other notif. will be deleted", -"Доп. сбор за доставку товаров, общая стоимость которых в интервале": "Additional fee for delivery of products, the total value of which is in the range", -"OPI_ПолучениеДанныхТестов.Проверка_БитриксСтрока(Результат); SKIP": "OPI_TestDataRetrieval.Check_BitrixString(Result); SKIP", -"и авторизуйтесь с вашим номером телефона, который привязан к Viber": "and authorize yourself with your phone number linked to Viber", -"Результат функции ПолучитьТокенПоКоду(), если перевести его в JSON": "Result of the function GetTokenByCode() if converted to JSON", +"Получает нвости или одну новость с отобором по ID или доступности": "Gen post or array of post with ID or rights selection", +"Позволяет добавлять стадии без проверки прав (для администраторов": "Allows you to add stages without checking permissions (for administrators", +"URL внешнего веб-хука или адрес Bitrix24 при использовании токена": "URL of webhook or a Bitrix24 domain, when token used", +"Метод + РазделительBat + СтрСоединить(МассивОпций, РазделительBat": "Method + BatSeparator + StrConcat(OptionsArray, BatSeparator", +"Сохраните **ClientID** и **Client secret** со страницы приложения": "Save **ClientID** and **ClientSecret** from the application page", +"После создания приложения можно заполнить необходимые данные в 1С": "After creating the application, you can fill in the necessary data in 1C", +"Получает список файлов и каталогов, находящихся в корне хранилища": "Get a list of files and folders, located at the root of the storage", +"Клавиатура, если нужна, см. СформироватьКлавиатуруИзМассиваКнопок": "Keyboard, if needed, see CreateKeyboardFromArrayButton", "Обрабатывает данные Telegram Mini App и опредеяет их достоверность": "Processes Telegram Mini App data and determines its validity", -"Вид номера заказа. Истина > номер в базе клиента, Ложь > номер СДЭК": "Type of order number. True > number in the customer base, False > CDEK number", +"и авторизуйтесь с вашим номером телефона, который привязан к Viber": "and authorize yourself with your phone number linked to Viber", +"OPI_ПолучениеДанныхТестов.Проверка_БитриксСтрока(Результат); SKIP": "OPI_TestDataRetrieval.Check_BitrixString(Result); SKIP", +"Результат функции ПолучитьТокенПоКоду(), если перевести его в JSON": "Result of the function GetTokenByCode() if converted to JSON", +"Тег уникальности Если уже существет, то другие увед. будут удалены": "Uniqueness Tag. If already exist, other notif. will be deleted", +"ID стадии, после которой необходимо вставить новую (в начало по ум": "ID of the stage after which a new stage should be inserted (at the beginning by default", +"Идентификатор следующей страницы списка баз из перыдудщего запроса": "Next page identifier of the base list from the previous request", +"Доп. сбор за доставку товаров, общая стоимость которых в интервале": "Additional fee for delivery of products, the total value of which is in the range", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьБазу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateDatabase", +"Подробнее о каждом варианте релиза в разделе [Про варианты релизов]": "For more details about each release variant, see the section [About Release Variants]", +"Формирует блок с картинкой для добавления в массив блоков сообщения": "Generates a block with an image to add to the message block array", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFile", +"Перейдите на вкладку **API**, сгенерируйте и сохранеите **API KEY**": "Click on the **API** tab, generate and save the **API KEY**", +"Идентификатор владельца чата. Текущий пользователь, если не указано": "ID of chat owner. Current user by default", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьБлок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateBlock", +"Совпадающие поля будут перезаписаны с приоритетом параметра функции": "Matching fields will be overwritten with the parameter of the function", +"Метод + РазделительBash + СтрСоединить(МассивОпций, РазделительBash": "Method + BashSeparator + StrConcat(OptionsArray, BashSeparator", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьБлок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteBlock", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteFile", "Ограничение на ур. вложенности разбора. На всю глубину по умолчанию": "Parsing depth limit. Full depth by default", "Создает новые или обновляет существующие товары по структурам полей": "Creates new products or updates existing products, based on data structures", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВернутьБлок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ReturnBlock", +"OneScript: ./OInt/tools/Modules/internal/Modules/OPI_Инструменты.os": "OneScript: ./OInt/tools/Modules/internal/Modules/OPI_Tools.os", +"Вид номера заказа. Истина > номер в базе клиента, Ложь > номер СДЭК": "Type of order number. True > number in the customer base, False > CDEK number", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПоле": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateField", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьЛист": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteSheet", "ID пользователя. Для канала > администратора, для бота > получателя": "User ID. For channel > administrator, for bot > recipient", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteFile", -"OneScript: ./OInt/tools/Modules/internal/Modules/OPI_Инструменты.os": "OneScript: ./OInt/tools/Modules/internal/Modules/OPI_Tools.os", -"Метод + РазделительBash + СтрСоединить(МассивОпций, РазделительBash": "Method + BashSeparator + StrConcat(OptionsArray, BashSeparator", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьБазу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateDatabase", -"Совпадающие поля будут перезаписаны с приоритетом параметра функции": "Matching fields will be overwritten with the parameter of the function", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьБлок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateBlock", -"Идентификатор владельца чата. Текущий пользователь, если не указано": "ID of chat owner. Current user by default", -"Перейдите на вкладку **API**, сгенерируйте и сохранеите **API KEY**": "Click on the **API** tab, generate and save the **API KEY**", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьБлок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteBlock", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFile", -"Формирует блок с картинкой для добавления в массив блоков сообщения": "Generates a block with an image to add to the message block array", -"Подробнее о каждом варианте релиза в разделе [Про варианты релизов]": "For more details about each release variant, see the section [About Release Variants]", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКнигу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateSpreadsheet", -"Отмечает выбранное сообщение и все сообщения до него как прочитанные": "Mark current and all previous messages as readed", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateChannel", -"Создает новую задачу по структуре полей (см. ПолучитьСтруктуруЗадачи": "Create new task by fields structure (see GetTaskFieldsStructure", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьЛист": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddSheet", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТовар": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteProduct", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОбновитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UpdateFile", -"Курсор из предыдущего запроса для получения следующего набора файлов": "Cursor from the previous request to get the next set of files", -"Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации": "Gets token based on the code from the GetAuthorizationLink page", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВернутьБлок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ReturnBlock", "на redirect_uri после авторизации через браузер есть всего 30 секунд": "on redirect_uri after authorization via the browser is only 30 seconds", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПапку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateFolder", -"Создает новую сделку по структуре полей (см. ПолучитьСтруктуруСделки": "Creates a new deal by field structure (see. GetDealStructure", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetFile", -"Для начала работы необходимо получить некоторые параметры для VK API": "To begin, you need to obtain certain parameters for the VK API", -"Товар должен быть предварительно архивирован (см. АрхивироватьТовары": "The product must be pre-archived (see ArchiveProducts", "OneScript: ./OInt/tools/Modules/internal/Modules/OPI_Криптография.os": "OneScript: ./OInt/tools/Modules/internal/Modules/OPI_Cryptography.os", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendFile", -"Загружает видео в группу с возможностью его дальнейшего использования": "Uploads video to the group for further use", -"Результат функции ПреобразоватьКодВТокен(), если перевести его в JSON": "The result of the function ConvertCodeToToken(), if convert it to JSON", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПокинутьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"LeaveChannel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПоставитьЛайк": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"Like", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТокен": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetToken", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьЗаписи": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteRecords", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОбновитьТокен": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UpdateToken", -"Войдите в свой аккаунт и перейдите на страницу **Your Apps** на сайте": "Log in to your account and go to the **Your Apps** page on the website", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьЗаписи": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateRecords", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьТовар": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddProduct", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFile", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьДиалог": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenDialog", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteObject", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьТовар": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProduct", -"Возвращает структуру полей для фильтрации дочерних элементов каталога": "Returns filter structure for child folder items", +"Товар должен быть предварительно архивирован (см. АрхивироватьТовары": "The product must be pre-archived (see ArchiveProducts", +"Для начала работы необходимо получить некоторые параметры для VK API": "To begin, you need to obtain certain parameters for the VK API", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetFile", +"Создает новую сделку по структуре полей (см. ПолучитьСтруктуруСделки": "Creates a new deal by field structure (see. GetDealStructure", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПапку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateFolder", +"Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации": "Gets token based on the code from the GetAuthorizationLink page", +"Курсор из предыдущего запроса для получения следующего набора файлов": "Cursor from the previous request to get the next set of files", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОбновитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UpdateFile", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТовар": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteProduct", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьЛист": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddSheet", +"Создает новую задачу по структуре полей (см. ПолучитьСтруктуруЗадачи": "Create new task by fields structure (see GetTaskFieldsStructure", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateChannel", +"Отмечает выбранное сообщение и все сообщения до него как прочитанные": "Mark current and all previous messages as readed", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКнигу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateSpreadsheet", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьДиалог": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseDialog", "Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш": "Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОчиститьЯчейки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ClearCells", -"Сохраните ID бота, получив его при помощи кнопки \"Показать моих ботов\"": "Save the bot ID by retrieving it using the \"Show My Bots\" button", -"Перейдите в раздел **Premission scope** из пункта установки приложения": "Go to **Premission scope** page", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteEvent", -"Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи": "The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТаблицу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTable", -"Значение, возвращаемое в событии нажатия. Только если не заполнено URL": "The value returned in the event. Only if the URL is not filled", -"Получает список ID товарных категорий для указания при создании товара": "Gets a list of product category IDs to specify when creating a product", -"access_token нужно будет забрать из параметра в строке адреса браузера": "access_token will need to be taken from the parameter in the browser address bar", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьЗапись": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetRecord", -"!OInt ВызватьИсключение(\"Не удалось получить информацию из json медиа!": "!OInt RaiseException(\"Failed to get information from json media!", -"ОПИ - пакет интеграций с популярными API для 1С:Enterprise и OneScript": "OpenIntegrations - integration tools for popular APIs", +"Возвращает структуру полей для фильтрации дочерних элементов каталога": "Returns filter structure for child folder items", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьТовар": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProduct", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteObject", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьДиалог": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenDialog", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFile", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьТовар": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddProduct", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannel", +"Загружает видео в группу с возможностью его дальнейшего использования": "Uploads video to the group for further use", +"Войдите в свой аккаунт и перейдите на страницу **Your Apps** на сайте": "Log in to your account and go to the **Your Apps** page on the website", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОбновитьТокен": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UpdateToken", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьЗаписи": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteRecords", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТокен": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetToken", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПоставитьЛайк": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"Like", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПокинутьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"LeaveChannel", +"Результат функции ПреобразоватьКодВТокен(), если перевести его в JSON": "The result of the function ConvertCodeToToken(), if convert it to JSON", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendFile", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьЗаписи": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateRecords", "После заполнения данных полей можно приступать к работе с методами API": "After filling in the data fields, you can proceed to work with the API methods", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetObject", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateEvent", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВступитьВКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"JoinChannel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"КопироватьЛист": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopySheet", +"Устанавливает URL обработчика событий бота для работы в режиме Webhook": "Set webhook URL for bot event handling in webhook mode", +"Двоичные данные или путь к файлу при указании параметра ПутьСохранения": "Binary data or file path when SavePath parameter is specified", "Имя сайта (логин) для получения информации. Текущий, если не заполнено": "Site name (login) for information. Current, if not filled in", "Полную структуру можно получить функцией ПолучитьСтурктуруПользователя": "The full structure can be obtained with the function GetUserFieldsStructure", -"Двоичные данные или путь к файлу при указании параметра ПутьСохранения": "Binary data or file path when SavePath parameter is specified", -"Устанавливает URL обработчика событий бота для работы в режиме Webhook": "Set webhook URL for bot event handling in webhook mode", -"Параметр active_product устарел, используйте значения параметра visible": "The active_product parameter is deprecated, use the values of the visible parameter", -"Получает данные о лимитах на ассортимент, создание и обновление товаров": "Get requests limits for products managment methods", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditEvent", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьТаблицу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditTable", -"Результат функции ПолучитьКодПодтверждения(), если перевести его в JSON": "The result of the function GetConfirmationCode(), if convert it to JSON", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"Бан\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"Ban\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСсылку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLink", -"В следующий раз используйте опцию --out для указания пути их сохранения": "Next time, use the --out option to specify the path for saving", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьПодборку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteCollection", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСтраницу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePage", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetEvent", -"Получает информацию о количестве использованного дискового пространства": "Gets information on the amount of used disk space", +"ОПИ - пакет интеграций с популярными API для 1С:Enterprise и OneScript": "OpenIntegrations - integration tools for popular APIs", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"КопироватьЛист": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopySheet", +"!OInt ВызватьИсключение(\"Не удалось получить информацию из json медиа!": "!OInt RaiseException(\"Failed to get information from json media!", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВступитьВКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"JoinChannel", +"access_token нужно будет забрать из параметра в строке адреса браузера": "access_token will need to be taken from the parameter in the browser address bar", +"Получает список ID товарных категорий для указания при создании товара": "Gets a list of product category IDs to specify when creating a product", +"Значение, возвращаемое в событии нажатия. Только если не заполнено URL": "The value returned in the event. Only if the URL is not filled", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТаблицу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTable", +"Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи": "The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteEvent", +"Перейдите в раздел **Premission scope** из пункта установки приложения": "Go to **Premission scope** page", +"Сохраните ID бота, получив его при помощи кнопки \"Показать моих ботов\"": "Save the bot ID by retrieving it using the \"Show My Bots\" button", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОчиститьЯчейки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ClearCells", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьЗапись": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetRecord", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТаблицу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetTable", -"Ссылка](@dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867": "Link](@dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитВидео": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetVideo", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteMessage", -"можно получить в браузере по URL из функции СоздатьСсылкуПолученияТокена": "can be obtained in the browser via the URL from the CreateTokenRetrievalLink function", -"Полную документацию можно найти по адресу: (https://openintegrations.dev": "Full documentation can be found at: (https://openintegrations.dev", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКалендарь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateCalendar", -"Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач": "Removes a kanban (My Plan) stage, provided there are no tasks in it", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКонтакт": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendContact", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитГифки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetGif", +"Получает информацию о количестве использованного дискового пространства": "Gets information on the amount of used disk space", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetEvent", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСтраницу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePage", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьПодборку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteCollection", +"В следующий раз используйте опцию --out для указания пути их сохранения": "Next time, use the --out option to specify the path for saving", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"Бан\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"Ban\", \"Telegram", +"Результат функции ПолучитьКодПодтверждения(), если перевести его в JSON": "The result of the function GetConfirmationCode(), if convert it to JSON", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьТаблицу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditTable", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditEvent", +"Получает данные о лимитах на ассортимент, создание и обновление товаров": "Get requests limits for products managment methods", +"Параметр active_product устарел, используйте значения параметра visible": "The active_product parameter is deprecated, use the values of the visible parameter", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСсылку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLink", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитОпрос": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetPoll", -"За один запрос вы можете создать штрихкоды не больше чем для 100 товаров": "You can create barcodes for a maximum of 100 products per request", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтраницу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPage", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьКалендарь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteCalendar", -"Время начала учета. Дата должна совпадать с текущей. Текущее время по ум": "Start time. The date must match the current. Current time by default", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьЛокацию": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLocation", "Получает информацию об уценке и основном товаре по SKU уценённых товаров": "Retrieves discount and main product information by SKU of the discounted items", -"Возвращает список пользователей, просмотревших выбранное важное сообщение": "Return list of important post viewers ids", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереместитьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"MoveObject", -"Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский": "Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПост\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокБаз": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDatabaseList", -"Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум": "Stop time. The date must match the current. Current time by default", -"Метод удаляет файлы на сервере, если они отсутствуют в локальном каталоге": "The method deletes files on the server if they do not exist in the local directory", -"Длительность опроса, если необходимо (опрос без длительности не создается": "Poll duration if necessary (poll without duration is not created", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"НаписатьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage", -"Отмечает выбранное сообщение и все сообщения после него как непрочитанные": "Mark current and all messages after as unreaded", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьЛокацию": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLocation", +"Время начала учета. Дата должна совпадать с текущей. Текущее время по ум": "Start time. The date must match the current. Current time by default", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьКалендарь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteCalendar", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтраницу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPage", +"За один запрос вы можете создать штрихкоды не больше чем для 100 товаров": "You can create barcodes for a maximum of 100 products per request", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитГифки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetGif", +"Ссылка](@dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867": "Link](@dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867", +"Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач": "Removes a kanban (My Plan) stage, provided there are no tasks in it", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКалендарь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateCalendar", +"Полную документацию можно найти по адресу: (https://openintegrations.dev": "Full documentation can be found at: (https://openintegrations.dev", +"можно получить в браузере по URL из функции СоздатьСсылкуПолученияТокена": "can be obtained in the browser via the URL from the CreateTokenRetrievalLink function", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteMessage", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитВидео": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetVideo", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКонтакт": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendContact", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьПост\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeletePost\", \"VK", -"Она заточена для работы с сообществами и выполнением действий от их имени": "It is geared towards working with communities and performing actions on their behalf", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьБазуДанных": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateDatabase", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendPicture", -"Получает соответствие ID Emoji для установки в качестве иконок тем форума": "Gets the mapping of Emoji IDs for setting as forum theme icons", -"Устанавливает размер скидки на уценённые товары, продающиеся по схеме FBS": "Sets the amount of discount on discounted products sold under the FBS scheme", "Получает список id рекламных категорий для создания рекламного объявления": "Gets a list of advertising category IDs for creating an advertising post", +"Устанавливает размер скидки на уценённые товары, продающиеся по схеме FBS": "Sets the amount of discount on discounted products sold under the FBS scheme", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditMessage", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьАудио (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendAudio (DD", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateComment", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереместитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"MoveEvent", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтатистику": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetStatistics", -"ID задачи, после которой надо поставить выбранную (если не заполнено Перед": "ID of the task to be followed by the selected (if Prev not filled", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteComment", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьОпрос\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePoll\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереименоватьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RenameChannel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьГифку (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendGif (DD", -"Метод для вставки в http-сервис, адрес которого указывается в redirect_uri": "Method for insertion into an http service, the address of which is specified in redirect_uri", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайлПоURL": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFileByURL", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendPicture", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьБазуДанных": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateDatabase", +"Она заточена для работы с сообществами и выполнением действий от их имени": "It is geared towards working with communities and performing actions on their behalf", +"Отмечает выбранное сообщение и все сообщения после него как непрочитанные": "Mark current and all messages after as unreaded", +"Получает соответствие ID Emoji для установки в качестве иконок тем форума": "Gets the mapping of Emoji IDs for setting as forum theme icons", +"Длительность опроса, если необходимо (опрос без длительности не создается": "Poll duration if necessary (poll without duration is not created", +"Метод удаляет файлы на сервере, если они отсутствуют в локальном каталоге": "The method deletes files on the server if they do not exist in the local directory", +"Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум": "Stop time. The date must match the current. Current time by default", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокБаз": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDatabaseList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПост\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost\", \"VK", +"Язык ответа: DEFAULT (русский), RU, EN, TR (турецкий), ZH_HANS (китайский": "Response language: DEFAULT (Russian), RU, EN, TR (Turkish), ZH_HANS (Chinese)", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереместитьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"MoveObject", +"Возвращает список пользователей, просмотревших выбранное важное сообщение": "Return list of important post viewers ids", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"НаписатьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьБазуДанных": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDatabase", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТоварыПоИД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetProductsByID", "Признак включения в макет полей исключительно для заказо Интернет магазина": "Flag of including fields in the layout exclusively for online store orders", "URL вашего http-сервиса (или другого обработчика запросов) для авторизации": "URL of your http service (or other request handler) for authorization", -"ID задачи, перед которой надо поставить выбранную (если не заполнено После": "ID of the task to put the selected one in front of (if After not filled", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкоприроватьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopyObject", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"Разбан\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"Unban\", \"Telegram", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьВидео (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendVideo (DD", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкоприроватьОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopyObject", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайлПоURL": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFileByURL", +"ID задачи, перед которой надо поставить выбранную (если не заполнено После": "ID of the task to put the selected one in front of (if After not filled", +"Метод для вставки в http-сервис, адрес которого указывается в redirect_uri": "Method for insertion into an http service, the address of which is specified in redirect_uri", "Список доступных типов: audio, backup, book, compressed, data, development": "List of available types: audio, backup, book, compressed, data, development", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьАльбом\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateAlbum\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьЗаписи (одна": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateEntries (one", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитКартинки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetImages", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"КопироватьЛист (доп": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopySheet (new", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТаблицыБазы": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDatabaseTables", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьАльбом\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteAlbum\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьЗаписи (одна": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteEntries (one", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СгруппироватьТовары": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GroupProducts", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереименоватьКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RenameChannel", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьГифку (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendGif (DD", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateComment", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереместитьСобытие": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"MoveEvent", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтатистику": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetStatistics", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьАудио (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendAudio (DD", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteComment", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьОпрос\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePoll\", \"VK", +"ID задачи, после которой надо поставить выбранную (если не заполнено Перед": "ID of the task to be followed by the selected (if Prev not filled", +"Получает справочные значения характеристики по заданному значению в запросе": "Gets the reference values of the attribute by the specified value", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetComment", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СписокПользователей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UserList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditComment", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКомментарии": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetComments", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКопиюОбъекта": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateObjectCopy", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьВнешнийФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetExternalFile", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"НаписатьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"WriteComment", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьВнешнийФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddExternalFile", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьВнешнийФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetExternalFile", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьКопиюОбъекта": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateObjectCopy", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКомментарии": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetComments", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditComment", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СписокПользователей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UserList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКомментарий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetComment", -"Получает справочные значения характеристики по заданному значению в запросе": "Gets the reference values of the attribute by the specified value", -"Данные варианты релизов предназначены для использования в OneScript-проектах": "These release options are intended for use in OneScript projects", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьТемуКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetChannelTheme", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьИсторию (путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateStory (path", -"Можно упомянуть пользователя, добавив в текст его userId в следующем формате": "You can mention a user by adding their userId to the text in the following format", -"URL для создания кнопки открытия страницы. Только если не заполнено Значение": "URL to create the page open button. Only if the Value is not filled in", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьЦельКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetChannelGoal", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьИсторию\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateStory\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьАудио (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendAudio (Path", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьВнешнийФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendExternalFile", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТекстовыйТвит": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTextTweet", -"Возвращает структуру полей для фильтрации лидов в методе ПолучитьСписокЛидов": "Returns the field structure for filtering leads in the GetLeadsList method", -"Отправляет местоположение по географической широте и долготе в чат или канал": "Sends location by geographic latitude and longitude to a chat or channel", -"Создает пост на основе массива идетификаторов объектов (картинок, видео и др": "Creates a post based on an array of object identifiers (images, videos, etc.", -"Из OAuth 2.0 Client ID and Client Secret страницы настроек Twitter Developer": "From OAuth 2.0 Client ID and Client Secret settings page of Twitter Developer", -"Показывает значения, которые можно получить из переданного JSON и возвращает": "Displays the values that can be obtained from the passed JSON and returns", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"Изменение публикации": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ChangePublication", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьЗаписи (одна": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteEntries (one", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьАльбом\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteAlbum\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТаблицыБазы": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDatabaseTables", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"КопироватьЛист (доп": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopySheet (new", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТвитКартинки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTweetImages", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьЗаписи (одна": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateEntries (one", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьАльбом\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateAlbum\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СгруппироватьТовары": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GroupProducts", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьВидео (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendVideo (Path", "Полную структуру фильтра можно найти в функции ПолучитьСтруктуруФильтраЗадач": "Full filter structure you can find at GetTasksFilterStructure method", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСтраницуВБазу": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePageInDatabase", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСвойстваБазы": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditDatabaseProperties", "Выберите название и рабочую область, в которой необходимо создать приложение": "Select the name and workspace where you need to create the application", -"Получает структуру для отбора списка товаров в функции ПолучитьСписокТоваров": "Gets the structure for products list selecting in the GetProductList function", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокФайлов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetFileList", "в соответствии с условиями лицензии Attribution 4.0 International (CC BY 4.0": "under the terms of the Attribution 4.0 International (CC BY 4.0 license", +"Возвращает структуру полей для фильтрации задач в методе ПолучитьСписокЗадач": "Return filter structure for GetTasksList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокФайлов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetFileList", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьГифку (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendGif (Path", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВернутьДочерниеБлоки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ReturnChildBlocks", -"Возвращает структуру полей для фильтрации задач в методе ПолучитьСписокЗадач": "Return filter structure for GetTasksList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"Изменение публикации": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ChangePublication", +"Получает структуру для отбора списка товаров в функции ПолучитьСписокТоваров": "Gets the structure for products list selecting in the GetProductList function", +"Показывает значения, которые можно получить из переданного JSON и возвращает": "Displays the values that can be obtained from the passed JSON and returns", +"URL для создания кнопки открытия страницы. Только если не заполнено Значение": "URL to create the page open button. Only if the Value is not filled in", +"Создает пост на основе массива идетификаторов объектов (картинок, видео и др": "Creates a post based on an array of object identifiers (images, videos, etc.", +"Из OAuth 2.0 Client ID and Client Secret страницы настроек Twitter Developer": "From OAuth 2.0 Client ID and Client Secret settings page of Twitter Developer", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьТемуКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetChannelTheme", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьИсторию (путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateStory (path", +"Можно упомянуть пользователя, добавив в текст его userId в следующем формате": "You can mention a user by adding their userId to the text in the following format", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьЦельКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetChannelGoal", +"Данные варианты релизов предназначены для использования в OneScript-проектах": "These release options are intended for use in OneScript projects", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьАудио (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendAudio (Path", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьВнешнийФайл": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendExternalFile", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТекстовыйТвит": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTextTweet", +"Возвращает структуру полей для фильтрации лидов в методе ПолучитьСписокЛидов": "Returns the field structure for filtering leads in the GetLeadsList method", +"Отправляет местоположение по географической широте и долготе в чат или канал": "Sends location by geographic latitude and longitude to a chat or channel", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьИсторию\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateStory\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьОпрос (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendPoll (channel", +"в своем проекте и **заново получить токен** (последние два пункта инструкции)": "service in your existing project and reacquire the token (the last two steps in the instructions)", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьДокумент (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendDocument (DD", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИсториюКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelHistory", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокСобытий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetEventList", +"Получает код подтверждения и адрес страницы, на которой его необходимо ввести": "Gets the confirmation code and the address of the page where it needs to be entered", +"**Токен** и **ID страницы** - два параметра, необходимые для работы через API": "**Token** and **Page ID** are the two parameters required for working through the API.", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКаналов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьСвойствоТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteProductProperty", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокЗаписей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetEntryList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокЗаказов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetOrderList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСвойствоТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateProductProperty", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendImage (DD", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[4], \"ПолучитьПолеДаты": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[4], \"GetDateField", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьКартинку\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteImage\", \"VK", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТег\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteTag\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetProductList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьКартинку\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteImage\", \"VK", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьЗначенияЯчеек": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCellValues", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокСвойств": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPropertyList", "С одного аккаунта продавца можно использовать метод не больше 20 раз в минуту": "From one merchant account, you can use the method no more than 20 times per minute", "Размер файла. Если не заполнен > определяется автоматически скачиванием файла": "File size. If not filled in > determined automatically by downloading the file", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСвойствоТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateProductProperty", "Перейти в подраздел **Разработчикам** в разделе **Приложения** боковой панели": "Go to **Developers** in the **Applications** section of the sidebar", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокЗаписей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetEntryList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьОпрос (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendPoll (channel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьСвойствоТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteProductProperty", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКаналов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelList", -"**Токен** и **ID страницы** - два параметра, необходимые для работы через API": "**Token** and **Page ID** are the two parameters required for working through the API.", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокЗаказов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetOrderList", -"Получает код подтверждения и адрес страницы, на которой его необходимо ввести": "Gets the confirmation code and the address of the page where it needs to be entered", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокСобытий": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetEventList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИсториюКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelHistory", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьДокумент (ДД": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendDocument (DD", -"в своем проекте и **заново получить токен** (последние два пункта инструкции)": "service in your existing project and reacquire the token (the last two steps in the instructions)", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТоварИзПодборки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RemoveProductFromCollection", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьТег\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddTag\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПост (один путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost (single path", -"!OInt Сообщить(ЛокальныйПуть.Ключ + Символы.ПС + Ответ[\"message\"] + Символы.ПС": "!OInt Message(LocalPath.Key + Chars.LF + Response[\"message\"] + Chars.LF", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьТоварВПодборку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddProductToCollection", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[6], \"ПолучитьПолеПочты": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[6], \"GetEmailField", -"Вне зависимости от выбранного сопособа установки, получать файлы необходимо из": "Regardless of the chosen installation method, the files must be obtained from the", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПодборкуТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateProductCollection", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьВидеоНаСервер": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadVideoToServer", -"Все права защищены. Эта программа и сопроводительные материалы предоставляются": "All rights reserved. This program and accompanying materials are provided", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьФайл\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFile\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокПодборок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCollectionList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСвойствоТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProductProperty", "Возвращает структуру полей для фильтрации сделок в методе ПолучитьСписокСделок": "Returns the field structure for filtering deals in the GetDealsList method", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСвойствоТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProductProperty", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокПодборок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCollectionList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьФайл\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFile\", \"Dropbox", +"Все права защищены. Эта программа и сопроводительные материалы предоставляются": "All rights reserved. This program and accompanying materials are provided", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайл (в канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFile (to channel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКалендарьСписка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetListCalendar", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendImage (Path", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[0], \"ПолучитьПолеНомера": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[0], \"GetNumberField", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateDiscussion\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОБоте": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetBotInfo", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПапку\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateFolder\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseDiscussion\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьПапку\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFolder\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКаталогов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCatalogList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьЗначенияЯчеек": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetCellValues", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьКалендарьСписка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditListCalendar", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКонтакт (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendContact (channel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[3], \"ПолучитьПолеФлажка": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[3], \"GetCheckboxField", +"Вне зависимости от выбранного сопособа установки, получать файлы необходимо из": "Regardless of the chosen installation method, the files must be obtained from the", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[6], \"ПолучитьПолеПочты": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[6], \"GetEmailField", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьТоварВПодборку": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddProductToCollection", +"!OInt Сообщить(ЛокальныйПуть.Ключ + Символы.ПС + Ответ[\"message\"] + Символы.ПС": "!OInt Message(LocalPath.Key + Chars.LF + Response[\"message\"] + Chars.LF", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПост (один путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost (single path", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьТег\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddTag\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТоварИзПодборки": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RemoveProductFromCollection", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПодборкуТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateProductCollection", "Из Consumer Keys -> Access Token and Secret страницы настроек Twitter Developer": "From Consumer Keys -> Access Token and Secret settings page of Twitter Developer", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenDiscussion\", \"VK", "Создает одну или массив записей по описанию или массиву описаний значений полей": "Creates one or an array of records by description or an array of field value descriptions", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьФайл\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFile\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьПубличныйОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPublicObject", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьПодборкуТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProductCollection", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьДокумент (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendDocument (Path", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьПодборкуТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProductCollection", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[7], \"ПолучитьПолеСсылки": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[7], \"GetLinkField", -"Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей": "True > structure with empty valuse, False > field descriptions at values", -"D:\\REPOS\\OpenIntegrations\\src\\ru\\OInt\\tests\\Modules\\Coverage_ЗапускВсехТестов.os": "D:\\REPOS\\OpenIntegrations\\src\\ru\\OInt\\tests\\Modules\\Coverage_StartAllTests.os", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтатистикуПостов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPostStatistics", -"Причина изменения. Обязателен при указании Время и отключенном свободном графике": "Reason for change. Required when Time is specified and free schedule is disabled", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСвойстваСтраницы": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditPageProperties", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОДиске": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDiskInfo", -"Параметры fbs_sku и fbo_sku из ответа метода были отключены 15 августа 2023 года": "The fbs_sku and fbo_sku parameters from the method response were disabled on August 15, 2023", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьКалендарьВСписок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddCalendarToList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайл\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFile\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение (json": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage (json", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteObject\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[3], \"ПолучитьПолеФлажка": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[3], \"GetCheckboxField", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьПубличныйОбъект": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPublicObject", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКонтакт (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendContact (channel", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОБоте": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetBotInfo", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьЗначенияЯчеек": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetCellValues", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКаталогов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCatalogList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкачатьПапку\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DownloadFolder\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseDiscussion\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПапку\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateFolder\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьКалендарьСписка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditListCalendar", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateDiscussion\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[0], \"ПолучитьПолеНомера": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[0], \"GetNumberField", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку (Путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendImage (Path", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьКалендарьСписка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetListCalendar", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКалендарей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCalendarList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОКанале": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelInfo", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"НаписатьВОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PostInDiscussion\", \"VK", -"Обновление происходит методом ОбновитьТокен с новыми access_token и refresh_token": "The update is done using the UpdateToken method with new access_token and refresh_token", -"Сохраните **токен**, который вам прислал BotFather после завершения создания бота": "Save the **token** that BotFather sent you after completing the bot creation", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОчиститьОсновнойКалендарь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ClearPrimaryCalendar", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьПревью\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPreview\", \"Dropbox", -"Если в не знаете с чего начать, то стоит найти метод ПолучитьСтандартныеПараметры": "If you don't know where to start, you should find the GetStandardParameters method", -"Токен и ID чата являются основными параметрами всех методов работы с Telegram API": "The token and chat ID are the primary parameters for all methods of working with the Telegram API", -"id приложения, которое необходимо создать в профиле на странице для разработчиков": "application ID that needs to be created in the profile on the developer page", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteObject\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение (json": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage (json", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайл\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFile\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьКалендарьВСписок": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddCalendarToList", +"Параметры fbs_sku и fbo_sku из ответа метода были отключены 15 августа 2023 года": "The fbs_sku and fbo_sku parameters from the method response were disabled on August 15, 2023", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьСвойстваСтраницы": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditPageProperties", +"Причина изменения. Обязателен при указании Время и отключенном свободном графике": "Reason for change. Required when Time is specified and free schedule is disabled", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтатистикуПостов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPostStatistics", +"D:\\REPOS\\OpenIntegrations\\src\\ru\\OInt\\tests\\Modules\\Coverage_ЗапускВсехТестов.os": "D:\\REPOS\\OpenIntegrations\\src\\ru\\OInt\\tests\\Modules\\Coverage_StartAllTests.os", +"Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей": "True > structure with empty valuse, False > field descriptions at values", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОДиске": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDiskInfo", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[2], \"ПолучитьПолеВложения": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[2], \"GetAttachmentField", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТокен\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetToken\", \"Bitrix24", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьНаименованиеКниги": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditSpreadsheetTitle", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуНаСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetMessageLink", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОбновитьТокен\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RefreshToken\", \"Bitrix24", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[5], \"ПолучитьПолеТелефона": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[5], \"GetPhoneField", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОбновитьТокен\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RefreshToken\", \"Bitrix24", "Для начала работы необходимо вызвать команду `oint` из командной строки/терминала": "To get started, you need to call the command `oint` from the command prompt/terminal", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьОпрос\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendSurvey\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СерверноеВремя\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ServerTime\", \"Bitrix24", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьДанныеПользователя": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUserData", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[1], \"ПолучитьПолеСтроковое": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[1], \"GetStringField", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьВидео\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendVideo\", \"Telegram", -"В боковом меню выберите пункт Credentials -> Create Credentials -> OAuth client ID": "In the side menu, select Credentials -> Create Credentials -> OAuth client ID", -"Авторизуйтесь в Airtable и перейдите **[на страницу создания персональных токенов]": "Sign in to Airtable and go to the **[personal tokens creation page]", -"Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели": "Generates a simple JSON keyboard from an array of buttons for a message or bottom panel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКомментариев": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCommentList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьТемуФорума (главная": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseForumTopic (main", -"Данные вложений, где ключ > имя файла, значение > путь к файлу иди двоичные данные": "Attachment data where key > filename, value > file path or binary data", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСоставнойПост\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateCompositePost\", \"VK", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьТемуФорума (главная": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenForumTopic (main", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуНаСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetMessageLink", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьНаименованиеКниги": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditSpreadsheetTitle", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьТокен\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetToken\", \"Bitrix24", +"id приложения, которое необходимо создать в профиле на странице для разработчиков": "application ID that needs to be created in the profile on the developer page", +"Обновление происходит методом ОбновитьТокен с новыми access_token и refresh_token": "The update is done using the UpdateToken method with new access_token and refresh_token", +"Если в не знаете с чего начать, то стоит найти метод ПолучитьСтандартныеПараметры": "If you don't know where to start, you should find the GetStandardParameters method", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьПревью\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPreview\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОчиститьОсновнойКалендарь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ClearPrimaryCalendar", +"Сохраните **токен**, который вам прислал BotFather после завершения создания бота": "Save the **token** that BotFather sent you after completing the bot creation", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"НаписатьВОбсуждение\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PostInDiscussion\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОКанале": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelInfo", +"Токен и ID чата являются основными параметрами всех методов работы с Telegram API": "The token and chat ID are the primary parameters for all methods of working with the Telegram API", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьНовость\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost\", \"Bitrix24", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьРекламноеОбъявление": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateAd", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьНовость\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeletePost\", \"Bitrix24", "Вызывает метод получения токена, так как для получения токена из кода, приходящего": "Calls the token acquisition method, as for obtaining a token from the code received", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьАудио\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendAudio\", \"Telegram", +"color=Зеленый) - путь к файлу сохранения результата (двоичных данных в частности": "color=Green) - the path to the result saving file (particularly binary data", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьПост (одна картинка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost (single image", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьWebhook\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteWebhook\", \"Telegram", -"color=Зеленый) - путь к файлу сохранения результата (двоичных данных в частности": "color=Green) - the path to the result saving file (particularly binary data", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьГифку\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendGif\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокПользователей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUserList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОбОбъекте": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetObjectInfo", -"На данной странице описаны все действия, необходимые для полноценного начала работы": "On this page, all the steps necessary to start working are described", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьМетаданныеКалендаря": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCalendarMetadata", -"Получает структуру для внесения остатков товара в функции ОбновитьКоличествоТоваров": "Gets the data structure for udpating product stocks in the UpdateProductsStocks function", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьОнлайнПользователей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetOnlineUsers", -"Формирует кнопку действия для клавиатуры сообщения (см. ОтправитьТекстовоеСообщение": "Forms an action button for the message keyboard (see SendTextMessage", -"Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей": "Returns the field structure for filtering users in the FindUsers method", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВыгнатьПользователяИзКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"KickUserFromChannel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуДляСкачивания": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDownloadLink", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьТемуФорума (главная": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenForumTopic (main", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьАудио\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendAudio\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСоставнойПост\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateCompositePost\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СерверноеВремя\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ServerTime\", \"Bitrix24", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьТемуФорума (главная": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseForumTopic (main", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКомментариев": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCommentList", +"Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели": "Generates a simple JSON keyboard from an array of buttons for a message or bottom panel", +"Авторизуйтесь в Airtable и перейдите **[на страницу создания персональных токенов]": "Sign in to Airtable and go to the **[personal tokens creation page]", +"В боковом меню выберите пункт Credentials -> Create Credentials -> OAuth client ID": "In the side menu, select Credentials -> Create Credentials -> OAuth client ID", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьВидео\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendVideo\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(МассивПолей[1], \"ПолучитьПолеСтроковое": "!OInt OPI_TestDataRetrieval.WriteLog(FieldArray[1], \"GetStringField", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьДанныеПользователя": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUserData", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьОпрос\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendSurvey\", \"Telegram", +"Данные вложений, где ключ > имя файла, значение > путь к файлу иди двоичные данные": "Attachment data where key > filename, value > file path or binary data", "Для Twitter это довольно значительный набор, что обсуловлено наличием сразу 2-х API": "For Twitter, this is quite a significant set, which is due to the presence of 2 APIs at once", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьМетаданныеКалендаря": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditCalendarMetadata", -"Пока вам не нужно использовать такие методы, получать communitytoken не обязательно": "You don't need to obtain the 'communitytoken' if you're not using such methods at the moment", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокВнешнихФайлов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetExternalFileList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"КопироватьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopyObject\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьТекстовоеСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendTextMessage", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьВариантСвойстваТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteProductPropertyVariant", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОпубликоватьПапку\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PublishFolder\", \"Dropbox", -"После завершения создания интеграции, нажмите *Show* и скопируйте **Токен (Secret)**": "After finishing the integration creation, click *Show* and copy the **Token (Secret)**", -"OInt CLI - приложение для работы с API различных онлайн-сервисов из командной строки": "OInt CLI - CLI toolkit for integrating with APIs of popular online services", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение (картинка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage (image", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"КопироватьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CopyObject\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуДляСкачивания": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDownloadLink", +"Пока вам не нужно использовать такие методы, получать communitytoken не обязательно": "You don't need to obtain the 'communitytoken' if you're not using such methods at the moment", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВыгнатьПользователяИзКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"KickUserFromChannel", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокВнешнихФайлов": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetExternalFileList", +"Формирует кнопку действия для клавиатуры сообщения (см. ОтправитьТекстовоеСообщение": "Forms an action button for the message keyboard (see SendTextMessage", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьОнлайнПользователей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetOnlineUsers", +"Получает структуру для внесения остатков товара в функции ОбновитьКоличествоТоваров": "Gets the data structure for udpating product stocks in the UpdateProductsStocks function", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьМетаданныеКалендаря": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetCalendarMetadata", +"На данной странице описаны все действия, необходимые для полноценного начала работы": "On this page, all the steps necessary to start working are described", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОбОбъекте": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetObjectInfo", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокПользователей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUserList", +"Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей": "Returns the field structure for filtering users in the FindUsers method", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереместитьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"MoveObject\", \"Dropbox", +"Преобразовывает код в токен после ввода кода при выполнении ПолучитьКодПодтверждения": "Converts the code to a token after entering the code when executing GetConfirmationCode", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКонтакт\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendContact\", \"Telegram", +"Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT": "If you want to add an intranet user, you must pass UF_DEPARTMENT field", "Получить пустую структуру можно при помощи метода ПолучитьСокращеннуюСтруктуруТовара": "You can get an empty structure using the GetSimplifiedProductStructure method", "ID пользователя из информации о канале не подойдет для отправки сообщений через бота": "The user ID from channel information is not suitable for sending messages through the bot", -"Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT": "If you want to add an intranet user, you must pass UF_DEPARTMENT field", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКонтакт\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendContact\", \"Telegram", -"Преобразовывает код в токен после ввода кода при выполнении ПолучитьКодПодтверждения": "Converts the code to a token after entering the code when executing GetConfirmationCode", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереместитьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"MoveObject\", \"Dropbox", -"Вызов данного метода должен использоваться в ответ на получение события callbackQuery": "This method call should be used in response to receiving a callbackQuery event", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьВариантСвойстваТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddProductPropertyVariant", -"Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа": "Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendImage\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьДокумент\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendDocument\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьWebhook\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetWebhook\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайлПоURL\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFileByURL\", \"Dropbox", -"**IDПользователя** - ваш ID (администратора канала). См. Получить информацию о канале": "**UserID** - your ID (channel administrator). See Get Channel Information for details", +"OInt CLI - приложение для работы с API различных онлайн-сервисов из командной строки": "OInt CLI - CLI toolkit for integrating with APIs of popular online services", +"После завершения создания интеграции, нажмите *Show* и скопируйте **Токен (Secret)**": "After finishing the integration creation, click *Show* and copy the **Token (Secret)**", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОпубликоватьПапку\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PublishFolder\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьВариантСвойстваТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteProductPropertyVariant", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение (картинка": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage (image", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьВариантСвойстваТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProductPropertyVariant", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenForumTopic\", \"Telegram", +"Создайте новый токен, нажав **Generate Token and Scopes** ниже на странице приложения": "Create a new token by clicking Generate Token and Scopes below on the application page", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteForumTopic\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateForumTopic\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseForumTopic\", \"Telegram", +"Описание структур см. здесь https:pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT": "Description of structures see here https:pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT", +"Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId": "You can mention a user by appending their userId to the text in the following format @[userId", +"|--> ОбновитьТокен() ->|access_token --> Используется в т-нии 2-х часов для запросов": "|--> RefreshToken() ->| access_token --> Used in the interval of 2 hours for requests", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПригласитьПользователейВКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"InviteUsersToChannel", "Файл не был записан! Используйте флаг --debug для получения дополнительной информации": "File was not saved! Use the --debug flag for more information", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокРабочихОбластей": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetWorkspaceList", +"**IDПользователя** - ваш ID (администратора канала). См. Получить информацию о канале": "**UserID** - your ID (channel administrator). See Get Channel Information for details", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗагрузитьФайлПоURL\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UploadFileByURL\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УстановитьWebhook\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SetWebhook\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьДокумент\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendDocument\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьКартинку\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendImage\", \"Telegram", +"Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа": "Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьВариантСвойстваТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddProductPropertyVariant", +"Вызов данного метода должен использоваться в ответ на получение события callbackQuery": "This method call should be used in response to receiving a callbackQuery event", "Все страницы, которые будут созданы как дочерние, должны иметь свойства базы-родителя": "All pages created as children must have parent base properties", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПригласитьПользователейВКанал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"InviteUsersToChannel", -"|--> ОбновитьТокен() ->|access_token --> Используется в т-нии 2-х часов для запросов": "|--> RefreshToken() ->| access_token --> Used in the interval of 2 hours for requests", -"Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId": "You can mention a user by appending their userId to the text in the following format @[userId", -"Описание структур см. здесь https:pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT": "Description of structures see here https:pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрытьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CloseForumTopic\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateForumTopic\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeleteForumTopic\", \"Telegram", -"Создайте новый токен, нажав **Generate Token and Scopes** ниже на странице приложения": "Create a new token by clicking Generate Token and Scopes below on the application page", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрытьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"OpenForumTopic\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьВариантСвойстваТовара": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"EditProductPropertyVariant", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКатегорийТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetProductCategoryList", -"Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей": "True > structure with empty values, False > field types at values", -"id группы с \"-\" в начале. Можно найти в настройках группы ВК или в ее URL, если не был": "group ID with \"-\" at the beginning. Can be found in the settings of the VK group or in its URL if not set", -"Получение ссылки для интерактивного получения токена (access_token), который необходим": "Getting a link for interactive token retrieval (access_token), which is necessary", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереслатьСообщение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ForwardMessage\", \"Telegram", -"статус для сортировки. Аналогичен REAL_STATUS, но имеет дополнительно три мета-статуса": "status for sorting. Similar to REAL_STATUS, but has three additional meta-statuses", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ChangeForumTheme\", \"Telegram", -"Массив|Один получатель: UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа": "Array or a single post target: UA all, SG work group, U user, DR depart., G group", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьМестоположение (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLocation (channel", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СохранитьКартинкуВАльбом (путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SaveImageToAlbum (path", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокТегов\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetTagList\", \"Dropbox", -"которые, при этом, созданы не для разныз задач, но просто являются версиями друг друга": "which, at the same time, are not created for different tasks, but are simply versions of each other", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ЗакрепитьСообщение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PinMessage\", \"Telegram", "Зарегистрируйтесь, оформите тариф и скачайте приложение VK Teams [на главной странице]": "Register, book a tariff and download the VK Teams app [on the home page]", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокТегов (одиночный": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetTagList (single", "Массив|Один получатель (UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа": "Array or a single post target (UA all, SG work group, U user, DR depart., G group", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СохранитьКартинкуВАльбом\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SaveImageToAlbum\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьОбновления\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUpdates\", \"Telegram", "набор разрешений для получаемого ключа. Может быть любой, но offline.access обязателен": "a set of permissions for the received key. Can be any, but offline.access is mandatory", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение (отложенное": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendDelayedMessage", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОткрепитьСообщение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DetachMessage\", \"Telegram", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьОбновления\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUpdates\", \"Telegram", -"Описание полей фильтра можно найти на странице документации по получению списка товаров": "The description of the filter fields can be found on the documentation page for product list retrieving method", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьОпрос (строчный массив": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendPoll (string array", -"Из Authentication Tokens -> Access Token and Secret страницы настроек Twitter Developer": "From Authentication Tokens -> Access Token and Secret settings page of Twitter Developer", -"Заполните поля App name, User support email и Email addresses (все поля со звездочками)": "Fill in the fields: App name, User support email, and Email addresses (all fields with asterisks)", -"можно использовать http-сервис. Туда же будет приходить и информация о новых сообщениях": "you can use an HTTP service. Information about new messages will also be sent there", -"Узнать, есть ли вложенный справочник, можно через метод ПолучитьХарактеристикиКатегории": "You can find out if there is a nested catalog by the GetCharacteristicsCategories method", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СохранитьКартинкуВАльбом\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SaveImageToAlbum\", \"VK", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокТегов\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetTagList\", \"Dropbox", +"которые, при этом, созданы не для разныз задач, но просто являются версиями друг друга": "which, at the same time, are not created for different tasks, but are simply versions of each other", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьМестоположение (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLocation (channel", +"Массив|Один получатель: UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа": "Array or a single post target: UA all, SG work group, U user, DR depart., G group", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ChangeForumTheme\", \"Telegram", +"статус для сортировки. Аналогичен REAL_STATUS, но имеет дополнительно три мета-статуса": "status for sorting. Similar to REAL_STATUS, but has three additional meta-statuses", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПереслатьСообщение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ForwardMessage\", \"Telegram", +"Получение ссылки для интерактивного получения токена (access_token), который необходим": "Getting a link for interactive token retrieval (access_token), which is necessary", +"id группы с \"-\" в начале. Можно найти в настройках группы ВК или в ее URL, если не был": "group ID with \"-\" at the beginning. Can be found in the settings of the VK group or in its URL if not set", +"Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей": "True > structure with empty values, False > field types at values", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокКатегорийТоваров": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetProductCategoryList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СохранитьКартинкуВАльбом (путь": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SaveImageToAlbum (path", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьСообщение (json массив": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMessage (json array", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьМедиагруппу\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMediaGroup\", \"Telegram", -"Связанные функции: ПолучитьСписокТоваров, ПолучитьКоличествоТоваров, ПолучитьЦеныТоваров": "Related functions: GetProductList, GetProductsStocks, GetProductsPrices", +"Узнать, есть ли вложенный справочник, можно через метод ПолучитьХарактеристикиКатегории": "You can find out if there is a nested catalog by the GetCharacteristicsCategories method", +"можно использовать http-сервис. Туда же будет приходить и информация о новых сообщениях": "you can use an HTTP service. Information about new messages will also be sent there", +"Описание полей фильтра можно найти на странице документации по получению списка товаров": "The description of the filter fields can be found on the documentation page for product list retrieving method", +"Из Authentication Tokens -> Access Token and Secret страницы настроек Twitter Developer": "From Authentication Tokens -> Access Token and Secret settings page of Twitter Developer", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьОпрос (строчный массив": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendPoll (string array", +"Заполните поля App name, User support email и Email addresses (все поля со звездочками)": "Fill in the fields: App name, User support email, and Email addresses (all fields with asterisks)", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПриостановитьРекламноеОбъявление": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PauseAdvertisement", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокОтветовНаСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetMessageReplyList", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьНовость (хук)\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeletePost (wh)\", \"Bitrix24", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьНовость (хук)\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost (wh)\", \"Bitrix24", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СерверноеВремя (хук)\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ServerTime (wh)\", \"Bitrix24", "Получает структуру для создания товара на основе Ozon ID в функции СоздатьТоварыПоOzonID": "Gets the structure for creating a product based on Ozon ID in the CreateProductByOzonID function", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователейКФайлу (доп": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUsersToFile (new", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьМедиагруппу\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendMediaGroup\", \"Telegram", "Создать ссылку для авторизации в браузере при помощи функции *ПолучитьСсылкуАвторизации*": "Create a link for authorization in the browser using the *GetAuthorizationLink* function", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СерверноеВремя (хук)\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ServerTime (wh)\", \"Bitrix24", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПриостановитьРекламноеОбъявление": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"PauseAdvertisement", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"УдалитьНовость (хук)\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"DeletePost (wh)\", \"Bitrix24", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокОтветовНаСообщение": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetMessageReplyList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьНовость (хук)\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreatePost (wh)\", \"Bitrix24", +"Связанные функции: ПолучитьСписокТоваров, ПолучитьКоличествоТоваров, ПолучитьЦеныТоваров": "Related functions: GetProductList, GetProductsStocks, GetProductsPrices", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокПользователейКанала": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetChannelUserList", "Отбор новостей по доступу (UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа": "Post selection by rights (UA all, SGn work group, Un user, DRn depart, Gn group", "Показывает дни рождения, годовщины и другие значимые события для людей в Google Контактах": "Hollydays", @@ -6313,23 +6313,24 @@ "При следующем обновлении нужно использовать уже новый refresh_token, так что захардкодить": "For the next update, you need to use a new refresh_token, so hardcode", "!OInt Сообщить(Прогресс + ЛокальныйПуть.Ключ + Символы.ПС + Ответ[\"message\"] + Символы.ПС": "!OInt Message(Progress + LocalPath.Key + Chars.LF + Response[\"message\"] + Chars.LF", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокОтложенныхСообщений": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetDelayedMessageList", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСсылкуПолученияТокена\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTokenRequestLink\", \"VK", -"Данные варианты релизов - различные формы поставки расширения для платформы 1С:Предприятие": "These release options are various forms of distribution for the extension for the 1C:Enterprise platform", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтменитьПубликациюФайла\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UnpublishFile\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтменитьПубликациюПапки\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UnpublishFolder\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьТекстовоеСообщение (форум": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendTextMessage (forum", -"Приходит вместе с access_token и используется для его обновления (время жизни access_token": "Comes together with access_token and is used to refresh it (access_token lifetime", -"ВАЖНО: Установка Webhook обязательна по правилам Viber. Для этого надо иметь свободный URL": "IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to have a free URL for this.", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьТекстовоеСообщение (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendTextMessage (channel", -"Остатки крупногабаритных товаров можно обновлять только на предназначенных для них складах": "Stocks of bulky goods can only be renewed in the warehouses designated for them", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюБота\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetBotInfo\", \"Telegram", -"Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации": "Gets the token by the code received when authorizing using the link from GetAuthorizationLink", "Получить пустую структуру можно при помощи метода ПолучитьСтруктуруОбновленияХарактеристик": "You can get an empty structure using the GetAttributesUpdateStructure method", -"ПолучитьСсылкуАвторизации() -> Браузер -> code придет на redirect_uri -> ПолучитьТокен(code": "GetAuthorizationLink() -> Browser -> code will come to redirect_uri -> GetToken(code", -"Данная библиотека позволяет работать с функционалом бесплатного плана, т.е. создавать твиты": "This library allows you to work with the functionality of the free plan, meaning you can create tweets", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкрытьГлавнуюТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"HideMainForumTheme\", \"Telegram", +"Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации": "Gets the token by the code received when authorizing using the link from GetAuthorizationLink", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюБота\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetBotInfo\", \"Telegram", +"Остатки крупногабаритных товаров можно обновлять только на предназначенных для них складах": "Stocks of bulky goods can only be renewed in the warehouses designated for them", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьТекстовоеСообщение (канал": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendTextMessage (channel", +"ВАЖНО: Установка Webhook обязательна по правилам Viber. Для этого надо иметь свободный URL": "IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to have a free URL for this.", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтменитьПубликациюФайла\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UnpublishFile\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьТекстовоеСообщение (форум": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendTextMessage (forum", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтменитьПубликациюПапки\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"UnpublishFolder\", \"Dropbox", +"Данные варианты релизов - различные формы поставки расширения для платформы 1С:Предприятие": "These release options are various forms of distribution for the extension for the 1C:Enterprise platform", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСсылкуПолученияТокена\", \"VK": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateTokenRequestLink\", \"VK", +"Приходит вместе с access_token и используется для его обновления (время жизни access_token": "Comes together with access_token and is used to refresh it (access_token lifetime", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьМестоположение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendLocation\", \"Telegram", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьЧислоУчастников\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetMemberCount\", \"Telegram", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СкрытьГлавнуюТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"HideMainForumTheme\", \"Telegram", +"ПолучитьСсылкуАвторизации() -> Браузер -> code придет на redirect_uri -> ПолучитьТокен(code": "GetAuthorizationLink() -> Browser -> code will come to redirect_uri -> GetToken(code", +"Данная библиотека позволяет работать с функционалом бесплатного плана, т.е. создавать твиты": "This library allows you to work with the functionality of the free plan, meaning you can create tweets", +"!OInt Сообщить(OPI_Инструменты.ИнформацияОПрогрессе(ТекущаяПозиция, ОбщийРазмер, \"МБ\", МБайт": "!OInt Message(OPI_Tools.ProgressInfo(CurrentPosition, TotalSize, \"MB\", MB", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"СоздатьСсылкуПриглашение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"CreateInvitationLink\", \"Telegram", "При каждом вызове метода передавайте все изображения, которые должны быть на карточке товара": "On each method call, send all the images that should be on the product card", "Отправляет набор файлов в чат или канал. Варианты типов медиа: audio, document, photo, video": "Sends a set of files to a chat or channel. Media types: audio, document, photo, video", @@ -6338,35 +6339,34 @@ "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокФайловПапки\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetFolderFileList\", \"Dropbox", "Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения": "Change storage name (for app storage only, see. GetAppStorage", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"Dropbox_ПереместитьОбъект\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"Dropbox_MoveObject\", \"Dropbox", -"!OInt Сообщить(OPI_Инструменты.ИнформацияОПрогрессе(ТекущаяПозиция, ОбщийРазмер, \"МБ\", МБайт": "!OInt Message(OPI_Tools.ProgressInfo(CurrentPosition, TotalSize, \"MB\", MB", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ВосстановитьОбъектКВерсии\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"RestoreObjectToVersion\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуАвторизации\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetAuthorizationLink\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователяКФайлу\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUserToFile\", \"Dropbox", -"на версии 1.1, а что-то на 2: вплоть до того что они убрали возможность постить твиты из v1.1": "on version 1.1, and something on 2: up to the point that they removed the ability to post tweets from v1.1", -"Получает информацию о хранилище с которым может работать приложение для хранения своих данных": "Get information about storage with which the application can work to store its data", -"Сгенерируйте новый **токен** и включите возможность добавлять бота в группу (если необходимо)": "Generate a new **token** and enable the ability to add the bot to a group (if necessary)", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПоказатьГлавнуюТемуФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ShowMainForumTheme\", \"Telegram", +"Сгенерируйте новый **токен** и включите возможность добавлять бота в группу (если необходимо)": "Generate a new **token** and enable the ability to add the bot to a group (if necessary)", "В IDЧатаИсточника можно передавать только chatId из событий (код из ссылки на чат не подходит": "Only the chatId from events can be passed to the FromChatID (the code from the chat link is not suitable)", -"Набор инструментов для интеграции с популярными API посредством CLI, 1C:Enterprise и OneScript": "A toolkit for integrating with popular APIs via CLI, 1C:Enterprise and OneScript", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователейКПапке\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUsersToFolder\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователейКФайлу\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUsersToFile\", \"Dropbox", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтатусЗагрузкиПоURL\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUploadStatusByUrl\", \"Dropbox", -"Массив|Один получатель (UA все, SG раб. группа, U пользователь, DR отдел, G группа": "Array or a single post target (UA all, SG work group, U user, DR depart., G group", -"Получает список первых файлов каталога или продолжает получение следующих при указании курсора": "Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокВерсийОбъекта\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetObjectVersionList\", \"Dropbox", -"Получает структуру для обновления характеристик товара в функции ОбновитьХарактеристикиТоваров": "Gets the structure for updating product characteristics in the UpdateProductsAttributes function", +"на версии 1.1, а что-то на 2: вплоть до того что они убрали возможность постить твиты из v1.1": "on version 1.1, and something on 2: up to the point that they removed the ability to post tweets from v1.1", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователяКФайлу\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUserToFile\", \"Dropbox", +"Получает информацию о хранилище с которым может работать приложение для хранения своих данных": "Get information about storage with which the application can work to store its data", "Оформляет значение в формате атрибута и добавляет его в массив attributes переданной коллекции": "Formats the value in attribute format and adds it to the Attributes array of the collection", -"Выберите созданный проект и в боковом меню перейдите APIs and Services -> OAuth consent screen": "Select the created project and in the side menu go to APIs and Services -> OAuth consent screen", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСтатусЗагрузкиПоURL\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetUploadStatusByUrl\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОбОбъекте\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetObjectInfo\", \"Dropbox", +"Получает структуру для обновления характеристик товара в функции ОбновитьХарактеристикиТоваров": "Gets the structure for updating product characteristics in the UpdateProductsAttributes function", +"Выберите созданный проект и в боковом меню перейдите APIs and Services -> OAuth consent screen": "Select the created project and in the side menu go to APIs and Services -> OAuth consent screen", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокВерсийОбъекта\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetObjectVersionList\", \"Dropbox", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователейКПапке\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUsersToFolder\", \"Dropbox", +"Массив|Один получатель (UA все, SG раб. группа, U пользователь, DR отдел, G группа": "Array or a single post target (UA all, SG work group, U user, DR depart., G group", +"Набор инструментов для интеграции с популярными API посредством CLI, 1C:Enterprise и OneScript": "A toolkit for integrating with popular APIs via CLI, 1C:Enterprise and OneScript", +"Получает список первых файлов каталога или продолжает получение следующих при указании курсора": "Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ДобавитьПользователейКФайлу\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"AddUsersToFile\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОтправитьТекстовоеСообщение\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"SendTextMessage\", \"Telegram", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОбАккаунте (сторонний": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetAccountInfo (external", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьИнформациюОбАккаунте\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetAccountInfo\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСписокИконокАватаров\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetAvatarIconList\", \"Telegram", "Возвращает структуру полей для фильтрации комментариев в методе ПолучитьСписокКомментариевЗадачи": "Return filter structure for GetTaskCommentsList", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ИзменитьИмяГлавнойТемыФорума\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ChangeMainForumThemeName\", \"Telegram", -"BotFather предложит вам выбрать имя и никнейм бота, после чего процедура создания будет завершена": "BotFather will prompt you to choose a name and a username for the bot, after which the creation process will be completed", "который будет возвращать 200 и подлинный SSL сертификат. Если есть сертификат и база опубликована": "which will return 200 and a genuine SSL certificate. If there is a certificate and the database is published", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуСкачиванияПубличногоОбъекта": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetPublicObjectDownloadLink", +"BotFather предложит вам выбрать имя и никнейм бота, после чего процедура создания будет завершена": "BotFather will prompt you to choose a name and a username for the bot, after which the creation process will be completed", "что Twitter настаивает на использовании этой актуальной версии, они как-то умудрились не перенести": "that Twitter insists on using this latest version, they somehow managed not to transfer", "Получите ID этой страинцы. Это можно сделать нажав Share -> Copy link или просто скопировав из URL": "Get the ID of this page. You can do this by clicking Share -> Copy link or simply by copying it from the URL", "Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook": "Here you can get the channel's user IDs. Bot IDs need to be obtained from the Webhook arrivals", @@ -6375,8 +6375,8 @@ "Выполняет запрос, возвращающий информацию о событиях бота. Используется при работе в polling режиме": "Executes a request, returning information about bot events. Used in polling mode", "color=Зеленый) - выводит справку по текущей команде или методу. Аналогично вызову команды без опций": "color=Green) - displays help on the current command or method. Similar to calling a command without options", "Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего": "Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified", -"но только через нее в твит можно добавить картинку. При этом способы авторизации и токены у них разные": "but only through it you can add a picture to the tweet. At the same time, their authentication methods and tokens are different", "https:developer.twitter.com/en/portal/dashboard и выбор конкретного проекта из списка (значек c ключем": "https:developer.twitter.com/en/portal/dashboard and select a specific project from the list (icon with key", +"но только через нее в твит можно добавить картинку. При этом способы авторизации и токены у них разные": "but only through it you can add a picture to the tweet. At the same time, their authentication methods and tokens are different", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьСсылкуАвторизацииПриложения\", \"Bitrix24": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetAppAuthLink\", \"Bitrix24", "Получает список задач (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЗадач": "Get tasks list (50 at one response max)", "Получает список лидов (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЛидов": "Gets a list of leads (50 per request max) with or without filtering (see GetLeadFilterStructure", @@ -6386,9 +6386,9 @@ "Получает структуру для отбора списка товаров в функциях ПолучитьСписокТоваров и ПолучитьКоличествоТоваров": "Gets the structure for selecting the list of goods in the functions GetProductList and GetProductsStocks", "Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID": "If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID", "Получает список сделок (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраСделок": "Gets the list of deals (50 pcs per query max) with or without filtering (see. GetDealsFilterStructure", -"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьДанныеИспользованияПространства\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetSpaceUsageData\", \"Dropbox", -"Товар отклонён. Чтобы добавить его в «Маркет», укажите реальную цену товара или стоимость оказания услуги.": "Denied", "Параметр `v` означает версию VK API. Тестирование проводилось на 5.131, рекомендуется его таким и оставить": "The parameter `v` denotes the version of the VK API. Testing was conducted on version 5.131, and it is recommended to keep it as such", +"Товар отклонён. Чтобы добавить его в «Маркет», укажите реальную цену товара или стоимость оказания услуги.": "Denied", +"!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ПолучитьДанныеИспользованияПространства\", \"Dropbox": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"GetSpaceUsageData\", \"Dropbox", "!OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, \"ОчиститьСписокЗакрепленныхСообщенийТемы\", \"Telegram": "!OInt OPI_TestDataRetrieval.WriteLog(Result, \"ClearForumThemePinnedMessages\", \"Telegram", "В поле *Доступ к данным* добавьте разрешения как на скриншоте ниже, после чего нажмите *Создать приложение*": "In the **Data Access** field, add permissions as shown in the screenshot below, then click **Create Application**", "Выполняет запрос, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д": "Executes the request, returning basic bot information: name, id, ability to add the bot to groups, etc.", @@ -6397,9 +6397,9 @@ "Этот метод используется в случае, если прямой заказ доставлялся СДЭК и получатель хочет вернуть его полностью": "This method is used if the direct order was delivered by CDEK and the recipient wants to return it in full", "Доступные цвета: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND": "Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND", "и создайте новую страницу. Эта страница будет родительской для всех остальных объектов, создаваемых через API": "and create a new page. This page will serve as the parent for all other objects created through the API", -"Запуск портативной версии в RHEL/Fedora/CentOS (дистрибутивы, использующие rpm-пакеты) осуществляется командой": "To run the portable version in RHEL/Fedora/CentOS (distributions using rpm packages), use the command ", -"Выполняет запрос getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме": "Executes a request getUpdates, returning information about bot events. Used in polling mode", ", так как в самих файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.": " section, as the repository files may contain intermediate data and functions that are still in development.", +"Выполняет запрос getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме": "Executes a request getUpdates, returning information about bot events. Used in polling mode", +"Запуск портативной версии в RHEL/Fedora/CentOS (дистрибутивы, использующие rpm-пакеты) осуществляется командой": "To run the portable version in RHEL/Fedora/CentOS (distributions using rpm packages), use the command ", "Выполняет запрос /getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме": "Executes a request /getUpdates, returning information about bot events. Used in polling mode", "В теле запроса должен быть один идентификатор или массив однотипных идентификаторов, в ответе будет массив items": "The body of the request must contain a single identifier or an array of identical identifiers, the response will be an array of items", "Выполняет запрос getMe, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д": "Executes the getMe request, returning basic bot information: name, id, ability to add the bot to groups, etc.", @@ -6410,8 +6410,8 @@ "Ссылку на получение acess_token можно получить при помощи функции *СоздатьСсылкуПолученияТокена* или склеить вручную:": "You can obtain a link for acquiring the access token using the function *CreateTokenRetrievalLink* or manually concatenate it", "За один запрос можно изменить наличие для 100 товаров. С одного аккаунта продавца можно отправить до 80 запросов в минуту": "You can change availability for 100 products per request. You can send up to 80 requests per minute from one merchant account", "**Важно:** Имена библиотек чувствительны к регистру и пишутся строчными буквами. Имена методов к регистру не чувствительны": "**Important:** Library names are case-sensitive and should be written in lowercase. Method names are not case-sensitive", -"Найти своего нового бота вы можете отсканировав QR на странице создания или в настройках (пункт чат-боты) в приложении Viber": "To find your new bot, you can scan the QR code on the creation page or in the settings (chat bots section) within the Viber app", "Получите ссылку авторизации при помощи функции *ПолучитьСсылкуАвторизации(Знач КлючПриложения)* и передите по ней в браузере": "Get the authorization link using the *GetAuthorizationLink()* function and pass it in the browser", +"Найти своего нового бота вы можете отсканировав QR на странице создания или в настройках (пункт чат-боты) в приложении Viber": "To find your new bot, you can scan the QR code on the creation page or in the settings (chat bots section) within the Viber app", "Для загрузки передайте адрес ссылки на изображение в общедоступном облачном хранилище. Формат изображения по ссылке: JPG или PNG": "To upload, pass the link address of the image to public cloud storage. Image format of the linked image: JPG or PNG", "Для загрузки передайте адрес ссылки на изображение в общедоступном облачном хранилище. Формат изображения по ссылке — JPG или PNG": "To upload, pass the URL of the image to public cloud storage. The format of the image is JPG or PNG", "Если вы хотите, чтобы клиент отображал этот файл как воспроизводимое голосовое сообщение, он должен быть в формате aac, ogg или m4a": "If you want the client to display this file as a playable voice message, it must be in aac, ogg, or m4a format", @@ -6422,9 +6422,9 @@ "Добавить в модуль http-сервиса (GET) вызов функции *ОбработкаВходящегоЗапросаПослеАвторизации*, передавая HTTPСервисЗапрос как параметр": "Add to the HTTP service module (GET) a call to the *HandleIncomingRequestAfterAuthorization* function, passing the HTTP service request as a parameter", "Работать с Bitrix24 через API можно двумя способами: через **Webhook** и через **локальное приложение**. Для обоих вариантов необходимо": "There are two ways to work with Bitrix24 via API: via **Webhook** and via **local application**. For both options you need", "Все действия при работе с Telegram API осуществляются посредством ботов. Для создания нового бота необходимо в мессенджере начать диалог с": "All actions with the Telegram API are carried out through bots. To create a new bot, you need to start a conversation with", +"При установке из пакетов (Linux) или установщика (Windows, после перезагрузки), сделать это можно из любого места без дополнительных действий": "If app was installed from packages (Linux) or installer (Windows, after reboot), you can do this from any place without additional actions", "**OInt CLI** - приложение для командой строки, которое позволяет использовать методы Открытого пакета интеграций независимо от 1С и OneScript": "OInt CLI - a command-line application that allows you to use methods of the Open Integration Package independently of 1C and OneScript", "Используйте полученный код, ClientID и Client Secret для вызова функции OPI_GoogleWorkspace.ПолучитьТокенПоКоду(ClientID, ClientSecret, Code)": "Use the obtained code, ClientID, and Client Secret to call the function OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code)", -"При установке из пакетов (Linux) или установщика (Windows, после перезагрузки), сделать это можно из любого места без дополнительных действий": "If app was installed from packages (Linux) or installer (Windows, after reboot), you can do this from any place without additional actions", "Эти токены необходимо получить http запросом с указанием кода, который приходит при авторизации на http-сервис redirect_uri. Порядок действий:": "These tokens need to be obtained via an HTTP request with the code that comes during authorization on the HTTP service redirect_uri. The sequence of actions is as follows:", "это OSPX пакет, предназначенный для установки через пакетный менеджер OPM. Вы можете использовать его для оффлайн установки при помощи команды": "this is an OSPX package intended for installation via the OPM package manager. You can use it for offline installation using the command", "Сохранить access_token и refresh_token, полученный из функции *ОбработкаВходящегоЗапросаПослеАвторизации* п. 2, в константы или другое хранилище": "Save the access_token and refresh_token obtained from the *HandleIncomingRequestAfterAuthorization* function in step 2 into constants or another storage", @@ -6433,8 +6433,8 @@ "Уточняйте минимальную цену товара после применения всех акций в личном кабинете. Параметр min_price из ответа метода на доработке и возвращает 0": "Specify the minimum price of the product after all promotions have been applied in your personal cabinet. The min_price parameter from the method response is being reworked and returns 0", "Передайте полученный код, вместе с ключем и секретом приложения, в функцию **ПолучитьТокен**. Сохраните полученные **access** и **refresh токены**": "Pass the received code, along with the application key and secret, to the **GetToken** function. Save the received **access** and **refresh tokens**", "Вызовите функцию *OPI_YandexID.ПолучитьКодПодтверждения()*, передав ClientID в качестве параметра. Она вернет ответ сервера Yandex, где будут поля": "Call the function *OPI_YandexID.GetConfirmationCode()*, passing ClientID as a parameter. It will return a response from the Yandex server, which will contain the fields", -"Откройте URL из **verification_url** в барузере. Скорее всего это будет https://ya.ru/device. В появившееся поле введите **user_code** из пункта 5 ": "Open the URL from **verification_url** in the browser. Most likely, it will be https://ya.ru/device. In the field that appears, enter the **user_code** from step 5", "После запуска **IDПользователя** будет ID конкретного человека, ведущего диалог с ботом. Получить можно из обработыки входящих сообщения по Webhook": "After launch, the **User ID** will be the ID of the specific person engaging with the bot. You can obtain it from processing incoming messages via Webhook", +"Откройте URL из **verification_url** в барузере. Скорее всего это будет https://ya.ru/device. В появившееся поле введите **user_code** из пункта 5 ": "Open the URL from **verification_url** in the browser. Most likely, it will be https://ya.ru/device. In the field that appears, enter the **user_code** from step 5", "Для его работы требуется **.Net Framework 4.8** или сопоставимый **Mono Runtime** (при использовании deb и rpm пакетов устанавливается автоматически)": "It requires .Net Framework 4.8 or a compatible Mono Runtime (automatically installed when using deb and rpm packages)", "Характеристики представляют из себя структуры с полями complex_id, id и массивом values. Для их быстрого создания есть метод ДополнитьКомплексныйАтрибут": "Attributes are structures with complex_id, id and values fields. For their quick creation there is the CompleteComplexAttribute method", "В зависимости от выбранного способа примения будет отличаться способ получения **ID чата** - параметра, отвечающего за определение объекта взаимодействия": "Depending on the chosen path, the way to obtain the **ChatID** (the parameter responsible for identifying the interaction object) will differ",