From a01f7597a618c2f35b64e2fd2d3ab09c6743da01 Mon Sep 17 00:00:00 2001 From: Vitaly the Alpaca Date: Wed, 5 Jun 2024 10:19:46 +0000 Subject: [PATCH] =?UTF-8?q?=D0=A1=D0=BE=D0=B7=D0=B4=D0=B0=D0=BD=D0=B8?= =?UTF-8?q?=D0=B5=20MD=20=D1=84=D0=B0=D0=B9=D0=BB=D0=BE=D0=B2=20=D0=B4?= =?UTF-8?q?=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8?= =?UTF-8?q?=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/md/Airtable/Airtable.md | 48 +- .../Comment-management/Create-comment.md | 118 +- .../Comment-management/Delete-comment.md | 104 +- .../Comment-management/Edit-comment.md | 122 +- .../Comment-management/Get-comments.md | 126 +- .../Comment-management/_category_.json | 8 +- .../Airtable/Database-work/Create-database.md | 172 +- .../Database-work/Get-database-tables.md | 146 +- .../Database-work/Get-list-of-bases.md | 180 +-- .../md/Airtable/Database-work/_category_.json | 8 +- .../en/md/Airtable/Field-work/Create-field.md | 110 +- .../Field-work/Get-attachment-field.md | 90 +- .../Airtable/Field-work/Get-checkbox-field.md | 98 +- .../md/Airtable/Field-work/Get-date-field.md | 102 +- .../md/Airtable/Field-work/Get-email-field.md | 90 +- .../md/Airtable/Field-work/Get-link-field.md | 90 +- .../Airtable/Field-work/Get-number-field.md | 100 +- .../md/Airtable/Field-work/Get-phone-field.md | 90 +- .../Airtable/Field-work/Get-string-field.md | 90 +- .../en/md/Airtable/Field-work/Modify-field.md | 118 +- .../en/md/Airtable/Field-work/_category_.json | 8 +- .../Record-management/Create-posts.md | 148 +- .../Record-management/Delete-posts.md | 122 +- .../Record-management/Get-list-of-records.md | 146 +- .../Airtable/Record-management/Get-record.md | 108 +- .../Record-management/_category_.json | 8 +- .../Airtable/Table-management/Create-table.md | 256 +-- .../Airtable/Table-management/Modify-table.md | 238 +-- .../Airtable/Table-management/_category_.json | 8 +- docs/en/md/Airtable/_category_.json | 16 +- .../Get-account-information.md | 128 +- .../Get-authorization-link.md | 76 +- .../Get-space-usage-data.md | 90 +- .../Account-and-authorization/Get-token.md | 92 +- .../Refresh-token.md | 94 +- .../Account-and-authorization/_category_.json | 8 +- .../Copy-object.md | 114 +- .../Create-folder.md | 96 +- .../Delete-object.md | 112 +- .../Download-file.md | 82 +- .../Download-folder.md | 82 +- .../Get-list-of-folder-files.md | 86 +- .../Get-object-information.md | 108 +- .../Get-object-version-list.md | 116 +- .../Get-preview.md | 82 +- .../Get-upload-status-by-url.md | 124 +- .../Move-object.md | 86 +- .../Restore-object-to-version.md | 108 +- .../Upload-file-by-url.md | 92 +- .../Upload-file.md | 116 +- .../_category_.json | 8 +- .../Add-users-to-file.md | 88 +- .../Add-users-to-folder.md | 88 +- .../Cancel-file-publication.md | 82 +- .../Cancel-folder-publication.md | 102 +- .../Get-asynchronous-change-status.md | 74 +- .../Shared-access-settings/Publish-folder.md | 138 +- .../Shared-access-settings/_category_.json | 8 +- docs/en/md/Dropbox/Tag-work/Add-tag.md | 86 +- docs/en/md/Dropbox/Tag-work/Delete-tag.md | 86 +- docs/en/md/Dropbox/Tag-work/Get-tag-list.md | 106 +- docs/en/md/Dropbox/Tag-work/_category_.json | 8 +- .../Add-calendar-to-list.md | 118 +- .../Delete-calendar-from-list.md | 82 +- .../Edit-list-calendar.md | 130 +- .../Get-calendar-list.md | 350 ++-- .../Get-list-calendar.md | 116 +- .../Calendar-list-management/_category_.json | 8 +- .../Clear-main-calendar.md | 78 +- .../Create-calendar.md | 104 +- .../Delete-calendar.md | 82 +- .../Edit-calendar-metadata.md | 114 +- .../Get-calendar-metadata.md | 106 +- .../_category_.json | 8 +- .../Event-management/Create-event.md | 200 +-- .../Event-management/Delete-event.md | 84 +- .../Event-management/Edit-event.md | 182 +-- .../Event-management/Get-event-description.md | 84 +- .../Event-management/Get-event-list.md | 180 +-- .../Event-management/Get-event.md | 174 +- .../Event-management/Move-event.md | 176 +- .../Event-management/_category_.json | 8 +- docs/en/md/Google_Calendar/Google_Calendar.md | 196 +-- docs/en/md/Google_Calendar/_category_.json | 16 +- .../Comment-management/Create-comment.md | 120 +- .../Comment-management/Delete-comment.md | 86 +- .../Comment-management/Get-comment-list.md | 126 +- .../Comment-management/Get-comment.md | 120 +- .../Comment-management/_category_.json | 8 +- .../Copy-object.md | 104 +- .../Create-folder.md | 98 +- .../Delete-object.md | 84 +- .../Download-file.md | 88 +- .../Get-directories-list.md | 296 ++-- .../Get-file-description.md | 88 +- .../Get-files-list.md | 354 ++-- .../Get-object-information.md | 292 ++-- .../Update-file.md | 104 +- .../Upload-file.md | 110 +- .../_category_.json | 8 +- docs/en/md/Google_Drive/Google_Drive.md | 196 +-- docs/en/md/Google_Drive/_category_.json | 20 +- .../md/Google_Sheets/Book-work/Create-book.md | 416 ++--- .../Book-work/Edit-book-title.md | 100 +- .../en/md/Google_Sheets/Book-work/Get-book.md | 406 ++--- .../Google_Sheets/Book-work/_category_.json | 8 +- .../md/Google_Sheets/Data-work/Clear-cells.md | 116 +- .../Data-work/Get-cell-values.md | 164 +- .../Data-work/Set-cell-values.md | 242 +-- .../Google_Sheets/Data-work/_category_.json | 8 +- docs/en/md/Google_Sheets/Google_Sheets.md | 196 +-- .../md/Google_Sheets/Sheet-work/Add-sheet.md | 126 +- .../md/Google_Sheets/Sheet-work/Copy-sheet.md | 112 +- .../Google_Sheets/Sheet-work/Delete-sheet.md | 100 +- .../Google_Sheets/Sheet-work/_category_.json | 8 +- docs/en/md/Google_Sheets/_category_.json | 16 +- .../Notion/Blocks-managment/Create-block.md | 204 +-- .../Notion/Blocks-managment/Delete-block.md | 176 +- .../Notion/Blocks-managment/Return-block.md | 178 +- .../Blocks-managment/Return-child-blocks.md | 278 ++-- .../Notion/Blocks-managment/_category_.json | 8 +- .../Database-management/Create-database.md | 402 ++--- .../Edit-database-properties.md | 400 ++--- .../Database-management/Get-database.md | 382 ++--- .../Database-management/_category_.json | 8 +- docs/en/md/Notion/Notion.md | 76 +- .../Create-page-in-database.md | 408 ++--- .../md/Notion/Page-management/Create-page.md | 188 +-- .../Page-management/Edit-page-properties.md | 430 ++--- docs/en/md/Notion/Page-management/Get-page.md | 398 ++--- .../md/Notion/Page-management/_category_.json | 8 +- docs/en/md/Notion/Users/Get-user-data.md | 108 +- docs/en/md/Notion/Users/User-list.md | 148 +- docs/en/md/Notion/Users/_category_.json | 8 +- docs/en/md/Notion/_category_.json | 16 +- .../Block-formation/Generate-image-block.md | 96 +- .../md/Slack/Block-formation/_category_.json | 8 +- .../Channel-management/Archive-channel.md | 92 +- .../Channel-management/Create-channel.md | 174 +- .../Channel-management/Get-channel-history.md | 164 +- .../Channel-management/Get-channel-list.md | 182 +-- .../Get-channel-user-list.md | 104 +- .../Slack/Channel-management/Get-channel.md | 170 +- .../Invite-users-to-channel.md | 176 +- .../Slack/Channel-management/Join-channel.md | 172 +- .../Kick-user-from-channel.md | 94 +- .../Slack/Channel-management/Leave-channel.md | 90 +- .../Channel-management/Rename-channel.md | 178 +- .../Channel-management/Set-channel-goal.md | 172 +- .../Channel-management/Set-channel-topic.md | 172 +- .../Slack/Channel-management/_category_.json | 8 +- .../Add-external-file.md | 164 +- .../Delete-external-file.md | 90 +- .../Get-external-file-list.md | 100 +- .../Get-external-file.md | 160 +- .../Send-external-file.md | 198 +-- .../Deleted-files-management/_category_.json | 8 +- .../Slack/Dialog-management/Close-dialog.md | 94 +- .../md/Slack/Dialog-management/Open-dialog.md | 104 +- .../Slack/Dialog-management/_category_.json | 8 +- docs/en/md/Slack/File-work/Delete-file.md | 90 +- docs/en/md/Slack/File-work/Get-file-data.md | 168 +- docs/en/md/Slack/File-work/Get-files-list.md | 168 +- .../md/Slack/File-work/Make-file-private.md | 74 +- .../en/md/Slack/File-work/Make-file-public.md | 74 +- docs/en/md/Slack/File-work/Upload-file.md | 176 +- docs/en/md/Slack/File-work/_category_.json | 8 +- .../Get-bot-information.md | 100 +- .../Management-and-settings/Get-user-list.md | 392 ++--- .../Get-workspace-list.md | 100 +- .../Management-and-settings/_category_.json | 8 +- .../Message-management/Delete-message.md | 100 +- .../Slack/Message-management/Edit-message.md | 182 +-- .../Get-delayed-message-list.md | 100 +- .../Message-management/Get-message-link.md | 98 +- .../Get-message-reply-list.md | 188 +-- .../Send-ephemeral-message.md | 100 +- .../Slack/Message-management/Send-message.md | 180 +-- .../Slack/Message-management/_category_.json | 8 +- docs/en/md/Slack/Slack.md | 128 +- docs/en/md/Slack/_category_.json | 16 +- docs/en/md/Start/CLI_version.md | 84 +- docs/en/md/Start/Release-variants.md | 106 +- docs/en/md/Start/Start.md | 88 +- docs/en/md/Start/_category_.json | 16 +- docs/en/md/Telegram/Administration/Ban.md | 94 +- .../Administration/Create-invitation-link.md | 134 +- .../Administration/Get-participant-count.md | 88 +- .../md/Telegram/Administration/Pin-message.md | 92 +- docs/en/md/Telegram/Administration/Unban.md | 94 +- .../Telegram/Administration/Unpin-message.md | 92 +- .../Telegram/Administration/_category_.json | 8 +- .../Delete-webhook.md | 84 +- .../Download-file.md | 82 +- .../Get-bot-information.md | 100 +- .../Get-updates.md | 732 ++++----- .../Set-webhook.md | 90 +- .../_category_.json | 8 +- .../Form-keyboard-from-button-array.md | 136 +- .../Telegram/Data-sending/Forward-message.md | 168 +- .../en/md/Telegram/Data-sending/Send-audio.md | 170 +- .../md/Telegram/Data-sending/Send-contact.md | 148 +- .../md/Telegram/Data-sending/Send-document.md | 164 +- docs/en/md/Telegram/Data-sending/Send-gif.md | 240 +-- .../en/md/Telegram/Data-sending/Send-image.md | 224 +-- .../md/Telegram/Data-sending/Send-location.md | 142 +- .../Telegram/Data-sending/Send-media-group.md | 306 ++-- docs/en/md/Telegram/Data-sending/Send-poll.md | 198 +-- .../Data-sending/Send-text-message.md | 134 +- .../en/md/Telegram/Data-sending/Send-video.md | 198 +-- .../md/Telegram/Data-sending/_category_.json | 8 +- .../Clear-thread-pinned-messages-list.md | 94 +- .../Close-forum-thread.md | 94 +- .../Create-forum-thread.md | 106 +- .../Delete-forum-topic.md | 92 +- .../Edit-forum-topic.md | 100 +- .../Edit-main-forum-topic-name.md | 90 +- .../Get-avatar-icon-list.md | 306 ++-- .../Hide-main-forum-topic.md | 88 +- .../Open-forum-thread.md | 94 +- .../Show-main-forum-topic.md | 88 +- .../Forum-topic-management/_category_.json | 8 +- docs/en/md/Telegram/Telegram.md | 82 +- docs/en/md/Telegram/_category_.json | 16 +- .../Get-authorization-link.md | 78 +- .../md/Twitter/Data-and-settings/Get-token.md | 94 +- .../Data-and-settings/Refresh-token.md | 98 +- .../Twitter/Data-and-settings/_category_.json | 8 +- docs/en/md/Twitter/Tweets/Create-gif-tweet.md | 108 +- .../md/Twitter/Tweets/Create-image-tweet.md | 108 +- .../en/md/Twitter/Tweets/Create-poll-tweet.md | 112 +- .../en/md/Twitter/Tweets/Create-text-tweet.md | 98 +- .../md/Twitter/Tweets/Create-video-tweet.md | 108 +- docs/en/md/Twitter/Tweets/_category_.json | 8 +- docs/en/md/Twitter/Twitter.md | 250 +-- docs/en/md/Twitter/_category_.json | 16 +- .../md/VK/Ad-account-management/Create-ad.md | 102 +- .../Create-advertising-campaign.md | 96 +- .../Get-advertising-category-list.md | 142 +- .../Pause-advertising-ad.md | 96 +- .../VK/Ad-account-management/_category_.json | 8 +- .../Discussion-management/Close-discussion.md | 86 +- .../Create-discussion.md | 90 +- .../Discussion-management/Open-discussion.md | 84 +- .../Write-in-discussion.md | 90 +- .../VK/Discussion-management/_category_.json | 8 +- docs/en/md/VK/Group-work/Create-album.md | 118 +- .../md/VK/Group-work/Create-composite-post.md | 136 +- docs/en/md/VK/Group-work/Create-poll.md | 104 +- docs/en/md/VK/Group-work/Create-post.md | 120 +- docs/en/md/VK/Group-work/Create-story.md | 280 ++-- docs/en/md/VK/Group-work/Delete-album.md | 86 +- docs/en/md/VK/Group-work/Delete-image.md | 86 +- docs/en/md/VK/Group-work/Delete-post.md | 86 +- .../md/VK/Group-work/Save-image-to-album.md | 252 +-- .../VK/Group-work/Upload-photo-to-server.md | 76 +- .../VK/Group-work/Upload-video-to-server.md | 80 +- docs/en/md/VK/Group-work/_category_.json | 8 +- .../en/md/VK/Interactive-actions/Like-post.md | 92 +- .../md/VK/Interactive-actions/Make-repost.md | 116 +- .../md/VK/Interactive-actions/Shorten-link.md | 80 +- .../VK/Interactive-actions/Write-comment.md | 96 +- .../VK/Interactive-actions/Write-message.md | 96 +- .../md/VK/Interactive-actions/_category_.json | 8 +- .../md/VK/Order-management/Get-order-list.md | 72 +- .../en/md/VK/Order-management/_category_.json | 8 +- docs/en/md/VK/Others/Form-keyboard.md | 130 +- docs/en/md/VK/Others/_category_.json | 8 +- .../md/VK/Product-management/Add-product.md | 134 +- .../VK/Product-management/Delete-product.md | 86 +- .../md/VK/Product-management/Edit-product.md | 96 +- .../Get-product-category-list.md | 88 +- .../Get-product-description.md | 104 +- .../VK/Product-management/Get-product-list.md | 696 ++++---- .../Product-management/Get-products-by-id.md | 1426 ++++++++--------- .../VK/Product-management/Group-products.md | 100 +- .../md/VK/Product-management/_category_.json | 8 +- .../Add-product-property-variant.md | 92 +- .../Create-product-property.md | 90 +- .../Delete-product-property-variant.md | 86 +- .../Delete-product-property.md | 86 +- .../Edit-product-property-variant.md | 90 +- .../Edit-product-property.md | 88 +- .../Get-property-list.md | 120 +- .../_category_.json | 8 +- .../Add-product-to-selection.md | 88 +- .../Create-product-collection.md | 108 +- .../Delete-selection.md | 86 +- .../Edit-product-collection.md | 106 +- .../Get-selection-list.md | 232 +-- .../Get-selections-by-id.md | 234 +-- .../Remove-product-from-selection.md | 88 +- .../_category_.json | 8 +- .../md/VK/Statistics/Get-post-statistics.md | 180 +-- docs/en/md/VK/Statistics/Get-statistics.md | 1098 ++++++------- docs/en/md/VK/Statistics/_category_.json | 8 +- .../Create-token-retrieval-link.md | 76 +- docs/en/md/VK/Token-retrieval/_category_.json | 8 +- docs/en/md/VK/VK.md | 188 +-- docs/en/md/VK/_category_.json | 16 +- .../Create-keyboard-from-array-button.md | 144 +- .../md/Viber/Message-sending/Send-contact.md | 106 +- docs/en/md/Viber/Message-sending/Send-file.md | 106 +- .../en/md/Viber/Message-sending/Send-image.md | 104 +- docs/en/md/Viber/Message-sending/Send-link.md | 104 +- .../md/Viber/Message-sending/Send-location.md | 106 +- .../Message-sending/Send-text-message.md | 120 +- .../md/Viber/Message-sending/_category_.json | 8 +- .../Get-channel-information.md | 126 +- .../Get-online-users.md | 104 +- .../Settings-and-information/Get-user-data.md | 116 +- .../Settings-and-information/Set-webhook.md | 114 +- .../Settings-and-information/_category_.json | 8 +- docs/en/md/Viber/Viber.md | 138 +- docs/en/md/Viber/_category_.json | 16 +- .../Create-folder.md | 128 +- .../Create-object-copy.md | 236 +-- .../Delete-object.md | 88 +- .../Download-file.md | 76 +- .../Get-disk-information.md | 152 +- .../Get-download-link.md | 94 +- .../Get-files-list.md | 396 ++--- .../File-and-folder-management/Get-object.md | 228 +-- .../File-and-folder-management/Move-object.md | 236 +-- .../Upload-file-by-url.md | 100 +- .../File-and-folder-management/Upload-file.md | 94 +- .../_category_.json | 8 +- .../Cancel-object-publication.md | 228 +-- .../Get-download-link-for-public-object.md | 98 +- .../Manage-public-access/Get-public-object.md | 250 +-- .../Get-published-objects-list.md | 386 ++--- .../Manage-public-access/Publish-object.md | 232 +-- .../Save-public-object-to-disk.md | 234 +-- .../Manage-public-access/_category_.json | 8 +- docs/en/md/Yandex_Disk/Yandex_Disk.md | 124 +- docs/en/md/Yandex_Disk/_category_.json | 16 +- .../Comment-management/Create-comment.md | 118 +- .../Comment-management/Delete-comment.md | 104 +- .../Comment-management/Edit-comment.md | 122 +- .../Comment-management/Get-comments.md | 126 +- .../Airtable/Database-work/Create-database.md | 172 +- .../Database-work/Get-database-tables.md | 146 +- .../Database-work/Get-list-of-bases.md | 180 +-- .../ru/md/Airtable/Field-work/Create-field.md | 110 +- .../Field-work/Get-attachment-field.md | 90 +- .../Airtable/Field-work/Get-checkbox-field.md | 98 +- .../md/Airtable/Field-work/Get-date-field.md | 102 +- .../md/Airtable/Field-work/Get-email-field.md | 90 +- .../md/Airtable/Field-work/Get-link-field.md | 90 +- .../Airtable/Field-work/Get-number-field.md | 100 +- .../md/Airtable/Field-work/Get-phone-field.md | 90 +- .../Airtable/Field-work/Get-string-field.md | 90 +- .../ru/md/Airtable/Field-work/Modify-field.md | 118 +- .../Record-management/Create-posts.md | 148 +- .../Record-management/Delete-posts.md | 122 +- .../Record-management/Get-list-of-records.md | 146 +- .../Airtable/Record-management/Get-record.md | 108 +- .../Airtable/Table-management/Create-table.md | 256 +-- .../Airtable/Table-management/Modify-table.md | 238 +-- .../Get-account-information.md | 128 +- .../Get-authorization-link.md | 76 +- .../Get-space-usage-data.md | 90 +- .../Account-and-authorization/Get-token.md | 92 +- .../Refresh-token.md | 94 +- .../Copy-object.md | 114 +- .../Create-folder.md | 96 +- .../Delete-object.md | 112 +- .../Download-file.md | 82 +- .../Download-folder.md | 82 +- .../Get-list-of-folder-files.md | 86 +- .../Get-object-information.md | 108 +- .../Get-object-version-list.md | 116 +- .../Get-preview.md | 82 +- .../Get-upload-status-by-url.md | 124 +- .../Move-object.md | 86 +- .../Restore-object-to-version.md | 108 +- .../Upload-file-by-url.md | 92 +- .../Upload-file.md | 116 +- .../Add-users-to-file.md | 88 +- .../Add-users-to-folder.md | 88 +- .../Cancel-file-publication.md | 82 +- .../Cancel-folder-publication.md | 102 +- .../Get-asynchronous-change-status.md | 74 +- .../Shared-access-settings/Publish-folder.md | 138 +- docs/ru/md/Dropbox/Tag-work/Add-tag.md | 86 +- docs/ru/md/Dropbox/Tag-work/Delete-tag.md | 86 +- docs/ru/md/Dropbox/Tag-work/Get-tag-list.md | 106 +- .../Add-calendar-to-list.md | 118 +- .../Delete-calendar-from-list.md | 82 +- .../Edit-list-calendar.md | 130 +- .../Get-calendar-list.md | 350 ++-- .../Get-list-calendar.md | 116 +- .../Clear-main-calendar.md | 78 +- .../Create-calendar.md | 104 +- .../Delete-calendar.md | 82 +- .../Edit-calendar-metadata.md | 114 +- .../Get-calendar-metadata.md | 106 +- .../Event-management/Create-event.md | 200 +-- .../Event-management/Delete-event.md | 84 +- .../Event-management/Edit-event.md | 182 +-- .../Event-management/Get-event-description.md | 84 +- .../Event-management/Get-event-list.md | 180 +-- .../Event-management/Get-event.md | 174 +- .../Event-management/Move-event.md | 176 +- .../Comment-management/Create-comment.md | 120 +- .../Comment-management/Delete-comment.md | 86 +- .../Comment-management/Get-comment-list.md | 126 +- .../Comment-management/Get-comment.md | 120 +- .../Copy-object.md | 104 +- .../Create-folder.md | 98 +- .../Delete-object.md | 84 +- .../Download-file.md | 88 +- .../Get-directories-list.md | 296 ++-- .../Get-file-description.md | 88 +- .../Get-files-list.md | 354 ++-- .../Get-object-information.md | 292 ++-- .../Update-file.md | 104 +- .../Upload-file.md | 110 +- .../md/Google_Sheets/Book-work/Create-book.md | 416 ++--- .../Book-work/Edit-book-title.md | 100 +- .../ru/md/Google_Sheets/Book-work/Get-book.md | 406 ++--- .../md/Google_Sheets/Data-work/Clear-cells.md | 116 +- .../Data-work/Get-cell-values.md | 164 +- .../Data-work/Set-cell-values.md | 242 +-- .../md/Google_Sheets/Sheet-work/Add-sheet.md | 126 +- .../md/Google_Sheets/Sheet-work/Copy-sheet.md | 112 +- .../Google_Sheets/Sheet-work/Delete-sheet.md | 100 +- .../Notion/Blocks-managment/Create-block.md | 204 +-- .../Notion/Blocks-managment/Delete-block.md | 176 +- .../Notion/Blocks-managment/Return-block.md | 178 +- .../Blocks-managment/Return-child-blocks.md | 278 ++-- .../Database-management/Create-database.md | 402 ++--- .../Edit-database-properties.md | 400 ++--- .../Database-management/Get-database.md | 382 ++--- .../Create-page-in-database.md | 408 ++--- .../md/Notion/Page-management/Create-page.md | 188 +-- .../Page-management/Edit-page-properties.md | 430 ++--- docs/ru/md/Notion/Page-management/Get-page.md | 398 ++--- docs/ru/md/Notion/Users/Get-user-data.md | 108 +- docs/ru/md/Notion/Users/User-list.md | 148 +- .../Block-formation/Generate-image-block.md | 96 +- .../Channel-management/Archive-channel.md | 92 +- .../Channel-management/Create-channel.md | 174 +- .../Channel-management/Get-channel-history.md | 164 +- .../Channel-management/Get-channel-list.md | 182 +-- .../Get-channel-user-list.md | 104 +- .../Slack/Channel-management/Get-channel.md | 170 +- .../Invite-users-to-channel.md | 176 +- .../Slack/Channel-management/Join-channel.md | 172 +- .../Kick-user-from-channel.md | 94 +- .../Slack/Channel-management/Leave-channel.md | 90 +- .../Channel-management/Rename-channel.md | 178 +- .../Channel-management/Set-channel-goal.md | 172 +- .../Channel-management/Set-channel-topic.md | 172 +- .../Add-external-file.md | 164 +- .../Delete-external-file.md | 90 +- .../Get-external-file-list.md | 100 +- .../Get-external-file.md | 160 +- .../Send-external-file.md | 198 +-- .../Slack/Dialog-management/Close-dialog.md | 94 +- .../md/Slack/Dialog-management/Open-dialog.md | 104 +- docs/ru/md/Slack/File-work/Delete-file.md | 90 +- docs/ru/md/Slack/File-work/Get-file-data.md | 168 +- docs/ru/md/Slack/File-work/Get-files-list.md | 168 +- .../md/Slack/File-work/Make-file-private.md | 74 +- .../ru/md/Slack/File-work/Make-file-public.md | 74 +- docs/ru/md/Slack/File-work/Upload-file.md | 176 +- .../Get-bot-information.md | 100 +- .../Management-and-settings/Get-user-list.md | 392 ++--- .../Get-workspace-list.md | 100 +- .../Message-management/Delete-message.md | 100 +- .../Slack/Message-management/Edit-message.md | 182 +-- .../Get-delayed-message-list.md | 100 +- .../Message-management/Get-message-link.md | 98 +- .../Get-message-reply-list.md | 188 +-- .../Send-ephemeral-message.md | 100 +- .../Slack/Message-management/Send-message.md | 180 +-- docs/ru/md/Telegram/Administration/Ban.md | 94 +- .../Administration/Create-invitation-link.md | 134 +- .../Administration/Get-participant-count.md | 88 +- .../md/Telegram/Administration/Pin-message.md | 92 +- docs/ru/md/Telegram/Administration/Unban.md | 94 +- .../Telegram/Administration/Unpin-message.md | 92 +- .../Delete-webhook.md | 84 +- .../Download-file.md | 82 +- .../Get-bot-information.md | 100 +- .../Get-updates.md | 732 ++++----- .../Set-webhook.md | 90 +- .../Form-keyboard-from-button-array.md | 136 +- .../Telegram/Data-sending/Forward-message.md | 168 +- .../ru/md/Telegram/Data-sending/Send-audio.md | 170 +- .../md/Telegram/Data-sending/Send-contact.md | 148 +- .../md/Telegram/Data-sending/Send-document.md | 164 +- docs/ru/md/Telegram/Data-sending/Send-gif.md | 240 +-- .../ru/md/Telegram/Data-sending/Send-image.md | 224 +-- .../md/Telegram/Data-sending/Send-location.md | 142 +- .../Telegram/Data-sending/Send-media-group.md | 306 ++-- docs/ru/md/Telegram/Data-sending/Send-poll.md | 198 +-- .../Data-sending/Send-text-message.md | 134 +- .../ru/md/Telegram/Data-sending/Send-video.md | 198 +-- .../Clear-thread-pinned-messages-list.md | 94 +- .../Close-forum-thread.md | 94 +- .../Create-forum-thread.md | 106 +- .../Delete-forum-topic.md | 92 +- .../Edit-forum-topic.md | 100 +- .../Edit-main-forum-topic-name.md | 90 +- .../Get-avatar-icon-list.md | 306 ++-- .../Hide-main-forum-topic.md | 88 +- .../Open-forum-thread.md | 94 +- .../Show-main-forum-topic.md | 88 +- .../Get-authorization-link.md | 78 +- .../md/Twitter/Data-and-settings/Get-token.md | 94 +- .../Data-and-settings/Refresh-token.md | 98 +- docs/ru/md/Twitter/Tweets/Create-gif-tweet.md | 108 +- .../md/Twitter/Tweets/Create-image-tweet.md | 108 +- .../ru/md/Twitter/Tweets/Create-poll-tweet.md | 112 +- .../ru/md/Twitter/Tweets/Create-text-tweet.md | 98 +- .../md/Twitter/Tweets/Create-video-tweet.md | 108 +- .../md/VK/Ad-account-management/Create-ad.md | 102 +- .../Create-advertising-campaign.md | 96 +- .../Get-advertising-category-list.md | 142 +- .../Pause-advertising-ad.md | 96 +- .../Discussion-management/Close-discussion.md | 86 +- .../Create-discussion.md | 90 +- .../Discussion-management/Open-discussion.md | 84 +- .../Write-in-discussion.md | 90 +- docs/ru/md/VK/Group-work/Create-album.md | 118 +- .../md/VK/Group-work/Create-composite-post.md | 136 +- docs/ru/md/VK/Group-work/Create-poll.md | 104 +- docs/ru/md/VK/Group-work/Create-post.md | 120 +- docs/ru/md/VK/Group-work/Create-story.md | 280 ++-- docs/ru/md/VK/Group-work/Delete-album.md | 86 +- docs/ru/md/VK/Group-work/Delete-image.md | 86 +- docs/ru/md/VK/Group-work/Delete-post.md | 86 +- .../md/VK/Group-work/Save-image-to-album.md | 252 +-- .../VK/Group-work/Upload-photo-to-server.md | 76 +- .../VK/Group-work/Upload-video-to-server.md | 80 +- .../ru/md/VK/Interactive-actions/Like-post.md | 92 +- .../md/VK/Interactive-actions/Make-repost.md | 116 +- .../md/VK/Interactive-actions/Shorten-link.md | 80 +- .../VK/Interactive-actions/Write-comment.md | 96 +- .../VK/Interactive-actions/Write-message.md | 96 +- .../md/VK/Order-management/Get-order-list.md | 72 +- docs/ru/md/VK/Others/Form-keyboard.md | 130 +- .../md/VK/Product-management/Add-product.md | 134 +- .../VK/Product-management/Delete-product.md | 86 +- .../md/VK/Product-management/Edit-product.md | 96 +- .../Get-product-category-list.md | 88 +- .../Get-product-description.md | 104 +- .../VK/Product-management/Get-product-list.md | 696 ++++---- .../Product-management/Get-products-by-id.md | 1426 ++++++++--------- .../VK/Product-management/Group-products.md | 100 +- .../Add-product-property-variant.md | 92 +- .../Create-product-property.md | 90 +- .../Delete-product-property-variant.md | 86 +- .../Delete-product-property.md | 86 +- .../Edit-product-property-variant.md | 90 +- .../Edit-product-property.md | 88 +- .../Get-property-list.md | 120 +- .../Add-product-to-selection.md | 88 +- .../Create-product-collection.md | 108 +- .../Delete-selection.md | 86 +- .../Edit-product-collection.md | 106 +- .../Get-selection-list.md | 232 +-- .../Get-selections-by-id.md | 234 +-- .../Remove-product-from-selection.md | 88 +- .../md/VK/Statistics/Get-post-statistics.md | 180 +-- docs/ru/md/VK/Statistics/Get-statistics.md | 1098 ++++++------- .../Create-token-retrieval-link.md | 76 +- .../Create-keyboard-from-array-button.md | 144 +- .../md/Viber/Message-sending/Send-contact.md | 106 +- docs/ru/md/Viber/Message-sending/Send-file.md | 106 +- .../ru/md/Viber/Message-sending/Send-image.md | 104 +- docs/ru/md/Viber/Message-sending/Send-link.md | 104 +- .../md/Viber/Message-sending/Send-location.md | 106 +- .../Message-sending/Send-text-message.md | 120 +- .../Get-channel-information.md | 126 +- .../Get-online-users.md | 104 +- .../Settings-and-information/Get-user-data.md | 116 +- .../Settings-and-information/Set-webhook.md | 114 +- .../Create-folder.md | 128 +- .../Create-object-copy.md | 236 +-- .../Delete-object.md | 88 +- .../Download-file.md | 76 +- .../Get-disk-information.md | 152 +- .../Get-download-link.md | 94 +- .../Get-files-list.md | 396 ++--- .../File-and-folder-management/Get-object.md | 228 +-- .../File-and-folder-management/Move-object.md | 236 +-- .../Upload-file-by-url.md | 100 +- .../File-and-folder-management/Upload-file.md | 94 +- .../Cancel-object-publication.md | 228 +-- .../Get-download-link-for-public-object.md | 98 +- .../Manage-public-access/Get-public-object.md | 250 +-- .../Get-published-objects-list.md | 386 ++--- .../Manage-public-access/Publish-object.md | 232 +-- .../Save-public-object-to-disk.md | 234 +-- 597 files changed, 41032 insertions(+), 41032 deletions(-) diff --git a/docs/en/md/Airtable/Airtable.md b/docs/en/md/Airtable/Airtable.md index 385877009c..7407322ada 100644 --- a/docs/en/md/Airtable/Airtable.md +++ b/docs/en/md/Airtable/Airtable.md @@ -1,24 +1,24 @@ ---- -id: Airtable -sidebar_class_name: Airtable ---- - - - -# Airtable - -Этот раздел поwithinящен библиотеtoе for work with Airtable API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -1. Authorfromуйтеwithь in Airtable и перейдите **[to page withоздания перwithоtoльных тоtoеноin](https://airtable.com/create/tokens)**, toжмите **Create new token** - -![BF](../../static/img/Docs/Airtable/1.png) - -2. Ininедите name for ноinого тоtoеto, inыберите from перечня необходимые **Scopes** (разрешения) и **Acess** (базы и рабочие проwithтранwithтinа, to toоторым у тоtoеto will доwithтуп) - -![BF](../../static/img/Docs/Airtable/2.png) - -3. Сtoопируйте ноinый **тоtoен** - -![BF](../../static/img/Docs/Airtable/3.png) +--- +id: Airtable +sidebar_class_name: Airtable +--- + + + +# Airtable + +Этот раздел поwithinящен библиотеtoе for work with Airtable API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +1. Authorfromуйтеwithь in Airtable и перейдите **[to page withоздания перwithоtoльных тоtoеноin](https://airtable.com/create/tokens)**, toжмите **Create new token** + +![BF](../../static/img/Docs/Airtable/1.png) + +2. Ininедите name for ноinого тоtoеto, inыберите from перечня необходимые **Scopes** (разрешения) и **Acess** (базы и рабочие проwithтранwithтinа, to toоторым у тоtoеto will доwithтуп) + +![BF](../../static/img/Docs/Airtable/2.png) + +3. Сtoопируйте ноinый **тоtoен** + +![BF](../../static/img/Docs/Airtable/3.png) diff --git a/docs/en/md/Airtable/Comment-management/Create-comment.md b/docs/en/md/Airtable/Comment-management/Create-comment.md index fd7e598518..b6812bf574 100644 --- a/docs/en/md/Airtable/Comment-management/Create-comment.md +++ b/docs/en/md/Airtable/Comment-management/Create-comment.md @@ -1,59 +1,59 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Record = "recV6DxeLQMBNJrUk"; - Text = "TestComment"; - - Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable CreateComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "TestComment" - - -``` - - -```json title="Result" - -{ - "id": "comL1oGEDJvIQlMs1", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Anton Titovets" - }, - "text": "TestComment", - "createdTime": "2024-05-10T19:39:51.561Z", - "lastUpdatedTime": null - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Record = "recV6DxeLQMBNJrUk"; + Text = "TestComment"; + + Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable CreateComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "TestComment" + + +``` + + +```json title="Result" + +{ + "id": "comL1oGEDJvIQlMs1", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Anton Titovets" + }, + "text": "TestComment", + "createdTime": "2024-05-10T19:39:51.561Z", + "lastUpdatedTime": null + } + +``` diff --git a/docs/en/md/Airtable/Comment-management/Delete-comment.md b/docs/en/md/Airtable/Comment-management/Delete-comment.md index 3c55707c75..c8d36a9167 100644 --- a/docs/en/md/Airtable/Comment-management/Delete-comment.md +++ b/docs/en/md/Airtable/Comment-management/Delete-comment.md @@ -1,52 +1,52 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Record = "recV6DxeLQMBNJrUk"; - Comment = "comL1oGEDJvIQlMs1"; - - Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable DeleteComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% - - -``` - - -```json title="Result" - -{ - "id": "comL1oGEDJvIQlMs1", - "deleted": true - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Record = "recV6DxeLQMBNJrUk"; + Comment = "comL1oGEDJvIQlMs1"; + + Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable DeleteComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% + + +``` + + +```json title="Result" + +{ + "id": "comL1oGEDJvIQlMs1", + "deleted": true + } + +``` diff --git a/docs/en/md/Airtable/Comment-management/Edit-comment.md b/docs/en/md/Airtable/Comment-management/Edit-comment.md index b3bd3b696e..5f6a464830 100644 --- a/docs/en/md/Airtable/Comment-management/Edit-comment.md +++ b/docs/en/md/Airtable/Comment-management/Edit-comment.md @@ -1,61 +1,61 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Record = "recV6DxeLQMBNJrUk"; - Comment = "comL1oGEDJvIQlMs1"; - Text = "Test comment (change.)"; - - Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable EditComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Test comment (change.)" - - -``` - - -```json title="Result" - -{ - "id": "comL1oGEDJvIQlMs1", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Anton Titovets" - }, - "text": "Test comment (change.)", - "createdTime": "2024-05-10T19:39:52Z", - "lastUpdatedTime": "2024-05-10T19:39:51.967Z" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Record = "recV6DxeLQMBNJrUk"; + Comment = "comL1oGEDJvIQlMs1"; + Text = "Test comment (change.)"; + + Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable EditComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Test comment (change.)" + + +``` + + +```json title="Result" + +{ + "id": "comL1oGEDJvIQlMs1", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Anton Titovets" + }, + "text": "Test comment (change.)", + "createdTime": "2024-05-10T19:39:52Z", + "lastUpdatedTime": "2024-05-10T19:39:51.967Z" + } + +``` diff --git a/docs/en/md/Airtable/Comment-management/Get-comments.md b/docs/en/md/Airtable/Comment-management/Get-comments.md index d6cf33569b..6634f32787 100644 --- a/docs/en/md/Airtable/Comment-management/Get-comments.md +++ b/docs/en/md/Airtable/Comment-management/Get-comments.md @@ -1,63 +1,63 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Record = "recV6DxeLQMBNJrUk"; - - Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetComments --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset% - - -``` - - -```json title="Result" - -{ - "comments": [ - { - "id": "comL1oGEDJvIQlMs1", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Anton Titovets" - }, - "text": "Test comment (change.)", - "createdTime": "2024-05-10T19:39:52Z", - "lastUpdatedTime": "2024-05-10T19:39:52Z" - } - ], - "offset": null - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Record = "recV6DxeLQMBNJrUk"; + + Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetComments --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset% + + +``` + + +```json title="Result" + +{ + "comments": [ + { + "id": "comL1oGEDJvIQlMs1", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Anton Titovets" + }, + "text": "Test comment (change.)", + "createdTime": "2024-05-10T19:39:52Z", + "lastUpdatedTime": "2024-05-10T19:39:52Z" + } + ], + "offset": null + } + +``` diff --git a/docs/en/md/Airtable/Comment-management/_category_.json b/docs/en/md/Airtable/Comment-management/_category_.json index 66a5e34002..a984af551f 100644 --- a/docs/en/md/Airtable/Comment-management/_category_.json +++ b/docs/en/md/Airtable/Comment-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Comment management", -"position": "6" -} +{ +"label": "Comment management", +"position": "6" +} diff --git a/docs/en/md/Airtable/Database-work/Create-database.md b/docs/en/md/Airtable/Database-work/Create-database.md index 20cd96b70f..907ce308b2 100644 --- a/docs/en/md/Airtable/Database-work/Create-database.md +++ b/docs/en/md/Airtable/Database-work/Create-database.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 3 ---- - -# Create base - Creates a new database - - -*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Workspace | --ws | String | Workspace identifier | - | Name | --title | String | New base name | - | TableCollection | --tablesdata | Key-Value Pair | Table description: Key > name, Value > array of fields | - - - Returns: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Workspace = "wspdf8yl1yZz3PmWZ"; - Name = "TestDatabase"; - - FieldArray = New Array; - FieldArray.Add(OPI_Airtable.GetNumberField("Number")); - FieldArray.Add(OPI_Airtable.GetStringField("String")); - - TableName = "TestTable"; - - TableCollection = New Map; - TableCollection.Insert(TableName, FieldArray); - - Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata% - - -``` - - -```json title="Result" - -{ - "id": "applEsyJmBRm12AuN", - "tables": [ - { - "id": "tblqZzW78Rvsdt9gt", - "name": "TestTable", - "primaryFieldId": "fldj9Z3fEpLzv40d0", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldj9Z3fEpLzv40d0", - "name": "Number" - }, - { - "type": "richText", - "id": "fldX1kR7lienmcdEj", - "name": "String" - } - ], - "views": [ - { - "id": "viwbKE3PS9jl6bqJl", - "name": "Grid view", - "type": "grid" - } - ] - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Create base + Creates a new database + + +*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Workspace | --ws | String | Workspace identifier | + | Name | --title | String | New base name | + | TableCollection | --tablesdata | Key-Value Pair | Table description: Key > name, Value > array of fields | + + + Returns: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Workspace = "wspdf8yl1yZz3PmWZ"; + Name = "TestDatabase"; + + FieldArray = New Array; + FieldArray.Add(OPI_Airtable.GetNumberField("Number")); + FieldArray.Add(OPI_Airtable.GetStringField("String")); + + TableName = "TestTable"; + + TableCollection = New Map; + TableCollection.Insert(TableName, FieldArray); + + Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata% + + +``` + + +```json title="Result" + +{ + "id": "applEsyJmBRm12AuN", + "tables": [ + { + "id": "tblqZzW78Rvsdt9gt", + "name": "TestTable", + "primaryFieldId": "fldj9Z3fEpLzv40d0", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldj9Z3fEpLzv40d0", + "name": "Number" + }, + { + "type": "richText", + "id": "fldX1kR7lienmcdEj", + "name": "String" + } + ], + "views": [ + { + "id": "viwbKE3PS9jl6bqJl", + "name": "Grid view", + "type": "grid" + } + ] + } + ] + } + +``` diff --git a/docs/en/md/Airtable/Database-work/Get-database-tables.md b/docs/en/md/Airtable/Database-work/Get-database-tables.md index 8d06a31941..127e11eae5 100644 --- a/docs/en/md/Airtable/Database-work/Get-database-tables.md +++ b/docs/en/md/Airtable/Database-work/Get-database-tables.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 2 ---- - -# Get base tables - Gets the schema of base tables - - -*Function GetDatabaseTables(Val Token, Val Base) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier | - - - Returns: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - - Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ" - - -``` - - -```json title="Result" - -{ - "tables": [ - { - "id": "tblqZzW78Rvsdt9gt", - "name": "TestTable", - "primaryFieldId": "fldj9Z3fEpLzv40d0", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldj9Z3fEpLzv40d0", - "name": "Number" - }, - { - "type": "richText", - "id": "fldX1kR7lienmcdEj", - "name": "String" - } - ], - "views": [ - { - "id": "viwbKE3PS9jl6bqJl", - "name": "Grid view", - "type": "grid" - } - ] - } - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Get base tables + Gets the schema of base tables + + +*Function GetDatabaseTables(Val Token, Val Base) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier | + + + Returns: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + + Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ" + + +``` + + +```json title="Result" + +{ + "tables": [ + { + "id": "tblqZzW78Rvsdt9gt", + "name": "TestTable", + "primaryFieldId": "fldj9Z3fEpLzv40d0", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldj9Z3fEpLzv40d0", + "name": "Number" + }, + { + "type": "richText", + "id": "fldX1kR7lienmcdEj", + "name": "String" + } + ], + "views": [ + { + "id": "viwbKE3PS9jl6bqJl", + "name": "Grid view", + "type": "grid" + } + ] + } + ] + } + +``` diff --git a/docs/en/md/Airtable/Database-work/Get-list-of-bases.md b/docs/en/md/Airtable/Database-work/Get-list-of-bases.md index d9ce12fe30..f8670d1f76 100644 --- a/docs/en/md/Airtable/Database-work/Get-list-of-bases.md +++ b/docs/en/md/Airtable/Database-work/Get-list-of-bases.md @@ -1,90 +1,90 @@ ---- -sidebar_position: 1 ---- - -# Get list of bases - Gets the list of available bases - - -*Function GetListOfBases(Val Token, Val Indent = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Indent | --offset | String | Next page identifier of the base list from the previous request | - - - Returns: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - - Response = OPI_Airtable.GetListOfBases(Token); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetListOfBases --token %token% --offset %offset% - - -``` - - -```json title="Result" - -{ - "bases": [ - { - "id": "appGarzKZ0lu3gzoa", - "name": "Test", - "permissionLevel": "create" - }, - { - "id": "app9WRfJirwn3yXuG", - "name": "Product catalog", - "permissionLevel": "create" - }, - { - "id": "app6gigUYTzlDEq4X", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "app5hJGyK8asYYe1Q", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "appRQ6VxxOZb40Uwi", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "appM6FaGofV2XSfFA", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "apptm8Xqo7TwMaipQ", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "appsyQyGrF8aVN2Wm", - "name": "TestDatabase", - "permissionLevel": "create" - }, - { - "id": "applEsyJmBRm12AuN", - "name": "TestDatabase", - "permissionLevel": "create" - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Get list of bases + Gets the list of available bases + + +*Function GetListOfBases(Val Token, Val Indent = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Indent | --offset | String | Next page identifier of the base list from the previous request | + + + Returns: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + + Response = OPI_Airtable.GetListOfBases(Token); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetListOfBases --token %token% --offset %offset% + + +``` + + +```json title="Result" + +{ + "bases": [ + { + "id": "appGarzKZ0lu3gzoa", + "name": "Test", + "permissionLevel": "create" + }, + { + "id": "app9WRfJirwn3yXuG", + "name": "Product catalog", + "permissionLevel": "create" + }, + { + "id": "app6gigUYTzlDEq4X", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "app5hJGyK8asYYe1Q", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "appRQ6VxxOZb40Uwi", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "appM6FaGofV2XSfFA", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "apptm8Xqo7TwMaipQ", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "appsyQyGrF8aVN2Wm", + "name": "TestDatabase", + "permissionLevel": "create" + }, + { + "id": "applEsyJmBRm12AuN", + "name": "TestDatabase", + "permissionLevel": "create" + } + ] + } + +``` diff --git a/docs/en/md/Airtable/Database-work/_category_.json b/docs/en/md/Airtable/Database-work/_category_.json index cadfe5956a..ec99978b65 100644 --- a/docs/en/md/Airtable/Database-work/_category_.json +++ b/docs/en/md/Airtable/Database-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Database work", -"position": "2" -} +{ +"label": "Database work", +"position": "2" +} diff --git a/docs/en/md/Airtable/Field-work/Create-field.md b/docs/en/md/Airtable/Field-work/Create-field.md index 346a80e66c..6a0a7dec2a 100644 --- a/docs/en/md/Airtable/Field-work/Create-field.md +++ b/docs/en/md/Airtable/Field-work/Create-field.md @@ -1,55 +1,55 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Base identifier | - | Table | --table | String | Table identifier | - | FieldStructure | --fielddata | Structure of Key-Value | Description of the new field | - - - Returns: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Name = String(New UUID); - Field = OPI_Airtable.GetNumberField(Name); - - Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata% - - -``` - - -```json title="Result" - -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld3IbFtHZtBHQwsk", - "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Base identifier | + | Table | --table | String | Table identifier | + | FieldStructure | --fielddata | Structure of Key-Value | Description of the new field | + + + Returns: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Name = String(New UUID); + Field = OPI_Airtable.GetNumberField(Name); + + Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata% + + +``` + + +```json title="Result" + +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld3IbFtHZtBHQwsk", + "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-attachment-field.md b/docs/en/md/Airtable/Field-work/Get-attachment-field.md index c04e5c45a7..421f3d2feb 100644 --- a/docs/en/md/Airtable/Field-work/Get-attachment-field.md +++ b/docs/en/md/Airtable/Field-work/Get-attachment-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Get field (file) - Gets the description of a file field - - -*Function GetAttachmentField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "multipleAttachments");EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Attachment"; - - Response = OPI_Airtable.GetAttachmentField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetAttachmentField --title "Attachment" - - -``` - - -```json title="Result" - -{ - "name": "Attachment", - "type": "multipleAttachments" - } - -``` +--- +sidebar_position: 5 +--- + +# Get field (file) + Gets the description of a file field + + +*Function GetAttachmentField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "multipleAttachments");EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Attachment"; + + Response = OPI_Airtable.GetAttachmentField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetAttachmentField --title "Attachment" + + +``` + + +```json title="Result" + +{ + "name": "Attachment", + "type": "multipleAttachments" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-checkbox-field.md b/docs/en/md/Airtable/Field-work/Get-checkbox-field.md index 2c87351b7b..39074f8857 100644 --- a/docs/en/md/Airtable/Field-work/Get-checkbox-field.md +++ b/docs/en/md/Airtable/Field-work/Get-checkbox-field.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 6 ---- - -# Get field (checkbox) - Gets the description of a boolean field - - -*Function GetCheckboxField(Val Name) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Checkbox"; - - Response = OPI_Airtable.GetCheckboxField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetCheckboxField --title "Checkbox" - - -``` - - -```json title="Result" - -{ - "name": "Checkbox", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } - } - -``` +--- +sidebar_position: 6 +--- + +# Get field (checkbox) + Gets the description of a boolean field + + +*Function GetCheckboxField(Val Name) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Checkbox"; + + Response = OPI_Airtable.GetCheckboxField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetCheckboxField --title "Checkbox" + + +``` + + +```json title="Result" + +{ + "name": "Checkbox", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-date-field.md b/docs/en/md/Airtable/Field-work/Get-date-field.md index 16a0ef8336..541305473a 100644 --- a/docs/en/md/Airtable/Field-work/Get-date-field.md +++ b/docs/en/md/Airtable/Field-work/Get-date-field.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 7 ---- - -# Get field (date) - Gets the description of a date field - - -*Function GetDateField(Val Name) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Date"; - - Response = OPI_Airtable.GetDateField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetDateField --title "Date" - - -``` - - -```json title="Result" - -{ - "name": "Date", - "type": "date", - "options": { - "dateFormat": { - "format": "YYYY-MM-DD", - "name": "iso" - } - } - } - -``` +--- +sidebar_position: 7 +--- + +# Get field (date) + Gets the description of a date field + + +*Function GetDateField(Val Name) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Date"; + + Response = OPI_Airtable.GetDateField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetDateField --title "Date" + + +``` + + +```json title="Result" + +{ + "name": "Date", + "type": "date", + "options": { + "dateFormat": { + "format": "YYYY-MM-DD", + "name": "iso" + } + } + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-email-field.md b/docs/en/md/Airtable/Field-work/Get-email-field.md index 84505c91c2..f10f162027 100644 --- a/docs/en/md/Airtable/Field-work/Get-email-field.md +++ b/docs/en/md/Airtable/Field-work/Get-email-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 8 ---- - -# Get field (email) - Gets the description of an email field - - -*Function GetEmailField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "email");EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Email"; - - Response = OPI_Airtable.GetEmailField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetEmailField --title "Email" - - -``` - - -```json title="Result" - -{ - "name": "Email", - "type": "email" - } - -``` +--- +sidebar_position: 8 +--- + +# Get field (email) + Gets the description of an email field + + +*Function GetEmailField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "email");EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Email"; + + Response = OPI_Airtable.GetEmailField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetEmailField --title "Email" + + +``` + + +```json title="Result" + +{ + "name": "Email", + "type": "email" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-link-field.md b/docs/en/md/Airtable/Field-work/Get-link-field.md index 3c1a1fbe5a..07aa1b91ef 100644 --- a/docs/en/md/Airtable/Field-work/Get-link-field.md +++ b/docs/en/md/Airtable/Field-work/Get-link-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 10 ---- - -# Get field (url) - Gets the description of a URL field - - -*Function GetLinkField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "url");EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Link"; - - Response = OPI_Airtable.GetLinkField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetLinkField --title "Link" - - -``` - - -```json title="Result" - -{ - "name": "Link", - "type": "url" - } - -``` +--- +sidebar_position: 10 +--- + +# Get field (url) + Gets the description of a URL field + + +*Function GetLinkField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "url");EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Link"; + + Response = OPI_Airtable.GetLinkField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetLinkField --title "Link" + + +``` + + +```json title="Result" + +{ + "name": "Link", + "type": "url" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-number-field.md b/docs/en/md/Airtable/Field-work/Get-number-field.md index 804f804c16..140d7fa2ef 100644 --- a/docs/en/md/Airtable/Field-work/Get-number-field.md +++ b/docs/en/md/Airtable/Field-work/Get-number-field.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | Name | --title | String | New field name | - | Precision | --precision | Number, String | Number of decimal places | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Number"; - Precision = "0"; - - Response = OPI_Airtable.GetNumberField(Name, Precision); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetNumberField --title "Number" --precision "0" - - -``` - - -```json title="Result" - -{ - "name": "Number", - "type": "number", - "options": { - "precision": 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 | Destination | + |-|-|-|-| + | Name | --title | String | New field name | + | Precision | --precision | Number, String | Number of decimal places | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Number"; + Precision = "0"; + + Response = OPI_Airtable.GetNumberField(Name, Precision); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetNumberField --title "Number" --precision "0" + + +``` + + +```json title="Result" + +{ + "name": "Number", + "type": "number", + "options": { + "precision": 0 + } + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-phone-field.md b/docs/en/md/Airtable/Field-work/Get-phone-field.md index 7f4e805f89..50bf726f43 100644 --- a/docs/en/md/Airtable/Field-work/Get-phone-field.md +++ b/docs/en/md/Airtable/Field-work/Get-phone-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 9 ---- - -# Get field (phone) - Gets the description of a phone number field - - -*Function GetPhoneField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "phoneNumber");EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "Phone"; - - Response = OPI_Airtable.GetPhoneField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetPhoneField --title "Phone" - - -``` - - -```json title="Result" - -{ - "name": "Phone", - "type": "phoneNumber" - } - -``` +--- +sidebar_position: 9 +--- + +# Get field (phone) + Gets the description of a phone number field + + +*Function GetPhoneField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "phoneNumber");EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "Phone"; + + Response = OPI_Airtable.GetPhoneField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetPhoneField --title "Phone" + + +``` + + +```json title="Result" + +{ + "name": "Phone", + "type": "phoneNumber" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Get-string-field.md b/docs/en/md/Airtable/Field-work/Get-string-field.md index 4996aca838..a91d6d4e00 100644 --- a/docs/en/md/Airtable/Field-work/Get-string-field.md +++ b/docs/en/md/Airtable/Field-work/Get-string-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 3 ---- - -# Get field (string) - Gets the description of a string field - - -*Function GetStringField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "richText");EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | New field name | - - - Returns: Structure - Field description - -```bsl title="Code example" - - - Name = "String"; - - Response = OPI_Airtable.GetStringField(Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetStringField --title "String" - - -``` - - -```json title="Result" - -{ - "name": "String", - "type": "richText" - } - -``` +--- +sidebar_position: 3 +--- + +# Get field (string) + Gets the description of a string field + + +*Function GetStringField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "richText");EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | New field name | + + + Returns: Structure - Field description + +```bsl title="Code example" + + + Name = "String"; + + Response = OPI_Airtable.GetStringField(Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetStringField --title "String" + + +``` + + +```json title="Result" + +{ + "name": "String", + "type": "richText" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/Modify-field.md b/docs/en/md/Airtable/Field-work/Modify-field.md index cc9e39d8c2..1003543f8e 100644 --- a/docs/en/md/Airtable/Field-work/Modify-field.md +++ b/docs/en/md/Airtable/Field-work/Modify-field.md @@ -1,59 +1,59 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Field = "fld3IbFtHZtBHQwsk"; - Name = String(New UUID) + "(change.)"; - Description = "New description"; - - Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description" - - -``` - - -```json title="Result" - -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld3IbFtHZtBHQwsk", - "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)", - "description": "New description" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Field = "fld3IbFtHZtBHQwsk"; + Name = String(New UUID) + "(change.)"; + Description = "New description"; + + Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description" + + +``` + + +```json title="Result" + +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld3IbFtHZtBHQwsk", + "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)", + "description": "New description" + } + +``` diff --git a/docs/en/md/Airtable/Field-work/_category_.json b/docs/en/md/Airtable/Field-work/_category_.json index 5b8e91cd6b..6dc63de29a 100644 --- a/docs/en/md/Airtable/Field-work/_category_.json +++ b/docs/en/md/Airtable/Field-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Field work", -"position": "4" -} +{ +"label": "Field work", +"position": "4" +} diff --git a/docs/en/md/Airtable/Record-management/Create-posts.md b/docs/en/md/Airtable/Record-management/Create-posts.md index 4afaa5520d..1b6aebaab9 100644 --- a/docs/en/md/Airtable/Record-management/Create-posts.md +++ b/docs/en/md/Airtable/Record-management/Create-posts.md @@ -1,74 +1,74 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 Key : Value pairs > Field : Indicator | - - - Returns: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Numeric = 10; - StringType = "Hello"; - - RowDescription1 = New Structure("Number,String", Numeric, StringType); - RowDescription2 = New Structure("Number,String", Numeric, StringType); - - Data = New Array; - Data.Add(RowDescription1); - Data.Add(RowDescription2); - - Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable CreatePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data% - - -``` - - -```json title="Result" - -{ - "records": [ - { - "id": "recjHNKNZBWLZkZ7A", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - }, - { - "id": "recGyJ0MlN1H3GMuN", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 Key : Value pairs > Field : Indicator | + + + Returns: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Numeric = 10; + StringType = "Hello"; + + RowDescription1 = New Structure("Number,String", Numeric, StringType); + RowDescription2 = New Structure("Number,String", Numeric, StringType); + + Data = New Array; + Data.Add(RowDescription1); + Data.Add(RowDescription2); + + Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable CreatePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data% + + +``` + + +```json title="Result" + +{ + "records": [ + { + "id": "recjHNKNZBWLZkZ7A", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + }, + { + "id": "recGyJ0MlN1H3GMuN", + "createdTime": "2024-05-10T19:39:51Z", + "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 index 36e79b7c9d..16be8b89f1 100644 --- a/docs/en/md/Airtable/Record-management/Delete-posts.md +++ b/docs/en/md/Airtable/Record-management/Delete-posts.md @@ -1,61 +1,61 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - - Records = New Array; - Records.Add("recjHNKNZBWLZkZ7A"); - Records.Add("recGyJ0MlN1H3GMuN"); - - Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable DeletePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records% - - -``` - - -```json title="Result" - -{ - "records": [ - { - "deleted": true, - "id": "recjHNKNZBWLZkZ7A" - }, - { - "deleted": true, - "id": "recGyJ0MlN1H3GMuN" - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + + Records = New Array; + Records.Add("recjHNKNZBWLZkZ7A"); + Records.Add("recGyJ0MlN1H3GMuN"); + + Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable DeletePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records% + + +``` + + +```json title="Result" + +{ + "records": [ + { + "deleted": true, + "id": "recjHNKNZBWLZkZ7A" + }, + { + "deleted": true, + "id": "recGyJ0MlN1H3GMuN" + } + ] + } + +``` 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 index 83e37dd427..5048bdefc7 100644 --- a/docs/en/md/Airtable/Record-management/Get-list-of-records.md +++ b/docs/en/md/Airtable/Record-management/Get-list-of-records.md @@ -1,73 +1,73 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - - Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetListOfRecords --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset% - - -``` - - -```json title="Result" - -{ - "records": [ - { - "id": "recGyJ0MlN1H3GMuN", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - }, - { - "id": "recV6DxeLQMBNJrUk", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - }, - { - "id": "recjHNKNZBWLZkZ7A", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + + Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetListOfRecords --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset% + + +``` + + +```json title="Result" + +{ + "records": [ + { + "id": "recGyJ0MlN1H3GMuN", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + }, + { + "id": "recV6DxeLQMBNJrUk", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + }, + { + "id": "recjHNKNZBWLZkZ7A", + "createdTime": "2024-05-10T19:39:51Z", + "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 index c90b112ed9..b67e58b074 100644 --- a/docs/en/md/Airtable/Record-management/Get-record.md +++ b/docs/en/md/Airtable/Record-management/Get-record.md @@ -1,54 +1,54 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database identifier | - | Table | --table | String | Table identifier | - | Record | --record | String | Record identifier in the table | - - - Returns: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Record = "recV6DxeLQMBNJrUk"; - - Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable GetRecord --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" - - -``` - - -```json title="Result" - -{ - "id": "recV6DxeLQMBNJrUk", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Number": 10, - "String": "Hello\n" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database identifier | + | Table | --table | String | Table identifier | + | Record | --record | String | Record identifier in the table | + + + Returns: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Record = "recV6DxeLQMBNJrUk"; + + Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable GetRecord --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" + + +``` + + +```json title="Result" + +{ + "id": "recV6DxeLQMBNJrUk", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Number": 10, + "String": "Hello\n" + } + } + +``` diff --git a/docs/en/md/Airtable/Record-management/_category_.json b/docs/en/md/Airtable/Record-management/_category_.json index 8459e2d9d6..2c06bb7602 100644 --- a/docs/en/md/Airtable/Record-management/_category_.json +++ b/docs/en/md/Airtable/Record-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Record management", -"position": "5" -} +{ +"label": "Record management", +"position": "5" +} diff --git a/docs/en/md/Airtable/Table-management/Create-table.md b/docs/en/md/Airtable/Table-management/Create-table.md index f7e3cb73a6..3aed1a08e5 100644 --- a/docs/en/md/Airtable/Table-management/Create-table.md +++ b/docs/en/md/Airtable/Table-management/Create-table.md @@ -1,128 +1,128 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - TableName = "TestTable2"; - Description = "NewTable"; - - 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")); - - Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable CreateTable --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "NewTable" - - -``` - - -```json title="Result" - -{ - "id": "tblT64aWyrMUAbUmF", - "name": "TestTable2", - "description": "NewTable", - "primaryFieldId": "fldoHs3kv6RLc8pjo", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldoHs3kv6RLc8pjo", - "name": "Number" - }, - { - "type": "richText", - "id": "fldzY5xRHDY7ClKxa", - "name": "String" - }, - { - "type": "multipleAttachments", - "options": { - "isReversed": false - }, - "id": "fldYHxxXPALKl3yHp", - "name": "Attachment" - }, - { - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - }, - "id": "fldRUoggUObfqckXh", - "name": "Checkbox" - }, - { - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - }, - "id": "fldvtwjapJM7s99nN", - "name": "Date" - }, - { - "type": "phoneNumber", - "id": "flda4VY8dVd2mbqz9", - "name": "Phone" - }, - { - "type": "email", - "id": "fld8ZLKndqBIkT72s", - "name": "Email" - }, - { - "type": "url", - "id": "fldqjsCp1c2KaAS53", - "name": "Link" - } - ], - "views": [ - { - "id": "viwX3vEGO5vB2Km4k", - "name": "Grid view", - "type": "grid" - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + TableName = "TestTable2"; + Description = "NewTable"; + + 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")); + + Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable CreateTable --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "NewTable" + + +``` + + +```json title="Result" + +{ + "id": "tblT64aWyrMUAbUmF", + "name": "TestTable2", + "description": "NewTable", + "primaryFieldId": "fldoHs3kv6RLc8pjo", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldoHs3kv6RLc8pjo", + "name": "Number" + }, + { + "type": "richText", + "id": "fldzY5xRHDY7ClKxa", + "name": "String" + }, + { + "type": "multipleAttachments", + "options": { + "isReversed": false + }, + "id": "fldYHxxXPALKl3yHp", + "name": "Attachment" + }, + { + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + }, + "id": "fldRUoggUObfqckXh", + "name": "Checkbox" + }, + { + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + }, + "id": "fldvtwjapJM7s99nN", + "name": "Date" + }, + { + "type": "phoneNumber", + "id": "flda4VY8dVd2mbqz9", + "name": "Phone" + }, + { + "type": "email", + "id": "fld8ZLKndqBIkT72s", + "name": "Email" + }, + { + "type": "url", + "id": "fldqjsCp1c2KaAS53", + "name": "Link" + } + ], + "views": [ + { + "id": "viwX3vEGO5vB2Km4k", + "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 index 78e4f629e2..96e601b05c 100644 --- a/docs/en/md/Airtable/Table-management/Modify-table.md +++ b/docs/en/md/Airtable/Table-management/Modify-table.md @@ -1,119 +1,119 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Airtable - -```bsl title="Code example" - - - Base = "apptm8Xqo7TwMaipQ"; - Table = "tbl9G4jVoTJpxYwSY"; - Name = "Test table 2 (change.)"; - Description = "New table (change.)"; - - Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint airtable ModifyTable --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Test table 2 (change.)" --description "New table (change.)" - - -``` - - -```json title="Result" - -{ - "id": "tblT64aWyrMUAbUmF", - "name": "Test table 2 (change.)", - "description": "New table (change.)", - "primaryFieldId": "fldoHs3kv6RLc8pjo", - "fields": [ - { - "id": "fldoHs3kv6RLc8pjo", - "name": "Number", - "type": "number", - "options": { - "precision": 0 - } - }, - { - "id": "fldzY5xRHDY7ClKxa", - "name": "String", - "type": "richText" - }, - { - "id": "fldYHxxXPALKl3yHp", - "name": "Attachment", - "type": "multipleAttachments", - "options": { - "isReversed": false - } - }, - { - "id": "fldRUoggUObfqckXh", - "name": "Checkbox", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } - }, - { - "id": "fldvtwjapJM7s99nN", - "name": "Date", - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - } - }, - { - "id": "flda4VY8dVd2mbqz9", - "name": "Phone", - "type": "phoneNumber" - }, - { - "id": "fld8ZLKndqBIkT72s", - "name": "Email", - "type": "email" - }, - { - "id": "fldqjsCp1c2KaAS53", - "name": "Link", - "type": "url" - } - ], - "views": [ - { - "id": "viwX3vEGO5vB2Km4k", - "name": "Grid view", - "type": "grid" - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Airtable + +```bsl title="Code example" + + + Base = "apptm8Xqo7TwMaipQ"; + Table = "tbl9G4jVoTJpxYwSY"; + Name = "Test table 2 (change.)"; + Description = "New table (change.)"; + + Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint airtable ModifyTable --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Test table 2 (change.)" --description "New table (change.)" + + +``` + + +```json title="Result" + +{ + "id": "tblT64aWyrMUAbUmF", + "name": "Test table 2 (change.)", + "description": "New table (change.)", + "primaryFieldId": "fldoHs3kv6RLc8pjo", + "fields": [ + { + "id": "fldoHs3kv6RLc8pjo", + "name": "Number", + "type": "number", + "options": { + "precision": 0 + } + }, + { + "id": "fldzY5xRHDY7ClKxa", + "name": "String", + "type": "richText" + }, + { + "id": "fldYHxxXPALKl3yHp", + "name": "Attachment", + "type": "multipleAttachments", + "options": { + "isReversed": false + } + }, + { + "id": "fldRUoggUObfqckXh", + "name": "Checkbox", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } + }, + { + "id": "fldvtwjapJM7s99nN", + "name": "Date", + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + } + }, + { + "id": "flda4VY8dVd2mbqz9", + "name": "Phone", + "type": "phoneNumber" + }, + { + "id": "fld8ZLKndqBIkT72s", + "name": "Email", + "type": "email" + }, + { + "id": "fldqjsCp1c2KaAS53", + "name": "Link", + "type": "url" + } + ], + "views": [ + { + "id": "viwX3vEGO5vB2Km4k", + "name": "Grid view", + "type": "grid" + } + ] + } + +``` diff --git a/docs/en/md/Airtable/Table-management/_category_.json b/docs/en/md/Airtable/Table-management/_category_.json index 15e71f6271..ff9df15ff9 100644 --- a/docs/en/md/Airtable/Table-management/_category_.json +++ b/docs/en/md/Airtable/Table-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Table management", -"position": "3" -} +{ +"label": "Table management", +"position": "3" +} diff --git a/docs/en/md/Airtable/_category_.json b/docs/en/md/Airtable/_category_.json index 52b2a5dc22..41adf80231 100644 --- a/docs/en/md/Airtable/_category_.json +++ b/docs/en/md/Airtable/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Airtable", - "position": 11, - "link": { - "type": "doc", - "id": "Airtable" - } -} +{ + "label": "Airtable", + "position": 11, + "link": { + "type": "doc", + "id": "Airtable" + } +} 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 index 494d60e8ce..1635182ccc 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Get account information - Gets account information - - -*Function GetAccountInformation(Val Token, Val Account = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Account | --account | String | Account ID. Current token account if not filled | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.GetAccountInformation(Token); - - -``` - -```sh title="CLI command example" - - oint dropbox GetAccountInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account% - - -``` - - -```json title="Result" - -{ - "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", - "name": { - "given_name": "Anton", - "surname": "Titovets", - "familiar_name": "Anton", - "display_name": "Anton Titovets", - "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" - } -} - -``` +--- +sidebar_position: 4 +--- + +# Get account information + Gets account information + + +*Function GetAccountInformation(Val Token, Val Account = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Account | --account | String | Account ID. Current token account if not filled | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.GetAccountInformation(Token); + + +``` + +```sh title="CLI command example" + + oint dropbox GetAccountInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account% + + +``` + + +```json title="Result" + +{ + "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", + "name": { + "given_name": "Anton", + "surname": "Titovets", + "familiar_name": "Anton", + "display_name": "Anton Titovets", + "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 index ed82f21f74..b3b492cf5f 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md @@ -1,38 +1,38 @@ ---- -sidebar_position: 1 ---- - -# Get authorization link - Generates an authorization link for browser transition - - -*Function GetAuthorizationLink(Val AppKey) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | AppKey | --appkey | String | Application key | - - - Returns: String - URL for browser transition - -```bsl title="Code example" - - AppKey = "oynqxds..."; - Result = OPI_Dropbox.GetAuthorizationLink(AppKey); - - -``` - -```sh title="CLI command example" - - oint dropbox GetAuthorizationLink --appkey "oynqxds..." - - -``` - - -```json title="Result" - -"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" - -``` +--- +sidebar_position: 1 +--- + +# Get authorization link + Generates an authorization link for browser transition + + +*Function GetAuthorizationLink(Val AppKey) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | AppKey | --appkey | String | Application key | + + + Returns: String - URL for browser transition + +```bsl title="Code example" + + AppKey = "oynqxds..."; + Result = OPI_Dropbox.GetAuthorizationLink(AppKey); + + +``` + +```sh title="CLI command example" + + oint dropbox GetAuthorizationLink --appkey "oynqxds..." + + +``` + + +```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 index 0d5fa44f12..c22d3fbbef 100644 --- 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 @@ -1,45 +1,45 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.GetSpaceUsageData(Token); - - -``` - -```sh title="CLI command example" - - oint dropbox GetSpaceUsageData --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." - - -``` - - -```json title="Result" - -{ - "used": 1477493597, - "allocation": { - ".tag": "individual", - "allocated": 2147483648 - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.GetSpaceUsageData(Token); + + +``` + +```sh title="CLI command example" + + oint dropbox GetSpaceUsageData --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." + + +``` + + +```json title="Result" + +{ + "used": 1477493597, + "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 index d1bdcc62cf..c229c5ddc0 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-token.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-token.md @@ -1,46 +1,46 @@ ---- -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 | Destination | - |-|-|-|-| - | AppKey | --appkey | String | Application key | - | AppSecret | --appsecret | String | Application secret | - | Code | --code | String | Code from the authorization page | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - AppKey = "oynqxds..."; - AppSecret = "tk2oewn..."; - Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; - - Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code); - - -``` - -```sh title="CLI command example" - - oint dropbox GetToken --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" - - -``` - - -```json title="Result" - -{ - "error": "invalid_grant", - "error_description": "code doesn't exist or has expired" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | AppKey | --appkey | String | Application key | + | AppSecret | --appsecret | String | Application secret | + | Code | --code | String | Code from the authorization page | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + AppKey = "oynqxds..."; + AppSecret = "tk2oewn..."; + Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; + + Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code); + + +``` + +```sh title="CLI command example" + + oint dropbox GetToken --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" + + +``` + + +```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 index e14f59d0a0..b26b33dec5 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md @@ -1,47 +1,47 @@ ---- -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 | Destination | - |-|-|-|-| - | AppKey | --appkey | String | Application key | - | AppSecret | --appsecret | String | Application secret | - | RefreshToken | --refresh | String | Refresh token | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - AppKey = "oynqxds..."; - AppSecret = "tk2oewn..."; - RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; - - Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken); - - -``` - -```sh title="CLI command example" - - oint dropbox RefreshToken --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..." - - -``` - - -```json title="Result" - -{ - "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", - "token_type": "bearer", - "expires_in": 14400 -} - -``` +--- +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 | Destination | + |-|-|-|-| + | AppKey | --appkey | String | Application key | + | AppSecret | --appsecret | String | Application secret | + | RefreshToken | --refresh | String | Refresh token | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + AppKey = "oynqxds..."; + AppSecret = "tk2oewn..."; + RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; + + Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken); + + +``` + +```sh title="CLI command example" + + oint dropbox RefreshToken --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..." + + +``` + + +```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/_category_.json b/docs/en/md/Dropbox/Account-and-authorization/_category_.json index 09ff4b8938..6b133e6e09 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/_category_.json +++ b/docs/en/md/Dropbox/Account-and-authorization/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Account and authorization", -"position": "2" -} +{ +"label": "Account and authorization", +"position": "2" +} 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 index 0c403b33ca..1943ee716a 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md @@ -1,57 +1,57 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | From | --form | String | Path to the original object | - | Target | --to | String | Target path for the new object | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Original = "/New/pic.png"; - Copy = "/New/pic_copy.png"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.CopyObject(Token, Original, Copy); - - -``` - -```sh title="CLI command example" - - oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% - - -``` - - -```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-pT48AAAAAAAABYg", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:54Z", - "rev": "619ab10ed491ebd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | From | --form | String | Path to the original object | + | Target | --to | String | Target path for the new object | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Original = "/New/pic.png"; + Copy = "/New/pic_copy.png"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.CopyObject(Token, Original, Copy); + + +``` + +```sh title="CLI command example" + + oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% + + +``` + + +```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-pT48AAAAAAAABYg", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:54Z", + "rev": "619ab10ed491ebd841553", + "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 index 273a4369c3..4f7b1eb8ae 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 10 ---- - -# Create folder - Creates an empty directory at the selected path - - -*Function CreateFolder(Val Token, Val Path) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Target path for creating the directory | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New catalog"; - - Result = OPI_Dropbox.CreateFolder(Token, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```json title="Result" - -{ - "metadata": { - "name": "New catalog", - "path_lower": "/new catalog", - "path_display": "/New catalog", - "id": "id:kJU6-a-pT48AAAAAAAABZA" - } -} - -``` +--- +sidebar_position: 10 +--- + +# Create folder + Creates an empty directory at the selected path + + +*Function CreateFolder(Val Token, Val Path) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Target path for creating the directory | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New catalog"; + + Result = OPI_Dropbox.CreateFolder(Token, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```json title="Result" + +{ + "metadata": { + "name": "New catalog", + "path_lower": "/new catalog", + "path_display": "/New catalog", + "id": "id:kJU6-a-pT48AAAAAAAABZA" + } +} + +``` 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 index 030de73c83..19cf181b60 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md @@ -1,56 +1,56 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object to delete | - | Irrecoverable | --permanently | String | Delete object without the possibility of recovery | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Path = "/New/pic.png"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.DeleteObject(Token, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently% - - -``` - - -```json title="Result" - -{ - "metadata": { - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:48Z", - "rev": "619ab108e3d3dbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object to delete | + | Irrecoverable | --permanently | String | Delete object without the possibility of recovery | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Path = "/New/pic.png"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.DeleteObject(Token, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently% + + +``` + + +```json title="Result" + +{ + "metadata": { + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:48Z", + "rev": "619ab108e3d3dbd841553", + "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 index e52a14a336..5814c29f9d 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Download-file.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Download-file.md @@ -1,41 +1,41 @@ ---- -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 | Destination | - |-|-|-|-| - | 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.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New/pic.png"; - - Result = OPI_Dropbox.DownloadFile(Token, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %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… - -``` +--- +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 | Destination | + |-|-|-|-| + | 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.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New/pic.png"; + + Result = OPI_Dropbox.DownloadFile(Token, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %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 index 835cdfc656..9dce634403 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md @@ -1,41 +1,41 @@ ---- -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 | Destination | - |-|-|-|-| - | 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.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New"; - - Result = OPI_Dropbox.DownloadFolder(Token, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```json title="Result" - -NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… - -``` +--- +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 | Destination | + |-|-|-|-| + | 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.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New"; + + Result = OPI_Dropbox.DownloadFolder(Token, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```json title="Result" + +NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… + +``` 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 index cd17a4d9ee..bee71ed4a4 100644 --- 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 @@ -1,43 +1,43 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the directory. Optional if the cursor is specified | - | Detailed | --detail | Boolean | Adds additional information fields for media files | - | Cursor | --cursor | String | Cursor from the previous request to get the next set of files | - - - Returns: HTTPResponse - Get list of folder files - -```bsl title="Code example" - - Path = "/New"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True); - - -``` - -```sh title="CLI command example" - - oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the directory. Optional if the cursor is specified | + | Detailed | --detail | Boolean | Adds additional information fields for media files | + | Cursor | --cursor | String | Cursor from the previous request to get the next set of files | + + + Returns: HTTPResponse - Get list of folder files + +```bsl title="Code example" + + Path = "/New"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True); + + +``` + +```sh title="CLI command example" + + oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor% + + +``` + + +```json title="Result" + + + +``` 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 index 7f4a5a6eb7..e129c9a837 100644 --- 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 @@ -1,54 +1,54 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - | Detailed | --detail | Boolean | Adds additional information fields for media files | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Path = "/New/pic.png"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.GetObjectInformation(Token, Path, True); - - -``` - -```sh title="CLI command example" - - oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% - - -``` - - -```json title="Result" - -{ - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + | Detailed | --detail | Boolean | Adds additional information fields for media files | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Path = "/New/pic.png"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.GetObjectInformation(Token, Path, True); + + +``` + +```sh title="CLI command example" + + oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% + + +``` + + +```json title="Result" + +{ + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index 9ac014fc6a..aa10d10894 100644 --- 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 @@ -1,58 +1,58 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New/pic.png"; - - Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1); - - -``` - -```sh title="CLI command example" - - oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount% - - -``` - - -```json title="Result" - -{ - "is_deleted": false, - "entries": [ - { - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } - ] -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New/pic.png"; + + Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1); + + +``` + +```sh title="CLI command example" + + oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount% + + +``` + + +```json title="Result" + +{ + "is_deleted": false, + "entries": [ + { + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index d53be453a6..ae7794173a 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md @@ -1,41 +1,41 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - - - Returns: BinaryData - document preview - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New/mydoc.docx"; - - Result = OPI_Dropbox.GetPreview(Token, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %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… - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + + + Returns: BinaryData - document preview + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New/mydoc.docx"; + + Result = OPI_Dropbox.GetPreview(Token, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %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 index 6c9d8c499a..f5ca8fe8aa 100644 --- 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 @@ -1,62 +1,62 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - WorkID = "G8YbueOu2nsAAAAAAAAAAQ"; - Status = "in_progress"; - - WHile Status = "in_progress" Do - - Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID); - Status = Result[".tag"]; - - OPI_Tools.Pause(5); - - - EndDo; - - -``` - -```sh title="CLI command example" - - oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job% - - -``` - - -```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-pT48AAAAAAAABYw", - "client_modified": "2024-05-30T12:33:07Z", - "server_modified": "2024-05-30T12:33:08Z", - "rev": "619ab11c37fb9bd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + WorkID = "G8YbueOu2nsAAAAAAAAAAQ"; + Status = "in_progress"; + + WHile Status = "in_progress" Do + + Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID); + Status = Result[".tag"]; + + OPI_Tools.Pause(5); + + + EndDo; + + +``` + +```sh title="CLI command example" + + oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job% + + +``` + + +```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-pT48AAAAAAAABYw", + "client_modified": "2024-05-30T12:33:07Z", + "server_modified": "2024-05-30T12:33:08Z", + "rev": "619ab11c37fb9bd841553", + "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 index b5ac66fc2d..beeb911568 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Move-object.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Move-object.md @@ -1,43 +1,43 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | From | --form | String | Path to the original object | - | Target | --to | String | Target path for the new object | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - OriginalPath = "/New/pic.png"; - TargetPath = "/pic.png"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath); - - -``` - -```sh title="CLI command example" - - oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | From | --form | String | Path to the original object | + | Target | --to | String | Target path for the new object | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + OriginalPath = "/New/pic.png"; + TargetPath = "/pic.png"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath); + + +``` + +```sh title="CLI command example" + + oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% + + +``` + + +```json title="Result" + + + +``` 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 index 5daec5d91f..399fc72ae3 100644 --- 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 @@ -1,54 +1,54 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object | - | Version | --rev | String | ID of the version (revision) for restoration | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Version = "61a0b76320a6fbd841553"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New/pic.png"; - - Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version); - - -``` - -```sh title="CLI command example" - - oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553" - - -``` - - -```json title="Result" - -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object | + | Version | --rev | String | ID of the version (revision) for restoration | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Version = "61a0b76320a6fbd841553"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New/pic.png"; + + Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version); + + +``` + +```sh title="CLI command example" + + oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553" + + +``` + + +```json title="Result" + +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index a4676fac9a..c3122af67d 100644 --- 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 @@ -1,46 +1,46 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | FileURL | --url | String | URL source of the file | - | Path | --path | String | Save path on Dropbox | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Path = "/New/url_doc.docx"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - URL = "https://openintegrations.dev/test_data/document.docx"; - - Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path% - - -``` - - -```json title="Result" - -{ - ".tag": "async_job_id", - "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | FileURL | --url | String | URL source of the file | + | Path | --path | String | Save path on Dropbox | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Path = "/New/url_doc.docx"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + URL = "https://openintegrations.dev/test_data/document.docx"; + + Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path% + + +``` + + +```json title="Result" + +{ + ".tag": "async_job_id", + "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" +} + +``` 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 index 647fb4816c..3fb788f522 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md @@ -1,58 +1,58 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Path = "/New/pic.png"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Image = "https://openintegrations.dev/test_data/picture.jpg"; - - ImagePath = GetTempFileName("png"); - CopyFile(Image, ImagePath); - - Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True); - - -``` - -```sh title="CLI command example" - - oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite% - - -``` - - -```json title="Result" - -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Path = "/New/pic.png"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Image = "https://openintegrations.dev/test_data/picture.jpg"; + + ImagePath = GetTempFileName("png"); + CopyFile(Image, ImagePath); + + Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True); + + +``` + +```sh title="CLI command example" + + oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite% + + +``` + + +```json title="Result" + +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "size": 2114023, + "is_downloadable": true, + "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" +} + +``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/_category_.json b/docs/en/md/Dropbox/File-and-directory-management/_category_.json index 2290d49da8..1b4ac0dfdc 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/_category_.json +++ b/docs/en/md/Dropbox/File-and-directory-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "File and directory management", -"position": "3" -} +{ +"label": "File and directory management", +"position": "3" +} 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 index a32b2bb1fc..097bad1975 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 3 ---- - -# Add user to file - Defines access to the file for an external user - - -*Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Email = "h5bk6ft62s@privaterelay.appleid.com"; - File = "kJU6-a-pT48AAAAAAAAABw"; - - Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False); - - -``` - -```sh title="CLI command example" - - oint dropbox AddUsersToFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly% - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 3 +--- + +# Add user to file + Defines access to the file for an external user + + +*Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Email = "h5bk6ft62s@privaterelay.appleid.com"; + File = "kJU6-a-pT48AAAAAAAAABw"; + + Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False); + + +``` + +```sh title="CLI command example" + + oint dropbox AddUsersToFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly% + + +``` + + +```json title="Result" + + + +``` 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 index 4c71efb8e5..e2fc26bd48 100644 --- 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 @@ -1,44 +1,44 @@ ---- -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 | Destination | - |-|-|-|-| - | 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.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Email = "h5bk6ft62s@privaterelay.appleid.com"; - Folder = "5022319569"; // shared_folder_id - - Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False); - - -``` - -```sh title="CLI command example" - - oint dropbox AddUsersToFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | 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.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Email = "h5bk6ft62s@privaterelay.appleid.com"; + Folder = "5022319569"; // shared_folder_id + + Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False); + + +``` + +```sh title="CLI command example" + + oint dropbox AddUsersToFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly% + + +``` + + +```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 index f899640f26..6ea70e048f 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 6 ---- - -# Unpublish file - Prohibits access to the file for external users - - -*Function CancelFilePublication(Val Token, Val FileID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | FileID | --fileid | String | ID of the file to be accessed | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - File = "kJU6-a-pT48AAAAAAAAABw"; - - Result = OPI_Dropbox.CancelFilePublication(Token, File); - - -``` - -```sh title="CLI command example" - - oint dropbox CancelFilePublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% - - -``` - - -```json title="Result" - -{} - -``` +--- +sidebar_position: 6 +--- + +# Unpublish file + Prohibits access to the file for external users + + +*Function CancelFilePublication(Val Token, Val FileID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | FileID | --fileid | String | ID of the file to be accessed | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + File = "kJU6-a-pT48AAAAAAAAABw"; + + Result = OPI_Dropbox.CancelFilePublication(Token, File); + + +``` + +```sh title="CLI command example" + + oint dropbox CancelFilePublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% + + +``` + + +```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 index 03f519a6dd..5b5eeb0367 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 2 ---- - -# Unpublish folder - Cancels the public access mode for the directory - - -*Function CancelFolderPublication(Val Token, Val FolderID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | FolderID | --folder | String | ID of the public catalog (shared folder ID) | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Folder = "5022319569"; - - Result = OPI_Dropbox.CancelFolderPublication(Token, Folder); - CurrentStatus = "in_progress"; - JobID = Result["async_job_id"]; - - WHile CurrentStatus = "in_progress" Do - Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID); - CurrentStatus = Result[".tag"]; - OPI_Tools.Pause(3); - EndDo; - - -``` - -```sh title="CLI command example" - - oint dropbox CancelFolderPublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% - - -``` - - -```json title="Result" - -{ - ".tag": "complete" -} - -``` +--- +sidebar_position: 2 +--- + +# Unpublish folder + Cancels the public access mode for the directory + + +*Function CancelFolderPublication(Val Token, Val FolderID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | FolderID | --folder | String | ID of the public catalog (shared folder ID) | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Folder = "5022319569"; + + Result = OPI_Dropbox.CancelFolderPublication(Token, Folder); + CurrentStatus = "in_progress"; + JobID = Result["async_job_id"]; + + WHile CurrentStatus = "in_progress" Do + Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID); + CurrentStatus = Result[".tag"]; + OPI_Tools.Pause(3); + EndDo; + + +``` + +```sh title="CLI command example" + + oint dropbox CancelFolderPublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% + + +``` + + +```json title="Result" + +{ + ".tag": "complete" +} + +``` 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 index 41f9331e0e..7385c1c117 100644 --- 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 @@ -1,37 +1,37 @@ ---- -sidebar_position: 5 ---- - -# Get asynchronous change status - Gets the status of the asynchronous access change job - - -*Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | JobID | --job | String | AsynchronousJobID | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint dropbox GetAsynchronousChangeStatus --token %token% --job %job% - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 5 +--- + +# Get asynchronous change status + Gets the status of the asynchronous access change job + + +*Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | JobID | --job | String | AsynchronousJobID | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint dropbox GetAsynchronousChangeStatus --token %token% --job %job% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md index e741c37bed..89939c23cb 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md @@ -1,69 +1,69 @@ ---- -sidebar_position: 1 ---- - -# Publish folder - Sets the directory to public access mode - - -*Function PublishFolder(Val Token, Val Path) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the target directory | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New"; - - Result = OPI_Dropbox.PublishFolder(Token, Path); - - -``` - -```sh title="CLI command example" - - oint dropbox PublishFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %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/0eu3zz5f05vymefoq6yyl/h?dl=0", - "shared_folder_id": "5009428129", - "time_invited": "2024-05-30T12:35:34Z", - "access_inheritance": { - ".tag": "inherit" - }, - "folder_id": "id:kJU6-a-pT48AAAAAAAABXw" -} - -``` +--- +sidebar_position: 1 +--- + +# Publish folder + Sets the directory to public access mode + + +*Function PublishFolder(Val Token, Val Path) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the target directory | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New"; + + Result = OPI_Dropbox.PublishFolder(Token, Path); + + +``` + +```sh title="CLI command example" + + oint dropbox PublishFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %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/0eu3zz5f05vymefoq6yyl/h?dl=0", + "shared_folder_id": "5009428129", + "time_invited": "2024-05-30T12:35:34Z", + "access_inheritance": { + ".tag": "inherit" + }, + "folder_id": "id:kJU6-a-pT48AAAAAAAABXw" +} + +``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/_category_.json b/docs/en/md/Dropbox/Shared-access-settings/_category_.json index 3480d164c4..ba1256d155 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/_category_.json +++ b/docs/en/md/Dropbox/Shared-access-settings/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Shared access settings", -"position": "5" -} +{ +"label": "Shared access settings", +"position": "5" +} diff --git a/docs/en/md/Dropbox/Tag-work/Add-tag.md b/docs/en/md/Dropbox/Tag-work/Add-tag.md index 7369161707..c3e5d85409 100644 --- a/docs/en/md/Dropbox/Tag-work/Add-tag.md +++ b/docs/en/md/Dropbox/Tag-work/Add-tag.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 2 ---- - -# Add tag - Adds a new text tag to a file or directory - - -*Function AddTag(Val Token, Val Path, Val Tag) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Tag = "Important"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New/mydoc.docx"; - - Result = OPI_Dropbox.AddTag(Token, Path, Tag); - - -``` - -```sh title="CLI command example" - - oint dropbox AddTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% - - -``` - - -```json title="Result" - -{} - -``` +--- +sidebar_position: 2 +--- + +# Add tag + Adds a new text tag to a file or directory + + +*Function AddTag(Val Token, Val Path, Val Tag) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Tag = "Important"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New/mydoc.docx"; + + Result = OPI_Dropbox.AddTag(Token, Path, Tag); + + +``` + +```sh title="CLI command example" + + oint dropbox AddTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% + + +``` + + +```json title="Result" + +{} + +``` diff --git a/docs/en/md/Dropbox/Tag-work/Delete-tag.md b/docs/en/md/Dropbox/Tag-work/Delete-tag.md index 6e21531196..c18ebc59cf 100644 --- a/docs/en/md/Dropbox/Tag-work/Delete-tag.md +++ b/docs/en/md/Dropbox/Tag-work/Delete-tag.md @@ -1,43 +1,43 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object whose tag needs to be deleted | - | Tag | --tag | String | Tag text | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - Tag = "Important"; - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Path = "/New/mydoc.docx"; - - Result = OPI_Dropbox.DeleteTag(Token, Path, Tag); - - -``` - -```sh title="CLI command example" - - oint dropbox DeleteTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% - - -``` - - -```json title="Result" - -{} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object whose tag needs to be deleted | + | Tag | --tag | String | Tag text | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + Tag = "Important"; + Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Path = "/New/mydoc.docx"; + + Result = OPI_Dropbox.DeleteTag(Token, Path, Tag); + + +``` + +```sh title="CLI command example" + + oint dropbox DeleteTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% + + +``` + + +```json title="Result" + +{} + +``` diff --git a/docs/en/md/Dropbox/Tag-work/Get-tag-list.md b/docs/en/md/Dropbox/Tag-work/Get-tag-list.md index b2c2324387..fb35465e71 100644 --- a/docs/en/md/Dropbox/Tag-work/Get-tag-list.md +++ b/docs/en/md/Dropbox/Tag-work/Get-tag-list.md @@ -1,53 +1,53 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Paths | --paths | String, Array of String | Path or set of paths to the files | - - - Returns: Key-Value Pair - serialized JSON response from Dropbox - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint dropbox GetTagList --token %token% --paths %paths% - - -``` - - -```json title="Result" - -{ - "paths_to_tags": [ - { - "path": "/New/Dogs.mp3", - "tags": [] - }, - { - "path": "/New/mydoc.docx", - "tags": [ - { - ".tag": "user_generated_tag", - "tag_text": "important" - } - ] - } - ] -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Paths | --paths | String, Array of String | Path or set of paths to the files | + + + Returns: Key-Value Pair - serialized JSON response from Dropbox + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint dropbox GetTagList --token %token% --paths %paths% + + +``` + + +```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/Tag-work/_category_.json b/docs/en/md/Dropbox/Tag-work/_category_.json index f6e40c0bf8..843133162b 100644 --- a/docs/en/md/Dropbox/Tag-work/_category_.json +++ b/docs/en/md/Dropbox/Tag-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Tag work", -"position": "4" -} +{ +"label": "Tag work", +"position": "4" +} 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 index 43838b188f..b1c340c514 100644 --- 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 @@ -1,59 +1,59 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.AddCalendarToList(Token, "55868c32be16935f0..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar AddCalendarToList --token %token% --calendar %calendar% - - -``` - - -```json title="Result" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "selected": true, - "foregroundColor": "#000000", - "backgroundColor": "#7bd148", - "colorId": "9", - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", - "etag": "\"1708423365033000\"", - "kind": "calendar#calendarListEntry" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.AddCalendarToList(Token, "55868c32be16935f0..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar AddCalendarToList --token %token% --calendar %calendar% + + +``` + + +```json title="Result" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "selected": true, + "foregroundColor": "#000000", + "backgroundColor": "#7bd148", + "colorId": "9", + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", + "etag": "\"1708423365033000\"", + "kind": "calendar#calendarListEntry" + } + +``` 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 index 54157dfd0a..50ae217e74 100644 --- 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 @@ -1,41 +1,41 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.DeleteCalendarFromList(Token, "55868c32be16935f0..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar DeleteCalendarFromList --token %token% --calendar %calendar% - - -``` - - -```json title="Result" - -"" - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.DeleteCalendarFromList(Token, "55868c32be16935f0..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar DeleteCalendarFromList --token %token% --calendar %calendar% + + +``` + + +```json title="Result" + +"" + +``` 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 index 652e42495c..62ef972c5c 100644 --- 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 @@ -1,65 +1,65 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - - Black = "#000000"; - Yellow = "#ffd800"; - - Response = OPI_GoogleCalendar.EditListCalendar(Token, "55868c32be16935f0...", Black, Yellow, False); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar EditListCalendar --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden% - - -``` - - -```json title="Result" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com", - "etag": "\"1708424005038000\"", - "kind": "calendar#calendarListEntry" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + + Black = "#000000"; + Yellow = "#ffd800"; + + Response = OPI_GoogleCalendar.EditListCalendar(Token, "55868c32be16935f0...", Black, Yellow, False); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar EditListCalendar --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden% + + +``` + + +```json title="Result" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com", + "etag": "\"1708424005038000\"", + "kind": "calendar#calendarListEntry" + } + +``` 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 index 4bd523334a..eff2bfe6b8 100644 --- 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 @@ -1,175 +1,175 @@ ---- -sidebar_position: 1 ---- - -# Get list of calendars - Gets an array of account calendars - - -*Function GetCalendarList(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - Array of calendar data mappings - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.GetCalendarList(Token); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar GetCalendarList --token %token% - - -``` - - -```json title="Result" - -[ - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "reader", - "foregroundColor": "#000000", - "backgroundColor": "#92e1c0", - "colorId": "13", - "description": "Hollydays.", - "summary": "Hollydays", - "defaultReminders": [], - "timeZone": "Europe/Minsk", - "id": "addressbook#contacts@group.v.calendar.google.com", - "etag": "\"1708410978711000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "notificationSettings": { - "notifications": [ - { - "method": "email", - "type": "eventCreation" - }, - { - "method": "email", - "type": "eventChange" - }, - { - "method": "email", - "type": "eventCancellation" - }, - { - "method": "email", - "type": "eventResponse" - } - ] - }, - "accessRole": "owner", - "selected": true, - "foregroundColor": "#000000", - "backgroundColor": "#9fe1e7", - "colorId": "14", - "primary": true, - "summary": "bayselonarrend@gmail.com", - "defaultReminders": [ - { - "minutes": 30, - "method": "popup" - } - ], - "timeZone": "Europe/Minsk", - "id": "bayselonarrend@gmail.com", - "etag": "\"1708411692097000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "reader", - "foregroundColor": "#000000", - "backgroundColor": "#16a765", - "colorId": "8", - "description": "Holidays and memorable dates in Belarus", - "summary": "Holidays in Belarus", - "defaultReminders": [], - "timeZone": "Europe/Minsk", - "id": "ru.by#holiday@group.v.calendar.google.com", - "etag": "\"1708417568219000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#cca6ac", - "colorId": "21", - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com", - "etag": "\"1708417602744000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com", - "etag": "\"1708417840630000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com", - "etag": "\"1708418157716000\"", - "kind": "calendar#calendarListEntry" - } - ] - -``` +--- +sidebar_position: 1 +--- + +# Get list of calendars + Gets an array of account calendars + + +*Function GetCalendarList(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - Array of calendar data mappings + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.GetCalendarList(Token); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar GetCalendarList --token %token% + + +``` + + +```json title="Result" + +[ + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "reader", + "foregroundColor": "#000000", + "backgroundColor": "#92e1c0", + "colorId": "13", + "description": "Hollydays.", + "summary": "Hollydays", + "defaultReminders": [], + "timeZone": "Europe/Minsk", + "id": "addressbook#contacts@group.v.calendar.google.com", + "etag": "\"1708410978711000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "notificationSettings": { + "notifications": [ + { + "method": "email", + "type": "eventCreation" + }, + { + "method": "email", + "type": "eventChange" + }, + { + "method": "email", + "type": "eventCancellation" + }, + { + "method": "email", + "type": "eventResponse" + } + ] + }, + "accessRole": "owner", + "selected": true, + "foregroundColor": "#000000", + "backgroundColor": "#9fe1e7", + "colorId": "14", + "primary": true, + "summary": "bayselonarrend@gmail.com", + "defaultReminders": [ + { + "minutes": 30, + "method": "popup" + } + ], + "timeZone": "Europe/Minsk", + "id": "bayselonarrend@gmail.com", + "etag": "\"1708411692097000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "reader", + "foregroundColor": "#000000", + "backgroundColor": "#16a765", + "colorId": "8", + "description": "Holidays and memorable dates in Belarus", + "summary": "Holidays in Belarus", + "defaultReminders": [], + "timeZone": "Europe/Minsk", + "id": "ru.by#holiday@group.v.calendar.google.com", + "etag": "\"1708417568219000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#cca6ac", + "colorId": "21", + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com", + "etag": "\"1708417602744000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com", + "etag": "\"1708417840630000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com", + "etag": "\"1708418157716000\"", + "kind": "calendar#calendarListEntry" + } + ] + +``` 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 index 33ac04c9a6..d48a6d444c 100644 --- 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 @@ -1,58 +1,58 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.GetListCalendar(Token, "55868c32be16935f0..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar GetListCalendar --token %token% --calendar %calendar% - - -``` - - -```json title="Result" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", - "etag": "\"1708423563386000\"", - "kind": "calendar#calendarListEntry" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.GetListCalendar(Token, "55868c32be16935f0..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar GetListCalendar --token %token% --calendar %calendar% + + +``` + + +```json title="Result" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", + "etag": "\"1708423563386000\"", + "kind": "calendar#calendarListEntry" + } + +``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/_category_.json b/docs/en/md/Google_Calendar/Calendar-list-management/_category_.json index 00aa1f6ce8..885115d3d0 100644 --- a/docs/en/md/Google_Calendar/Calendar-list-management/_category_.json +++ b/docs/en/md/Google_Calendar/Calendar-list-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Calendar list management", -"position": "3" -} +{ +"label": "Calendar list management", +"position": "3" +} 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 index 03ace6a333..ff37610c77 100644 --- 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 @@ -1,39 +1,39 @@ ---- -sidebar_position: 4 ---- - -# Clear primary calendar - Clears the event list of the primary calendar - - -*Function ClearMainCalendar(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.ClearMainCalendar(Token); - - - -``` - -```sh title="CLI command example" - - oint gcalendar ClearMainCalendar --token %token% - - -``` - - -```json title="Result" - -"" - -``` +--- +sidebar_position: 4 +--- + +# Clear primary calendar + Clears the event list of the primary calendar + + +*Function ClearMainCalendar(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.ClearMainCalendar(Token); + + + +``` + +```sh title="CLI command example" + + oint gcalendar ClearMainCalendar --token %token% + + +``` + + +```json title="Result" + +"" + +``` 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 index 7093454cbc..e138725435 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 1 ---- - -# Create calendar - Creates an empty calendar - - -*Function CreateCalendar(Val Token, Val Name) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Name | --title | String | Name of the created calendar | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.CreateCalendar(Token, "TestCalendar"); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar CreateCalendar --token %token% --title %title% - - -``` - - -```json title="Result" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "summary": "TestCalendar", - "timeZone": "UTC", - "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", - "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", - "kind": "calendar#calendar" - } - -``` +--- +sidebar_position: 1 +--- + +# Create calendar + Creates an empty calendar + + +*Function CreateCalendar(Val Token, Val Name) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Name | --title | String | Name of the created calendar | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.CreateCalendar(Token, "TestCalendar"); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar CreateCalendar --token %token% --title %title% + + +``` + + +```json title="Result" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "summary": "TestCalendar", + "timeZone": "UTC", + "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", + "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", + "kind": "calendar#calendar" + } + +``` 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 index 0dbf0a3d03..91d9e30a38 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 5 ---- - -# Delete calendar - Deletes a calendar by ID - - -*Function DeleteCalendar(Val Token, Val Calendar) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.DeleteCalendar(Token, "55868c32be16935f0..."); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint gcalendar DeleteCalendar --token %token% --calendar %calendar% - - -``` - - -```json title="Result" - -"" - -``` +--- +sidebar_position: 5 +--- + +# Delete calendar + Deletes a calendar by ID + + +*Function DeleteCalendar(Val Token, Val Calendar) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.DeleteCalendar(Token, "55868c32be16935f0..."); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint gcalendar DeleteCalendar --token %token% --calendar %calendar% + + +``` + + +```json title="Result" + +"" + +``` 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 index c45a03ffbb..be55049120 100644 --- 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 @@ -1,57 +1,57 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | Name | --title | String | New name | - | Description | --description | String | New calendar description | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Name = "TestCalendar (change.)"; - Description = "TestDescription"; - Response = OPI_GoogleCalendar.EditCalendarMetadata(Token, "55868c32be16935f0...", Name, Description); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar EditCalendarMetadata --token %token% --calendar %calendar% --title "TestCalendar (change.)" --description "TestDescription" - - -``` - - -```json title="Result" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "timeZone": "UTC", - "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", - "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", - "kind": "calendar#calendar" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | Name | --title | String | New name | + | Description | --description | String | New calendar description | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Name = "TestCalendar (change.)"; + Description = "TestDescription"; + Response = OPI_GoogleCalendar.EditCalendarMetadata(Token, "55868c32be16935f0...", Name, Description); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar EditCalendarMetadata --token %token% --calendar %calendar% --title "TestCalendar (change.)" --description "TestDescription" + + +``` + + +```json title="Result" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "timeZone": "UTC", + "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", + "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", + "kind": "calendar#calendar" + } + +``` 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 index c9f5d364e8..fbbaa4f8ed 100644 --- 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 @@ -1,53 +1,53 @@ ---- -sidebar_position: 2 ---- - -# Get calendar - Gets calendar information by ID - - -*Function GetCalendarMetadata(Val Token, Val Calendar) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.GetCalendarMetadata(Token, "55868c32be16935f0..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar GetCalendarMetadata --token %token% --calendar %calendar% - - -``` - - -```json title="Result" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "description": "TestDescription", - "summary": "TestCalendar (change.)", - "timeZone": "UTC", - "id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com", - "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", - "kind": "calendar#calendar" - } - -``` +--- +sidebar_position: 2 +--- + +# Get calendar + Gets calendar information by ID + + +*Function GetCalendarMetadata(Val Token, Val Calendar) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.GetCalendarMetadata(Token, "55868c32be16935f0..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar GetCalendarMetadata --token %token% --calendar %calendar% + + +``` + + +```json title="Result" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "description": "TestDescription", + "summary": "TestCalendar (change.)", + "timeZone": "UTC", + "id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com", + "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", + "kind": "calendar#calendar" + } + +``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/_category_.json b/docs/en/md/Google_Calendar/Calendar-metadata-management/_category_.json index 5fce25e0cd..9c0673da1f 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/_category_.json +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Calendar metadata management", -"position": "2" -} +{ +"label": "Calendar metadata management", +"position": "2" +} diff --git a/docs/en/md/Google_Calendar/Event-management/Create-event.md b/docs/en/md/Google_Calendar/Event-management/Create-event.md index f32620afa6..c14aff4429 100644 --- a/docs/en/md/Google_Calendar/Event-management/Create-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Create-event.md @@ -1,100 +1,100 @@ ---- -sidebar_position: 4 ---- - -# Create event - Creates a new event - - -*Function CreateEvent(Val Token, Val Calendar, Val EventDescription) ExportReturn EventManagement(Token, Calendar, EventDescription);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | EventDescription | --props | Key-Value Pair | Event description | - - - Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response - -```bsl title="Code example" - - - Attachments = New Map; - Attachments.Insert("Image1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); - Attachments.Insert("Image2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"); - - EventMatch = New Map; - EventMatch.Insert("Description", Description); - EventMatch.Insert("Title", Name); - EventMatch.Insert("Venue", "On office"); - EventMatch.Insert("StartDate", CurrentSessionDate()); - EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); - EventMatch.Insert("ArrayOfAttachmentURLs", Attachments); - EventMatch.Insert("SendNotifications", True); - - Response = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventMatch); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint gcalendar CreateEvent --token %token% --calendar %calendar% --props %props% - - -``` - - -```json title="Result" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Image2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Image1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T15:16:25+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T16:16:25+03:00" - }, - "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", - "description": "TestEventDescription", - "updated": "2024-02-21T09:16:28.474Z", - "created": "2024-02-21T09:16:28.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", - "location": "On office", - "summary": "New event", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "j4nonfcc0m2mtop1vc8ivo8tb8", - "etag": "\"3417013976948000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 4 +--- + +# Create event + Creates a new event + + +*Function CreateEvent(Val Token, Val Calendar, Val EventDescription) ExportReturn EventManagement(Token, Calendar, EventDescription);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | EventDescription | --props | Key-Value Pair | Event description | + + + Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response + +```bsl title="Code example" + + + Attachments = New Map; + Attachments.Insert("Image1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); + Attachments.Insert("Image2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"); + + EventMatch = New Map; + EventMatch.Insert("Description", Description); + EventMatch.Insert("Title", Name); + EventMatch.Insert("Venue", "On office"); + EventMatch.Insert("StartDate", CurrentSessionDate()); + EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); + EventMatch.Insert("ArrayOfAttachmentURLs", Attachments); + EventMatch.Insert("SendNotifications", True); + + Response = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventMatch); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint gcalendar CreateEvent --token %token% --calendar %calendar% --props %props% + + +``` + + +```json title="Result" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Image2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Image1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T15:16:25+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T16:16:25+03:00" + }, + "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", + "description": "TestEventDescription", + "updated": "2024-02-21T09:16:28.474Z", + "created": "2024-02-21T09:16:28.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", + "location": "On office", + "summary": "New event", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "j4nonfcc0m2mtop1vc8ivo8tb8", + "etag": "\"3417013976948000\"", + "kind": "calendar#event" + } + +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Delete-event.md b/docs/en/md/Google_Calendar/Event-management/Delete-event.md index 89ea922796..0eda7ac711 100644 --- a/docs/en/md/Google_Calendar/Event-management/Delete-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Delete-event.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 7 ---- - -# Delete event - Deletes an event by ID - - -*Function DeleteEvent(Val Token, Val Calendar, Val Event) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | Event | --event | String | Event ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.DeleteEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar DeleteEvent --token %token% --calendar %calendar% --event %event% - - -``` - - -```json title="Result" - -"" - -``` +--- +sidebar_position: 7 +--- + +# Delete event + Deletes an event by ID + + +*Function DeleteEvent(Val Token, Val Calendar, Val Event) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | Event | --event | String | Event ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.DeleteEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar DeleteEvent --token %token% --calendar %calendar% --event %event% + + +``` + + +```json title="Result" + +"" + +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Edit-event.md b/docs/en/md/Google_Calendar/Event-management/Edit-event.md index 32042eba88..82dac1105e 100644 --- a/docs/en/md/Google_Calendar/Event-management/Edit-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Edit-event.md @@ -1,91 +1,91 @@ ---- -sidebar_position: 6 ---- - -# Edit event - Edits an existing event - - -*Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) ExportReturn EventManagement(Token, Calendar, EventDescription, Event);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | EventDescription | --props | String | New event description | - | Event | --event | String | Event ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - EventMatch = New Map; - EventMatch.Insert("Description", "Test event description (change.)"); - - Response = OPI_GoogleCalendar.EditEvent(Token, "55868c32be16935f0...", EventMatch, "j4nonfcc0m2..."); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint gcalendar EditEvent --token %token% --calendar %calendar% --props %props% --event %event% - - -``` - - -```json title="Result" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Image2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Image1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T16:42:28+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T17:42:28+03:00" - }, - "iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com", - "description": "Test event description (change.)", - "updated": "2024-02-24T10:42:42.401Z", - "created": "2024-02-24T10:42:32.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ", - "location": "InOffice", - "summary": "New event", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "7c2s6g3k6ib1mr2v1b7lnt9kfk", - "etag": "\"3417542724802000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 6 +--- + +# Edit event + Edits an existing event + + +*Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) ExportReturn EventManagement(Token, Calendar, EventDescription, Event);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | EventDescription | --props | String | New event description | + | Event | --event | String | Event ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + EventMatch = New Map; + EventMatch.Insert("Description", "Test event description (change.)"); + + Response = OPI_GoogleCalendar.EditEvent(Token, "55868c32be16935f0...", EventMatch, "j4nonfcc0m2..."); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint gcalendar EditEvent --token %token% --calendar %calendar% --props %props% --event %event% + + +``` + + +```json title="Result" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Image2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Image1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T16:42:28+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T17:42:28+03:00" + }, + "iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com", + "description": "Test event description (change.)", + "updated": "2024-02-24T10:42:42.401Z", + "created": "2024-02-24T10:42:32.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ", + "location": "InOffice", + "summary": "New event", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "7c2s6g3k6ib1mr2v1b7lnt9kfk", + "etag": "\"3417542724802000\"", + "kind": "calendar#event" + } + +``` 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 index 7e14fe0315..2cf6acd63f 100644 --- a/docs/en/md/Google_Calendar/Event-management/Get-event-description.md +++ b/docs/en/md/Google_Calendar/Event-management/Get-event-description.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 1 ---- - -# Get description events - - - -*Function GetEventDescription() Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - - - Returns: Key-Value Pair - Empty event template - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint gcalendar GetEventDescription - - -``` - - -```json title="Result" - -EventMatch = New Map; - EventMatch.Insert("Description", ""); // Event description - EventMatch.Insert("Title", "New event"); // Title events - EventMatch.Insert("Venue", ""); // String description of the venue of the event - EventMatch.Insert("StartDate", CurrentSessionDate()); // Date of start events - EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); // Date of end events - EventMatch.Insert("ArrayOfAttachmentURLs", New Map); // Key - name, Value - URL to file - EventMatch.Insert("SendNotifications", True); // Indication of sending notifications to participants - -``` +--- +sidebar_position: 1 +--- + +# Get description events + + + +*Function GetEventDescription() Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + + + Returns: Key-Value Pair - Empty event template + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint gcalendar GetEventDescription + + +``` + + +```json title="Result" + +EventMatch = New Map; + EventMatch.Insert("Description", ""); // Event description + EventMatch.Insert("Title", "New event"); // Title events + EventMatch.Insert("Venue", ""); // String description of the venue of the event + EventMatch.Insert("StartDate", CurrentSessionDate()); // Date of start events + EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); // Date of end events + EventMatch.Insert("ArrayOfAttachmentURLs", New Map); // Key - name, Value - URL to file + EventMatch.Insert("SendNotifications", True); // Indication of sending notifications to participants + +``` 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 index 048354379d..dbf0d43699 100644 --- a/docs/en/md/Google_Calendar/Event-management/Get-event-list.md +++ b/docs/en/md/Google_Calendar/Event-management/Get-event-list.md @@ -1,90 +1,90 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - - - Returns: Key-Value Pair - Array of event mappings - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.GetEventList(Token, "55868c32be16935f0..."); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint gcalendar GetEventList --token %token% --calendar %calendar% - - -``` - - -```json title="Result" - -[ - - { - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - }, - { - "iconLink": "", - "title": "", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-20T05:31:12+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-20T06:31:12+03:00" - }, - "iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com", - "description": "TestEventDescription", - "updated": "2024-02-20T11:31:13.044Z", - "created": "2024-02-20T11:31:13.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ", - "location": "On office", - "summary": "New event", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "o6dt8kbedrmu15o53pgbrrv35o", - "etag": "\"3416857346088000\"", - "kind": "calendar#event" - }, - - ] - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + + + Returns: Key-Value Pair - Array of event mappings + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.GetEventList(Token, "55868c32be16935f0..."); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint gcalendar GetEventList --token %token% --calendar %calendar% + + +``` + + +```json title="Result" + +[ + + { + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + }, + { + "iconLink": "", + "title": "", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-20T05:31:12+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-20T06:31:12+03:00" + }, + "iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com", + "description": "TestEventDescription", + "updated": "2024-02-20T11:31:13.044Z", + "created": "2024-02-20T11:31:13.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ", + "location": "On office", + "summary": "New event", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "o6dt8kbedrmu15o53pgbrrv35o", + "etag": "\"3416857346088000\"", + "kind": "calendar#event" + }, + + ] + +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event.md b/docs/en/md/Google_Calendar/Event-management/Get-event.md index a8e8f9237a..814d1f6b91 100644 --- a/docs/en/md/Google_Calendar/Event-management/Get-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Get-event.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 3 ---- - -# Get event - Gets an event by ID - - -*Function GetEvent(Val Token, Val Calendar, Val Event) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Calendar | --calendar | String | Calendar ID | - | Event | --event | String | Event ID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.GetEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar GetEvent --token %token% --calendar %calendar% --event %event% - - -``` - - -```json title="Result" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Image2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Image1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T15:16:25+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T16:16:25+03:00" - }, - "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", - "description": "TestEventDescription", - "updated": "2024-02-21T09:16:28.474Z", - "created": "2024-02-21T09:16:28.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", - "location": "On office", - "summary": "New event", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "j4nonfcc0m2mtop1vc8ivo8tb8", - "etag": "\"3417013976948000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 3 +--- + +# Get event + Gets an event by ID + + +*Function GetEvent(Val Token, Val Calendar, Val Event) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Calendar | --calendar | String | Calendar ID | + | Event | --event | String | Event ID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.GetEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar GetEvent --token %token% --calendar %calendar% --event %event% + + +``` + + +```json title="Result" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Image2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Image1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T15:16:25+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T16:16:25+03:00" + }, + "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", + "description": "TestEventDescription", + "updated": "2024-02-21T09:16:28.474Z", + "created": "2024-02-21T09:16:28.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", + "location": "On office", + "summary": "New event", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "j4nonfcc0m2mtop1vc8ivo8tb8", + "etag": "\"3417013976948000\"", + "kind": "calendar#event" + } + +``` diff --git a/docs/en/md/Google_Calendar/Event-management/Move-event.md b/docs/en/md/Google_Calendar/Event-management/Move-event.md index 70f1381557..b9deca5cec 100644 --- a/docs/en/md/Google_Calendar/Event-management/Move-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Move-event.md @@ -1,88 +1,88 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Response = OPI_GoogleCalendar.MoveEvent(Token, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gcalendar MoveEvent --token %token% --from %from% --to %to% --event %event% - - -``` - - -```json title="Result" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Image2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Image1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T16:20:49+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T17:20:49+03:00" - }, - "iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com", - "description": "TestEventDescription", - "updated": "2024-02-24T10:20:51.234Z", - "created": "2024-02-24T10:20:49.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ", - "location": "InOffice", - "summary": "New event", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "f9kkj2omsqtt67g12qh2jig8uk", - "etag": "\"3417540102468000\"", - "kind": "calendar#event" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Response = OPI_GoogleCalendar.MoveEvent(Token, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gcalendar MoveEvent --token %token% --from %from% --to %to% --event %event% + + +``` + + +```json title="Result" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Image2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Image1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T16:20:49+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T17:20:49+03:00" + }, + "iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com", + "description": "TestEventDescription", + "updated": "2024-02-24T10:20:51.234Z", + "created": "2024-02-24T10:20:49.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ", + "location": "InOffice", + "summary": "New event", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "f9kkj2omsqtt67g12qh2jig8uk", + "etag": "\"3417540102468000\"", + "kind": "calendar#event" + } + +``` diff --git a/docs/en/md/Google_Calendar/Event-management/_category_.json b/docs/en/md/Google_Calendar/Event-management/_category_.json index f0af283070..710b6dcaee 100644 --- a/docs/en/md/Google_Calendar/Event-management/_category_.json +++ b/docs/en/md/Google_Calendar/Event-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Event management", -"position": "4" -} +{ +"label": "Event management", +"position": "4" +} diff --git a/docs/en/md/Google_Calendar/Google_Calendar.md b/docs/en/md/Google_Calendar/Google_Calendar.md index d63e08c021..496ab09c72 100644 --- a/docs/en/md/Google_Calendar/Google_Calendar.md +++ b/docs/en/md/Google_Calendar/Google_Calendar.md @@ -1,98 +1,98 @@ ---- -id: GoogleCalendar -sidebar_class_name: GoogleCalendar ---- - - - -# Google Calendar - -Этот раздел поwithinящен библиотеtoе for work with API Google Kалендаря. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -:::important -If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Drive** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). -::: - -## Getting started - -
- -### Создание проеtoта - -1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт - -![BF](../../static/img/Docs/GoogleCalendar/1.png) - -2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen - -![BF](../../static/img/Docs/GoogleCalendar/2.png) - -3. Inыберите пунtoт External - -![BF](../../static/img/Docs/GoogleCalendar/3.png) - -4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) - -![BF](../../static/img/Docs/GoogleCalendar/4.png) - -5. Nажимайте далее и Save and continue to afterдней intoладtoе - -![BF](../../static/img/Docs/GoogleCalendar/5.png) - -6. Nажмите Publish App - -![BF](../../static/img/Docs/GoogleCalendar/6.png) - -
- -### Nаwithтройtoа OAuth - -1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID - -![BF](../../static/img/Docs/GoogleCalendar/7.png) - -2. Ininедите имя и inыберите Application type - Desktop app - -![BF](../../static/img/Docs/GoogleCalendar/8.png) - -3. Сохраните ClientID и Client Secret - -![BF](../../static/img/Docs/GoogleCalendar/9.png) - -
- -### Intoлючение withерinиwithа Google Calendar - -1. Перейдите to [page Kалендаря in Marketplace](https://console.cloud.google.com/marketplace/product/google/calendar-json.googleapis.com) - -2. Nажмите Enable - -![BF](../../static/img/Docs/GoogleCalendar/12.png) - -
- -### Toлучение Tokenа - -1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google - -![BF](../../static/img/Docs/GoogleCalendar/10.png) - -2. Сtoопируйте toод from URL after аinторfromации - -![BF](../../static/img/Docs/GoogleCalendar/11.png) - -3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) - -```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" - -{ - "token_type": "Bearer", - "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", - "scope": "https://www.googleapis.com/auth/calendar", - "expires_in": 3599, - "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" -} - -``` - -4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. +--- +id: GoogleCalendar +sidebar_class_name: GoogleCalendar +--- + + + +# Google Calendar + +Этот раздел поwithinящен библиотеtoе for work with API Google Kалендаря. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +:::important +If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Drive** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). +::: + +## Getting started + +
+ +### Создание проеtoта + +1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт + +![BF](../../static/img/Docs/GoogleCalendar/1.png) + +2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen + +![BF](../../static/img/Docs/GoogleCalendar/2.png) + +3. Inыберите пунtoт External + +![BF](../../static/img/Docs/GoogleCalendar/3.png) + +4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) + +![BF](../../static/img/Docs/GoogleCalendar/4.png) + +5. Nажимайте далее и Save and continue to afterдней intoладtoе + +![BF](../../static/img/Docs/GoogleCalendar/5.png) + +6. Nажмите Publish App + +![BF](../../static/img/Docs/GoogleCalendar/6.png) + +
+ +### Nаwithтройtoа OAuth + +1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID + +![BF](../../static/img/Docs/GoogleCalendar/7.png) + +2. Ininедите имя и inыберите Application type - Desktop app + +![BF](../../static/img/Docs/GoogleCalendar/8.png) + +3. Сохраните ClientID и Client Secret + +![BF](../../static/img/Docs/GoogleCalendar/9.png) + +
+ +### Intoлючение withерinиwithа Google Calendar + +1. Перейдите to [page Kалендаря in Marketplace](https://console.cloud.google.com/marketplace/product/google/calendar-json.googleapis.com) + +2. Nажмите Enable + +![BF](../../static/img/Docs/GoogleCalendar/12.png) + +
+ +### Toлучение Tokenа + +1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google + +![BF](../../static/img/Docs/GoogleCalendar/10.png) + +2. Сtoопируйте toод from URL after аinторfromации + +![BF](../../static/img/Docs/GoogleCalendar/11.png) + +3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) + +```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" + +{ + "token_type": "Bearer", + "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", + "scope": "https://www.googleapis.com/auth/calendar", + "expires_in": 3599, + "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" +} + +``` + +4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. diff --git a/docs/en/md/Google_Calendar/_category_.json b/docs/en/md/Google_Calendar/_category_.json index d494a98440..6eaa1215be 100644 --- a/docs/en/md/Google_Calendar/_category_.json +++ b/docs/en/md/Google_Calendar/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Google Calendar", - "position": 7, - "link": { - "type": "doc", - "id": "GoogleCalendar" - } -} +{ + "label": "Google Calendar", + "position": 7, + "link": { + "type": "doc", + "id": "GoogleCalendar" + } +} diff --git a/docs/en/md/Google_Drive/Comment-management/Create-comment.md b/docs/en/md/Google_Drive/Comment-management/Create-comment.md index adf24ffe62..7bcd3fb2ad 100644 --- a/docs/en/md/Google_Drive/Comment-management/Create-comment.md +++ b/docs/en/md/Google_Drive/Comment-management/Create-comment.md @@ -1,60 +1,60 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the object that needs a comment | - | Comment | --text | String | Comment text | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Identifier = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; - Comment = "NewComment"; - - Response = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive CreateComment --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text% - - -``` - - -```json title="Result" - -{ - "content": "NewComment", - "htmlContent": "NewComment", - "author": { - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - }, - "replies": [], - "modifiedTime": "2024-03-17T12:53:45.469Z", - "createdTime": "2024-03-17T12:53:45.469Z", - "kind": "drive#comment", - "deleted": false, - "id": "AAABI3NNNAY" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the object that needs a comment | + | Comment | --text | String | Comment text | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Identifier = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; + Comment = "NewComment"; + + Response = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive CreateComment --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text% + + +``` + + +```json title="Result" + +{ + "content": "NewComment", + "htmlContent": "NewComment", + "author": { + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + }, + "replies": [], + "modifiedTime": "2024-03-17T12:53:45.469Z", + "createdTime": "2024-03-17T12:53:45.469Z", + "kind": "drive#comment", + "deleted": false, + "id": "AAABI3NNNAY" + } + +``` diff --git a/docs/en/md/Google_Drive/Comment-management/Delete-comment.md b/docs/en/md/Google_Drive/Comment-management/Delete-comment.md index 67369d71b6..3ca06a8b6e 100644 --- a/docs/en/md/Google_Drive/Comment-management/Delete-comment.md +++ b/docs/en/md/Google_Drive/Comment-management/Delete-comment.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 4 ---- - -# Delete comment - Deletes comment by ID - - -*Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ObjectID | --object | String | Identifier of the file or directory where the comment is located | - | CommentID | --comment | String | Comment identifier | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Response = OPI_GoogleDrive.DeleteComment(Token, Identifier, Comment); //Map - - - -``` - -```sh title="CLI command example" - - oint gdrive DeleteComment --token %token% --object %object% --comment %comment% - - -``` - - -```json title="Result" - -'' - -``` +--- +sidebar_position: 4 +--- + +# Delete comment + Deletes comment by ID + + +*Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ObjectID | --object | String | Identifier of the file or directory where the comment is located | + | CommentID | --comment | String | Comment identifier | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Response = OPI_GoogleDrive.DeleteComment(Token, Identifier, Comment); //Map + + + +``` + +```sh title="CLI command example" + + oint gdrive DeleteComment --token %token% --object %object% --comment %comment% + + +``` + + +```json title="Result" + +'' + +``` 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 index b00047149c..323008dec9 100644 --- a/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md +++ b/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md @@ -1,63 +1,63 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ObjectID | --object | String | Object identifier | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; - - Response = OPI_GoogleDrive.GetCommentList(Token, AndДFile); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive GetCommentList --token %token% --object %object% - - -``` - - -```json title="Result" - -{ - "comments": [ - { - "content": "NewComment", - "htmlContent": "NewComment", - "author": { - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - }, - "replies": [], - "modifiedTime": "2024-03-17T12:53:45.469Z", - "createdTime": "2024-03-17T12:53:45.469Z", - "kind": "drive#comment", - "deleted": false, - "id": "AAABI3NNNAY" - } - ], - "kind": "drive#commentList" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ObjectID | --object | String | Object identifier | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; + + Response = OPI_GoogleDrive.GetCommentList(Token, AndДFile); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive GetCommentList --token %token% --object %object% + + +``` + + +```json title="Result" + +{ + "comments": [ + { + "content": "NewComment", + "htmlContent": "NewComment", + "author": { + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + }, + "replies": [], + "modifiedTime": "2024-03-17T12:53:45.469Z", + "createdTime": "2024-03-17T12:53:45.469Z", + "kind": "drive#comment", + "deleted": false, + "id": "AAABI3NNNAY" + } + ], + "kind": "drive#commentList" + } + +``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment.md b/docs/en/md/Google_Drive/Comment-management/Get-comment.md index 9867d19de8..b843970345 100644 --- a/docs/en/md/Google_Drive/Comment-management/Get-comment.md +++ b/docs/en/md/Google_Drive/Comment-management/Get-comment.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 2 ---- - -# Get comment - Gets comment by ID - - -*Function GetComment(Val Token, Val ObjectID, Val CommentID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ObjectID | --object | String | Identifier of the file or directory where the comment is located | - | CommentID | --comment | String | Comment identifier | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; - CommentID = AAABI3NNNAY; - - Response = OPI_GoogleDrive.GetComment(Token, AndДFile, CommentID); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive GetComment --token %token% --object %object% --comment "AAABI3NNNAY" - - -``` - - -```json title="Result" - -{ - "content": "NewComment", - "htmlContent": "NewComment", - "author": { - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - }, - "replies": [], - "modifiedTime": "2024-03-17T12:53:45.469Z", - "createdTime": "2024-03-17T12:53:45.469Z", - "kind": "drive#comment", - "deleted": false, - "id": "AAABI3NNNAY" - } - -``` +--- +sidebar_position: 2 +--- + +# Get comment + Gets comment by ID + + +*Function GetComment(Val Token, Val ObjectID, Val CommentID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ObjectID | --object | String | Identifier of the file or directory where the comment is located | + | CommentID | --comment | String | Comment identifier | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; + CommentID = AAABI3NNNAY; + + Response = OPI_GoogleDrive.GetComment(Token, AndДFile, CommentID); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive GetComment --token %token% --object %object% --comment "AAABI3NNNAY" + + +``` + + +```json title="Result" + +{ + "content": "NewComment", + "htmlContent": "NewComment", + "author": { + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + }, + "replies": [], + "modifiedTime": "2024-03-17T12:53:45.469Z", + "createdTime": "2024-03-17T12:53:45.469Z", + "kind": "drive#comment", + "deleted": false, + "id": "AAABI3NNNAY" + } + +``` diff --git a/docs/en/md/Google_Drive/Comment-management/_category_.json b/docs/en/md/Google_Drive/Comment-management/_category_.json index 22b69679e2..71728ced9f 100644 --- a/docs/en/md/Google_Drive/Comment-management/_category_.json +++ b/docs/en/md/Google_Drive/Comment-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Comment management", -"position": "3" -} +{ +"label": "Comment management", +"position": "3" +} 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 index 5a2228f93a..278e7a545e 100644 --- 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 @@ -1,52 +1,52 @@ ---- -sidebar_position: 7 ---- - -# Copy object - Copies file or directory - - -*Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Object identifier | - | NewName | --title | String | New object name | - | NewParent | --catalog | String | New parent directory | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - NewName = "CopiedFile.jpeg"; - NewLocation = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; - Identifier = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk"; - - Response = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewLocation) //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive CopyObject --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "CopiedFile.jpeg" --catalog %catalog% - - -``` - - -```json title="Result" - -{ - "mimeType": "image/jpeg", - "name": "CopiedFile.jpeg", - "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 7 +--- + +# Copy object + Copies file or directory + + +*Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Object identifier | + | NewName | --title | String | New object name | + | NewParent | --catalog | String | New parent directory | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + NewName = "CopiedFile.jpeg"; + NewLocation = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; + Identifier = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk"; + + Response = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewLocation) //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive CopyObject --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "CopiedFile.jpeg" --catalog %catalog% + + +``` + + +```json title="Result" + +{ + "mimeType": "image/jpeg", + "name": "CopiedFile.jpeg", + "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", + "kind": "drive#file" + } + +``` 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 index 8eedc05d51..4f453ff236 100644 --- 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 @@ -1,49 +1,49 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Name | --title | String | Folder name | - | Parent | --catalog | String | Parent | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Name = "TestFolder"; - - Response = OPI_GoogleDrive.CreateFolder(Token, Name); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive CreateFolder --token %token% --title "TestFolder" --catalog %catalog% - - -``` - - -```json title="Result" - -{ - "mimeType": "application/vnd.google-apps.folder", - "name": "TestFolder", - "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", - "kind": "drive#file" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Name | --title | String | Folder name | + | Parent | --catalog | String | Parent | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Name = "TestFolder"; + + Response = OPI_GoogleDrive.CreateFolder(Token, Name); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive CreateFolder --token %token% --title "TestFolder" --catalog %catalog% + + +``` + + +```json title="Result" + +{ + "mimeType": "application/vnd.google-apps.folder", + "name": "TestFolder", + "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", + "kind": "drive#file" + } + +``` 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 index 499813696e..158d43d507 100644 --- 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 @@ -1,42 +1,42 @@ ---- -sidebar_position: 9 ---- - -# Delete object - Deletes file or directory by ID - - -*Function DeleteObject(Val Token, Val Identifier) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the object to delete | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Response = OPI_GoogleDrive.DeleteObject(Token, Identifier); //Map - - - -``` - -```sh title="CLI command example" - - oint gdrive DeleteObject --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" - - -``` - - -```json title="Result" - -'' - -``` +--- +sidebar_position: 9 +--- + +# Delete object + Deletes file or directory by ID + + +*Function DeleteObject(Val Token, Val Identifier) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the object to delete | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Response = OPI_GoogleDrive.DeleteObject(Token, Identifier); //Map + + + +``` + +```sh title="CLI command example" + + oint gdrive DeleteObject --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" + + +``` + + +```json title="Result" + +'' + +``` 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 index 90de3de9bb..640f0444fe 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 6 ---- - -# Download file - Gets file by ID - - -*Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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" - - - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Response = OPI_GoogleDrive.DownloadFile(Token, Identifier); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive DownloadFile --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out% - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 6 +--- + +# Download file + Gets file by ID + + +*Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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" + + + Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Response = OPI_GoogleDrive.DownloadFile(Token, Identifier); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive DownloadFile --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out% + + +``` + + +```json title="Result" + + + +``` 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 index fb0f8370ca..c20721e0a9 100644 --- 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 @@ -1,148 +1,148 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | NameContains | --querry | String | Filter by name | - | Detailed | --depth | Boolean | Adds a list of files to the directory fields | - - - Returns: Key-Value Pair - Array of directory mappings - -```bsl title="Code example" - - - Name = "Description"; - Response = OPI_GoogleDrive.GetDirectoriesList(Token, Name, False); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive GetDirectoriesList --token %token% --querry %querry% --depth %depth% - - -``` - - -```json title="Result" - -[ - { - "linkShareMetadata": { - "securityUpdateEnabled": true, - "securityUpdateEligible": false - }, - "modifiedByMe": true, - "quotaBytesUsed": "0", - "viewedByMeTime": "2024-03-13T06:02:50.470Z", - "createdTime": "2024-03-13T06:02:50.470Z", - "permissionIds": [ - "07468399490707249352" - ], - "modifiedByMeTime": "2024-03-13T06:02:50.470Z", - "explicitlyTrashed": false, - "trashed": true, - "id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", - "starred": false, - "name": "MovesDescription", - "permissions": [ - { - "pendingOwner": false, - "role": "owner", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "kind": "drive#permission", - "type": "user", - "deleted": false, - "displayName": "Anton Titovets", - "id": "07468399490707249352" - } - ], - "spaces": [ - "drive" - ], - "webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", - "isAppAuthorized": false, - "owners": [ - { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - } - ], - "version": "2", - "lastModifyingUser": { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - }, - "shared": false, - "hasThumbnail": false, - "parents": [ - "1PAFI1-rThB46uix012xmLQ01h-JARjaz" - ], - "ownedByMe": true, - "mimeType": "application/vnd.google-apps.folder", - "viewersCanCopyContent": true, - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "viewedByMe": true, - "writersCanShare": true, - "folderColorRgb": "#8f8f8f", - "copyRequiresWriterPermission": false, - "capabilities": { - "canRemoveContentRestriction": false, - "canModifyOwnerContentRestriction": false, - "canModifyLabels": false, - "canAcceptOwnership": false, - "canChangeSecurityUpdateEnabled": false, - "canMoveItemWithinDrive": true, - "canRemoveMyDriveParent": true, - "canReadLabels": false, - "canAddMyDriveParent": false, - "canShare": true, - "canModifyContent": true, - "canUntrash": true, - "canMoveItemOutOfDrive": false, - "canMoveItemIntoTeamDrive": false, - "canModifyContentRestriction": false, - "canReadRevisions": false, - "canTrash": true, - "canRemoveChildren": true, - "canListChildren": true, - "canDownload": true, - "canDelete": true, - "canRename": true, - "canChangeCopyRequiresWriterPermission": false, - "canAddChildren": true, - "canComment": true, - "canModifyEditorContentRestriction": false, - "canMoveChildrenWithinDrive": true, - "canCopy": false, - "canChangeViewersCanCopyContent": false, - "canEdit": true - }, - "modifiedTime": "2024-03-13T06:02:50.470Z", - "thumbnailVersion": "0", - "kind": "drive#file" - } - ] - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | NameContains | --querry | String | Filter by name | + | Detailed | --depth | Boolean | Adds a list of files to the directory fields | + + + Returns: Key-Value Pair - Array of directory mappings + +```bsl title="Code example" + + + Name = "Description"; + Response = OPI_GoogleDrive.GetDirectoriesList(Token, Name, False); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive GetDirectoriesList --token %token% --querry %querry% --depth %depth% + + +``` + + +```json title="Result" + +[ + { + "linkShareMetadata": { + "securityUpdateEnabled": true, + "securityUpdateEligible": false + }, + "modifiedByMe": true, + "quotaBytesUsed": "0", + "viewedByMeTime": "2024-03-13T06:02:50.470Z", + "createdTime": "2024-03-13T06:02:50.470Z", + "permissionIds": [ + "07468399490707249352" + ], + "modifiedByMeTime": "2024-03-13T06:02:50.470Z", + "explicitlyTrashed": false, + "trashed": true, + "id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", + "starred": false, + "name": "MovesDescription", + "permissions": [ + { + "pendingOwner": false, + "role": "owner", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "kind": "drive#permission", + "type": "user", + "deleted": false, + "displayName": "Anton Titovets", + "id": "07468399490707249352" + } + ], + "spaces": [ + "drive" + ], + "webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", + "isAppAuthorized": false, + "owners": [ + { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + } + ], + "version": "2", + "lastModifyingUser": { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + }, + "shared": false, + "hasThumbnail": false, + "parents": [ + "1PAFI1-rThB46uix012xmLQ01h-JARjaz" + ], + "ownedByMe": true, + "mimeType": "application/vnd.google-apps.folder", + "viewersCanCopyContent": true, + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "viewedByMe": true, + "writersCanShare": true, + "folderColorRgb": "#8f8f8f", + "copyRequiresWriterPermission": false, + "capabilities": { + "canRemoveContentRestriction": false, + "canModifyOwnerContentRestriction": false, + "canModifyLabels": false, + "canAcceptOwnership": false, + "canChangeSecurityUpdateEnabled": false, + "canMoveItemWithinDrive": true, + "canRemoveMyDriveParent": true, + "canReadLabels": false, + "canAddMyDriveParent": false, + "canShare": true, + "canModifyContent": true, + "canUntrash": true, + "canMoveItemOutOfDrive": false, + "canMoveItemIntoTeamDrive": false, + "canModifyContentRestriction": false, + "canReadRevisions": false, + "canTrash": true, + "canRemoveChildren": true, + "canListChildren": true, + "canDownload": true, + "canDelete": true, + "canRename": true, + "canChangeCopyRequiresWriterPermission": false, + "canAddChildren": true, + "canComment": true, + "canModifyEditorContentRestriction": false, + "canMoveChildrenWithinDrive": true, + "canCopy": false, + "canChangeViewersCanCopyContent": false, + "canEdit": true + }, + "modifiedTime": "2024-03-13T06:02:50.470Z", + "thumbnailVersion": "0", + "kind": "drive#file" + } + ] + +``` 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 index 3a635410a1..bb1aaff6d2 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 10 ---- - -# Get description file - - - -*Function GetFileDescription() Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - - - Returns: Key-Value Pair - File description - -```bsl title="Code example" - - - Description = New Map; - Description.Insert("MIME", "image/jpeg"); // MIME-type uploading file - Description.Insert("Name", "New file.jpg"); // File name with extension - Description.Insert("Description", "This is a new file"); // File description - Description.Insert("Parent", "root"); // ID directory upload or "root" for upload in root - - Return Description; - - - -``` - -```sh title="CLI command example" - - oint gdrive GetFileDescription - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 10 +--- + +# Get description file + + + +*Function GetFileDescription() Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + + + Returns: Key-Value Pair - File description + +```bsl title="Code example" + + + Description = New Map; + Description.Insert("MIME", "image/jpeg"); // MIME-type uploading file + Description.Insert("Name", "New file.jpg"); // File name with extension + Description.Insert("Description", "This is a new file"); // File description + Description.Insert("Parent", "root"); // ID directory upload or "root" for upload in root + + Return Description; + + + +``` + +```sh title="CLI command example" + + oint gdrive GetFileDescription + + +``` + + +```json title="Result" + + + +``` 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 index d3eb3ab780..05aaa77000 100644 --- 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 @@ -1,177 +1,177 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | NameContains | --querry | String | Filter by name | - | Directory | --catalog | String | Filter by parent directory ID | - - - Returns: Key-Value Pair - Array of file mappings - -```bsl title="Code example" - - - Directory = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; - Response = OPI_GoogleDrive.GetFilesList(Token,, Directory); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive GetFilesList --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" - - -``` - - -```json title="Result" - -[ - { - "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", - "linkShareMetadata": { - "securityUpdateEnabled": true, - "securityUpdateEligible": false - }, - "imageMediaMetadata": { - "exposureBias": 0, - "focalLength": 5.2, - "exposureTime": 0.00125, - "cameraMake": "SONY", - "isoSpeed": 100, - "time": "2012:08:03 08:21:50", - "width": 3264, - "cameraModel": "DSC-H7", - "whiteBalance": "Auto", - "colorSpace": "sRGB", - "aperture": 5.6, - "exposureMode": "Auto", - "rotation": 0, - "height": 2448, - "meteringMode": "Pattern", - "maxApertureValue": 2.875, - "flashUsed": true - }, - "modifiedByMe": true, - "thumbnailVersion": "1", - "fullFileExtension": "jpg", - "quotaBytesUsed": "2114025", - "viewedByMeTime": "2024-03-17T08:09:01.753Z", - "permissionIds": [ - "07468399490707249352" - ], - "modifiedByMeTime": "2024-03-17T08:05:59.327Z", - "explicitlyTrashed": false, - "trashed": false, - "description": "This is a new file", - "createdTime": "2024-03-17T08:05:59.327Z", - "id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD", - "starred": false, - "spaces": [ - "drive" - ], - "name": "New file.jpg", - "permissions": [ - { - "pendingOwner": false, - "role": "owner", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "kind": "drive#permission", - "type": "user", - "deleted": false, - "displayName": "Anton Titovets", - "id": "07468399490707249352" - } - ], - "webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download", - "isAppAuthorized": true, - "webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk", - "version": "4", - "owners": [ - { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - } - ], - "lastModifyingUser": { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Anton Titovets" - }, - "hasThumbnail": true, - "shared": false, - "ownedByMe": true, - "parents": [ - "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" - ], - "sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2", - "viewedByMe": true, - "headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ", - "writersCanShare": true, - "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220", - "modifiedTime": "2024-03-17T08:05:59.327Z", - "capabilities": { - "canRemoveContentRestriction": false, - "canModifyOwnerContentRestriction": true, - "canModifyLabels": false, - "canAcceptOwnership": false, - "canChangeSecurityUpdateEnabled": false, - "canMoveItemWithinDrive": true, - "canRemoveMyDriveParent": true, - "canReadLabels": false, - "canAddMyDriveParent": false, - "canShare": true, - "canModifyContent": true, - "canUntrash": true, - "canMoveItemOutOfDrive": true, - "canMoveItemIntoTeamDrive": true, - "canModifyContentRestriction": true, - "canReadRevisions": true, - "canTrash": true, - "canRemoveChildren": false, - "canListChildren": false, - "canDownload": true, - "canDelete": true, - "canRename": true, - "canChangeCopyRequiresWriterPermission": true, - "canAddChildren": false, - "canComment": true, - "canModifyEditorContentRestriction": true, - "canMoveChildrenWithinDrive": false, - "canCopy": true, - "canChangeViewersCanCopyContent": true, - "canEdit": true - }, - "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", - "copyRequiresWriterPermission": false, - "fileExtension": "jpg", - "originalFilename": "New file.jpg", - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", - "viewersCanCopyContent": true, - "mimeType": "image/jpeg", - "kind": "drive#file", - "size": "2114025" - } - ] - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | NameContains | --querry | String | Filter by name | + | Directory | --catalog | String | Filter by parent directory ID | + + + Returns: Key-Value Pair - Array of file mappings + +```bsl title="Code example" + + + Directory = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; + Response = OPI_GoogleDrive.GetFilesList(Token,, Directory); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive GetFilesList --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" + + +``` + + +```json title="Result" + +[ + { + "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", + "linkShareMetadata": { + "securityUpdateEnabled": true, + "securityUpdateEligible": false + }, + "imageMediaMetadata": { + "exposureBias": 0, + "focalLength": 5.2, + "exposureTime": 0.00125, + "cameraMake": "SONY", + "isoSpeed": 100, + "time": "2012:08:03 08:21:50", + "width": 3264, + "cameraModel": "DSC-H7", + "whiteBalance": "Auto", + "colorSpace": "sRGB", + "aperture": 5.6, + "exposureMode": "Auto", + "rotation": 0, + "height": 2448, + "meteringMode": "Pattern", + "maxApertureValue": 2.875, + "flashUsed": true + }, + "modifiedByMe": true, + "thumbnailVersion": "1", + "fullFileExtension": "jpg", + "quotaBytesUsed": "2114025", + "viewedByMeTime": "2024-03-17T08:09:01.753Z", + "permissionIds": [ + "07468399490707249352" + ], + "modifiedByMeTime": "2024-03-17T08:05:59.327Z", + "explicitlyTrashed": false, + "trashed": false, + "description": "This is a new file", + "createdTime": "2024-03-17T08:05:59.327Z", + "id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD", + "starred": false, + "spaces": [ + "drive" + ], + "name": "New file.jpg", + "permissions": [ + { + "pendingOwner": false, + "role": "owner", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "kind": "drive#permission", + "type": "user", + "deleted": false, + "displayName": "Anton Titovets", + "id": "07468399490707249352" + } + ], + "webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download", + "isAppAuthorized": true, + "webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk", + "version": "4", + "owners": [ + { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + } + ], + "lastModifyingUser": { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Anton Titovets" + }, + "hasThumbnail": true, + "shared": false, + "ownedByMe": true, + "parents": [ + "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" + ], + "sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2", + "viewedByMe": true, + "headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ", + "writersCanShare": true, + "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220", + "modifiedTime": "2024-03-17T08:05:59.327Z", + "capabilities": { + "canRemoveContentRestriction": false, + "canModifyOwnerContentRestriction": true, + "canModifyLabels": false, + "canAcceptOwnership": false, + "canChangeSecurityUpdateEnabled": false, + "canMoveItemWithinDrive": true, + "canRemoveMyDriveParent": true, + "canReadLabels": false, + "canAddMyDriveParent": false, + "canShare": true, + "canModifyContent": true, + "canUntrash": true, + "canMoveItemOutOfDrive": true, + "canMoveItemIntoTeamDrive": true, + "canModifyContentRestriction": true, + "canReadRevisions": true, + "canTrash": true, + "canRemoveChildren": false, + "canListChildren": false, + "canDownload": true, + "canDelete": true, + "canRename": true, + "canChangeCopyRequiresWriterPermission": true, + "canAddChildren": false, + "canComment": true, + "canModifyEditorContentRestriction": true, + "canMoveChildrenWithinDrive": false, + "canCopy": true, + "canChangeViewersCanCopyContent": true, + "canEdit": true + }, + "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", + "copyRequiresWriterPermission": false, + "fileExtension": "jpg", + "originalFilename": "New file.jpg", + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", + "viewersCanCopyContent": true, + "mimeType": "image/jpeg", + "kind": "drive#file", + "size": "2114025" + } + ] + +``` 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 index 7eaafd49fd..adc55bc8fd 100644 --- 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 @@ -1,146 +1,146 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --object | String | Identifier of the file or folder | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Response = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive GetObjectInformation --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" - - -``` - - -```json title="Result" - -{ - "linkShareMetadata": { - "securityUpdateEnabled": true, - "securityUpdateEligible": false - }, - "quotaBytesUsed": "0", - "folderColorRgb": "#8f8f8f", - "writersCanShare": true, - "lastModifyingUser": { - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "displayName": "Anton Titovets", - "kind": "drive#user" - }, - "modifiedByMe": true, - "capabilities": { - "canUntrash": true, - "canTrash": true, - "canRemoveMyDriveParent": true, - "canRemoveContentRestriction": false, - "canRemoveChildren": true, - "canMoveItemWithinDrive": true, - "canMoveItemOutOfDrive": true, - "canMoveItemIntoTeamDrive": true, - "canModifyLabels": false, - "canModifyOwnerContentRestriction": false, - "canReadRevisions": false, - "canModifyContentRestriction": false, - "canShare": true, - "canModifyContent": true, - "canDownload": true, - "canMoveChildrenWithinDrive": true, - "canCopy": false, - "canModifyEditorContentRestriction": false, - "canChangeSecurityUpdateEnabled": false, - "canRename": true, - "canChangeCopyRequiresWriterPermission": false, - "canDelete": true, - "canChangeViewersCanCopyContent": false, - "canEdit": true, - "canReadLabels": false, - "canAddMyDriveParent": false, - "canComment": true, - "canAddChildren": true, - "canListChildren": true, - "canAcceptOwnership": false - }, - "copyRequiresWriterPermission": false, - "modifiedTime": "2023-12-28T13:22:03.333Z", - "createdTime": "2023-12-28T13:22:00.683Z", - "viewedByMeTime": "2023-12-28T13:22:00.683Z", - "viewedByMe": true, - "shared": false, - "hasThumbnail": false, - "version": "3", - "owners": [ - { - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "displayName": "Anton Titovets", - "kind": "drive#user" - } - ], - "isAppAuthorized": false, - "webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm", - "spaces": [ - "drive" - ], - "modifiedByMeTime": "2023-12-28T13:22:03.333Z", - "permissionIds": [ - "07468399490707249352" - ], - "explicitlyTrashed": false, - "parents": [ - "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ" - ], - "ownedByMe": true, - "trashed": false, - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "viewersCanCopyContent": true, - "mimeType": "application/vnd.google-apps.folder", - "permissions": [ - { - "pendingOwner": false, - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "role": "owner", - "emailAddress": "bayselonarrend@gmail.com", - "type": "user", - "deleted": false, - "displayName": "Anton Titovets", - "id": "07468399490707249352", - "kind": "drive#permission" - } - ], - "name": "OPI", - "starred": false, - "id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa", - "kind": "drive#file", - "thumbnailVersion": "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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --object | String | Identifier of the file or folder | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Response = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive GetObjectInformation --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" + + +``` + + +```json title="Result" + +{ + "linkShareMetadata": { + "securityUpdateEnabled": true, + "securityUpdateEligible": false + }, + "quotaBytesUsed": "0", + "folderColorRgb": "#8f8f8f", + "writersCanShare": true, + "lastModifyingUser": { + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "displayName": "Anton Titovets", + "kind": "drive#user" + }, + "modifiedByMe": true, + "capabilities": { + "canUntrash": true, + "canTrash": true, + "canRemoveMyDriveParent": true, + "canRemoveContentRestriction": false, + "canRemoveChildren": true, + "canMoveItemWithinDrive": true, + "canMoveItemOutOfDrive": true, + "canMoveItemIntoTeamDrive": true, + "canModifyLabels": false, + "canModifyOwnerContentRestriction": false, + "canReadRevisions": false, + "canModifyContentRestriction": false, + "canShare": true, + "canModifyContent": true, + "canDownload": true, + "canMoveChildrenWithinDrive": true, + "canCopy": false, + "canModifyEditorContentRestriction": false, + "canChangeSecurityUpdateEnabled": false, + "canRename": true, + "canChangeCopyRequiresWriterPermission": false, + "canDelete": true, + "canChangeViewersCanCopyContent": false, + "canEdit": true, + "canReadLabels": false, + "canAddMyDriveParent": false, + "canComment": true, + "canAddChildren": true, + "canListChildren": true, + "canAcceptOwnership": false + }, + "copyRequiresWriterPermission": false, + "modifiedTime": "2023-12-28T13:22:03.333Z", + "createdTime": "2023-12-28T13:22:00.683Z", + "viewedByMeTime": "2023-12-28T13:22:00.683Z", + "viewedByMe": true, + "shared": false, + "hasThumbnail": false, + "version": "3", + "owners": [ + { + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "displayName": "Anton Titovets", + "kind": "drive#user" + } + ], + "isAppAuthorized": false, + "webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm", + "spaces": [ + "drive" + ], + "modifiedByMeTime": "2023-12-28T13:22:03.333Z", + "permissionIds": [ + "07468399490707249352" + ], + "explicitlyTrashed": false, + "parents": [ + "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ" + ], + "ownedByMe": true, + "trashed": false, + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "viewersCanCopyContent": true, + "mimeType": "application/vnd.google-apps.folder", + "permissions": [ + { + "pendingOwner": false, + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "role": "owner", + "emailAddress": "bayselonarrend@gmail.com", + "type": "user", + "deleted": false, + "displayName": "Anton Titovets", + "id": "07468399490707249352", + "kind": "drive#permission" + } + ], + "name": "OPI", + "starred": false, + "id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa", + "kind": "drive#file", + "thumbnailVersion": "0" + } + +``` 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 index d46027b2df..e7e341aaa4 100644 --- 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 @@ -1,52 +1,52 @@ ---- -sidebar_position: 8 ---- - -# Update file - Updates file binary data - - -*Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - NewName = "Updated file.jpeg"; - ReplacementImage = "C:\OPI\image2.jpg"; - Identifier = "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ"; - - Response = OPI_GoogleDrive.UpdateFile(Token, Identifier, ReplacementImage, NewName) //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive UpdateFile --token %token% --object "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ" --file %file% --title "Updated file.jpeg" - - -``` - - -```json title="Result" - -{ - "mimeType": "image/jpeg", - "name": "UpdatedFile.jpg", - "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 8 +--- + +# Update file + Updates file binary data + + +*Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + NewName = "Updated file.jpeg"; + ReplacementImage = "C:\OPI\image2.jpg"; + Identifier = "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ"; + + Response = OPI_GoogleDrive.UpdateFile(Token, Identifier, ReplacementImage, NewName) //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive UpdateFile --token %token% --object "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ" --file %file% --title "Updated file.jpeg" + + +``` + + +```json title="Result" + +{ + "mimeType": "image/jpeg", + "name": "UpdatedFile.jpg", + "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", + "kind": "drive#file" + } + +``` 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 index 987f529ade..59eb0ebe3d 100644 --- 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 @@ -1,55 +1,55 @@ ---- -sidebar_position: 4 ---- - -# Upload file - Uploads a file to the drive - - -*Function UploadFile(Val Token, Val File, Val Description) ExportReturn FileManagement(Token, File, Description);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | File | --file | BinaryData,String | File to be uploaded | - | Description | --props | Key-Value Pair | JSON description or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Description = New Map; - Description.Insert("MIME", "image/jpeg"); - Description.Insert("Name", "New file.jpg"); - Description.Insert("Description", "This is a new file"); - Description.Insert("Parent", "root"); - - Image = "C:\OPI\image.jpg"; - - Response = OPI_GoogleDrive.UploadFile(Token, Image, Description); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint gdrive UploadFile --token %token% --file %file% --props %props% - - -``` - - -```json title="Result" - -{ - "mimeType": "image/jpeg", - "name": "New file.jpg", - "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 4 +--- + +# Upload file + Uploads a file to the drive + + +*Function UploadFile(Val Token, Val File, Val Description) ExportReturn FileManagement(Token, File, Description);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | File | --file | BinaryData,String | File to be uploaded | + | Description | --props | Key-Value Pair | JSON description or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Description = New Map; + Description.Insert("MIME", "image/jpeg"); + Description.Insert("Name", "New file.jpg"); + Description.Insert("Description", "This is a new file"); + Description.Insert("Parent", "root"); + + Image = "C:\OPI\image.jpg"; + + Response = OPI_GoogleDrive.UploadFile(Token, Image, Description); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint gdrive UploadFile --token %token% --file %file% --props %props% + + +``` + + +```json title="Result" + +{ + "mimeType": "image/jpeg", + "name": "New file.jpg", + "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", + "kind": "drive#file" + } + +``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/_category_.json b/docs/en/md/Google_Drive/File-and-directory-management/_category_.json index 4356ad44f3..2e365e5413 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/_category_.json +++ b/docs/en/md/Google_Drive/File-and-directory-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "File and directory management", -"position": "2" -} +{ +"label": "File and directory management", +"position": "2" +} diff --git a/docs/en/md/Google_Drive/Google_Drive.md b/docs/en/md/Google_Drive/Google_Drive.md index 766c11538e..a174f4997d 100644 --- a/docs/en/md/Google_Drive/Google_Drive.md +++ b/docs/en/md/Google_Drive/Google_Drive.md @@ -1,98 +1,98 @@ ---- -id: GoogleDrive -sidebar_class_name: GoogleDrive ---- - - - -# Google Drive - -Этот раздел поwithinящен библиотеtoе for work with API Google Drive. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -:::important -If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Drive** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). -::: - -## Getting started - -
- -### Создание проеtoта - -1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт - -![BF](../../static/img/Docs/GoogleCalendar/1.png) - -2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen - -![BF](../../static/img/Docs/GoogleCalendar/2.png) - -3. Inыберите пунtoт External - -![BF](../../static/img/Docs/GoogleCalendar/3.png) - -4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) - -![BF](../../static/img/Docs/GoogleCalendar/4.png) - -5. Nажимайте далее и Save and continue to afterдней intoладtoе - -![BF](../../static/img/Docs/GoogleCalendar/5.png) - -6. Nажмите Publish App - -![BF](../../static/img/Docs/GoogleCalendar/6.png) - -
- -### Nаwithтройtoа OAuth - -1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID - -![BF](../../static/img/Docs/GoogleCalendar/7.png) - -2. Ininедите имя и inыберите Application type - Desktop app - -![BF](../../static/img/Docs/GoogleCalendar/8.png) - -3. Сохраните ClientID и Client Secret - -![BF](../../static/img/Docs/GoogleCalendar/9.png) - -
- -### Intoлючение withерinиwithа Google Drive - -1. Перейдите to [page Drive in Marketplace](https://console.cloud.google.com/marketplace/product/google/drive.googleapis.com) - -2. Nажмите Enable - -![BF](../../static/img/Docs/GoogleDrive/1.png) - -
- -### Toлучение Tokenа - -1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google - -![BF](../../static/img/Docs/GoogleCalendar/10.png) - -2. Сtoопируйте toод from URL after аinторfromации - -![BF](../../static/img/Docs/GoogleCalendar/11.png) - -3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) - -```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" - -{ - "token_type": "Bearer", - "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", - "scope": "https://www.googleapis.com/auth/...", - "expires_in": 3599, - "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" -} - -``` - -4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. +--- +id: GoogleDrive +sidebar_class_name: GoogleDrive +--- + + + +# Google Drive + +Этот раздел поwithinящен библиотеtoе for work with API Google Drive. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +:::important +If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Drive** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). +::: + +## Getting started + +
+ +### Создание проеtoта + +1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт + +![BF](../../static/img/Docs/GoogleCalendar/1.png) + +2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen + +![BF](../../static/img/Docs/GoogleCalendar/2.png) + +3. Inыберите пунtoт External + +![BF](../../static/img/Docs/GoogleCalendar/3.png) + +4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) + +![BF](../../static/img/Docs/GoogleCalendar/4.png) + +5. Nажимайте далее и Save and continue to afterдней intoладtoе + +![BF](../../static/img/Docs/GoogleCalendar/5.png) + +6. Nажмите Publish App + +![BF](../../static/img/Docs/GoogleCalendar/6.png) + +
+ +### Nаwithтройtoа OAuth + +1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID + +![BF](../../static/img/Docs/GoogleCalendar/7.png) + +2. Ininедите имя и inыберите Application type - Desktop app + +![BF](../../static/img/Docs/GoogleCalendar/8.png) + +3. Сохраните ClientID и Client Secret + +![BF](../../static/img/Docs/GoogleCalendar/9.png) + +
+ +### Intoлючение withерinиwithа Google Drive + +1. Перейдите to [page Drive in Marketplace](https://console.cloud.google.com/marketplace/product/google/drive.googleapis.com) + +2. Nажмите Enable + +![BF](../../static/img/Docs/GoogleDrive/1.png) + +
+ +### Toлучение Tokenа + +1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google + +![BF](../../static/img/Docs/GoogleCalendar/10.png) + +2. Сtoопируйте toод from URL after аinторfromации + +![BF](../../static/img/Docs/GoogleCalendar/11.png) + +3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) + +```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" + +{ + "token_type": "Bearer", + "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", + "scope": "https://www.googleapis.com/auth/...", + "expires_in": 3599, + "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" +} + +``` + +4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. diff --git a/docs/en/md/Google_Drive/_category_.json b/docs/en/md/Google_Drive/_category_.json index 3c20e6354d..bf46da9965 100644 --- a/docs/en/md/Google_Drive/_category_.json +++ b/docs/en/md/Google_Drive/_category_.json @@ -1,10 +1,10 @@ - -{ - "label": "Google Drive", - "position": 8, - "link": { - "type": "doc", - "id": "GoogleDrive" - } -} - + +{ + "label": "Google Drive", + "position": 8, + "link": { + "type": "doc", + "id": "GoogleDrive" + } +} + diff --git a/docs/en/md/Google_Sheets/Book-work/Create-book.md b/docs/en/md/Google_Sheets/Book-work/Create-book.md index 123a74b81e..536880a916 100644 --- a/docs/en/md/Google_Sheets/Book-work/Create-book.md +++ b/docs/en/md/Google_Sheets/Book-work/Create-book.md @@ -1,208 +1,208 @@ ---- -sidebar_position: 1 ---- - -# CreateBook - Creates a new book - - -*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Name | --title | String | Name | - | ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - ArrayOfSheetNames = New Array; - ArrayOfSheetNames.Add("Sheet1"); - ArrayOfSheetNames.Add("Sheet2"); - - Name = "TestTable"; - - Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets% - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "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": 1999766427, - "title": "Sheet1", - "index": 0, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - }, - { - "properties": { - "sheetId": 225184494, - "title": "Sheet2", - "index": 1, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - ], - "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" - } - -``` +--- +sidebar_position: 1 +--- + +# CreateBook + Creates a new book + + +*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Name | --title | String | Name | + | ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + ArrayOfSheetNames = New Array; + ArrayOfSheetNames.Add("Sheet1"); + ArrayOfSheetNames.Add("Sheet2"); + + Name = "TestTable"; + + Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets% + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "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": 1999766427, + "title": "Sheet1", + "index": 0, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + }, + { + "properties": { + "sheetId": 225184494, + "title": "Sheet2", + "index": 1, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + ], + "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" + } + +``` diff --git a/docs/en/md/Google_Sheets/Book-work/Edit-book-title.md b/docs/en/md/Google_Sheets/Book-work/Edit-book-title.md index 0fbb8f9e58..c9f59a3ab5 100644 --- a/docs/en/md/Google_Sheets/Book-work/Edit-book-title.md +++ b/docs/en/md/Google_Sheets/Book-work/Edit-book-title.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 3 ---- - -# ChangeBookName - Changes the name of the existing book - - -*Function EditBookTitle(Val Token, Val Book, Val Name) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Book | --spreadsheet | String | BookID | - | Name | --title | String | New name | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Name = "Test table (change.)"; - - Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)" - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "replies": [ - {} - ] - } - -``` +--- +sidebar_position: 3 +--- + +# ChangeBookName + Changes the name of the existing book + + +*Function EditBookTitle(Val Token, Val Book, Val Name) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Book | --spreadsheet | String | BookID | + | Name | --title | String | New name | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Name = "Test table (change.)"; + + Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)" + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "replies": [ + {} + ] + } + +``` diff --git a/docs/en/md/Google_Sheets/Book-work/Get-book.md b/docs/en/md/Google_Sheets/Book-work/Get-book.md index 142e3d5b81..a6631ecc9f 100644 --- a/docs/en/md/Google_Sheets/Book-work/Get-book.md +++ b/docs/en/md/Google_Sheets/Book-work/Get-book.md @@ -1,203 +1,203 @@ ---- -sidebar_position: 2 ---- - -# GetBook - Gets information about the book by ID - - -*Function GetBook(Val Token, Val Identifier) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Identifier | --spreadsheet | String | BookIdentifier | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - - Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "properties": { - "title": "Test table (change.)", - "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": 1999766427, - "title": "Sheet1", - "index": 0, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - }, - { - "properties": { - "sheetId": 225184494, - "title": "Sheet2", - "index": 1, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - ], - "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" - } - -``` +--- +sidebar_position: 2 +--- + +# GetBook + Gets information about the book by ID + + +*Function GetBook(Val Token, Val Identifier) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Identifier | --spreadsheet | String | BookIdentifier | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + + Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "properties": { + "title": "Test table (change.)", + "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": 1999766427, + "title": "Sheet1", + "index": 0, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + }, + { + "properties": { + "sheetId": 225184494, + "title": "Sheet2", + "index": 1, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + ], + "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" + } + +``` diff --git a/docs/en/md/Google_Sheets/Book-work/_category_.json b/docs/en/md/Google_Sheets/Book-work/_category_.json index 69904f3d25..f777fecc4a 100644 --- a/docs/en/md/Google_Sheets/Book-work/_category_.json +++ b/docs/en/md/Google_Sheets/Book-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Book work", -"position": "2" -} +{ +"label": "Book work", +"position": "2" +} diff --git a/docs/en/md/Google_Sheets/Data-work/Clear-cells.md b/docs/en/md/Google_Sheets/Data-work/Clear-cells.md index cb06b7b744..254e8911ff 100644 --- a/docs/en/md/Google_Sheets/Data-work/Clear-cells.md +++ b/docs/en/md/Google_Sheets/Data-work/Clear-cells.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 2 ---- - -# Clear cells - Clears the value in cells - - -*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Book | --spreadsheet | String | BookID | - | CellsArray | --cells | Array of String | Array of cells like A1 to be cleared | - | Sheet | --sheetname | String | Sheet name (first sheet by default) | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - CellsArray = New Array; - CellsArray.Add("B2"); - CellsArray.Add("A3"); - CellsArray.Add("B4"); - - Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Sheet = "Sheet2"; - - Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets ClearCells --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2" - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "clearedRanges": [ - "'Sheet2'!B2", - "'Sheet2'!A3", - "'Sheet2'!B4" - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Clear cells + Clears the value in cells + + +*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Book | --spreadsheet | String | BookID | + | CellsArray | --cells | Array of String | Array of cells like A1 to be cleared | + | Sheet | --sheetname | String | Sheet name (first sheet by default) | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + CellsArray = New Array; + CellsArray.Add("B2"); + CellsArray.Add("A3"); + CellsArray.Add("B4"); + + Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Sheet = "Sheet2"; + + Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets ClearCells --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2" + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "clearedRanges": [ + "'Sheet2'!B2", + "'Sheet2'!A3", + "'Sheet2'!B4" + ] + } + +``` diff --git a/docs/en/md/Google_Sheets/Data-work/Get-cell-values.md b/docs/en/md/Google_Sheets/Data-work/Get-cell-values.md index b61bda08c2..9ce8f84f33 100644 --- a/docs/en/md/Google_Sheets/Data-work/Get-cell-values.md +++ b/docs/en/md/Google_Sheets/Data-work/Get-cell-values.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 3 ---- - -# Get cell values - Gets cell values of the table - - -*Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Book | --spreadsheet | String | BookID | - | 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: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - CellsArray = New Array; - CellsArray.Add("B2"); - CellsArray.Add("A3"); - CellsArray.Add("B4"); - - Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Sheet = "Sheet2"; - - Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets GetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2" - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "valueRanges": [ - { - "range": "'Sheet2'!B2", - "majorDimension": "ROWS", - "values": [ - [ - "ThisIsB2" - ] - ] - }, - { - "range": "'Sheet2'!A3", - "majorDimension": "ROWS", - "values": [ - [ - "ThisIsA3" - ] - ] - }, - { - "range": "'Sheet2'!B4", - "majorDimension": "ROWS", - "values": [ - [ - "ThisIsB4" - ] - ] - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Get cell values + Gets cell values of the table + + +*Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Book | --spreadsheet | String | BookID | + | 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: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + CellsArray = New Array; + CellsArray.Add("B2"); + CellsArray.Add("A3"); + CellsArray.Add("B4"); + + Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Sheet = "Sheet2"; + + Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets GetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2" + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "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-work/Set-cell-values.md b/docs/en/md/Google_Sheets/Data-work/Set-cell-values.md index f60b73b56d..a94e75749d 100644 --- a/docs/en/md/Google_Sheets/Data-work/Set-cell-values.md +++ b/docs/en/md/Google_Sheets/Data-work/Set-cell-values.md @@ -1,121 +1,121 @@ ---- -sidebar_position: 1 ---- - -# SetCellValues - Sets sheet cell values - - -*Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Book | --spreadsheet | String | BookID | - | ValueMapping | --data | Key-Value Pair | 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: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - 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"); - - Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Sheet = "Sheet2"; - - Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets SetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --data %data% --sheetname "Sheet2" --dim %dim% - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "totalUpdatedRows": 4, - "totalUpdatedColumns": 2, - "totalUpdatedCells": 8, - "totalUpdatedSheets": 1, - "responses": [ - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!A1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!A2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!B2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!B3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!A3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!A4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!B1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Sheet2'!B4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# SetCellValues + Sets sheet cell values + + +*Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Book | --spreadsheet | String | BookID | + | ValueMapping | --data | Key-Value Pair | 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: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + 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"); + + Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Sheet = "Sheet2"; + + Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets SetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --data %data% --sheetname "Sheet2" --dim %dim% + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "totalUpdatedRows": 4, + "totalUpdatedColumns": 2, + "totalUpdatedCells": 8, + "totalUpdatedSheets": 1, + "responses": [ + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!A1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!A2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!B2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!B3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!A3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!A4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!B1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Sheet2'!B4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + } + ] + } + +``` diff --git a/docs/en/md/Google_Sheets/Data-work/_category_.json b/docs/en/md/Google_Sheets/Data-work/_category_.json index 5122366380..05202c8271 100644 --- a/docs/en/md/Google_Sheets/Data-work/_category_.json +++ b/docs/en/md/Google_Sheets/Data-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Data work", -"position": "4" -} +{ +"label": "Data work", +"position": "4" +} diff --git a/docs/en/md/Google_Sheets/Google_Sheets.md b/docs/en/md/Google_Sheets/Google_Sheets.md index 34db8efacd..9fd8ea93da 100644 --- a/docs/en/md/Google_Sheets/Google_Sheets.md +++ b/docs/en/md/Google_Sheets/Google_Sheets.md @@ -1,98 +1,98 @@ ---- -id: GoogleSheets -sidebar_class_name: GoogleSheets ---- - - - -# Google Sheets - -Этот раздел поwithinящен библиотеtoе for work with API Google Sheets. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -:::important -If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Sheets** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). -::: - -## Getting started - -
- -### Создание проеtoта - -1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт - -![BF](../../static/img/Docs/GoogleCalendar/1.png) - -2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen - -![BF](../../static/img/Docs/GoogleCalendar/2.png) - -3. Inыберите пунtoт External - -![BF](../../static/img/Docs/GoogleCalendar/3.png) - -4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) - -![BF](../../static/img/Docs/GoogleCalendar/4.png) - -5. Nажимайте далее и Save and continue to afterдней intoладtoе - -![BF](../../static/img/Docs/GoogleCalendar/5.png) - -6. Nажмите Publish App - -![BF](../../static/img/Docs/GoogleCalendar/6.png) - -
- -### Nаwithтройtoа OAuth - -1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID - -![BF](../../static/img/Docs/GoogleCalendar/7.png) - -2. Ininедите имя и inыберите Application type - Desktop app - -![BF](../../static/img/Docs/GoogleCalendar/8.png) - -3. Сохраните ClientID и Client Secret - -![BF](../../static/img/Docs/GoogleCalendar/9.png) - -
- -### Intoлючение withерinиwithа Google Sheets - -1. Перейдите to [page Sheets in Marketplace](https://console.cloud.google.com/marketplace/product/google/sheets.googleapis.com) - -2. Nажмите Enable - -![BF](../../static/img/Docs/GoogleSheets/1.png) - -
- -### Toлучение Tokenа - -1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google - -![BF](../../static/img/Docs/GoogleCalendar/10.png) - -2. Сtoопируйте toод from URL after аinторfromации - -![BF](../../static/img/Docs/GoogleCalendar/11.png) - -3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) - -```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" - -{ - "token_type": "Bearer", - "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", - "scope": "https://www.googleapis.com/auth/...", - "expires_in": 3599, - "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" -} - -``` - -4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. +--- +id: GoogleSheets +sidebar_class_name: GoogleSheets +--- + + + +# Google Sheets + +Этот раздел поwithinящен библиотеtoе for work with API Google Sheets. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +:::important +If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Sheets** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). +::: + +## Getting started + +
+ +### Создание проеtoта + +1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт + +![BF](../../static/img/Docs/GoogleCalendar/1.png) + +2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen + +![BF](../../static/img/Docs/GoogleCalendar/2.png) + +3. Inыберите пунtoт External + +![BF](../../static/img/Docs/GoogleCalendar/3.png) + +4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) + +![BF](../../static/img/Docs/GoogleCalendar/4.png) + +5. Nажимайте далее и Save and continue to afterдней intoладtoе + +![BF](../../static/img/Docs/GoogleCalendar/5.png) + +6. Nажмите Publish App + +![BF](../../static/img/Docs/GoogleCalendar/6.png) + +
+ +### Nаwithтройtoа OAuth + +1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID + +![BF](../../static/img/Docs/GoogleCalendar/7.png) + +2. Ininедите имя и inыберите Application type - Desktop app + +![BF](../../static/img/Docs/GoogleCalendar/8.png) + +3. Сохраните ClientID и Client Secret + +![BF](../../static/img/Docs/GoogleCalendar/9.png) + +
+ +### Intoлючение withерinиwithа Google Sheets + +1. Перейдите to [page Sheets in Marketplace](https://console.cloud.google.com/marketplace/product/google/sheets.googleapis.com) + +2. Nажмите Enable + +![BF](../../static/img/Docs/GoogleSheets/1.png) + +
+ +### Toлучение Tokenа + +1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google + +![BF](../../static/img/Docs/GoogleCalendar/10.png) + +2. Сtoопируйте toод from URL after аinторfromации + +![BF](../../static/img/Docs/GoogleCalendar/11.png) + +3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) + +```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" + +{ + "token_type": "Bearer", + "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", + "scope": "https://www.googleapis.com/auth/...", + "expires_in": 3599, + "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" +} + +``` + +4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. diff --git a/docs/en/md/Google_Sheets/Sheet-work/Add-sheet.md b/docs/en/md/Google_Sheets/Sheet-work/Add-sheet.md index 6846951168..d8aa22327b 100644 --- a/docs/en/md/Google_Sheets/Sheet-work/Add-sheet.md +++ b/docs/en/md/Google_Sheets/Sheet-work/Add-sheet.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 1 ---- - -# AddSheet - Adds a new sheet to the book - - -*Function AddSheet(Val Token, Val Book, Val Name) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Book | --spreadsheet | String | BookIdentifier | - | Name | --title | String | NewSheetName | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Name = "TestSheet"; - - Response = OPI_GoogleSheets.AddSheet(Token, Book, Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets AddSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "TestSheet" - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "replies": [ - { - "addSheet": { - "properties": { - "sheetId": 321892522, - "title": "TestSheet", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# AddSheet + Adds a new sheet to the book + + +*Function AddSheet(Val Token, Val Book, Val Name) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Book | --spreadsheet | String | BookIdentifier | + | Name | --title | String | NewSheetName | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Name = "TestSheet"; + + Response = OPI_GoogleSheets.AddSheet(Token, Book, Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets AddSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "TestSheet" + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "replies": [ + { + "addSheet": { + "properties": { + "sheetId": 321892522, + "title": "TestSheet", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + } + ] + } + +``` diff --git a/docs/en/md/Google_Sheets/Sheet-work/Copy-sheet.md b/docs/en/md/Google_Sheets/Sheet-work/Copy-sheet.md index 46fdc118a3..5587300b47 100644 --- a/docs/en/md/Google_Sheets/Sheet-work/Copy-sheet.md +++ b/docs/en/md/Google_Sheets/Sheet-work/Copy-sheet.md @@ -1,56 +1,56 @@ ---- -sidebar_position: 3 ---- - -# CopySheet - Copies a sheet from one book to another - - -*Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | From | --from | String | SourceBookID | - | Target | --to | String | DestinationBookID | - | Sheet | --sheet | String | CopiedSheetID | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - From = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Target = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; - Sheet = "25093199"; - - Response = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets CopySheet --token %token% --from "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --to "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s" --sheet "25093199" - - -``` - - -```json title="Result" - -{ - "sheetId": 1790807910, - "title": "Sheet2 (copy)", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - -``` +--- +sidebar_position: 3 +--- + +# CopySheet + Copies a sheet from one book to another + + +*Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | From | --from | String | SourceBookID | + | Target | --to | String | DestinationBookID | + | Sheet | --sheet | String | CopiedSheetID | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + From = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Target = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; + Sheet = "25093199"; + + Response = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets CopySheet --token %token% --from "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --to "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s" --sheet "25093199" + + +``` + + +```json title="Result" + +{ + "sheetId": 1790807910, + "title": "Sheet2 (copy)", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + +``` diff --git a/docs/en/md/Google_Sheets/Sheet-work/Delete-sheet.md b/docs/en/md/Google_Sheets/Sheet-work/Delete-sheet.md index ee1f0e7979..03d9730072 100644 --- a/docs/en/md/Google_Sheets/Sheet-work/Delete-sheet.md +++ b/docs/en/md/Google_Sheets/Sheet-work/Delete-sheet.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 2 ---- - -# DeleteSheet - Deletes a sheet from the book - - -*Function DeleteSheet(Val Token, Val Book, Val Sheet) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Book | --spreadsheet | String | BookIdentifier | - | Sheet | --sheet | String | IdentifierOfSheetToDelete | - - - Returns: Key-Value Pair - serialized JSON response from Google - -```bsl title="Code example" - - - Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Sheet = "1790807910"; - - Response = OPI_GoogleSheets.DeleteSheet(Token, Book, Sheet); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint gsheets DeleteSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --sheet "1790807910" - - -``` - - -```json title="Result" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "replies": [ - {} - ] - } - -``` +--- +sidebar_position: 2 +--- + +# DeleteSheet + Deletes a sheet from the book + + +*Function DeleteSheet(Val Token, Val Book, Val Sheet) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Book | --spreadsheet | String | BookIdentifier | + | Sheet | --sheet | String | IdentifierOfSheetToDelete | + + + Returns: Key-Value Pair - serialized JSON response from Google + +```bsl title="Code example" + + + Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Sheet = "1790807910"; + + Response = OPI_GoogleSheets.DeleteSheet(Token, Book, Sheet); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint gsheets DeleteSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --sheet "1790807910" + + +``` + + +```json title="Result" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "replies": [ + {} + ] + } + +``` diff --git a/docs/en/md/Google_Sheets/Sheet-work/_category_.json b/docs/en/md/Google_Sheets/Sheet-work/_category_.json index c7429ad272..f3e17a6938 100644 --- a/docs/en/md/Google_Sheets/Sheet-work/_category_.json +++ b/docs/en/md/Google_Sheets/Sheet-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Sheet work", -"position": "3" -} +{ +"label": "Sheet work", +"position": "3" +} diff --git a/docs/en/md/Google_Sheets/_category_.json b/docs/en/md/Google_Sheets/_category_.json index 16066d757e..add1b245d7 100644 --- a/docs/en/md/Google_Sheets/_category_.json +++ b/docs/en/md/Google_Sheets/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Google Sheets", - "position": 9, - "link": { - "type": "doc", - "id": "GoogleSheets" - } -} +{ + "label": "Google Sheets", + "position": 9, + "link": { + "type": "doc", + "id": "GoogleSheets" + } +} diff --git a/docs/en/md/Notion/Blocks-managment/Create-block.md b/docs/en/md/Notion/Blocks-managment/Create-block.md index 1f42e6a211..b45e3f6e6d 100644 --- a/docs/en/md/Notion/Blocks-managment/Create-block.md +++ b/docs/en/md/Notion/Blocks-managment/Create-block.md @@ -1,102 +1,102 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff9..."; - - Block = OPI_Notion.ReturnBlock(Token, "ca18df269bd24407852b91c30e..."); //Block as map. Can be changed. - - Response = OPI_Notion.CreateBlock(Token, Parent, Block); - Response = OPI_Notion.CreateBlock(Token, Parent, "46c1500ed40c4e89ba6a229003..."); - Response = OPI_Notion.CreateBlock(Token, Parent, "aa4137d4c8cc445d9f969c3968..."); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion CreateBlock --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --block %block% --prev %prev% - - -``` - - -```json title="Result" - -{ - "request_id": "4de46f5b-d38b-4df5-b26e-32127db1096b", - "block": {}, - "type": "block", - "has_more": false, - "next_cursor": null, - "results": [ - { - "type": "numbered_list_item", - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T17:11:00.000Z", - "created_time": "2024-01-26T17:11:00.000Z", - "has_children": false, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "b147fabd-53ea-42d5-bd23-85968f627f88", - "numbered_list_item": { - "color": "default", - "rich_text": [ - { - "plain_text": "Description", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Description" - }, - "href": null, - "type": "text" - } - ] - }, - "object": "block" - } - ], - "object": "list" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff9..."; + + Block = OPI_Notion.ReturnBlock(Token, "ca18df269bd24407852b91c30e..."); //Block as map. Can be changed. + + Response = OPI_Notion.CreateBlock(Token, Parent, Block); + Response = OPI_Notion.CreateBlock(Token, Parent, "46c1500ed40c4e89ba6a229003..."); + Response = OPI_Notion.CreateBlock(Token, Parent, "aa4137d4c8cc445d9f969c3968..."); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion CreateBlock --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --block %block% --prev %prev% + + +``` + + +```json title="Result" + +{ + "request_id": "4de46f5b-d38b-4df5-b26e-32127db1096b", + "block": {}, + "type": "block", + "has_more": false, + "next_cursor": null, + "results": [ + { + "type": "numbered_list_item", + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T17:11:00.000Z", + "created_time": "2024-01-26T17:11:00.000Z", + "has_children": false, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "b147fabd-53ea-42d5-bd23-85968f627f88", + "numbered_list_item": { + "color": "default", + "rich_text": [ + { + "plain_text": "Description", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Description" + }, + "href": null, + "type": "text" + } + ] + }, + "object": "block" + } + ], + "object": "list" + } + +``` diff --git a/docs/en/md/Notion/Blocks-managment/Delete-block.md b/docs/en/md/Notion/Blocks-managment/Delete-block.md index a2ad03c64b..1da464ee55 100644 --- a/docs/en/md/Notion/Blocks-managment/Delete-block.md +++ b/docs/en/md/Notion/Blocks-managment/Delete-block.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 4 ---- - -# Delete block - Deletes block by ID - - -*Function DeleteBlock(Val Token, Val BlockID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | BlockID | --block | String | Block ID | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Block = "ca18df269bd24407852b91c30..."; - - Response = OPI_Notion.DeleteBlock(Token, BlockID); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion DeleteBlock --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% - - -``` - - -```json title="Result" - -{ - "request_id": "62b95ed2-c9af-4be8-b75a-f6e4f69aef14", - "to_do": { - "color": "default", - "checked": false, - "rich_text": [ - { - "plain_text": "Hello", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Hello" - }, - "href": null, - "type": "text" - } - ] - }, - "type": "to_do", - "archived": true, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:43:00.000Z", - "created_time": "2024-01-26T11:03:00.000Z", - "has_children": false, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", - "object": "block" - } - -``` +--- +sidebar_position: 4 +--- + +# Delete block + Deletes block by ID + + +*Function DeleteBlock(Val Token, Val BlockID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | BlockID | --block | String | Block ID | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Block = "ca18df269bd24407852b91c30..."; + + Response = OPI_Notion.DeleteBlock(Token, BlockID); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion DeleteBlock --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% + + +``` + + +```json title="Result" + +{ + "request_id": "62b95ed2-c9af-4be8-b75a-f6e4f69aef14", + "to_do": { + "color": "default", + "checked": false, + "rich_text": [ + { + "plain_text": "Hello", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Hello" + }, + "href": null, + "type": "text" + } + ] + }, + "type": "to_do", + "archived": true, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:43:00.000Z", + "created_time": "2024-01-26T11:03:00.000Z", + "has_children": false, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", + "object": "block" + } + +``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-block.md b/docs/en/md/Notion/Blocks-managment/Return-block.md index 3bdb334079..c0f2a0e297 100644 --- a/docs/en/md/Notion/Blocks-managment/Return-block.md +++ b/docs/en/md/Notion/Blocks-managment/Return-block.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 2 ---- - -# Return block. - - - -*Function ReturnBlock(Val Token, Val BlockID, Val OnlyBase = True) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | BlockID | --block | String | Block ID | - | OnlyBase | --core | Boolean | True > service fields are deleted, only the block itself remains | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Block = "ca18df269bd24407852b91c30..."; - - Response = OPI_Notion.ReturnBlock(Token, BlockID); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion ReturnBlock --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% --core %core% - - -``` - - -```json title="Result" - -{ - "request_id": "031886cc-537d-4025-b480-ecfdc9f2870c", - "to_do": { - "color": "default", - "checked": false, - "rich_text": [ - { - "plain_text": "Hello", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Hello" - }, - "href": null, - "type": "text" - } - ] - }, - "type": "to_do", - "archived": true, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:43:00.000Z", - "created_time": "2024-01-26T11:03:00.000Z", - "has_children": false, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", - "object": "block" - } - -``` +--- +sidebar_position: 2 +--- + +# Return block. + + + +*Function ReturnBlock(Val Token, Val BlockID, Val OnlyBase = True) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | BlockID | --block | String | Block ID | + | OnlyBase | --core | Boolean | True > service fields are deleted, only the block itself remains | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Block = "ca18df269bd24407852b91c30..."; + + Response = OPI_Notion.ReturnBlock(Token, BlockID); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion ReturnBlock --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% --core %core% + + +``` + + +```json title="Result" + +{ + "request_id": "031886cc-537d-4025-b480-ecfdc9f2870c", + "to_do": { + "color": "default", + "checked": false, + "rich_text": [ + { + "plain_text": "Hello", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Hello" + }, + "href": null, + "type": "text" + } + ] + }, + "type": "to_do", + "archived": true, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:43:00.000Z", + "created_time": "2024-01-26T11:03:00.000Z", + "has_children": false, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", + "object": "block" + } + +``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md index d83d61dcb7..b032251fff 100644 --- a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md +++ b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md @@ -1,139 +1,139 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | BlockID | --block | String | Parent block ID | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Block = "46c1500ed40c4e89ba6a22900..."; - - Response = OPI_Notion.ReturnChildBlocks(Token, BlockID); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion ReturnChildBlocks --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% - - -``` - - -```json title="Result" - -{ - "request_id": "fea2a37b-5507-451d-a4be-14433811a69e", - "block": {}, - "type": "block", - "has_more": false, - "next_cursor": null, - "results": [ - { - "type": "numbered_list_item", - "archived": false, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T20:33:00.000Z", - "created_time": "2024-01-26T17:02:00.000Z", - "has_children": false, - "parent": { - "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", - "type": "block_id" - }, - "last_edited_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "id": "aa4137d4-c8cc-445d-9f96-9c3968334e74", - "numbered_list_item": { - "color": "default", - "rich_text": [ - { - "plain_text": "Two", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Two" - }, - "href": null, - "type": "text" - } - ] - }, - "object": "block" - }, - { - "type": "numbered_list_item", - "archived": false, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T20:33:00.000Z", - "created_time": "2024-01-26T20:30:00.000Z", - "has_children": false, - "parent": { - "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", - "type": "block_id" - }, - "last_edited_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "id": "6fb45895-0350-49d3-a5c7-e0cb1e24061e", - "numbered_list_item": { - "color": "default", - "rich_text": [ - { - "plain_text": "Three", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Three" - }, - "href": null, - "type": "text" - } - ] - }, - "object": "block" - } - ], - "object": "list" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | BlockID | --block | String | Parent block ID | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Block = "46c1500ed40c4e89ba6a22900..."; + + Response = OPI_Notion.ReturnChildBlocks(Token, BlockID); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion ReturnChildBlocks --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% + + +``` + + +```json title="Result" + +{ + "request_id": "fea2a37b-5507-451d-a4be-14433811a69e", + "block": {}, + "type": "block", + "has_more": false, + "next_cursor": null, + "results": [ + { + "type": "numbered_list_item", + "archived": false, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T20:33:00.000Z", + "created_time": "2024-01-26T17:02:00.000Z", + "has_children": false, + "parent": { + "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", + "type": "block_id" + }, + "last_edited_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "id": "aa4137d4-c8cc-445d-9f96-9c3968334e74", + "numbered_list_item": { + "color": "default", + "rich_text": [ + { + "plain_text": "Two", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Two" + }, + "href": null, + "type": "text" + } + ] + }, + "object": "block" + }, + { + "type": "numbered_list_item", + "archived": false, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T20:33:00.000Z", + "created_time": "2024-01-26T20:30:00.000Z", + "has_children": false, + "parent": { + "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", + "type": "block_id" + }, + "last_edited_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "id": "6fb45895-0350-49d3-a5c7-e0cb1e24061e", + "numbered_list_item": { + "color": "default", + "rich_text": [ + { + "plain_text": "Three", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Three" + }, + "href": null, + "type": "text" + } + ] + }, + "object": "block" + } + ], + "object": "list" + } + +``` diff --git a/docs/en/md/Notion/Blocks-managment/_category_.json b/docs/en/md/Notion/Blocks-managment/_category_.json index cc7bce85c2..5fb27291c9 100644 --- a/docs/en/md/Notion/Blocks-managment/_category_.json +++ b/docs/en/md/Notion/Blocks-managment/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Blocks managment", -"position": "4" -} +{ +"label": "Blocks managment", +"position": "4" +} diff --git a/docs/en/md/Notion/Database-management/Create-database.md b/docs/en/md/Notion/Database-management/Create-database.md index 371033b808..001627e0bf 100644 --- a/docs/en/md/Notion/Database-management/Create-database.md +++ b/docs/en/md/Notion/Database-management/Create-database.md @@ -1,201 +1,201 @@ ---- -sidebar_position: 1 ---- - -# Create database - Creates a database - - -*Function CreateDatabase(Val Token, Val Parent, Val Title, Val Properties = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --page | String | Parent page ID | - | Title | --title | String | Database title | - | Properties | --props | Structure Of String | Database properties | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff9..."; - Title = "This base is from 1C"; - - Properties = New Map; - Properties.Insert("Name", "title"); //Title field required - 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); - - Response = OPI_Notion.CreateDatabase(Token, Parent, Title, Properties); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion CreateDatabase --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "This base is from 1C" --props %props% - - -``` - - -```json title="Result" - -{ - "request_id": "43adcae7-c8ee-4a7d-aba6-c2c43ad2c33b", - "public_url": null, - "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "properties": { - "Image": { - "files": {}, - "type": "files", - "name": "Image", - "id": "r%3Dfa" - }, - "Active": { - "checkbox": {}, - "type": "checkbox", - "name": "Active", - "id": "q%3FQF" - }, - "Phone": { - "phone_number": {}, - "type": "phone_number", - "name": "Phone", - "id": "hDII" - }, - "User": { - "people": {}, - "type": "people", - "name": "User", - "id": "%5D%40Md" - }, - "Website": { - "url": {}, - "type": "url", - "name": "Website", - "id": "THre" - }, - "Description": { - "rich_text": {}, - "type": "rich_text", - "name": "Description", - "id": "KnG%3F" - }, - "Status": { - "select": { - "options": [ - { - "description": null, - "color": "red", - "name": "Remote", - "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" - }, - { - "description": null, - "color": "yellow", - "name": "InProgress", - "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" - }, - { - "description": null, - "color": "green", - "name": "New", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - } - ] - }, - "type": "select", - "name": "Status", - "id": "IDW%3C" - }, - "Number": { - "type": "number", - "name": "Number", - "number": { - "format": "number" - }, - "id": "CH__" - }, - "CreationDate": { - "date": {}, - "type": "date", - "name": "CreationDate", - "id": "BQN%5B" - }, - "Name": { - "title": {}, - "type": "title", - "name": "Name", - "id": "title" - }, - "Email": { - "email": {}, - "type": "email", - "name": "Email", - "id": "%3CO%3AD" - } - }, - "last_edited_time": "2024-01-26T16:49:00.000Z", - "description": [], - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "archived": false, - "icon": null, - "created_time": "2024-01-26T16:49:00.000Z", - "title": [ - { - "plain_text": "This base is from 1C", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "This base is from 1C" - }, - "href": null, - "type": "text" - } - ], - "cover": null, - "is_inline": false, - "id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "object": "database" - } - -``` +--- +sidebar_position: 1 +--- + +# Create database + Creates a database + + +*Function CreateDatabase(Val Token, Val Parent, Val Title, Val Properties = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --page | String | Parent page ID | + | Title | --title | String | Database title | + | Properties | --props | Structure Of String | Database properties | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff9..."; + Title = "This base is from 1C"; + + Properties = New Map; + Properties.Insert("Name", "title"); //Title field required + 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); + + Response = OPI_Notion.CreateDatabase(Token, Parent, Title, Properties); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion CreateDatabase --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "This base is from 1C" --props %props% + + +``` + + +```json title="Result" + +{ + "request_id": "43adcae7-c8ee-4a7d-aba6-c2c43ad2c33b", + "public_url": null, + "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "properties": { + "Image": { + "files": {}, + "type": "files", + "name": "Image", + "id": "r%3Dfa" + }, + "Active": { + "checkbox": {}, + "type": "checkbox", + "name": "Active", + "id": "q%3FQF" + }, + "Phone": { + "phone_number": {}, + "type": "phone_number", + "name": "Phone", + "id": "hDII" + }, + "User": { + "people": {}, + "type": "people", + "name": "User", + "id": "%5D%40Md" + }, + "Website": { + "url": {}, + "type": "url", + "name": "Website", + "id": "THre" + }, + "Description": { + "rich_text": {}, + "type": "rich_text", + "name": "Description", + "id": "KnG%3F" + }, + "Status": { + "select": { + "options": [ + { + "description": null, + "color": "red", + "name": "Remote", + "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" + }, + { + "description": null, + "color": "yellow", + "name": "InProgress", + "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" + }, + { + "description": null, + "color": "green", + "name": "New", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + } + ] + }, + "type": "select", + "name": "Status", + "id": "IDW%3C" + }, + "Number": { + "type": "number", + "name": "Number", + "number": { + "format": "number" + }, + "id": "CH__" + }, + "CreationDate": { + "date": {}, + "type": "date", + "name": "CreationDate", + "id": "BQN%5B" + }, + "Name": { + "title": {}, + "type": "title", + "name": "Name", + "id": "title" + }, + "Email": { + "email": {}, + "type": "email", + "name": "Email", + "id": "%3CO%3AD" + } + }, + "last_edited_time": "2024-01-26T16:49:00.000Z", + "description": [], + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "archived": false, + "icon": null, + "created_time": "2024-01-26T16:49:00.000Z", + "title": [ + { + "plain_text": "This base is from 1C", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "This base is from 1C" + }, + "href": null, + "type": "text" + } + ], + "cover": null, + "is_inline": false, + "id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "object": "database" + } + +``` diff --git a/docs/en/md/Notion/Database-management/Edit-database-properties.md b/docs/en/md/Notion/Database-management/Edit-database-properties.md index 6f18611d40..7ce0fc7972 100644 --- a/docs/en/md/Notion/Database-management/Edit-database-properties.md +++ b/docs/en/md/Notion/Database-management/Edit-database-properties.md @@ -1,200 +1,200 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Base = "5dd94c34fab04bff9..."; - Title = "Updated title"; - Description = "Updated base description"; - - Properties = New Map; - Properties.Insert("Email", "rich_text"); //Type fields "Email" will changed with email to text - Properties.Insert("Website"); //Field "Website" will deleted - - Response = OPI_Notion.EditDatabaseProperties(Token, Base, Properties, Title, Description); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion EditDatabaseProperties --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --props %props% --title "Updated title" --description "Updated base description" - - -``` - - -```json title="Result" - -{ - "request_id": "d42b5700-9325-439e-98ce-252a007f5ed7", - "public_url": null, - "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "properties": { - "Image": { - "files": {}, - "type": "files", - "name": "Image", - "id": "r%3Dfa" - }, - "Active": { - "checkbox": {}, - "type": "checkbox", - "name": "Active", - "id": "q%3FQF" - }, - "Phone": { - "phone_number": {}, - "type": "phone_number", - "name": "Phone", - "id": "hDII" - }, - "User": { - "people": {}, - "type": "people", - "name": "User", - "id": "%5D%40Md" - }, - "Description": { - "rich_text": {}, - "type": "rich_text", - "name": "Description", - "id": "KnG%3F" - }, - "Status": { - "select": { - "options": [ - { - "description": null, - "color": "red", - "name": "Remote", - "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" - }, - { - "description": null, - "color": "yellow", - "name": "InProgress", - "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" - }, - { - "description": null, - "color": "green", - "name": "New", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - } - ] - }, - "type": "select", - "name": "Status", - "id": "IDW%3C" - }, - "Number": { - "type": "number", - "name": "Number", - "number": { - "format": "number" - }, - "id": "CH__" - }, - "CreationDate": { - "date": {}, - "type": "date", - "name": "CreationDate", - "id": "BQN%5B" - }, - "Name": { - "title": {}, - "type": "title", - "name": "Name", - "id": "title" - }, - "Email": { - "rich_text": {}, - "type": "rich_text", - "name": "Email", - "id": "%3CO%3AD" - } - }, - "last_edited_time": "2024-01-26T18:26:00.000Z", - "description": [ - { - "plain_text": "Updated base description", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Updated base description" - }, - "href": null, - "type": "text" - } - ], - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "archived": false, - "icon": null, - "created_time": "2024-01-26T16:49:00.000Z", - "title": [ - { - "plain_text": "Updated title", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Updated title" - }, - "href": null, - "type": "text" - } - ], - "cover": null, - "is_inline": false, - "id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "object": "database" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Base = "5dd94c34fab04bff9..."; + Title = "Updated title"; + Description = "Updated base description"; + + Properties = New Map; + Properties.Insert("Email", "rich_text"); //Type fields "Email" will changed with email to text + Properties.Insert("Website"); //Field "Website" will deleted + + Response = OPI_Notion.EditDatabaseProperties(Token, Base, Properties, Title, Description); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion EditDatabaseProperties --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --props %props% --title "Updated title" --description "Updated base description" + + +``` + + +```json title="Result" + +{ + "request_id": "d42b5700-9325-439e-98ce-252a007f5ed7", + "public_url": null, + "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "properties": { + "Image": { + "files": {}, + "type": "files", + "name": "Image", + "id": "r%3Dfa" + }, + "Active": { + "checkbox": {}, + "type": "checkbox", + "name": "Active", + "id": "q%3FQF" + }, + "Phone": { + "phone_number": {}, + "type": "phone_number", + "name": "Phone", + "id": "hDII" + }, + "User": { + "people": {}, + "type": "people", + "name": "User", + "id": "%5D%40Md" + }, + "Description": { + "rich_text": {}, + "type": "rich_text", + "name": "Description", + "id": "KnG%3F" + }, + "Status": { + "select": { + "options": [ + { + "description": null, + "color": "red", + "name": "Remote", + "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" + }, + { + "description": null, + "color": "yellow", + "name": "InProgress", + "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" + }, + { + "description": null, + "color": "green", + "name": "New", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + } + ] + }, + "type": "select", + "name": "Status", + "id": "IDW%3C" + }, + "Number": { + "type": "number", + "name": "Number", + "number": { + "format": "number" + }, + "id": "CH__" + }, + "CreationDate": { + "date": {}, + "type": "date", + "name": "CreationDate", + "id": "BQN%5B" + }, + "Name": { + "title": {}, + "type": "title", + "name": "Name", + "id": "title" + }, + "Email": { + "rich_text": {}, + "type": "rich_text", + "name": "Email", + "id": "%3CO%3AD" + } + }, + "last_edited_time": "2024-01-26T18:26:00.000Z", + "description": [ + { + "plain_text": "Updated base description", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Updated base description" + }, + "href": null, + "type": "text" + } + ], + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "archived": false, + "icon": null, + "created_time": "2024-01-26T16:49:00.000Z", + "title": [ + { + "plain_text": "Updated title", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Updated title" + }, + "href": null, + "type": "text" + } + ], + "cover": null, + "is_inline": false, + "id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "object": "database" + } + +``` diff --git a/docs/en/md/Notion/Database-management/Get-database.md b/docs/en/md/Notion/Database-management/Get-database.md index 5f4d31a1eb..b288a046b8 100644 --- a/docs/en/md/Notion/Database-management/Get-database.md +++ b/docs/en/md/Notion/Database-management/Get-database.md @@ -1,191 +1,191 @@ ---- -sidebar_position: 2 ---- - -# Get database - Get database information - - -*Function GetDatabase(Val Token, Val Base) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Base | --base | String | Database ID | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Base = "048ba0ce4f474e33900540d24..."; - - Response = OPI_Notion.GetDatabase(Token, Base); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion GetDatabase --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "048ba0ce4f474e33900540d24..." - - -``` - - -```json title="Result" - -{ - "request_id": "9c6e06e9-ffa5-4a3c-b4ff-0368553ca066", - "public_url": null, - "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "properties": { - "Image": { - "files": {}, - "type": "files", - "name": "Image", - "id": "r%3Dfa" - }, - "Active": { - "checkbox": {}, - "type": "checkbox", - "name": "Active", - "id": "q%3FQF" - }, - "Phone": { - "phone_number": {}, - "type": "phone_number", - "name": "Phone", - "id": "hDII" - }, - "User": { - "people": {}, - "type": "people", - "name": "User", - "id": "%5D%40Md" - }, - "Description": { - "rich_text": {}, - "type": "rich_text", - "name": "Description", - "id": "KnG%3F" - }, - "Status": { - "select": { - "options": [ - { - "description": null, - "color": "red", - "name": "Remote", - "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" - }, - { - "description": null, - "color": "yellow", - "name": "InProgress", - "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" - }, - { - "description": null, - "color": "green", - "name": "New", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - } - ] - }, - "type": "select", - "name": "Status", - "id": "IDW%3C" - }, - "Number": { - "type": "number", - "name": "Number", - "number": { - "format": "number" - }, - "id": "CH__" - }, - "CreationDate": { - "date": {}, - "type": "date", - "name": "CreationDate", - "id": "BQN%5B" - }, - "Name": { - "title": {}, - "type": "title", - "name": "Name", - "id": "title" - }, - "Email": { - "rich_text": {}, - "type": "rich_text", - "name": "Email", - "id": "%3CO%3AD" - } - }, - "last_edited_time": "2024-01-26T18:28:00.000Z", - "description": [ - { - "plain_text": "Updated base description", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Updated base description" - }, - "href": null, - "type": "text" - } - ], - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "archived": false, - "icon": null, - "created_time": "2024-01-26T16:49:00.000Z", - "title": [ - { - "plain_text": "Updated title", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Updated title" - }, - "href": null, - "type": "text" - } - ], - "cover": null, - "is_inline": false, - "id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "last_edited_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "object": "database" - } - -``` +--- +sidebar_position: 2 +--- + +# Get database + Get database information + + +*Function GetDatabase(Val Token, Val Base) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Base | --base | String | Database ID | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Base = "048ba0ce4f474e33900540d24..."; + + Response = OPI_Notion.GetDatabase(Token, Base); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion GetDatabase --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "048ba0ce4f474e33900540d24..." + + +``` + + +```json title="Result" + +{ + "request_id": "9c6e06e9-ffa5-4a3c-b4ff-0368553ca066", + "public_url": null, + "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "properties": { + "Image": { + "files": {}, + "type": "files", + "name": "Image", + "id": "r%3Dfa" + }, + "Active": { + "checkbox": {}, + "type": "checkbox", + "name": "Active", + "id": "q%3FQF" + }, + "Phone": { + "phone_number": {}, + "type": "phone_number", + "name": "Phone", + "id": "hDII" + }, + "User": { + "people": {}, + "type": "people", + "name": "User", + "id": "%5D%40Md" + }, + "Description": { + "rich_text": {}, + "type": "rich_text", + "name": "Description", + "id": "KnG%3F" + }, + "Status": { + "select": { + "options": [ + { + "description": null, + "color": "red", + "name": "Remote", + "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" + }, + { + "description": null, + "color": "yellow", + "name": "InProgress", + "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" + }, + { + "description": null, + "color": "green", + "name": "New", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + } + ] + }, + "type": "select", + "name": "Status", + "id": "IDW%3C" + }, + "Number": { + "type": "number", + "name": "Number", + "number": { + "format": "number" + }, + "id": "CH__" + }, + "CreationDate": { + "date": {}, + "type": "date", + "name": "CreationDate", + "id": "BQN%5B" + }, + "Name": { + "title": {}, + "type": "title", + "name": "Name", + "id": "title" + }, + "Email": { + "rich_text": {}, + "type": "rich_text", + "name": "Email", + "id": "%3CO%3AD" + } + }, + "last_edited_time": "2024-01-26T18:28:00.000Z", + "description": [ + { + "plain_text": "Updated base description", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Updated base description" + }, + "href": null, + "type": "text" + } + ], + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "archived": false, + "icon": null, + "created_time": "2024-01-26T16:49:00.000Z", + "title": [ + { + "plain_text": "Updated title", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Updated title" + }, + "href": null, + "type": "text" + } + ], + "cover": null, + "is_inline": false, + "id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "last_edited_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "object": "database" + } + +``` diff --git a/docs/en/md/Notion/Database-management/_category_.json b/docs/en/md/Notion/Database-management/_category_.json index 4558a0b2bc..acdb686865 100644 --- a/docs/en/md/Notion/Database-management/_category_.json +++ b/docs/en/md/Notion/Database-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Database management", -"position": "3" -} +{ +"label": "Database management", +"position": "3" +} diff --git a/docs/en/md/Notion/Notion.md b/docs/en/md/Notion/Notion.md index c373217f81..355ac0d44f 100644 --- a/docs/en/md/Notion/Notion.md +++ b/docs/en/md/Notion/Notion.md @@ -1,38 +1,38 @@ ---- -id: Notion -sidebar_class_name: Notion ---- - - - -# Notion - -Этот раздел поwithinящен библиотеtoе for work with Notion API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -1. Перейдите **[in раздел интеграций портала for разработчиtoоin](https://www.notion.so/my-integrations)** - -![BF](../../static/img/Docs/Notion/1.png) - -2. Ininедите name inашей интеграции - -![BF](../../static/img/Docs/Notion/2.png) - -3. Towithле заinершения withоздания интеграции, toжмите *Show* и withtoопируйте **Token (Secret)** - -![BF](../../static/img/Docs/Notion/3.png) - -4. Перейдите in **[mainоinной интерфейwith Notion](https://notion.so)** и withоздайте ноinую page. Эта withтраница will родительwithtoой for all оwithтальных объеtoтоin, withоздаinаемых через API - -![BF](../../static/img/Docs/Notion/4.png) - -5. Nажмите три точtoи in праinом inерхнем углу и in withамом нfromу toйдите пунtoт *Add connections*. Inыберите там withinою интеграцию from пунtoтоin 1-3 - -![BF](../../static/img/Docs/Notion/5.png) - -6. Toлучите ID this withтраинцы. Это можно withделать toжаin Share -> Copy link or проwithто withtoопироinаin from URL - -![BF](../../static/img/Docs/Notion/6.png) - -**Token** и **Page ID** - дinа параметра, необходимые for work через API +--- +id: Notion +sidebar_class_name: Notion +--- + + + +# Notion + +Этот раздел поwithinящен библиотеtoе for work with Notion API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +1. Перейдите **[in раздел интеграций портала for разработчиtoоin](https://www.notion.so/my-integrations)** + +![BF](../../static/img/Docs/Notion/1.png) + +2. Ininедите name inашей интеграции + +![BF](../../static/img/Docs/Notion/2.png) + +3. Towithле заinершения withоздания интеграции, toжмите *Show* и withtoопируйте **Token (Secret)** + +![BF](../../static/img/Docs/Notion/3.png) + +4. Перейдите in **[mainоinной интерфейwith Notion](https://notion.so)** и withоздайте ноinую page. Эта withтраница will родительwithtoой for all оwithтальных объеtoтоin, withоздаinаемых через API + +![BF](../../static/img/Docs/Notion/4.png) + +5. Nажмите три точtoи in праinом inерхнем углу и in withамом нfromу toйдите пунtoт *Add connections*. Inыберите там withinою интеграцию from пунtoтоin 1-3 + +![BF](../../static/img/Docs/Notion/5.png) + +6. Toлучите ID this withтраинцы. Это можно withделать toжаin Share -> Copy link or проwithто withtoопироinаin from URL + +![BF](../../static/img/Docs/Notion/6.png) + +**Token** и **Page ID** - дinа параметра, необходимые for work через API 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 index a4d1042086..d65cc9dc2a 100644 --- a/docs/en/md/Notion/Page-management/Create-page-in-database.md +++ b/docs/en/md/Notion/Page-management/Create-page-in-database.md @@ -1,204 +1,204 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --base | String | Parent database ID | - | Data | --data | Key-Value Pair | Properties match | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff9..."; - Image = New Map; - Image.Insert("Logo", "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg"); - - Data = New Map; - Data.Insert("Name", "LLC Vector"); - Data.Insert("Description", "OurFirstClient"); - Data.Insert("Number", 1); - Data.Insert("Status", "Regular"); - Data.Insert("CreationDate", CurrentSessionDate()); - Data.Insert("Image", Image); - Data.Insert("Active", True); - Data.Insert("Email", "mail@vector.ru"); - Data.Insert("Phone", "88005553535"); - Data.Insert("Status", "New"); - - Response = OPI_Notion.CreatePageInDatabase(Token, Base, Data); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion CreatePageInDatabase --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --data %data% - - -``` - - -```json title="Result" - -{ - "request_id": "03fd3bd2-6dd1-4ca2-bf85-9233748a745f", - "public_url": null, - "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", - "properties": { - "Image": { - "files": [ - { - "external": { - "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" - }, - "type": "external", - "name": "Logo" - } - ], - "type": "files", - "id": "r%3Dfa" - }, - "Active": { - "checkbox": true, - "type": "checkbox", - "id": "q%3FQF" - }, - "Phone": { - "phone_number": "88005553535", - "type": "phone_number", - "id": "hDII" - }, - "User": { - "people": [], - "type": "people", - "id": "%5D%40Md" - }, - "Description": { - "rich_text": [ - { - "plain_text": "OurFirstClient", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "OurFirstClient" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "KnG%3F" - }, - "Status": { - "select": { - "color": "green", - "name": "New", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - }, - "type": "select", - "id": "IDW%3C" - }, - "Number": { - "type": "number", - "number": 1, - "id": "CH__" - }, - "CreationDate": { - "date": { - "time_zone": null, - "end": null, - "start": "2024-01-26T09:45:00.000+00:00" - }, - "type": "date", - "id": "BQN%5B" - }, - "Name": { - "title": [ - { - "plain_text": "LLC Vector", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "LLC Vector" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - }, - "Email": { - "rich_text": [ - { - "plain_text": "mail@vector.ru", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "mail@vector.ru" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "%3CO%3AD" - } - }, - "parent": { - "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "type": "database_id" - }, - "cover": null, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T18:45:00.000Z", - "icon": null, - "created_time": "2024-01-26T18:45:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "a5742816-1417-4169-bf55-dbae44f46d9c", - "object": "page" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --base | String | Parent database ID | + | Data | --data | Key-Value Pair | Properties match | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff9..."; + Image = New Map; + Image.Insert("Logo", "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg"); + + Data = New Map; + Data.Insert("Name", "LLC Vector"); + Data.Insert("Description", "OurFirstClient"); + Data.Insert("Number", 1); + Data.Insert("Status", "Regular"); + Data.Insert("CreationDate", CurrentSessionDate()); + Data.Insert("Image", Image); + Data.Insert("Active", True); + Data.Insert("Email", "mail@vector.ru"); + Data.Insert("Phone", "88005553535"); + Data.Insert("Status", "New"); + + Response = OPI_Notion.CreatePageInDatabase(Token, Base, Data); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion CreatePageInDatabase --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --data %data% + + +``` + + +```json title="Result" + +{ + "request_id": "03fd3bd2-6dd1-4ca2-bf85-9233748a745f", + "public_url": null, + "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", + "properties": { + "Image": { + "files": [ + { + "external": { + "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" + }, + "type": "external", + "name": "Logo" + } + ], + "type": "files", + "id": "r%3Dfa" + }, + "Active": { + "checkbox": true, + "type": "checkbox", + "id": "q%3FQF" + }, + "Phone": { + "phone_number": "88005553535", + "type": "phone_number", + "id": "hDII" + }, + "User": { + "people": [], + "type": "people", + "id": "%5D%40Md" + }, + "Description": { + "rich_text": [ + { + "plain_text": "OurFirstClient", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "OurFirstClient" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "KnG%3F" + }, + "Status": { + "select": { + "color": "green", + "name": "New", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + }, + "type": "select", + "id": "IDW%3C" + }, + "Number": { + "type": "number", + "number": 1, + "id": "CH__" + }, + "CreationDate": { + "date": { + "time_zone": null, + "end": null, + "start": "2024-01-26T09:45:00.000+00:00" + }, + "type": "date", + "id": "BQN%5B" + }, + "Name": { + "title": [ + { + "plain_text": "LLC Vector", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "LLC Vector" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + }, + "Email": { + "rich_text": [ + { + "plain_text": "mail@vector.ru", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "mail@vector.ru" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "%3CO%3AD" + } + }, + "parent": { + "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "type": "database_id" + }, + "cover": null, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T18:45:00.000Z", + "icon": null, + "created_time": "2024-01-26T18:45:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "a5742816-1417-4169-bf55-dbae44f46d9c", + "object": "page" + } + +``` diff --git a/docs/en/md/Notion/Page-management/Create-page.md b/docs/en/md/Notion/Page-management/Create-page.md index dfc8c7e12b..7b43aa3c14 100644 --- a/docs/en/md/Notion/Page-management/Create-page.md +++ b/docs/en/md/Notion/Page-management/Create-page.md @@ -1,94 +1,94 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Parent | --page | String | Parent ID | - | Title | --title | String | Page title | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Parent = "5dd94c34fab04bff9..."; - Title = "Created by 1C"; - - Response = OPI_Notion.CreatePage(Token, Parent, Title); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion CreatePage --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "Created by 1C" - - -``` - - -```json title="Result" - -{ - "request_id": "f145f634-ea3a-4f74-b079-f365ecbcf583", - "public_url": null, - "url": "https://www.notion.so/1-4392f919813c4c8d84017d973bddaabf", - "properties": { - "title": { - "title": [ - { - "plain_text": "Created by 1C", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Created by 1C" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - } - }, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "cover": null, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T17:20:00.000Z", - "icon": null, - "created_time": "2024-01-26T17:20:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "4392f919-813c-4c8d-8401-7d973bddaabf", - "object": "page" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Parent | --page | String | Parent ID | + | Title | --title | String | Page title | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Parent = "5dd94c34fab04bff9..."; + Title = "Created by 1C"; + + Response = OPI_Notion.CreatePage(Token, Parent, Title); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion CreatePage --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "Created by 1C" + + +``` + + +```json title="Result" + +{ + "request_id": "f145f634-ea3a-4f74-b079-f365ecbcf583", + "public_url": null, + "url": "https://www.notion.so/1-4392f919813c4c8d84017d973bddaabf", + "properties": { + "title": { + "title": [ + { + "plain_text": "Created by 1C", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Created by 1C" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + } + }, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "cover": null, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T17:20:00.000Z", + "icon": null, + "created_time": "2024-01-26T17:20:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "4392f919-813c-4c8d-8401-7d973bddaabf", + "object": "page" + } + +``` diff --git a/docs/en/md/Notion/Page-management/Edit-page-properties.md b/docs/en/md/Notion/Page-management/Edit-page-properties.md index 7caaf67086..7afff60a79 100644 --- a/docs/en/md/Notion/Page-management/Edit-page-properties.md +++ b/docs/en/md/Notion/Page-management/Edit-page-properties.md @@ -1,215 +1,215 @@ ---- -sidebar_position: 4 ---- - -# Edit page properties. - - - -*Function EditPageProperties(Val Token, Val Page, Val Data = "", Val Icon = "", Val Cover = "", Val Archived = False) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Page | --page | String | ID of the page being modified | - | Data | --data | Key-Value Pair | Matching 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: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Page = "5dd94c34fab04bff9..."; - Icon = "https://opi.neocities.org/img/logo.png"; - Cover = "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png"; - - Properties = New Map; - Properties.Insert("Active", False); - Properties.Insert("Email", "vector@mail.ru"); - - Response = OPI_Notion.EditPageProperties(Token -, Page -, Properties -, Icon -, Cover -, Archive); - - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion EditPageProperties --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --data %data% --icon "https://opi.neocities.org/img/logo.png" --cover "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" --archive %archive% - - -``` - - -```json title="Result" - -{ - "request_id": "a02741b2-4eb8-43ae-9a2e-542d5dd10687", - "public_url": null, - "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", - "properties": { - "Image": { - "files": [ - { - "external": { - "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" - }, - "type": "external", - "name": "Logo" - } - ], - "type": "files", - "id": "r%3Dfa" - }, - "Active": { - "checkbox": false, - "type": "checkbox", - "id": "q%3FQF" - }, - "Phone": { - "phone_number": "88005553535", - "type": "phone_number", - "id": "hDII" - }, - "User": { - "people": [], - "type": "people", - "id": "%5D%40Md" - }, - "Description": { - "rich_text": [ - { - "plain_text": "OurFirstClient", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "OurFirstClient" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "KnG%3F" - }, - "Status": { - "select": { - "color": "green", - "name": "New", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - }, - "type": "select", - "id": "IDW%3C" - }, - "Number": { - "type": "number", - "number": 1, - "id": "CH__" - }, - "CreationDate": { - "date": { - "time_zone": null, - "end": null, - "start": "2024-01-26T09:45:00.000+00:00" - }, - "type": "date", - "id": "BQN%5B" - }, - "Name": { - "title": [ - { - "plain_text": "LLC Vector", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "LLC Vector" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - }, - "Email": { - "rich_text": [ - { - "plain_text": "vector@mail.ru", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "vector@mail.ru" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "%3CO%3AD" - } - }, - "parent": { - "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "type": "database_id" - }, - "cover": { - "external": { - "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" - }, - "type": "external" - }, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:30:00.000Z", - "icon": { - "external": { - "url": "https://opi.neocities.org/img/logo.png" - }, - "type": "external" - }, - "created_time": "2024-01-26T18:45:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "a5742816-1417-4169-bf55-dbae44f46d9c", - "object": "page" - } - -``` +--- +sidebar_position: 4 +--- + +# Edit page properties. + + + +*Function EditPageProperties(Val Token, Val Page, Val Data = "", Val Icon = "", Val Cover = "", Val Archived = False) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Page | --page | String | ID of the page being modified | + | Data | --data | Key-Value Pair | Matching 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: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Page = "5dd94c34fab04bff9..."; + Icon = "https://opi.neocities.org/img/logo.png"; + Cover = "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png"; + + Properties = New Map; + Properties.Insert("Active", False); + Properties.Insert("Email", "vector@mail.ru"); + + Response = OPI_Notion.EditPageProperties(Token +, Page +, Properties +, Icon +, Cover +, Archive); + + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion EditPageProperties --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --data %data% --icon "https://opi.neocities.org/img/logo.png" --cover "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" --archive %archive% + + +``` + + +```json title="Result" + +{ + "request_id": "a02741b2-4eb8-43ae-9a2e-542d5dd10687", + "public_url": null, + "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", + "properties": { + "Image": { + "files": [ + { + "external": { + "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" + }, + "type": "external", + "name": "Logo" + } + ], + "type": "files", + "id": "r%3Dfa" + }, + "Active": { + "checkbox": false, + "type": "checkbox", + "id": "q%3FQF" + }, + "Phone": { + "phone_number": "88005553535", + "type": "phone_number", + "id": "hDII" + }, + "User": { + "people": [], + "type": "people", + "id": "%5D%40Md" + }, + "Description": { + "rich_text": [ + { + "plain_text": "OurFirstClient", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "OurFirstClient" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "KnG%3F" + }, + "Status": { + "select": { + "color": "green", + "name": "New", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + }, + "type": "select", + "id": "IDW%3C" + }, + "Number": { + "type": "number", + "number": 1, + "id": "CH__" + }, + "CreationDate": { + "date": { + "time_zone": null, + "end": null, + "start": "2024-01-26T09:45:00.000+00:00" + }, + "type": "date", + "id": "BQN%5B" + }, + "Name": { + "title": [ + { + "plain_text": "LLC Vector", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "LLC Vector" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + }, + "Email": { + "rich_text": [ + { + "plain_text": "vector@mail.ru", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "vector@mail.ru" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "%3CO%3AD" + } + }, + "parent": { + "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "type": "database_id" + }, + "cover": { + "external": { + "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" + }, + "type": "external" + }, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:30:00.000Z", + "icon": { + "external": { + "url": "https://opi.neocities.org/img/logo.png" + }, + "type": "external" + }, + "created_time": "2024-01-26T18:45:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "a5742816-1417-4169-bf55-dbae44f46d9c", + "object": "page" + } + +``` diff --git a/docs/en/md/Notion/Page-management/Get-page.md b/docs/en/md/Notion/Page-management/Get-page.md index 6d31d1120b..a70235fd2a 100644 --- a/docs/en/md/Notion/Page-management/Get-page.md +++ b/docs/en/md/Notion/Page-management/Get-page.md @@ -1,199 +1,199 @@ ---- -sidebar_position: 3 ---- - -# Get page - Gets information about the page by ID - - -*Function GetPage(Val Token, Val Page) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Page | --page | String | Page ID | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Page = "a574281614174169bf55dbae4..."; - - Response = OPI_Notion.GetPage(Token, Page); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion GetPage --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "a574281614174169bf55dbae4..." - - -``` - - -```json title="Result" - -{ - "request_id": "61eaaa91-41fc-4523-a445-602805afb281", - "public_url": null, - "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", - "properties": { - "Image": { - "files": [ - { - "external": { - "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" - }, - "type": "external", - "name": "Logo" - } - ], - "type": "files", - "id": "r%3Dfa" - }, - "Active": { - "checkbox": false, - "type": "checkbox", - "id": "q%3FQF" - }, - "Phone": { - "phone_number": "88005553535", - "type": "phone_number", - "id": "hDII" - }, - "User": { - "people": [], - "type": "people", - "id": "%5D%40Md" - }, - "Description": { - "rich_text": [ - { - "plain_text": "OurFirstClient", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "OurFirstClient" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "KnG%3F" - }, - "Status": { - "select": { - "color": "green", - "name": "New", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - }, - "type": "select", - "id": "IDW%3C" - }, - "Number": { - "type": "number", - "number": 1, - "id": "CH__" - }, - "CreationDate": { - "date": { - "time_zone": null, - "end": null, - "start": "2024-01-26T09:45:00.000+00:00" - }, - "type": "date", - "id": "BQN%5B" - }, - "Name": { - "title": [ - { - "plain_text": "LLC Vector", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "LLC Vector" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - }, - "Email": { - "rich_text": [ - { - "plain_text": "vector@mail.ru", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "vector@mail.ru" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "%3CO%3AD" - } - }, - "parent": { - "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "type": "database_id" - }, - "cover": { - "external": { - "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" - }, - "type": "external" - }, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:30:00.000Z", - "icon": { - "external": { - "url": "https://opi.neocities.org/img/logo.png" - }, - "type": "external" - }, - "created_time": "2024-01-26T18:45:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "a5742816-1417-4169-bf55-dbae44f46d9c", - "object": "page" - } - -``` +--- +sidebar_position: 3 +--- + +# Get page + Gets information about the page by ID + + +*Function GetPage(Val Token, Val Page) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Page | --page | String | Page ID | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Page = "a574281614174169bf55dbae4..."; + + Response = OPI_Notion.GetPage(Token, Page); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion GetPage --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "a574281614174169bf55dbae4..." + + +``` + + +```json title="Result" + +{ + "request_id": "61eaaa91-41fc-4523-a445-602805afb281", + "public_url": null, + "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", + "properties": { + "Image": { + "files": [ + { + "external": { + "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" + }, + "type": "external", + "name": "Logo" + } + ], + "type": "files", + "id": "r%3Dfa" + }, + "Active": { + "checkbox": false, + "type": "checkbox", + "id": "q%3FQF" + }, + "Phone": { + "phone_number": "88005553535", + "type": "phone_number", + "id": "hDII" + }, + "User": { + "people": [], + "type": "people", + "id": "%5D%40Md" + }, + "Description": { + "rich_text": [ + { + "plain_text": "OurFirstClient", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "OurFirstClient" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "KnG%3F" + }, + "Status": { + "select": { + "color": "green", + "name": "New", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + }, + "type": "select", + "id": "IDW%3C" + }, + "Number": { + "type": "number", + "number": 1, + "id": "CH__" + }, + "CreationDate": { + "date": { + "time_zone": null, + "end": null, + "start": "2024-01-26T09:45:00.000+00:00" + }, + "type": "date", + "id": "BQN%5B" + }, + "Name": { + "title": [ + { + "plain_text": "LLC Vector", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "LLC Vector" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + }, + "Email": { + "rich_text": [ + { + "plain_text": "vector@mail.ru", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "vector@mail.ru" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "%3CO%3AD" + } + }, + "parent": { + "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "type": "database_id" + }, + "cover": { + "external": { + "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" + }, + "type": "external" + }, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:30:00.000Z", + "icon": { + "external": { + "url": "https://opi.neocities.org/img/logo.png" + }, + "type": "external" + }, + "created_time": "2024-01-26T18:45:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "a5742816-1417-4169-bf55-dbae44f46d9c", + "object": "page" + } + +``` diff --git a/docs/en/md/Notion/Page-management/_category_.json b/docs/en/md/Notion/Page-management/_category_.json index f698ea18b6..b32a8032fa 100644 --- a/docs/en/md/Notion/Page-management/_category_.json +++ b/docs/en/md/Notion/Page-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Page management", -"position": "2" -} +{ +"label": "Page management", +"position": "2" +} diff --git a/docs/en/md/Notion/Users/Get-user-data.md b/docs/en/md/Notion/Users/Get-user-data.md index 7bbfb8acf1..c16d8a26be 100644 --- a/docs/en/md/Notion/Users/Get-user-data.md +++ b/docs/en/md/Notion/Users/Get-user-data.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 2 ---- - -# Get user data - Gets user data by ID - - -*Function GetUserData(Val Token, Val UserID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | UserID | --user | String | Target user ID | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - UserID = "ed71865a989146bc86cdwdf24..."; - - Response = OPI_Notion.GetUserData(Token, UserID); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion GetUserData --token "secret_9RsfMrRMqZwqp0Zl0B..." --user "ed71865a989146bc86cdwdf24..." - - -``` - - -```json title="Result" - -{ - "request_id": "f33d34a8-f3cf-41b5-bdf5-4a07cf7d7118", - "person": { - "email": "ex@gmail.com" - }, - "type": "person", - "avatar_url": null, - "name": "Bayselonarrend", - "id": "ed71865a-9891-1111-86cd-1111111", - "object": "user" - } - -``` +--- +sidebar_position: 2 +--- + +# Get user data + Gets user data by ID + + +*Function GetUserData(Val Token, Val UserID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | UserID | --user | String | Target user ID | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + UserID = "ed71865a989146bc86cdwdf24..."; + + Response = OPI_Notion.GetUserData(Token, UserID); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion GetUserData --token "secret_9RsfMrRMqZwqp0Zl0B..." --user "ed71865a989146bc86cdwdf24..." + + +``` + + +```json title="Result" + +{ + "request_id": "f33d34a8-f3cf-41b5-bdf5-4a07cf7d7118", + "person": { + "email": "ex@gmail.com" + }, + "type": "person", + "avatar_url": null, + "name": "Bayselonarrend", + "id": "ed71865a-9891-1111-86cd-1111111", + "object": "user" + } + +``` diff --git a/docs/en/md/Notion/Users/User-list.md b/docs/en/md/Notion/Users/User-list.md index 3a04fd1f7f..c17461d251 100644 --- a/docs/en/md/Notion/Users/User-list.md +++ b/docs/en/md/Notion/Users/User-list.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 1 ---- - -# User list - Returns a list of workspace users - - -*Function UserList(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - Serialized JSON response from Notion - -```bsl title="Code example" - - - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; - Response = OPI_Notion.UserList(Token); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint notion UserList --token "secret_9RsfMrRMqZwqp0Zl0B..." - - -``` - - -```json title="Result" - -{ - "request_id": "ea9a6b96-0b02-4866-a60a-2958e514af38", - "user": {}, - "type": "user", - "has_more": false, - "next_cursor": null, - "results": [ - { - "person": { - "email": "ex@gmail.com" - }, - "type": "person", - "avatar_url": null, - "name": "Bayselonarrends", - "id": "ed71865a-9891-1111-86cd-11111111", - "object": "user" - }, - { - "type": "bot", - "avatar_url": null, - "name": "1C Integration", - "bot": { - "workspace_name": "Bayselonarrends Notion", - "owner": { - "workspace": true, - "type": "workspace" - } - }, - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - } - ], - "object": "list" - } - -``` +--- +sidebar_position: 1 +--- + +# User list + Returns a list of workspace users + + +*Function UserList(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - Serialized JSON response from Notion + +```bsl title="Code example" + + + Token = "secret_9RsfMrRMqZwqp0Zl0B..."; + Response = OPI_Notion.UserList(Token); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint notion UserList --token "secret_9RsfMrRMqZwqp0Zl0B..." + + +``` + + +```json title="Result" + +{ + "request_id": "ea9a6b96-0b02-4866-a60a-2958e514af38", + "user": {}, + "type": "user", + "has_more": false, + "next_cursor": null, + "results": [ + { + "person": { + "email": "ex@gmail.com" + }, + "type": "person", + "avatar_url": null, + "name": "Bayselonarrends", + "id": "ed71865a-9891-1111-86cd-11111111", + "object": "user" + }, + { + "type": "bot", + "avatar_url": null, + "name": "1C Integration", + "bot": { + "workspace_name": "Bayselonarrends Notion", + "owner": { + "workspace": true, + "type": "workspace" + } + }, + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + } + ], + "object": "list" + } + +``` diff --git a/docs/en/md/Notion/Users/_category_.json b/docs/en/md/Notion/Users/_category_.json index 93cfa8f58f..d64ebf5ef8 100644 --- a/docs/en/md/Notion/Users/_category_.json +++ b/docs/en/md/Notion/Users/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Users", -"position": "5" -} +{ +"label": "Users", +"position": "5" +} diff --git a/docs/en/md/Notion/_category_.json b/docs/en/md/Notion/_category_.json index a56cc01b13..7fc4cbbe25 100644 --- a/docs/en/md/Notion/_category_.json +++ b/docs/en/md/Notion/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Notion", - "position": 6, - "link": { - "type": "doc", - "id": "Notion" - } -} +{ + "label": "Notion", + "position": 6, + "link": { + "type": "doc", + "id": "Notion" + } +} diff --git a/docs/en/md/Slack/Block-formation/Generate-image-block.md b/docs/en/md/Slack/Block-formation/Generate-image-block.md index b0268a8dab..2c2150cd2f 100644 --- a/docs/en/md/Slack/Block-formation/Generate-image-block.md +++ b/docs/en/md/Slack/Block-formation/Generate-image-block.md @@ -1,48 +1,48 @@ ---- -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 | Destination | - |-|-|-|-| - | URL | --picture | String | Image URL | - | AlternateText | --alt | String | Alternate text of the image | - - - Returns: Key-Value Pair - Image block - -```bsl title="Code example" - - - Text = "Alpaca picture"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"; - - Response = OPI_Slack.GenerateImageBlock(URL, Text); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GenerateImageBlock --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" --alt %alt% - - -``` - - -```json title="Result" - -{ - "alt_text": "Yo", - "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1", - "type": "image" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | URL | --picture | String | Image URL | + | AlternateText | --alt | String | Alternate text of the image | + + + Returns: Key-Value Pair - Image block + +```bsl title="Code example" + + + Text = "Alpaca picture"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"; + + Response = OPI_Slack.GenerateImageBlock(URL, Text); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GenerateImageBlock --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" --alt %alt% + + +``` + + +```json title="Result" + +{ + "alt_text": "Yo", + "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1", + "type": "image" + } + +``` diff --git a/docs/en/md/Slack/Block-formation/_category_.json b/docs/en/md/Slack/Block-formation/_category_.json index e842cb7ae7..2a2b5065fa 100644 --- a/docs/en/md/Slack/Block-formation/_category_.json +++ b/docs/en/md/Slack/Block-formation/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Block formation", -"position": "8" -} +{ +"label": "Block formation", +"position": "8" +} diff --git a/docs/en/md/Slack/Channel-management/Archive-channel.md b/docs/en/md/Slack/Channel-management/Archive-channel.md index d47c52902c..abc3d58664 100644 --- a/docs/en/md/Slack/Channel-management/Archive-channel.md +++ b/docs/en/md/Slack/Channel-management/Archive-channel.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 4 ---- - -# Archive channel - Archives an active channel - - -*Function ArchiveChannel(Val Token, Val Channel) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.ArchiveChannel(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack ArchiveChannel --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Result" - -{ - "ok": true - } - -``` +--- +sidebar_position: 4 +--- + +# Archive channel + Archives an active channel + + +*Function ArchiveChannel(Val Token, Val Channel) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.ArchiveChannel(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack ArchiveChannel --token %token% --channel "C070VPMKN8J" + + +``` + + +```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 index 0f6731e447..c61bf943ca 100644 --- a/docs/en/md/Slack/Channel-management/Create-channel.md +++ b/docs/en/md/Slack/Channel-management/Create-channel.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 3 ---- - -# Create channel - Creates a new channel - - -*Function CreateChannel(Val Token, Val Name, Val Private = False) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Name | --title | String | Channel name | - | Private | --private | Boolean | Create channel as private | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Name = "testcov" + String(New UUID); - - Response = OPI_Slack.CreateChannel(Token, Name, False); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack CreateChannel --token %token% --title %title% --private %private% - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542419, - "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 - } - } - -``` +--- +sidebar_position: 3 +--- + +# Create channel + Creates a new channel + + +*Function CreateChannel(Val Token, Val Name, Val Private = False) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Name | --title | String | Channel name | + | Private | --private | Boolean | Create channel as private | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Name = "testcov" + String(New UUID); + + Response = OPI_Slack.CreateChannel(Token, Name, False); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack CreateChannel --token %token% --title %title% --private %private% + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542419, + "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 index f0700a9360..7750bd42fc 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel-history.md +++ b/docs/en/md/Slack/Channel-management/Get-channel-history.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 6 ---- - -# Get channel history - Gets information about channel events - - -*Function GetChannelHistory(Val Token, Val Channel) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.GetChannelHistory(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetChannelHistory --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Result" - -{ - "ok": true, - "messages": [ - { - "subtype": "channel_join", - "user": "U06UABH3APP", - "text": "<@U06UABH3APP> has joined the channel", - "inviter": "U06UG1CAYH2", - "type": "message", - "ts": "1714146543.286219" - }, - { - "subtype": "channel_purpose", - "user": "U06UG1CAYH2", - "purpose": "TestGoal", - "text": "set the channel description: TestGoal", - "type": "message", - "ts": "1714146543.014349" - }, - { - "subtype": "channel_topic", - "user": "U06UG1CAYH2", - "topic": "TestTopic", - "text": "set the channel topic: TestTopic", - "type": "message", - "ts": "1714146542.849559" - }, - { - "subtype": "channel_join", - "user": "U06UG1CAYH2", - "text": "<@U06UG1CAYH2> has joined the channel", - "type": "message", - "ts": "1714146542.605859" - } - ], - "has_more": false, - "pin_count": 0, - "channel_actions_ts": null, - "channel_actions_count": 0 - } - -``` +--- +sidebar_position: 6 +--- + +# Get channel history + Gets information about channel events + + +*Function GetChannelHistory(Val Token, Val Channel) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.GetChannelHistory(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetChannelHistory --token %token% --channel "C070VPMKN8J" + + +``` + + +```json title="Result" + +{ + "ok": true, + "messages": [ + { + "subtype": "channel_join", + "user": "U06UABH3APP", + "text": "<@U06UABH3APP> has joined the channel", + "inviter": "U06UG1CAYH2", + "type": "message", + "ts": "1714146543.286219" + }, + { + "subtype": "channel_purpose", + "user": "U06UG1CAYH2", + "purpose": "TestGoal", + "text": "set the channel description: TestGoal", + "type": "message", + "ts": "1714146543.014349" + }, + { + "subtype": "channel_topic", + "user": "U06UG1CAYH2", + "topic": "TestTopic", + "text": "set the channel topic: TestTopic", + "type": "message", + "ts": "1714146542.849559" + }, + { + "subtype": "channel_join", + "user": "U06UG1CAYH2", + "text": "<@U06UG1CAYH2> has joined the channel", + "type": "message", + "ts": "1714146542.605859" + } + ], + "has_more": 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 index 432b9810ff..c728686750 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel-list.md +++ b/docs/en/md/Slack/Channel-management/Get-channel-list.md @@ -1,91 +1,91 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - ExcludeArchived = True; - - Response = OPI_Slack.GetChannelList(Token, ExcludeArchived); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetChannelList --token %token% --notarchived "True" --cursor %cursor% - - -``` - - -```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": 1713202497794, - "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 - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + ExcludeArchived = True; + + Response = OPI_Slack.GetChannelList(Token, ExcludeArchived); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetChannelList --token %token% --notarchived "True" --cursor %cursor% + + +``` + + +```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": 1713202497794, + "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 + } + ] + } + +``` 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 index 00ddd8eb61..6945d1771c 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel-user-list.md +++ b/docs/en/md/Slack/Channel-management/Get-channel-user-list.md @@ -1,52 +1,52 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.GetChannelUserList(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetChannelUserList --token %token% --channel "C070VPMKN8J" --cursor %cursor% - - -``` - - -```json title="Result" - -{ - "ok": true, - "members": [ - "U06UG1CAYH2" - ], - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.GetChannelUserList(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetChannelUserList --token %token% --channel "C070VPMKN8J" --cursor %cursor% + + +``` + + +```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 index 746941ff65..d7c97dae58 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel.md +++ b/docs/en/md/Slack/Channel-management/Get-channel.md @@ -1,85 +1,85 @@ ---- -sidebar_position: 5 ---- - -# Get channel - Gets information about the channel - - -*Function GetChannel(Val Token, Val Channel) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.GetChannel(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response);//JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetChannel --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "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": 1714146542 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 5 +--- + +# Get channel + Gets information about the channel + + +*Function GetChannel(Val Token, Val Channel) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.GetChannel(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response);//JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetChannel --token %token% --channel "C070VPMKN8J" + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "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": 1714146542 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "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 index 966f31155a..479b2ec8e2 100644 --- a/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md +++ b/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md @@ -1,88 +1,88 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | ArrayOfUsers | --users | Array Of String | User ID Array | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - ArrayOfUsers = New Array; - ArrayOfUsers.Add("U06UG1CAYH2"); - - Response = OPI_Slack.InviteUsersToChannel(Token, Channel, ArrayOfUsers); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack InviteUsersToChannel --token %token% --channel "C070VPMKN8J" --users %users% - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "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": 1714146542 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [] - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | ArrayOfUsers | --users | Array Of String | User ID Array | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + ArrayOfUsers = New Array; + ArrayOfUsers.Add("U06UG1CAYH2"); + + Response = OPI_Slack.InviteUsersToChannel(Token, Channel, ArrayOfUsers); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack InviteUsersToChannel --token %token% --channel "C070VPMKN8J" --users %users% + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "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": 1714146542 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "previous_names": [] + } + } + +``` diff --git a/docs/en/md/Slack/Channel-management/Join-channel.md b/docs/en/md/Slack/Channel-management/Join-channel.md index d66b5781c3..1a126df1a5 100644 --- a/docs/en/md/Slack/Channel-management/Join-channel.md +++ b/docs/en/md/Slack/Channel-management/Join-channel.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 9 ---- - -# Join channel - Adds the current bot to the channel - - -*Function JoinChannel(Val Token, Val Channel) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.JoinChannel(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack JoinChannel --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1714146543.286219", - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [], - "priority": 0 - } - } - -``` +--- +sidebar_position: 9 +--- + +# Join channel + Adds the current bot to the channel + + +*Function JoinChannel(Val Token, Val Channel) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.JoinChannel(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack JoinChannel --token %token% --channel "C070VPMKN8J" + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1714146543.286219", + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "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 index b01b00e179..902b980de9 100644 --- a/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md +++ b/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md @@ -1,47 +1,47 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | User | --user | String | User ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - User = "U06UG1CAYH2"; - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.KickUserFromChannel(Token, Channel, User); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack KickUserFromChannel --token %token% --channel "C070VPMKN8J" --user "U06UG1CAYH2" - - -``` - - -```json title="Result" - -{ - "ok": true - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | User | --user | String | User ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + User = "U06UG1CAYH2"; + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.KickUserFromChannel(Token, Channel, User); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack KickUserFromChannel --token %token% --channel "C070VPMKN8J" --user "U06UG1CAYH2" + + +``` + + +```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 index 53f4c6a612..46c28a4263 100644 --- a/docs/en/md/Slack/Channel-management/Leave-channel.md +++ b/docs/en/md/Slack/Channel-management/Leave-channel.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 10 ---- - -# Leave channel - Removes the current bot from the channel - - -*Function LeaveChannel(Val Token, Val Channel) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.LeaveChannel(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack LeaveChannel --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Result" - -{ - "ok": true - } - -``` +--- +sidebar_position: 10 +--- + +# Leave channel + Removes the current bot from the channel + + +*Function LeaveChannel(Val Token, Val Channel) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.LeaveChannel(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack LeaveChannel --token %token% --channel "C070VPMKN8J" + + +``` + + +```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 index 9b79cfbe82..9ad9c336d2 100644 --- a/docs/en/md/Slack/Channel-management/Rename-channel.md +++ b/docs/en/md/Slack/Channel-management/Rename-channel.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 13 ---- - -# Rename channel - Changes the name of the channel - - -*Function RenameChannel(Val Token, Val Channel, Val Name) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Name | --title | String | New channel name | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Name = "testcov" + String(New UUID); - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.RenameChannel(Token, Channel, Name); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack RenameChannel --token %token% --channel "C070VPMKN8J" --title %title% - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146544414, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1714146543.286219", - "topic": { - "value": "TestTopic", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [ - "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c" - ] - } - } - -``` +--- +sidebar_position: 13 +--- + +# Rename channel + Changes the name of the channel + + +*Function RenameChannel(Val Token, Val Channel, Val Name) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Name | --title | String | New channel name | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Name = "testcov" + String(New UUID); + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.RenameChannel(Token, Channel, Name); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack RenameChannel --token %token% --channel "C070VPMKN8J" --title %title% + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146544414, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1714146543.286219", + "topic": { + "value": "TestTopic", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "previous_names": [ + "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c" + ] + } + } + +``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-goal.md b/docs/en/md/Slack/Channel-management/Set-channel-goal.md index 220ad876bf..1f3b06cc60 100644 --- a/docs/en/md/Slack/Channel-management/Set-channel-goal.md +++ b/docs/en/md/Slack/Channel-management/Set-channel-goal.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 12 ---- - -# Set channel purpose - Sets the channel purpose (description) - - -*Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Purpose | --purpose | String | Channel purpose | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Purpose = "TestGoal"; - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.SetChannelGoal(Token, Channel, Purpose); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack SetChannelGoal --token %token% --channel "C070VPMKN8J" --purpose "TestGoal" - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "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": 1714146542 - }, - "purpose": { - "value": "TestGoal", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 12 +--- + +# Set channel purpose + Sets the channel purpose (description) + + +*Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Purpose | --purpose | String | Channel purpose | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Purpose = "TestGoal"; + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.SetChannelGoal(Token, Channel, Purpose); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack SetChannelGoal --token %token% --channel "C070VPMKN8J" --purpose "TestGoal" + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "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": 1714146542 + }, + "purpose": { + "value": "TestGoal", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "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 index 60d5230e21..ba5e2ac7dd 100644 --- a/docs/en/md/Slack/Channel-management/Set-channel-topic.md +++ b/docs/en/md/Slack/Channel-management/Set-channel-topic.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 11 ---- - -# Set channel topic - Sets the channel topic - - -*Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Topic | --theme | String | Channel topic | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - Topic = "TestTopic"; - - Response = OPI_Slack.SetChannelTopic(Token, Channel, Topic); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack SetChannelTopic --token %token% --channel "C070VPMKN8J" --theme "TestTopic" - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542817, - "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": 1714146542 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 11 +--- + +# Set channel topic + Sets the channel topic + + +*Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Topic | --theme | String | Channel topic | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + Topic = "TestTopic"; + + Response = OPI_Slack.SetChannelTopic(Token, Channel, Topic); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack SetChannelTopic --token %token% --channel "C070VPMKN8J" --theme "TestTopic" + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542817, + "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": 1714146542 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [] + } + } + +``` diff --git a/docs/en/md/Slack/Channel-management/_category_.json b/docs/en/md/Slack/Channel-management/_category_.json index d4bfad97b6..fe831b2898 100644 --- a/docs/en/md/Slack/Channel-management/_category_.json +++ b/docs/en/md/Slack/Channel-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Channel management", -"position": "4" -} +{ +"label": "Channel management", +"position": "4" +} diff --git a/docs/en/md/Slack/Deleted-files-management/Add-external-file.md b/docs/en/md/Slack/Deleted-files-management/Add-external-file.md index 2497931bce..93779bea2f 100644 --- a/docs/en/md/Slack/Deleted-files-management/Add-external-file.md +++ b/docs/en/md/Slack/Deleted-files-management/Add-external-file.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 3 ---- - -# Add external file - Adds a new external file - - -*Function AddExternalFile(Val Token, Val URL, Val Title) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | URL | --url | String | URL to external file | - | Title | --title | String | File title for Slack | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - URL = https://opi.neocities.org/test_data/document.docx; - Title = "NewFile"; - - Response = OPI_Slack.AddExternalFile(Token, URL, Title); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack AddExternalFile --token %token% --url "https://opi.neocities.org/test_data/document.docx" --title %title% - - -``` - - -```json title="Result" - -{ - "ok": true, - "file": { - "id": "F070P52CU94", - "created": 1714146552, - "timestamp": 1714146552, - "name": "Novyj_fajl", - "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/F070P52CU94/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } - } - -``` +--- +sidebar_position: 3 +--- + +# Add external file + Adds a new external file + + +*Function AddExternalFile(Val Token, Val URL, Val Title) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | URL | --url | String | URL to external file | + | Title | --title | String | File title for Slack | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + URL = https://opi.neocities.org/test_data/document.docx; + Title = "NewFile"; + + Response = OPI_Slack.AddExternalFile(Token, URL, Title); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack AddExternalFile --token %token% --url "https://opi.neocities.org/test_data/document.docx" --title %title% + + +``` + + +```json title="Result" + +{ + "ok": true, + "file": { + "id": "F070P52CU94", + "created": 1714146552, + "timestamp": 1714146552, + "name": "Novyj_fajl", + "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/F070P52CU94/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } + } + +``` diff --git a/docs/en/md/Slack/Deleted-files-management/Delete-external-file.md b/docs/en/md/Slack/Deleted-files-management/Delete-external-file.md index 1c9facb6c4..90b8d0186a 100644 --- a/docs/en/md/Slack/Deleted-files-management/Delete-external-file.md +++ b/docs/en/md/Slack/Deleted-files-management/Delete-external-file.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Delete external file - Deletes an external file from Slack - - -*Function DeleteExternalFile(Val Token, Val FileID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - FileID = "F070P52CU94"; - - Response = OPI_Slack.DeleteExternalFile(Token, FileID); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack DeleteExternalFile --token %token% --fileid "F070P52CU94" - - -``` - - -```json title="Result" - -{ - "ok": true - } - -``` +--- +sidebar_position: 5 +--- + +# Delete external file + Deletes an external file from Slack + + +*Function DeleteExternalFile(Val Token, Val FileID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + FileID = "F070P52CU94"; + + Response = OPI_Slack.DeleteExternalFile(Token, FileID); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack DeleteExternalFile --token %token% --fileid "F070P52CU94" + + +``` + + +```json title="Result" + +{ + "ok": true + } + +``` diff --git a/docs/en/md/Slack/Deleted-files-management/Get-external-file-list.md b/docs/en/md/Slack/Deleted-files-management/Get-external-file-list.md index 03eb7cae0b..7d34f7b579 100644 --- a/docs/en/md/Slack/Deleted-files-management/Get-external-file-list.md +++ b/docs/en/md/Slack/Deleted-files-management/Get-external-file-list.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.GetExternalFileList(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetExternalFileList --token %token% --channel "C070VPMKN8J" --cursor %cursor% - - -``` - - -```json title="Result" - -{ - "ok": true, - "files": [], - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.GetExternalFileList(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetExternalFileList --token %token% --channel "C070VPMKN8J" --cursor %cursor% + + +``` + + +```json title="Result" + +{ + "ok": true, + "files": [], + "response_metadata": { + "next_cursor": "" + } + } + +``` diff --git a/docs/en/md/Slack/Deleted-files-management/Get-external-file.md b/docs/en/md/Slack/Deleted-files-management/Get-external-file.md index 086104fd0e..480ffa2967 100644 --- a/docs/en/md/Slack/Deleted-files-management/Get-external-file.md +++ b/docs/en/md/Slack/Deleted-files-management/Get-external-file.md @@ -1,80 +1,80 @@ ---- -sidebar_position: 2 ---- - -# Get external file - Gets information about the external file - - -*Function GetExternalFile(Val Token, Val FileID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - FileID = "F070P52CU94"; - - Response = OPI_Slack.GetExternalFile(Token, FileID); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetExternalFile --token %token% --fileid "F070P52CU94" - - -``` - - -```json title="Result" - -{ - "ok": true, - "file": { - "id": "F070P52CU94", - "created": 1714146552, - "timestamp": 1714146552, - "name": "Novyj_fajl", - "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/F070P52CU94/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } - } - -``` +--- +sidebar_position: 2 +--- + +# Get external file + Gets information about the external file + + +*Function GetExternalFile(Val Token, Val FileID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + FileID = "F070P52CU94"; + + Response = OPI_Slack.GetExternalFile(Token, FileID); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetExternalFile --token %token% --fileid "F070P52CU94" + + +``` + + +```json title="Result" + +{ + "ok": true, + "file": { + "id": "F070P52CU94", + "created": 1714146552, + "timestamp": 1714146552, + "name": "Novyj_fajl", + "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/F070P52CU94/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } + } + +``` diff --git a/docs/en/md/Slack/Deleted-files-management/Send-external-file.md b/docs/en/md/Slack/Deleted-files-management/Send-external-file.md index 4189a36ca4..816364a1be 100644 --- a/docs/en/md/Slack/Deleted-files-management/Send-external-file.md +++ b/docs/en/md/Slack/Deleted-files-management/Send-external-file.md @@ -1,99 +1,99 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - | ChannelArray | --channels | Array Of String | Array of channels for sending | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - FileID = "F070P52CU94"; - - Response = OPI_Slack.SendExternalFile(Token, FileID, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack SendExternalFile --token %token% --fileid "F070P52CU94" --channels %channels% - - -``` - - -```json title="Result" - -{ - "ok": true, - "file": { - "id": "F070P52CU94", - "created": 1714146552, - "timestamp": 1714146552, - "name": "Novyj_fajl", - "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/F070P52CU94/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": { - "public": { - "C06UFNUTKUL": [ - { - "reply_users": [], - "reply_users_count": 0, - "reply_count": 0, - "ts": "1714146553.217059", - "channel_name": "slack-api-librarry", - "team_id": "T06UD92BS3C", - "share_user_id": "U06UG1CAYH2", - "source": "UNKNOWN" - } - ] - } - }, - "channels": [ - "C06UFNUTKUL" - ], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + | ChannelArray | --channels | Array Of String | Array of channels for sending | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + FileID = "F070P52CU94"; + + Response = OPI_Slack.SendExternalFile(Token, FileID, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack SendExternalFile --token %token% --fileid "F070P52CU94" --channels %channels% + + +``` + + +```json title="Result" + +{ + "ok": true, + "file": { + "id": "F070P52CU94", + "created": 1714146552, + "timestamp": 1714146552, + "name": "Novyj_fajl", + "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/F070P52CU94/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": { + "public": { + "C06UFNUTKUL": [ + { + "reply_users": [], + "reply_users_count": 0, + "reply_count": 0, + "ts": "1714146553.217059", + "channel_name": "slack-api-librarry", + "team_id": "T06UD92BS3C", + "share_user_id": "U06UG1CAYH2", + "source": "UNKNOWN" + } + ] + } + }, + "channels": [ + "C06UFNUTKUL" + ], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } + } + +``` diff --git a/docs/en/md/Slack/Deleted-files-management/_category_.json b/docs/en/md/Slack/Deleted-files-management/_category_.json index 9aa593d1d4..d297bc0a00 100644 --- a/docs/en/md/Slack/Deleted-files-management/_category_.json +++ b/docs/en/md/Slack/Deleted-files-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Deleted files management", -"position": "7" -} +{ +"label": "Deleted files management", +"position": "7" +} diff --git a/docs/en/md/Slack/Dialog-management/Close-dialog.md b/docs/en/md/Slack/Dialog-management/Close-dialog.md index c5675e8fe4..2426a3c28d 100644 --- a/docs/en/md/Slack/Dialog-management/Close-dialog.md +++ b/docs/en/md/Slack/Dialog-management/Close-dialog.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 2 ---- - -# Close dialog - Closes an existing dialog - - -*Function CloseDialog(Val Token, Val Dialog) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Dialog | --conv | String | Dialog ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Dialog = "D06UAKK1C6R"; - - Response = OPI_Slack.CloseDialog(Token, Dialog); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack CloseDialog --token %token% --conv "D06UAKK1C6R" - - -``` - - -```json title="Result" - -{ - "ok": true, - "already_closed": false, - "no_op": false - } - -``` +--- +sidebar_position: 2 +--- + +# Close dialog + Closes an existing dialog + + +*Function CloseDialog(Val Token, Val Dialog) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Dialog | --conv | String | Dialog ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Dialog = "D06UAKK1C6R"; + + Response = OPI_Slack.CloseDialog(Token, Dialog); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack CloseDialog --token %token% --conv "D06UAKK1C6R" + + +``` + + +```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 index 3dd532deba..0250b1a039 100644 --- a/docs/en/md/Slack/Dialog-management/Open-dialog.md +++ b/docs/en/md/Slack/Dialog-management/Open-dialog.md @@ -1,52 +1,52 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ArrayOfUsers | --users | Array of String | User ID Array | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - ArrayOfUsers = New Array; - ArrayOfUsers.Add("U123456"); - ArrayOfUsers.Add("U654321"); - - Response = OPI_Slack.OpenDialog(Token, ArrayOfUsers); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack OpenDialog --token %token% --users %users% - - -``` - - -```json title="Result" - -{ - "ok": true, - "no_op": false, - "already_open": false, - "channel": { - "id": "D06UAKK1C6R" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ArrayOfUsers | --users | Array of String | User ID Array | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + ArrayOfUsers = New Array; + ArrayOfUsers.Add("U123456"); + ArrayOfUsers.Add("U654321"); + + Response = OPI_Slack.OpenDialog(Token, ArrayOfUsers); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack OpenDialog --token %token% --users %users% + + +``` + + +```json title="Result" + +{ + "ok": true, + "no_op": false, + "already_open": false, + "channel": { + "id": "D06UAKK1C6R" + } + } + +``` diff --git a/docs/en/md/Slack/Dialog-management/_category_.json b/docs/en/md/Slack/Dialog-management/_category_.json index f1b45121de..a2b59f819a 100644 --- a/docs/en/md/Slack/Dialog-management/_category_.json +++ b/docs/en/md/Slack/Dialog-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Dialog management", -"position": "5" -} +{ +"label": "Dialog management", +"position": "5" +} diff --git a/docs/en/md/Slack/File-work/Delete-file.md b/docs/en/md/Slack/File-work/Delete-file.md index 7d9c587c7a..b817ae276e 100644 --- a/docs/en/md/Slack/File-work/Delete-file.md +++ b/docs/en/md/Slack/File-work/Delete-file.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 4 ---- - -# Delete file - Deletes a file on Slack - - -*Function DeleteFile(Val Token, Val FileID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - FileID = "F070VL6FQFM"; - - Response = OPI_Slack.DeleteFile(Token, FileID); //Map - Response = OPI_Tools.JSONString(Response);//JSON string - - - -``` - -```sh title="CLI command example" - - oint slack DeleteFile --token %token% --fileid "F070VL6FQFM" - - -``` - - -```json title="Result" - -{ - "ok": true - } - -``` +--- +sidebar_position: 4 +--- + +# Delete file + Deletes a file on Slack + + +*Function DeleteFile(Val Token, Val FileID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + FileID = "F070VL6FQFM"; + + Response = OPI_Slack.DeleteFile(Token, FileID); //Map + Response = OPI_Tools.JSONString(Response);//JSON string + + + +``` + +```sh title="CLI command example" + + oint slack DeleteFile --token %token% --fileid "F070VL6FQFM" + + +``` + + +```json title="Result" + +{ + "ok": true + } + +``` diff --git a/docs/en/md/Slack/File-work/Get-file-data.md b/docs/en/md/Slack/File-work/Get-file-data.md index 31521dab82..2b0416b6a2 100644 --- a/docs/en/md/Slack/File-work/Get-file-data.md +++ b/docs/en/md/Slack/File-work/Get-file-data.md @@ -1,84 +1,84 @@ ---- -sidebar_position: 3 ---- - -# Get file data - Gets information about the file - - -*Function GetFileData(Val Token, Val FileID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String | File identifier | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - FileID = "F070VL6FQFM"; - - Response = OPI_Slack.GetFileData(Token, FileID); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetFileData --token %token% --fileid "F070VL6FQFM" - - -``` - - -```json title="Result" - -{ - "ok": true, - "file": { - "id": "F070VL6FQFM", - "created": 1714146550, - "timestamp": 1714146550, - "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-F070VL6FQFM/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070VL6FQFM/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F070VL6FQFM-9fb2618d36", - "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": "" - } - } - -``` +--- +sidebar_position: 3 +--- + +# Get file data + Gets information about the file + + +*Function GetFileData(Val Token, Val FileID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String | File identifier | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + FileID = "F070VL6FQFM"; + + Response = OPI_Slack.GetFileData(Token, FileID); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetFileData --token %token% --fileid "F070VL6FQFM" + + +``` + + +```json title="Result" + +{ + "ok": true, + "file": { + "id": "F070VL6FQFM", + "created": 1714146550, + "timestamp": 1714146550, + "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-F070VL6FQFM/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070VL6FQFM/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F070VL6FQFM-9fb2618d36", + "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-work/Get-files-list.md b/docs/en/md/Slack/File-work/Get-files-list.md index a3c1b50c76..dbb0ad9fc9 100644 --- a/docs/en/md/Slack/File-work/Get-files-list.md +++ b/docs/en/md/Slack/File-work/Get-files-list.md @@ -1,84 +1,84 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel for selection | - | PageNumber | --page | Number, String | Page number | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - PageNumber = 1; - Channel = "C123456"; - - Response = OPI_Slack.GetFilesList(Token, Channel, PageNumber); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetFilesList --token %token% --channel "C123456" --page "1" - - -``` - - -```json title="Result" - -{ - "ok": true, - "files": [ - { - "id": "F070V4U7Y4R", - "created": 1713978714, - "timestamp": 1713978714, - "name": "megadoc.docx", - "title": "NewFile", - "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "filetype": "docx", - "pretty_type": "Word Document", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": true, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/download/megadoc.docx", - "media_display_type": "unknown", - "converted_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_converted.pdf", - "thumb_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_thumb_pdf.png", - "thumb_pdf_w": 909, - "thumb_pdf_h": 1286, - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070V4U7Y4R/megadoc.docx", - "channels": [ - "C06UFNUTKUL" - ], - "groups": [], - "ims": [], - "comments_count": 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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel for selection | + | PageNumber | --page | Number, String | Page number | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + PageNumber = 1; + Channel = "C123456"; + + Response = OPI_Slack.GetFilesList(Token, Channel, PageNumber); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetFilesList --token %token% --channel "C123456" --page "1" + + +``` + + +```json title="Result" + +{ + "ok": true, + "files": [ + { + "id": "F070V4U7Y4R", + "created": 1713978714, + "timestamp": 1713978714, + "name": "megadoc.docx", + "title": "NewFile", + "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "filetype": "docx", + "pretty_type": "Word Document", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": true, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/download/megadoc.docx", + "media_display_type": "unknown", + "converted_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_converted.pdf", + "thumb_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_thumb_pdf.png", + "thumb_pdf_w": 909, + "thumb_pdf_h": 1286, + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070V4U7Y4R/megadoc.docx", + "channels": [ + "C06UFNUTKUL" + ], + "groups": [], + "ims": [], + "comments_count": 0 + } + ] + } + +``` diff --git a/docs/en/md/Slack/File-work/Make-file-private.md b/docs/en/md/Slack/File-work/Make-file-private.md index 579e1109f2..37ef241abf 100644 --- a/docs/en/md/Slack/File-work/Make-file-private.md +++ b/docs/en/md/Slack/File-work/Make-file-private.md @@ -1,37 +1,37 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | User token | - | FileID | --fileid | String | File identifier | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint slack MakeFilePrivate --token %token% --fileid %fileid% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | User token | + | FileID | --fileid | String | File identifier | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint slack MakeFilePrivate --token %token% --fileid %fileid% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/Slack/File-work/Make-file-public.md b/docs/en/md/Slack/File-work/Make-file-public.md index 74a2e0a3d0..181d351bd3 100644 --- a/docs/en/md/Slack/File-work/Make-file-public.md +++ b/docs/en/md/Slack/File-work/Make-file-public.md @@ -1,37 +1,37 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | User token | - | FileID | --fileid | String | File identifier | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint slack MakeFilePublic --token %token% --fileid %fileid% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | User token | + | FileID | --fileid | String | File identifier | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint slack MakeFilePublic --token %token% --fileid %fileid% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/Slack/File-work/Upload-file.md b/docs/en/md/Slack/File-work/Upload-file.md index 5505e66d3f..263804ae72 100644 --- a/docs/en/md/Slack/File-work/Upload-file.md +++ b/docs/en/md/Slack/File-work/Upload-file.md @@ -1,88 +1,88 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - FileName = "megadoc.docx"; - File = New BinaryData("D:\" + FileName); - Title = "NewFile"; - Channel = "C123456"; - - Response = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); //Map - Response = OPI_Tools.JSONString(Response);//JSON string - - - -``` - -```sh title="CLI command example" - - oint slack UploadFile --token %token% --file %file% --filename "megadoc.docx" --title %title% --channel "C123456" - - -``` - - -```json title="Result" - -{ - "ok": true, - "files": [ - { - "id": "F070SS4UHNZ", - "created": 1714146549, - "timestamp": 1714146549, - "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-F070SS4UHNZ/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070SS4UHNZ/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F070SS4UHNZ-e68bef4a91", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + FileName = "megadoc.docx"; + File = New BinaryData("D:\" + FileName); + Title = "NewFile"; + Channel = "C123456"; + + Response = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); //Map + Response = OPI_Tools.JSONString(Response);//JSON string + + + +``` + +```sh title="CLI command example" + + oint slack UploadFile --token %token% --file %file% --filename "megadoc.docx" --title %title% --channel "C123456" + + +``` + + +```json title="Result" + +{ + "ok": true, + "files": [ + { + "id": "F070SS4UHNZ", + "created": 1714146549, + "timestamp": 1714146549, + "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-F070SS4UHNZ/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070SS4UHNZ/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F070SS4UHNZ-e68bef4a91", + "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-work/_category_.json b/docs/en/md/Slack/File-work/_category_.json index 8f60e261fa..46620a2311 100644 --- a/docs/en/md/Slack/File-work/_category_.json +++ b/docs/en/md/Slack/File-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "File work", -"position": "6" -} +{ +"label": "File work", +"position": "6" +} 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 index 47c5655a9d..4a18757d5a 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md +++ b/docs/en/md/Slack/Management-and-settings/Get-bot-information.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 1 ---- - -# Get bot information - Gets basic information about the bot - - -*Function GetBotInformation(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - - Response = OPI_Slack.GetBotInformation(Token); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetBotInformation --token %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 - } - -``` +--- +sidebar_position: 1 +--- + +# Get bot information + Gets basic information about the bot + + +*Function GetBotInformation(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + + Response = OPI_Slack.GetBotInformation(Token); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetBotInformation --token %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 index 7aff36f6e7..f0cafa9211 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-user-list.md +++ b/docs/en/md/Slack/Management-and-settings/Get-user-list.md @@ -1,196 +1,196 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - - Response = OPI_Slack.GetUserList(Token, Cursor); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetUserList --token %token% --cursor %cursor% - - -``` - - -```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": "Anton Titovets", - "tz": "Europe/Moscow", - "tz_label": "Moscow Time", - "tz_offset": 10800, - "profile": { - "title": "", - "phone": "", - "skype": "", - "real_name": "Anton Titovets", - "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": "Anton", - "last_name": "Titovets", - "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" - } - ], - "cache_ts": 1714215811, - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + + Response = OPI_Slack.GetUserList(Token, Cursor); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetUserList --token %token% --cursor %cursor% + + +``` + + +```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": "Anton Titovets", + "tz": "Europe/Moscow", + "tz_label": "Moscow Time", + "tz_offset": 10800, + "profile": { + "title": "", + "phone": "", + "skype": "", + "real_name": "Anton Titovets", + "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": "Anton", + "last_name": "Titovets", + "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" + } + ], + "cache_ts": 1714215811, + "response_metadata": { + "next_cursor": "" + } + } + +``` 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 index 329036245d..715d4416fb 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md +++ b/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - - Response = OPI_Slack.GetWorkspaceList(Token); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetWorkspaceList --token %token% --cursor %cursor% - - -``` - - -```json title="Result" - -{ - "ok": true, - "teams": [ - { - "id": "T06UD92BS3C", - "name": "OpenIntegrations" - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + + Response = OPI_Slack.GetWorkspaceList(Token); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetWorkspaceList --token %token% --cursor %cursor% + + +``` + + +```json title="Result" + +{ + "ok": true, + "teams": [ + { + "id": "T06UD92BS3C", + "name": "OpenIntegrations" + } + ] + } + +``` diff --git a/docs/en/md/Slack/Management-and-settings/_category_.json b/docs/en/md/Slack/Management-and-settings/_category_.json index aba788daf1..ccdbf6eaf4 100644 --- a/docs/en/md/Slack/Management-and-settings/_category_.json +++ b/docs/en/md/Slack/Management-and-settings/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Management and settings", -"position": "2" -} +{ +"label": "Management and settings", +"position": "2" +} diff --git a/docs/en/md/Slack/Message-management/Delete-message.md b/docs/en/md/Slack/Message-management/Delete-message.md index 0b79548fd6..72000564b9 100644 --- a/docs/en/md/Slack/Message-management/Delete-message.md +++ b/docs/en/md/Slack/Message-management/Delete-message.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C06UFNUTKUL"; - Timestamp = "1714146538.221929"; - - Response = OPI_Slack.DeleteMessage(Token, Channel, Timestamp); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack DeleteMessage --token %token% --channel "C06UFNUTKUL" --stamp "1714146538.221929" --issheduled %issheduled% - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1714146538.221929" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C06UFNUTKUL"; + Timestamp = "1714146538.221929"; + + Response = OPI_Slack.DeleteMessage(Token, Channel, Timestamp); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack DeleteMessage --token %token% --channel "C06UFNUTKUL" --stamp "1714146538.221929" --issheduled %issheduled% + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1714146538.221929" + } + +``` diff --git a/docs/en/md/Slack/Message-management/Edit-message.md b/docs/en/md/Slack/Message-management/Edit-message.md index b309da9d79..78163b8c2d 100644 --- a/docs/en/md/Slack/Message-management/Edit-message.md +++ b/docs/en/md/Slack/Message-management/Edit-message.md @@ -1,91 +1,91 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - Timestamp = "1714146538.221929"; - Text = "TestMessage2"; - - Response = OPI_Slack.EditMessage(Token, Channel, Timestamp, Text); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack EditMessage --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --text "TestMessage2" --blocks %blocks% - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1714146538.221929", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1714146538.221929", - "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": "MO6", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "TestMessage2" - } - ] - } - ] - } - ] - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + Timestamp = "1714146538.221929"; + Text = "TestMessage2"; + + Response = OPI_Slack.EditMessage(Token, Channel, Timestamp, Text); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack EditMessage --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --text "TestMessage2" --blocks %blocks% + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1714146538.221929", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1714146538.221929", + "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": "MO6", + "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 index 081f994c30..5d1d8598b0 100644 --- a/docs/en/md/Slack/Message-management/Get-delayed-message-list.md +++ b/docs/en/md/Slack/Message-management/Get-delayed-message-list.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - - Response = OPI_Slack.GetDelayedMessageList(Token, Channel); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetDelayedMessageList --token %token% --channel "C070VPMKN8J" --cursor %cursor% - - -``` - - -```json title="Result" - -{ - "ok": true, - "scheduled_messages": [], - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + + Response = OPI_Slack.GetDelayedMessageList(Token, Channel); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetDelayedMessageList --token %token% --channel "C070VPMKN8J" --cursor %cursor% + + +``` + + +```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 index e98f75f72c..e877fe6a0a 100644 --- a/docs/en/md/Slack/Message-management/Get-message-link.md +++ b/docs/en/md/Slack/Message-management/Get-message-link.md @@ -1,49 +1,49 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | Channel | --channel | String | Channel ID | - | Timestamp | --stamp | String | Timestamp or message ID | - - - Returns: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - Timestamp = "1714146538.221929"; - - Response = OPI_Slack.GetMessageLink(Token, Channel, Timestamp); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetMessageLink --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" - - -``` - - -```json title="Result" - -{ - "ok": true, - "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1714146538221929", - "channel": "C06UFNUTKUL" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | Channel | --channel | String | Channel ID | + | Timestamp | --stamp | String | Timestamp or message ID | + + + Returns: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + Timestamp = "1714146538.221929"; + + Response = OPI_Slack.GetMessageLink(Token, Channel, Timestamp); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetMessageLink --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" + + +``` + + +```json title="Result" + +{ + "ok": true, + "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1714146538221929", + "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 index f2026cd83a..350ad5c488 100644 --- a/docs/en/md/Slack/Message-management/Get-message-reply-list.md +++ b/docs/en/md/Slack/Message-management/Get-message-reply-list.md @@ -1,94 +1,94 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - Timestamp = "1714146538.221929"; - - Response = OPI_Slack.GetMessageReplyList(Token, Channel, Timestamp); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack GetMessageReplyList --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --cursor %cursor% - - -``` - - -```json title="Result" - -{ - "ok": true, - "messages": [ - { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1714215813.399779", - "edited": { - "user": "B06TZ0MJV5M", - "ts": "1714215813.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": "04z", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "TestMessage2" - } - ] - } - ] - } - ] - } - ], - "has_more": false - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + Timestamp = "1714146538.221929"; + + Response = OPI_Slack.GetMessageReplyList(Token, Channel, Timestamp); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack GetMessageReplyList --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --cursor %cursor% + + +``` + + +```json title="Result" + +{ + "ok": true, + "messages": [ + { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1714215813.399779", + "edited": { + "user": "B06TZ0MJV5M", + "ts": "1714215813.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": "04z", + "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 index dd3f9a95c9..ef6feb8c5d 100644 --- a/docs/en/md/Slack/Message-management/Send-ephemeral-message.md +++ b/docs/en/md/Slack/Message-management/Send-ephemeral-message.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - Block = OPI_Slack.GenerateImageBlock("https://opi.neocities.org/test_data/picture.jpg", "Image"); - - Response = OPI_Slack.SendEphemeralMessage(Token, Channel,, User, Block); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack SendEphemeralMessage --token %token% --channel "C070VPMKN8J" --text %text% --user %user% --blocks %blocks% - - -``` - - -```json title="Result" - -{ - "ok": true, - "message_ts": "1714146540.000300" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + Block = OPI_Slack.GenerateImageBlock("https://opi.neocities.org/test_data/picture.jpg", "Image"); + + Response = OPI_Slack.SendEphemeralMessage(Token, Channel,, User, Block); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack SendEphemeralMessage --token %token% --channel "C070VPMKN8J" --text %text% --user %user% --blocks %blocks% + + +``` + + +```json title="Result" + +{ + "ok": true, + "message_ts": "1714146540.000300" + } + +``` diff --git a/docs/en/md/Slack/Message-management/Send-message.md b/docs/en/md/Slack/Message-management/Send-message.md index c5f89f69f3..1d9371b503 100644 --- a/docs/en/md/Slack/Message-management/Send-message.md +++ b/docs/en/md/Slack/Message-management/Send-message.md @@ -1,90 +1,90 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Slack - -```bsl title="Code example" - - - Channel = "C070VPMKN8J"; - Text = "TestMessage"; - - Response = OPI_Slack.SendMessage(Token, Channel, Text); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint slack SendMessage --token %token% --channel "C070VPMKN8J" --text "TestMessage" --date %date% --blocks %blocks% - - -``` - - -```json title="Result" - -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1714146538.221929", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1714146538.221929", - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "TestMessage", - "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": "MO6", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "TestMessage" - } - ] - } - ] - } - ] - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Slack + +```bsl title="Code example" + + + Channel = "C070VPMKN8J"; + Text = "TestMessage"; + + Response = OPI_Slack.SendMessage(Token, Channel, Text); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint slack SendMessage --token %token% --channel "C070VPMKN8J" --text "TestMessage" --date %date% --blocks %blocks% + + +``` + + +```json title="Result" + +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1714146538.221929", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1714146538.221929", + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "TestMessage", + "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": "MO6", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "TestMessage" + } + ] + } + ] + } + ] + } + } + +``` diff --git a/docs/en/md/Slack/Message-management/_category_.json b/docs/en/md/Slack/Message-management/_category_.json index 4e063731f5..be575a89ae 100644 --- a/docs/en/md/Slack/Message-management/_category_.json +++ b/docs/en/md/Slack/Message-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Message management", -"position": "3" -} +{ +"label": "Message management", +"position": "3" +} diff --git a/docs/en/md/Slack/Slack.md b/docs/en/md/Slack/Slack.md index ae6cd19d6a..8536444777 100644 --- a/docs/en/md/Slack/Slack.md +++ b/docs/en/md/Slack/Slack.md @@ -1,64 +1,64 @@ ---- -id: Slack -sidebar_class_name: Slack ---- - - - -# Slack - -Этот раздел поwithinящен библиотеtoе for work withо Slack Web API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -1. Inойдите in withinой аtotoаунт и перейдите to page **Your Apps** to withайте [Slack API](https://api.slack.com) - -![BF](../../static/img/Docs/Slack/1.png) - -
- -2. Nажмите **Create App** и inыберите пунtoт **From scratch** - -![BF](../../static/img/Docs/Slack/2.png) - -3. Inыберите name и рабочую облаwithть, in toоторой необходимо withоздать приложение - -![BF](../../static/img/Docs/Slack/3.png) - -
- -4. Создайте ноinый тоtoен, toжаin **Generate Token and Scopes** ниже to withтранице приложения - -![BF](../../static/img/Docs/Slack/4.png) - -
- -5. Inыберите имя и добаinьте разрешения - -![BF](../../static/img/Docs/Slack/5.png) - -
- -6. Перейдите in раздел **Premission scope** from пунtoта уwithтаноintoи приложения - -![BF](../../static/img/Docs/Slack/6.png) - -
- -7. Добаinьте необходимые for inаших целей разрешения - -![BF](../../static/img/Docs/Slack/7.png) - -
- -8. Уwithтаноinите приложение - -![BF](../../static/img/Docs/Slack/8.png) - -
- -9. Сохраните withгенерироinанный тоtoен - -![BF](../../static/img/Docs/Slack/9.png) - -
+--- +id: Slack +sidebar_class_name: Slack +--- + + + +# Slack + +Этот раздел поwithinящен библиотеtoе for work withо Slack Web API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +1. Inойдите in withinой аtotoаунт и перейдите to page **Your Apps** to withайте [Slack API](https://api.slack.com) + +![BF](../../static/img/Docs/Slack/1.png) + +
+ +2. Nажмите **Create App** и inыберите пунtoт **From scratch** + +![BF](../../static/img/Docs/Slack/2.png) + +3. Inыберите name и рабочую облаwithть, in toоторой необходимо withоздать приложение + +![BF](../../static/img/Docs/Slack/3.png) + +
+ +4. Создайте ноinый тоtoен, toжаin **Generate Token and Scopes** ниже to withтранице приложения + +![BF](../../static/img/Docs/Slack/4.png) + +
+ +5. Inыберите имя и добаinьте разрешения + +![BF](../../static/img/Docs/Slack/5.png) + +
+ +6. Перейдите in раздел **Premission scope** from пунtoта уwithтаноintoи приложения + +![BF](../../static/img/Docs/Slack/6.png) + +
+ +7. Добаinьте необходимые for inаших целей разрешения + +![BF](../../static/img/Docs/Slack/7.png) + +
+ +8. Уwithтаноinите приложение + +![BF](../../static/img/Docs/Slack/8.png) + +
+ +9. Сохраните withгенерироinанный тоtoен + +![BF](../../static/img/Docs/Slack/9.png) + +
diff --git a/docs/en/md/Slack/_category_.json b/docs/en/md/Slack/_category_.json index fb647b2759..0b1ed35cc3 100644 --- a/docs/en/md/Slack/_category_.json +++ b/docs/en/md/Slack/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Slack", - "position": 9, - "link": { - "type": "doc", - "id": "Slack" - } -} +{ + "label": "Slack", + "position": 9, + "link": { + "type": "doc", + "id": "Slack" + } +} diff --git a/docs/en/md/Start/CLI_version.md b/docs/en/md/Start/CLI_version.md index b04ebdf778..4f920abbbb 100644 --- a/docs/en/md/Start/CLI_version.md +++ b/docs/en/md/Start/CLI_version.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 2 ---- - -# Working with CLI app - -**OInt CLI** - приложение for commandsой withтроtoи, toоторое позinоляет иwithпользоinать methodы Отtoрытого паtoета интеграций незаinиwithимо от 1С и OneScript. For его work требуетwithя **.Net Framework 4.8** or withопоwithтаinимый **Mono Runtime** (при иwithпользоinании deb и rpm паtoетоin уwithтаtoinлиinаетwithя аinтоматичеwithtoи) - -## First запуwithto - -For of start work необходимо inызinать commandsу `oint` from commandsной withтроtoи/термиtoла. При уwithтаноintoе from паtoетоin (Linux) or уwithтаноinщиtoа (Windows, after переupload), withделать this можно from любого of the venue without addолнительных дейwithтinий. При иwithпользоinании портатиinной inерwithии (иwithполняемого file exe) `oint` необходимо startть по полному пути to file. In Linux-диwithтрибутиinах, таtoже, предinарительно нужно will пропиwithать `chmod +x /oint` - -Запуwithto портатиinной inерwithии in RHEL/Fedora/CentOS (диwithтрибутиinы, иwithпользующие rpm-паtoеты) оwithущеwithтinляетwithя commandsой
`mono /oint "$@"` - -![demo](./img/1.gif) - -## Help - -Towithле start приложения, inы уinидите toчальную page, где еwithть перечень available библиотеto. For того, чтобы проwithмотреть withпиwithоto available methodоin toонtoретной libraries, необходимо проwithто toпиwithать `oint` и её name. Nапример `oint telegram`. Аtoлогично можно узtoть подробноwithти о toонtoретном methodе - необходимо inызinать commandsу `oint <библиотеtoа> `, toпример `oint telegram SendTextMessage` - ->**Inажно:** Andмеto библиотеto чуinwithтinительны to региwithтру и пишутwithя withтрочными буtoinами. Andмеto methodоin to региwithтру не чуinwithтinительны - -![demo](./img/3.gif) - -## Andwithпользоinание methodоin -Kаto и большинwithтinо других программ, toцеленных to иwithпользоinание in bat/sh withtoриптах, toаждое отдельное дейwithтinие Oint CLI inызыinаетwithя полной withтроtoой inызоinа withледующего inида: - -```powershell - oint <библиотеtoа> --парам1 "Value" --парам2 "Value"... -``` - -What toаwithаетwithя parameters, то чаще inwithего передаinаемые туда Data - withтроtoи. Это может be text, пути to fileм, URL и пр. Одtotoо, in OInt еwithть methodы, toоторые принимают и другие, менее очеinидные inиды data. Это могут be: - - + Даты - передаютwithя toаto withтроtoи формата ISO 8601 - + Arrayы - передаютwithя toаto withтроtoи inида `"['Val1','Val2','Val3']"` - + JSON - передаетwithя toаto path to file - -Towithле inыполнения запрашиinаемого дейwithтinия, программа inыinодит результат и заinершает работу. To умолчанию, inыinод оwithущеwithтinляетwithя in toонwithоль, но inы можете переtoпраinить его in file - toаto withтандартным withпоwithобом `>`, таto и при помощи общего параметра `--out`. Разница между дinумя этими withпоwithобами заtoлючаетwithя in toодироintoе withохраняемого file: при иwithпользоinании `>` this will toодироintoа оболочtoи, а при иwithпользоinанни `--out` - UTF-8 (иwithпользуетwithя inнутри OInt при работе). Таtoже иwithпользоinание `--out` обязательно for methodоin, inозinращающих дinоичные Data in отinете (like withtoачиinания file from Google Drive, toпример) - -![demo](./img/2.gif) - -Inwithю дальнейшую информацию, toоторая может поtoдобитьwithя inам for work, inы withможете toйти in других разделах данной доtoументации, а таtoже inо inwithтроенной withпраintoе OInt CLI +--- +sidebar_position: 2 +--- + +# Working with CLI app + +**OInt CLI** - приложение for commandsой withтроtoи, toоторое позinоляет иwithпользоinать methodы Отtoрытого паtoета интеграций незаinиwithимо от 1С и OneScript. For его work требуетwithя **.Net Framework 4.8** or withопоwithтаinимый **Mono Runtime** (при иwithпользоinании deb и rpm паtoетоin уwithтаtoinлиinаетwithя аinтоматичеwithtoи) + +## First запуwithto + +For of start work необходимо inызinать commandsу `oint` from commandsной withтроtoи/термиtoла. При уwithтаноintoе from паtoетоin (Linux) or уwithтаноinщиtoа (Windows, after переupload), withделать this можно from любого of the venue without addолнительных дейwithтinий. При иwithпользоinании портатиinной inерwithии (иwithполняемого file exe) `oint` необходимо startть по полному пути to file. In Linux-диwithтрибутиinах, таtoже, предinарительно нужно will пропиwithать `chmod +x /oint` + +Запуwithto портатиinной inерwithии in RHEL/Fedora/CentOS (диwithтрибутиinы, иwithпользующие rpm-паtoеты) оwithущеwithтinляетwithя commandsой
`mono /oint "$@"` + +![demo](./img/1.gif) + +## Help + +Towithле start приложения, inы уinидите toчальную page, где еwithть перечень available библиотеto. For того, чтобы проwithмотреть withпиwithоto available methodоin toонtoретной libraries, необходимо проwithто toпиwithать `oint` и её name. Nапример `oint telegram`. Аtoлогично можно узtoть подробноwithти о toонtoретном methodе - необходимо inызinать commandsу `oint <библиотеtoа> `, toпример `oint telegram SendTextMessage` + +>**Inажно:** Andмеto библиотеto чуinwithтinительны to региwithтру и пишутwithя withтрочными буtoinами. Andмеto methodоin to региwithтру не чуinwithтinительны + +![demo](./img/3.gif) + +## Andwithпользоinание methodоin +Kаto и большинwithтinо других программ, toцеленных to иwithпользоinание in bat/sh withtoриптах, toаждое отдельное дейwithтinие Oint CLI inызыinаетwithя полной withтроtoой inызоinа withледующего inида: + +```powershell + oint <библиотеtoа> --парам1 "Value" --парам2 "Value"... +``` + +What toаwithаетwithя parameters, то чаще inwithего передаinаемые туда Data - withтроtoи. Это может be text, пути to fileм, URL и пр. Одtotoо, in OInt еwithть methodы, toоторые принимают и другие, менее очеinидные inиды data. Это могут be: + + + Даты - передаютwithя toаto withтроtoи формата ISO 8601 + + Arrayы - передаютwithя toаto withтроtoи inида `"['Val1','Val2','Val3']"` + + JSON - передаетwithя toаto path to file + +Towithле inыполнения запрашиinаемого дейwithтinия, программа inыinодит результат и заinершает работу. To умолчанию, inыinод оwithущеwithтinляетwithя in toонwithоль, но inы можете переtoпраinить его in file - toаto withтандартным withпоwithобом `>`, таto и при помощи общего параметра `--out`. Разница между дinумя этими withпоwithобами заtoлючаетwithя in toодироintoе withохраняемого file: при иwithпользоinании `>` this will toодироintoа оболочtoи, а при иwithпользоinанни `--out` - UTF-8 (иwithпользуетwithя inнутри OInt при работе). Таtoже иwithпользоinание `--out` обязательно for methodоin, inозinращающих дinоичные Data in отinете (like withtoачиinания file from Google Drive, toпример) + +![demo](./img/2.gif) + +Inwithю дальнейшую информацию, toоторая может поtoдобитьwithя inам for work, inы withможете toйти in других разделах данной доtoументации, а таtoже inо inwithтроенной withпраintoе OInt CLI diff --git a/docs/en/md/Start/Release-variants.md b/docs/en/md/Start/Release-variants.md index 589534a2dc..9f27ae2134 100644 --- a/docs/en/md/Start/Release-variants.md +++ b/docs/en/md/Start/Release-variants.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 1 ---- - -# About releases variants - -The Open Integration Package is a project with three development paths: 1C, OneScript, and CLI. The main version is 1C, which is then automatically transformed into a package for OneScript, and from there into a CLI application. Each of these paths has its own distribution options – there are 8 in total: 3 for 1C, 4 for CLI, and 1 for OneScript. Descriptions of each of these are provided below - ->To the latest release: [Click!](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest) - -## 1С:Enterprise -These release options are various forms of distribution for the extension for the 1C:Enterprise platform - - -**OpenIntegrations_x.x.x.cfe** - the standard distribution option for the 1C configuration extension. To start working, it is sufficient to load it into the list of extensions for your specific configuration. Development is carried out in compatibility mode with 1C 8.3.9. - - -**XML.zip** - this is a zip archive that contains the files of the standard 1C extension export "to files". Similar to the CFE option, the unpacked archive can be used to load the extension through the Configuration Extensions panel in a specific project - - -**EDT.zip** - this is a zip archive that contains the files of the EDT extension project. This distribution option is intended for quickly starting work with the Open Integration Package in cases where the development of the main configuration is carried out using 1C Enterprise Development Tools - -
- -## CLI -these release options are various forms of distribution for OInt CLI – a cross-platform terminal/command line application that implements the full functionality of the OpenIntegrations library without being tied to the 1C/OS technology stack. The system requirements for OInt are the system requirements for OneScript: **.Net Framework 4.8 (Windows)** or **a comparable version of Mono (Linux)** - - -**oint.exe** - an executable file that, despite its Windows-oriented extension, is cross-platform. It requires .Net Framework 4.8 or a compatible version of Mono to run. In Windows and Debian-based distributions, this application is launched simply through the command line/terminal, while in RHEL-based distributions, it is launched through ```mono oint.exe "$@"``` - - -**oint_x.x.x_installer.exe** - this is a Windows installer. It is the recommended installation method for Windows OS, as it automatically creates the program directory and sets the PATH (after restarting the computer). This allows the application to be launched from any location by simply typing oint in the command line - - -**oint_x.x.x_all.deb** - this is a DEB package designed for installing OInt on Debian/Ubuntu distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working - - -**oint-x.x.x-1.el7.x86_64.rpm** - this is an RPM package designed for installing OInt on RHEL/Fedora/CentOS distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working. Also, there is no need to run it through mono, as with the exe. - -
- - -## OneScript -These release options are intended for use in OneScript projects - - -**oint-x.x.x.ospx** - this is an OSPX package intended for installation via the OPM package manager. You can use it for offline installation using the command -``` opm install -f "./OInt-x.x.x.ospx" ```. -But it is much easier to install OInt directly from the package hub. You don't need to download any files for this, just execute the command ``` opm install oint ``` - - - -
+--- +sidebar_position: 1 +--- + +# About releases variants + +The Open Integration Package is a project with three development paths: 1C, OneScript, and CLI. The main version is 1C, which is then automatically transformed into a package for OneScript, and from there into a CLI application. Each of these paths has its own distribution options – there are 8 in total: 3 for 1C, 4 for CLI, and 1 for OneScript. Descriptions of each of these are provided below + +>To the latest release: [Click!](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest) + +## 1С:Enterprise +These release options are various forms of distribution for the extension for the 1C:Enterprise platform + + +**OpenIntegrations_x.x.x.cfe** - the standard distribution option for the 1C configuration extension. To start working, it is sufficient to load it into the list of extensions for your specific configuration. Development is carried out in compatibility mode with 1C 8.3.9. + + +**XML.zip** - this is a zip archive that contains the files of the standard 1C extension export "to files". Similar to the CFE option, the unpacked archive can be used to load the extension through the Configuration Extensions panel in a specific project + + +**EDT.zip** - this is a zip archive that contains the files of the EDT extension project. This distribution option is intended for quickly starting work with the Open Integration Package in cases where the development of the main configuration is carried out using 1C Enterprise Development Tools + +
+ +## CLI +these release options are various forms of distribution for OInt CLI – a cross-platform terminal/command line application that implements the full functionality of the OpenIntegrations library without being tied to the 1C/OS technology stack. The system requirements for OInt are the system requirements for OneScript: **.Net Framework 4.8 (Windows)** or **a comparable version of Mono (Linux)** + + +**oint.exe** - an executable file that, despite its Windows-oriented extension, is cross-platform. It requires .Net Framework 4.8 or a compatible version of Mono to run. In Windows and Debian-based distributions, this application is launched simply through the command line/terminal, while in RHEL-based distributions, it is launched through ```mono oint.exe "$@"``` + + +**oint_x.x.x_installer.exe** - this is a Windows installer. It is the recommended installation method for Windows OS, as it automatically creates the program directory and sets the PATH (after restarting the computer). This allows the application to be launched from any location by simply typing oint in the command line + + +**oint_x.x.x_all.deb** - this is a DEB package designed for installing OInt on Debian/Ubuntu distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working + + +**oint-x.x.x-1.el7.x86_64.rpm** - this is an RPM package designed for installing OInt on RHEL/Fedora/CentOS distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working. Also, there is no need to run it through mono, as with the exe. + +
+ + +## OneScript +These release options are intended for use in OneScript projects + + +**oint-x.x.x.ospx** - this is an OSPX package intended for installation via the OPM package manager. You can use it for offline installation using the command +``` opm install -f "./OInt-x.x.x.ospx" ```. +But it is much easier to install OInt directly from the package hub. You don't need to download any files for this, just execute the command ``` opm install oint ``` + + + +
diff --git a/docs/en/md/Start/Start.md b/docs/en/md/Start/Start.md index f13800a4c4..dc0b00eeb1 100644 --- a/docs/en/md/Start/Start.md +++ b/docs/en/md/Start/Start.md @@ -1,44 +1,44 @@ ---- -id: Start -sidebar_class_name: NachaloRaboty ---- - -# Welcome! - -![OPI](../../static/img/logo_long.png) - -**Open Integrations Package** - is a set of tools for integration with some popular APIs via CLI, 1C, or OneScript. It consists of common modules, each responsible for its own API, as well as several utility modules that are common to all. - -The implemented methods perform specific tasks (such as *SendMessage()* or *CreatePost()*), allowing them to be used without delving into the implementation details. However, the code is highly decomposed – authorization methods, data retrieval, etc., are separated into individual functions where possible. This makes it easy to add new methods, even if they are not yet implemented in the library at the current time. - -
- -## Getting started - -The library releases come in five variants: - -- As a CLI application for Windows and Linux (exe, rpm, deb) -- As XML extension files for loading via the configurator -- As an EDT extension project -- As a standalone extension file in cfe format -- As a OneScript extension package in ospx format - -Regardless of the chosen installation method, the files must be obtained from the [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases) section, as the repository files may contain intermediate data and functions that are still in development. - -For more details about each release variant, see the section [About Release Variants](/docs/Start/Release-variants) - -
- -## Structure of modules - -The project's common modules come in two types: - -- Service - - OPI_Tools - - OPI_Cryptography -- Modules for direct interaction with APIs - - OPI_Telegram, OPI_VK... - -:::warning -It is not recommended to use the methods of utility modules in other parts of your configuration (if you plan to update to new versions in the future). To maintain backward compatibility, the number/purpose of parameters and the return types for API interaction methods do not change, but this does not apply to utility modules, which can be modified in any way for optimization and adaptation to new requirements. If you need functionality from the utility modules, it is recommended to copy it separately. -::: +--- +id: Start +sidebar_class_name: NachaloRaboty +--- + +# Welcome! + +![OPI](../../static/img/logo_long.png) + +**Open Integrations Package** - is a set of tools for integration with some popular APIs via CLI, 1C, or OneScript. It consists of common modules, each responsible for its own API, as well as several utility modules that are common to all. + +The implemented methods perform specific tasks (such as *SendMessage()* or *CreatePost()*), allowing them to be used without delving into the implementation details. However, the code is highly decomposed – authorization methods, data retrieval, etc., are separated into individual functions where possible. This makes it easy to add new methods, even if they are not yet implemented in the library at the current time. + +
+ +## Getting started + +The library releases come in five variants: + +- As a CLI application for Windows and Linux (exe, rpm, deb) +- As XML extension files for loading via the configurator +- As an EDT extension project +- As a standalone extension file in cfe format +- As a OneScript extension package in ospx format + +Regardless of the chosen installation method, the files must be obtained from the [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases) section, as the repository files may contain intermediate data and functions that are still in development. + +For more details about each release variant, see the section [About Release Variants](/docs/Start/Release-variants) + +
+ +## Structure of modules + +The project's common modules come in two types: + +- Service + - OPI_Tools + - OPI_Cryptography +- Modules for direct interaction with APIs + - OPI_Telegram, OPI_VK... + +:::warning +It is not recommended to use the methods of utility modules in other parts of your configuration (if you plan to update to new versions in the future). To maintain backward compatibility, the number/purpose of parameters and the return types for API interaction methods do not change, but this does not apply to utility modules, which can be modified in any way for optimization and adaptation to new requirements. If you need functionality from the utility modules, it is recommended to copy it separately. +::: diff --git a/docs/en/md/Start/_category_.json b/docs/en/md/Start/_category_.json index 20cf5e37d0..512475452f 100644 --- a/docs/en/md/Start/_category_.json +++ b/docs/en/md/Start/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Getting started", - "position": 1, - "link": { - "type": "doc", - "id": "Start" - } -} +{ + "label": "Getting started", + "position": 1, + "link": { + "type": "doc", + "id": "Start" + } +} diff --git a/docs/en/md/Telegram/Administration/Ban.md b/docs/en/md/Telegram/Administration/Ban.md index 3dbf7bc00f..e6836d4ea3 100644 --- a/docs/en/md/Telegram/Administration/Ban.md +++ b/docs/en/md/Telegram/Administration/Ban.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 1 ---- - -# Ban - Bans a user in the selected chat - - -*Function Ban(Val Token, Val ChatID, Val UserID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | UserID | --user | String, Number | Target user ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - UserID = "461699897"; - ChannelID = "@testsichee"; - - Result = OPI_Telegram.Ban(Token, ChannelID, UserID); - - -``` - -```sh title="CLI command example" - - oint telegram Ban --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897" - - -``` - - -```json title="Result" - -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} - -``` +--- +sidebar_position: 1 +--- + +# Ban + Bans a user in the selected chat + + +*Function Ban(Val Token, Val ChatID, Val UserID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | UserID | --user | String, Number | Target user ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + UserID = "461699897"; + ChannelID = "@testsichee"; + + Result = OPI_Telegram.Ban(Token, ChannelID, UserID); + + +``` + +```sh title="CLI command example" + + oint telegram Ban --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897" + + +``` + + +```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 index 74b7fcd0db..6d47b1392d 100644 --- a/docs/en/md/Telegram/Administration/Create-invitation-link.md +++ b/docs/en/md/Telegram/Administration/Create-invitation-link.md @@ -1,67 +1,67 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Telegram - -```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); - - -``` - -```sh title="CLI command example" - - oint telegram CreateInvitationLink --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --title %title% --expire %expire% --limit %limit% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "invite_link": "https://t.me/+W-9MzjOejStiYzYy", - "name": "Link 05/30/2024 12:34:59", - "creator": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "expire_date": 1717155300, - "member_limit": 200, - "creates_join_request": false, - "is_primary": false, - "is_revoked": false - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Telegram + +```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); + + +``` + +```sh title="CLI command example" + + oint telegram CreateInvitationLink --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --title %title% --expire %expire% --limit %limit% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "invite_link": "https://t.me/+W-9MzjOejStiYzYy", + "name": "Link 05/30/2024 12:34:59", + "creator": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "expire_date": 1717155300, + "member_limit": 200, + "creates_join_request": false, + "is_primary": false, + "is_revoked": false + } +} + +``` diff --git a/docs/en/md/Telegram/Administration/Get-participant-count.md b/docs/en/md/Telegram/Administration/Get-participant-count.md index 4c85f06f39..be5497595b 100644 --- a/docs/en/md/Telegram/Administration/Get-participant-count.md +++ b/docs/en/md/Telegram/Administration/Get-participant-count.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 6 ---- - -# Get participant count - Gets the total number of chat participants - - -*Function GetParticipantCount(Val Token, Val ChatID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - - Result = OPI_Telegram.GetParticipantCount(Token, ChannelID); - - -``` - -```sh title="CLI command example" - - oint telegram GetParticipantCount --token "6129457865:AAFyzNYOAFbu..." --chat %chat% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": 2 -} - -``` +--- +sidebar_position: 6 +--- + +# Get participant count + Gets the total number of chat participants + + +*Function GetParticipantCount(Val Token, Val ChatID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + + Result = OPI_Telegram.GetParticipantCount(Token, ChannelID); + + +``` + +```sh title="CLI command example" + + oint telegram GetParticipantCount --token "6129457865:AAFyzNYOAFbu..." --chat %chat% + + +``` + + +```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 index 18f8bea314..980f518542 100644 --- a/docs/en/md/Telegram/Administration/Pin-message.md +++ b/docs/en/md/Telegram/Administration/Pin-message.md @@ -1,46 +1,46 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --chat | String, Number | Target chat ID | - | MessageID | --message | String, Number | Target message ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - MessageID = "4951"; - - Result = OPI_Telegram.PinMessage(Token, ChannelID, MessageID); - - -``` - -```sh title="CLI command example" - - oint telegram PinMessage --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --chat | String, Number | Target chat ID | + | MessageID | --message | String, Number | Target message ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + MessageID = "4951"; + + Result = OPI_Telegram.PinMessage(Token, ChannelID, MessageID); + + +``` + +```sh title="CLI command example" + + oint telegram PinMessage --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" + + +``` + + +```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 index b05300c115..17a8f095fb 100644 --- a/docs/en/md/Telegram/Administration/Unban.md +++ b/docs/en/md/Telegram/Administration/Unban.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 2 ---- - -# Unban - Unbans a previously banned user - - -*Function Unban(Val Token, Val ChatID, Val UserID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | UserID | --user | String, Number | Target user ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - UserID = "461699897"; - ChannelID = "@testsichee"; - - Result = OPI_Telegram.Unban(Token, ChannelID, UserID); - - -``` - -```sh title="CLI command example" - - oint telegram Unban --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897" - - -``` - - -```json title="Result" - -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} - -``` +--- +sidebar_position: 2 +--- + +# Unban + Unbans a previously banned user + + +*Function Unban(Val Token, Val ChatID, Val UserID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | UserID | --user | String, Number | Target user ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + UserID = "461699897"; + ChannelID = "@testsichee"; + + Result = OPI_Telegram.Unban(Token, ChannelID, UserID); + + +``` + +```sh title="CLI command example" + + oint telegram Unban --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897" + + +``` + + +```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 index 4d873cc23b..2073b81632 100644 --- a/docs/en/md/Telegram/Administration/Unpin-message.md +++ b/docs/en/md/Telegram/Administration/Unpin-message.md @@ -1,46 +1,46 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID | - | MessageID | --message | String, Number | Target message ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChannelID = "@testsichee"; - MessageID = "4951"; - - Result = OPI_Telegram.UnpinMessage(Token, ChannelID, MessageID); - - -``` - -```sh title="CLI command example" - - oint telegram UnpinMessage --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID | + | MessageID | --message | String, Number | Target message ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChannelID = "@testsichee"; + MessageID = "4951"; + + Result = OPI_Telegram.UnpinMessage(Token, ChannelID, MessageID); + + +``` + +```sh title="CLI command example" + + oint telegram UnpinMessage --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": true +} + +``` diff --git a/docs/en/md/Telegram/Administration/_category_.json b/docs/en/md/Telegram/Administration/_category_.json index 5cd8a982e1..5558f28a34 100644 --- a/docs/en/md/Telegram/Administration/_category_.json +++ b/docs/en/md/Telegram/Administration/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Administration", -"position": "4" -} +{ +"label": "Administration", +"position": "4" +} 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 index 2cf58459d9..0be9401624 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 4 ---- - -# Delete webhook - Deletes the bot event handler URL for webhook operation - - -*Function DeleteWebhook(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.DeleteWebhook(Token); - - -``` - -```sh title="CLI command example" - - oint telegram DeleteWebhook --token "6129457865:AAFyzNYOAFbu..." - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true, - "description": "Webhook was deleted" -} - -``` +--- +sidebar_position: 4 +--- + +# Delete webhook + Deletes the bot event handler URL for webhook operation + + +*Function DeleteWebhook(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.DeleteWebhook(Token); + + +``` + +```sh title="CLI command example" + + oint telegram DeleteWebhook --token "6129457865:AAFyzNYOAFbu..." + + +``` + + +```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 index f0004ba31c..2c512e6698 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 5 ---- - -# Download file - Download file from Telegram servers - - -*Function DownloadFile(Val Token, Val FileID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | FileID | --fileid | String | File ID for downloading | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - FileID = "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE"; - Token = "6129457865:AAFyzNYOAFbu..."; - - Result = OPI_Telegram.DownloadFile(Token, FileID); - - -``` - -```sh title="CLI command example" - - oint telegram DownloadFile --token "6129457865:AAFyzNYOAFbu..." --fileid "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE" - - -``` - - -```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… - -``` +--- +sidebar_position: 5 +--- + +# Download file + Download file from Telegram servers + + +*Function DownloadFile(Val Token, Val FileID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | FileID | --fileid | String | File ID for downloading | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + FileID = "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE"; + Token = "6129457865:AAFyzNYOAFbu..."; + + Result = OPI_Telegram.DownloadFile(Token, FileID); + + +``` + +```sh title="CLI command example" + + oint telegram DownloadFile --token "6129457865:AAFyzNYOAFbu..." --fileid "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE" + + +``` + + +```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 index 8e3ca55b2f..a5cf3a711a 100644 --- 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 @@ -1,50 +1,50 @@ ---- -sidebar_position: 1 ---- - -# Get bot information -Executes the getMe request, returning basic bot information: name, id, ability to add the bot to groups, etc.. - - -*Function GetBotInformation(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.GetBotInformation(Token); - - -``` - -```sh title="CLI command example" - - oint telegram GetBotInformation --token "6129457865:AAFyzNYOAFbu..." - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot", - "can_join_groups": true, - "can_read_all_group_messages": false, - "supports_inline_queries": false, - "can_connect_to_business": false - } -} - -``` +--- +sidebar_position: 1 +--- + +# Get bot information +Executes the getMe request, returning basic bot information: name, id, ability to add the bot to groups, etc.. + + +*Function GetBotInformation(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.GetBotInformation(Token); + + +``` + +```sh title="CLI command example" + + oint telegram GetBotInformation --token "6129457865:AAFyzNYOAFbu..." + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot", + "can_join_groups": true, + "can_read_all_group_messages": false, + "supports_inline_queries": false, + "can_connect_to_business": 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 index 9a3ea8a4e4..e5b2693d8f 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md @@ -1,366 +1,366 @@ ---- -sidebar_position: 2 ---- - -# Get updates -Executes a request getUpdates, returning information about bot events. Used in polling mode - - -*Function GetUpdates(Val Token, Val Timeout = 0, Val Offset = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Result = OPI_Telegram.GetUpdates(Token); - - -``` - -```sh title="CLI command example" - - oint telegram GetUpdates --token "6129457865:AAFyzNYOAFbu..." --timeout %timeout% --offset %offset% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": [ - { - "update_id": 291366000, - "channel_post": { - "message_id": 4685, - "sender_chat": { - "id": -1001893407333, - "title": "Test channel", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Test channel", - "username": "testsichee", - "type": "channel" - }, - "date": 1717054881, - "pinned_message": { - "message_id": 4670, - "sender_chat": { - "id": -1001893407333, - "title": "Test channel", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Test channel", - "username": "testsichee", - "type": "channel" - }, - "date": 1717054721, - "text": "String value" - } - } - }, - { - "update_id": 291366001, - "message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - } - }, - { - "update_id": 291366002, - "message": { - "message_id": 2448, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054907, - "message_thread_id": 2446, - "reply_to_message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", - "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": 291366003, - "message": { - "message_id": 2449, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054912, - "forum_topic_reopened": {} - } - }, - { - "update_id": 291366004, - "message": { - "message_id": 2450, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054912, - "forum_topic_closed": {} - } - }, - { - "update_id": 291366005, - "message": { - "message_id": 2451, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054912, - "message_thread_id": 2446, - "reply_to_message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - }, - "forum_topic_closed": {}, - "is_topic_message": true - } - }, - { - "update_id": 291366006, - "message": { - "message_id": 2452, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054937, - "forum_topic_reopened": {} - } - }, - { - "update_id": 291366007, - "message": { - "message_id": 2453, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054937, - "message_thread_id": 2446, - "reply_to_message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - }, - "forum_topic_reopened": {}, - "is_topic_message": true - } - }, - { - "update_id": 291366008, - "message": { - "message_id": 2454, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054995, - "forum_topic_edited": { - "name": "New main thread name b7ff8b12-563b-417f-8218-a460d59d7f7f" - } - } - }, - { - "update_id": 291366009, - "message": { - "message_id": 2455, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717055002, - "general_forum_topic_hidden": {} - } - }, - { - "update_id": 291366010, - "message": { - "message_id": 2456, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Test", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717055007, - "general_forum_topic_unhidden": {} - } - } - ] -} - -``` +--- +sidebar_position: 2 +--- + +# Get updates +Executes a request getUpdates, returning information about bot events. Used in polling mode + + +*Function GetUpdates(Val Token, Val Timeout = 0, Val Offset = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Result = OPI_Telegram.GetUpdates(Token); + + +``` + +```sh title="CLI command example" + + oint telegram GetUpdates --token "6129457865:AAFyzNYOAFbu..." --timeout %timeout% --offset %offset% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": [ + { + "update_id": 291366000, + "channel_post": { + "message_id": 4685, + "sender_chat": { + "id": -1001893407333, + "title": "Test channel", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Test channel", + "username": "testsichee", + "type": "channel" + }, + "date": 1717054881, + "pinned_message": { + "message_id": 4670, + "sender_chat": { + "id": -1001893407333, + "title": "Test channel", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Test channel", + "username": "testsichee", + "type": "channel" + }, + "date": 1717054721, + "text": "String value" + } + } + }, + { + "update_id": 291366001, + "message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + } + }, + { + "update_id": 291366002, + "message": { + "message_id": 2448, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054907, + "message_thread_id": 2446, + "reply_to_message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", + "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": 291366003, + "message": { + "message_id": 2449, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054912, + "forum_topic_reopened": {} + } + }, + { + "update_id": 291366004, + "message": { + "message_id": 2450, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054912, + "forum_topic_closed": {} + } + }, + { + "update_id": 291366005, + "message": { + "message_id": 2451, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054912, + "message_thread_id": 2446, + "reply_to_message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + }, + "forum_topic_closed": {}, + "is_topic_message": true + } + }, + { + "update_id": 291366006, + "message": { + "message_id": 2452, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054937, + "forum_topic_reopened": {} + } + }, + { + "update_id": 291366007, + "message": { + "message_id": 2453, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054937, + "message_thread_id": 2446, + "reply_to_message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "TestTopic fb0492fb-3a2d-4496-8309-b119226ef9f9", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + }, + "forum_topic_reopened": {}, + "is_topic_message": true + } + }, + { + "update_id": 291366008, + "message": { + "message_id": 2454, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054995, + "forum_topic_edited": { + "name": "New main thread name b7ff8b12-563b-417f-8218-a460d59d7f7f" + } + } + }, + { + "update_id": 291366009, + "message": { + "message_id": 2455, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717055002, + "general_forum_topic_hidden": {} + } + }, + { + "update_id": 291366010, + "message": { + "message_id": 2456, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Test", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717055007, + "general_forum_topic_unhidden": {} + } + } + ] +} + +``` 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 index 305e594451..5142385c97 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md @@ -1,45 +1,45 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | URL | --url | String | Request handling address from Telegram (with https:) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - URL = "https://api.athenaeum.digital/opi/hs/twitter"; - - Result = OPI_Telegram.SetWebhook(Token, URL); - - -``` - -```sh title="CLI command example" - - oint telegram SetWebhook --token "6129457865:AAFyzNYOAFbu..." --url "https://api.athenaeum.digital/opi/hs/twitter" - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true, - "description": "Webhook was set" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | URL | --url | String | Request handling address from Telegram (with https:) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + URL = "https://api.athenaeum.digital/opi/hs/twitter"; + + Result = OPI_Telegram.SetWebhook(Token, URL); + + +``` + +```sh title="CLI command example" + + oint telegram SetWebhook --token "6129457865:AAFyzNYOAFbu..." --url "https://api.athenaeum.digital/opi/hs/twitter" + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": true, + "description": "Webhook was set" +} + +``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/_category_.json b/docs/en/md/Telegram/Data-retrieval-and-settings/_category_.json index d8011e279e..3aa97d1d5a 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/_category_.json +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Data retrieval and settings", -"position": "2" -} +{ +"label": "Data retrieval and settings", +"position": "2" +} 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 index d541e36960..dce9f4f4b5 100644 --- 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 @@ -1,68 +1,68 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 - -```bsl title="Code example" - - - ButtonArray = New Array; - ButtonArray.Add("Great"); - ButtonArray.Add("Ok"); - ButtonArray.Add("Bad"); - - Keyboard = OPI_Telegram.FormKeyboardFromButtonArray(ButtonArray, True, True); - - - -``` - -```sh title="CLI command example" - - oint telegram FormKeyboardFromButtonArray --buttons %buttons% --under %under% --column %column% - - -``` - - -```json title="Result" - -{ - "inline_keyboard":[ - [ - { - "text":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E", - "callback_data":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E" - } - ], - [ - { - "text":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E", - "callback_data":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E" - } - ], - [ - { - "text":"\u041F\u043B\u043E\u0445\u043E", - "callback_data":"\u041F\u043B\u043E\u0445\u043E" - } - ] - ], - "rows":1 - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 + +```bsl title="Code example" + + + ButtonArray = New Array; + ButtonArray.Add("Great"); + ButtonArray.Add("Ok"); + ButtonArray.Add("Bad"); + + Keyboard = OPI_Telegram.FormKeyboardFromButtonArray(ButtonArray, True, True); + + + +``` + +```sh title="CLI command example" + + oint telegram FormKeyboardFromButtonArray --buttons %buttons% --under %under% --column %column% + + +``` + + +```json title="Result" + +{ + "inline_keyboard":[ + [ + { + "text":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E", + "callback_data":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E" + } + ], + [ + { + "text":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E", + "callback_data":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E" + } + ], + [ + { + "text":"\u041F\u043B\u043E\u0445\u043E", + "callback_data":"\u041F\u043B\u043E\u0445\u043E" + } + ] + ], + "rows":1 + } + +``` diff --git a/docs/en/md/Telegram/Data-sending/Forward-message.md b/docs/en/md/Telegram/Data-sending/Forward-message.md index 50fbab4302..13dfcfaa91 100644 --- a/docs/en/md/Telegram/Data-sending/Forward-message.md +++ b/docs/en/md/Telegram/Data-sending/Forward-message.md @@ -1,84 +1,84 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - MessageID = "4951"; - - Result = OPI_Telegram.ForwardMessage(Token, MessageID, ChannelID, ChatID); - - -``` - -```sh title="CLI command example" - - oint telegram ForwardMessage --token "6129457865:AAFyzNYOAFbu..." --message %message% --from %from% --to %to% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4649, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072482, - "forward_origin": { - "type": "channel", - "chat": { - "id": -1001893407333, - "title": "Test channel", - "username": "testsichee", - "type": "channel" - }, - "message_id": 4686, - "date": 1717072354 - }, - "forward_from_chat": { - "id": -1001893407333, - "title": "Test channel", - "username": "testsichee", - "type": "channel" - }, - "forward_from_message_id": 4686, - "forward_date": 1717072354, - "text": "String value" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + MessageID = "4951"; + + Result = OPI_Telegram.ForwardMessage(Token, MessageID, ChannelID, ChatID); + + +``` + +```sh title="CLI command example" + + oint telegram ForwardMessage --token "6129457865:AAFyzNYOAFbu..." --message %message% --from %from% --to %to% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4649, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072482, + "forward_origin": { + "type": "channel", + "chat": { + "id": -1001893407333, + "title": "Test channel", + "username": "testsichee", + "type": "channel" + }, + "message_id": 4686, + "date": 1717072354 + }, + "forward_from_chat": { + "id": -1001893407333, + "title": "Test channel", + "username": "testsichee", + "type": "channel" + }, + "forward_from_message_id": 4686, + "forward_date": 1717072354, + "text": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-audio.md b/docs/en/md/Telegram/Data-sending/Send-audio.md index a492dd3966..8eed4b4c5f 100644 --- a/docs/en/md/Telegram/Data-sending/Send-audio.md +++ b/docs/en/md/Telegram/Data-sending/Send-audio.md @@ -1,85 +1,85 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "String value"; - Audio = "https://openintegrations.dev/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); - - -``` - -```sh title="CLI command example" - - oint telegram SendAudio --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --audio "https://openintegrations.dev/test_data/song.mp3" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4641, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072399, - "audio": { - "duration": 228, - "file_name": "audio", - "mime_type": "audio/mpeg", - "title": "Dogs", - "performer": "Motorhead", - "file_id": "CQACAgIAAxkDAAISIWZYcg_Kxij0GylJNbAlQXeFsOL_AAKsUAACYCjISuJ28LqFPDf3NQQ", - "file_unique_id": "AgADrFAAAmAoyEo", - "file_size": 9229352 - }, - "caption": "String value" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "String value"; + Audio = "https://openintegrations.dev/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); + + +``` + +```sh title="CLI command example" + + oint telegram SendAudio --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --audio "https://openintegrations.dev/test_data/song.mp3" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4641, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072399, + "audio": { + "duration": 228, + "file_name": "audio", + "mime_type": "audio/mpeg", + "title": "Dogs", + "performer": "Motorhead", + "file_id": "CQACAgIAAxkDAAISIWZYcg_Kxij0GylJNbAlQXeFsOL_AAKsUAACYCjISuJ28LqFPDf3NQQ", + "file_unique_id": "AgADrFAAAmAoyEo", + "file_size": 9229352 + }, + "caption": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-contact.md b/docs/en/md/Telegram/Data-sending/Send-contact.md index 9b2fa99a69..89ee3e58b0 100644 --- a/docs/en/md/Telegram/Data-sending/Send-contact.md +++ b/docs/en/md/Telegram/Data-sending/Send-contact.md @@ -1,74 +1,74 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Name = "John"; - LastName = "Doe"; - Phone = "88005553535"; - - Result = OPI_Telegram.SendContact(Token, ChatID, Name, LastName, Phone); - Result = OPI_Telegram.SendContact(Token, ChannelID, Name, LastName, Phone); - - -``` - -```sh title="CLI command example" - - oint telegram SendContact --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --name "John" --surname "Doe" --phone "88005553535" --keyboard %keyboard% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4647, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072448, - "contact": { - "phone_number": "88005553535", - "first_name": "John", - "last_name": "Doe" - } - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Name = "John"; + LastName = "Doe"; + Phone = "88005553535"; + + Result = OPI_Telegram.SendContact(Token, ChatID, Name, LastName, Phone); + Result = OPI_Telegram.SendContact(Token, ChannelID, Name, LastName, Phone); + + +``` + +```sh title="CLI command example" + + oint telegram SendContact --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --name "John" --surname "Doe" --phone "88005553535" --keyboard %keyboard% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4647, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072448, + "contact": { + "phone_number": "88005553535", + "first_name": "John", + "last_name": "Doe" + } + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-document.md b/docs/en/md/Telegram/Data-sending/Send-document.md index 9c6529bef7..8477638df9 100644 --- a/docs/en/md/Telegram/Data-sending/Send-document.md +++ b/docs/en/md/Telegram/Data-sending/Send-document.md @@ -1,82 +1,82 @@ ---- -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") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "String value"; - Document = "https://openintegrations.dev/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, ChannelID, Text, DocumentPath); - Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentDD); - - -``` - -```sh title="CLI command example" - - oint telegram SendDocument --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --doc "https://openintegrations.dev/test_data/document.docx" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4642, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072414, - "document": { - "file_name": "document.docx", - "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "file_id": "BQACAgIAAxkDAAISImZYch5MDU2ibeJ0S46yZfw6Dmb2AAKtUAACYCjISp3o6gzXeDCVNQQ", - "file_unique_id": "AgADrVAAAmAoyEo", - "file_size": 24069 - }, - "caption": "String value" - } -} - -``` +--- +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") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "String value"; + Document = "https://openintegrations.dev/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, ChannelID, Text, DocumentPath); + Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentDD); + + +``` + +```sh title="CLI command example" + + oint telegram SendDocument --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --doc "https://openintegrations.dev/test_data/document.docx" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4642, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072414, + "document": { + "file_name": "document.docx", + "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "file_id": "BQACAgIAAxkDAAISImZYch5MDU2ibeJ0S46yZfw6Dmb2AAKtUAACYCjISp3o6gzXeDCVNQQ", + "file_unique_id": "AgADrVAAAmAoyEo", + "file_size": 24069 + }, + "caption": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-gif.md b/docs/en/md/Telegram/Data-sending/Send-gif.md index 3e3e3e37af..4399aa72c0 100644 --- a/docs/en/md/Telegram/Data-sending/Send-gif.md +++ b/docs/en/md/Telegram/Data-sending/Send-gif.md @@ -1,120 +1,120 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "String value"; - GIF = "https://openintegrations.dev/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); - - -``` - -```sh title="CLI command example" - - oint telegram SendGif --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --gif "https://openintegrations.dev/test_data/animation.gif" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4643, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072423, - "animation": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "duration": 3, - "width": 220, - "height": 220, - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", - "file_unique_id": "AgADrlAAAmAoyEo", - "file_size": 84940 - }, - "document": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", - "file_unique_id": "AgADrlAAAmAoyEo", - "file_size": 84940 - }, - "caption": "String value" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "String value"; + GIF = "https://openintegrations.dev/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); + + +``` + +```sh title="CLI command example" + + oint telegram SendGif --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --gif "https://openintegrations.dev/test_data/animation.gif" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4643, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072423, + "animation": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "duration": 3, + "width": 220, + "height": 220, + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", + "file_unique_id": "AgADrlAAAmAoyEo", + "file_size": 84940 + }, + "document": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", + "file_unique_id": "AgADrlAAAmAoyEo", + "file_size": 84940 + }, + "caption": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-image.md b/docs/en/md/Telegram/Data-sending/Send-image.md index 390846e8fa..00e28ab268 100644 --- a/docs/en/md/Telegram/Data-sending/Send-image.md +++ b/docs/en/md/Telegram/Data-sending/Send-image.md @@ -1,112 +1,112 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```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"); - CopyFile(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); - - -``` - -```sh title="CLI command example" - - oint telegram SendImage --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --picture "https://openintegrations.dev/test_data/picture.jpg" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4639, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072364, - "photo": [ - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", - "file_unique_id": "AQADmtkxG77-sUpy", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", - "file_unique_id": "AQADmtkxG77-sUp9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", - "file_unique_id": "AQADmtkxG77-sUp-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "String value" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```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"); + CopyFile(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); + + +``` + +```sh title="CLI command example" + + oint telegram SendImage --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --picture "https://openintegrations.dev/test_data/picture.jpg" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4639, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072364, + "photo": [ + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", + "file_unique_id": "AQADmtkxG77-sUpy", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", + "file_unique_id": "AQADmtkxG77-sUp9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", + "file_unique_id": "AQADmtkxG77-sUp-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-location.md b/docs/en/md/Telegram/Data-sending/Send-location.md index 586a1528bc..ff2345b1b4 100644 --- a/docs/en/md/Telegram/Data-sending/Send-location.md +++ b/docs/en/md/Telegram/Data-sending/Send-location.md @@ -1,71 +1,71 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```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); - - -``` - -```sh title="CLI command example" - - oint telegram SendLocation --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --lat %lat% --long "48.87373649724122" --keyboard %keyboard% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4646, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072442, - "location": { - "latitude": 48.873739, - "longitude": 48.873733 - } - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```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); + + +``` + +```sh title="CLI command example" + + oint telegram SendLocation --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --lat %lat% --long "48.87373649724122" --keyboard %keyboard% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4646, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072442, + "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 index ec367b062d..c558986030 100644 --- a/docs/en/md/Telegram/Data-sending/Send-media-group.md +++ b/docs/en/md/Telegram/Data-sending/Send-media-group.md @@ -1,153 +1,153 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | FileMapping | --media | Map of String | File JSON or path to .json | - | Keyboard | --keyboard | String | Keyboard JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - - Token = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ"; - Description = "Pictures group"; - FileMapping = New Map; - FileMapping.Insert("C:\OPI\alpaca.png", "photo"); - FileMapping.Insert("C:\OPI\alpaca_text.png", "photo"); - - Response = OPI_Telegram.SendMediaGroup(Token, 1234567890, Description, FileMapping); //Map - Response = OPI_Tools.JSONString(Response_); //JSON string - - - -``` - -```sh title="CLI command example" - - oint telegram SendMediaGroup --token "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ" --chat %chat% --text %text% --media %media% --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": [ - { - "message_id": 4644, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072435, - "media_group_id": "13736579485142714", - "photo": [ - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", - "file_unique_id": "AQADmtkxG77-sUpy", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", - "file_unique_id": "AQADmtkxG77-sUp9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", - "file_unique_id": "AQADmtkxG77-sUp-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "String value" - }, - { - "message_id": 4645, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072435, - "media_group_id": "13736579485142714", - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video1", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", - "file_unique_id": "AQADr1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", - "file_unique_id": "AQADr1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxkDAAISJWZYcjPG5UBlLcgCf53SUY366x0_AAKvUAACYCjISu2YyUUvFzLSNQQ", - "file_unique_id": "AgADr1AAAmAoyEo", - "file_size": 1137878 - } - } - ] -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | FileMapping | --media | Map of String | File JSON or path to .json | + | Keyboard | --keyboard | String | Keyboard JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + + Token = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ"; + Description = "Pictures group"; + FileMapping = New Map; + FileMapping.Insert("C:\OPI\alpaca.png", "photo"); + FileMapping.Insert("C:\OPI\alpaca_text.png", "photo"); + + Response = OPI_Telegram.SendMediaGroup(Token, 1234567890, Description, FileMapping); //Map + Response = OPI_Tools.JSONString(Response_); //JSON string + + + +``` + +```sh title="CLI command example" + + oint telegram SendMediaGroup --token "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ" --chat %chat% --text %text% --media %media% --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": [ + { + "message_id": 4644, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072435, + "media_group_id": "13736579485142714", + "photo": [ + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", + "file_unique_id": "AQADmtkxG77-sUpy", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", + "file_unique_id": "AQADmtkxG77-sUp9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", + "file_unique_id": "AQADmtkxG77-sUp-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "String value" + }, + { + "message_id": 4645, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072435, + "media_group_id": "13736579485142714", + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video1", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", + "file_unique_id": "AQADr1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", + "file_unique_id": "AQADr1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxkDAAISJWZYcjPG5UBlLcgCf53SUY366x0_AAKvUAACYCjISu2YyUUvFzLSNQQ", + "file_unique_id": "AgADr1AAAmAoyEo", + "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 index cbe74620ef..9340a21620 100644 --- a/docs/en/md/Telegram/Data-sending/Send-poll.md +++ b/docs/en/md/Telegram/Data-sending/Send-poll.md @@ -1,99 +1,99 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 | Poll anonymity | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```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); - - -``` - -```sh title="CLI command example" - - oint telegram SendPoll --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --question %question% --options %options% --anonymous %anonymous% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4648, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072475, - "poll": { - "id": "5388601346930772585", - "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 - } - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 | Poll anonymity | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```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); + + +``` + +```sh title="CLI command example" + + oint telegram SendPoll --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --question %question% --options %options% --anonymous %anonymous% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4648, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072475, + "poll": { + "id": "5388601346930772585", + "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 index 2c7ba36359..ac70dea0e0 100644 --- a/docs/en/md/Telegram/Data-sending/Send-text-message.md +++ b/docs/en/md/Telegram/Data-sending/Send-text-message.md @@ -1,67 +1,67 @@ ---- -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") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | - | Text | --text | String | Message text | - | Keyboard | --keyboard | String | Keyboard JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "String value"; - - Result = OPI_Telegram.SendTextMessage(Token, ChatID, Text); - Result = OPI_Telegram.SendTextMessage(Token, ChannelID, Text); - - -``` - -```sh title="CLI command example" - - oint telegram SendTextMessage --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4638, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072354, - "text": "String value" - } -} - -``` +--- +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") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID | + | Text | --text | String | Message text | + | Keyboard | --keyboard | String | Keyboard JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "String value"; + + Result = OPI_Telegram.SendTextMessage(Token, ChatID, Text); + Result = OPI_Telegram.SendTextMessage(Token, ChannelID, Text); + + +``` + +```sh title="CLI command example" + + oint telegram SendTextMessage --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4638, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072354, + "text": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/Send-video.md b/docs/en/md/Telegram/Data-sending/Send-video.md index 8acf8c65c5..41185c3dde 100644 --- a/docs/en/md/Telegram/Data-sending/Send-video.md +++ b/docs/en/md/Telegram/Data-sending/Send-video.md @@ -1,99 +1,99 @@ ---- -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 | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - ChatID = "461699897"; - ChannelID = "@testsichee"; - Text = "String value"; - Video = "https://openintegrations.dev/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); - - -``` - -```sh title="CLI command example" - - oint telegram SendVideo --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --video "https://openintegrations.dev/test_data/video.mp4" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_id": 4640, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Vitaly The Bot", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072376, - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", - "file_unique_id": "AQADq1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", - "file_unique_id": "AQADq1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxkDAAISIGZYcfd2b2c_lBihqowoDy15WD0oAAKrUAACYCjISh7uoJd1agn6NQQ", - "file_unique_id": "AgADq1AAAmAoyEo", - "file_size": 1137878 - }, - "caption": "String value" - } -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + | Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + ChatID = "461699897"; + ChannelID = "@testsichee"; + Text = "String value"; + Video = "https://openintegrations.dev/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); + + +``` + +```sh title="CLI command example" + + oint telegram SendVideo --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "String value" --video "https://openintegrations.dev/test_data/video.mp4" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_id": 4640, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Vitaly The Bot", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072376, + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", + "file_unique_id": "AQADq1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", + "file_unique_id": "AQADq1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxkDAAISIGZYcfd2b2c_lBihqowoDy15WD0oAAKrUAACYCjISh7uoJd1agn6NQQ", + "file_unique_id": "AgADq1AAAmAoyEo", + "file_size": 1137878 + }, + "caption": "String value" + } +} + +``` diff --git a/docs/en/md/Telegram/Data-sending/_category_.json b/docs/en/md/Telegram/Data-sending/_category_.json index 189ccbf6a1..095392a30b 100644 --- a/docs/en/md/Telegram/Data-sending/_category_.json +++ b/docs/en/md/Telegram/Data-sending/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Data sending", -"position": "3" -} +{ +"label": "Data sending", +"position": "3" +} 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 index 7b8f8e11f9..9bae68573f 100644 --- 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 @@ -1,47 +1,47 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID. Main if not filled | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "2673"; - - Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat); - Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat, Topic); - - -``` - -```sh title="CLI command example" - - oint telegram ClearThreadPinnedMessagesList --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID. Main if not filled | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "2673"; + + Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat); + Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat, Topic); + + +``` + +```sh title="CLI command example" + + oint telegram ClearThreadPinnedMessagesList --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %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 index b76dc1de04..40fe51501c 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md +++ b/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 4 ---- - -# Close forum thread - Closes the thread for new messages - - -*Function CloseForumThread(Val Token, Val ChatID, Val ThreadID = "") ExportReturn ManageForumThreadState(Token, ChatID, 2, ThreadID);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "2673"; - - Result = OPI_Telegram.CloseForumThread(Token, Chat); // Closes main topic - Result = OPI_Telegram.CloseForumThread(Token, Chat, Topic); - - -``` - -```sh title="CLI command example" - - oint telegram CloseForumThread --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 4 +--- + +# Close forum thread + Closes the thread for new messages + + +*Function CloseForumThread(Val Token, Val ChatID, Val ThreadID = "") ExportReturn ManageForumThreadState(Token, ChatID, 2, ThreadID);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "2673"; + + Result = OPI_Telegram.CloseForumThread(Token, Chat); // Closes main topic + Result = OPI_Telegram.CloseForumThread(Token, Chat, Topic); + + +``` + +```sh title="CLI command example" + + oint telegram CloseForumThread --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %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 index 4dfd427b9c..019e6ab4d6 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md +++ b/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md @@ -1,53 +1,53 @@ ---- -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 = "") ExportReturn ForumTopicManagement(Token, ChatID, Title, IconID);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread creation chat ID | - | Title | --title | String | Thread title | - | IconID | --icon | String | See GetAvatarIconList | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Icon = "5357419403325481346"; - Name = "TestTopic " + String(New UUID); - - Result = OPI_Telegram.CreateForumThread(Token, Chat, Name, Icon); - - -``` - -```sh title="CLI command example" - - oint telegram CreateForumThread --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% --icon %icon% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": { - "message_thread_id": 2457, - "name": "TestTopic bb6937b8-0372-4118-81f5-cb75b85c4627", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - } -} - -``` +--- +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 = "") ExportReturn ForumTopicManagement(Token, ChatID, Title, IconID);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread creation chat ID | + | Title | --title | String | Thread title | + | IconID | --icon | String | See GetAvatarIconList | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Icon = "5357419403325481346"; + Name = "TestTopic " + String(New UUID); + + Result = OPI_Telegram.CreateForumThread(Token, Chat, Name, Icon); + + +``` + +```sh title="CLI command example" + + oint telegram CreateForumThread --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% --icon %icon% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": { + "message_thread_id": 2457, + "name": "TestTopic bb6937b8-0372-4118-81f5-cb75b85c4627", + "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 index f5cb2cf015..9d630ca179 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md +++ b/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 6 ---- - -# Delete forum thread - Deletes a forum thread - - -*Function DeleteForumTopic(Val Token, Val ChatID, Val ThreadID) ExportReturn ManageForumThreadState(Token, ChatID, 3, ThreadID);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "2673"; - - Result = OPI_Telegram.DeleteForumTopic(Token, Chat, Topic); - - -``` - -```sh title="CLI command example" - - oint telegram DeleteForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 6 +--- + +# Delete forum thread + Deletes a forum thread + + +*Function DeleteForumTopic(Val Token, Val ChatID, Val ThreadID) ExportReturn ManageForumThreadState(Token, ChatID, 3, ThreadID);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "2673"; + + Result = OPI_Telegram.DeleteForumTopic(Token, Chat, Topic); + + +``` + +```sh title="CLI command example" + + oint telegram DeleteForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %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 index d9eb443077..1130762498 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md +++ b/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "2673"; - NewName = "NewTestTitle"; - NewIcon = "5310132165583840589"; - - Result = OPI_Telegram.EditForumTopic(Token, Chat, Topic, NewName, NewIcon); - - -``` - -```sh title="CLI command example" - - oint telegram EditForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% --title %title% --icon %icon% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "2673"; + NewName = "NewTestTitle"; + NewIcon = "5310132165583840589"; + + Result = OPI_Telegram.EditForumTopic(Token, Chat, Topic, NewName, NewIcon); + + +``` + +```sh title="CLI command example" + + oint telegram EditForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% --title %title% --icon %icon% + + +``` + + +```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 index 64eb78989f..bd9a619f36 100644 --- 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 @@ -1,45 +1,45 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | Title | --title | String | New main thread name | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Title = "New main thread name " + String(New UUID); - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Result = OPI_Telegram.EditMainForumTopicName(Token, Chat, Title); - - -``` - -```sh title="CLI command example" - - oint telegram EditMainForumTopicName --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | Title | --title | String | New main thread name | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Title = "New main thread name " + String(New UUID); + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Result = OPI_Telegram.EditMainForumTopicName(Token, Chat, Title); + + +``` + +```sh title="CLI command example" + + oint telegram EditMainForumTopicName --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %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 index a5967ebb1d..948ed6fa98 100644 --- 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 @@ -1,153 +1,153 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - Key > ID, Value > Emoji - -```bsl title="Code example" - - - Response = GetAvatarIconList("6129457325:BWDF..."); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint telegram GetAvatarIconList --token %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": "🐈" -} - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - Key > ID, Value > Emoji + +```bsl title="Code example" + + + Response = GetAvatarIconList("6129457325:BWDF..."); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint telegram GetAvatarIconList --token %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 index d1fa661201..d7e78a1a68 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 7 ---- - -# Hide main forum thread - Hides the main forum thread - - -*Function HideMainForumTopic(Val Token, Val ChatID) ExportReturn ManageMainTopicVisibility(Token, ChatID, True);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - - Result = OPI_Telegram.HideMainForumTopic(Token, Chat); - - -``` - -```sh title="CLI command example" - - oint telegram HideMainForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 7 +--- + +# Hide main forum thread + Hides the main forum thread + + +*Function HideMainForumTopic(Val Token, Val ChatID) ExportReturn ManageMainTopicVisibility(Token, ChatID, True);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + + Result = OPI_Telegram.HideMainForumTopic(Token, Chat); + + +``` + +```sh title="CLI command example" + + oint telegram HideMainForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% + + +``` + + +```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 index 23582c4c34..b1be95b845 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md +++ b/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 5 ---- - -# Open forum thread - Reopens a previously closed forum thread - - -*Function OpenForumThread(Val Token, Val ChatID, Val ThreadID = "") ExportReturn ManageForumThreadState(Token, ChatID, 1, ThreadID);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - | ThreadID | --topic | String, Number | Thread ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - Topic = "2673"; - - Result = OPI_Telegram.OpenForumThread(Token, Chat); // Opens main topic - Result = OPI_Telegram.OpenForumThread(Token, Chat, Topic); - - -``` - -```sh title="CLI command example" - - oint telegram OpenForumThread --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 5 +--- + +# Open forum thread + Reopens a previously closed forum thread + + +*Function OpenForumThread(Val Token, Val ChatID, Val ThreadID = "") ExportReturn ManageForumThreadState(Token, ChatID, 1, ThreadID);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + | ThreadID | --topic | String, Number | Thread ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + Topic = "2673"; + + Result = OPI_Telegram.OpenForumThread(Token, Chat); // Opens main topic + Result = OPI_Telegram.OpenForumThread(Token, Chat, Topic); + + +``` + +```sh title="CLI command example" + + oint telegram OpenForumThread --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %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 index 19f167e0ae..a7206ae8f9 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 8 ---- - -# Show main forum thread - Shows a previously hidden main forum thread - - -*Function ShowMainForumTopic(Val Token, Val ChatID) ExportReturn ManageMainTopicVisibility(Token, ChatID, False);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | ChatID | --forum | String, Number | Thread chat ID | - - - Returns: Key-Value Pair - Serialized JSON response from Telegram - -```bsl title="Code example" - - Token = "6129457865:AAFyzNYOAFbu..."; - Chat = "-1001971186208"; - - Result = OPI_Telegram.ShowMainForumTopic(Token, Chat); - - -``` - -```sh title="CLI command example" - - oint telegram ShowMainForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% - - -``` - - -```json title="Result" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 8 +--- + +# Show main forum thread + Shows a previously hidden main forum thread + + +*Function ShowMainForumTopic(Val Token, Val ChatID) ExportReturn ManageMainTopicVisibility(Token, ChatID, False);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | ChatID | --forum | String, Number | Thread chat ID | + + + Returns: Key-Value Pair - Serialized JSON response from Telegram + +```bsl title="Code example" + + Token = "6129457865:AAFyzNYOAFbu..."; + Chat = "-1001971186208"; + + Result = OPI_Telegram.ShowMainForumTopic(Token, Chat); + + +``` + +```sh title="CLI command example" + + oint telegram ShowMainForumTopic --token "6129457865:AAFyzNYOAFbu..." --forum %forum% + + +``` + + +```json title="Result" + +{ + "ok": true, + "result": true +} + +``` diff --git a/docs/en/md/Telegram/Forum-topic-management/_category_.json b/docs/en/md/Telegram/Forum-topic-management/_category_.json index cd5b01fab2..f8f75980c6 100644 --- a/docs/en/md/Telegram/Forum-topic-management/_category_.json +++ b/docs/en/md/Telegram/Forum-topic-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Forum topic management", -"position": "5" -} +{ +"label": "Forum topic management", +"position": "5" +} diff --git a/docs/en/md/Telegram/Telegram.md b/docs/en/md/Telegram/Telegram.md index c181a3cb6f..f650cd7576 100644 --- a/docs/en/md/Telegram/Telegram.md +++ b/docs/en/md/Telegram/Telegram.md @@ -1,41 +1,41 @@ ---- -id: Telegram -sidebar_class_name: Telegram ---- - - - -# Telegram - -Этот раздел поwithinящен библиотеtoе for work with Telegram API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -- Создайте бота Telegram - - 1. Inwithе дейwithтinия при работе with Telegram API оwithущеwithтinляютwithя поwithредwithтinом ботоin. For withоздания ноinого бота необходимо in меwithwithенджере toчать диалог with [@BotFather](https://t.me/BotFather) - - ![BF](../../static/img/Docs/Telegram/2.png) - - 2. Inыбрать in меню commandsу */newbot* - - ![BF](../../static/img/Docs/Telegram/3.png) - - 3. BotFather предложит inам inыбрать имя и ниtoнейм бота, after чего процедура withоздания will заinершеto - -- Сохраните **тоtoен**, toоторый inам приwithлал BotFather after заinершения withоздания бота - - ![BF](../../static/img/Docs/Telegram/1.png) - -- (Дополнительно) Определитеwithь with целью inзаимодейwithтinия - - Созданного inами бота теперь можно применить дinумя withпоwithобами - - - In toачеwithтinе чат-бота - - For аinтоматfromации inедения toаtoла - - In заinиwithимоwithти от inыбранного withпоwithоба примения will отличатьwithя withпоwithоб получения **ID чата** - параметра, отinечающего за определение объеtoта inзаимодейwithтinия. - - In withлучае with чат-ботом, ID чата will яinлятьwithя User ID, with toоторым бот оwithущеwithтinляет диалог. If же бота необходимо иwithпользоinать for inедения toаtoла, то, after добаinления его in toачеwithтinе админиwithтратора, inмеwithто ID чата можно иwithпользоinать имя toаtoла через @ (@MyChannel) - - Token и ID чата яinляютwithя mainоinными параметрами all methodоin work with Telegram API +--- +id: Telegram +sidebar_class_name: Telegram +--- + + + +# Telegram + +Этот раздел поwithinящен библиотеtoе for work with Telegram API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +- Создайте бота Telegram + + 1. Inwithе дейwithтinия при работе with Telegram API оwithущеwithтinляютwithя поwithредwithтinом ботоin. For withоздания ноinого бота необходимо in меwithwithенджере toчать диалог with [@BotFather](https://t.me/BotFather) + + ![BF](../../static/img/Docs/Telegram/2.png) + + 2. Inыбрать in меню commandsу */newbot* + + ![BF](../../static/img/Docs/Telegram/3.png) + + 3. BotFather предложит inам inыбрать имя и ниtoнейм бота, after чего процедура withоздания will заinершеto + +- Сохраните **тоtoен**, toоторый inам приwithлал BotFather after заinершения withоздания бота + + ![BF](../../static/img/Docs/Telegram/1.png) + +- (Дополнительно) Определитеwithь with целью inзаимодейwithтinия + + Созданного inами бота теперь можно применить дinумя withпоwithобами + + - In toачеwithтinе чат-бота + - For аinтоматfromации inедения toаtoла + + In заinиwithимоwithти от inыбранного withпоwithоба примения will отличатьwithя withпоwithоб получения **ID чата** - параметра, отinечающего за определение объеtoта inзаимодейwithтinия. + + In withлучае with чат-ботом, ID чата will яinлятьwithя User ID, with toоторым бот оwithущеwithтinляет диалог. If же бота необходимо иwithпользоinать for inедения toаtoла, то, after добаinления его in toачеwithтinе админиwithтратора, inмеwithто ID чата можно иwithпользоinать имя toаtoла через @ (@MyChannel) + + Token и ID чата яinляютwithя mainоinными параметрами all methodоin work with Telegram API diff --git a/docs/en/md/Telegram/_category_.json b/docs/en/md/Telegram/_category_.json index b4f4d10cdb..15aa47c93c 100644 --- a/docs/en/md/Telegram/_category_.json +++ b/docs/en/md/Telegram/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Telegram", - "position": 2, - "link": { - "type": "doc", - "id": "Telegram" - } -} +{ + "label": "Telegram", + "position": 2, + "link": { + "type": "doc", + "id": "Telegram" + } +} 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 index 215bcc7420..e6b7acf84f 100644 --- a/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md +++ b/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md @@ -1,39 +1,39 @@ ---- -sidebar_position: 1 ---- - -# Get authorization link - Forms a link for authorization via the browser - - -*Function GetAuthorizationLink(Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: String - URL for browser transition - -```bsl title="Code example" - - - Response = OPI_Twitter.GetAuthorizationLink(Parameters); - - - -``` - -```sh title="CLI command example" - - oint twitter GetAuthorizationLink --auth %auth% - - -``` - - -```json title="Result" - -"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&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" - -``` +--- +sidebar_position: 1 +--- + +# Get authorization link + Forms a link for authorization via the browser + + +*Function GetAuthorizationLink(Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: String - URL for browser transition + +```bsl title="Code example" + + + Response = OPI_Twitter.GetAuthorizationLink(Parameters); + + + +``` + +```sh title="CLI command example" + + oint twitter GetAuthorizationLink --auth %auth% + + +``` + + +```json title="Result" + +"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&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 index 5e288fb5ea..1a89a92707 100644 --- a/docs/en/md/Twitter/Data-and-settings/Get-token.md +++ b/docs/en/md/Twitter/Data-and-settings/Get-token.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 2 ---- - -# Get token - Gets the token by the code obtained during authorization via the link from GetAuthorizationLink - - -*Function GetToken(Val Code, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Code | --code | String | Code obtained from authorization See GetAuthorizationLink | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - Response = OPI_Twitter.GetToken(Code, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter GetToken --code %code% --auth %auth% - - -``` - - -```json title="Result" - -{ - "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", - "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", - "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", - "expires_in": 7200, - "token_type": "bearer" - } - -``` +--- +sidebar_position: 2 +--- + +# Get token + Gets the token by the code obtained during authorization via the link from GetAuthorizationLink + + +*Function GetToken(Val Code, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Code | --code | String | Code obtained from authorization See GetAuthorizationLink | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + Response = OPI_Twitter.GetToken(Code, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter GetToken --code %code% --auth %auth% + + +``` + + +```json title="Result" + +{ + "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", + "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", + "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", + "expires_in": 7200, + "token_type": "bearer" + } + +``` diff --git a/docs/en/md/Twitter/Data-and-settings/Refresh-token.md b/docs/en/md/Twitter/Data-and-settings/Refresh-token.md index bd0da4c9a2..c433a6b716 100644 --- a/docs/en/md/Twitter/Data-and-settings/Refresh-token.md +++ b/docs/en/md/Twitter/Data-and-settings/Refresh-token.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 3 ---- - -# Refresh token - Updates the v2 token using the refresh_token - - -*Function RefreshToken(Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - Response = OPI_Twitter.RefreshToken(Parameters); - Constants.TwitterToken.Set(Response["access_token"]); - Constants.TwitterRefresh.Set(Response["refresh_token"]); - - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter RefreshToken --auth %auth% - - -``` - - -```json title="Result" - -{ - "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", - "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", - "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", - "expires_in": 7200, - "token_type": "bearer" - } - -``` +--- +sidebar_position: 3 +--- + +# Refresh token + Updates the v2 token using the refresh_token + + +*Function RefreshToken(Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + Response = OPI_Twitter.RefreshToken(Parameters); + Constants.TwitterToken.Set(Response["access_token"]); + Constants.TwitterRefresh.Set(Response["refresh_token"]); + + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter RefreshToken --auth %auth% + + +``` + + +```json title="Result" + +{ + "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", + "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", + "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", + "expires_in": 7200, + "token_type": "bearer" + } + +``` diff --git a/docs/en/md/Twitter/Data-and-settings/_category_.json b/docs/en/md/Twitter/Data-and-settings/_category_.json index 925cbcf209..894b25f4c3 100644 --- a/docs/en/md/Twitter/Data-and-settings/_category_.json +++ b/docs/en/md/Twitter/Data-and-settings/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Data and settings", -"position": "2" -} +{ +"label": "Data and settings", +"position": "2" +} diff --git a/docs/en/md/Twitter/Tweets/Create-gif-tweet.md b/docs/en/md/Twitter/Tweets/Create-gif-tweet.md index f76179cf53..78eb136ef6 100644 --- a/docs/en/md/Twitter/Tweets/Create-gif-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-gif-tweet.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 3 ---- - -# Create gif tweet - Creates a tweet with a gif attachment - - -*Function CreateGifTweet(Val Text, Val GifsArray, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Text | --text | String | Tweet text | - | GifsArray | --gifs | Array of String, BinaryData | Gif files array | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - ImageArray = New Array; - ImageArray.Add("C:\1.gif"); - ImageArray.Add("C:\2.gif"); - - Response = OPI_Twitter.CreateGifTweet("Gifs", ImageArray, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter CreateGifTweet --text %text% --gifs %gifs% --auth %auth% - - -``` - - -```json title="Result" - -{ - "data": { - "text": "Nature https://t.co/VWkWU11111", - "id": "1746086669499924991", - "edit_history_tweet_ids": [ - "1746086669499924991" - ] - } - } - -``` +--- +sidebar_position: 3 +--- + +# Create gif tweet + Creates a tweet with a gif attachment + + +*Function CreateGifTweet(Val Text, Val GifsArray, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Text | --text | String | Tweet text | + | GifsArray | --gifs | Array of String, BinaryData | Gif files array | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + ImageArray = New Array; + ImageArray.Add("C:\1.gif"); + ImageArray.Add("C:\2.gif"); + + Response = OPI_Twitter.CreateGifTweet("Gifs", ImageArray, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter CreateGifTweet --text %text% --gifs %gifs% --auth %auth% + + +``` + + +```json title="Result" + +{ + "data": { + "text": "Nature https://t.co/VWkWU11111", + "id": "1746086669499924991", + "edit_history_tweet_ids": [ + "1746086669499924991" + ] + } + } + +``` diff --git a/docs/en/md/Twitter/Tweets/Create-image-tweet.md b/docs/en/md/Twitter/Tweets/Create-image-tweet.md index d5b477f8ad..2904ddb744 100644 --- a/docs/en/md/Twitter/Tweets/Create-image-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-image-tweet.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 2 ---- - -# Create image tweet - Creates a tweet with an image attachment - - -*Function CreateImageTweet(Val Text, Val ImageArray, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Text | --text | String | Tweet text | - | ImageArray | --pictures | Array of String, BinaryData | Image files array | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - ImageArray = New Array; - ImageArray.Add("C:\logo.png"); - ImageArray.Add("C:\logo_long.png"); - - Response = OPI_Twitter.CreateImageTweet("Alpaca", ImageArray, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter CreateImageTweet --text %text% --pictures %pictures% --auth %auth% - - -``` - - -```json title="Result" - -{ - "data": { - "text": "Alpaca https://t.co/OodoWT1AAA", - "id": "1745753004542726629", - "edit_history_tweet_ids": [ - "1745753004542726629" - ] - } - } - -``` +--- +sidebar_position: 2 +--- + +# Create image tweet + Creates a tweet with an image attachment + + +*Function CreateImageTweet(Val Text, Val ImageArray, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Text | --text | String | Tweet text | + | ImageArray | --pictures | Array of String, BinaryData | Image files array | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + ImageArray = New Array; + ImageArray.Add("C:\logo.png"); + ImageArray.Add("C:\logo_long.png"); + + Response = OPI_Twitter.CreateImageTweet("Alpaca", ImageArray, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter CreateImageTweet --text %text% --pictures %pictures% --auth %auth% + + +``` + + +```json title="Result" + +{ + "data": { + "text": "Alpaca https://t.co/OodoWT1AAA", + "id": "1745753004542726629", + "edit_history_tweet_ids": [ + "1745753004542726629" + ] + } + } + +``` diff --git a/docs/en/md/Twitter/Tweets/Create-poll-tweet.md b/docs/en/md/Twitter/Tweets/Create-poll-tweet.md index 60dca08615..6389e60a7c 100644 --- a/docs/en/md/Twitter/Tweets/Create-poll-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-poll-tweet.md @@ -1,56 +1,56 @@ ---- -sidebar_position: 5 ---- - -# Create poll tweet - Creates a tweet with a poll - - -*Function CreatePollTweet(Val Text, Val OptionArray, Val Duration, Val Parameters = "") ExportReturn CreateCustomTweet(Text,, OptionArray, Duration, Parameters);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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 JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - OptionArray = New Array; - OptionArray.Add("Good"); - OptionArray.Add("Nothing special"); - OptionArray.Add("Bad"); - - Response = OPI_Twitter.CreatePollTweet("How are you?", OptionArray, 60, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter CreatePollTweet --text %text% --options %options% --duration %duration% --auth %auth% - - -``` - - -```json title="Result" - -{ - "data": { - "text": "How are you?", - "id": "1746082302268969388", - "edit_history_tweet_ids": [ - "1746082302268969388" - ] - } - } - -``` +--- +sidebar_position: 5 +--- + +# Create poll tweet + Creates a tweet with a poll + + +*Function CreatePollTweet(Val Text, Val OptionArray, Val Duration, Val Parameters = "") ExportReturn CreateCustomTweet(Text,, OptionArray, Duration, Parameters);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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 JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + OptionArray = New Array; + OptionArray.Add("Good"); + OptionArray.Add("Nothing special"); + OptionArray.Add("Bad"); + + Response = OPI_Twitter.CreatePollTweet("How are you?", OptionArray, 60, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter CreatePollTweet --text %text% --options %options% --duration %duration% --auth %auth% + + +``` + + +```json title="Result" + +{ + "data": { + "text": "How are you?", + "id": "1746082302268969388", + "edit_history_tweet_ids": [ + "1746082302268969388" + ] + } + } + +``` diff --git a/docs/en/md/Twitter/Tweets/Create-text-tweet.md b/docs/en/md/Twitter/Tweets/Create-text-tweet.md index 66d54bc704..a29992838d 100644 --- a/docs/en/md/Twitter/Tweets/Create-text-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-text-tweet.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 1 ---- - -# Create text tweet - Creates a tweet without attachments - - -*Function CreateTextTweet(Val Text, Val Parameters = "") ExportReturn CreateCustomTweet(Text,,,, Parameters);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Text | --text | String | Tweet text | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - Response = OPI_Twitter.CreateTextTweet("Regular text tweet", Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter CreateTextTweet --text %text% --auth %auth% - - -``` - - -```json title="Result" - -{ - "data": { - "text": "Regular text tweet", - "id": "1745752006310895822", - "edit_history_tweet_ids": [ - "1745752006310895822" - ] - } - } - -``` +--- +sidebar_position: 1 +--- + +# Create text tweet + Creates a tweet without attachments + + +*Function CreateTextTweet(Val Text, Val Parameters = "") ExportReturn CreateCustomTweet(Text,,,, Parameters);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Text | --text | String | Tweet text | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + Response = OPI_Twitter.CreateTextTweet("Regular text tweet", Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter CreateTextTweet --text %text% --auth %auth% + + +``` + + +```json title="Result" + +{ + "data": { + "text": "Regular text tweet", + "id": "1745752006310895822", + "edit_history_tweet_ids": [ + "1745752006310895822" + ] + } + } + +``` diff --git a/docs/en/md/Twitter/Tweets/Create-video-tweet.md b/docs/en/md/Twitter/Tweets/Create-video-tweet.md index 62e4d445de..de813c9813 100644 --- a/docs/en/md/Twitter/Tweets/Create-video-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-video-tweet.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 4 ---- - -# Create video tweet - Creates a tweet with a video attachment - - -*Function CreateVideoTweet(Val Text, Val VideosArray, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Text | --text | String | Tweet text | - | VideosArray | --videos | Array of String, BinaryData | Video files array | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - serialized JSON response from Twitter - -```bsl title="Code example" - - - ImageArray = New Array; - ImageArray.Add("C:\1.mp4"); - ImageArray.Add("C:\2.mp4"); - - Response = OPI_Twitter.CreateVideoTweet("Nature", ImageArray, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint twitter CreateVideoTweet --text %text% --videos %videos% --auth %auth% - - -``` - - -```json title="Result" - -{ - "data": { - "text": "Alpaca https://t.co/OodoWT1AAA", - "id": "1745753004542726629", - "edit_history_tweet_ids": [ - "1745753004542726629" - ] - } - } - -``` +--- +sidebar_position: 4 +--- + +# Create video tweet + Creates a tweet with a video attachment + + +*Function CreateVideoTweet(Val Text, Val VideosArray, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Text | --text | String | Tweet text | + | VideosArray | --videos | Array of String, BinaryData | Video files array | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - serialized JSON response from Twitter + +```bsl title="Code example" + + + ImageArray = New Array; + ImageArray.Add("C:\1.mp4"); + ImageArray.Add("C:\2.mp4"); + + Response = OPI_Twitter.CreateVideoTweet("Nature", ImageArray, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint twitter CreateVideoTweet --text %text% --videos %videos% --auth %auth% + + +``` + + +```json title="Result" + +{ + "data": { + "text": "Alpaca https://t.co/OodoWT1AAA", + "id": "1745753004542726629", + "edit_history_tweet_ids": [ + "1745753004542726629" + ] + } + } + +``` diff --git a/docs/en/md/Twitter/Tweets/_category_.json b/docs/en/md/Twitter/Tweets/_category_.json index 703cebbae0..84e117e25b 100644 --- a/docs/en/md/Twitter/Tweets/_category_.json +++ b/docs/en/md/Twitter/Tweets/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Tweets", -"position": "3" -} +{ +"label": "Tweets", +"position": "3" +} diff --git a/docs/en/md/Twitter/Twitter.md b/docs/en/md/Twitter/Twitter.md index c5a4e345a1..4a9d69be55 100644 --- a/docs/en/md/Twitter/Twitter.md +++ b/docs/en/md/Twitter/Twitter.md @@ -1,125 +1,125 @@ ---- -id: Twitter -sidebar_class_name: Twitter ---- - - - -# Twitter | X - -Этот раздел поwithinящен библиотеtoе for work with Twitter API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work. Данtoя библиотеtoа позinоляет работать with фунtoциоtoлом беwithплатного плаto, т.е. withоздаinать тinиты. Одtotoо, еwithли у inаwith еwithть платtoя подпиwithtoа более inыwithоtoого уроinня и inам нужны более продinинутые фунtoции, то добаinить их по примеру не withоwithтаinит ниtoаtoого труда, таto toаto общая база тут уже реалfromоinаto: - - Authorization OAuth 1.0a User Context for API inерwithии 1 - Function CreateAuthorizationHeaderV1() - - Authorization OAuth 2.0 for API inерwithии 2 - Function CreateAuthorizationHeaderV2() - - Upload fileоin: toаto одним запроwithом, таto и чанtoами - Function UploadMediaFile() - - Далее will опиwithан принци work with аinторfromацией и дinумя inерwithиями API, а примеры work with API можно inзять from фунtoций UploadMediaFile() (for v1) и CreateCustomTweet() (for v2) - -## Getting started - - -Work with Twitter подразумеinает работу with дinумя API - v1 (1.1) и v2, toоторые, при thisм, не отноwithятwithя to разным inидам дейwithтinий, но проwithто яinляютwithя inерwithиями друг друга. Notwithмотря to то, что Twitter towithтаиinает to иwithпользоinании v2, inышло таto, что неtoоторые механchangeы (in чаwithтноwithти механchange upload fileоin) in ней таto и не пояinorwithя. Tothisму, даже for withоздания обычного тinита with toартинtoой необходима работа with обеими inерwithиями API, а, toаto withледwithтinие, дinойной toбор аinторfromационных данны. Этот toбор опиwithан in фунtoции *GetStandardParameters()* - - -```bsl - - Parameters_.Insert("redirect_uri", ""); - Parameters_.Insert("scope", ""); - Parameters_.Insert("client_id", ""); - Parameters_.Insert("client_secret", ""); - Parameters_.Insert("access_token", ""); - Parameters_.Insert("refresh_token", ""); - Parameters_.Insert("oauth_token", ""); - Parameters_.Insert("oauth_token_secret", ""); - Parameters_.Insert("oauth_consumer_key", ""); - Parameters_.Insert("oauth_consumer_secret", ""); - -``` - -Inы можете определить эти параметры прямо in withтруtoтуре inнутри данной фунtoции or передаinать непоwithредwithтinенно при inызоinе фунtoций уже for work with API - toаждая from них принимает параметры afterдним необязательным параметром. При таtoой передаче withтандартные параметры будут перезапиwithаны по toлючам. Раwithwithмотрим withоздание приложения и получение each fields - - - ### Создание приложения - For work with Twitter API необходимо перейти по адреwithу [https://developer.twitter.com/](https://developer.twitter.com/), зарегиwithтрироinатьwithя и withоздать ноinое приложение - - ![BF](../../static/img/Docs/Twitter/1.png) - ![BF](../../static/img/Docs/Twitter/2.png) - ![BF](../../static/img/Docs/Twitter/3.png) - ![BF](../../static/img/Docs/Twitter/4.png) - ![BF](../../static/img/Docs/Twitter/5.png) - - ### Определение полей - Towithле withоздания приложения можно заполнить необходимые Data in 1С - - - - **redirect_uri** - - redirect_uri - адреwith обработчиtoа http-запроwithоin, уtoазанный при региwithтрации. Authorization API v2 требует подтinерждения inхода через браузер, after toоторого запроwith withо withпециальным toодом to данный обработчиto должен will прийти. Далее об thisм will in пунtoте access_token и refresh_token. - - - - **scope** - - scope определяет доwithтупные for work фунtoции. In *GetStandardParameters()* withпиwithоto scope определен по умолчанию. - - - **client_id** - - ![BF](../../static/img/Docs/Twitter/6.png) - - - **client_secret** - - ![BF](../../static/img/Docs/Twitter/7.png) - - - **access_token** и **refresh_token** - - Эти тоtoены необходимо получить http запроwithом with уtoазанием toода, toоторый приходит при аinторfromации to http-withерinиwith redirect_uri. Toрядоto дейwithтinий - 1. Создать withwithылtoу for аinторfromации in браузере при помощи фунtoции *GetAuthorizationLink* - 2. Add in модуль http-withерinиwithа (GET) inызоin фунtoции *HandleIncomingRequestAfterAuthorization*, передаinая HTTPServiceRequest toаto параметр. - 3. Authorfromоinатьwithя in браузере по withwithылtoе from п.1. - 3. Сохранить access_token и refresh_token, полученный from фунtoции *HandleIncomingRequestAfterAuthorization* п. 2, in toонwithтанты or другое хранorще - - - ```bsl title="Toлучение" - - Function Twitterget(Request) - - Code = Request.RequestParameters["code"]; - TokenResponse = OPI_Twitter.GetToken(Code, Parameters); - - Constants.TwitterRefresh.Set(ResponseToken["refresh_token"]); - Constants.TwitterToken.Set(ResponseToken["access_token"]); - - Response = New HTTPСерinиwithResponse(200); - Return Response; - - EndFunction - - ``` - - ```bsl title="Обноinление" - - Procedure ОбноinлятьTokenKаждыеTwoHourа(Val Parameters) - - Response = OPI_Twitter.RefreshToken(Parameters); - Constants.TwitterToken.Set(Response["access_token"]); - Constants.TwitterRefresh.Set(Response["refresh_token"]); - - EndProcedure - ``` - - Хардtoодить Data тоtoены нельзя, таto toаto acess_token дейwithтinует inwithего 2 hrаwithа. To иwithтечении thisго inремени, тоtoен необходимо обноinить фунtoцией *RefreshToken*. При thisм обноinляетwithя toаto access_token, таto и refresh_token. Т.е. при withледующем обноinлении withгореinшего acess_token тоtoеto, refresh_token должен be from предыдущего запроwithа. - - ![BF](../../static/img/Docs/Twitter/8.png) - - - - **oauth_token** и **oauth_token_secret** - - ![BF](../../static/img/Docs/Twitter/9.png) - - - **oauth_consumer_key** и **oauth_consumer_secret** - - ![BF](../../static/img/Docs/Twitter/10.png) - - - Towithле заполнения data полей можно приwithтупать to работе with methods API - - - +--- +id: Twitter +sidebar_class_name: Twitter +--- + + + +# Twitter | X + +Этот раздел поwithinящен библиотеtoе for work with Twitter API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work. Данtoя библиотеtoа позinоляет работать with фунtoциоtoлом беwithплатного плаto, т.е. withоздаinать тinиты. Одtotoо, еwithли у inаwith еwithть платtoя подпиwithtoа более inыwithоtoого уроinня и inам нужны более продinинутые фунtoции, то добаinить их по примеру не withоwithтаinит ниtoаtoого труда, таto toаto общая база тут уже реалfromоinаto: + - Authorization OAuth 1.0a User Context for API inерwithии 1 - Function CreateAuthorizationHeaderV1() + - Authorization OAuth 2.0 for API inерwithии 2 - Function CreateAuthorizationHeaderV2() + - Upload fileоin: toаto одним запроwithом, таto и чанtoами - Function UploadMediaFile() + + Далее will опиwithан принци work with аinторfromацией и дinумя inерwithиями API, а примеры work with API можно inзять from фунtoций UploadMediaFile() (for v1) и CreateCustomTweet() (for v2) + +## Getting started + + +Work with Twitter подразумеinает работу with дinумя API - v1 (1.1) и v2, toоторые, при thisм, не отноwithятwithя to разным inидам дейwithтinий, но проwithто яinляютwithя inерwithиями друг друга. Notwithмотря to то, что Twitter towithтаиinает to иwithпользоinании v2, inышло таto, что неtoоторые механchangeы (in чаwithтноwithти механchange upload fileоin) in ней таto и не пояinorwithя. Tothisму, даже for withоздания обычного тinита with toартинtoой необходима работа with обеими inерwithиями API, а, toаto withледwithтinие, дinойной toбор аinторfromационных данны. Этот toбор опиwithан in фунtoции *GetStandardParameters()* + + +```bsl + + Parameters_.Insert("redirect_uri", ""); + Parameters_.Insert("scope", ""); + Parameters_.Insert("client_id", ""); + Parameters_.Insert("client_secret", ""); + Parameters_.Insert("access_token", ""); + Parameters_.Insert("refresh_token", ""); + Parameters_.Insert("oauth_token", ""); + Parameters_.Insert("oauth_token_secret", ""); + Parameters_.Insert("oauth_consumer_key", ""); + Parameters_.Insert("oauth_consumer_secret", ""); + +``` + +Inы можете определить эти параметры прямо in withтруtoтуре inнутри данной фунtoции or передаinать непоwithредwithтinенно при inызоinе фунtoций уже for work with API - toаждая from них принимает параметры afterдним необязательным параметром. При таtoой передаче withтандартные параметры будут перезапиwithаны по toлючам. Раwithwithмотрим withоздание приложения и получение each fields + + + ### Создание приложения + For work with Twitter API необходимо перейти по адреwithу [https://developer.twitter.com/](https://developer.twitter.com/), зарегиwithтрироinатьwithя и withоздать ноinое приложение + + ![BF](../../static/img/Docs/Twitter/1.png) + ![BF](../../static/img/Docs/Twitter/2.png) + ![BF](../../static/img/Docs/Twitter/3.png) + ![BF](../../static/img/Docs/Twitter/4.png) + ![BF](../../static/img/Docs/Twitter/5.png) + + ### Определение полей + Towithле withоздания приложения можно заполнить необходимые Data in 1С + + + - **redirect_uri** + + redirect_uri - адреwith обработчиtoа http-запроwithоin, уtoазанный при региwithтрации. Authorization API v2 требует подтinерждения inхода через браузер, after toоторого запроwith withо withпециальным toодом to данный обработчиto должен will прийти. Далее об thisм will in пунtoте access_token и refresh_token. + + + - **scope** + + scope определяет доwithтупные for work фунtoции. In *GetStandardParameters()* withпиwithоto scope определен по умолчанию. + + - **client_id** + + ![BF](../../static/img/Docs/Twitter/6.png) + + - **client_secret** + + ![BF](../../static/img/Docs/Twitter/7.png) + + - **access_token** и **refresh_token** + + Эти тоtoены необходимо получить http запроwithом with уtoазанием toода, toоторый приходит при аinторfromации to http-withерinиwith redirect_uri. Toрядоto дейwithтinий + 1. Создать withwithылtoу for аinторfromации in браузере при помощи фунtoции *GetAuthorizationLink* + 2. Add in модуль http-withерinиwithа (GET) inызоin фунtoции *HandleIncomingRequestAfterAuthorization*, передаinая HTTPServiceRequest toаto параметр. + 3. Authorfromоinатьwithя in браузере по withwithылtoе from п.1. + 3. Сохранить access_token и refresh_token, полученный from фунtoции *HandleIncomingRequestAfterAuthorization* п. 2, in toонwithтанты or другое хранorще + + + ```bsl title="Toлучение" + + Function Twitterget(Request) + + Code = Request.RequestParameters["code"]; + TokenResponse = OPI_Twitter.GetToken(Code, Parameters); + + Constants.TwitterRefresh.Set(ResponseToken["refresh_token"]); + Constants.TwitterToken.Set(ResponseToken["access_token"]); + + Response = New HTTPСерinиwithResponse(200); + Return Response; + + EndFunction + + ``` + + ```bsl title="Обноinление" + + Procedure ОбноinлятьTokenKаждыеTwoHourа(Val Parameters) + + Response = OPI_Twitter.RefreshToken(Parameters); + Constants.TwitterToken.Set(Response["access_token"]); + Constants.TwitterRefresh.Set(Response["refresh_token"]); + + EndProcedure + ``` + + Хардtoодить Data тоtoены нельзя, таto toаto acess_token дейwithтinует inwithего 2 hrаwithа. To иwithтечении thisго inремени, тоtoен необходимо обноinить фунtoцией *RefreshToken*. При thisм обноinляетwithя toаto access_token, таto и refresh_token. Т.е. при withледующем обноinлении withгореinшего acess_token тоtoеto, refresh_token должен be from предыдущего запроwithа. + + ![BF](../../static/img/Docs/Twitter/8.png) + + + - **oauth_token** и **oauth_token_secret** + + ![BF](../../static/img/Docs/Twitter/9.png) + + - **oauth_consumer_key** и **oauth_consumer_secret** + + ![BF](../../static/img/Docs/Twitter/10.png) + + + Towithле заполнения data полей можно приwithтупать to работе with methods API + + + diff --git a/docs/en/md/Twitter/_category_.json b/docs/en/md/Twitter/_category_.json index dbe01fe18d..709cd21863 100644 --- a/docs/en/md/Twitter/_category_.json +++ b/docs/en/md/Twitter/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Twitter", - "position": 4, - "link": { - "type": "doc", - "id": "Twitter" - } -} +{ + "label": "Twitter", + "position": 4, + "link": { + "type": "doc", + "id": "Twitter" + } +} diff --git a/docs/en/md/VK/Ad-account-management/Create-ad.md b/docs/en/md/VK/Ad-account-management/Create-ad.md index 715bc512ab..0887cdfe37 100644 --- a/docs/en/md/VK/Ad-account-management/Create-ad.md +++ b/docs/en/md/VK/Ad-account-management/Create-ad.md @@ -1,51 +1,51 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.CreateAd(1029683999, 166, 126, 221, 1607951446, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk CreateAd --campaign %campaign% --limit %limit% --category %category% --post %post% --cabinet %cabinet% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": [ - { - "id": 171372386 - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.CreateAd(1029683999, 166, 126, 221, 1607951446, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk CreateAd --campaign %campaign% --limit %limit% --category %category% --post %post% --cabinet %cabinet% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": [ + { + "id": 171372386 + } + ] + } + +``` 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 index cfebc729ad..f59f3c94e9 100644 --- a/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md +++ b/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md @@ -1,48 +1,48 @@ ---- -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 | Destination | - |-|-|-|-| - | AccountID | --cabinet | String, Number | Advertising account ID | - | Name | --title | String | Campaign name | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.CreateAdvertisingCampaign(1234567890, "New ads campaign", Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk CreateAdvertisingCampaign --cabinet %cabinet% --title %title% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": [ - { - "id": 1029701085 - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | AccountID | --cabinet | String, Number | Advertising account ID | + | Name | --title | String | Campaign name | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.CreateAdvertisingCampaign(1234567890, "New ads campaign", Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk CreateAdvertisingCampaign --cabinet %cabinet% --title %title% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": [ + { + "id": 1029701085 + } + ] + } + +``` 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 index 0ff8854965..8c66c4ed40 100644 --- 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 @@ -1,71 +1,71 @@ ---- -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 | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.GetAdvertisingCategoryList(Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetAdvertisingCategoryList --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "v2": [ - { - "subcategories": [ - { - "subcategories": [ - { - "name": "Mobile phones and tablets", - "id": 202 - }, - { - "name": "Audio and video", - "id": 203 - }, - { - "name": "Portable gadgets", - "id": 204 - }, - { - "name": "Consoles", - "id": 205 - }, - - ... - ] - } - ] - } - ] - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.GetAdvertisingCategoryList(Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetAdvertisingCategoryList --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "v2": [ + { + "subcategories": [ + { + "subcategories": [ + { + "name": "Mobile phones and tablets", + "id": 202 + }, + { + "name": "Audio and video", + "id": 203 + }, + { + "name": "Portable gadgets", + "id": 204 + }, + { + "name": "Consoles", + "id": 205 + }, + + ... + ] + } + ] + } + ] + } + } + +``` diff --git a/docs/en/md/VK/Ad-account-management/Pause-advertising-ad.md b/docs/en/md/VK/Ad-account-management/Pause-advertising-ad.md index befecd9e17..7bc0489fa9 100644 --- a/docs/en/md/VK/Ad-account-management/Pause-advertising-ad.md +++ b/docs/en/md/VK/Ad-account-management/Pause-advertising-ad.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 3 ---- - -# Pause advertising post - Pauses the display of the advertising post - - -*Function PauseAdvertisingAd(Val AccountID, Val AdID, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | AccountID | --cabinet | String, Number | Advertising account ID | - | AdID | --adv | String, Number | Ad ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.PauseAdvertisingAd(1234567890, 1029701085, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk PauseAdvertisingAd --cabinet %cabinet% --adv %adv% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": [ - { - "id": 1029701085 - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Pause advertising post + Pauses the display of the advertising post + + +*Function PauseAdvertisingAd(Val AccountID, Val AdID, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | AccountID | --cabinet | String, Number | Advertising account ID | + | AdID | --adv | String, Number | Ad ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.PauseAdvertisingAd(1234567890, 1029701085, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk PauseAdvertisingAd --cabinet %cabinet% --adv %adv% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": [ + { + "id": 1029701085 + } + ] + } + +``` diff --git a/docs/en/md/VK/Ad-account-management/_category_.json b/docs/en/md/VK/Ad-account-management/_category_.json index eced2626a3..67430544e6 100644 --- a/docs/en/md/VK/Ad-account-management/_category_.json +++ b/docs/en/md/VK/Ad-account-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Ad account management", -"position": "7" -} +{ +"label": "Ad account management", +"position": "7" +} diff --git a/docs/en/md/VK/Discussion-management/Close-discussion.md b/docs/en/md/VK/Discussion-management/Close-discussion.md index 2a8c2bb18d..071a430108 100644 --- a/docs/en/md/VK/Discussion-management/Close-discussion.md +++ b/docs/en/md/VK/Discussion-management/Close-discussion.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 2 ---- - -# Close discussion - Close or delete discussion - - -*Function CloseDiscussion(Val DiscussionID, Val DeleteCompletely = False, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - DiscussionID = "51206275"; - Result = OPI_VK.CloseDiscussion(DiscussionID, False, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk CloseDiscussion --topic %topic% --remove %remove% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 2 +--- + +# Close discussion + Close or delete discussion + + +*Function CloseDiscussion(Val DiscussionID, Val DeleteCompletely = False, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + DiscussionID = "51206275"; + Result = OPI_VK.CloseDiscussion(DiscussionID, False, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk CloseDiscussion --topic %topic% --remove %remove% --auth %auth% + + +``` + + +```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 index dc30fd0e39..429edf6301 100644 --- a/docs/en/md/VK/Discussion-management/Create-discussion.md +++ b/docs/en/md/VK/Discussion-management/Create-discussion.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 1 ---- - -# Create discussion - Creates a new discussion - - -*Function CreateDiscussion(Val Name, Val FirstMessageText, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - 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); - - -``` - -```sh title="CLI command example" - - oint vk CreateDiscussion --title %title% --text %text% --auth "GetVKParameters()" - - -``` - - -```json title="Result" - -{ - "response": 51182455 -} - -``` +--- +sidebar_position: 1 +--- + +# Create discussion + Creates a new discussion + + +*Function CreateDiscussion(Val Name, Val FirstMessageText, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - 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); + + +``` + +```sh title="CLI command example" + + oint vk CreateDiscussion --title %title% --text %text% --auth "GetVKParameters()" + + +``` + + +```json title="Result" + +{ + "response": 51182455 +} + +``` diff --git a/docs/en/md/VK/Discussion-management/Open-discussion.md b/docs/en/md/VK/Discussion-management/Open-discussion.md index 632220a707..41ad2f4086 100644 --- a/docs/en/md/VK/Discussion-management/Open-discussion.md +++ b/docs/en/md/VK/Discussion-management/Open-discussion.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 3 ---- - -# Open discussion - Opens a previously closed discussion - - -*Function OpenDiscussion(Val DiscussionID, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | DiscussionID | --topic | String, Number | Discussion ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - DiscussionID = "51206275"; - Result = OPI_VK.OpenDiscussion(DiscussionID, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk OpenDiscussion --topic %topic% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 3 +--- + +# Open discussion + Opens a previously closed discussion + + +*Function OpenDiscussion(Val DiscussionID, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | DiscussionID | --topic | String, Number | Discussion ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + DiscussionID = "51206275"; + Result = OPI_VK.OpenDiscussion(DiscussionID, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk OpenDiscussion --topic %topic% --auth %auth% + + +``` + + +```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 index 3a68c15566..c464502f8b 100644 --- a/docs/en/md/VK/Discussion-management/Write-in-discussion.md +++ b/docs/en/md/VK/Discussion-management/Write-in-discussion.md @@ -1,45 +1,45 @@ ---- -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 | Destination | - |-|-|-|-| - | DiscussionID | --topic | String, Number | Discussion ID | - | Text | --text | String | Message text | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - DiscussionID = "51206275"; - Message = "I like yellow more"; - - Result = OPI_VK.WriteInDiscussion(DiscussionID, Message, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk WriteInDiscussion --topic %topic% --text %text% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 705 -} - -``` +--- +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 | Destination | + |-|-|-|-| + | DiscussionID | --topic | String, Number | Discussion ID | + | Text | --text | String | Message text | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + DiscussionID = "51206275"; + Message = "I like yellow more"; + + Result = OPI_VK.WriteInDiscussion(DiscussionID, Message, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk WriteInDiscussion --topic %topic% --text %text% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": 705 +} + +``` diff --git a/docs/en/md/VK/Discussion-management/_category_.json b/docs/en/md/VK/Discussion-management/_category_.json index 198b6ab1a9..2669f444c0 100644 --- a/docs/en/md/VK/Discussion-management/_category_.json +++ b/docs/en/md/VK/Discussion-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Discussion management", -"position": "4" -} +{ +"label": "Discussion management", +"position": "4" +} diff --git a/docs/en/md/VK/Group-work/Create-album.md b/docs/en/md/VK/Group-work/Create-album.md index 93e48c6629..9ec44b9aca 100644 --- a/docs/en/md/VK/Group-work/Create-album.md +++ b/docs/en/md/VK/Group-work/Create-album.md @@ -1,59 +1,59 @@ ---- -sidebar_position: 5 ---- - -# Create album - Creates an album to store images - - -*Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Album name | - | Description | --description | String | Album description | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - Name = "AlbumFromAutoTest"; - Description = "NewAlbumFromAutoTest"; - - Result = OPI_VK.CreateAlbum(Name, Description, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk CreateAlbum --title %title% --description %description% --auth "GetVKParameters()" - - -``` - - -```json title="Result" - -{ - "response": { - "id": 304498513, - "owner_id": -218861756, - "size": 0, - "title": "AlbumFromAutoTest", - "feed_disabled": 0, - "feed_has_pinned": 0, - "can_upload": 1, - "comments_disabled": 0, - "created": 1717072416, - "description": "NewAlbumFromAutoTest", - "thumb_id": 0, - "updated": 1717072416, - "upload_by_admins_only": 1 - } -} - -``` +--- +sidebar_position: 5 +--- + +# Create album + Creates an album to store images + + +*Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Album name | + | Description | --description | String | Album description | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + Name = "AlbumFromAutoTest"; + Description = "NewAlbumFromAutoTest"; + + Result = OPI_VK.CreateAlbum(Name, Description, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk CreateAlbum --title %title% --description %description% --auth "GetVKParameters()" + + +``` + + +```json title="Result" + +{ + "response": { + "id": 304498513, + "owner_id": -218861756, + "size": 0, + "title": "AlbumFromAutoTest", + "feed_disabled": 0, + "feed_has_pinned": 0, + "can_upload": 1, + "comments_disabled": 0, + "created": 1717072416, + "description": "NewAlbumFromAutoTest", + "thumb_id": 0, + "updated": 1717072416, + "upload_by_admins_only": 1 + } +} + +``` diff --git a/docs/en/md/VK/Group-work/Create-composite-post.md b/docs/en/md/VK/Group-work/Create-composite-post.md index 41fe1f9dcd..7bcc826af2 100644 --- a/docs/en/md/VK/Group-work/Create-composite-post.md +++ b/docs/en/md/VK/Group-work/Create-composite-post.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 2 ---- - -# Create composite post - Creates a post based on an array of object identifiers (images, videos, etc..) - - -*Function CreateCompositePost(Val Text, Val Objects, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Text | --text | String | Post text | - | Objects | --objects | Array of String | Array of identifiers like photo123_123 | - | Advertisement | --ad | Boolean | Sign ""This is an ad"" | - | LinkUnderPost | --url | String | Link (URL) under the post | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - Text = "Post from autotest"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data - Video = "https://openintegrations.dev/test_data/video.mp4"; // URL, Path or Binary Data - - AndVF = GetTempFileName("png"); - CopyFile(Image, AndVF); - - ImageUpload = OPI_VK.UploadPhotoToServer(AndVF, Parameters)["response"][0]; - VideoUpload = OPI_VK.UploadVideoToServer(Video, "NewVideo",,, Parameters); - - ImageOwner = OPI_Tools.NumberToString(ImageUpload["owner_id"]); - VideoOwner = OPI_Tools.NumberToString(VideoUpload["owner_id"]); - - ImageID = OPI_Tools.NumberToString(ImageUpload["id"]); - VideoID = OPI_Tools.NumberToString(VideoUpload["video_id"]); - - AttachmentsArray = New Array; - AttachmentsArray.Add("photo" + ImageOwner + "_" + ImageID); - AttachmentsArray.Add("video" + VideoOwner + "_" + VideoID); - - Result = OPI_VK.CreateCompositePost(Text, AttachmentsArray, False, URL, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk CreateCompositePost --text %text% --objects %objects% --ad %ad% --url %url% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "post_id": 2126 - } -} - -``` +--- +sidebar_position: 2 +--- + +# Create composite post + Creates a post based on an array of object identifiers (images, videos, etc..) + + +*Function CreateCompositePost(Val Text, Val Objects, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Text | --text | String | Post text | + | Objects | --objects | Array of String | Array of identifiers like photo123_123 | + | Advertisement | --ad | Boolean | Sign ""This is an ad"" | + | LinkUnderPost | --url | String | Link (URL) under the post | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + Text = "Post from autotest"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data + Video = "https://openintegrations.dev/test_data/video.mp4"; // URL, Path or Binary Data + + AndVF = GetTempFileName("png"); + CopyFile(Image, AndVF); + + ImageUpload = OPI_VK.UploadPhotoToServer(AndVF, Parameters)["response"][0]; + VideoUpload = OPI_VK.UploadVideoToServer(Video, "NewVideo",,, Parameters); + + ImageOwner = OPI_Tools.NumberToString(ImageUpload["owner_id"]); + VideoOwner = OPI_Tools.NumberToString(VideoUpload["owner_id"]); + + ImageID = OPI_Tools.NumberToString(ImageUpload["id"]); + VideoID = OPI_Tools.NumberToString(VideoUpload["video_id"]); + + AttachmentsArray = New Array; + AttachmentsArray.Add("photo" + ImageOwner + "_" + ImageID); + AttachmentsArray.Add("video" + VideoOwner + "_" + VideoID); + + Result = OPI_VK.CreateCompositePost(Text, AttachmentsArray, False, URL, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk CreateCompositePost --text %text% --objects %objects% --ad %ad% --url %url% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "post_id": 2126 + } +} + +``` diff --git a/docs/en/md/VK/Group-work/Create-poll.md b/docs/en/md/VK/Group-work/Create-poll.md index 5114d76a7a..c10058662c 100644 --- a/docs/en/md/VK/Group-work/Create-poll.md +++ b/docs/en/md/VK/Group-work/Create-poll.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 4 ---- - -# Create poll - Creates a poll with answer options - - -*Function CreatePoll(Val Question, Val AnswersArray, Val Image = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Question | --question | String | Poll question | - | AnswersArray | --options | Array of String | Array of answer options | - | Image | --picture | String, BinaryData | Poll image | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - Question = "What's your favorite color?"; - - OptionArray = New Array; - OptionArray.Add("Red"); - OptionArray.Add("Yellow"); - OptionArray.Add("Green"); - - Result = OPI_VK.CreatePoll(Question, OptionArray,, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk CreatePoll --question "What's your favorite color?" --options %options% --picture %picture% --auth "GetVKParameters()" - - -``` - - -```json title="Result" - -{ - "response": { - "post_id": 2127 - } -} - -``` +--- +sidebar_position: 4 +--- + +# Create poll + Creates a poll with answer options + + +*Function CreatePoll(Val Question, Val AnswersArray, Val Image = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Question | --question | String | Poll question | + | AnswersArray | --options | Array of String | Array of answer options | + | Image | --picture | String, BinaryData | Poll image | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + Question = "What's your favorite color?"; + + OptionArray = New Array; + OptionArray.Add("Red"); + OptionArray.Add("Yellow"); + OptionArray.Add("Green"); + + Result = OPI_VK.CreatePoll(Question, OptionArray,, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk CreatePoll --question "What's your favorite color?" --options %options% --picture %picture% --auth "GetVKParameters()" + + +``` + + +```json title="Result" + +{ + "response": { + "post_id": 2127 + } +} + +``` diff --git a/docs/en/md/VK/Group-work/Create-post.md b/docs/en/md/VK/Group-work/Create-post.md index 35f0611513..ad0aa593e7 100644 --- a/docs/en/md/VK/Group-work/Create-post.md +++ b/docs/en/md/VK/Group-work/Create-post.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 1 ---- - -# Create post - Creates a post with images - - -*Function CreatePost(Val Text, Val ImageArray, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Text | --text | String | Post text | - | ImageArray | --pictures | Array of String, BinaryData | Array of images | - | Advertisement | --ad | Boolean | Sign ""This is an ad"" | - | LinkUnderPost | --url | String | Link (URL) under the post | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - Text = "Post from autotest"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data - Image2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Path or Binary Data - - AndVF = GetTempFileName("png"); - CopyFile(Image2, AndVF); - - ImageArray = New Array; - ImageArray.Add(Image); - ImageArray.Add(AndVF); - - Result = OPI_VK.CreatePost(Text, ImageArray, True, URL, Parameters); - Result = OPI_VK.CreatePost(Text, Image, False,, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk CreatePost --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "post_id": 2123 - } -} - -``` +--- +sidebar_position: 1 +--- + +# Create post + Creates a post with images + + +*Function CreatePost(Val Text, Val ImageArray, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Text | --text | String | Post text | + | ImageArray | --pictures | Array of String, BinaryData | Array of images | + | Advertisement | --ad | Boolean | Sign ""This is an ad"" | + | LinkUnderPost | --url | String | Link (URL) under the post | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + Text = "Post from autotest"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data + Image2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Path or Binary Data + + AndVF = GetTempFileName("png"); + CopyFile(Image2, AndVF); + + ImageArray = New Array; + ImageArray.Add(Image); + ImageArray.Add(AndVF); + + Result = OPI_VK.CreatePost(Text, ImageArray, True, URL, Parameters); + Result = OPI_VK.CreatePost(Text, Image, False,, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk CreatePost --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "post_id": 2123 + } +} + +``` diff --git a/docs/en/md/VK/Group-work/Create-story.md b/docs/en/md/VK/Group-work/Create-story.md index e92d910f96..c7144b4f6d 100644 --- a/docs/en/md/VK/Group-work/Create-story.md +++ b/docs/en/md/VK/Group-work/Create-story.md @@ -1,140 +1,140 @@ ---- -sidebar_position: 7 ---- - -# Create story - Creates a story from an image - - -*Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Image | --picture | String, BinaryData | Story background | - | URL | --url | String | URL for button under the story | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data - AndVF = GetTempFileName("png"); - CopyFile(Image, AndVF); - Image = New BinaryData(AndVF); - - Result = OPI_VK.CreateStory(Image, URL, Parameters); - Result = OPI_VK.CreateStory(AndVF,, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk CreateStory --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "count": 1, - "items": [ - { - "id": 456239491, - "owner_id": -218861756, - "access_key": "story", - "can_comment": 1, - "can_reply": 1, - "can_see": 1, - "can_like": true, - "can_share": 1, - "can_hide": 1, - "date": 1717072436, - "expires_at": 1717158836, - "link": { - "text": "More", - "url": "https://github.com/Bayselonarrend/OpenIntegrations" - }, - "photo": { - "album_id": -81, - "date": 1717072436, - "id": 457244016, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun6-20.userapi.com/s/v1/ig2/TUrQJn6Un8LHB0aNIOPtaqEt3K_J4tZbV2notqyJ1TUyHCj9m-bbiOZKm1u07WpGGAZfH1LFXbg95EM-uS0JHKX9.jpg?size=75x56&quality=95&type=story" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun6-20.userapi.com/s/v1/ig2/lASmJS8sUOYvtmSKkFOsBGNIWpcqoqenWSBOdBHSXQE9PuZjUx_aVVA3Zd6DOV08nssSEYQgXJ6Vam6TiPx2Lcpm.jpg?size=130x97&quality=95&type=story" - }, - { - "height": 192, - "type": "j", - "width": 256, - "url": "https://sun6-20.userapi.com/s/v1/ig2/mmYPgPQo3uRxhAH1qIKIijT-5j87fr0A5PEe1X8k3kdo5MmagHYZIdECvXyFL9KubVsKzTZTWFJSQgskL5a09dhS.jpg?size=256x192&quality=95&type=story" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun6-20.userapi.com/s/v1/ig2/APnAEUFfn6z-WwqFWAM0_jbv9cRo4zrIPx3RSFrsSNdh8bXpv6438yZqB_BDM3pMfSfl6Gsx751T7mJ8yEf_zCi9.jpg?size=604x453&quality=95&type=story" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun6-20.userapi.com/s/v1/ig2/vou57hqLWC875j9nOB1HbiEWaVcSXCHmxNlyzyKEyKv6UO97Mm67PyKNftSvW0RvaHARFvl7Hc9noOv2TAV8Tq6X.jpg?size=807x605&quality=95&type=story" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun6-20.userapi.com/s/v1/ig2/WGh4yRLRWsT4baZUDXiIUZU90sFYcZKcme9nnAPSy8CW_uYDQRDQSy8s0SkNRDEBteCyRBPG0Ka7tPwRQzp5M6Cx.jpg?size=1280x960&quality=95&type=story" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun6-20.userapi.com/s/v1/ig2/QugTL2gH3oV88GUPKhP1GOUfKWONc8iSt_v-Qt6TOsmioQPJ9nyq4L2a1yBHu2eSJKjsql1VhMtEx6wpt3fVVnly.jpg?size=2560x1920&quality=95&type=story" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "404a88e5d32e0ff306", - "has_tags": false - }, - "replies": { - "count": 0, - "new": 0 - }, - "is_one_time": false, - "track_code": "story/3AAQAdLy9G9EAs4bMamDA84nNfHkBAAFoAagB6AIAA==", - "type": "photo", - "views": 0, - "likes_count": 0, - "reaction_set_id": "reactions", - "no_sound": false, - "can_ask": 0, - "can_ask_anonymous": 0, - "narratives_count": 0, - "can_use_in_narrative": true - } - ] - } -} - -``` +--- +sidebar_position: 7 +--- + +# Create story + Creates a story from an image + + +*Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Image | --picture | String, BinaryData | Story background | + | URL | --url | String | URL for button under the story | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data + AndVF = GetTempFileName("png"); + CopyFile(Image, AndVF); + Image = New BinaryData(AndVF); + + Result = OPI_VK.CreateStory(Image, URL, Parameters); + Result = OPI_VK.CreateStory(AndVF,, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk CreateStory --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "count": 1, + "items": [ + { + "id": 456239491, + "owner_id": -218861756, + "access_key": "story", + "can_comment": 1, + "can_reply": 1, + "can_see": 1, + "can_like": true, + "can_share": 1, + "can_hide": 1, + "date": 1717072436, + "expires_at": 1717158836, + "link": { + "text": "More", + "url": "https://github.com/Bayselonarrend/OpenIntegrations" + }, + "photo": { + "album_id": -81, + "date": 1717072436, + "id": 457244016, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun6-20.userapi.com/s/v1/ig2/TUrQJn6Un8LHB0aNIOPtaqEt3K_J4tZbV2notqyJ1TUyHCj9m-bbiOZKm1u07WpGGAZfH1LFXbg95EM-uS0JHKX9.jpg?size=75x56&quality=95&type=story" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun6-20.userapi.com/s/v1/ig2/lASmJS8sUOYvtmSKkFOsBGNIWpcqoqenWSBOdBHSXQE9PuZjUx_aVVA3Zd6DOV08nssSEYQgXJ6Vam6TiPx2Lcpm.jpg?size=130x97&quality=95&type=story" + }, + { + "height": 192, + "type": "j", + "width": 256, + "url": "https://sun6-20.userapi.com/s/v1/ig2/mmYPgPQo3uRxhAH1qIKIijT-5j87fr0A5PEe1X8k3kdo5MmagHYZIdECvXyFL9KubVsKzTZTWFJSQgskL5a09dhS.jpg?size=256x192&quality=95&type=story" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun6-20.userapi.com/s/v1/ig2/APnAEUFfn6z-WwqFWAM0_jbv9cRo4zrIPx3RSFrsSNdh8bXpv6438yZqB_BDM3pMfSfl6Gsx751T7mJ8yEf_zCi9.jpg?size=604x453&quality=95&type=story" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun6-20.userapi.com/s/v1/ig2/vou57hqLWC875j9nOB1HbiEWaVcSXCHmxNlyzyKEyKv6UO97Mm67PyKNftSvW0RvaHARFvl7Hc9noOv2TAV8Tq6X.jpg?size=807x605&quality=95&type=story" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun6-20.userapi.com/s/v1/ig2/WGh4yRLRWsT4baZUDXiIUZU90sFYcZKcme9nnAPSy8CW_uYDQRDQSy8s0SkNRDEBteCyRBPG0Ka7tPwRQzp5M6Cx.jpg?size=1280x960&quality=95&type=story" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun6-20.userapi.com/s/v1/ig2/QugTL2gH3oV88GUPKhP1GOUfKWONc8iSt_v-Qt6TOsmioQPJ9nyq4L2a1yBHu2eSJKjsql1VhMtEx6wpt3fVVnly.jpg?size=2560x1920&quality=95&type=story" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "404a88e5d32e0ff306", + "has_tags": false + }, + "replies": { + "count": 0, + "new": 0 + }, + "is_one_time": false, + "track_code": "story/3AAQAdLy9G9EAs4bMamDA84nNfHkBAAFoAagB6AIAA==", + "type": "photo", + "views": 0, + "likes_count": 0, + "reaction_set_id": "reactions", + "no_sound": false, + "can_ask": 0, + "can_ask_anonymous": 0, + "narratives_count": 0, + "can_use_in_narrative": true + } + ] + } +} + +``` diff --git a/docs/en/md/VK/Group-work/Delete-album.md b/docs/en/md/VK/Group-work/Delete-album.md index d05dd8cc17..5bdc7f3155 100644 --- a/docs/en/md/VK/Group-work/Delete-album.md +++ b/docs/en/md/VK/Group-work/Delete-album.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 6 ---- - -# Delete album - Deletes a previously created album - - -*Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | AlbumID | --album | String, Number | Album ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - AlbumID = "304549394"; - - Result = OPI_VK.DeleteAlbum(AlbumID, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk DeleteAlbum --album %album% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 6 +--- + +# Delete album + Deletes a previously created album + + +*Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | AlbumID | --album | String, Number | Album ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + AlbumID = "304549394"; + + Result = OPI_VK.DeleteAlbum(AlbumID, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk DeleteAlbum --album %album% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": 1 +} + +``` diff --git a/docs/en/md/VK/Group-work/Delete-image.md b/docs/en/md/VK/Group-work/Delete-image.md index 9a77af31fd..fcf551b4d2 100644 --- a/docs/en/md/VK/Group-work/Delete-image.md +++ b/docs/en/md/VK/Group-work/Delete-image.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 9 ---- - -# Delete image - Deletes an image from the album - - -*Function DeleteImage(Val ImageID, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | ImageID | --pictureid | String, Number | Image ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - ImageID = "457244340"; - - Result = OPI_VK.DeleteImage(ImageID, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk DeleteImage --pictureid %pictureid% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 9 +--- + +# Delete image + Deletes an image from the album + + +*Function DeleteImage(Val ImageID, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | ImageID | --pictureid | String, Number | Image ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + ImageID = "457244340"; + + Result = OPI_VK.DeleteImage(ImageID, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk DeleteImage --pictureid %pictureid% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": 1 +} + +``` diff --git a/docs/en/md/VK/Group-work/Delete-post.md b/docs/en/md/VK/Group-work/Delete-post.md index 3c0fc5a60b..36930b090f 100644 --- a/docs/en/md/VK/Group-work/Delete-post.md +++ b/docs/en/md/VK/Group-work/Delete-post.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 3 ---- - -# Delete post - Deletes a post by ID - - -*Function DeletePost(Val PostID, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | PostID | --post | String, Number | Post ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - PostID = "2304"; - - Result = OPI_VK.DeletePost(PostID, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk DeletePost --post %post% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 3 +--- + +# Delete post + Deletes a post by ID + + +*Function DeletePost(Val PostID, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | PostID | --post | String, Number | Post ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + PostID = "2304"; + + Result = OPI_VK.DeletePost(PostID, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk DeletePost --post %post% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": 1 +} + +``` diff --git a/docs/en/md/VK/Group-work/Save-image-to-album.md b/docs/en/md/VK/Group-work/Save-image-to-album.md index 346029d74b..b470160124 100644 --- a/docs/en/md/VK/Group-work/Save-image-to-album.md +++ b/docs/en/md/VK/Group-work/Save-image-to-album.md @@ -1,126 +1,126 @@ ---- -sidebar_position: 8 ---- - -# Save image to album - Saves an image to the community album - - -*Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | AlbumID | --album | String, Number | Album ID | - | Image | --picture | BinaryData,String | Image file | - | Description | --description | String | Image description | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - Parameters = GetVKParameters(); - ImageDescription = "AutoTestImage"; - AlbumID = "304549394"; - - Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data - AndVF = GetTempFileName("png"); - CopyFile(Image, AndVF); - - Image = New BinaryData(AndVF); - - Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters); - Result = OPI_VK.SaveImageToAlbum(AlbumID, AndVF, ImageDescription, Parameters); - - -``` - -```sh title="CLI command example" - - oint vk SaveImageToAlbum --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": [ - { - "album_id": 304498513, - "date": 1717072420, - "id": 457244015, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=75x56&quality=96&sign=025829abd0851633ab894cc48e64dbbb&c_uniq_tag=2CLDgToJpt6arrVUiZQ9l04lyJ415VJvA6WDs7UOnoI&type=album" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=604x453&quality=96&sign=13ca3aaef94483586ace112657fe8241&c_uniq_tag=_pon027js3STBAQDQY4UbPdMBOh0AzKmalzEJnHAb-8&type=album" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=807x605&quality=96&sign=ca6a02d61aa6e88bbd63631e32c49895&c_uniq_tag=NSEWtM7U9s0sKGN84elYe-6ayOzx8dJXPD5JxUFUSK8&type=album" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=1280x960&quality=96&sign=b10c42d8778cd2ac306fdeed0d7c77e9&c_uniq_tag=OsjHk58Ztn163AK2vT9xOw8tz75w00HoqpQSzJ9DOzo&type=album" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=2560x1920&quality=96&sign=2b5cb4cd90cd4d100b394da5cd1d2540&c_uniq_tag=JXApXjELC3QaCHRgTV2wAZ9xT_1uGPHx2DnJ15ZrfqQ&type=album" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=200x150&quality=96&sign=aea8308f1793d48319babde7d4cf7a2a&c_uniq_tag=0oVRnXvNOW_41uhPO1-daYe0KK2SgLDPeMJ4gk2Js5g&type=album" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=320x240&quality=96&sign=f3d612a2ac0b297964e48d1775fa0c70&c_uniq_tag=LAynb-BcGM4BS_ew4PYMa93V627AEj8nTMcnq8Wy5gY&type=album" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=510x382&quality=96&sign=88209c9869f3522afe0a292a5884e246&c_uniq_tag=eMrSiFeVaca-qCgJXIxD1U1wU6ZInBYxsJVHxKn8CbY&type=album" - } - ], - "text": "AutoTestImage", - "user_id": 100, - "web_view_token": "dcacf60c612a67607b", - "has_tags": false - } - ] -} - -``` +--- +sidebar_position: 8 +--- + +# Save image to album + Saves an image to the community album + + +*Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | AlbumID | --album | String, Number | Album ID | + | Image | --picture | BinaryData,String | Image file | + | Description | --description | String | Image description | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + Parameters = GetVKParameters(); + ImageDescription = "AutoTestImage"; + AlbumID = "304549394"; + + Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data + AndVF = GetTempFileName("png"); + CopyFile(Image, AndVF); + + Image = New BinaryData(AndVF); + + Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters); + Result = OPI_VK.SaveImageToAlbum(AlbumID, AndVF, ImageDescription, Parameters); + + +``` + +```sh title="CLI command example" + + oint vk SaveImageToAlbum --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": [ + { + "album_id": 304498513, + "date": 1717072420, + "id": 457244015, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=75x56&quality=96&sign=025829abd0851633ab894cc48e64dbbb&c_uniq_tag=2CLDgToJpt6arrVUiZQ9l04lyJ415VJvA6WDs7UOnoI&type=album" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=604x453&quality=96&sign=13ca3aaef94483586ace112657fe8241&c_uniq_tag=_pon027js3STBAQDQY4UbPdMBOh0AzKmalzEJnHAb-8&type=album" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=807x605&quality=96&sign=ca6a02d61aa6e88bbd63631e32c49895&c_uniq_tag=NSEWtM7U9s0sKGN84elYe-6ayOzx8dJXPD5JxUFUSK8&type=album" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=1280x960&quality=96&sign=b10c42d8778cd2ac306fdeed0d7c77e9&c_uniq_tag=OsjHk58Ztn163AK2vT9xOw8tz75w00HoqpQSzJ9DOzo&type=album" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=2560x1920&quality=96&sign=2b5cb4cd90cd4d100b394da5cd1d2540&c_uniq_tag=JXApXjELC3QaCHRgTV2wAZ9xT_1uGPHx2DnJ15ZrfqQ&type=album" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=200x150&quality=96&sign=aea8308f1793d48319babde7d4cf7a2a&c_uniq_tag=0oVRnXvNOW_41uhPO1-daYe0KK2SgLDPeMJ4gk2Js5g&type=album" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=320x240&quality=96&sign=f3d612a2ac0b297964e48d1775fa0c70&c_uniq_tag=LAynb-BcGM4BS_ew4PYMa93V627AEj8nTMcnq8Wy5gY&type=album" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=510x382&quality=96&sign=88209c9869f3522afe0a292a5884e246&c_uniq_tag=eMrSiFeVaca-qCgJXIxD1U1wU6ZInBYxsJVHxKn8CbY&type=album" + } + ], + "text": "AutoTestImage", + "user_id": 100, + "web_view_token": "dcacf60c612a67607b", + "has_tags": false + } + ] +} + +``` diff --git a/docs/en/md/VK/Group-work/Upload-photo-to-server.md b/docs/en/md/VK/Group-work/Upload-photo-to-server.md index 8fbb0821ac..89b76e1e98 100644 --- a/docs/en/md/VK/Group-work/Upload-photo-to-server.md +++ b/docs/en/md/VK/Group-work/Upload-photo-to-server.md @@ -1,38 +1,38 @@ ---- -sidebar_position: 11 ---- - -# Upload photo to server - Uploads photo to server for further use - - -*Function UploadPhotoToServer(Val Image, Val Parameters = "", Val View = "Post") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Image | --file | String, BinaryData | Image file | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - | View | --type | String | Upload type (Post, Product, Story, Poll, Other) | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint vk UploadPhotoToServer --file %file% --auth %auth% --type %type% - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 11 +--- + +# Upload photo to server + Uploads photo to server for further use + + +*Function UploadPhotoToServer(Val Image, Val Parameters = "", Val View = "Post") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Image | --file | String, BinaryData | Image file | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + | View | --type | String | Upload type (Post, Product, Story, Poll, Other) | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint vk UploadPhotoToServer --file %file% --auth %auth% --type %type% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/VK/Group-work/Upload-video-to-server.md b/docs/en/md/VK/Group-work/Upload-video-to-server.md index 5cc3b37167..debfcf8d68 100644 --- a/docs/en/md/VK/Group-work/Upload-video-to-server.md +++ b/docs/en/md/VK/Group-work/Upload-video-to-server.md @@ -1,40 +1,40 @@ ---- -sidebar_position: 10 ---- - -# Upload video to server - Uploads video to the group for further use - - -*Function UploadVideoToServer(Val Video, Val Name, Val Description = "", Val Album = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Video | --file | String, BinaryData | Video file | - | Name | --title | String | Video name | - | Description | --description | String | Video description | - | Album | --album | String | Album ID, if necessary | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint vk UploadVideoToServer --file %file% --title %title% --description %description% --album %album% --auth %auth% - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 10 +--- + +# Upload video to server + Uploads video to the group for further use + + +*Function UploadVideoToServer(Val Video, Val Name, Val Description = "", Val Album = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Video | --file | String, BinaryData | Video file | + | Name | --title | String | Video name | + | Description | --description | String | Video description | + | Album | --album | String | Album ID, if necessary | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint vk UploadVideoToServer --file %file% --title %title% --description %description% --album %album% --auth %auth% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/VK/Group-work/_category_.json b/docs/en/md/VK/Group-work/_category_.json index 24682c7318..7583749bb6 100644 --- a/docs/en/md/VK/Group-work/_category_.json +++ b/docs/en/md/VK/Group-work/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Group work", -"position": "3" -} +{ +"label": "Group work", +"position": "3" +} diff --git a/docs/en/md/VK/Interactive-actions/Like-post.md b/docs/en/md/VK/Interactive-actions/Like-post.md index dc9ea5919d..116c4c7e09 100644 --- a/docs/en/md/VK/Interactive-actions/Like-post.md +++ b/docs/en/md/VK/Interactive-actions/Like-post.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 1 ---- - -# Like - Likes a post - - -*Function LikePost(Val PostID, Val WallID = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.LikePost(221,,Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk LikePost --post %post% --wall %wall% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "likes": 1 - } - } - -``` +--- +sidebar_position: 1 +--- + +# Like + Likes a post + + +*Function LikePost(Val PostID, Val WallID = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.LikePost(221,,Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk LikePost --post %post% --wall %wall% --auth %auth% + + +``` + + +```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 index 5e81ecd5b2..b4efdf8ca2 100644 --- a/docs/en/md/VK/Interactive-actions/Make-repost.md +++ b/docs/en/md/VK/Interactive-actions/Make-repost.md @@ -1,58 +1,58 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.MakeRepost(2571, -218704372,,, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk MakeRepost --post %post% --from %from% --to %to% --ad %ad% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "mail_repost_count": 2, - "likes_count": 7, - "reposts_count": 3, - "post_id": 228, - "badges": { - "owner_id": -218704372, - "id": 2571, - "type": 11 - }, - "wall_repost_count": 1, - "success": 1 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.MakeRepost(2571, -218704372,,, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk MakeRepost --post %post% --from %from% --to %to% --ad %ad% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "mail_repost_count": 2, + "likes_count": 7, + "reposts_count": 3, + "post_id": 228, + "badges": { + "owner_id": -218704372, + "id": 2571, + "type": 11 + }, + "wall_repost_count": 1, + "success": 1 + } + } + +``` diff --git a/docs/en/md/VK/Interactive-actions/Shorten-link.md b/docs/en/md/VK/Interactive-actions/Shorten-link.md index e238ed1a54..2c9e5451f1 100644 --- a/docs/en/md/VK/Interactive-actions/Shorten-link.md +++ b/docs/en/md/VK/Interactive-actions/Shorten-link.md @@ -1,40 +1,40 @@ ---- -sidebar_position: 5 ---- - -# Shorten link - Creates a shortened URL from a regular one - - -*Function ShortenLink(Val URL, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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" - - - Response = OPI_VK.ShortenLink("https://github.com/Bayselonarrend/OpenIntegrations", Parameters); - - - -``` - -```sh title="CLI command example" - - oint vk ShortenLink --url %url% --auth %auth% - - -``` - - -```json title="Result" - -https://vk.cc/ctL1sM - -``` +--- +sidebar_position: 5 +--- + +# Shorten link + Creates a shortened URL from a regular one + + +*Function ShortenLink(Val URL, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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" + + + Response = OPI_VK.ShortenLink("https://github.com/Bayselonarrend/OpenIntegrations", Parameters); + + + +``` + +```sh title="CLI command example" + + oint vk ShortenLink --url %url% --auth %auth% + + +``` + + +```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 index 8311022bd2..6d0165fa7e 100644 --- a/docs/en/md/VK/Interactive-actions/Write-comment.md +++ b/docs/en/md/VK/Interactive-actions/Write-comment.md @@ -1,48 +1,48 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.WriteComment(221, -218861756, "Hello", Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk WriteComment --post %post% --wall %wall% --text %text% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "parents_stack": [], - "comment_id": 229 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.WriteComment(221, -218861756, "Hello", Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk WriteComment --post %post% --wall %wall% --text %text% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "parents_stack": [], + "comment_id": 229 + } + } + +``` diff --git a/docs/en/md/VK/Interactive-actions/Write-message.md b/docs/en/md/VK/Interactive-actions/Write-message.md index 06dec4220b..5df63568a7 100644 --- a/docs/en/md/VK/Interactive-actions/Write-message.md +++ b/docs/en/md/VK/Interactive-actions/Write-message.md @@ -1,48 +1,48 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb..."; - Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657811122, KТ,, Parameters); - - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk WriteMessage --text %text% --user %user% --ct %ct% --keyboard %keyboard% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 7 - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb..."; + Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657811122, KТ,, Parameters); + + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk WriteMessage --text %text% --user %user% --ct %ct% --keyboard %keyboard% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": 7 + } + +``` diff --git a/docs/en/md/VK/Interactive-actions/_category_.json b/docs/en/md/VK/Interactive-actions/_category_.json index 086de59c56..f3d01472ce 100644 --- a/docs/en/md/VK/Interactive-actions/_category_.json +++ b/docs/en/md/VK/Interactive-actions/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Interactive actions", -"position": "5" -} +{ +"label": "Interactive actions", +"position": "5" +} diff --git a/docs/en/md/VK/Order-management/Get-order-list.md b/docs/en/md/VK/Order-management/Get-order-list.md index 2752fb6fb0..821f992375 100644 --- a/docs/en/md/VK/Order-management/Get-order-list.md +++ b/docs/en/md/VK/Order-management/Get-order-list.md @@ -1,36 +1,36 @@ ---- -sidebar_position: 1 ---- - -# Get order list - Returns the community's order list - - -*Function GetOrderList(Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint vk GetOrderList --auth %auth% - - -``` - - -```json title="Result" - - - -``` +--- +sidebar_position: 1 +--- + +# Get order list + Returns the community's order list + + +*Function GetOrderList(Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint vk GetOrderList --auth %auth% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/VK/Order-management/_category_.json b/docs/en/md/VK/Order-management/_category_.json index 6fd1074a59..1b0c09c826 100644 --- a/docs/en/md/VK/Order-management/_category_.json +++ b/docs/en/md/VK/Order-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Order management", -"position": "11" -} +{ +"label": "Order management", +"position": "11" +} diff --git a/docs/en/md/VK/Others/Form-keyboard.md b/docs/en/md/VK/Others/Form-keyboard.md index 2002a96344..980d8f481c 100644 --- a/docs/en/md/VK/Others/Form-keyboard.md +++ b/docs/en/md/VK/Others/Form-keyboard.md @@ -1,65 +1,65 @@ ---- -sidebar_position: 1 ---- - -# Create keyboard - Forms a keyboard from an array of buttons - - -*Function FormKeyboard(Val ButtonArray) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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); - KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYC..."; - Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657846756, KТ, Keyboard, Parameters); - - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk FormKeyboard --buttons %buttons% - - -``` - - -```json title="Result" - -{ - "buttons": [ - [ - { - "action": { - "type": "text", - "label": "Button 1" - } - }, - { - "action": { - "type": "text", - "label": "Button 2" - } - } - ] - ], - "one_time": false - } - -``` +--- +sidebar_position: 1 +--- + +# Create keyboard + Forms a keyboard from an array of buttons + + +*Function FormKeyboard(Val ButtonArray) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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); + KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYC..."; + Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657846756, KТ, Keyboard, Parameters); + + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk FormKeyboard --buttons %buttons% + + +``` + + +```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/_category_.json b/docs/en/md/VK/Others/_category_.json index 341efb1c71..60bd30940f 100644 --- a/docs/en/md/VK/Others/_category_.json +++ b/docs/en/md/VK/Others/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Others", -"position": "12" -} +{ +"label": "Others", +"position": "12" +} diff --git a/docs/en/md/VK/Product-management/Add-product.md b/docs/en/md/VK/Product-management/Add-product.md index f1db2787f1..be8aa0724d 100644 --- a/docs/en/md/VK/Product-management/Add-product.md +++ b/docs/en/md/VK/Product-management/Add-product.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 4 ---- - -# Add product - Adds a new product to the community's catalog - - -*Function AddProduct(Val ProductDescription, Val Selection = "", Val Parameters = "") ExportReturn ProductManagement(ProductDescription,, Selection, Parameters);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | ProductDescription | --product | Key-Value Pair | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - ImageArray = New Array; - ImageArray.Add(Image); - ImageArray.Add(Image); - - Product = New Map(); - Product.Insert("Name", "TestProduct"); - Product.Insert("Description", "Product description"); - Product.Insert("Category", "20173"); - Product.Insert("Price", 1); - Product.Insert("OldPrice", 15); - Product.Insert("MainPhoto", Image); - Product.Insert("URL", "https://github.com/Bayselonarrend/OpenIntegrations"); - Product.Insert("AdditionalPhotos", ImageArray); - Product.Insert("MainInGroup", True); - Product.Insert("Width", 20); - Product.Insert("Height", 30); - Product.Insert("Depth", 40); - Product.Insert("Weight", 100); - Product.Insert("SKU", "12345"); - Product.Insert("AvailableBalance", "10"); - - Response = OPI_VK.AddProduct(Product, SelectionID, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk AddProduct --product %product% --sel %sel% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "market_item_id": 8656047 - } - } - -``` +--- +sidebar_position: 4 +--- + +# Add product + Adds a new product to the community's catalog + + +*Function AddProduct(Val ProductDescription, Val Selection = "", Val Parameters = "") ExportReturn ProductManagement(ProductDescription,, Selection, Parameters);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | ProductDescription | --product | Key-Value Pair | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + ImageArray = New Array; + ImageArray.Add(Image); + ImageArray.Add(Image); + + Product = New Map(); + Product.Insert("Name", "TestProduct"); + Product.Insert("Description", "Product description"); + Product.Insert("Category", "20173"); + Product.Insert("Price", 1); + Product.Insert("OldPrice", 15); + Product.Insert("MainPhoto", Image); + Product.Insert("URL", "https://github.com/Bayselonarrend/OpenIntegrations"); + Product.Insert("AdditionalPhotos", ImageArray); + Product.Insert("MainInGroup", True); + Product.Insert("Width", 20); + Product.Insert("Height", 30); + Product.Insert("Depth", 40); + Product.Insert("Weight", 100); + Product.Insert("SKU", "12345"); + Product.Insert("AvailableBalance", "10"); + + Response = OPI_VK.AddProduct(Product, SelectionID, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk AddProduct --product %product% --sel %sel% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "market_item_id": 8656047 + } + } + +``` diff --git a/docs/en/md/VK/Product-management/Delete-product.md b/docs/en/md/VK/Product-management/Delete-product.md index 1ea8e35d19..ea060078c9 100644 --- a/docs/en/md/VK/Product-management/Delete-product.md +++ b/docs/en/md/VK/Product-management/Delete-product.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 6 ---- - -# Delete product - Deletes a previously created product - - -*Function DeleteProduct(Val Product, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Product | --item | String, Number | Product ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.DeleteProduct(ProductID, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk DeleteProduct --item %item% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 6 +--- + +# Delete product + Deletes a previously created product + + +*Function DeleteProduct(Val Product, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Product | --item | String, Number | Product ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.DeleteProduct(ProductID, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk DeleteProduct --item %item% --auth %auth% + + +``` + + +```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 index 5a348a04d3..f578e41d47 100644 --- a/docs/en/md/VK/Product-management/Edit-product.md +++ b/docs/en/md/VK/Product-management/Edit-product.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 5 ---- - -# Edit product - Edits a previously created product - - -*Function EditProduct(Val Product, Val ProductDescription, Val Selection = "", Val Parameters = "") ExportReturn ProductManagement(ProductDescription, Product, Selection, Parameters);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Product | --item | Number, String | Identifier of the product being edited | - | ProductDescription | --product | Key-Value Pair | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Product = New Map; - Product.Insert("Name", "EditedTestProduct"); - - Response = OPI_VK.EditProduct(ProductID, Product,, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk EditProduct --item %item% --product %product% --sel %sel% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 5 +--- + +# Edit product + Edits a previously created product + + +*Function EditProduct(Val Product, Val ProductDescription, Val Selection = "", Val Parameters = "") ExportReturn ProductManagement(ProductDescription, Product, Selection, Parameters);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Product | --item | Number, String | Identifier of the product being edited | + | ProductDescription | --product | Key-Value Pair | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Product = New Map; + Product.Insert("Name", "EditedTestProduct"); + + Response = OPI_VK.EditProduct(ProductID, Product,, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk EditProduct --item %item% --product %product% --sel %sel% --auth %auth% + + +``` + + +```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 index 7c6b094167..ecbabfcaf0 100644 --- a/docs/en/md/VK/Product-management/Get-product-category-list.md +++ b/docs/en/md/VK/Product-management/Get-product-category-list.md @@ -1,44 +1,44 @@ ---- -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 | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Map Of String - Key - ID, Value - Name - -```bsl title="Code example" - - - Response = OPI_VK.GetProductCategoryList(Parameters); //Map - - - -``` - -```sh title="CLI command example" - - oint vk GetProductCategoryList --auth %auth% - - -``` - - -```json title="Result" - -Key Value - - 1210 "Business" - 1200 "Photo and video service" - 2162 "Repair and building" - ... - -``` +--- +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 | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Map Of String - Key - ID, Value - Name + +```bsl title="Code example" + + + Response = OPI_VK.GetProductCategoryList(Parameters); //Map + + + +``` + +```sh title="CLI command example" + + oint vk GetProductCategoryList --auth %auth% + + +``` + + +```json title="Result" + +Key Value + + 1210 "Business" + 1200 "Photo and video service" + 2162 "Repair and building" + ... + +``` diff --git a/docs/en/md/VK/Product-management/Get-product-description.md b/docs/en/md/VK/Product-management/Get-product-description.md index 932f197788..ae2a5dcb3b 100644 --- a/docs/en/md/VK/Product-management/Get-product-description.md +++ b/docs/en/md/VK/Product-management/Get-product-description.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 8 ---- - -# Get description product. - - - -*Function GetProductDescription() Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - - - Returns: Key-Value Pair - Empty product description: - - -```bsl title="Code example" - - - -``` - -```sh title="CLI command example" - - oint vk GetProductDescription - - -``` - - -```json title="Result" - -Product = New Map(); - Product.Insert("Name", "New product"); // Product name - Product.Insert("Description", "Product description"); // Product description - Product.Insert("Category", "20173"); // See GetProductCategoryList() - Product.Insert("Price", 1); // Price. - Product.Insert("OldPrice", Undefined); // For reflection change price - Product.Insert("MainPhoto", Undefined); // BD or path to main. photo - Product.Insert("URL", Undefined); // Link to page store - Product.Insert("AdditionalPhotos", New Array); // Array paths or BD for add. photo - Product.Insert("PropertyValues", New Array); // Values properties (variants). Maximum 2 - Product.Insert("MainInGroup", False); // Make main in of its group - Product.Insert("Width", Undefined); // In millimeters - Product.Insert("Height", Undefined); // In millimeters - Product.Insert("Depth", Undefined); // In millimeters - Product.Insert("Weight", Undefined); // In grams - Product.Insert("SKU", Undefined); // SKU - Product.Insert("AvailableBalance", 1); - -``` +--- +sidebar_position: 8 +--- + +# Get description product. + + + +*Function GetProductDescription() Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + + + Returns: Key-Value Pair - Empty product description: + + +```bsl title="Code example" + + + +``` + +```sh title="CLI command example" + + oint vk GetProductDescription + + +``` + + +```json title="Result" + +Product = New Map(); + Product.Insert("Name", "New product"); // Product name + Product.Insert("Description", "Product description"); // Product description + Product.Insert("Category", "20173"); // See GetProductCategoryList() + Product.Insert("Price", 1); // Price. + Product.Insert("OldPrice", Undefined); // For reflection change price + Product.Insert("MainPhoto", Undefined); // BD or path to main. photo + Product.Insert("URL", Undefined); // Link to page store + Product.Insert("AdditionalPhotos", New Array); // Array paths or BD for add. photo + Product.Insert("PropertyValues", New Array); // Values properties (variants). Maximum 2 + Product.Insert("MainInGroup", False); // Make main in of its group + Product.Insert("Width", Undefined); // In millimeters + Product.Insert("Height", Undefined); // In millimeters + Product.Insert("Depth", Undefined); // In millimeters + Product.Insert("Weight", Undefined); // In grams + Product.Insert("SKU", Undefined); // SKU + Product.Insert("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 index 000d250420..c41923ecbc 100644 --- a/docs/en/md/VK/Product-management/Get-product-list.md +++ b/docs/en/md/VK/Product-management/Get-product-list.md @@ -1,348 +1,348 @@ ---- -sidebar_position: 2 ---- - -# Get product list - Gets the community's product list - - -*Function GetProductList(Val Selection = "", Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Selection | --sel | String, Number | Selection ID, if filtering is needed | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Array of product matches - -```bsl title="Code example" - - - Response = OPI_VK.GetProductList(, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetProductList --sel %sel% --auth %auth% - - -``` - - -```json title="Result" - -[ - { - "sku": "12 345", - "is_main_variant": true, - "is_owner": true, - "date": 1708079311, - "can_show_convert_to_service": true, - "can_delete": true, - "views_count": 1, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=a4094440c3769389eefbbb6f63fb3b06&c_uniq_tag=wg_JEvsvTTjzR-t_GyVXH_8VjxbraezNWRHCn7b6mBQ", - "likes": { - "user_likes": 0, - "count": 0 - }, - "can_recover": false, - "can_repost": 1, - "reject_info": { - "buttons": [ - { - "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653408&type=market", - "type": "market_edit" - }, - { - "type": "market_delete" - } - ], - "in_progress": false, - "description": "Test item description", - "moderation_status": 2, - "title": "" - }, - "photos": [ - { - "has_tags": false, - "web_view_token": "8aafd75b91f2cf1425", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=75x75&quality=95&sign=8799f9f279ce65bf9ac62a5724971675&c_uniq_tag=RBTqNLzMstWYqH3UP-8FEDlMyg31ogY38n3XLQ-lOCE&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=604x604&quality=95&sign=5dc945bfe9e7f79888d73004eae343eb&c_uniq_tag=V4KYZPU3iIF3RVCqYXXq8g8p0Trd2jQRKnY7AFlKDe8&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=807x807&quality=95&sign=d278b813303eb31bdb730e51ef8f6b6d&c_uniq_tag=aFbbqQ4bPqGp5BMBy917bpLCshpOoZjf5YA89T9UCec&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=1024x1024&quality=95&sign=f8881fbbded9f8840ee4b02c4c6cb879&c_uniq_tag=tHRje1Xf1jctFzjuO4X4aJBAAYxJ1_rK5JKFNIx17N8&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=200x200&quality=95&sign=cd430561bb7b2746fb6eb6fe75360ec6&c_uniq_tag=vApE_jC2x9G_pE2o_Sa0VbdXZbhyYpJ6stb7bWAnP-4&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=320x320&quality=95&sign=8e1438dda0f54fb11756668e2fee6c1a&c_uniq_tag=Vn2w0zG8YDCc0KftpKmikpLL3YyydcLrGgcqB3wKi2s&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=510x510&quality=95&sign=e91c847e2415d0ee15512c123421c276&c_uniq_tag=ZWDwoheiysNResAKNuM2WxUUsip8_r6MfNbvtGkh73Y&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "c9794503a593bd9cec", - "user_id": 100, - "owner_id": -218861756, - "id": 457239678, - "date": 1708079308, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "624c0066d8978afcac", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=75x75&quality=95&sign=2d38b31b4c3e10582b0679289e30e9b7&c_uniq_tag=NHINy4_e18wRuW7wSk8qdZAyddbb6UvEYe3tCKVzy1c&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=604x604&quality=95&sign=ff313c468d0b77929619430847063235&c_uniq_tag=babY_J2d40AbSOscXypcBkEgicxrrDxlYD74ZDTjIJA&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=807x807&quality=95&sign=5ed25ec65ddf75807a40592fa3a57b85&c_uniq_tag=QXMQTItlMkDqUZvYOS36ygz-eqDElNch6kznQpHNtUs&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=1024x1024&quality=95&sign=43a67fdc1397e5eb5c5c87c9dcc64a16&c_uniq_tag=b7XxwzUXLkL9jIg7PjcUdEGQJUMcnn_D6ZwTWaBwXkQ&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=200x200&quality=95&sign=87d8cd030f6312d3e914895882a0fd1f&c_uniq_tag=5s7vPvuFFNHVaieG0xd_Izcw3WnuOR2mRRlDZtw8zJU&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=320x320&quality=95&sign=37a2a53a35d6a2c1451e5ccd524b878c&c_uniq_tag=BX5IGPc0xpKDoYtTPlHGSbIoucM1H2-cpOg_7VQGgAs&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=510x510&quality=95&sign=925dbfb3a9b9b85d328880f9342cc7d8&c_uniq_tag=JGGgvPjVHXrx7PgK3FVuk9X1KNeg5skBMMNeSN9fg4s&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "266753958e3c5635cb", - "user_id": 100, - "owner_id": -218861756, - "id": 457239679, - "date": 1708079309, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "4d22638dbca11b42dc", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=75x75&quality=95&sign=b5c353c838e289bf4dfe012e93c8d96f&c_uniq_tag=M99VG2d-cv9h8UPexKNwfDIpFp59CFVbZ5B8ksQLr4I&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=604x604&quality=95&sign=0a958b351a1d2301159c30e4e57f3fd3&c_uniq_tag=02RQFt-o1HuSw8GYCWY_a7STB4ua28_zFb7a4CD5BO8&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=807x807&quality=95&sign=18fd0f4c4d1097074cc761211e5904c7&c_uniq_tag=HS0b1Fur_f2LFs3_NHY8kCaJyQrv11_I6wjaeMYcmA8&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=1024x1024&quality=95&sign=6f59f9c6c1bb8ee0458c9d970a95eb37&c_uniq_tag=9N6uQC5vMHptVulrxwY6a_uJIx3ND4Q65klbzMDGguE&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=200x200&quality=95&sign=80a6e97e3262ccc6ff80e30d609b39c8&c_uniq_tag=5fZY8t9mBrikvu-J0q4JkrOg0wHERphSEGIfscG2_t0&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=320x320&quality=95&sign=4bff4c938faaab606aeb85451951a175&c_uniq_tag=-mFXyFqoRGG2T0uDx1ZKZiMrU7vCzIUuzN56k1Xrd7o&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=510x510&quality=95&sign=bcefcff03c4cd3f6ca30f41f6e6f19df&c_uniq_tag=1BHfm_IEucSBPtWGWR-xDhdJ8w5L_tw0Tf3iTj8UixU&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "78ed3a6ff11c40a07c", - "user_id": 100, - "owner_id": -218861756, - "id": 457239680, - "date": 1708079310, - "album_id": -53 - } - ], - "cart_quantity": 0, - "albums_ids": [ - 9 - ], - "weight": 100, - "dimensions": { - "length": 40, - "height": 30, - "width": 20 - }, - "title": "EditedTestProduct", - "other_items": [ - { - "item_ids": [ - "-218861756_8655960", - "-218861756_8655800", - "-218861756_8655797", - "-218861756_8653766", - "-218861756_8653760", - "-218861756_8653404", - "-218861756_8653395", - "-218861756_8653393", - "-218861756_8653391", - "-218861756_8653387" - ], - "referrer_item_type": "other_goods", - "view_type": 1, - "title": "Other items" - } - ], - "reposts": { - "count": 0 - }, - "price": { - "old_amount_text": "15 ₽", - "old_amount": "1500", - "discount_rate": -93, - "text": "1 ₽", - "currency": { - "title": "₽", - "name": "RUB", - "id": 643 - }, - "amount": "100" - }, - "can_edit": true, - "owner_id": -218861756, - "can_comment": 1, - "is_adult": false, - "id": 8653408, - "description": "Product description", - "owner_info": { - "market_type": "pro", - "category": "TestCollection", - "is_corporated_market": false, - "name": "Test", - "category_url": "/market-218861756?section=album_9", - "avatar": [] - }, - "category": { - "section": { - "name": "Stationery", - "id": 10016 - }, - "name": "Batteries", - "id": 20173, - "inner_type": "market_market_category_old" - }, - "promotion": { - "is_available": false - }, - "availability": 0 - } - ] - -``` +--- +sidebar_position: 2 +--- + +# Get product list + Gets the community's product list + + +*Function GetProductList(Val Selection = "", Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Selection | --sel | String, Number | Selection ID, if filtering is needed | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Array of product matches + +```bsl title="Code example" + + + Response = OPI_VK.GetProductList(, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetProductList --sel %sel% --auth %auth% + + +``` + + +```json title="Result" + +[ + { + "sku": "12 345", + "is_main_variant": true, + "is_owner": true, + "date": 1708079311, + "can_show_convert_to_service": true, + "can_delete": true, + "views_count": 1, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=a4094440c3769389eefbbb6f63fb3b06&c_uniq_tag=wg_JEvsvTTjzR-t_GyVXH_8VjxbraezNWRHCn7b6mBQ", + "likes": { + "user_likes": 0, + "count": 0 + }, + "can_recover": false, + "can_repost": 1, + "reject_info": { + "buttons": [ + { + "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653408&type=market", + "type": "market_edit" + }, + { + "type": "market_delete" + } + ], + "in_progress": false, + "description": "Test item description", + "moderation_status": 2, + "title": "" + }, + "photos": [ + { + "has_tags": false, + "web_view_token": "8aafd75b91f2cf1425", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=75x75&quality=95&sign=8799f9f279ce65bf9ac62a5724971675&c_uniq_tag=RBTqNLzMstWYqH3UP-8FEDlMyg31ogY38n3XLQ-lOCE&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=604x604&quality=95&sign=5dc945bfe9e7f79888d73004eae343eb&c_uniq_tag=V4KYZPU3iIF3RVCqYXXq8g8p0Trd2jQRKnY7AFlKDe8&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=807x807&quality=95&sign=d278b813303eb31bdb730e51ef8f6b6d&c_uniq_tag=aFbbqQ4bPqGp5BMBy917bpLCshpOoZjf5YA89T9UCec&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=1024x1024&quality=95&sign=f8881fbbded9f8840ee4b02c4c6cb879&c_uniq_tag=tHRje1Xf1jctFzjuO4X4aJBAAYxJ1_rK5JKFNIx17N8&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=200x200&quality=95&sign=cd430561bb7b2746fb6eb6fe75360ec6&c_uniq_tag=vApE_jC2x9G_pE2o_Sa0VbdXZbhyYpJ6stb7bWAnP-4&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=320x320&quality=95&sign=8e1438dda0f54fb11756668e2fee6c1a&c_uniq_tag=Vn2w0zG8YDCc0KftpKmikpLL3YyydcLrGgcqB3wKi2s&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=510x510&quality=95&sign=e91c847e2415d0ee15512c123421c276&c_uniq_tag=ZWDwoheiysNResAKNuM2WxUUsip8_r6MfNbvtGkh73Y&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "c9794503a593bd9cec", + "user_id": 100, + "owner_id": -218861756, + "id": 457239678, + "date": 1708079308, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "624c0066d8978afcac", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=75x75&quality=95&sign=2d38b31b4c3e10582b0679289e30e9b7&c_uniq_tag=NHINy4_e18wRuW7wSk8qdZAyddbb6UvEYe3tCKVzy1c&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=604x604&quality=95&sign=ff313c468d0b77929619430847063235&c_uniq_tag=babY_J2d40AbSOscXypcBkEgicxrrDxlYD74ZDTjIJA&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=807x807&quality=95&sign=5ed25ec65ddf75807a40592fa3a57b85&c_uniq_tag=QXMQTItlMkDqUZvYOS36ygz-eqDElNch6kznQpHNtUs&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=1024x1024&quality=95&sign=43a67fdc1397e5eb5c5c87c9dcc64a16&c_uniq_tag=b7XxwzUXLkL9jIg7PjcUdEGQJUMcnn_D6ZwTWaBwXkQ&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=200x200&quality=95&sign=87d8cd030f6312d3e914895882a0fd1f&c_uniq_tag=5s7vPvuFFNHVaieG0xd_Izcw3WnuOR2mRRlDZtw8zJU&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=320x320&quality=95&sign=37a2a53a35d6a2c1451e5ccd524b878c&c_uniq_tag=BX5IGPc0xpKDoYtTPlHGSbIoucM1H2-cpOg_7VQGgAs&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=510x510&quality=95&sign=925dbfb3a9b9b85d328880f9342cc7d8&c_uniq_tag=JGGgvPjVHXrx7PgK3FVuk9X1KNeg5skBMMNeSN9fg4s&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "266753958e3c5635cb", + "user_id": 100, + "owner_id": -218861756, + "id": 457239679, + "date": 1708079309, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "4d22638dbca11b42dc", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=75x75&quality=95&sign=b5c353c838e289bf4dfe012e93c8d96f&c_uniq_tag=M99VG2d-cv9h8UPexKNwfDIpFp59CFVbZ5B8ksQLr4I&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=604x604&quality=95&sign=0a958b351a1d2301159c30e4e57f3fd3&c_uniq_tag=02RQFt-o1HuSw8GYCWY_a7STB4ua28_zFb7a4CD5BO8&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=807x807&quality=95&sign=18fd0f4c4d1097074cc761211e5904c7&c_uniq_tag=HS0b1Fur_f2LFs3_NHY8kCaJyQrv11_I6wjaeMYcmA8&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=1024x1024&quality=95&sign=6f59f9c6c1bb8ee0458c9d970a95eb37&c_uniq_tag=9N6uQC5vMHptVulrxwY6a_uJIx3ND4Q65klbzMDGguE&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=200x200&quality=95&sign=80a6e97e3262ccc6ff80e30d609b39c8&c_uniq_tag=5fZY8t9mBrikvu-J0q4JkrOg0wHERphSEGIfscG2_t0&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=320x320&quality=95&sign=4bff4c938faaab606aeb85451951a175&c_uniq_tag=-mFXyFqoRGG2T0uDx1ZKZiMrU7vCzIUuzN56k1Xrd7o&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=510x510&quality=95&sign=bcefcff03c4cd3f6ca30f41f6e6f19df&c_uniq_tag=1BHfm_IEucSBPtWGWR-xDhdJ8w5L_tw0Tf3iTj8UixU&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "78ed3a6ff11c40a07c", + "user_id": 100, + "owner_id": -218861756, + "id": 457239680, + "date": 1708079310, + "album_id": -53 + } + ], + "cart_quantity": 0, + "albums_ids": [ + 9 + ], + "weight": 100, + "dimensions": { + "length": 40, + "height": 30, + "width": 20 + }, + "title": "EditedTestProduct", + "other_items": [ + { + "item_ids": [ + "-218861756_8655960", + "-218861756_8655800", + "-218861756_8655797", + "-218861756_8653766", + "-218861756_8653760", + "-218861756_8653404", + "-218861756_8653395", + "-218861756_8653393", + "-218861756_8653391", + "-218861756_8653387" + ], + "referrer_item_type": "other_goods", + "view_type": 1, + "title": "Other items" + } + ], + "reposts": { + "count": 0 + }, + "price": { + "old_amount_text": "15 ₽", + "old_amount": "1500", + "discount_rate": -93, + "text": "1 ₽", + "currency": { + "title": "₽", + "name": "RUB", + "id": 643 + }, + "amount": "100" + }, + "can_edit": true, + "owner_id": -218861756, + "can_comment": 1, + "is_adult": false, + "id": 8653408, + "description": "Product description", + "owner_info": { + "market_type": "pro", + "category": "TestCollection", + "is_corporated_market": false, + "name": "Test", + "category_url": "/market-218861756?section=album_9", + "avatar": [] + }, + "category": { + "section": { + "name": "Stationery", + "id": 10016 + }, + "name": "Batteries", + "id": 20173, + "inner_type": "market_market_category_old" + }, + "promotion": { + "is_available": false + }, + "availability": 0 + } + ] + +``` 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 index f36d49209f..93cd8ef368 100644 --- a/docs/en/md/VK/Product-management/Get-products-by-id.md +++ b/docs/en/md/VK/Product-management/Get-products-by-id.md @@ -1,713 +1,713 @@ ---- -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 | Destination | - |-|-|-|-| - | Products | --items | String, Array of String | Array of product IDs | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - ProductsArray = New Array; - ProductsArray.Add("8656033"); - ProductsArray.Add("8656034"); - - Response = OPI_VK.GetProductsByID(ProductsArray, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetProductsByID --items %items% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "items": [ - { - "sku": "12 345", - "is_main_variant": true, - "is_owner": true, - "date": 1708170274, - "can_show_convert_to_service": true, - "can_delete": true, - "properties": [ - { - "variants": [ - { - "title": "Yellow (change.)", - "id": 971 - }, - { - "title": "Blue (change.)", - "id": 972 - }, - { - "title": "Red (change.)", - "id": 973 - } - ], - "type": "text", - "title": "Color (change.)", - "id": 258 - } - ], - "views_count": 0, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=589be01d2fc8e371862518142ccb7462&c_uniq_tag=3UKP-MAlxuqYtgy6jOhFLiWDMayz_V8bqjCYnh35JhM", - "likes": { - "user_likes": 0, - "count": 0 - }, - "can_repost": 1, - "can_recover": false, - "photos": [ - { - "has_tags": false, - "web_view_token": "92862d343958147ed4", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=75x75&quality=95&sign=75b8b9ecc41139c3c1b0d17bbf6e0c32&c_uniq_tag=FXd5BlAEmMnIGfUpqwLUWhaJwb8irsAIJ4-lUHfbZ_E&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=604x604&quality=95&sign=8d173aac7ac1259e516a6d926ce80544&c_uniq_tag=ap7TLKtgI6zBnvGjJaFp_zROOKQiBg6NENjMCk1ZdBc&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=807x807&quality=95&sign=d7536ec7a9f84e511f21182dea67a70a&c_uniq_tag=VIIaPDSt68vRlOqCymz9grEM5RQG1Ocx0wyevX4xb6Q&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=1024x1024&quality=95&sign=106d75b1819f1976d40d66200db9ef8c&c_uniq_tag=Bo7Hk6h0bNaaYET9k36N25VbSyysB6r2RT_66bUW_hs&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=200x200&quality=95&sign=8b70ea4984f97979ce995dd37bcf3133&c_uniq_tag=Y4CfVHj6Hih0lhp8txhKpNhaVSgQnjr7WlH_B01N1EU&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=320x320&quality=95&sign=0a5c91e112ef0c02425bdbf27f2a65a1&c_uniq_tag=V9Q3PNtkF8XD02aYEbvcbny0jrGZ5LUTaanYB5ulArI&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=510x510&quality=95&sign=45b47460e1a4dce2692355265114f996&c_uniq_tag=IuTEvNe-qW6JGpt4guLe2R3vH4l4899EaWrr77ZtQlk&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "66dc21beb4d43f2a3c", - "user_id": 100, - "owner_id": -218861756, - "id": 457239799, - "date": 1708170270, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "a6344b5c5e566b3d0f", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=75x75&quality=95&sign=008ec0a154820e532df70a27551bed4f&c_uniq_tag=V6vBDJlnnQSlWj7dtWCH_i1oXJgW_m1q47Dtgiip_Es&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=604x604&quality=95&sign=458343fa9344319daced2b0996e5ee74&c_uniq_tag=ausjWwNUoPL003iQ4jKsFx_46Hf-lpCcaAOrGXV82cQ&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=807x807&quality=95&sign=487b910daf99d58f09bb84e7f4955e12&c_uniq_tag=pGkpJrVh8zKvIdRG74G9NuXamkrHe25ybGMfmcVGKfk&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=1024x1024&quality=95&sign=db36ba2bdc5176946b44c9d7bddc173b&c_uniq_tag=LupvbVz1DM9ZHGGCd2GWH8rVcanmneNhRvzt_keB_r0&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=200x200&quality=95&sign=92b5fbc6456d64a450f2798d0f4b2907&c_uniq_tag=wilVvQyyONq1VsFP42UIlM6DnUetObxgjPwEOU87bcI&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=320x320&quality=95&sign=6fb75856a87c217c4e033c17ef340c70&c_uniq_tag=gGcnPnWWjfd5zD7qQMhZdDV_BjGWb3vk_p4Q0mXIFlo&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=510x510&quality=95&sign=9f4deabcdf7a1e52128a1cc08b3f51ba&c_uniq_tag=cX_tQwscXoWRbH4WF-rq7EFmr8Sddv_P4JQ7rEzF9Ws&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "306f176545bea47727", - "user_id": 100, - "owner_id": -218861756, - "id": 457239800, - "date": 1708170272, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "0f912989fe5cda4777", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=75x75&quality=95&sign=68afdefe830d4be39b04ba23a61c26ce&c_uniq_tag=Xc5-AjRx8tqr0Zo5pMZ4jIGFgD1YoRU1La4aDMIQEC4&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=604x604&quality=95&sign=79f669caf7b26acfdeed6715c85fe9ed&c_uniq_tag=17W-VKiO2S8SrmCSItPAoWq5PKqcQhHggCVD3jAf6B0&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=807x807&quality=95&sign=3bc1e4917a25c52fb37a821f7c83bf85&c_uniq_tag=P1wmEHLW5WNZhBYfsoKFdKFFWGoVj89Y7v6JmqpcumE&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=1024x1024&quality=95&sign=f7f1d87da40cc7070770d2a2f45f557b&c_uniq_tag=XZ-FwW1W54vlkhc3jVRdBI2xEQ53BSLTyKVPl3RGAXU&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=200x200&quality=95&sign=3e7d2483ff4d3a889cc38eea4727d471&c_uniq_tag=xQQVVr-_nJ8Vxha5_EpmDfTxow2rZM516lXgezq74p8&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=320x320&quality=95&sign=f118def9cbea6e5e4eeb8e33a9d0c0b3&c_uniq_tag=1TTdudzMdBLTi3Jo7BZGXK16S_fIMBxE2zvlYDVrPmc&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=510x510&quality=95&sign=f78d1f8e32dd8d7826749d236165afaf&c_uniq_tag=JwqjdnieaCRm_wk4q3GmzwSiuYuS6Xz0QTjN_ncx7rM&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "fbd338a4c3be88ff3c", - "user_id": 100, - "owner_id": -218861756, - "id": 457239801, - "date": 1708170273, - "album_id": -53 - } - ], - "cart_quantity": 0, - "albums_ids": [], - "weight": 100, - "dimensions": { - "length": 40, - "height": 30, - "width": 20 - }, - "title": "TestProduct (Yellow)", - "other_items": [ - { - "item_ids": [ - "-218861756_8656034", - "-218861756_8655800", - "-218861756_8655797", - "-218861756_8653766", - "-218861756_8653760", - "-218861756_8653408", - "-218861756_8653404", - "-218861756_8653395", - "-218861756_8653393", - "-218861756_8653391" - ], - "referrer_item_type": "other_goods", - "view_type": 1, - "title": "Other items" - } - ], - "reposts": { - "count": 0 - }, - "price": { - "old_amount_text": "15 ₽", - "old_amount": "1500", - "discount_rate": -93, - "text": "1 ₽", - "currency": { - "title": "₽", - "name": "RUB", - "id": 643 - }, - "amount": "100" - }, - "can_edit": true, - "can_comment": 1, - "owner_id": -218861756, - "is_adult": false, - "id": 8656033, - "variants_grid": [ - { - "variants": [ - { - "is_selected": true, - "item_id": 8656033, - "name": "Yellow (change.)", - "variant_id": 971 - } - ], - "type": "text", - "name": "Color (change.)" - } - ], - "description": "Product description", - "owner_info": { - "market_type": "pro", - "category": "Batteries", - "is_corporated_market": false, - "name": "Test", - "category_url": "/market-218861756", - "avatar": [] - }, - "property_values": [ - { - "property_name": "Color (change.)", - "variant_name": "Yellow (change.)", - "variant_id": 971 - } - ], - "category": { - "section": { - "name": "Stationery", - "id": 10016 - }, - "name": "Batteries", - "id": 20173, - "inner_type": "market_market_category_old" - }, - "availability": 0, - "promotion": { - "is_available": true - } - }, - { - "sku": "12 345", - "is_main_variant": true, - "is_owner": true, - "date": 1708170288, - "can_show_convert_to_service": true, - "can_delete": true, - "properties": [ - { - "variants": [ - { - "title": "Yellow (change.)", - "id": 971 - }, - { - "title": "Blue (change.)", - "id": 972 - }, - { - "title": "Red (change.)", - "id": 973 - } - ], - "type": "text", - "title": "Color (change.)", - "id": 258 - } - ], - "views_count": 0, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6fe8502b6de244ccb70eebb1ff4ab23a&c_uniq_tag=Juovt6U5F84vc8uZw_2u5ejCgNGxNqYse3fKfIORYsA", - "likes": { - "user_likes": 0, - "count": 0 - }, - "can_repost": 1, - "can_recover": false, - "photos": [ - { - "has_tags": false, - "web_view_token": "93d071511c9e966e9a", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=75x75&quality=95&sign=dfe0b24adf5f3705cf02a1702f45036b&c_uniq_tag=EQgp0KDeFcPWq8dm6l05egD_z2uHaN-DT8Cr5dQQkBo&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=604x604&quality=95&sign=779f24d1abc0fe24a4a424b7a57bb093&c_uniq_tag=QNmQQTT76Mhu8Oinz-5qrMzwVVwKmJFABeTE9bd-M04&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=807x807&quality=95&sign=68cf71539a9242931d48a0cd0be1a0ce&c_uniq_tag=MQO9LYERwp1e6tS9OJYz-YeyEAoWa4yTD6CX3C_FUzA&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=1024x1024&quality=95&sign=b609734c59b0229115c911fc20f3df2d&c_uniq_tag=bdm1GIOMPi0B6oy29CZnJYw23shE3eghtMSsCI8JYGg&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=200x200&quality=95&sign=c64e879b106ab293043bb60563312cb6&c_uniq_tag=3vfMLZacvzwhJSWS51xEo0DHeRFy6KS_TLPN0xEQWBY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=320x320&quality=95&sign=59810b1b5192658255ab539a40149880&c_uniq_tag=-MpQ7yEq8wm5U6P-GJWHqfOSq6xA8l3czg2ggwlSNnQ&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=510x510&quality=95&sign=36ab4a9f54e0a96f4ea92302e855894d&c_uniq_tag=tHaCIm_9DjSqiDUDZUBe_tjn7zOH5oZfwwpWXYRx_70&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "10037480cb2af9af0d", - "user_id": 100, - "owner_id": -218861756, - "id": 457239802, - "date": 1708170285, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "d1181c5d59752488a2", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=75x75&quality=95&sign=d5cfeb6f122274ca04226d23818c2436&c_uniq_tag=g_yta3-5oqlvRCBKknktnRsJ7lnlP2VnnxLk9cfxkHg&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=604x604&quality=95&sign=3aafaad6b865a4326ebb066c7dd96ffc&c_uniq_tag=ZD3QYn27B-77k_Ky6EvfTkQpWRvvdquZgKq4aWhPc0M&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=807x807&quality=95&sign=9d3a2122bca8a751fdddc22af862740f&c_uniq_tag=OQVkuFFazrrA-5LmkWDdTdsrC6YzHpvFlMjXZNcKa8A&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=1024x1024&quality=95&sign=f00777c18a9e2a8690abec2518459c85&c_uniq_tag=oa7b3R9OPg0LGnMZwVd5tkmRQtFZ97uuCkmOdIPgxNQ&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=200x200&quality=95&sign=19663322aa62b505f4204c27d75304cd&c_uniq_tag=ZIEbwDmIZR-vEFRWjmw-Qp_PSX7EacMIEG9PF7GpBEs&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=320x320&quality=95&sign=454278ef305df41f60bbd66588e235da&c_uniq_tag=ZJhu-b2l8_3WCJlFirFZQxoVgtsaLK65yW0mvx8J08A&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=510x510&quality=95&sign=8de646064ff8be8c896b90dc2f773722&c_uniq_tag=VpnbvqL0oDTt2ZKV-irlb2RpQv229T-EHaeIyVS5Vpc&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "f3a1fb96168aea29f8", - "user_id": 100, - "owner_id": -218861756, - "id": 457239803, - "date": 1708170287, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "81fb7553b335d5b014", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=75x75&quality=95&sign=6ecdc8b90775ddf376b0b8188dbffe92&c_uniq_tag=swVsbxdS4C74XKjml3-ZfJyK2APAKb5zukLSREgvgPA&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=604x604&quality=95&sign=e15ba3df9b63bd7c793cd9fb12a08539&c_uniq_tag=i7wKGLU0jk2qPnzhl4ah1EuupPe7-XeFPRs8krcbzr4&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=807x807&quality=95&sign=6ce24dc60c88b14dd50f72b157ecb68d&c_uniq_tag=4GU58hsK_GvHsoc9_SzqN2EdgRu8arCCOqIqJ8TxErI&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=1024x1024&quality=95&sign=93706c2f263ea67b93a17dcb0c1a03d9&c_uniq_tag=w8oS3d2yXrNChsDA1g5jcyJmihuegLAmiNUkIwTEcfI&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=200x200&quality=95&sign=bd9d8e4629660da0502be09ecbf30c0c&c_uniq_tag=SH9RVt_MXCjYWtCw68wDIz7ILMHO3QMF4t8GWvtA7qY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=320x320&quality=95&sign=513e44d6745d2dcf3134e0518584841d&c_uniq_tag=60HVud6C_z47D5l2delWwgf0ghIvEaFfvA5s1_MoPWE&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=510x510&quality=95&sign=13e3f25a80b3c8e332bd8f9d0abde28c&c_uniq_tag=TTjqylVQf7Wgu03X6HCu1TqVTy07G11FecGeXsiZUbk&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "4aa836406d898be665", - "user_id": 100, - "owner_id": -218861756, - "id": 457239804, - "date": 1708170288, - "album_id": -53 - } - ], - "cart_quantity": 0, - "albums_ids": [], - "weight": 100, - "dimensions": { - "length": 40, - "height": 30, - "width": 20 - }, - "title": "TestProduct (Red)", - "other_items": [ - { - "item_ids": [ - "-218861756_8656033", - "-218861756_8655800", - "-218861756_8655797", - "-218861756_8653766", - "-218861756_8653760", - "-218861756_8653408", - "-218861756_8653404", - "-218861756_8653395", - "-218861756_8653393", - "-218861756_8653391" - ], - "referrer_item_type": "other_goods", - "view_type": 1, - "title": "Other items" - } - ], - "reposts": { - "count": 0 - }, - "price": { - "old_amount_text": "15 ₽", - "old_amount": "1500", - "discount_rate": -93, - "text": "1 ₽", - "currency": { - "title": "₽", - "name": "RUB", - "id": 643 - }, - "amount": "100" - }, - "can_edit": true, - "can_comment": 1, - "owner_id": -218861756, - "is_adult": false, - "id": 8656034, - "variants_grid": [ - { - "variants": [ - { - "is_selected": true, - "item_id": 8656034, - "name": "Red (change.)", - "variant_id": 973 - } - ], - "type": "text", - "name": "Color (change.)" - } - ], - "description": "Product description", - "owner_info": { - "market_type": "pro", - "category": "Batteries", - "is_corporated_market": false, - "name": "Test", - "category_url": "/market-218861756", - "avatar": [] - }, - "property_values": [ - { - "property_name": "Color (change.)", - "variant_name": "Red (change.)", - "variant_id": 973 - } - ], - "category": { - "section": { - "name": "Stationery", - "id": 10016 - }, - "name": "Batteries", - "id": 20173, - "inner_type": "market_market_category_old" - }, - "availability": 0, - "promotion": { - "is_available": true - } - } - ], - "count": 2 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Products | --items | String, Array of String | Array of product IDs | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + ProductsArray = New Array; + ProductsArray.Add("8656033"); + ProductsArray.Add("8656034"); + + Response = OPI_VK.GetProductsByID(ProductsArray, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetProductsByID --items %items% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "items": [ + { + "sku": "12 345", + "is_main_variant": true, + "is_owner": true, + "date": 1708170274, + "can_show_convert_to_service": true, + "can_delete": true, + "properties": [ + { + "variants": [ + { + "title": "Yellow (change.)", + "id": 971 + }, + { + "title": "Blue (change.)", + "id": 972 + }, + { + "title": "Red (change.)", + "id": 973 + } + ], + "type": "text", + "title": "Color (change.)", + "id": 258 + } + ], + "views_count": 0, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=589be01d2fc8e371862518142ccb7462&c_uniq_tag=3UKP-MAlxuqYtgy6jOhFLiWDMayz_V8bqjCYnh35JhM", + "likes": { + "user_likes": 0, + "count": 0 + }, + "can_repost": 1, + "can_recover": false, + "photos": [ + { + "has_tags": false, + "web_view_token": "92862d343958147ed4", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=75x75&quality=95&sign=75b8b9ecc41139c3c1b0d17bbf6e0c32&c_uniq_tag=FXd5BlAEmMnIGfUpqwLUWhaJwb8irsAIJ4-lUHfbZ_E&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=604x604&quality=95&sign=8d173aac7ac1259e516a6d926ce80544&c_uniq_tag=ap7TLKtgI6zBnvGjJaFp_zROOKQiBg6NENjMCk1ZdBc&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=807x807&quality=95&sign=d7536ec7a9f84e511f21182dea67a70a&c_uniq_tag=VIIaPDSt68vRlOqCymz9grEM5RQG1Ocx0wyevX4xb6Q&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=1024x1024&quality=95&sign=106d75b1819f1976d40d66200db9ef8c&c_uniq_tag=Bo7Hk6h0bNaaYET9k36N25VbSyysB6r2RT_66bUW_hs&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=200x200&quality=95&sign=8b70ea4984f97979ce995dd37bcf3133&c_uniq_tag=Y4CfVHj6Hih0lhp8txhKpNhaVSgQnjr7WlH_B01N1EU&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=320x320&quality=95&sign=0a5c91e112ef0c02425bdbf27f2a65a1&c_uniq_tag=V9Q3PNtkF8XD02aYEbvcbny0jrGZ5LUTaanYB5ulArI&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=510x510&quality=95&sign=45b47460e1a4dce2692355265114f996&c_uniq_tag=IuTEvNe-qW6JGpt4guLe2R3vH4l4899EaWrr77ZtQlk&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "66dc21beb4d43f2a3c", + "user_id": 100, + "owner_id": -218861756, + "id": 457239799, + "date": 1708170270, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "a6344b5c5e566b3d0f", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=75x75&quality=95&sign=008ec0a154820e532df70a27551bed4f&c_uniq_tag=V6vBDJlnnQSlWj7dtWCH_i1oXJgW_m1q47Dtgiip_Es&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=604x604&quality=95&sign=458343fa9344319daced2b0996e5ee74&c_uniq_tag=ausjWwNUoPL003iQ4jKsFx_46Hf-lpCcaAOrGXV82cQ&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=807x807&quality=95&sign=487b910daf99d58f09bb84e7f4955e12&c_uniq_tag=pGkpJrVh8zKvIdRG74G9NuXamkrHe25ybGMfmcVGKfk&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=1024x1024&quality=95&sign=db36ba2bdc5176946b44c9d7bddc173b&c_uniq_tag=LupvbVz1DM9ZHGGCd2GWH8rVcanmneNhRvzt_keB_r0&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=200x200&quality=95&sign=92b5fbc6456d64a450f2798d0f4b2907&c_uniq_tag=wilVvQyyONq1VsFP42UIlM6DnUetObxgjPwEOU87bcI&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=320x320&quality=95&sign=6fb75856a87c217c4e033c17ef340c70&c_uniq_tag=gGcnPnWWjfd5zD7qQMhZdDV_BjGWb3vk_p4Q0mXIFlo&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=510x510&quality=95&sign=9f4deabcdf7a1e52128a1cc08b3f51ba&c_uniq_tag=cX_tQwscXoWRbH4WF-rq7EFmr8Sddv_P4JQ7rEzF9Ws&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "306f176545bea47727", + "user_id": 100, + "owner_id": -218861756, + "id": 457239800, + "date": 1708170272, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "0f912989fe5cda4777", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=75x75&quality=95&sign=68afdefe830d4be39b04ba23a61c26ce&c_uniq_tag=Xc5-AjRx8tqr0Zo5pMZ4jIGFgD1YoRU1La4aDMIQEC4&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=604x604&quality=95&sign=79f669caf7b26acfdeed6715c85fe9ed&c_uniq_tag=17W-VKiO2S8SrmCSItPAoWq5PKqcQhHggCVD3jAf6B0&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=807x807&quality=95&sign=3bc1e4917a25c52fb37a821f7c83bf85&c_uniq_tag=P1wmEHLW5WNZhBYfsoKFdKFFWGoVj89Y7v6JmqpcumE&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=1024x1024&quality=95&sign=f7f1d87da40cc7070770d2a2f45f557b&c_uniq_tag=XZ-FwW1W54vlkhc3jVRdBI2xEQ53BSLTyKVPl3RGAXU&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=200x200&quality=95&sign=3e7d2483ff4d3a889cc38eea4727d471&c_uniq_tag=xQQVVr-_nJ8Vxha5_EpmDfTxow2rZM516lXgezq74p8&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=320x320&quality=95&sign=f118def9cbea6e5e4eeb8e33a9d0c0b3&c_uniq_tag=1TTdudzMdBLTi3Jo7BZGXK16S_fIMBxE2zvlYDVrPmc&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=510x510&quality=95&sign=f78d1f8e32dd8d7826749d236165afaf&c_uniq_tag=JwqjdnieaCRm_wk4q3GmzwSiuYuS6Xz0QTjN_ncx7rM&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "fbd338a4c3be88ff3c", + "user_id": 100, + "owner_id": -218861756, + "id": 457239801, + "date": 1708170273, + "album_id": -53 + } + ], + "cart_quantity": 0, + "albums_ids": [], + "weight": 100, + "dimensions": { + "length": 40, + "height": 30, + "width": 20 + }, + "title": "TestProduct (Yellow)", + "other_items": [ + { + "item_ids": [ + "-218861756_8656034", + "-218861756_8655800", + "-218861756_8655797", + "-218861756_8653766", + "-218861756_8653760", + "-218861756_8653408", + "-218861756_8653404", + "-218861756_8653395", + "-218861756_8653393", + "-218861756_8653391" + ], + "referrer_item_type": "other_goods", + "view_type": 1, + "title": "Other items" + } + ], + "reposts": { + "count": 0 + }, + "price": { + "old_amount_text": "15 ₽", + "old_amount": "1500", + "discount_rate": -93, + "text": "1 ₽", + "currency": { + "title": "₽", + "name": "RUB", + "id": 643 + }, + "amount": "100" + }, + "can_edit": true, + "can_comment": 1, + "owner_id": -218861756, + "is_adult": false, + "id": 8656033, + "variants_grid": [ + { + "variants": [ + { + "is_selected": true, + "item_id": 8656033, + "name": "Yellow (change.)", + "variant_id": 971 + } + ], + "type": "text", + "name": "Color (change.)" + } + ], + "description": "Product description", + "owner_info": { + "market_type": "pro", + "category": "Batteries", + "is_corporated_market": false, + "name": "Test", + "category_url": "/market-218861756", + "avatar": [] + }, + "property_values": [ + { + "property_name": "Color (change.)", + "variant_name": "Yellow (change.)", + "variant_id": 971 + } + ], + "category": { + "section": { + "name": "Stationery", + "id": 10016 + }, + "name": "Batteries", + "id": 20173, + "inner_type": "market_market_category_old" + }, + "availability": 0, + "promotion": { + "is_available": true + } + }, + { + "sku": "12 345", + "is_main_variant": true, + "is_owner": true, + "date": 1708170288, + "can_show_convert_to_service": true, + "can_delete": true, + "properties": [ + { + "variants": [ + { + "title": "Yellow (change.)", + "id": 971 + }, + { + "title": "Blue (change.)", + "id": 972 + }, + { + "title": "Red (change.)", + "id": 973 + } + ], + "type": "text", + "title": "Color (change.)", + "id": 258 + } + ], + "views_count": 0, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6fe8502b6de244ccb70eebb1ff4ab23a&c_uniq_tag=Juovt6U5F84vc8uZw_2u5ejCgNGxNqYse3fKfIORYsA", + "likes": { + "user_likes": 0, + "count": 0 + }, + "can_repost": 1, + "can_recover": false, + "photos": [ + { + "has_tags": false, + "web_view_token": "93d071511c9e966e9a", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=75x75&quality=95&sign=dfe0b24adf5f3705cf02a1702f45036b&c_uniq_tag=EQgp0KDeFcPWq8dm6l05egD_z2uHaN-DT8Cr5dQQkBo&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=604x604&quality=95&sign=779f24d1abc0fe24a4a424b7a57bb093&c_uniq_tag=QNmQQTT76Mhu8Oinz-5qrMzwVVwKmJFABeTE9bd-M04&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=807x807&quality=95&sign=68cf71539a9242931d48a0cd0be1a0ce&c_uniq_tag=MQO9LYERwp1e6tS9OJYz-YeyEAoWa4yTD6CX3C_FUzA&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=1024x1024&quality=95&sign=b609734c59b0229115c911fc20f3df2d&c_uniq_tag=bdm1GIOMPi0B6oy29CZnJYw23shE3eghtMSsCI8JYGg&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=200x200&quality=95&sign=c64e879b106ab293043bb60563312cb6&c_uniq_tag=3vfMLZacvzwhJSWS51xEo0DHeRFy6KS_TLPN0xEQWBY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=320x320&quality=95&sign=59810b1b5192658255ab539a40149880&c_uniq_tag=-MpQ7yEq8wm5U6P-GJWHqfOSq6xA8l3czg2ggwlSNnQ&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=510x510&quality=95&sign=36ab4a9f54e0a96f4ea92302e855894d&c_uniq_tag=tHaCIm_9DjSqiDUDZUBe_tjn7zOH5oZfwwpWXYRx_70&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "10037480cb2af9af0d", + "user_id": 100, + "owner_id": -218861756, + "id": 457239802, + "date": 1708170285, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "d1181c5d59752488a2", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=75x75&quality=95&sign=d5cfeb6f122274ca04226d23818c2436&c_uniq_tag=g_yta3-5oqlvRCBKknktnRsJ7lnlP2VnnxLk9cfxkHg&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=604x604&quality=95&sign=3aafaad6b865a4326ebb066c7dd96ffc&c_uniq_tag=ZD3QYn27B-77k_Ky6EvfTkQpWRvvdquZgKq4aWhPc0M&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=807x807&quality=95&sign=9d3a2122bca8a751fdddc22af862740f&c_uniq_tag=OQVkuFFazrrA-5LmkWDdTdsrC6YzHpvFlMjXZNcKa8A&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=1024x1024&quality=95&sign=f00777c18a9e2a8690abec2518459c85&c_uniq_tag=oa7b3R9OPg0LGnMZwVd5tkmRQtFZ97uuCkmOdIPgxNQ&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=200x200&quality=95&sign=19663322aa62b505f4204c27d75304cd&c_uniq_tag=ZIEbwDmIZR-vEFRWjmw-Qp_PSX7EacMIEG9PF7GpBEs&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=320x320&quality=95&sign=454278ef305df41f60bbd66588e235da&c_uniq_tag=ZJhu-b2l8_3WCJlFirFZQxoVgtsaLK65yW0mvx8J08A&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=510x510&quality=95&sign=8de646064ff8be8c896b90dc2f773722&c_uniq_tag=VpnbvqL0oDTt2ZKV-irlb2RpQv229T-EHaeIyVS5Vpc&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "f3a1fb96168aea29f8", + "user_id": 100, + "owner_id": -218861756, + "id": 457239803, + "date": 1708170287, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "81fb7553b335d5b014", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=75x75&quality=95&sign=6ecdc8b90775ddf376b0b8188dbffe92&c_uniq_tag=swVsbxdS4C74XKjml3-ZfJyK2APAKb5zukLSREgvgPA&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=604x604&quality=95&sign=e15ba3df9b63bd7c793cd9fb12a08539&c_uniq_tag=i7wKGLU0jk2qPnzhl4ah1EuupPe7-XeFPRs8krcbzr4&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=807x807&quality=95&sign=6ce24dc60c88b14dd50f72b157ecb68d&c_uniq_tag=4GU58hsK_GvHsoc9_SzqN2EdgRu8arCCOqIqJ8TxErI&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=1024x1024&quality=95&sign=93706c2f263ea67b93a17dcb0c1a03d9&c_uniq_tag=w8oS3d2yXrNChsDA1g5jcyJmihuegLAmiNUkIwTEcfI&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=200x200&quality=95&sign=bd9d8e4629660da0502be09ecbf30c0c&c_uniq_tag=SH9RVt_MXCjYWtCw68wDIz7ILMHO3QMF4t8GWvtA7qY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=320x320&quality=95&sign=513e44d6745d2dcf3134e0518584841d&c_uniq_tag=60HVud6C_z47D5l2delWwgf0ghIvEaFfvA5s1_MoPWE&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=510x510&quality=95&sign=13e3f25a80b3c8e332bd8f9d0abde28c&c_uniq_tag=TTjqylVQf7Wgu03X6HCu1TqVTy07G11FecGeXsiZUbk&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "4aa836406d898be665", + "user_id": 100, + "owner_id": -218861756, + "id": 457239804, + "date": 1708170288, + "album_id": -53 + } + ], + "cart_quantity": 0, + "albums_ids": [], + "weight": 100, + "dimensions": { + "length": 40, + "height": 30, + "width": 20 + }, + "title": "TestProduct (Red)", + "other_items": [ + { + "item_ids": [ + "-218861756_8656033", + "-218861756_8655800", + "-218861756_8655797", + "-218861756_8653766", + "-218861756_8653760", + "-218861756_8653408", + "-218861756_8653404", + "-218861756_8653395", + "-218861756_8653393", + "-218861756_8653391" + ], + "referrer_item_type": "other_goods", + "view_type": 1, + "title": "Other items" + } + ], + "reposts": { + "count": 0 + }, + "price": { + "old_amount_text": "15 ₽", + "old_amount": "1500", + "discount_rate": -93, + "text": "1 ₽", + "currency": { + "title": "₽", + "name": "RUB", + "id": 643 + }, + "amount": "100" + }, + "can_edit": true, + "can_comment": 1, + "owner_id": -218861756, + "is_adult": false, + "id": 8656034, + "variants_grid": [ + { + "variants": [ + { + "is_selected": true, + "item_id": 8656034, + "name": "Red (change.)", + "variant_id": 973 + } + ], + "type": "text", + "name": "Color (change.)" + } + ], + "description": "Product description", + "owner_info": { + "market_type": "pro", + "category": "Batteries", + "is_corporated_market": false, + "name": "Test", + "category_url": "/market-218861756", + "avatar": [] + }, + "property_values": [ + { + "property_name": "Color (change.)", + "variant_name": "Red (change.)", + "variant_id": 973 + } + ], + "category": { + "section": { + "name": "Stationery", + "id": 10016 + }, + "name": "Batteries", + "id": 20173, + "inner_type": "market_market_category_old" + }, + "availability": 0, + "promotion": { + "is_available": true + } + } + ], + "count": 2 + } + } + +``` diff --git a/docs/en/md/VK/Product-management/Group-products.md b/docs/en/md/VK/Product-management/Group-products.md index 3c7307e304..47d49b0654 100644 --- a/docs/en/md/VK/Product-management/Group-products.md +++ b/docs/en/md/VK/Product-management/Group-products.md @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - ProductsArray = New Array; - ProductsArray.Add(YellowItemID); - ProductsArray.Add(RedItemID); - - Response = OPI_VK.GroupProducts(ProductsArray,, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GroupProducts --items %items% --sellgroup %sellgroup% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "item_group_id": 5957 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + ProductsArray = New Array; + ProductsArray.Add(YellowItemID); + ProductsArray.Add(RedItemID); + + Response = OPI_VK.GroupProducts(ProductsArray,, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GroupProducts --items %items% --sellgroup %sellgroup% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "item_group_id": 5957 + } + } + +``` diff --git a/docs/en/md/VK/Product-management/_category_.json b/docs/en/md/VK/Product-management/_category_.json index 3834e7dee5..7c0b2c1c5a 100644 --- a/docs/en/md/VK/Product-management/_category_.json +++ b/docs/en/md/VK/Product-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Product management", -"position": "8" -} +{ +"label": "Product management", +"position": "8" +} 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 index 8b87b88230..18f36b8f57 100644 --- 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 @@ -1,46 +1,46 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.AddProductPropertyVariant("Red", 260, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk AddProductPropertyVariant --value %value% --prop %prop% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "variant_id": 980 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.AddProductPropertyVariant("Red", 260, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk AddProductPropertyVariant --value %value% --prop %prop% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "variant_id": 980 + } + } + +``` 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 index 06ee21a8eb..32fe737e00 100644 --- a/docs/en/md/VK/Product-properties-management/Create-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Create-product-property.md @@ -1,45 +1,45 @@ ---- -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 | Destination | - |-|-|-|-| - | Name | --title | String | Property name | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.CreateProductProperty("Color", Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk CreateProductProperty --title %title% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "property_id": 260 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Name | --title | String | Property name | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.CreateProductProperty("Color", Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk CreateProductProperty --title %title% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "property_id": 260 + } + } + +``` 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 index 9d2e823a29..ea567d820c 100644 --- 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 @@ -1,43 +1,43 @@ ---- -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 | Destination | - |-|-|-|-| - | Option | --option | String, Number | Variant ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.DeleteProductPropertyVariant(980 Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk DeleteProductPropertyVariant --option %option% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Option | --option | String, Number | Variant ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.DeleteProductPropertyVariant(980 Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk DeleteProductPropertyVariant --option %option% --auth %auth% + + +``` + + +```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 index 2dddc77cd4..229bfbf596 100644 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 4 ---- - -# Delete product property - Deletes the existing product property - - -*Function DeleteProductProperty(Val Property, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Property | --prop | String, Number | Property ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.DeleteProductProperty(260, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk DeleteProductProperty --prop %prop% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 4 +--- + +# Delete product property + Deletes the existing product property + + +*Function DeleteProductProperty(Val Property, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Property | --prop | String, Number | Property ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.DeleteProductProperty(260, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk DeleteProductProperty --prop %prop% --auth %auth% + + +``` + + +```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 index 1dffad09e3..21dc6db0b4 100644 --- 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 @@ -1,45 +1,45 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.EditProductPropertyVariant("Yellow", 260, 980 Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk EditProductPropertyVariant --value %value% --prop %prop% --option %option% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.EditProductPropertyVariant("Yellow", 260, 980 Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk EditProductPropertyVariant --value %value% --prop %prop% --option %option% --auth %auth% + + +``` + + +```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 index 49bccb269c..571f995d32 100644 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 3 ---- - -# Edit product property - Edits the existing product property - - -*Function EditProductProperty(Val Name, Val Property, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | New name | - | Property | --prop | String, Number | Property ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.EditProductProperty("Color (change.)", Property, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk EditProductProperty --title %title% --prop %prop% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 3 +--- + +# Edit product property + Edits the existing product property + + +*Function EditProductProperty(Val Name, Val Property, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | New name | + | Property | --prop | String, Number | Property ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.EditProductProperty("Color (change.)", Property, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk EditProductProperty --title %title% --prop %prop% --auth %auth% + + +``` + + +```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 index 58b04f75bc..908e45b9ff 100644 --- a/docs/en/md/VK/Product-properties-management/Get-property-list.md +++ b/docs/en/md/VK/Product-properties-management/Get-property-list.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 1 ---- - -# Get property list - Gets the list of properties of group products - - -*Function GetPropertyList(Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.GetPropertyList(Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetPropertyList --auth %auth% - - -``` - - -```json title="Result" - -[ - { - "variants": [ - { - "title": "Yellow", - "id": 962 - }, - { - "title": "Blue", - "id": 963 - }, - { - "title": "Red", - "id": 964 - } - ], - "type": "text", - "title": "Color", - "id": 255 - } - ] - -``` +--- +sidebar_position: 1 +--- + +# Get property list + Gets the list of properties of group products + + +*Function GetPropertyList(Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.GetPropertyList(Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetPropertyList --auth %auth% + + +``` + + +```json title="Result" + +[ + { + "variants": [ + { + "title": "Yellow", + "id": 962 + }, + { + "title": "Blue", + "id": 963 + }, + { + "title": "Red", + "id": 964 + } + ], + "type": "text", + "title": "Color", + "id": 255 + } + ] + +``` diff --git a/docs/en/md/VK/Product-properties-management/_category_.json b/docs/en/md/VK/Product-properties-management/_category_.json index b8d19917a4..dd9682aed9 100644 --- a/docs/en/md/VK/Product-properties-management/_category_.json +++ b/docs/en/md/VK/Product-properties-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Product properties management", -"position": "10" -} +{ +"label": "Product properties management", +"position": "10" +} diff --git a/docs/en/md/VK/Product-selection-management/Add-product-to-selection.md b/docs/en/md/VK/Product-selection-management/Add-product-to-selection.md index a3567b1c40..8e70eaecf8 100644 --- a/docs/en/md/VK/Product-selection-management/Add-product-to-selection.md +++ b/docs/en/md/VK/Product-selection-management/Add-product-to-selection.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 5 ---- - -# Add product to selection - Adds a product to the selection - - -*Function AddProductToSelection(Val ProductsArray, Val Selection, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | ProductsArray | --items | Array of string, number | Array of products or product | - | Selection | --sel | String | Selection ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.AddProductToSelection(8656559, 40, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk AddProductToSelection --items %items% --sel %sel% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 5 +--- + +# Add product to selection + Adds a product to the selection + + +*Function AddProductToSelection(Val ProductsArray, Val Selection, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | ProductsArray | --items | Array of string, number | Array of products or product | + | Selection | --sel | String | Selection ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.AddProductToSelection(8656559, 40, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk AddProductToSelection --items %items% --sel %sel% --auth %auth% + + +``` + + +```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 index 6626c52c18..5f661edf07 100644 --- a/docs/en/md/VK/Product-selection-management/Create-product-collection.md +++ b/docs/en/md/VK/Product-selection-management/Create-product-collection.md @@ -1,54 +1,54 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.CreateProductCollection("TestCollection" -, Image -, True -, False -, Parameters); - - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk CreateProductCollection --title %title% --picture %picture% --main %main% --hidden %hidden% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": { - "albums_count": 23, - "market_album_id": 39 - } - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.CreateProductCollection("TestCollection" +, Image +, True +, False +, Parameters); + + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk CreateProductCollection --title %title% --picture %picture% --main %main% --hidden %hidden% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": { + "albums_count": 23, + "market_album_id": 39 + } + } + +``` diff --git a/docs/en/md/VK/Product-selection-management/Delete-selection.md b/docs/en/md/VK/Product-selection-management/Delete-selection.md index da691effcd..99ed1dd567 100644 --- a/docs/en/md/VK/Product-selection-management/Delete-selection.md +++ b/docs/en/md/VK/Product-selection-management/Delete-selection.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 7 ---- - -# DeleteSelection - Deletes the selection by ID - - -*Function DeleteSelection(Val Selection, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Selection | --sel | String | Selection ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.DeleteSelection(40, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk DeleteSelection --sel %sel% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 7 +--- + +# DeleteSelection + Deletes the selection by ID + + +*Function DeleteSelection(Val Selection, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Selection | --sel | String | Selection ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.DeleteSelection(40, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk DeleteSelection --sel %sel% --auth %auth% + + +``` + + +```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 index a5a55ad9ee..4e47c7ba88 100644 --- a/docs/en/md/VK/Product-selection-management/Edit-product-collection.md +++ b/docs/en/md/VK/Product-selection-management/Edit-product-collection.md @@ -1,53 +1,53 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.EditProductCollection("EditedCollection" -, 40 -, Image -, True -, False -, Parameters); - - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk EditProductCollection --title %title% --sel %sel% --picture %picture% --main %main% --hidden %hidden% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.EditProductCollection("EditedCollection" +, 40 +, Image +, True +, False +, Parameters); + + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk EditProductCollection --title %title% --sel %sel% --picture %picture% --main %main% --hidden %hidden% --auth %auth% + + +``` + + +```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 index bf4393f574..e039232929 100644 --- a/docs/en/md/VK/Product-selection-management/Get-selection-list.md +++ b/docs/en/md/VK/Product-selection-management/Get-selection-list.md @@ -1,116 +1,116 @@ ---- -sidebar_position: 1 ---- - -# Get selection list - Gets the list of product selections - - -*Function GetSelectionList(Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Array of selection matches - -```bsl title="Code example" - - - Response = OPI_VK.GetSelectionList(Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetSelectionList --auth %auth% - - -``` - - -```json title="Result" - -[ - { - "is_hidden": false, - "is_main": true, - "photo": { - "has_tags": false, - "web_view_token": "6e66fabe30412b7a20", - "text": "", - "sizes": [ - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "user_id": 100, - "owner_id": -218861756, - "id": 457239823, - "date": 1708173749, - "album_id": -53 - }, - "count": 0, - "title": "TestCollection", - "updated_time": 1708173749, - "owner_id": -218861756, - "id": 38 - } - ] - -``` +--- +sidebar_position: 1 +--- + +# Get selection list + Gets the list of product selections + + +*Function GetSelectionList(Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Array of selection matches + +```bsl title="Code example" + + + Response = OPI_VK.GetSelectionList(Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetSelectionList --auth %auth% + + +``` + + +```json title="Result" + +[ + { + "is_hidden": false, + "is_main": true, + "photo": { + "has_tags": false, + "web_view_token": "6e66fabe30412b7a20", + "text": "", + "sizes": [ + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "user_id": 100, + "owner_id": -218861756, + "id": 457239823, + "date": 1708173749, + "album_id": -53 + }, + "count": 0, + "title": "TestCollection", + "updated_time": 1708173749, + "owner_id": -218861756, + "id": 38 + } + ] + +``` 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 index f9a0dbec62..b1f619343b 100644 --- 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 @@ -1,117 +1,117 @@ ---- -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 | Destination | - |-|-|-|-| - | Selections | --sels | String, Array of String | Selection IDs | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.GetSelectionsByID(Selections, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetSelectionsByID --sels %sels% --auth %auth% - - -``` - - -```json title="Result" - -[ - { - "is_hidden": false, - "is_main": true, - "photo": { - "has_tags": false, - "web_view_token": "6e66fabe30412b7a20", - "text": "", - "sizes": [ - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "user_id": 100, - "owner_id": -218861756, - "id": 457239823, - "date": 1708173749, - "album_id": -53 - }, - "count": 0, - "title": "TestCollection", - "updated_time": 1708173749, - "owner_id": -218861756, - "id": 38 - } - ] - -``` +--- +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 | Destination | + |-|-|-|-| + | Selections | --sels | String, Array of String | Selection IDs | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.GetSelectionsByID(Selections, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetSelectionsByID --sels %sels% --auth %auth% + + +``` + + +```json title="Result" + +[ + { + "is_hidden": false, + "is_main": true, + "photo": { + "has_tags": false, + "web_view_token": "6e66fabe30412b7a20", + "text": "", + "sizes": [ + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "user_id": 100, + "owner_id": -218861756, + "id": 457239823, + "date": 1708173749, + "album_id": -53 + }, + "count": 0, + "title": "TestCollection", + "updated_time": 1708173749, + "owner_id": -218861756, + "id": 38 + } + ] + +``` 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 index b85083c3ba..54ec744bb4 100644 --- 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 @@ -1,44 +1,44 @@ ---- -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 | Destination | - |-|-|-|-| - | Product | --item | String | Product ID | - | Selection | --sel | String | Selection ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.RemoveProductFromSelection(8656559, 40, Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk RemoveProductFromSelection --item %item% --sel %sel% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": 1 - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Product | --item | String | Product ID | + | Selection | --sel | String | Selection ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.RemoveProductFromSelection(8656559, 40, Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk RemoveProductFromSelection --item %item% --sel %sel% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": 1 + } + +``` diff --git a/docs/en/md/VK/Product-selection-management/_category_.json b/docs/en/md/VK/Product-selection-management/_category_.json index 5fc1a25b13..238e2936ee 100644 --- a/docs/en/md/VK/Product-selection-management/_category_.json +++ b/docs/en/md/VK/Product-selection-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Product selection management", -"position": "9" -} +{ +"label": "Product selection management", +"position": "9" +} diff --git a/docs/en/md/VK/Statistics/Get-post-statistics.md b/docs/en/md/VK/Statistics/Get-post-statistics.md index 68e0c91905..2f8f015b2e 100644 --- a/docs/en/md/VK/Statistics/Get-post-statistics.md +++ b/docs/en/md/VK/Statistics/Get-post-statistics.md @@ -1,90 +1,90 @@ ---- -sidebar_position: 2 ---- - -# Get post statistics - Gets statistics in terms of posts - - -*Function GetPostStatistics(Val PostIDsArray, Val Parameters = "") Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | 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" - - - ArrayOfPosts = New Array; - ArrayOfPosts.Add(214); - ArrayOfPosts.Add(215); - - Response = OPI_VK.GetPostStatistics(ArrayOfPosts, VK_Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetPostStatistics --posts %posts% --auth %auth% - - -``` - - -```json title="Result" - -[ - { - "ad_report": 0, - "ad_coverage": 0, - "ad_to_group": 0, - "ad_unsubscribe": 0, - "ad_hide": 0, - "ad_join_group": 0, - "ad_subscribers": 0, - "ad_links": 0, - "ad_views": 0, - "reach_viral": 0, - "reach_total": 1, - "reach_ads": 0, - "report": 0, - "join_group": 0, - "links": 0, - "unsubscribe": 0, - "hide": 0, - "reach_subscribers": 1, - "to_group": 1, - "post_id": 214 - }, - { - "ad_report": 0, - "ad_coverage": 0, - "ad_to_group": 0, - "ad_unsubscribe": 0, - "ad_hide": 0, - "ad_join_group": 0, - "ad_subscribers": 0, - "ad_links": 0, - "ad_views": 0, - "reach_viral": 0, - "reach_total": 1, - "reach_ads": 0, - "report": 0, - "join_group": 0, - "links": 0, - "unsubscribe": 0, - "hide": 0, - "reach_subscribers": 1, - "to_group": 0, - "post_id": 215 - } - ] - -``` +--- +sidebar_position: 2 +--- + +# Get post statistics + Gets statistics in terms of posts + + +*Function GetPostStatistics(Val PostIDsArray, Val Parameters = "") Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | 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" + + + ArrayOfPosts = New Array; + ArrayOfPosts.Add(214); + ArrayOfPosts.Add(215); + + Response = OPI_VK.GetPostStatistics(ArrayOfPosts, VK_Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetPostStatistics --posts %posts% --auth %auth% + + +``` + + +```json title="Result" + +[ + { + "ad_report": 0, + "ad_coverage": 0, + "ad_to_group": 0, + "ad_unsubscribe": 0, + "ad_hide": 0, + "ad_join_group": 0, + "ad_subscribers": 0, + "ad_links": 0, + "ad_views": 0, + "reach_viral": 0, + "reach_total": 1, + "reach_ads": 0, + "report": 0, + "join_group": 0, + "links": 0, + "unsubscribe": 0, + "hide": 0, + "reach_subscribers": 1, + "to_group": 1, + "post_id": 214 + }, + { + "ad_report": 0, + "ad_coverage": 0, + "ad_to_group": 0, + "ad_unsubscribe": 0, + "ad_hide": 0, + "ad_join_group": 0, + "ad_subscribers": 0, + "ad_links": 0, + "ad_views": 0, + "reach_viral": 0, + "reach_total": 1, + "reach_ads": 0, + "report": 0, + "join_group": 0, + "links": 0, + "unsubscribe": 0, + "hide": 0, + "reach_subscribers": 1, + "to_group": 0, + "post_id": 215 + } + ] + +``` diff --git a/docs/en/md/VK/Statistics/Get-statistics.md b/docs/en/md/VK/Statistics/Get-statistics.md index 9af845632a..1acefed9ef 100644 --- a/docs/en/md/VK/Statistics/Get-statistics.md +++ b/docs/en/md/VK/Statistics/Get-statistics.md @@ -1,549 +1,549 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - Serialized JSON response from VK - -```bsl title="Code example" - - - Response = OPI_VK.GetStatistics(CurrentSessionDate() - 60 * 60 * 24, CurrentSessionDate(), Parameters); - Response = OPI_Tools.JSONString(Response); - - - -``` - -```sh title="CLI command example" - - oint vk GetStatistics --datefrom %datefrom% --dateto %dateto% --auth %auth% - - -``` - - -```json title="Result" - -{ - "response": [ - { - "visitors": { - "views": 8, - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "mobile_views": 0, - "countries": [ - { - "value": 3, - "name": "Belarus", - "count": 1, - "code": "BY" - } - ], - "visitors": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "reach": { - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "reach": 1, - "mobile_reach": 0, - "countries": [ - { - "value": 3, - "name": "Belarus", - "count": 1, - "code": "BY" - } - ], - "reach_subscribers": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "period_to": 1704671999, - "period_from": 1704585600 - }, - { - "visitors": { - "views": 3, - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "mobile_views": 0, - "countries": [ - { - "value": 3, - "name": "Belarus", - "count": 1, - "code": "BY" - } - ], - "visitors": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "reach": { - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "reach": 1, - "mobile_reach": 0, - "countries": [ - { - "value": 3, - "name": "Belarus", - "count": 1, - "code": "BY" - } - ], - "reach_subscribers": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "period_to": 1704585599, - "period_from": 1704499200 - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - Serialized JSON response from VK + +```bsl title="Code example" + + + Response = OPI_VK.GetStatistics(CurrentSessionDate() - 60 * 60 * 24, CurrentSessionDate(), Parameters); + Response = OPI_Tools.JSONString(Response); + + + +``` + +```sh title="CLI command example" + + oint vk GetStatistics --datefrom %datefrom% --dateto %dateto% --auth %auth% + + +``` + + +```json title="Result" + +{ + "response": [ + { + "visitors": { + "views": 8, + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "mobile_views": 0, + "countries": [ + { + "value": 3, + "name": "Belarus", + "count": 1, + "code": "BY" + } + ], + "visitors": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "reach": { + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "reach": 1, + "mobile_reach": 0, + "countries": [ + { + "value": 3, + "name": "Belarus", + "count": 1, + "code": "BY" + } + ], + "reach_subscribers": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "period_to": 1704671999, + "period_from": 1704585600 + }, + { + "visitors": { + "views": 3, + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "mobile_views": 0, + "countries": [ + { + "value": 3, + "name": "Belarus", + "count": 1, + "code": "BY" + } + ], + "visitors": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "reach": { + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "reach": 1, + "mobile_reach": 0, + "countries": [ + { + "value": 3, + "name": "Belarus", + "count": 1, + "code": "BY" + } + ], + "reach_subscribers": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "period_to": 1704585599, + "period_from": 1704499200 + } + ] + } + +``` diff --git a/docs/en/md/VK/Statistics/_category_.json b/docs/en/md/VK/Statistics/_category_.json index c9c215a39e..56c040c7bb 100644 --- a/docs/en/md/VK/Statistics/_category_.json +++ b/docs/en/md/VK/Statistics/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Statistics", -"position": "6" -} +{ +"label": "Statistics", +"position": "6" +} 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 index 59c4b8db3c..9bab30d8f4 100644 --- a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md @@ -1,38 +1,38 @@ ---- -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 | Destination | - |-|-|-|-| - | 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); - - -``` - -```sh title="CLI command example" - - oint vk CreateTokenRetrievalLink --app %app% - - -``` - - -```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" - -``` +--- +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 | Destination | + |-|-|-|-| + | 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); + + +``` + +```sh title="CLI command example" + + oint vk CreateTokenRetrievalLink --app %app% + + +``` + + +```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/_category_.json b/docs/en/md/VK/Token-retrieval/_category_.json index fb8ce91b62..a7961b0965 100644 --- a/docs/en/md/VK/Token-retrieval/_category_.json +++ b/docs/en/md/VK/Token-retrieval/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Token retrieval", -"position": "2" -} +{ +"label": "Token retrieval", +"position": "2" +} diff --git a/docs/en/md/VK/VK.md b/docs/en/md/VK/VK.md index 500c64c4e4..257cccf7c3 100644 --- a/docs/en/md/VK/VK.md +++ b/docs/en/md/VK/VK.md @@ -1,94 +1,94 @@ ---- -id: VK -sidebar_class_name: VK ---- - - - -# VKontakte - -Этот раздел поwithinящен библиотеtoе for work with VK API. Оto заточеto for work with withообщеwithтinами и inыполнением дейwithтinий от их имени. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -For of start work необходимо получить неtoоторые параметры for VK API. - -

-Перечень необходимых data in inиде withтруtoтуры withодержитwithя in фунtoции *GetStandardParameters()*. Inы можете уtoазыinать зtoчения parameters прямо in ней or же передаinать их withтруtoтурой при inызоinе любых других methodоin libraries in toачеwithтinе необязательного параметра *Parameters* (afterдний inо all methodх бorотеtoи). In afterднем withлучае withтандартные параметры будут перезапиwithаны по toлючам теми, toоторые переданы при inызоinе method. Перезапиwithаны будут тольtoо withоinпадающие по toлючам Data. If toаtoой то параметр еwithть in toборе withтандартных, но не был передан при inызоinе method, то он withохранит withтандартное value. -

- - ```bsl - _Parameters = New Structure; - - _Parameters.Insert("v", "5.131"); - _Parameters.Insert("from_group", "1"); - _Parameters.Insert("group_id", "123456789"); - _Parameters.Insert("owner_id", "-123456789"); - _Parameters.Insert("app_id", "87654321"); - _Parameters.Insert("access_token", "vk1.a.E-byuFeG1qcN7..."); - - ``` - -Раwithwithмотрим получение each зtoчения: - -**1. v** - - Parameter v озtoчает inерwithию VK API. Testing проinодилоwithь to 5.131, реtoомендуетwithя его таtoим и оwithтаinить - -**2. from_group** - - От лица группы. Должен be 1 - -**3. group_id и owner_id** - - ID группы. If у inаwith withтандартный адреwith группы, то id можно toйти in URL. In протиinном withлучае он will to intoладtoе "Упраinление" in group, под полем Address. owner_id - тоже withамое, но withо зtotoом '-' inпереди - - ![BF](../../static/img/Docs/VK/1.png) - -**4. app_id** - - app_id - ID приложения. For withоздания приложения необходимо: - - * Goto по адреwithу https://id.vk.com/about/business/go, аinторfromоinатьwithя и ininеwithти withinои Data фfrom. or юр. лица - - ![BF](../../static/img/Docs/VK/2.png) - - * Ininеwithти name приложения и inыбрать пунtoт **Web** - - ![BF](../../static/img/Docs/VK/3.png) - - * Ininеwithти домееное имя и URL обработчиtoа переtoпраinлений. Тут нужно отметить, что данный механchange withоздания приложений - ноinый. Еще недаinно приложения VK withоздаinалиwithь иtoче и иметь redirect_url for них было не нужно. Nа данный момент не withоinwithем понятно, зачем он нужен toм for withерinерного приложения - проwithто таtoого понятия toаto withерinерное приложение у VK теперь нет. Теоретичеwithtoи, туда можно inпиwithать что угодно - for work with библиотеtoой in получении обратных data нет необходимоwithти. Одtotoо, with течением inремени, this может changeенитьwithя. - - ![BF](../../static/img/Docs/VK/4.png) - - * Ininеwithти паwithпортные Data or Data об органfromации, intoлючить доwithтуп to withообщеwithтinам (toороче, еwithли у inаwith уже было приложение до thisго, то inам toрупно поinезло, а еwithли нет роwithwithийwithtoого паwithпорта - придетwithя пиwithать in поддержtoу) - - ![BF](../../static/img/Docs/VK/8.png) - - * Get app_id to withтранице приложения - - ![BF](../../static/img/Docs/VK/5.png) - -**5. access_token** - - Сwithылtoу to получение acess_token можно получить при помощи фунtoции *CreateTokenRetrievalLink* or withtoлеить inручную: - - https://oauth.vk.com/authorize?client_id= + *app_id* + &scope=offline,wall,groups,photos,stats,stories,ads&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html - - * To thisй withwithылtoе необходимо перейти in браузере - * Authorfromоinатьwithя через VK и подтinердить доwithтуп - * Забрать тоtoен from параметра URL in адреwithной withтроtoе - - ![BF](../../static/img/Docs/VK/6.png) - -**(Дополнительно) communitytoken** - - Nottoоторые methodы, toпример for work with чат-ботом withообщеwithтinа, принимают in toачеwithтinе параметра communitytoken - in этих methodх он заменяет access_token. For его получения необходимо: - - * Зайти in раздел "Упраinление" in group VK - * Nайти intoладtoу "Work with API" - * Nажать "Создать toлюч" и забрать его - - ![BF](../../static/img/Docs/VK/7.png) - - WHile inам не нужно иwithпользоinать таtoие methodы, получать communitytoken не обязательно +--- +id: VK +sidebar_class_name: VK +--- + + + +# VKontakte + +Этот раздел поwithinящен библиотеtoе for work with VK API. Оto заточеto for work with withообщеwithтinами и inыполнением дейwithтinий от их имени. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +For of start work необходимо получить неtoоторые параметры for VK API. + +

+Перечень необходимых data in inиде withтруtoтуры withодержитwithя in фунtoции *GetStandardParameters()*. Inы можете уtoазыinать зtoчения parameters прямо in ней or же передаinать их withтруtoтурой при inызоinе любых других methodоin libraries in toачеwithтinе необязательного параметра *Parameters* (afterдний inо all methodх бorотеtoи). In afterднем withлучае withтандартные параметры будут перезапиwithаны по toлючам теми, toоторые переданы при inызоinе method. Перезапиwithаны будут тольtoо withоinпадающие по toлючам Data. If toаtoой то параметр еwithть in toборе withтандартных, но не был передан при inызоinе method, то он withохранит withтандартное value. +

+ + ```bsl + _Parameters = New Structure; + + _Parameters.Insert("v", "5.131"); + _Parameters.Insert("from_group", "1"); + _Parameters.Insert("group_id", "123456789"); + _Parameters.Insert("owner_id", "-123456789"); + _Parameters.Insert("app_id", "87654321"); + _Parameters.Insert("access_token", "vk1.a.E-byuFeG1qcN7..."); + + ``` + +Раwithwithмотрим получение each зtoчения: + +**1. v** + + Parameter v озtoчает inерwithию VK API. Testing проinодилоwithь to 5.131, реtoомендуетwithя его таtoим и оwithтаinить + +**2. from_group** + + От лица группы. Должен be 1 + +**3. group_id и owner_id** + + ID группы. If у inаwith withтандартный адреwith группы, то id можно toйти in URL. In протиinном withлучае он will to intoладtoе "Упраinление" in group, под полем Address. owner_id - тоже withамое, но withо зtotoом '-' inпереди + + ![BF](../../static/img/Docs/VK/1.png) + +**4. app_id** + + app_id - ID приложения. For withоздания приложения необходимо: + + * Goto по адреwithу https://id.vk.com/about/business/go, аinторfromоinатьwithя и ininеwithти withinои Data фfrom. or юр. лица + + ![BF](../../static/img/Docs/VK/2.png) + + * Ininеwithти name приложения и inыбрать пунtoт **Web** + + ![BF](../../static/img/Docs/VK/3.png) + + * Ininеwithти домееное имя и URL обработчиtoа переtoпраinлений. Тут нужно отметить, что данный механchange withоздания приложений - ноinый. Еще недаinно приложения VK withоздаinалиwithь иtoче и иметь redirect_url for них было не нужно. Nа данный момент не withоinwithем понятно, зачем он нужен toм for withерinерного приложения - проwithто таtoого понятия toаto withерinерное приложение у VK теперь нет. Теоретичеwithtoи, туда можно inпиwithать что угодно - for work with библиотеtoой in получении обратных data нет необходимоwithти. Одtotoо, with течением inремени, this может changeенитьwithя. + + ![BF](../../static/img/Docs/VK/4.png) + + * Ininеwithти паwithпортные Data or Data об органfromации, intoлючить доwithтуп to withообщеwithтinам (toороче, еwithли у inаwith уже было приложение до thisго, то inам toрупно поinезло, а еwithли нет роwithwithийwithtoого паwithпорта - придетwithя пиwithать in поддержtoу) + + ![BF](../../static/img/Docs/VK/8.png) + + * Get app_id to withтранице приложения + + ![BF](../../static/img/Docs/VK/5.png) + +**5. access_token** + + Сwithылtoу to получение acess_token можно получить при помощи фунtoции *CreateTokenRetrievalLink* or withtoлеить inручную: + + https://oauth.vk.com/authorize?client_id= + *app_id* + &scope=offline,wall,groups,photos,stats,stories,ads&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html + + * To thisй withwithылtoе необходимо перейти in браузере + * Authorfromоinатьwithя через VK и подтinердить доwithтуп + * Забрать тоtoен from параметра URL in адреwithной withтроtoе + + ![BF](../../static/img/Docs/VK/6.png) + +**(Дополнительно) communitytoken** + + Nottoоторые methodы, toпример for work with чат-ботом withообщеwithтinа, принимают in toачеwithтinе параметра communitytoken - in этих methodх он заменяет access_token. For его получения необходимо: + + * Зайти in раздел "Упраinление" in group VK + * Nайти intoладtoу "Work with API" + * Nажать "Создать toлюч" и забрать его + + ![BF](../../static/img/Docs/VK/7.png) + + WHile inам не нужно иwithпользоinать таtoие methodы, получать communitytoken не обязательно diff --git a/docs/en/md/VK/_category_.json b/docs/en/md/VK/_category_.json index fa73854365..adf66705ca 100644 --- a/docs/en/md/VK/_category_.json +++ b/docs/en/md/VK/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "VK", - "position": 3, - "link": { - "type": "doc", - "id": "VK" - } -} +{ + "label": "VK", + "position": 3, + "link": { + "type": "doc", + "id": "VK" + } +} 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 index dbc333b8ee..df6425e56e 100644 --- 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 @@ -1,72 +1,72 @@ ---- -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 | Destination | - |-|-|-|-| - | 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"); - - Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); //Structure - JSON = OPI_Tools.JSONString(Keyboard); //String - - - -``` - -```sh title="CLI command example" - - oint viber CreateKeyboardFromArrayButton --buttons %buttons% --color %color% - - -``` - - -```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" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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"); + + Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); //Structure + JSON = OPI_Tools.JSONString(Keyboard); //String + + + +``` + +```sh title="CLI command example" + + oint viber CreateKeyboardFromArrayButton --buttons %buttons% --color %color% + + +``` + + +```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 index 829b75ba63..bd0c4221bc 100644 --- a/docs/en/md/Viber/Message-sending/Send-contact.md +++ b/docs/en/md/Viber/Message-sending/Send-contact.md @@ -1,53 +1,53 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - UserID = "d3jxe1111111111jYGgZg=="; - - Response = OPI_Viber.SendContact(BotToken, "John Doe", "+749521231", UserID, False); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SendContact --token %token% --name %name% --phone %phone% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% - - -``` - - -```json title="Result" - -{ - "billing_status": 1, - "chat_hostname": "SN-CHAT-15_", - "message_token": 5925747984748149627, - "status_message": "ok", - "status": 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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + UserID = "d3jxe1111111111jYGgZg=="; + + Response = OPI_Viber.SendContact(BotToken, "John Doe", "+749521231", UserID, False); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SendContact --token %token% --name %name% --phone %phone% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% + + +``` + + +```json title="Result" + +{ + "billing_status": 1, + "chat_hostname": "SN-CHAT-15_", + "message_token": 5925747984748149627, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Message-sending/Send-file.md b/docs/en/md/Viber/Message-sending/Send-file.md index 68562ab343..b0d63e5b46 100644 --- a/docs/en/md/Viber/Message-sending/Send-file.md +++ b/docs/en/md/Viber/Message-sending/Send-file.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 3 ---- - -# SendFile - 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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - ChannelToken = "523b58ba82afffaa-111111111111111-2222222222222222"; - UserID = "tMNGh111111111D+bT4g=="; - - Response = OPI_Viber.SendFile(ChannelToken, "https://api.athenaeum.digital/1.txt", UserID, True, "txt"); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SendFile --token %token% --file %file% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --ext %ext% --size %size% - - -``` - - -```json title="Result" - -{ - "chat_hostname": "SN-CHAT-09_", - "message_token": 5925491906424759104, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 3 +--- + +# SendFile + 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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + ChannelToken = "523b58ba82afffaa-111111111111111-2222222222222222"; + UserID = "tMNGh111111111D+bT4g=="; + + Response = OPI_Viber.SendFile(ChannelToken, "https://api.athenaeum.digital/1.txt", UserID, True, "txt"); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SendFile --token %token% --file %file% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --ext %ext% --size %size% + + +``` + + +```json title="Result" + +{ + "chat_hostname": "SN-CHAT-09_", + "message_token": 5925491906424759104, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Message-sending/Send-image.md b/docs/en/md/Viber/Message-sending/Send-image.md index e4d9f22dfc..8e121de2ba 100644 --- a/docs/en/md/Viber/Message-sending/Send-image.md +++ b/docs/en/md/Viber/Message-sending/Send-image.md @@ -1,52 +1,52 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - ChannelToken = "523b58ba82afffaa-111111111111111-2222222222222222"; - UserID = "tMNGh111111111D+bT4g=="; - - Response = OPI_Viber.SendImage(ChannelToken, "https://api.athenaeum.digital/logo.png", UserID, True, "Alpaca"); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SendImage --token %token% --picture %picture% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --description %description% - - -``` - - -```json title="Result" - -{ - "chat_hostname": "SN-CHAT-12_", - "message_token": 5925484936191962157, - "status_message": "ok", - "status": 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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + ChannelToken = "523b58ba82afffaa-111111111111111-2222222222222222"; + UserID = "tMNGh111111111D+bT4g=="; + + Response = OPI_Viber.SendImage(ChannelToken, "https://api.athenaeum.digital/logo.png", UserID, True, "Alpaca"); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SendImage --token %token% --picture %picture% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --description %description% + + +``` + + +```json title="Result" + +{ + "chat_hostname": "SN-CHAT-12_", + "message_token": 5925484936191962157, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Message-sending/Send-link.md b/docs/en/md/Viber/Message-sending/Send-link.md index d87d4aa48f..a1dba2d507 100644 --- a/docs/en/md/Viber/Message-sending/Send-link.md +++ b/docs/en/md/Viber/Message-sending/Send-link.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 6 ---- - -# SendLink - 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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - UserID = "d3jxe1111111111jYGgZg=="; - - Response = OPI_Viber.SendLink(BotToken, "https://github.com/Bayselonarrend", UserID, False); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SendLink --token %token% --url %url% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% - - -``` - - -```json title="Result" - -{ - "billing_status": 1, - "chat_hostname": "SN-CHAT-15_", - "message_token": 5925752472607291800, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 6 +--- + +# SendLink + 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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + UserID = "d3jxe1111111111jYGgZg=="; + + Response = OPI_Viber.SendLink(BotToken, "https://github.com/Bayselonarrend", UserID, False); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SendLink --token %token% --url %url% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% + + +``` + + +```json title="Result" + +{ + "billing_status": 1, + "chat_hostname": "SN-CHAT-15_", + "message_token": 5925752472607291800, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Message-sending/Send-location.md b/docs/en/md/Viber/Message-sending/Send-location.md index 4ad65f4af9..70c257136b 100644 --- a/docs/en/md/Viber/Message-sending/Send-location.md +++ b/docs/en/md/Viber/Message-sending/Send-location.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 5 ---- - -# SendLocation - 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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - UserID = "d3jxe1111111111jYGgZg=="; - - Response = OPI_Viber.SendLocation(BotToken, "55.75", "37.6167", UserID, False); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SendLocation --token %token% --lat %lat% --long %long% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% - - -``` - - -```json title="Result" - -{ - "billing_status": 1, - "chat_hostname": "SN-CHAT-10_", - "message_token": 5925751017338988046, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 5 +--- + +# SendLocation + 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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + UserID = "d3jxe1111111111jYGgZg=="; + + Response = OPI_Viber.SendLocation(BotToken, "55.75", "37.6167", UserID, False); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SendLocation --token %token% --lat %lat% --long %long% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% + + +``` + + +```json title="Result" + +{ + "billing_status": 1, + "chat_hostname": "SN-CHAT-10_", + "message_token": 5925751017338988046, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Message-sending/Send-text-message.md b/docs/en/md/Viber/Message-sending/Send-text-message.md index 7c02a62593..23c2f7c25a 100644 --- a/docs/en/md/Viber/Message-sending/Send-text-message.md +++ b/docs/en/md/Viber/Message-sending/Send-text-message.md @@ -1,60 +1,60 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - UserID = "d3jxe1111111111jYGgZg=="; - - ButtonArray = New Array; - - ButtonArray.Add("Button 1"); - ButtonArray.Add("Button 2"); - ButtonArray.Add("Button 3"); - - Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); - - Response = OPI_Viber.SendTextMessage(BotToken, "Hello", UserID, False, Keyboard); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SendTextMessage --token %token% --text %text% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% --keyboard %keyboard% - - -``` - - -```json title="Result" - -{ - "chat_hostname": "SN-CHAT-10_", - "message_token": 5925400810709476620, - "status_message": "ok", - "status": 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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + UserID = "d3jxe1111111111jYGgZg=="; + + ButtonArray = New Array; + + ButtonArray.Add("Button 1"); + ButtonArray.Add("Button 2"); + ButtonArray.Add("Button 3"); + + Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); + + Response = OPI_Viber.SendTextMessage(BotToken, "Hello", UserID, False, Keyboard); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SendTextMessage --token %token% --text %text% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% --keyboard %keyboard% + + +``` + + +```json title="Result" + +{ + "chat_hostname": "SN-CHAT-10_", + "message_token": 5925400810709476620, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Message-sending/_category_.json b/docs/en/md/Viber/Message-sending/_category_.json index f3e5e2df52..0df27b99c6 100644 --- a/docs/en/md/Viber/Message-sending/_category_.json +++ b/docs/en/md/Viber/Message-sending/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Message sending", -"position": "3" -} +{ +"label": "Message sending", +"position": "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 index d851b31cf7..1628c24256 100644 --- a/docs/en/md/Viber/Settings-and-information/Get-channel-information.md +++ b/docs/en/md/Viber/Settings-and-information/Get-channel-information.md @@ -1,63 +1,63 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - Response = OPI_Viber.GetChannelInformation(ChannelToken); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber GetChannelInformation --token %token% - - -``` - - -```json title="Result" - -{ - "members": [ - { - "role": "admin", - "name": "John", - "id": "d3jxe611111111kjYGgZg==" - } - ], - "subcategory": "Advertising Service", - "category": "Local Businesses", - "location": { - "lon": -73.96878, - "lat": 40.7691018 - }, - "icon": "https://media-direct.cdn.viber.com/pg_download?pgtp=icons&dlid=0-04-01-05bfe24da13dddf32cf52976b099dc6965c03300763e6a9316de26986e5dea05&fltp=jpg&imsz=0000", - "subscribers_count": 0, - "name": "1CTestBot", - "chat_hostname": "SN-CHAT-01_", - "id": "pa:5925429953186752236", - "country": "US", - "uri": "1ctestbot", - "status_message": "ok", - "status": 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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + Response = OPI_Viber.GetChannelInformation(ChannelToken); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber GetChannelInformation --token %token% + + +``` + + +```json title="Result" + +{ + "members": [ + { + "role": "admin", + "name": "John", + "id": "d3jxe611111111kjYGgZg==" + } + ], + "subcategory": "Advertising Service", + "category": "Local Businesses", + "location": { + "lon": -73.96878, + "lat": 40.7691018 + }, + "icon": "https://media-direct.cdn.viber.com/pg_download?pgtp=icons&dlid=0-04-01-05bfe24da13dddf32cf52976b099dc6965c03300763e6a9316de26986e5dea05&fltp=jpg&imsz=0000", + "subscribers_count": 0, + "name": "1CTestBot", + "chat_hostname": "SN-CHAT-01_", + "id": "pa:5925429953186752236", + "country": "US", + "uri": "1ctestbot", + "status_message": "ok", + "status": 0 + } + +``` 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 index 7d31a8565d..6c89cb83a1 100644 --- a/docs/en/md/Viber/Settings-and-information/Get-online-users.md +++ b/docs/en/md/Viber/Settings-and-information/Get-online-users.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 4 ---- - -# Get online users - Gets the status of a user or several users by ID - - -*Function GetOnlineUsers(Val Token, Val UserIDs) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Viber Token | - | UserIDs | --users | String,Number,Array of String,Number | Viber User(s) ID | - - - Returns: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - Response = OPI_Viber.GetOnlineUsers(Token, UserID); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber GetOnlineUsers --token %token% --users %users% - - -``` - - -```json title="Result" - -{ - "users": [ - { - "last_online": 1704796869778, - "online_status_message": "offline", - "online_status": 1, - "id": "d3jxe111111111YGgZg==" - } - ], - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 4 +--- + +# Get online users + Gets the status of a user or several users by ID + + +*Function GetOnlineUsers(Val Token, Val UserIDs) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Viber Token | + | UserIDs | --users | String,Number,Array of String,Number | Viber User(s) ID | + + + Returns: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + Response = OPI_Viber.GetOnlineUsers(Token, UserID); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber GetOnlineUsers --token %token% --users %users% + + +``` + + +```json title="Result" + +{ + "users": [ + { + "last_online": 1704796869778, + "online_status_message": "offline", + "online_status": 1, + "id": "d3jxe111111111YGgZg==" + } + ], + "status_message": "ok", + "status": 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 index 25aca6baa3..4ae332222f 100644 --- a/docs/en/md/Viber/Settings-and-information/Get-user-data.md +++ b/docs/en/md/Viber/Settings-and-information/Get-user-data.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 3 ---- - -# Get user data - Gets user information by ID - - -*Function GetUserData(Val Token, Val UserID) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | UserID | --user | String, Number | Viber User ID | - - - Returns: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - Response = OPI_Viber.GetUserData(Token, UserID); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber GetUserData --token %token% --user %user% - - -``` - - -```json title="Result" - -{ - "user": { - "device_type": "iPhone8,4", - "mnc": 1, - "mcc": 257, - "api_version": 10, - "primary_device_os": "iOS 15.6.1", - "viber_version": "21.6.0.18", - "country": "FR", - "language": "ru", - "avatar": "http://dl-media.viber.com/1/share/2/long/bots/generic-avatar%402x.png", - "name": "Subscriber", - "id": "d3jxe6111111NkjYGgZg==" - }, - "chat_hostname": "SN-CHAT-07_", - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 3 +--- + +# Get user data + Gets user information by ID + + +*Function GetUserData(Val Token, Val UserID) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | UserID | --user | String, Number | Viber User ID | + + + Returns: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + Response = OPI_Viber.GetUserData(Token, UserID); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber GetUserData --token %token% --user %user% + + +``` + + +```json title="Result" + +{ + "user": { + "device_type": "iPhone8,4", + "mnc": 1, + "mcc": 257, + "api_version": 10, + "primary_device_os": "iOS 15.6.1", + "viber_version": "21.6.0.18", + "country": "FR", + "language": "ru", + "avatar": "http://dl-media.viber.com/1/share/2/long/bots/generic-avatar%402x.png", + "name": "Subscriber", + "id": "d3jxe6111111NkjYGgZg==" + }, + "chat_hostname": "SN-CHAT-07_", + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Settings-and-information/Set-webhook.md b/docs/en/md/Viber/Settings-and-information/Set-webhook.md index bff6d0b1e5..03f5844d74 100644 --- a/docs/en/md/Viber/Settings-and-information/Set-webhook.md +++ b/docs/en/md/Viber/Settings-and-information/Set-webhook.md @@ -1,57 +1,57 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Viber Token | - | URL | --url | String | URL for setting up Webhook | - - - Returns: Key-Value Pair - serialized JSON response from Viber - -```bsl title="Code example" - - - Response = OPI_Viber.SetWebhook(Token, "https://api.athenaeum.digital/opi/hs/viber"); //Map - Response = OPI_Tools.JSONString(Response); //JSON string - - - -``` - -```sh title="CLI command example" - - oint viber SetWebhook --token %token% --url %url% - - -``` - - -```json title="Result" - -{ - "event_types": [ - "subscribed", - "unsubscribed", - "webhook", - "conversation_started", - "client_status", - "action", - "delivered", - "failed", - "message", - "seen" - ], - "chat_hostname": "SN-CHAT-12_", - "status_message": "ok", - "status": 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 | Destination | + |-|-|-|-| + | Token | --token | String | Viber Token | + | URL | --url | String | URL for setting up Webhook | + + + Returns: Key-Value Pair - serialized JSON response from Viber + +```bsl title="Code example" + + + Response = OPI_Viber.SetWebhook(Token, "https://api.athenaeum.digital/opi/hs/viber"); //Map + Response = OPI_Tools.JSONString(Response); //JSON string + + + +``` + +```sh title="CLI command example" + + oint viber SetWebhook --token %token% --url %url% + + +``` + + +```json title="Result" + +{ + "event_types": [ + "subscribed", + "unsubscribed", + "webhook", + "conversation_started", + "client_status", + "action", + "delivered", + "failed", + "message", + "seen" + ], + "chat_hostname": "SN-CHAT-12_", + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/en/md/Viber/Settings-and-information/_category_.json b/docs/en/md/Viber/Settings-and-information/_category_.json index 31fbf28c4f..6cf21ad1f2 100644 --- a/docs/en/md/Viber/Settings-and-information/_category_.json +++ b/docs/en/md/Viber/Settings-and-information/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Settings and information", -"position": "2" -} +{ +"label": "Settings and information", +"position": "2" +} diff --git a/docs/en/md/Viber/Viber.md b/docs/en/md/Viber/Viber.md index 01569b7f60..fb865c27bb 100644 --- a/docs/en/md/Viber/Viber.md +++ b/docs/en/md/Viber/Viber.md @@ -1,69 +1,69 @@ ---- -id: Viber -sidebar_class_name: Viber ---- - - - -# Viber - -Этот раздел поwithinящен библиотеtoе for work with Viber API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -:::note - -Оwithобенноwithти work with Viber API - -1. Notльзя иwithпользоinать бота и упраinлять toаtoлом через API, еwithли не уwithтаноinлен Webhook - - In отличии от Telegram, toоторые позinоляют withамому забирать обноinления with withерinероin, а пиwithать и inоinwithе незаinиwithимо от thisго, Viber требует обязательного иwithпользоinания Webhook, т.е у inаwith должен be withерinер with inнешним IP и дейwithтinительный SSL withертифиtoат. If inерить доtoументации, Viber периодичеwithtoи will withтучать по адреwithу, уtoазанному toаto WH и еwithли он не получит отinет 200, то inwithе переwithтанет работать(**UPD:** Уже меwithяц нет http-withерinиwithа, но ничего не поломалоwithь). Requests от Viber могут обрабатыinатьwithя http-withерinиwithом or любым другим обработчиtoом for запроwithоin typeа POST, при уwithлоinии toличия SSL и доwithтупноwithти адреwithа frominне. If у inаwith еwithть таtoой адреwith, то уwithтаноinить Webhook можно при помощий фунtoции *SetWebhook()* данной libraries (withм. далее). Towithле уwithтаноintoи, у чат бота in приложении Viber пояinитwithя toнопtoа "Message" for of start диалога, а in toаtoл withтанет можно отпраinлять withообщения через REST Api. - -2. У Viber отwithутwithтinуют механchangeы upload inнешних fileоin to их withерinера - - Kартинtoи, fileы и доtoументы могут отпраinлятьwithя in Viber тольtoо in inиде URL. Т.е. for thisго тоже нужен withерinер or, toаto минимум, withторонний withерinиwith for публиtoации fileоin. Nо таto toаto withерinер уже in любом withлучае необходим for Webhook, отпраinляемые fileы можно inременно withохранять in папtoу inеб-withерinера. У IIS this папtoа wwwroot - -::: - -У Viber еwithть дinа REST API: один for work with toаtoлами, а inторой - for чат-ботоin. In обоих withлучаях mainоinными параметрами withлужат **Token** и **UserID** - -- If inам необходимо упраinлять toаtoлом: - 1. Зайдите in приложение Viber и withоздайте ноinый toаtoл - - ![BF](../../static/img/Docs/Viber/1.png) - - 2. Towithле withоздания, перейдите in towithтройtoи toаtoла -> "For разработчиtoоin", и withtoопируйте **Token** - - ![BF](../../static/img/Docs/Viber/2.png) - - 3. Уwithтаноinите Webhook. See. Set Webhook - 4. **UserID** - inаш ID (админиwithтратора toаtoла). See. Get channel information - -
- -- If inам необходим чат-бот: - 1. Перейдите по withwithылtoе [https://partners.viber.com/account/create-bot-account](https://partners.viber.com/account/create-bot-account) и аinторfromуйтеwithь with inашим номером телефоto, toоторый приinязан to Viber - - ![BF](../../static/img/Docs/Viber/3.png) - - 2. Inыберите пунtoт withоздания ноinого бота - - ![BF](../../static/img/Docs/Viber/4.png) - - 3. In меню withоздания бота заполните inwithе необходимые fields - - ![BF](../../static/img/Docs/Viber/5.png) - - 4. Сtoопируйте **Token** - - ![BF](../../static/img/Docs/Viber/6.png) - - 4. Nайти withinоего ноinого бота inы можете отwithtoанироinаin QR to withтранице withоздания or in towithтройtoах (пунtoт чат-боты) in приложении Viber. - - ![BF](../../static/img/Docs/Viber/7.png) - - 5. Сейчаwith inы не можете toчать диалог with ботом, withof start необходимо уwithтаноinить Webhook. See. Set Webhook - 6. Towithле start **UserID** will ID toонtoретного челоinеtoа, inедущего диалог with ботом. Get можно from обworktoи incoming withообщения по Webhook - - - **Inажно:** ID одного и того же пользоinателя у чата и toаtoла - this разные зtoчения. Notльзя иwithпользоinать ID, полученный from withообщения боту for inызоinа methodоin упраinления toаtoлом и toоборот. +--- +id: Viber +sidebar_class_name: Viber +--- + + + +# Viber + +Этот раздел поwithinящен библиотеtoе for work with Viber API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +:::note + +Оwithобенноwithти work with Viber API + +1. Notльзя иwithпользоinать бота и упраinлять toаtoлом через API, еwithли не уwithтаноinлен Webhook + + In отличии от Telegram, toоторые позinоляют withамому забирать обноinления with withерinероin, а пиwithать и inоinwithе незаinиwithимо от thisго, Viber требует обязательного иwithпользоinания Webhook, т.е у inаwith должен be withерinер with inнешним IP и дейwithтinительный SSL withертифиtoат. If inерить доtoументации, Viber периодичеwithtoи will withтучать по адреwithу, уtoазанному toаto WH и еwithли он не получит отinет 200, то inwithе переwithтанет работать(**UPD:** Уже меwithяц нет http-withерinиwithа, но ничего не поломалоwithь). Requests от Viber могут обрабатыinатьwithя http-withерinиwithом or любым другим обработчиtoом for запроwithоin typeа POST, при уwithлоinии toличия SSL и доwithтупноwithти адреwithа frominне. If у inаwith еwithть таtoой адреwith, то уwithтаноinить Webhook можно при помощий фунtoции *SetWebhook()* данной libraries (withм. далее). Towithле уwithтаноintoи, у чат бота in приложении Viber пояinитwithя toнопtoа "Message" for of start диалога, а in toаtoл withтанет можно отпраinлять withообщения через REST Api. + +2. У Viber отwithутwithтinуют механchangeы upload inнешних fileоin to их withерinера + + Kартинtoи, fileы и доtoументы могут отпраinлятьwithя in Viber тольtoо in inиде URL. Т.е. for thisго тоже нужен withерinер or, toаto минимум, withторонний withерinиwith for публиtoации fileоin. Nо таto toаto withерinер уже in любом withлучае необходим for Webhook, отпраinляемые fileы можно inременно withохранять in папtoу inеб-withерinера. У IIS this папtoа wwwroot + +::: + +У Viber еwithть дinа REST API: один for work with toаtoлами, а inторой - for чат-ботоin. In обоих withлучаях mainоinными параметрами withлужат **Token** и **UserID** + +- If inам необходимо упраinлять toаtoлом: + 1. Зайдите in приложение Viber и withоздайте ноinый toаtoл + + ![BF](../../static/img/Docs/Viber/1.png) + + 2. Towithле withоздания, перейдите in towithтройtoи toаtoла -> "For разработчиtoоin", и withtoопируйте **Token** + + ![BF](../../static/img/Docs/Viber/2.png) + + 3. Уwithтаноinите Webhook. See. Set Webhook + 4. **UserID** - inаш ID (админиwithтратора toаtoла). See. Get channel information + +
+ +- If inам необходим чат-бот: + 1. Перейдите по withwithылtoе [https://partners.viber.com/account/create-bot-account](https://partners.viber.com/account/create-bot-account) и аinторfromуйтеwithь with inашим номером телефоto, toоторый приinязан to Viber + + ![BF](../../static/img/Docs/Viber/3.png) + + 2. Inыберите пунtoт withоздания ноinого бота + + ![BF](../../static/img/Docs/Viber/4.png) + + 3. In меню withоздания бота заполните inwithе необходимые fields + + ![BF](../../static/img/Docs/Viber/5.png) + + 4. Сtoопируйте **Token** + + ![BF](../../static/img/Docs/Viber/6.png) + + 4. Nайти withinоего ноinого бота inы можете отwithtoанироinаin QR to withтранице withоздания or in towithтройtoах (пунtoт чат-боты) in приложении Viber. + + ![BF](../../static/img/Docs/Viber/7.png) + + 5. Сейчаwith inы не можете toчать диалог with ботом, withof start необходимо уwithтаноinить Webhook. See. Set Webhook + 6. Towithле start **UserID** will ID toонtoретного челоinеtoа, inедущего диалог with ботом. Get можно from обworktoи incoming withообщения по Webhook + + + **Inажно:** ID одного и того же пользоinателя у чата и toаtoла - this разные зtoчения. Notльзя иwithпользоinать ID, полученный from withообщения боту for inызоinа methodоin упраinления toаtoлом и toоборот. diff --git a/docs/en/md/Viber/_category_.json b/docs/en/md/Viber/_category_.json index bfc75ada7c..9c721bc3ec 100644 --- a/docs/en/md/Viber/_category_.json +++ b/docs/en/md/Viber/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Viber", - "position": 3, - "link": { - "type": "doc", - "id": "Viber" - } -} +{ + "label": "Viber", + "position": 3, + "link": { + "type": "doc", + "id": "Viber" + } +} 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 index 4f1584184d..86dfe43dd3 100644 --- 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 @@ -1,64 +1,64 @@ ---- -sidebar_position: 2 ---- - -# Create folder - Creates a directory on the disk - - -*Function CreateFolder(Val Token, Val Path) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the created folder | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/TestFolder" - Response = OPI_YandexDisk.CreateFolder(Token, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk CreateFolder --token "y0_AgAAAABdylaOAA..." --path "/TestFolder" - - -``` - - -```json title="Result" - -{ - "revision": 1707461457546792, - "comment_ids": { - "public_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", - "private_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac" - }, - "path": "disk:/TestFolder", - "modified": "2024-02-09T06:50:57+00:00", - "created": "2024-02-09T06:50:57+00:00", - "resource_id": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", - "type": "dir", - "name": "TestFolder", - "exif": {}, - "_embedded": { - "total": 0, - "path": "disk:/TestFolder", - "limit": 20, - "offset": 0, - "items": [], - "sort": "" - } - } - -``` +--- +sidebar_position: 2 +--- + +# Create folder + Creates a directory on the disk + + +*Function CreateFolder(Val Token, Val Path) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the created folder | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/TestFolder" + Response = OPI_YandexDisk.CreateFolder(Token, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk CreateFolder --token "y0_AgAAAABdylaOAA..." --path "/TestFolder" + + +``` + + +```json title="Result" + +{ + "revision": 1707461457546792, + "comment_ids": { + "public_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", + "private_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac" + }, + "path": "disk:/TestFolder", + "modified": "2024-02-09T06:50:57+00:00", + "created": "2024-02-09T06:50:57+00:00", + "resource_id": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", + "type": "dir", + "name": "TestFolder", + "exif": {}, + "_embedded": { + "total": 0, + "path": "disk:/TestFolder", + "limit": 20, + "offset": 0, + "items": [], + "sort": "" + } + } + +``` 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 index 5317cb7de3..5a31ea4984 100644 --- 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 @@ -1,118 +1,118 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Original = "/Alpaca.png"; - Path = "/Alpaca (copy).png"; - - Response = OPI_YandexDisk.CreateObjectCopy(Token, Original, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk CreateObjectCopy --token "y0_AgAAAABdylaOAA..." --from "/Alpaca.png" --to "/Alpaca (copy).png" --rewrite %rewrite% - - -``` - - -```json title="Result" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707469147481281, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T08:59:07+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", - "preview": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T08:59:07+00:00", - "exif": {}, - "name": "Alpaca (copy).png", - "type": "file", - "size": 440431, - "path": "disk:/Alpaca (copy).png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", - "private_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c" - }, - "mime_type": "multipart" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Original = "/Alpaca.png"; + Path = "/Alpaca (copy).png"; + + Response = OPI_YandexDisk.CreateObjectCopy(Token, Original, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk CreateObjectCopy --token "y0_AgAAAABdylaOAA..." --from "/Alpaca.png" --to "/Alpaca (copy).png" --rewrite %rewrite% + + +``` + + +```json title="Result" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707469147481281, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T08:59:07+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", + "preview": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T08:59:07+00:00", + "exif": {}, + "name": "Alpaca (copy).png", + "type": "file", + "size": 440431, + "path": "disk:/Alpaca (copy).png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", + "private_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c" + }, + "mime_type": "multipart" + } + +``` 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 index 49575febb1..a028a2103d 100644 --- 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 @@ -1,44 +1,44 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the folder or file to be deleted | - | ToCart | --can | Boolean | To cart | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/Alpaca.png" - Response = OPI_YandexDisk.DeleteObject(Token, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk DeleteObject --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" --can %can% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the folder or file to be deleted | + | ToCart | --can | Boolean | To cart | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/Alpaca.png" + Response = OPI_YandexDisk.DeleteObject(Token, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk DeleteObject --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" --can %can% + + +``` + + +```json title="Result" + + + +``` 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 index 6c6ecb7c18..a5de43a851 100644 --- 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 @@ -1,38 +1,38 @@ ---- -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 | Destination | - |-|-|-|-| - | 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" - - - -``` - -```sh title="CLI command example" - - oint yadisk DownloadFile --token %token% --path %path% --out %out% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | 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" + + + +``` + +```sh title="CLI command example" + + oint yadisk DownloadFile --token %token% --path %path% --out %out% + + +``` + + +```json title="Result" + + + +``` 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 index ff41a30d44..4bda356b72 100644 --- 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 @@ -1,76 +1,76 @@ ---- -sidebar_position: 1 ---- - -# Get disk information - Gets information about the current disk - - -*Function GetDiskInformation(Val Token) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Response = OPI_YandexDisk.GetDiskInformation(Token); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetDiskInformation --token "y0_AgAAAABdylaOAA..." - - -``` - - -```json title="Result" - -{ - "user": { - "login": "bayselonarrend", - "country": "by", - "uid": "1573541111", - "display_name": "bayselonarrend", - "is_child": false, - "reg_time": "2024-02-01T22:13:41+00:00" - }, - "revision": 1707416628219047, - "system_folders": { - "photostream": "disk:/Photos/", - "screenshots": "disk:/Screenshots/", - "scans": "disk:/Scans", - "messenger": "disk:/Messenger files", - "facebook": "disk:/Social networks/Facebook", - "applications": "disk:/Apps", - "downloads": "disk:/Downloads/", - "mailru": "disk:/Social networks/My World", - "attach": "disk:/Mail attachments", - "instagram": "disk:/Social networks/Instagram", - "calendar": "disk:/Meeting materials", - "social": "disk:/Social networks/", - "vkontakte": "disk:/Social networks/VKontakte", - "google": "disk:/Social networks/Google+", - "odnoklassniki": "disk:/Social networks/Classmates" - }, - "unlimited_autoupload_enabled": false, - "used_space": 73372937, - "trash_size": 0, - "reg_time": "2024-02-01T12:13:41+00:00", - "total_space": 5368709120, - "is_paid": false, - "paid_max_file_size": 53687091200, - "max_file_size": 1073741824 - } - -``` +--- +sidebar_position: 1 +--- + +# Get disk information + Gets information about the current disk + + +*Function GetDiskInformation(Val Token) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Response = OPI_YandexDisk.GetDiskInformation(Token); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetDiskInformation --token "y0_AgAAAABdylaOAA..." + + +``` + + +```json title="Result" + +{ + "user": { + "login": "bayselonarrend", + "country": "by", + "uid": "1573541111", + "display_name": "bayselonarrend", + "is_child": false, + "reg_time": "2024-02-01T22:13:41+00:00" + }, + "revision": 1707416628219047, + "system_folders": { + "photostream": "disk:/Photos/", + "screenshots": "disk:/Screenshots/", + "scans": "disk:/Scans", + "messenger": "disk:/Messenger files", + "facebook": "disk:/Social networks/Facebook", + "applications": "disk:/Apps", + "downloads": "disk:/Downloads/", + "mailru": "disk:/Social networks/My World", + "attach": "disk:/Mail attachments", + "instagram": "disk:/Social networks/Instagram", + "calendar": "disk:/Meeting materials", + "social": "disk:/Social networks/", + "vkontakte": "disk:/Social networks/VKontakte", + "google": "disk:/Social networks/Google+", + "odnoklassniki": "disk:/Social networks/Classmates" + }, + "unlimited_autoupload_enabled": false, + "used_space": 73372937, + "trash_size": 0, + "reg_time": "2024-02-01T12:13:41+00:00", + "total_space": 5368709120, + "is_paid": false, + "paid_max_file_size": 53687091200, + "max_file_size": 1073741824 + } + +``` 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 index 4379526295..30f7cf48e5 100644 --- 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 @@ -1,47 +1,47 @@ ---- -sidebar_position: 6 ---- - -# Get download link - Gets a download link for the file - - -*Function GetDownloadLink(Val Token, Val Path) Export* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the file for downloading | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/Alpaca.png" - Response = OPI_YandexDisk.GetDownloadLink(Token, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetDownloadLink --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" - - -``` - - -```json title="Result" - -{ - "templated": false, - "method": "GET", - "href": "https://downloader.disk.yandex.ru/disk/5e035e14f3580573be69477a0a5a41a598227875d7c471604e386ee2dcfc7067/65c62a93/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - } - -``` +--- +sidebar_position: 6 +--- + +# Get download link + Gets a download link for the file + + +*Function GetDownloadLink(Val Token, Val Path) Export* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the file for downloading | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/Alpaca.png" + Response = OPI_YandexDisk.GetDownloadLink(Token, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetDownloadLink --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" + + +``` + + +```json title="Result" + +{ + "templated": false, + "method": "GET", + "href": "https://downloader.disk.yandex.ru/disk/5e035e14f3580573be69477a0a5a41a598227875d7c471604e386ee2dcfc7067/65c62a93/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + } + +``` 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 index e6f4147321..d1fed169bb 100644 --- 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 @@ -1,198 +1,198 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Response = OPI_YandexDisk.GetFilesList(Token, 2, 1, "image"); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetFilesList --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% --type %type% --datesort %datesort% - - -``` - - -```json title="Result" - -{ - "limit": 2, - "offset": 1, - "items": [ - { - "md5": "d27d72a3059ad5ebed7a5470459d2670", - "sha256": "fe9e2ea0d191ff0eb9d2129464f87da5fd5f02f370a4889492efc18947c70172", - "revision": 1706789623558058, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/600aa748c7064a155b01d3906b075cd77b14610e224ea20f629220e132a23add/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670", - "modified": "2024-02-01T12:13:43+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/386674328ba45b839defa451b28ce532a3027e32db910efce2a92a3b578fed65/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", - "preview": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-01T12:13:43+00:00", - "exif": { - "date_time": "2014-12-13T11:59:54+00:00" - }, - "name": "Moscow.jpg", - "type": "file", - "size": 1454228, - "path": "disk:/Moscow.jpg", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", - "private_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565" - }, - "mime_type": "image/jpeg" - }, - { - "md5": "ab903d9cab031eca2a8f12f37bbc9d37", - "sha256": "21f14018436c3dca7a47c5bd83f3b9bbc8b6c113b2a1d23ce7f5a0c80ce0e687", - "revision": 1706789624992463, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/1c893a2d6e3b1940e5705cb1e6c3dca9f47c9b79f2c2841615b8ae8868353186/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37", - "modified": "2024-02-01T12:13:44+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/a7af85df25252eb792b08de6bee2fb681dee549b375589a12574d6db2b97e770/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", - "preview": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-01T12:13:44+00:00", - "exif": { - "date_time": "2014-12-13T10:31:34+00:00" - }, - "name": "Sea.jpg", - "type": "file", - "size": 1080301, - "path": "disk:/Sea.jpg", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", - "private_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3" - }, - "mime_type": "image/jpeg" - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Response = OPI_YandexDisk.GetFilesList(Token, 2, 1, "image"); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetFilesList --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% --type %type% --datesort %datesort% + + +``` + + +```json title="Result" + +{ + "limit": 2, + "offset": 1, + "items": [ + { + "md5": "d27d72a3059ad5ebed7a5470459d2670", + "sha256": "fe9e2ea0d191ff0eb9d2129464f87da5fd5f02f370a4889492efc18947c70172", + "revision": 1706789623558058, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/600aa748c7064a155b01d3906b075cd77b14610e224ea20f629220e132a23add/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670", + "modified": "2024-02-01T12:13:43+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/386674328ba45b839defa451b28ce532a3027e32db910efce2a92a3b578fed65/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", + "preview": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-01T12:13:43+00:00", + "exif": { + "date_time": "2014-12-13T11:59:54+00:00" + }, + "name": "Moscow.jpg", + "type": "file", + "size": 1454228, + "path": "disk:/Moscow.jpg", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", + "private_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565" + }, + "mime_type": "image/jpeg" + }, + { + "md5": "ab903d9cab031eca2a8f12f37bbc9d37", + "sha256": "21f14018436c3dca7a47c5bd83f3b9bbc8b6c113b2a1d23ce7f5a0c80ce0e687", + "revision": 1706789624992463, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/1c893a2d6e3b1940e5705cb1e6c3dca9f47c9b79f2c2841615b8ae8868353186/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37", + "modified": "2024-02-01T12:13:44+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/a7af85df25252eb792b08de6bee2fb681dee549b375589a12574d6db2b97e770/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", + "preview": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-01T12:13:44+00:00", + "exif": { + "date_time": "2014-12-13T10:31:34+00:00" + }, + "name": "Sea.jpg", + "type": "file", + "size": 1080301, + "path": "disk:/Sea.jpg", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", + "private_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3" + }, + "mime_type": "image/jpeg" + } + ] + } + +``` 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 index 7713a122ca..992f064c48 100644 --- 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 @@ -1,114 +1,114 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to folder or file | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/Alpaca.png" - Response = OPI_YandexDisk.GetObject(Token, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetObject --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" - - -``` - - -```json title="Result" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707464146094880, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/dde91b59521a82943bf471bd567cbfc5d1743e47c070612cb12142b1539dee31/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T07:35:46+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/30f5ad2a163156a249c62177447abd5e88c7dc54491b67cd378c354abf67d7e5/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", - "preview": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-08T10:56:19+00:00", - "exif": {}, - "name": "Alpaca.png", - "type": "file", - "size": 440431, - "path": "disk:/Alpaca.png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", - "private_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb" - }, - "mime_type": "image/png" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to folder or file | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/Alpaca.png" + Response = OPI_YandexDisk.GetObject(Token, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetObject --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" + + +``` + + +```json title="Result" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707464146094880, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/dde91b59521a82943bf471bd567cbfc5d1743e47c070612cb12142b1539dee31/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T07:35:46+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/30f5ad2a163156a249c62177447abd5e88c7dc54491b67cd378c354abf67d7e5/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", + "preview": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-08T10:56:19+00:00", + "exif": {}, + "name": "Alpaca.png", + "type": "file", + "size": 440431, + "path": "disk:/Alpaca.png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", + "private_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb" + }, + "mime_type": "image/png" + } + +``` 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 index dde75dff52..6283359a73 100644 --- 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 @@ -1,118 +1,118 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Original = "/Alpaca.png"; - Path = "/TestFolder/Alpaca (Moved).png"; - - Response = OPI_YandexDisk.MoveObject(Token, Original, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk MoveObject --token "y0_AgAAAABdylaOAA..." --from "/Alpaca.png" --to "/TestFolder/Alpaca (Moved).png" --rewrite %rewrite% - - -``` - - -```json title="Result" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707469557170087, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/ac927eda1a0a731aa738bf31fa798a35970b5b47c2720a198574e124f462f7d8/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T09:05:57+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/a63112c5e420fa188f83cb59424d4149d181903e5fe2278da40cae9b9b0c3fb7/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", - "preview": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T09:05:22+00:00", - "exif": {}, - "name": "Alpaca (Moved).png", - "type": "file", - "size": 440431, - "path": "disk:/TestFolder/Alpaca (Moved).png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", - "private_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e" - }, - "mime_type": "image/png" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Original = "/Alpaca.png"; + Path = "/TestFolder/Alpaca (Moved).png"; + + Response = OPI_YandexDisk.MoveObject(Token, Original, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk MoveObject --token "y0_AgAAAABdylaOAA..." --from "/Alpaca.png" --to "/TestFolder/Alpaca (Moved).png" --rewrite %rewrite% + + +``` + + +```json title="Result" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707469557170087, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/ac927eda1a0a731aa738bf31fa798a35970b5b47c2720a198574e124f462f7d8/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T09:05:57+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/a63112c5e420fa188f83cb59424d4149d181903e5fe2278da40cae9b9b0c3fb7/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", + "preview": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T09:05:22+00:00", + "exif": {}, + "name": "Alpaca (Moved).png", + "type": "file", + "size": 440431, + "path": "disk:/TestFolder/Alpaca (Moved).png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", + "private_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e" + }, + "mime_type": "image/png" + } + +``` 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 index d6e57ad70a..17a07f5ab6 100644 --- 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 @@ -1,50 +1,50 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to place the downloaded file | - | Address | --url | String | File URL | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/Alpaca.png"; - Address = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png"; - - Response = OPI_YandexDisk.UploadFileByURL(Token, Path, Address); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk UploadFileByURL --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" --url "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png" - - -``` - - -```json title="Result" - -{ - "templated": false, - "method": "GET", - "href": "https://cloud-api.yandex.net/v1/disk/operations/b78a7ef2dd49971aa22e5e72f2e615db885da9947d7c61b2822de23a99e855a1" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to place the downloaded file | + | Address | --url | String | File URL | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/Alpaca.png"; + Address = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png"; + + Response = OPI_YandexDisk.UploadFileByURL(Token, Path, Address); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk UploadFileByURL --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" --url "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png" + + +``` + + +```json title="Result" + +{ + "templated": false, + "method": "GET", + "href": "https://cloud-api.yandex.net/v1/disk/operations/b78a7ef2dd49971aa22e5e72f2e615db885da9947d7c61b2822de23a99e855a1" + } + +``` 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 index bbb42d6aab..89d3b88acd 100644 --- 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 @@ -1,47 +1,47 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/AlpacaInFile.png"; - File = "C:\logo.png"; - - Response = OPI_YandexDisk.UploadFile(Token, Path, File); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk UploadFile --token "y0_AgAAAABdylaOAA..." --path "/AlpacaInFile.png" --file "C:\logo.png" --rewrite %rewrite% - - -``` - - -```json title="Result" - - - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/AlpacaInFile.png"; + File = "C:\logo.png"; + + Response = OPI_YandexDisk.UploadFile(Token, Path, File); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk UploadFile --token "y0_AgAAAABdylaOAA..." --path "/AlpacaInFile.png" --file "C:\logo.png" --rewrite %rewrite% + + +``` + + +```json title="Result" + + + +``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/_category_.json b/docs/en/md/Yandex_Disk/File-and-folder-management/_category_.json index e89aaebe00..78961d3156 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/_category_.json +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "File and folder management", -"position": "2" -} +{ +"label": "File and folder management", +"position": "2" +} 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 index 5490c7f9b2..af94d3f114 100644 --- 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 @@ -1,114 +1,114 @@ ---- -sidebar_position: 2 ---- - -# Unpublish object - Unpublishes a previously published object - - -*Function CancelObjectPublication(Val Token, Val Path) ExportReturn TogglePublicAccess(Token, Path, False);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the previously published object | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/Alpaca.png" - Response = OPI_YandexDisk.CancelObjectPublication(Token, Path); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk CancelObjectPublication --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" - - -``` - - -```json title="Result" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707477571749555, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/975f34b37717b6e83f8d3ff4102e45e3425dc27fe0b15f296941f40b9e42fafb/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T10:50:41+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/ab19200794efaae9cda8243cf7531ee1d1345a757e45232ce030ab3a74309dc1/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T10:50:41+00:00", - "exif": {}, - "name": "Alpaca.png", - "type": "file", - "size": 440431, - "path": "disk:/Alpaca.png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" - }, - "mime_type": "image/png" - } - -``` +--- +sidebar_position: 2 +--- + +# Unpublish object + Unpublishes a previously published object + + +*Function CancelObjectPublication(Val Token, Val Path) ExportReturn TogglePublicAccess(Token, Path, False);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the previously published object | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/Alpaca.png" + Response = OPI_YandexDisk.CancelObjectPublication(Token, Path); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk CancelObjectPublication --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" + + +``` + + +```json title="Result" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707477571749555, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/975f34b37717b6e83f8d3ff4102e45e3425dc27fe0b15f296941f40b9e42fafb/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T10:50:41+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/ab19200794efaae9cda8243cf7531ee1d1345a757e45232ce030ab3a74309dc1/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T10:50:41+00:00", + "exif": {}, + "name": "Alpaca.png", + "type": "file", + "size": 440431, + "path": "disk:/Alpaca.png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" + }, + "mime_type": "image/png" + } + +``` 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 index fc5f2f6c16..b87ec4f062 100644 --- 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 @@ -1,49 +1,49 @@ ---- -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 | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | URL | --url | String | Object address | - | Path | --path | String | Path inside the object | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" - - Response = OPI_YandexDisk.GetDownloadLinkForPublicObject(Token, URL); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetDownloadLinkForPublicObject --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --path %path% - - -``` - - -```json title="Result" - -{ - "templated": false, - "method": "GET", - "href": "https://downloader.disk.yandex.ru/disk/e43662271abc4a5afd5b2122004e702e97e20c36932d687bbca183cfee10413d/65c63eba/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=O%2BtgG9OfyuyJgwBRM%2BBJVaHN3Kg0nH8yi5xbEKU3m%2Bd8vVVsZCwR%2BLHB8oeN%2BwcTq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | URL | --url | String | Object address | + | Path | --path | String | Path inside the object | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" + + Response = OPI_YandexDisk.GetDownloadLinkForPublicObject(Token, URL); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetDownloadLinkForPublicObject --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --path %path% + + +``` + + +```json title="Result" + +{ + "templated": false, + "method": "GET", + "href": "https://downloader.disk.yandex.ru/disk/e43662271abc4a5afd5b2122004e702e97e20c36932d687bbca183cfee10413d/65c63eba/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=O%2BtgG9OfyuyJgwBRM%2BBJVaHN3Kg0nH8yi5xbEKU3m%2Bd8vVVsZCwR%2BLHB8oeN%2BwcTq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2" + } + +``` 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 index a72b26c70e..59c0707cd2 100644 --- 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 @@ -1,125 +1,125 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" - - Response = OPI_YandexDisk.GetPublicObject(Token, URL); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetPublicObject --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --amount %amount% --offset %offset% - - -``` - - -```json title="Result" - -{ - "modified": "2024-02-09T10:50:41+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/6c21ad3881d0b63ff36b4e8dac62f92bcad19123eb5089651351bfe8bf9a1ffc/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" - } - ], - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", - "name": "Alpaca.png", - "type": "file", - "media_type": "image", - "revision": 1707476320145658, - "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", - "exif": {}, - "size": 440431, - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "owner": { - "uid": "1573541518", - "display_name": "bayselonarrend", - "login": "bayselonarrend" - }, - "file": "https://downloader.disk.yandex.ru/disk/625f72fc8f1f169d498e24b1c3531b81b6e26dc742ecaed842fa527a930965ec/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "preview": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0", - "created": "2024-02-09T10:50:41+00:00", - "views_count": 1, - "path": "/", - "comment_ids": { - "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" - }, - "antivirus_status": "clean", - "mime_type": "image/png" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" + + Response = OPI_YandexDisk.GetPublicObject(Token, URL); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetPublicObject --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --amount %amount% --offset %offset% + + +``` + + +```json title="Result" + +{ + "modified": "2024-02-09T10:50:41+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/6c21ad3881d0b63ff36b4e8dac62f92bcad19123eb5089651351bfe8bf9a1ffc/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" + } + ], + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", + "name": "Alpaca.png", + "type": "file", + "media_type": "image", + "revision": 1707476320145658, + "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", + "exif": {}, + "size": 440431, + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "owner": { + "uid": "1573541518", + "display_name": "bayselonarrend", + "login": "bayselonarrend" + }, + "file": "https://downloader.disk.yandex.ru/disk/625f72fc8f1f169d498e24b1c3531b81b6e26dc742ecaed842fa527a930965ec/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "preview": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0", + "created": "2024-02-09T10:50:41+00:00", + "views_count": 1, + "path": "/", + "comment_ids": { + "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" + }, + "antivirus_status": "clean", + "mime_type": "image/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 index b411bf1b21..6b3e5ca1e7 100644 --- 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 @@ -1,193 +1,193 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - - Response = OPI_YandexDisk.GetPublishedObjectsList(Token, 2, 1); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk GetPublishedObjectsList --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% - - -``` - - -```json title="Result" - -{ - "limit": 2, - "offset": 1, - "items": [ - { - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707467847758751, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/ec7c4af09602f08ba661fb602a8e4db7c8ca13285ffbeab9d8506dff136bae19/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-08T16:17:21+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/57195ff44cc3ad6aae4f76ce041f034cbc8d2b58e39de212d8f1a2c3a699db43/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", - "preview": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "size": 440431, - "created": "2024-02-08T16:17:21+00:00", - "type": "file", - "name": "305ac06e-8d73-4d58-ae46-0ea29a7406da.png", - "exif": {}, - "public_url": "https://yadi.sk/i/E_la61R-mzUT5A", - "public_key": "NZQPwaOubeMinNBV4E6vzBEuymih3ZMAHHopRVwcS/Xu163y7YXBNfzquJP61v+5q/J6bpmRyOJonT3VoXnDag==", - "path": "disk:/305ac06e-8d73-4d58-ae46-0ea29a7406da.png", - "antivirus_status": "clean", - "mime_type": "image/png", - "comment_ids": { - "public_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", - "private_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f" - } - }, - { - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707061681378003, - "media_type": "unknown", - "file": "https://downloader.disk.yandex.ru/disk/1901f85f01b5fe49b247379130d99dd0241ceb8f29943842febf7b8da6da3f1f/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=New&disposition=attachment&hash=&limit=0&content_type=mixed&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=unknown&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-02T17:08:06+00:00", - "sizes": [ - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", - "preview": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "size": 440431, - "created": "2024-02-02T17:08:06+00:00", - "type": "file", - "name": "New", - "exif": {}, - "public_url": "https://yadi.sk/i/BpLVpspCDVp0rw", - "public_key": "jOttD+xa1Q27aw1F5pZ2cFZi6bFYThmnpmJkkbmvD1bLErfIx4L0xd2KMy430kUEq/J6bpmRyOJonT3VoXnDag==", - "path": "disk:/New", - "antivirus_status": "clean", - "mime_type": "mixed", - "comment_ids": { - "public_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", - "private_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326" - } - } - ] - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + + Response = OPI_YandexDisk.GetPublishedObjectsList(Token, 2, 1); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk GetPublishedObjectsList --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% + + +``` + + +```json title="Result" + +{ + "limit": 2, + "offset": 1, + "items": [ + { + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707467847758751, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/ec7c4af09602f08ba661fb602a8e4db7c8ca13285ffbeab9d8506dff136bae19/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-08T16:17:21+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/57195ff44cc3ad6aae4f76ce041f034cbc8d2b58e39de212d8f1a2c3a699db43/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", + "preview": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "size": 440431, + "created": "2024-02-08T16:17:21+00:00", + "type": "file", + "name": "305ac06e-8d73-4d58-ae46-0ea29a7406da.png", + "exif": {}, + "public_url": "https://yadi.sk/i/E_la61R-mzUT5A", + "public_key": "NZQPwaOubeMinNBV4E6vzBEuymih3ZMAHHopRVwcS/Xu163y7YXBNfzquJP61v+5q/J6bpmRyOJonT3VoXnDag==", + "path": "disk:/305ac06e-8d73-4d58-ae46-0ea29a7406da.png", + "antivirus_status": "clean", + "mime_type": "image/png", + "comment_ids": { + "public_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", + "private_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f" + } + }, + { + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707061681378003, + "media_type": "unknown", + "file": "https://downloader.disk.yandex.ru/disk/1901f85f01b5fe49b247379130d99dd0241ceb8f29943842febf7b8da6da3f1f/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=New&disposition=attachment&hash=&limit=0&content_type=mixed&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=unknown&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-02T17:08:06+00:00", + "sizes": [ + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", + "preview": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "size": 440431, + "created": "2024-02-02T17:08:06+00:00", + "type": "file", + "name": "New", + "exif": {}, + "public_url": "https://yadi.sk/i/BpLVpspCDVp0rw", + "public_key": "jOttD+xa1Q27aw1F5pZ2cFZi6bFYThmnpmJkkbmvD1bLErfIx4L0xd2KMy430kUEq/J6bpmRyOJonT3VoXnDag==", + "path": "disk:/New", + "antivirus_status": "clean", + "mime_type": "mixed", + "comment_ids": { + "public_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", + "private_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326" + } + } + ] + } + +``` 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 index b3a24c0453..cdb472ff7d 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md @@ -1,116 +1,116 @@ ---- -sidebar_position: 1 ---- - -# Publish object - Publishes the disk object for public access - - -*Function PublishObject(Val Token, Val Path) ExportReturn TogglePublicAccess(Token, Path, True);EndFunction* - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Token | - | Path | --path | String | Path to the object to be published | - - - Returns: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - Path = "/Alpaca.png" - Response = OPI_YandexDisk.PublishObject(Token, Path); //Map; Link to file - Response["public_url"] - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk PublishObject --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" - - -``` - - -```json title="Result" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707475863191537, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/8124011f47d668473ec5556e7aa03ed0c825d2bce0777c5f268ab3b133fa366b/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T10:50:41+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/df3f57d6fee627517405de91b959bc7585d9f1ca0afbba833a216be01699d04f/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "size": 440431, - "created": "2024-02-09T10:50:41+00:00", - "type": "file", - "name": "Alpaca.png", - "exif": {}, - "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", - "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", - "path": "disk:/Alpaca.png", - "antivirus_status": "clean", - "mime_type": "image/png", - "comment_ids": { - "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" - } - } - -``` +--- +sidebar_position: 1 +--- + +# Publish object + Publishes the disk object for public access + + +*Function PublishObject(Val Token, Val Path) ExportReturn TogglePublicAccess(Token, Path, True);EndFunction* + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Token | + | Path | --path | String | Path to the object to be published | + + + Returns: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + Path = "/Alpaca.png" + Response = OPI_YandexDisk.PublishObject(Token, Path); //Map; Link to file - Response["public_url"] + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk PublishObject --token "y0_AgAAAABdylaOAA..." --path "/Alpaca.png" + + +``` + + +```json title="Result" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707475863191537, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/8124011f47d668473ec5556e7aa03ed0c825d2bce0777c5f268ab3b133fa366b/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T10:50:41+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/df3f57d6fee627517405de91b959bc7585d9f1ca0afbba833a216be01699d04f/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "size": 440431, + "created": "2024-02-09T10:50:41+00:00", + "type": "file", + "name": "Alpaca.png", + "exif": {}, + "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", + "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", + "path": "disk:/Alpaca.png", + "antivirus_status": "clean", + "mime_type": "image/png", + "comment_ids": { + "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" + } + } + +``` 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 index 5d5d9acc7d..91ad6d559a 100644 --- 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 @@ -1,117 +1,117 @@ ---- -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 | Destination | - |-|-|-|-| - | 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: Key-Value Pair - serialized JSON response from Yandex - -```bsl title="Code example" - - - Token = "y0_AgAAAABdylaOAA..."; - URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" - - Response = OPI_YandexDisk.SavePublicObjectToDisk(Token, URL); //Map - Response = OPI_Tools.JSONString(Response); //String - - - -``` - -```sh title="CLI command example" - - oint yadisk SavePublicObjectToDisk --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --from %from% --to %to% - - -``` - - -```json title="Result" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707476319349747, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/e0c18f0f93c86c78b56f0927b8a7b2ff688cbe986c5825cb5b705f387e88ccac/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T10:58:39+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/9ad20ff719c0cc685af46a7043850faee074fd93cfbb610a9e0edbd22ec3e459/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", - "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T10:58:39+00:00", - "exif": {}, - "name": "Alpaca.png", - "type": "file", - "size": 440431, - "path": "disk:/Downloads/Alpaca.png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", - "private_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3" - }, - "mime_type": "image/png" - } - -``` +--- +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 | Destination | + |-|-|-|-| + | 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: Key-Value Pair - serialized JSON response from Yandex + +```bsl title="Code example" + + + Token = "y0_AgAAAABdylaOAA..."; + URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" + + Response = OPI_YandexDisk.SavePublicObjectToDisk(Token, URL); //Map + Response = OPI_Tools.JSONString(Response); //String + + + +``` + +```sh title="CLI command example" + + oint yadisk SavePublicObjectToDisk --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --from %from% --to %to% + + +``` + + +```json title="Result" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707476319349747, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/e0c18f0f93c86c78b56f0927b8a7b2ff688cbe986c5825cb5b705f387e88ccac/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T10:58:39+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/9ad20ff719c0cc685af46a7043850faee074fd93cfbb610a9e0edbd22ec3e459/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", + "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T10:58:39+00:00", + "exif": {}, + "name": "Alpaca.png", + "type": "file", + "size": 440431, + "path": "disk:/Downloads/Alpaca.png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", + "private_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3" + }, + "mime_type": "image/png" + } + +``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/_category_.json b/docs/en/md/Yandex_Disk/Manage-public-access/_category_.json index e47decc873..b5c4207852 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/_category_.json +++ b/docs/en/md/Yandex_Disk/Manage-public-access/_category_.json @@ -1,4 +1,4 @@ -{ -"label": "Manage public access", -"position": "3" -} +{ +"label": "Manage public access", +"position": "3" +} diff --git a/docs/en/md/Yandex_Disk/Yandex_Disk.md b/docs/en/md/Yandex_Disk/Yandex_Disk.md index f8f9a9c2b9..fa0caa0704 100644 --- a/docs/en/md/Yandex_Disk/Yandex_Disk.md +++ b/docs/en/md/Yandex_Disk/Yandex_Disk.md @@ -1,62 +1,62 @@ ---- -id: YandexDisk -sidebar_class_name: YandexDisk ---- - - - -# Яндеtowith Диwithto - -Этот раздел поwithinящен библиотеtoе for work with Яндеtowith Диwithto API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work - -## Getting started - -For of start work необходимо получить тоtoен доwithтупа to диwithtoу: - -1. Перейдите to [page withоздания приложения](https://oauth.yandex.ru/client/new/) - -![BF](../../static/img/Docs/YandexDisk/1.png) - -2. Ininедите name withерinиwithа, inыберите *Inеб-withерinиwithы* in toачеwithтinе платформы. Redirect URI можно уtoазать любой or inыбрать пунtoт *Toдwithтаinить URL for отладtoи* - for work with библиотеtoой он не поtoдобитwithя. - -![BF](../../static/img/Docs/YandexDisk/3.png) - -3. In поле *Доwithтуп to данным* добаinьте разрешения toаto to withtoриншоте ниже, after чего toжмите *Создать приложение* - -![BF](../../static/img/Docs/YandexDisk/2.png) - -4. Сохраните **ClientID** и **Client secret** withо withтраницы приложения - -![BF](../../static/img/Docs/YandexDisk/4.png) - -5. Callите фунtoцию *OPI_YandexID.GetConfirmationCode()*, передаin ClientID in toачеwithтinе параметра. Оto inернет отinет withерinера Yandex, где будут fields - - **user_code** - необходимо will ininеwithти in браузере - - **device_code** - необходимо will передать in другую фунtoцию - - **verification_url** - URL, toоторый нужно отtoрыть in браузере -
- ```json title="Result фунtoции GetConfirmationCode(), еwithли переinеwithти его in JSON" - { - "verification_url": "https://ya.ru/device", - "user_code": "gjehyruw", - "interval": 5, - "expires_in": 300, - "device_code": "12207cafec1b40ad8d0052af3faf0d12" - } - ``` - -6. Отtoройте URL from **verification_url** in барузере. Сtoорее inwithего this will https://ya.ru/device. In пояinиinшееwithя поле ininедите **user_code** from пунtoта 5 - -![BF](../../static/img/Docs/YandexDisk/5.png) - -7. Towithле ininода toода in пунtoте 6, inызоinите фунtoцию *OPI_YandexID.ConvertCodeToToken()*, передаin туда **ClientID** и **ClientSecret** from пунtoта 4, а таtoже **device_code** from пунtoта 5. Сохраните полученные **acess_token** и **refresh_token** - -```json title="Result фунtoции ConvertCodeToToken(), еwithли переinеwithти его in JSON" -{ - "token_type": "bearer", - "refresh_token": "1:Tj6nD2vgE2L8jwSm:YgWjQXPv6_y3e07GW70ig2AOyEXoRVsKKpApGHq2EOg7pfx0MKrXiCrfLBFtzgQawdawdwadad3Sasa9z2H0vSeZKNmZmA", - "expires_in": 31535956, - "access_token": "y0_AgAAAABWxxdkAAs0QgAAAAD59cawdawdwadadVKIiwGK__crw" -} -``` - -**acess_token** иwithпользуетwithя inо all оwithтальных фунtoциях libraries, а при помощи **refresh_token** его можно обноinить, toогда withроto жfromни will подходить to toонцу (при помощи фунtoции *RefreshToken()*) +--- +id: YandexDisk +sidebar_class_name: YandexDisk +--- + + + +# Яндеtowith Диwithto + +Этот раздел поwithinящен библиотеtoе for work with Яндеtowith Диwithto API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work + +## Getting started + +For of start work необходимо получить тоtoен доwithтупа to диwithtoу: + +1. Перейдите to [page withоздания приложения](https://oauth.yandex.ru/client/new/) + +![BF](../../static/img/Docs/YandexDisk/1.png) + +2. Ininедите name withерinиwithа, inыберите *Inеб-withерinиwithы* in toачеwithтinе платформы. Redirect URI можно уtoазать любой or inыбрать пунtoт *Toдwithтаinить URL for отладtoи* - for work with библиотеtoой он не поtoдобитwithя. + +![BF](../../static/img/Docs/YandexDisk/3.png) + +3. In поле *Доwithтуп to данным* добаinьте разрешения toаto to withtoриншоте ниже, after чего toжмите *Создать приложение* + +![BF](../../static/img/Docs/YandexDisk/2.png) + +4. Сохраните **ClientID** и **Client secret** withо withтраницы приложения + +![BF](../../static/img/Docs/YandexDisk/4.png) + +5. Callите фунtoцию *OPI_YandexID.GetConfirmationCode()*, передаin ClientID in toачеwithтinе параметра. Оto inернет отinет withерinера Yandex, где будут fields + - **user_code** - необходимо will ininеwithти in браузере + - **device_code** - необходимо will передать in другую фунtoцию + - **verification_url** - URL, toоторый нужно отtoрыть in браузере +
+ ```json title="Result фунtoции GetConfirmationCode(), еwithли переinеwithти его in JSON" + { + "verification_url": "https://ya.ru/device", + "user_code": "gjehyruw", + "interval": 5, + "expires_in": 300, + "device_code": "12207cafec1b40ad8d0052af3faf0d12" + } + ``` + +6. Отtoройте URL from **verification_url** in барузере. Сtoорее inwithего this will https://ya.ru/device. In пояinиinшееwithя поле ininедите **user_code** from пунtoта 5 + +![BF](../../static/img/Docs/YandexDisk/5.png) + +7. Towithле ininода toода in пунtoте 6, inызоinите фунtoцию *OPI_YandexID.ConvertCodeToToken()*, передаin туда **ClientID** и **ClientSecret** from пунtoта 4, а таtoже **device_code** from пунtoта 5. Сохраните полученные **acess_token** и **refresh_token** + +```json title="Result фунtoции ConvertCodeToToken(), еwithли переinеwithти его in JSON" +{ + "token_type": "bearer", + "refresh_token": "1:Tj6nD2vgE2L8jwSm:YgWjQXPv6_y3e07GW70ig2AOyEXoRVsKKpApGHq2EOg7pfx0MKrXiCrfLBFtzgQawdawdwadad3Sasa9z2H0vSeZKNmZmA", + "expires_in": 31535956, + "access_token": "y0_AgAAAABWxxdkAAs0QgAAAAD59cawdawdwadadVKIiwGK__crw" +} +``` + +**acess_token** иwithпользуетwithя inо all оwithтальных фунtoциях libraries, а при помощи **refresh_token** его можно обноinить, toогда withроto жfromни will подходить to toонцу (при помощи фунtoции *RefreshToken()*) diff --git a/docs/en/md/Yandex_Disk/_category_.json b/docs/en/md/Yandex_Disk/_category_.json index aab4e21605..15689fb64e 100644 --- a/docs/en/md/Yandex_Disk/_category_.json +++ b/docs/en/md/Yandex_Disk/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Yandex Disk", - "position": 13, - "link": { - "type": "doc", - "id": "YandexDisk" - } -} +{ + "label": "Yandex Disk", + "position": 13, + "link": { + "type": "doc", + "id": "YandexDisk" + } +} diff --git a/docs/ru/md/Airtable/Comment-management/Create-comment.md b/docs/ru/md/Airtable/Comment-management/Create-comment.md index c2530ee2ad..b293ab2a69 100644 --- a/docs/ru/md/Airtable/Comment-management/Create-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Create-comment.md @@ -1,59 +1,59 @@ ---- -sidebar_position: 2 ---- - -# Создать комментарий - Создает комментарий к записи в таблице - - -*Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Текст | --text | Строка | Текст комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Запись = "recV6DxeLQMBNJrUk"; - Текст = "Тестовый комментарий"; - - Ответ = OPI_Airtable.СоздатьКомментарий(Токен, База, Таблица, Запись, Текст); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable СоздатьКомментарий --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "Тестовый комментарий" - - -``` - - -```json title="Результат" - -{ - "id": "comL1oGEDJvIQlMs1", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Тестовый комментарий", - "createdTime": "2024-05-10T19:39:51.561Z", - "lastUpdatedTime": null - } - -``` +--- +sidebar_position: 2 +--- + +# Создать комментарий + Создает комментарий к записи в таблице + + +*Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Текст | --text | Строка | Текст комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Запись = "recV6DxeLQMBNJrUk"; + Текст = "Тестовый комментарий"; + + Ответ = OPI_Airtable.СоздатьКомментарий(Токен, База, Таблица, Запись, Текст); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable СоздатьКомментарий --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "Тестовый комментарий" + + +``` + + +```json title="Результат" + +{ + "id": "comL1oGEDJvIQlMs1", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Тестовый комментарий", + "createdTime": "2024-05-10T19:39:51.561Z", + "lastUpdatedTime": null + } + +``` diff --git a/docs/ru/md/Airtable/Comment-management/Delete-comment.md b/docs/ru/md/Airtable/Comment-management/Delete-comment.md index e0a491a0b1..a46435f9a2 100644 --- a/docs/ru/md/Airtable/Comment-management/Delete-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Delete-comment.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 4 ---- - -# Удалить комментарий - Удаляет комментарий к записи таблицы - - -*Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Комментарий | --comment | Строка | Идентификатор комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Запись = "recV6DxeLQMBNJrUk"; - Коммент = "comL1oGEDJvIQlMs1"; - - Ответ = OPI_Airtable.УдалитьКомментарий(Токен, База, Таблица, Запись, Коммент); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable УдалитьКомментарий --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% - - -``` - - -```json title="Результат" - -{ - "id": "comL1oGEDJvIQlMs1", - "deleted": true - } - -``` +--- +sidebar_position: 4 +--- + +# Удалить комментарий + Удаляет комментарий к записи таблицы + + +*Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Комментарий | --comment | Строка | Идентификатор комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Запись = "recV6DxeLQMBNJrUk"; + Коммент = "comL1oGEDJvIQlMs1"; + + Ответ = OPI_Airtable.УдалитьКомментарий(Токен, База, Таблица, Запись, Коммент); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable УдалитьКомментарий --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% + + +``` + + +```json title="Результат" + +{ + "id": "comL1oGEDJvIQlMs1", + "deleted": true + } + +``` diff --git a/docs/ru/md/Airtable/Comment-management/Edit-comment.md b/docs/ru/md/Airtable/Comment-management/Edit-comment.md index 852907c15b..748b4c921d 100644 --- a/docs/ru/md/Airtable/Comment-management/Edit-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Edit-comment.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 3 ---- - -# Изменить комментарий - Изменяет текст существующего комментария - - -*Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Комментарий | --comment | Строка | Идентификатор комментария | - | Текст | --text | Строка | Новый текст комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Запись = "recV6DxeLQMBNJrUk"; - Коммент = "comL1oGEDJvIQlMs1"; - Текст = "Тестовый комментарий (изм.)"; - - Ответ = OPI_Airtable.ИзменитьКомментарий(Токен, База, Таблица, Запись, Коммент, Текст); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ИзменитьКомментарий --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Тестовый комментарий (изм.)" - - -``` - - -```json title="Результат" - -{ - "id": "comL1oGEDJvIQlMs1", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Тестовый комментарий (изм.)", - "createdTime": "2024-05-10T19:39:52Z", - "lastUpdatedTime": "2024-05-10T19:39:51.967Z" - } - -``` +--- +sidebar_position: 3 +--- + +# Изменить комментарий + Изменяет текст существующего комментария + + +*Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Комментарий | --comment | Строка | Идентификатор комментария | + | Текст | --text | Строка | Новый текст комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Запись = "recV6DxeLQMBNJrUk"; + Коммент = "comL1oGEDJvIQlMs1"; + Текст = "Тестовый комментарий (изм.)"; + + Ответ = OPI_Airtable.ИзменитьКомментарий(Токен, База, Таблица, Запись, Коммент, Текст); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ИзменитьКомментарий --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Тестовый комментарий (изм.)" + + +``` + + +```json title="Результат" + +{ + "id": "comL1oGEDJvIQlMs1", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Тестовый комментарий (изм.)", + "createdTime": "2024-05-10T19:39:52Z", + "lastUpdatedTime": "2024-05-10T19:39:51.967Z" + } + +``` diff --git a/docs/ru/md/Airtable/Comment-management/Get-comments.md b/docs/ru/md/Airtable/Comment-management/Get-comments.md index 13ddd3df62..0af09b519d 100644 --- a/docs/ru/md/Airtable/Comment-management/Get-comments.md +++ b/docs/ru/md/Airtable/Comment-management/Get-comments.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 1 ---- - -# Получить комментарии - Получает список комментариев к записи в таблице - - -*Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Запись = "recV6DxeLQMBNJrUk"; - - Ответ = OPI_Airtable.ПолучитьКомментарии(Токен, База, Таблица, Запись); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьКомментарии --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset% - - -``` - - -```json title="Результат" - -{ - "comments": [ - { - "id": "comL1oGEDJvIQlMs1", - "author": { - "id": "usrFlaAHlTfYWAbVW", - "email": "bayselonarrend@gmail.com", - "name": "Антон Титовец" - }, - "text": "Тестовый комментарий (изм.)", - "createdTime": "2024-05-10T19:39:52Z", - "lastUpdatedTime": "2024-05-10T19:39:52Z" - } - ], - "offset": null - } - -``` +--- +sidebar_position: 1 +--- + +# Получить комментарии + Получает список комментариев к записи в таблице + + +*Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Запись = "recV6DxeLQMBNJrUk"; + + Ответ = OPI_Airtable.ПолучитьКомментарии(Токен, База, Таблица, Запись); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьКомментарии --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset% + + +``` + + +```json title="Результат" + +{ + "comments": [ + { + "id": "comL1oGEDJvIQlMs1", + "author": { + "id": "usrFlaAHlTfYWAbVW", + "email": "bayselonarrend@gmail.com", + "name": "Антон Титовец" + }, + "text": "Тестовый комментарий (изм.)", + "createdTime": "2024-05-10T19:39:52Z", + "lastUpdatedTime": "2024-05-10T19:39:52Z" + } + ], + "offset": null + } + +``` diff --git a/docs/ru/md/Airtable/Database-work/Create-database.md b/docs/ru/md/Airtable/Database-work/Create-database.md index 1577efc9a2..ff4f719c5c 100644 --- a/docs/ru/md/Airtable/Database-work/Create-database.md +++ b/docs/ru/md/Airtable/Database-work/Create-database.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 3 ---- - -# Создать базу - Создает новую базу данных - - -*Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | РабочееПространство | --ws | Строка | Идентификатор рабочего пространства | - | Наименование | --title | Строка | Наименование новой базы | - | КоллекцияТаблиц | --tablesdata | Соответствие Из КлючИЗначение | Описание таблиц: Ключ > имя, Значение > массив полей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - РабочееПространство = "wspdf8yl1yZz3PmWZ"; - Наименование = "Тестовая база"; - - МассивПолей = Новый Массив; - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); - - ИмяТаблицы = "Тестовая таблица"; - - КоллекцияТаблиц = Новый Соответствие; - КоллекцияТаблиц.Вставить(ИмяТаблицы, МассивПолей); - - Ответ = OPI_Airtable.СоздатьБазу(Токен, РабочееПространство, Наименование, КоллекцияТаблиц); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable СоздатьБазу --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "Тестовая база" --tablesdata %tablesdata% - - -``` - - -```json title="Результат" - -{ - "id": "applEsyJmBRm12AuN", - "tables": [ - { - "id": "tblqZzW78Rvsdt9gt", - "name": "Тестовая таблица", - "primaryFieldId": "fldj9Z3fEpLzv40d0", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldj9Z3fEpLzv40d0", - "name": "Номер" - }, - { - "type": "richText", - "id": "fldX1kR7lienmcdEj", - "name": "Строковое" - } - ], - "views": [ - { - "id": "viwbKE3PS9jl6bqJl", - "name": "Grid view", - "type": "grid" - } - ] - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Создать базу + Создает новую базу данных + + +*Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | РабочееПространство | --ws | Строка | Идентификатор рабочего пространства | + | Наименование | --title | Строка | Наименование новой базы | + | КоллекцияТаблиц | --tablesdata | Соответствие Из КлючИЗначение | Описание таблиц: Ключ > имя, Значение > массив полей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + РабочееПространство = "wspdf8yl1yZz3PmWZ"; + Наименование = "Тестовая база"; + + МассивПолей = Новый Массив; + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); + + ИмяТаблицы = "Тестовая таблица"; + + КоллекцияТаблиц = Новый Соответствие; + КоллекцияТаблиц.Вставить(ИмяТаблицы, МассивПолей); + + Ответ = OPI_Airtable.СоздатьБазу(Токен, РабочееПространство, Наименование, КоллекцияТаблиц); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable СоздатьБазу --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "Тестовая база" --tablesdata %tablesdata% + + +``` + + +```json title="Результат" + +{ + "id": "applEsyJmBRm12AuN", + "tables": [ + { + "id": "tblqZzW78Rvsdt9gt", + "name": "Тестовая таблица", + "primaryFieldId": "fldj9Z3fEpLzv40d0", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldj9Z3fEpLzv40d0", + "name": "Номер" + }, + { + "type": "richText", + "id": "fldX1kR7lienmcdEj", + "name": "Строковое" + } + ], + "views": [ + { + "id": "viwbKE3PS9jl6bqJl", + "name": "Grid view", + "type": "grid" + } + ] + } + ] + } + +``` diff --git a/docs/ru/md/Airtable/Database-work/Get-database-tables.md b/docs/ru/md/Airtable/Database-work/Get-database-tables.md index 2394a6d117..212c60e552 100644 --- a/docs/ru/md/Airtable/Database-work/Get-database-tables.md +++ b/docs/ru/md/Airtable/Database-work/Get-database-tables.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 2 ---- - -# Получить таблицы базы - Получает схему таблиц базы - - -*Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - - Ответ = OPI_Airtable.ПолучитьТаблицыБазы(Токен, База); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьТаблицыБазы --token %token% --base "apptm8Xqo7TwMaipQ" - - -``` - - -```json title="Результат" - -{ - "tables": [ - { - "id": "tblqZzW78Rvsdt9gt", - "name": "Тестовая таблица", - "primaryFieldId": "fldj9Z3fEpLzv40d0", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldj9Z3fEpLzv40d0", - "name": "Номер" - }, - { - "type": "richText", - "id": "fldX1kR7lienmcdEj", - "name": "Строковое" - } - ], - "views": [ - { - "id": "viwbKE3PS9jl6bqJl", - "name": "Grid view", - "type": "grid" - } - ] - } - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Получить таблицы базы + Получает схему таблиц базы + + +*Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + + Ответ = OPI_Airtable.ПолучитьТаблицыБазы(Токен, База); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьТаблицыБазы --token %token% --base "apptm8Xqo7TwMaipQ" + + +``` + + +```json title="Результат" + +{ + "tables": [ + { + "id": "tblqZzW78Rvsdt9gt", + "name": "Тестовая таблица", + "primaryFieldId": "fldj9Z3fEpLzv40d0", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldj9Z3fEpLzv40d0", + "name": "Номер" + }, + { + "type": "richText", + "id": "fldX1kR7lienmcdEj", + "name": "Строковое" + } + ], + "views": [ + { + "id": "viwbKE3PS9jl6bqJl", + "name": "Grid view", + "type": "grid" + } + ] + } + ] + } + +``` diff --git a/docs/ru/md/Airtable/Database-work/Get-list-of-bases.md b/docs/ru/md/Airtable/Database-work/Get-list-of-bases.md index 773ad8090e..746795bdd2 100644 --- a/docs/ru/md/Airtable/Database-work/Get-list-of-bases.md +++ b/docs/ru/md/Airtable/Database-work/Get-list-of-bases.md @@ -1,90 +1,90 @@ ---- -sidebar_position: 1 ---- - -# Получить список баз - Получает список доступных баз - - -*Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Отступ | --offset | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - - Ответ = OPI_Airtable.ПолучитьСписокБаз(Токен); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьСписокБаз --token %token% --offset %offset% - - -``` - - -```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" - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Получить список баз + Получает список доступных баз + + +*Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Отступ | --offset | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + + Ответ = OPI_Airtable.ПолучитьСписокБаз(Токен); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьСписокБаз --token %token% --offset %offset% + + +``` + + +```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" + } + ] + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Create-field.md b/docs/ru/md/Airtable/Field-work/Create-field.md index bffe5518f5..8f813da2b7 100644 --- a/docs/ru/md/Airtable/Field-work/Create-field.md +++ b/docs/ru/md/Airtable/Field-work/Create-field.md @@ -1,55 +1,55 @@ ---- -sidebar_position: 1 ---- - -# Создать поле - Создет новое поле в таблице - - -*Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - | Таблица | --table | Строка | Идентификатор таблицы | - | СтруктураПоля | --fielddata | Структура Из КлючИЗначение | Описание нового поля | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Имя = Строка(Новый УникальныйИдентификатор); - Поле = OPI_Airtable.ПолучитьПолеНомера(Имя); - - Ответ = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, СтруктураПоля); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable СоздатьПоле --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata% - - -``` - - -```json title="Результат" - -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld3IbFtHZtBHQwsk", - "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать поле + Создет новое поле в таблице + + +*Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Таблица | --table | Строка | Идентификатор таблицы | + | СтруктураПоля | --fielddata | Структура Из КлючИЗначение | Описание нового поля | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Имя = Строка(Новый УникальныйИдентификатор); + Поле = OPI_Airtable.ПолучитьПолеНомера(Имя); + + Ответ = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, СтруктураПоля); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable СоздатьПоле --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata% + + +``` + + +```json title="Результат" + +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld3IbFtHZtBHQwsk", + "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-attachment-field.md b/docs/ru/md/Airtable/Field-work/Get-attachment-field.md index 18eebb5316..ef92b86faa 100644 --- a/docs/ru/md/Airtable/Field-work/Get-attachment-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-attachment-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Получить поле (файл) - Получает описание поля файлового типа - - -*Функция ПолучитьПолеВложения(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "multipleAttachments");КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Вложение"; - - Ответ = OPI_Airtable.ПолучитьПолеВложения(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеВложения --title "Вложение" - - -``` - - -```json title="Результат" - -{ - "name": "Вложение", - "type": "multipleAttachments" - } - -``` +--- +sidebar_position: 5 +--- + +# Получить поле (файл) + Получает описание поля файлового типа + + +*Функция ПолучитьПолеВложения(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "multipleAttachments");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Вложение"; + + Ответ = OPI_Airtable.ПолучитьПолеВложения(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеВложения --title "Вложение" + + +``` + + +```json title="Результат" + +{ + "name": "Вложение", + "type": "multipleAttachments" + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-checkbox-field.md b/docs/ru/md/Airtable/Field-work/Get-checkbox-field.md index 18bbe09946..5fb25a1027 100644 --- a/docs/ru/md/Airtable/Field-work/Get-checkbox-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-checkbox-field.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 6 ---- - -# Получить поле (флажок) - Получает описание поля типа булево - - -*Функция ПолучитьПолеФлажка(Знач Наименование) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Флажок"; - - Ответ = OPI_Airtable.ПолучитьПолеФлажка(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеФлажка --title "Флажок" - - -``` - - -```json title="Результат" - -{ - "name": "Флажок", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } - } - -``` +--- +sidebar_position: 6 +--- + +# Получить поле (флажок) + Получает описание поля типа булево + + +*Функция ПолучитьПолеФлажка(Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Флажок"; + + Ответ = OPI_Airtable.ПолучитьПолеФлажка(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеФлажка --title "Флажок" + + +``` + + +```json title="Результат" + +{ + "name": "Флажок", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-date-field.md b/docs/ru/md/Airtable/Field-work/Get-date-field.md index df6fb4722d..0ab7929349 100644 --- a/docs/ru/md/Airtable/Field-work/Get-date-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-date-field.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 7 ---- - -# Получить поле (дата) - Получает описание поля типа дата - - -*Функция ПолучитьПолеДаты(Знач Наименование) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Дата"; - - Ответ = OPI_Airtable.ПолучитьПолеДаты(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеДаты --title "Дата" - - -``` - - -```json title="Результат" - -{ - "name": "Дата", - "type": "date", - "options": { - "dateFormat": { - "format": "YYYY-MM-DD", - "name": "iso" - } - } - } - -``` +--- +sidebar_position: 7 +--- + +# Получить поле (дата) + Получает описание поля типа дата + + +*Функция ПолучитьПолеДаты(Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Дата"; + + Ответ = OPI_Airtable.ПолучитьПолеДаты(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеДаты --title "Дата" + + +``` + + +```json title="Результат" + +{ + "name": "Дата", + "type": "date", + "options": { + "dateFormat": { + "format": "YYYY-MM-DD", + "name": "iso" + } + } + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-email-field.md b/docs/ru/md/Airtable/Field-work/Get-email-field.md index d4bb774c9c..ed522ed869 100644 --- a/docs/ru/md/Airtable/Field-work/Get-email-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-email-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 8 ---- - -# Получить поле (email) - Получает описание поля с электронной почтой - - -*Функция ПолучитьПолеПочты(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "email");КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Почта"; - - Ответ = OPI_Airtable.ПолучитьПолеПочты(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеПочты --title "Почта" - - -``` - - -```json title="Результат" - -{ - "name": "Почта", - "type": "email" - } - -``` +--- +sidebar_position: 8 +--- + +# Получить поле (email) + Получает описание поля с электронной почтой + + +*Функция ПолучитьПолеПочты(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "email");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Почта"; + + Ответ = OPI_Airtable.ПолучитьПолеПочты(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеПочты --title "Почта" + + +``` + + +```json title="Результат" + +{ + "name": "Почта", + "type": "email" + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-link-field.md b/docs/ru/md/Airtable/Field-work/Get-link-field.md index 37cea05229..432fcbaaec 100644 --- a/docs/ru/md/Airtable/Field-work/Get-link-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-link-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 10 ---- - -# Получить поле (url) - Получает описание поля с URL - - -*Функция ПолучитьПолеСсылки(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "url");КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Ссылка"; - - Ответ = OPI_Airtable.ПолучитьПолеСсылки(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеСсылки --title "Ссылка" - - -``` - - -```json title="Результат" - -{ - "name": "Ссылка", - "type": "url" - } - -``` +--- +sidebar_position: 10 +--- + +# Получить поле (url) + Получает описание поля с URL + + +*Функция ПолучитьПолеСсылки(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "url");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Ссылка"; + + Ответ = OPI_Airtable.ПолучитьПолеСсылки(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеСсылки --title "Ссылка" + + +``` + + +```json title="Результат" + +{ + "name": "Ссылка", + "type": "url" + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-number-field.md b/docs/ru/md/Airtable/Field-work/Get-number-field.md index b4e8caddae..b65205014a 100644 --- a/docs/ru/md/Airtable/Field-work/Get-number-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-number-field.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 4 ---- - -# Получить поле (числовое) - Получает описание поля числового типа - - -*Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование нового поля | - | Точность | --precision | Число,Строка | Число знаков после запятой | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Номер"; - Точность = "0"; - - Ответ = OPI_Airtable.ПолучитьПолеНомера(Наименование, Точность); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеНомера --title "Номер" --precision "0" - - -``` - - -```json title="Результат" - -{ - "name": "Номер", - "type": "number", - "options": { - "precision": 0 - } - } - -``` +--- +sidebar_position: 4 +--- + +# Получить поле (числовое) + Получает описание поля числового типа + + +*Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование нового поля | + | Точность | --precision | Число,Строка | Число знаков после запятой | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Номер"; + Точность = "0"; + + Ответ = OPI_Airtable.ПолучитьПолеНомера(Наименование, Точность); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеНомера --title "Номер" --precision "0" + + +``` + + +```json title="Результат" + +{ + "name": "Номер", + "type": "number", + "options": { + "precision": 0 + } + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-phone-field.md b/docs/ru/md/Airtable/Field-work/Get-phone-field.md index 5eeb611106..2ab198848b 100644 --- a/docs/ru/md/Airtable/Field-work/Get-phone-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-phone-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 9 ---- - -# Получить поле (телефон) - Получает описание поля с номером телефона - - -*Функция ПолучитьПолеТелефона(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "phoneNumber");КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Телефон"; - - Ответ = OPI_Airtable.ПолучитьПолеТелефона(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеТелефона --title "Телефон" - - -``` - - -```json title="Результат" - -{ - "name": "Телефон", - "type": "phoneNumber" - } - -``` +--- +sidebar_position: 9 +--- + +# Получить поле (телефон) + Получает описание поля с номером телефона + + +*Функция ПолучитьПолеТелефона(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "phoneNumber");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Телефон"; + + Ответ = OPI_Airtable.ПолучитьПолеТелефона(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеТелефона --title "Телефон" + + +``` + + +```json title="Результат" + +{ + "name": "Телефон", + "type": "phoneNumber" + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Get-string-field.md b/docs/ru/md/Airtable/Field-work/Get-string-field.md index 57a692933c..eb996383cb 100644 --- a/docs/ru/md/Airtable/Field-work/Get-string-field.md +++ b/docs/ru/md/Airtable/Field-work/Get-string-field.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 3 ---- - -# Получить поле (строковое) - Получает описание поля строкового типа - - -*Функция ПолучитьПолеСтроковое(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "richText");КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование нового поля | - - - Возвращаемое значение: Структура - Описание поля - -```bsl title="Пример кода" - - - Наименование = "Строковое"; - - Ответ = OPI_Airtable.ПолучитьПолеСтроковое(Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьПолеСтроковое --title "Строковое" - - -``` - - -```json title="Результат" - -{ - "name": "Строковое", - "type": "richText" - } - -``` +--- +sidebar_position: 3 +--- + +# Получить поле (строковое) + Получает описание поля строкового типа + + +*Функция ПолучитьПолеСтроковое(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "richText");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование нового поля | + + + Возвращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + Наименование = "Строковое"; + + Ответ = OPI_Airtable.ПолучитьПолеСтроковое(Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьПолеСтроковое --title "Строковое" + + +``` + + +```json title="Результат" + +{ + "name": "Строковое", + "type": "richText" + } + +``` diff --git a/docs/ru/md/Airtable/Field-work/Modify-field.md b/docs/ru/md/Airtable/Field-work/Modify-field.md index aa1675ce4e..ac62b3aac2 100644 --- a/docs/ru/md/Airtable/Field-work/Modify-field.md +++ b/docs/ru/md/Airtable/Field-work/Modify-field.md @@ -1,59 +1,59 @@ ---- -sidebar_position: 2 ---- - -# Изменить поле - Изменяет имя и|или описание существующего поля таблицы - - -*Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы База | - | Таблица | --table | Строка | Идентификатор таблицы | - | Поле | --field | Строка | Идентификатор поля | - | Наименование | --title | Строка | Новое наименование | - | Описание | --description | Строка | Новое описание | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Поле = "fld3IbFtHZtBHQwsk"; - Наименование = Строка(Новый УникальныйИдентификатор) + "(изм.)"; - Описание = "Новое описание"; - - Ответ = OPI_Airtable.ИзменитьПоле(Токен, База, Таблица, Поле, Наименование, Описание); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ИзменитьПоле --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "Новое описание" - - -``` - - -```json title="Результат" - -{ - "type": "number", - "options": { - "precision": 0 - }, - "id": "fld3IbFtHZtBHQwsk", - "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(изм.)", - "description": "Новое описание" - } - -``` +--- +sidebar_position: 2 +--- + +# Изменить поле + Изменяет имя и|или описание существующего поля таблицы + + +*Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы База | + | Таблица | --table | Строка | Идентификатор таблицы | + | Поле | --field | Строка | Идентификатор поля | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Поле = "fld3IbFtHZtBHQwsk"; + Наименование = Строка(Новый УникальныйИдентификатор) + "(изм.)"; + Описание = "Новое описание"; + + Ответ = OPI_Airtable.ИзменитьПоле(Токен, База, Таблица, Поле, Наименование, Описание); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ИзменитьПоле --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "Новое описание" + + +``` + + +```json title="Результат" + +{ + "type": "number", + "options": { + "precision": 0 + }, + "id": "fld3IbFtHZtBHQwsk", + "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(изм.)", + "description": "Новое описание" + } + +``` diff --git a/docs/ru/md/Airtable/Record-management/Create-posts.md b/docs/ru/md/Airtable/Record-management/Create-posts.md index c01d2078e5..c8f580f39f 100644 --- a/docs/ru/md/Airtable/Record-management/Create-posts.md +++ b/docs/ru/md/Airtable/Record-management/Create-posts.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 3 ---- - -# Создать записи - Создает одну или массив записей по описанию или массиву описаний значений полей - - -*Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Данные | --data | Структура, Массив из Структура | Набор или массив наборов пар Ключ : Значение > Поле : Показатель | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Числовой = 10; - Строчный = "Привет"; - - ОписаниеСтроки1 = Новый Структура("Номер,Строковое", Числовой, Строчный); - ОписаниеСтроки2 = Новый Структура("Номер,Строковое", Числовой, Строчный); - - Данные = Новый Массив; - Данные.Добавить(ОписаниеСтроки1); - Данные.Добавить(ОписаниеСтроки2); - - Ответ = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, Данные); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable СоздатьЗаписи --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data% - - -``` - - -```json title="Результат" - -{ - "records": [ - { - "id": "recjHNKNZBWLZkZ7A", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - }, - { - "id": "recGyJ0MlN1H3GMuN", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Создать записи + Создает одну или массив записей по описанию или массиву описаний значений полей + + +*Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Данные | --data | Структура, Массив из Структура | Набор или массив наборов пар Ключ : Значение > Поле : Показатель | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Числовой = 10; + Строчный = "Привет"; + + ОписаниеСтроки1 = Новый Структура("Номер,Строковое", Числовой, Строчный); + ОписаниеСтроки2 = Новый Структура("Номер,Строковое", Числовой, Строчный); + + Данные = Новый Массив; + Данные.Добавить(ОписаниеСтроки1); + Данные.Добавить(ОписаниеСтроки2); + + Ответ = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, Данные); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable СоздатьЗаписи --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data% + + +``` + + +```json title="Результат" + +{ + "records": [ + { + "id": "recjHNKNZBWLZkZ7A", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } + }, + { + "id": "recGyJ0MlN1H3GMuN", + "createdTime": "2024-05-10T19:39:51Z", + "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 index fb20e077ae..705e843468 100644 --- a/docs/ru/md/Airtable/Record-management/Delete-posts.md +++ b/docs/ru/md/Airtable/Record-management/Delete-posts.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 4 ---- - -# Удалить записи - Удаляет одну или массив записей по идентификаторам - - -*Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Записи | --records | Строка, Массив из Строка | Идентификатор или массив индентификаторов записей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - - Записи = Новый Массив; - Записи.Добавить("recjHNKNZBWLZkZ7A"); - Записи.Добавить("recGyJ0MlN1H3GMuN"); - - Ответ = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Запись); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable УдалитьЗаписи --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records% - - -``` - - -```json title="Результат" - -{ - "records": [ - { - "deleted": true, - "id": "recjHNKNZBWLZkZ7A" - }, - { - "deleted": true, - "id": "recGyJ0MlN1H3GMuN" - } - ] - } - -``` +--- +sidebar_position: 4 +--- + +# Удалить записи + Удаляет одну или массив записей по идентификаторам + + +*Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Записи | --records | Строка, Массив из Строка | Идентификатор или массив индентификаторов записей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + + Записи = Новый Массив; + Записи.Добавить("recjHNKNZBWLZkZ7A"); + Записи.Добавить("recGyJ0MlN1H3GMuN"); + + Ответ = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Запись); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable УдалитьЗаписи --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records% + + +``` + + +```json title="Результат" + +{ + "records": [ + { + "deleted": true, + "id": "recjHNKNZBWLZkZ7A" + }, + { + "deleted": true, + "id": "recGyJ0MlN1H3GMuN" + } + ] + } + +``` 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 index d71a7cb5c1..bf6f9e7275 100644 --- a/docs/ru/md/Airtable/Record-management/Get-list-of-records.md +++ b/docs/ru/md/Airtable/Record-management/Get-list-of-records.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 1 ---- - -# Получить список записей - Получает список записей выбранной таблицы - - -*Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - - Ответ = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица, Отступ); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьСписокЗаписей --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset% - - -``` - - -```json title="Результат" - -{ - "records": [ - { - "id": "recGyJ0MlN1H3GMuN", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - }, - { - "id": "recV6DxeLQMBNJrUk", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - }, - { - "id": "recjHNKNZBWLZkZ7A", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Получить список записей + Получает список записей выбранной таблицы + + +*Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + + Ответ = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица, Отступ); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьСписокЗаписей --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset% + + +``` + + +```json title="Результат" + +{ + "records": [ + { + "id": "recGyJ0MlN1H3GMuN", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } + }, + { + "id": "recV6DxeLQMBNJrUk", + "createdTime": "2024-05-10T19:39:51Z", + "fields": { + "Номер": 10, + "Строковое": "Привет\n" + } + }, + { + "id": "recjHNKNZBWLZkZ7A", + "createdTime": "2024-05-10T19:39:51Z", + "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 index 6f8d33aea0..07bd2b79d2 100644 --- a/docs/ru/md/Airtable/Record-management/Get-record.md +++ b/docs/ru/md/Airtable/Record-management/Get-record.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 2 ---- - -# Получить запись - Получает данные строки таблицы по идентификатору - - -*Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы данных | - | Таблица | --table | Строка | Идентификатор таблицы | - | Запись | --record | Строка | Идентификатор записи в таблице | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Запись = "recV6DxeLQMBNJrUk"; - - Ответ = OPI_Airtable.ПолучитьЗапись(Токен, База, Таблица, Запись); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ПолучитьЗапись --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" - - -``` - - -```json title="Результат" - -{ - "id": "recV6DxeLQMBNJrUk", - "createdTime": "2024-05-10T19:39:51Z", - "fields": { - "Номер": 10, - "Строковое": "Привет\n" - } - } - -``` +--- +sidebar_position: 2 +--- + +# Получить запись + Получает данные строки таблицы по идентификатору + + +*Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Запись = "recV6DxeLQMBNJrUk"; + + Ответ = OPI_Airtable.ПолучитьЗапись(Токен, База, Таблица, Запись); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ПолучитьЗапись --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" + + +``` + + +```json title="Результат" + +{ + "id": "recV6DxeLQMBNJrUk", + "createdTime": "2024-05-10T19:39:51Z", + "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 index 7a7f29f25d..ef7a23fa7a 100644 --- a/docs/ru/md/Airtable/Table-management/Create-table.md +++ b/docs/ru/md/Airtable/Table-management/Create-table.md @@ -1,128 +1,128 @@ ---- -sidebar_position: 1 ---- - -# Создать таблицу - Создает новую таблицу в базе - - -*Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - | Наименование | --title | Строка | Наименование новой таблицы | - | МассивПолей | --fieldsdata | Массив Из Структура | Массив описаний полей | - | Описание | --description | Строка | Описание таблицы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - ИмяТаблицы = "Тестовая таблица 2"; - Описание = "Новая таблица"; - - МассивПолей = Новый Массив; - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеВложения("Вложение")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеФлажка("Флажок")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеДаты("Дата")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеТелефона("Телефон")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеПочты("Почта")); - МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСсылки("Ссылка")); - - Ответ = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable СоздатьТаблицу --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "Новая таблица" - - -``` - - -```json title="Результат" - -{ - "id": "tblT64aWyrMUAbUmF", - "name": "Тестовая таблица 2", - "description": "Новая таблица", - "primaryFieldId": "fldoHs3kv6RLc8pjo", - "fields": [ - { - "type": "number", - "options": { - "precision": 0 - }, - "id": "fldoHs3kv6RLc8pjo", - "name": "Номер" - }, - { - "type": "richText", - "id": "fldzY5xRHDY7ClKxa", - "name": "Строковое" - }, - { - "type": "multipleAttachments", - "options": { - "isReversed": false - }, - "id": "fldYHxxXPALKl3yHp", - "name": "Вложение" - }, - { - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - }, - "id": "fldRUoggUObfqckXh", - "name": "Флажок" - }, - { - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - }, - "id": "fldvtwjapJM7s99nN", - "name": "Дата" - }, - { - "type": "phoneNumber", - "id": "flda4VY8dVd2mbqz9", - "name": "Телефон" - }, - { - "type": "email", - "id": "fld8ZLKndqBIkT72s", - "name": "Почта" - }, - { - "type": "url", - "id": "fldqjsCp1c2KaAS53", - "name": "Ссылка" - } - ], - "views": [ - { - "id": "viwX3vEGO5vB2Km4k", - "name": "Grid view", - "type": "grid" - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Создать таблицу + Создает новую таблицу в базе + + +*Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Наименование | --title | Строка | Наименование новой таблицы | + | МассивПолей | --fieldsdata | Массив Из Структура | Массив описаний полей | + | Описание | --description | Строка | Описание таблицы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + ИмяТаблицы = "Тестовая таблица 2"; + Описание = "Новая таблица"; + + МассивПолей = Новый Массив; + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеВложения("Вложение")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеФлажка("Флажок")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеДаты("Дата")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеТелефона("Телефон")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеПочты("Почта")); + МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСсылки("Ссылка")); + + Ответ = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable СоздатьТаблицу --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "Новая таблица" + + +``` + + +```json title="Результат" + +{ + "id": "tblT64aWyrMUAbUmF", + "name": "Тестовая таблица 2", + "description": "Новая таблица", + "primaryFieldId": "fldoHs3kv6RLc8pjo", + "fields": [ + { + "type": "number", + "options": { + "precision": 0 + }, + "id": "fldoHs3kv6RLc8pjo", + "name": "Номер" + }, + { + "type": "richText", + "id": "fldzY5xRHDY7ClKxa", + "name": "Строковое" + }, + { + "type": "multipleAttachments", + "options": { + "isReversed": false + }, + "id": "fldYHxxXPALKl3yHp", + "name": "Вложение" + }, + { + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + }, + "id": "fldRUoggUObfqckXh", + "name": "Флажок" + }, + { + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + }, + "id": "fldvtwjapJM7s99nN", + "name": "Дата" + }, + { + "type": "phoneNumber", + "id": "flda4VY8dVd2mbqz9", + "name": "Телефон" + }, + { + "type": "email", + "id": "fld8ZLKndqBIkT72s", + "name": "Почта" + }, + { + "type": "url", + "id": "fldqjsCp1c2KaAS53", + "name": "Ссылка" + } + ], + "views": [ + { + "id": "viwX3vEGO5vB2Km4k", + "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 index 5101606ee4..0cae06216e 100644 --- a/docs/ru/md/Airtable/Table-management/Modify-table.md +++ b/docs/ru/md/Airtable/Table-management/Modify-table.md @@ -1,119 +1,119 @@ ---- -sidebar_position: 2 ---- - -# Изменить таблицу - Изменяет наименование и|или описание базы - - -*Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | Идентификатор базы | - | Таблица | --table | Строка | Идентификатор таблицы | - | Наименование | --title | Строка | Новое наименование | - | Описание | --description | Строка | Новое описание | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable - -```bsl title="Пример кода" - - - База = "apptm8Xqo7TwMaipQ"; - Таблица = "tbl9G4jVoTJpxYwSY"; - Наименование = "Тестовая таблица 2 (изм.)"; - Описание = "Новая таблица (изм.)"; - - Ответ = OPI_Airtable.ИзменитьТаблицу(Токен, База, Таблица, Наименование, Описание); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint airtable ИзменитьТаблицу --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Тестовая таблица 2 (изм.)" --description "Новая таблица (изм.)" - - -``` - - -```json title="Результат" - -{ - "id": "tblT64aWyrMUAbUmF", - "name": "Тестовая таблица 2 (изм.)", - "description": "Новая таблица (изм.)", - "primaryFieldId": "fldoHs3kv6RLc8pjo", - "fields": [ - { - "id": "fldoHs3kv6RLc8pjo", - "name": "Номер", - "type": "number", - "options": { - "precision": 0 - } - }, - { - "id": "fldzY5xRHDY7ClKxa", - "name": "Строковое", - "type": "richText" - }, - { - "id": "fldYHxxXPALKl3yHp", - "name": "Вложение", - "type": "multipleAttachments", - "options": { - "isReversed": false - } - }, - { - "id": "fldRUoggUObfqckXh", - "name": "Флажок", - "type": "checkbox", - "options": { - "icon": "check", - "color": "yellowBright" - } - }, - { - "id": "fldvtwjapJM7s99nN", - "name": "Дата", - "type": "date", - "options": { - "dateFormat": { - "name": "iso", - "format": "YYYY-MM-DD" - } - } - }, - { - "id": "flda4VY8dVd2mbqz9", - "name": "Телефон", - "type": "phoneNumber" - }, - { - "id": "fld8ZLKndqBIkT72s", - "name": "Почта", - "type": "email" - }, - { - "id": "fldqjsCp1c2KaAS53", - "name": "Ссылка", - "type": "url" - } - ], - "views": [ - { - "id": "viwX3vEGO5vB2Km4k", - "name": "Grid view", - "type": "grid" - } - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Изменить таблицу + Изменяет наименование и|или описание базы + + +*Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Таблица | --table | Строка | Идентификатор таблицы | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + База = "apptm8Xqo7TwMaipQ"; + Таблица = "tbl9G4jVoTJpxYwSY"; + Наименование = "Тестовая таблица 2 (изм.)"; + Описание = "Новая таблица (изм.)"; + + Ответ = OPI_Airtable.ИзменитьТаблицу(Токен, База, Таблица, Наименование, Описание); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint airtable ИзменитьТаблицу --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Тестовая таблица 2 (изм.)" --description "Новая таблица (изм.)" + + +``` + + +```json title="Результат" + +{ + "id": "tblT64aWyrMUAbUmF", + "name": "Тестовая таблица 2 (изм.)", + "description": "Новая таблица (изм.)", + "primaryFieldId": "fldoHs3kv6RLc8pjo", + "fields": [ + { + "id": "fldoHs3kv6RLc8pjo", + "name": "Номер", + "type": "number", + "options": { + "precision": 0 + } + }, + { + "id": "fldzY5xRHDY7ClKxa", + "name": "Строковое", + "type": "richText" + }, + { + "id": "fldYHxxXPALKl3yHp", + "name": "Вложение", + "type": "multipleAttachments", + "options": { + "isReversed": false + } + }, + { + "id": "fldRUoggUObfqckXh", + "name": "Флажок", + "type": "checkbox", + "options": { + "icon": "check", + "color": "yellowBright" + } + }, + { + "id": "fldvtwjapJM7s99nN", + "name": "Дата", + "type": "date", + "options": { + "dateFormat": { + "name": "iso", + "format": "YYYY-MM-DD" + } + } + }, + { + "id": "flda4VY8dVd2mbqz9", + "name": "Телефон", + "type": "phoneNumber" + }, + { + "id": "fld8ZLKndqBIkT72s", + "name": "Почта", + "type": "email" + }, + { + "id": "fldqjsCp1c2KaAS53", + "name": "Ссылка", + "type": "url" + } + ], + "views": [ + { + "id": "viwX3vEGO5vB2Km4k", + "name": "Grid view", + "type": "grid" + } + ] + } + +``` 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 index e8a755bae5..8f421767d3 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Получить информацию об аккаунте - Получает информацию об аккаунте - - -*Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Аккаунт | --account | Строка | ID аккаунта. Текущий аккаунт токена, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьИнформациюОбАккаунте --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account% - - -``` - - -```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" - } -} - -``` +--- +sidebar_position: 4 +--- + +# Получить информацию об аккаунте + Получает информацию об аккаунте + + +*Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Аккаунт | --account | Строка | ID аккаунта. Текущий аккаунт токена, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьИнформациюОбАккаунте --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account% + + +``` + + +```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 index 67e5342130..0d2664b295 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md @@ -1,38 +1,38 @@ ---- -sidebar_position: 1 ---- - -# Получить ссылку авторизации - Генерирует ссылку авторизации для перехода в браузере - - -*Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | КлючПриложения | --appkey | Строка | Ключ приложения | - - - Возвращаемое значение: Строка - URL для перехода в браузере - -```bsl title="Пример кода" - - КлючПриложения = "oynqxds..."; - Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(КлючПриложения); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьСсылкуАвторизации --appkey "oynqxds..." - - -``` - - -```json title="Результат" - -"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" - -``` +--- +sidebar_position: 1 +--- + +# Получить ссылку авторизации + Генерирует ссылку авторизации для перехода в браузере + + +*Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + + + Возвращаемое значение: Строка - URL для перехода в браузере + +```bsl title="Пример кода" + + КлючПриложения = "oynqxds..."; + Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(КлючПриложения); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьСсылкуАвторизации --appkey "oynqxds..." + + +``` + + +```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 index 12493b142a..4fec6e2e41 100644 --- 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 @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Получить данные использования пространства - Получает информацию о количестве использованного дискового пространства - - -*Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьДанныеИспользованияПространства --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." - - -``` - - -```json title="Результат" - -{ - "used": 1477493597, - "allocation": { - ".tag": "individual", - "allocated": 2147483648 - } -} - -``` +--- +sidebar_position: 5 +--- + +# Получить данные использования пространства + Получает информацию о количестве использованного дискового пространства + + +*Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьДанныеИспользованияПространства --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." + + +``` + + +```json title="Результат" + +{ + "used": 1477493597, + "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 index 923406fc91..daa60b763f 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 2 ---- - -# Получить токен - Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации - - -*Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | КлючПриложения | --appkey | Строка | Ключ приложения | - | СекретПриложения | --appsecret | Строка | Секрет приложения | - | Код | --code | Строка | Код со страницы авторизации | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - КлючПриложения = "oynqxds..."; - СекретПриложения = "tk2oewn..."; - Код = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; - - Результат = OPI_Dropbox.ПолучитьТокен(КлючПриложения, СекретПриложения, Код); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьТокен --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" - - -``` - - -```json title="Результат" - -{ - "error": "invalid_grant", - "error_description": "code doesn't exist or has expired" -} - -``` +--- +sidebar_position: 2 +--- + +# Получить токен + Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации + + +*Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + | СекретПриложения | --appsecret | Строка | Секрет приложения | + | Код | --code | Строка | Код со страницы авторизации | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + КлючПриложения = "oynqxds..."; + СекретПриложения = "tk2oewn..."; + Код = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; + + Результат = OPI_Dropbox.ПолучитьТокен(КлючПриложения, СекретПриложения, Код); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьТокен --appkey "oynqxds..." --appsecret "tk2oewn..." --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 index d794f70f99..32b0d83438 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 3 ---- - -# Обновить токен - Получает новый токен на основе рефреш токена - - -*Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | КлючПриложения | --appkey | Строка | Ключ приложения | - | СекретПриложения | --appsecret | Строка | Секрет приложения | - | РефрешТокен | --refresh | Строка | Рефреш токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - КлючПриложения = "oynqxds..."; - СекретПриложения = "tk2oewn..."; - РефрешТокен = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; - - Результат = OPI_Dropbox.ОбновитьТокен(КлючПриложения, СекретПриложения, РефрешТокен); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ОбновитьТокен --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..." - - -``` - - -```json title="Результат" - -{ - "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", - "token_type": "bearer", - "expires_in": 14400 -} - -``` +--- +sidebar_position: 3 +--- + +# Обновить токен + Получает новый токен на основе рефреш токена + + +*Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + | СекретПриложения | --appsecret | Строка | Секрет приложения | + | РефрешТокен | --refresh | Строка | Рефреш токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + КлючПриложения = "oynqxds..."; + СекретПриложения = "tk2oewn..."; + РефрешТокен = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; + + Результат = OPI_Dropbox.ОбновитьТокен(КлючПриложения, СекретПриложения, РефрешТокен); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ОбновитьТокен --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..." + + +``` + + +```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 index 5c7416721f..8506feb42d 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md @@ -1,57 +1,57 @@ ---- -sidebar_position: 8 ---- - -# Копировать объект - Копирует файл или каталог по выбранному пути - - -*Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Откуда | --form | Строка | Путь к объекту оригинала | - | Куда | --to | Строка | Целевой путь для нового объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Оригинал = "/New/pic.png"; - Копия = "/New/pic_copy.png"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox КопироватьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% - - -``` - - -```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-pT48AAAAAAAABYg", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:54Z", - "rev": "619ab10ed491ebd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} - -``` +--- +sidebar_position: 8 +--- + +# Копировать объект + Копирует файл или каталог по выбранному пути + + +*Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --form | Строка | Путь к объекту оригинала | + | Куда | --to | Строка | Целевой путь для нового объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Оригинал = "/New/pic.png"; + Копия = "/New/pic_copy.png"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox КопироватьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% + + +``` + + +```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-pT48AAAAAAAABYg", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:54Z", + "rev": "619ab10ed491ebd841553", + "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 index 0cb9daf6ab..b7ddf46469 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 10 ---- - -# Создать папку - Создает пустой каталог по выбранному пути - - -*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Целевой путь создания каталога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/Новый каталог"; - - Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox СоздатьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```json title="Результат" - -{ - "metadata": { - "name": "Новый каталог", - "path_lower": "/новый каталог", - "path_display": "/Новый каталог", - "id": "id:kJU6-a-pT48AAAAAAAABZA" - } -} - -``` +--- +sidebar_position: 10 +--- + +# Создать папку + Создает пустой каталог по выбранному пути + + +*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Целевой путь создания каталога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/Новый каталог"; + + Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox СоздатьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```json title="Результат" + +{ + "metadata": { + "name": "Новый каталог", + "path_lower": "/новый каталог", + "path_display": "/Новый каталог", + "id": "id:kJU6-a-pT48AAAAAAAABZA" + } +} + +``` 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 index bca4bd30b4..5a814d89a5 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md @@ -1,56 +1,56 @@ ---- -sidebar_position: 7 ---- - -# Удалить объект - Удаляет объект с облачного диска - - -*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту удаления | - | БезВозвратно | --permanently | Строка | Удалить объект без возможности востановления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Путь = "/New/pic.png"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox УдалитьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently% - - -``` - - -```json title="Результат" - -{ - "metadata": { - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:48Z", - "rev": "619ab108e3d3dbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } -} - -``` +--- +sidebar_position: 7 +--- + +# Удалить объект + Удаляет объект с облачного диска + + +*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту удаления | + | БезВозвратно | --permanently | Строка | Удалить объект без возможности востановления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/pic.png"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox УдалитьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently% + + +``` + + +```json title="Результат" + +{ + "metadata": { + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:48Z", + "rev": "619ab108e3d3dbd841553", + "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 index d3ecf18eb4..8b35b018aa 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 11 ---- - -# Скачать файл - Скачивает файл по указанному пути или ID - - -*Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь или ID файла | - - - Возвращаемое значение: ДвоичныеДанные - двоичные данные файла - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New/pic.png"; - - Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox СкачатьФайл --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```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… - -``` +--- +sidebar_position: 11 +--- + +# Скачать файл + Скачивает файл по указанному пути или ID + + +*Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь или ID файла | + + + Возвращаемое значение: ДвоичныеДанные - двоичные данные файла + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox СкачатьФайл --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```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 index 23c1610583..bd15ac3a46 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 12 ---- - -# Скачать папку - Скачивает zip архив с содержимым указанного каталога - - -*Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь или ID каталога | - - - Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New"; - - Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox СкачатьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```json title="Результат" - -НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… - -``` +--- +sidebar_position: 12 +--- + +# Скачать папку + Скачивает zip архив с содержимым указанного каталога + + +*Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь или ID каталога | + + + Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New"; + + Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox СкачатьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```json title="Результат" + +НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… + +``` 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 index 66f422b6bb..4a3abf4191 100644 --- 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 @@ -1,43 +1,43 @@ ---- -sidebar_position: 2 ---- - -# Получить список файлов папки - Получает список первых файлов каталога или продолжает получение следующих при указании курсора - - -*Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к каталогу. Необязателен, если указан курсор | - | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | - | Курсор | --cursor | Строка | Курсор из предыдущего запроса для получения следующего набора файлов | - - - Возвращаемое значение: HTTPОтвет - Получить список файлов папки - -```bsl title="Пример кода" - - Путь = "/New"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьСписокФайловПапки --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 2 +--- + +# Получить список файлов папки + Получает список первых файлов каталога или продолжает получение следующих при указании курсора + + +*Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к каталогу. Необязателен, если указан курсор | + | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | + | Курсор | --cursor | Строка | Курсор из предыдущего запроса для получения следующего набора файлов | + + + Возвращаемое значение: HTTPОтвет - Получить список файлов папки + +```bsl title="Пример кода" + + Путь = "/New"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьСписокФайловПапки --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor% + + +``` + + +```json title="Результат" + + + +``` 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 index d998f4b52c..ab340b043b 100644 --- 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 @@ -1,54 +1,54 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию об объекте - Получает информацию о файле или каталоге - - -*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Путь = "/New/pic.png"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьИнформациюОбОбъекте --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% - - -``` - - -```json title="Результат" - -{ - ".tag": "file", - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} - -``` +--- +sidebar_position: 1 +--- + +# Получить информацию об объекте + Получает информацию о файле или каталоге + + +*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/pic.png"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьИнформациюОбОбъекте --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% + + +``` + + +```json title="Результат" + +{ + ".tag": "file", + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index 3f379ba8c4..0c2ec1189f 100644 --- 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 @@ -1,58 +1,58 @@ ---- -sidebar_position: 13 ---- - -# Получить список версий объекта - Получает список версий (ревизий) объекта - - -*Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - | Количество | --amount | Строка, Число | Число последних версий объекта для отображения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New/pic.png"; - - Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьСписокВерсийОбъекта --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount% - - -``` - - -```json title="Результат" - -{ - "is_deleted": false, - "entries": [ - { - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" - } - ] -} - -``` +--- +sidebar_position: 13 +--- + +# Получить список версий объекта + Получает список версий (ревизий) объекта + + +*Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Количество | --amount | Строка, Число | Число последних версий объекта для отображения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьСписокВерсийОбъекта --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount% + + +``` + + +```json title="Результат" + +{ + "is_deleted": false, + "entries": [ + { + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index f600e8287c..f7194cabd6 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 3 ---- - -# Получить превью - Получает PDF или HTML превью объекта (только для токументов) - - -*Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - - - Возвращаемое значение: ДвоичныеДанные - превью документа - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New/mydoc.docx"; - - Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьПревью --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```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… - -``` +--- +sidebar_position: 3 +--- + +# Получить превью + Получает PDF или HTML превью объекта (только для токументов) + + +*Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + + + Возвращаемое значение: ДвоичныеДанные - превью документа + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьПревью --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```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 index c68f979dfb..250a1daff8 100644 --- 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 @@ -1,62 +1,62 @@ ---- -sidebar_position: 6 ---- - -# Получить статус загрузки по URL - Получает статус загрузки файла по URL - - -*Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDРаботы | --job | Строка | ID асинхронной работы из ответа ЗагрузитьФайлПоURL | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - ИДРаботы = "G8YbueOu2nsAAAAAAAAAAQ"; - Статус = "in_progress"; - - Пока Статус = "in_progress" Цикл - - Результат = OPI_Dropbox.ПолучитьСтатусЗагрузкиПоURL(Токен, ИДРаботы); - Статус = Результат[".tag"]; - - OPI_Инструменты.Пауза(5); - - - КонецЦикла; - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьСтатусЗагрузкиПоURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job% - - -``` - - -```json title="Результат" - -{ - ".tag": "complete", - "name": "url_doc.docx", - "path_lower": "/new/url_doc.docx", - "path_display": "/New/url_doc.docx", - "id": "id:kJU6-a-pT48AAAAAAAABYw", - "client_modified": "2024-05-30T12:33:07Z", - "server_modified": "2024-05-30T12:33:08Z", - "rev": "619ab11c37fb9bd841553", - "size": 24069, - "is_downloadable": true, - "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" -} - -``` +--- +sidebar_position: 6 +--- + +# Получить статус загрузки по URL + Получает статус загрузки файла по URL + + +*Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDРаботы | --job | Строка | ID асинхронной работы из ответа ЗагрузитьФайлПоURL | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + ИДРаботы = "G8YbueOu2nsAAAAAAAAAAQ"; + Статус = "in_progress"; + + Пока Статус = "in_progress" Цикл + + Результат = OPI_Dropbox.ПолучитьСтатусЗагрузкиПоURL(Токен, ИДРаботы); + Статус = Результат[".tag"]; + + OPI_Инструменты.Пауза(5); + + + КонецЦикла; + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьСтатусЗагрузкиПоURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job% + + +``` + + +```json title="Результат" + +{ + ".tag": "complete", + "name": "url_doc.docx", + "path_lower": "/new/url_doc.docx", + "path_display": "/New/url_doc.docx", + "id": "id:kJU6-a-pT48AAAAAAAABYw", + "client_modified": "2024-05-30T12:33:07Z", + "server_modified": "2024-05-30T12:33:08Z", + "rev": "619ab11c37fb9bd841553", + "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 index 5031d9d4f4..ad092d8073 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 9 ---- - -# Переместить объект - Перемещает объект по выбранному пути - - -*Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Откуда | --form | Строка | Путь к объекту оригинала | - | Куда | --to | Строка | Целевой путь для нового объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - ОригиналныйПуть = "/New/pic.png"; - ЦелевойПуть = "/pic.png"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - - Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПереместитьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 9 +--- + +# Переместить объект + Перемещает объект по выбранному пути + + +*Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --form | Строка | Путь к объекту оригинала | + | Куда | --to | Строка | Целевой путь для нового объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + ОригиналныйПуть = "/New/pic.png"; + ЦелевойПуть = "/pic.png"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + + Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПереместитьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% + + +``` + + +```json title="Результат" + + + +``` 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 index 05aa066ce4..15c2dbd224 100644 --- 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 @@ -1,54 +1,54 @@ ---- -sidebar_position: 14 ---- - -# Восстановить объект к версии - Восстанавливает состояние объекта к необходимой версии (ревизии) - - -*Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту | - | Версия | --rev | Строка | ID версии (ревизии) для востановления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Версия = "61a0b76320a6fbd841553"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New/pic.png"; - - Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ВосстановитьОбъектКВерсии --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553" - - -``` - - -```json title="Результат" - -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} - -``` +--- +sidebar_position: 14 +--- + +# Восстановить объект к версии + Восстанавливает состояние объекта к необходимой версии (ревизии) + + +*Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Версия | --rev | Строка | ID версии (ревизии) для востановления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Версия = "61a0b76320a6fbd841553"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ВосстановитьОбъектКВерсии --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553" + + +``` + + +```json title="Результат" + +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index ef1012f661..1a04341720 100644 --- 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 @@ -1,46 +1,46 @@ ---- -sidebar_position: 5 ---- - -# Загрузить файл по URL - Загружает файл на облачный диск, получая его по указанному URL - - -*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URLФайла | --url | Строка | URL источник файла | - | Путь | --path | Строка | Путь сохранения на Dropbox | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Путь = "/New/url_doc.docx"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - URL = "https://openintegrations.dev/test_data/document.docx"; - - Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ЗагрузитьФайлПоURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path% - - -``` - - -```json title="Результат" - -{ - ".tag": "async_job_id", - "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" -} - -``` +--- +sidebar_position: 5 +--- + +# Загрузить файл по URL + Загружает файл на облачный диск, получая его по указанному URL + + +*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URLФайла | --url | Строка | URL источник файла | + | Путь | --path | Строка | Путь сохранения на Dropbox | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/url_doc.docx"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + URL = "https://openintegrations.dev/test_data/document.docx"; + + Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ЗагрузитьФайлПоURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path% + + +``` + + +```json title="Результат" + +{ + ".tag": "async_job_id", + "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" +} + +``` 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 index 731d81b95b..4d6673ea29 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 4 ---- - -# Загрузить файл - Загружает файл на облачный диск - - -*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Файл | --file | Строка, ДвоичныеДанные | Данные файл для загрузки | - | Путь | --path | Строка | Путь сохранения на Dropbox | - | Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Путь = "/New/pic.png"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; - - КартинкаПуть = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, КартинкаПуть); - - Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ЗагрузитьФайл --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite% - - -``` - - -```json title="Результат" - -{ - "name": "pic.png", - "path_lower": "/new/pic.png", - "path_display": "/New/pic.png", - "id": "id:kJU6-a-pT48AAAAAAAABYA", - "client_modified": "2024-05-30T12:32:09Z", - "server_modified": "2024-05-30T12:32:09Z", - "rev": "619ab0e44a57cbd841553", - "size": 2114023, - "is_downloadable": true, - "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" -} - -``` +--- +sidebar_position: 4 +--- + +# Загрузить файл + Загружает файл на облачный диск + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Файл | --file | Строка, ДвоичныеДанные | Данные файл для загрузки | + | Путь | --path | Строка | Путь сохранения на Dropbox | + | Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/pic.png"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; + + КартинкаПуть = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, КартинкаПуть); + + Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ЗагрузитьФайл --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite% + + +``` + + +```json title="Результат" + +{ + "name": "pic.png", + "path_lower": "/new/pic.png", + "path_display": "/New/pic.png", + "id": "id:kJU6-a-pT48AAAAAAAABYA", + "client_modified": "2024-05-30T12:32:09Z", + "server_modified": "2024-05-30T12:32:09Z", + "rev": "619ab0e44a57cbd841553", + "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 index fe04d1c1a0..3d6acb3058 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 3 ---- - -# Добавить пользователя к файлу - Определяет доступ к файлу для стороннего пользователя - - -*Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | - | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | - | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Почта = "h5bk6ft62s@privaterelay.appleid.com"; - Файл = "kJU6-a-pT48AAAAAAAAABw"; - - Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ДобавитьПользователейКФайлу --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 3 +--- + +# Добавить пользователя к файлу + Определяет доступ к файлу для стороннего пользователя + + +*Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | + | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | + | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Почта = "h5bk6ft62s@privaterelay.appleid.com"; + Файл = "kJU6-a-pT48AAAAAAAAABw"; + + Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ДобавитьПользователейКФайлу --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly% + + +``` + + +```json title="Результат" + + + +``` 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 index 1afec7a517..86a9dd8850 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 4 ---- - -# Добавить пользователей к папке - Предоставляет стороннии пользователям доступ к каталогу - - -*Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | - | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | - | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | - - - Возвращаемое значение: Неопределено - пустой ответ - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Почта = "h5bk6ft62s@privaterelay.appleid.com"; - Папка = "5022319569"; // shared_folder_id - - Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ДобавитьПользователейКПапке --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 4 +--- + +# Добавить пользователей к папке + Предоставляет стороннии пользователям доступ к каталогу + + +*Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | + | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | + | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | + + + Возвращаемое значение: Неопределено - пустой ответ + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Почта = "h5bk6ft62s@privaterelay.appleid.com"; + Папка = "5022319569"; // shared_folder_id + + Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ДобавитьПользователейКПапке --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly% + + +``` + + +```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 index 0c1667b107..5ae6e3615c 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 6 ---- - -# Отменить публикацию файла - Запрещает доступ к файлу для внешних пользователей - - -*Функция ОтменитьПубликациюФайла(Знач Токен, Знач IDФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Файл = "kJU6-a-pT48AAAAAAAAABw"; - - Результат = OPI_Dropbox.ОтменитьПубликациюФайла(Токен, Файл); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ОтменитьПубликациюФайла --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% - - -``` - - -```json title="Результат" - -{} - -``` +--- +sidebar_position: 6 +--- + +# Отменить публикацию файла + Запрещает доступ к файлу для внешних пользователей + + +*Функция ОтменитьПубликациюФайла(Знач Токен, Знач IDФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Файл = "kJU6-a-pT48AAAAAAAAABw"; + + Результат = OPI_Dropbox.ОтменитьПубликациюФайла(Токен, Файл); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ОтменитьПубликациюФайла --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% + + +``` + + +```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 index f22dfa1c02..b7ed74b900 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 2 ---- - -# Отменить публикацию папки - Отменяет режим общего доступа для каталога - - -*Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Папка = "5022319569"; - - Результат = OPI_Dropbox.ОтменитьПубликациюПапки(Токен, Папка); - ТекущийСтатус = "in_progress"; - IDРаботы = Результат["async_job_id"]; - - Пока ТекущийСтатус = "in_progress" Цикл - Результат = OPI_Dropbox.ПолучитьСтатусАсинхронногоИзменения(Токен, IDРаботы); - ТекущийСтатус = Результат[".tag"]; - OPI_Инструменты.Пауза(3); - КонецЦикла; - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ОтменитьПубликациюПапки --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% - - -``` - - -```json title="Результат" - -{ - ".tag": "complete" -} - -``` +--- +sidebar_position: 2 +--- + +# Отменить публикацию папки + Отменяет режим общего доступа для каталога + + +*Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Папка = "5022319569"; + + Результат = OPI_Dropbox.ОтменитьПубликациюПапки(Токен, Папка); + ТекущийСтатус = "in_progress"; + IDРаботы = Результат["async_job_id"]; + + Пока ТекущийСтатус = "in_progress" Цикл + Результат = OPI_Dropbox.ПолучитьСтатусАсинхронногоИзменения(Токен, IDРаботы); + ТекущийСтатус = Результат[".tag"]; + OPI_Инструменты.Пауза(3); + КонецЦикла; + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ОтменитьПубликациюПапки --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% + + +``` + + +```json title="Результат" + +{ + ".tag": "complete" +} + +``` 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 index 493d4aba3a..cf83871e41 100644 --- 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 @@ -1,37 +1,37 @@ ---- -sidebar_position: 5 ---- - -# Получить статус асинхронного изменения - Получает статус асинхронной работы по изменению доступов - - -*Функция ПолучитьСтатусАсинхронногоИзменения(Знач Токен, Знач IDРаботы) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDРаботы | --job | Строка | ID асинхронной работы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьСтатусАсинхронногоИзменения --token %token% --job %job% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 5 +--- + +# Получить статус асинхронного изменения + Получает статус асинхронной работы по изменению доступов + + +*Функция ПолучитьСтатусАсинхронногоИзменения(Знач Токен, Знач IDРаботы) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDРаботы | --job | Строка | ID асинхронной работы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьСтатусАсинхронногоИзменения --token %token% --job %job% + + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md index 21752caeaa..25b275dc81 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md @@ -1,69 +1,69 @@ ---- -sidebar_position: 1 ---- - -# Опубликовать папку - Переводит каталог в режим публичного доступа - - -*Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к целевому каталогу | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New"; - - Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ОпубликоватьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% - - -``` - - -```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/0eu3zz5f05vymefoq6yyl/h?dl=0", - "shared_folder_id": "5009428129", - "time_invited": "2024-05-30T12:35:34Z", - "access_inheritance": { - ".tag": "inherit" - }, - "folder_id": "id:kJU6-a-pT48AAAAAAAABXw" -} - -``` +--- +sidebar_position: 1 +--- + +# Опубликовать папку + Переводит каталог в режим публичного доступа + + +*Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к целевому каталогу | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New"; + + Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ОпубликоватьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% + + +``` + + +```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/0eu3zz5f05vymefoq6yyl/h?dl=0", + "shared_folder_id": "5009428129", + "time_invited": "2024-05-30T12:35:34Z", + "access_inheritance": { + ".tag": "inherit" + }, + "folder_id": "id:kJU6-a-pT48AAAAAAAABXw" +} + +``` diff --git a/docs/ru/md/Dropbox/Tag-work/Add-tag.md b/docs/ru/md/Dropbox/Tag-work/Add-tag.md index 09273af13f..b41144b6bc 100644 --- a/docs/ru/md/Dropbox/Tag-work/Add-tag.md +++ b/docs/ru/md/Dropbox/Tag-work/Add-tag.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 2 ---- - -# Добавить тег - Добавляет новый текстовый тег к файлу или каталогу - - -*Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту, для которого необходимо создать тег | - | Тег | --tag | Строка | Текст тега | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Тег = "Важное"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New/mydoc.docx"; - - Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ДобавитьТег --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% - - -``` - - -```json title="Результат" - -{} - -``` +--- +sidebar_position: 2 +--- + +# Добавить тег + Добавляет новый текстовый тег к файлу или каталогу + + +*Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту, для которого необходимо создать тег | + | Тег | --tag | Строка | Текст тега | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Тег = "Важное"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ДобавитьТег --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% + + +``` + + +```json title="Результат" + +{} + +``` diff --git a/docs/ru/md/Dropbox/Tag-work/Delete-tag.md b/docs/ru/md/Dropbox/Tag-work/Delete-tag.md index 468d7c389b..2155c69422 100644 --- a/docs/ru/md/Dropbox/Tag-work/Delete-tag.md +++ b/docs/ru/md/Dropbox/Tag-work/Delete-tag.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 3 ---- - -# Удалить тег - Удаляет текстовый тег файла или каталога - - -*Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к объекту, тег которого необходимо удалить | - | Тег | --tag | Строка | Текст тега | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - Тег = "Важное"; - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; - Путь = "/New/mydoc.docx"; - - Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег); - - -``` - -```sh title="Пример команды CLI" - - oint dropbox УдалитьТег --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% - - -``` - - -```json title="Результат" - -{} - -``` +--- +sidebar_position: 3 +--- + +# Удалить тег + Удаляет текстовый тег файла или каталога + + +*Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту, тег которого необходимо удалить | + | Тег | --tag | Строка | Текст тега | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Тег = "Важное"; + Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег); + + +``` + +```sh title="Пример команды CLI" + + oint dropbox УдалитьТег --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% + + +``` + + +```json title="Результат" + +{} + +``` diff --git a/docs/ru/md/Dropbox/Tag-work/Get-tag-list.md b/docs/ru/md/Dropbox/Tag-work/Get-tag-list.md index c3c1edaca5..0bff98e4b6 100644 --- a/docs/ru/md/Dropbox/Tag-work/Get-tag-list.md +++ b/docs/ru/md/Dropbox/Tag-work/Get-tag-list.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 1 ---- - -# Получить список тегов - Получает список тегов выбранных файлов - - -*Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Пути | --paths | Строка, Массив Из Строка | Путь или набору путей к файлам | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint dropbox ПолучитьСписокТегов --token %token% --paths %paths% - - -``` - - -```json title="Результат" - -{ - "paths_to_tags": [ - { - "path": "/New/Dogs.mp3", - "tags": [] - }, - { - "path": "/New/mydoc.docx", - "tags": [ - { - ".tag": "user_generated_tag", - "tag_text": "важное" - } - ] - } - ] -} - -``` +--- +sidebar_position: 1 +--- + +# Получить список тегов + Получает список тегов выбранных файлов + + +*Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Пути | --paths | Строка, Массив Из Строка | Путь или набору путей к файлам | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint dropbox ПолучитьСписокТегов --token %token% --paths %paths% + + +``` + + +```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 index adad735b9f..1c89cd0689 100644 --- 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 @@ -1,59 +1,59 @@ ---- -sidebar_position: 2 ---- - -# Добавить календарь в список - Добавляет существующий календарь в список пользователя - - -*Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ДобавитьКалендарьВСписок(Токен, "55868c32be16935f0..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ДобавитьКалендарьВСписок --token %token% --calendar %calendar% - - -``` - - -```json title="Результат" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "selected": true, - "foregroundColor": "#000000", - "backgroundColor": "#7bd148", - "colorId": "9", - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", - "etag": "\"1708423365033000\"", - "kind": "calendar#calendarListEntry" - } - -``` +--- +sidebar_position: 2 +--- + +# Добавить календарь в список + Добавляет существующий календарь в список пользователя + + +*Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ДобавитьКалендарьВСписок(Токен, "55868c32be16935f0..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ДобавитьКалендарьВСписок --token %token% --calendar %calendar% + + +``` + + +```json title="Результат" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "selected": true, + "foregroundColor": "#000000", + "backgroundColor": "#7bd148", + "colorId": "9", + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", + "etag": "\"1708423365033000\"", + "kind": "calendar#calendarListEntry" + } + +``` 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 index bb0a057784..bbbfaa7115 100644 --- 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 @@ -1,41 +1,41 @@ ---- -sidebar_position: 4 ---- - -# Удалить календарь из списка - Удаляет календарь из списка пользователя - - -*Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.УдалитьКалендарьИзСписка(Токен, "55868c32be16935f0..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar УдалитьКалендарьИзСписка --token %token% --calendar %calendar% - - -``` - - -```json title="Результат" - -"" - -``` +--- +sidebar_position: 4 +--- + +# Удалить календарь из списка + Удаляет календарь из списка пользователя + + +*Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.УдалитьКалендарьИзСписка(Токен, "55868c32be16935f0..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar УдалитьКалендарьИзСписка --token %token% --calendar %calendar% + + +``` + + +```json title="Результат" + +"" + +``` 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 index 315e92a629..348a6b65d6 100644 --- 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 @@ -1,65 +1,65 @@ ---- -sidebar_position: 5 ---- - -# Изменить календарь списка - Изменяет свойства календаря из списка пользователей - - -*Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | ОсновнойЦвет | --primary | Строка | HEX основного цвета (#ffffff) | - | ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (#ffffff) | - | Скрытый | --hidden | Булево | Скрытый календарь | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - - Черный = "#000000"; - Желтый = "#ffd800"; - - Ответ = OPI_GoogleCalendar.ИзменитьКалендарьСписка(Токен, "55868c32be16935f0...", Черный, Желтый, Ложь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ИзменитьКалендарьСписка --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden% - - -``` - - -```json title="Результат" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com", - "etag": "\"1708424005038000\"", - "kind": "calendar#calendarListEntry" - } - -``` +--- +sidebar_position: 5 +--- + +# Изменить календарь списка + Изменяет свойства календаря из списка пользователей + + +*Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОсновнойЦвет | --primary | Строка | HEX основного цвета (#ffffff) | + | ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (#ffffff) | + | Скрытый | --hidden | Булево | Скрытый календарь | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + + Черный = "#000000"; + Желтый = "#ffd800"; + + Ответ = OPI_GoogleCalendar.ИзменитьКалендарьСписка(Токен, "55868c32be16935f0...", Черный, Желтый, Ложь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ИзменитьКалендарьСписка --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden% + + +``` + + +```json title="Результат" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com", + "etag": "\"1708424005038000\"", + "kind": "calendar#calendarListEntry" + } + +``` 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 index ac880898e8..cb45f29fc7 100644 --- 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 @@ -1,175 +1,175 @@ ---- -sidebar_position: 1 ---- - -# Получить список календарей - Получает массив календарей аккаунта - - -*Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ПолучитьСписокКалендарей(Токен); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПолучитьСписокКалендарей --token %token% - - -``` - - -```json title="Результат" - -[ - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "reader", - "foregroundColor": "#000000", - "backgroundColor": "#92e1c0", - "colorId": "13", - "description": "Показывает дни рождения, годовщины и другие значимые события для людей в Google Контактах.", - "summary": "Дни рождения", - "defaultReminders": [], - "timeZone": "Europe/Minsk", - "id": "addressbook#contacts@group.v.calendar.google.com", - "etag": "\"1708410978711000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "notificationSettings": { - "notifications": [ - { - "method": "email", - "type": "eventCreation" - }, - { - "method": "email", - "type": "eventChange" - }, - { - "method": "email", - "type": "eventCancellation" - }, - { - "method": "email", - "type": "eventResponse" - } - ] - }, - "accessRole": "owner", - "selected": true, - "foregroundColor": "#000000", - "backgroundColor": "#9fe1e7", - "colorId": "14", - "primary": true, - "summary": "bayselonarrend@gmail.com", - "defaultReminders": [ - { - "minutes": 30, - "method": "popup" - } - ], - "timeZone": "Europe/Minsk", - "id": "bayselonarrend@gmail.com", - "etag": "\"1708411692097000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "reader", - "foregroundColor": "#000000", - "backgroundColor": "#16a765", - "colorId": "8", - "description": "Праздники и памятные даты Беларуси", - "summary": "Праздники Беларуси", - "defaultReminders": [], - "timeZone": "Europe/Minsk", - "id": "ru.by#holiday@group.v.calendar.google.com", - "etag": "\"1708417568219000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#cca6ac", - "colorId": "21", - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com", - "etag": "\"1708417602744000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com", - "etag": "\"1708417840630000\"", - "kind": "calendar#calendarListEntry" - }, - { - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com", - "etag": "\"1708418157716000\"", - "kind": "calendar#calendarListEntry" - } - ] - -``` +--- +sidebar_position: 1 +--- + +# Получить список календарей + Получает массив календарей аккаунта + + +*Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ПолучитьСписокКалендарей(Токен); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПолучитьСписокКалендарей --token %token% + + +``` + + +```json title="Результат" + +[ + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "reader", + "foregroundColor": "#000000", + "backgroundColor": "#92e1c0", + "colorId": "13", + "description": "Показывает дни рождения, годовщины и другие значимые события для людей в Google Контактах.", + "summary": "Дни рождения", + "defaultReminders": [], + "timeZone": "Europe/Minsk", + "id": "addressbook#contacts@group.v.calendar.google.com", + "etag": "\"1708410978711000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "notificationSettings": { + "notifications": [ + { + "method": "email", + "type": "eventCreation" + }, + { + "method": "email", + "type": "eventChange" + }, + { + "method": "email", + "type": "eventCancellation" + }, + { + "method": "email", + "type": "eventResponse" + } + ] + }, + "accessRole": "owner", + "selected": true, + "foregroundColor": "#000000", + "backgroundColor": "#9fe1e7", + "colorId": "14", + "primary": true, + "summary": "bayselonarrend@gmail.com", + "defaultReminders": [ + { + "minutes": 30, + "method": "popup" + } + ], + "timeZone": "Europe/Minsk", + "id": "bayselonarrend@gmail.com", + "etag": "\"1708411692097000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "reader", + "foregroundColor": "#000000", + "backgroundColor": "#16a765", + "colorId": "8", + "description": "Праздники и памятные даты Беларуси", + "summary": "Праздники Беларуси", + "defaultReminders": [], + "timeZone": "Europe/Minsk", + "id": "ru.by#holiday@group.v.calendar.google.com", + "etag": "\"1708417568219000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#cca6ac", + "colorId": "21", + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com", + "etag": "\"1708417602744000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com", + "etag": "\"1708417840630000\"", + "kind": "calendar#calendarListEntry" + }, + { + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com", + "etag": "\"1708418157716000\"", + "kind": "calendar#calendarListEntry" + } + ] + +``` 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 index 2497629b0e..f64a0c4680 100644 --- 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 @@ -1,58 +1,58 @@ ---- -sidebar_position: 3 ---- - -# Получить календарь списка - Получает календарь из списка пользователя по ID - - -*Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ПолучитьКалендарьСписка(Токен, "55868c32be16935f0..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПолучитьКалендарьСписка --token %token% --calendar %calendar% - - -``` - - -```json title="Результат" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "accessRole": "owner", - "foregroundColor": "#000000", - "backgroundColor": "#ffd800", - "colorId": "6", - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "defaultReminders": [], - "timeZone": "UTC", - "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", - "etag": "\"1708423563386000\"", - "kind": "calendar#calendarListEntry" - } - -``` +--- +sidebar_position: 3 +--- + +# Получить календарь списка + Получает календарь из списка пользователя по ID + + +*Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ПолучитьКалендарьСписка(Токен, "55868c32be16935f0..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПолучитьКалендарьСписка --token %token% --calendar %calendar% + + +``` + + +```json title="Результат" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "accessRole": "owner", + "foregroundColor": "#000000", + "backgroundColor": "#ffd800", + "colorId": "6", + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "defaultReminders": [], + "timeZone": "UTC", + "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", + "etag": "\"1708423563386000\"", + "kind": "calendar#calendarListEntry" + } + +``` 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 index 1e8a5c7cba..eeee64c2f9 100644 --- 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 @@ -1,39 +1,39 @@ ---- -sidebar_position: 4 ---- - -# Очистить основной календарь - Очищает список событий основного календаря - - -*Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ОчиститьОсновнойКалендарь(Токен); - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ОчиститьОсновнойКалендарь --token %token% - - -``` - - -```json title="Результат" - -"" - -``` +--- +sidebar_position: 4 +--- + +# Очистить основной календарь + Очищает список событий основного календаря + + +*Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ОчиститьОсновнойКалендарь(Токен); + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ОчиститьОсновнойКалендарь --token %token% + + +``` + + +```json title="Результат" + +"" + +``` 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 index c9c987a4f8..2ff7948803 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 1 ---- - -# Создать календарь - Создает пустой календарь - - -*Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Наименование | --title | Строка | Наименование создаваемого календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.СоздатьКалендарь(Токен, "Тестовый календарь"); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar СоздатьКалендарь --token %token% --title %title% - - -``` - - -```json title="Результат" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "summary": "Тестовый календарь", - "timeZone": "UTC", - "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", - "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", - "kind": "calendar#calendar" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать календарь + Создает пустой календарь + + +*Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Наименование | --title | Строка | Наименование создаваемого календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.СоздатьКалендарь(Токен, "Тестовый календарь"); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar СоздатьКалендарь --token %token% --title %title% + + +``` + + +```json title="Результат" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "summary": "Тестовый календарь", + "timeZone": "UTC", + "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", + "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", + "kind": "calendar#calendar" + } + +``` 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 index c576ccebdb..e6ee24a66f 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 5 ---- - -# Удалить календарь - Удаляет календарь по ID - - -*Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.УдалитьКалендарь(Токен, "55868c32be16935f0..."); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar УдалитьКалендарь --token %token% --calendar %calendar% - - -``` - - -```json title="Результат" - -"" - -``` +--- +sidebar_position: 5 +--- + +# Удалить календарь + Удаляет календарь по ID + + +*Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.УдалитьКалендарь(Токен, "55868c32be16935f0..."); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar УдалитьКалендарь --token %token% --calendar %calendar% + + +``` + + +```json title="Результат" + +"" + +``` 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 index c20f83760d..6d06774085 100644 --- 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 @@ -1,57 +1,57 @@ ---- -sidebar_position: 3 ---- - -# Изменить календарь - Изменяет свойства существуещего календаря - - -*Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | Наименование | --title | Строка | Новое наименование | - | Описание | --description | Строка | Новое описание календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Наименование = "Тестовый календарь (изм.)"; - Описание = "Тестовое описание"; - Ответ = OPI_GoogleCalendar.ИзменитьМетаданныеКалендаря(Токен, "55868c32be16935f0...", Наименование, Описание); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ИзменитьМетаданныеКалендаря --token %token% --calendar %calendar% --title "Тестовый календарь (изм.)" --description "Тестовое описание" - - -``` - - -```json title="Результат" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "timeZone": "UTC", - "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", - "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", - "kind": "calendar#calendar" - } - -``` +--- +sidebar_position: 3 +--- + +# Изменить календарь + Изменяет свойства существуещего календаря + + +*Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Наименование = "Тестовый календарь (изм.)"; + Описание = "Тестовое описание"; + Ответ = OPI_GoogleCalendar.ИзменитьМетаданныеКалендаря(Токен, "55868c32be16935f0...", Наименование, Описание); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ИзменитьМетаданныеКалендаря --token %token% --calendar %calendar% --title "Тестовый календарь (изм.)" --description "Тестовое описание" + + +``` + + +```json title="Результат" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "timeZone": "UTC", + "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", + "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", + "kind": "calendar#calendar" + } + +``` 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 index 9e123f1663..0825bcb34a 100644 --- 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 @@ -1,53 +1,53 @@ ---- -sidebar_position: 2 ---- - -# Получить календарь - Получает информацию о календаре по ID - - -*Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ПолучитьМетаданныеКалендаря(Токен, "55868c32be16935f0..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПолучитьМетаданныеКалендаря --token %token% --calendar %calendar% - - -``` - - -```json title="Результат" - -{ - "conferenceProperties": { - "allowedConferenceSolutionTypes": [ - "hangoutsMeet" - ] - }, - "description": "Тестовое описание", - "summary": "Тестовый календарь (изм.)", - "timeZone": "UTC", - "id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com", - "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", - "kind": "calendar#calendar" - } - -``` +--- +sidebar_position: 2 +--- + +# Получить календарь + Получает информацию о календаре по ID + + +*Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ПолучитьМетаданныеКалендаря(Токен, "55868c32be16935f0..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПолучитьМетаданныеКалендаря --token %token% --calendar %calendar% + + +``` + + +```json title="Результат" + +{ + "conferenceProperties": { + "allowedConferenceSolutionTypes": [ + "hangoutsMeet" + ] + }, + "description": "Тестовое описание", + "summary": "Тестовый календарь (изм.)", + "timeZone": "UTC", + "id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com", + "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", + "kind": "calendar#calendar" + } + +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Create-event.md b/docs/ru/md/Google_Calendar/Event-management/Create-event.md index 13e7f205a3..258bebadb9 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Create-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Create-event.md @@ -1,100 +1,100 @@ ---- -sidebar_position: 4 ---- - -# Создать событие - Создает новое событие - - -*Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | ОписаниеСобытия | --props | Соответствие Из КлючИЗначение | Описание события | - - - Возвращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google - -```bsl title="Пример кода" - - - Вложения = Новый Соответствие; - Вложения.Вставить("Картинка1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); - Вложения.Вставить("Картинка2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"); - - СоответствиеСобытия = Новый Соответствие; - СоответствиеСобытия.Вставить("Описание" , Описание); - СоответствиеСобытия.Вставить("Заголовок" , Наименование); - СоответствиеСобытия.Вставить("МестоПроведения" , "В оффисе"); - СоответствиеСобытия.Вставить("ДатаНачала" , ТекущаяДатаСеанса()); - СоответствиеСобытия.Вставить("ДатаОкончания" , СоответствиеСобытия["ДатаНачала"] + 3600); - СоответствиеСобытия.Вставить("МассивURLФайловВложений" , Вложения); - СоответствиеСобытия.Вставить("ОтправлятьУведомления" , Истина); - - Ответ = OPI_GoogleCalendar.СоздатьСобытие(Токен, Календарь, СоответствиеСобытия); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar СоздатьСобытие --token %token% --calendar %calendar% --props %props% - - -``` - - -```json title="Результат" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Картинка2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Картинка1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T15:16:25+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T16:16:25+03:00" - }, - "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", - "description": "Описание тестового события", - "updated": "2024-02-21T09:16:28.474Z", - "created": "2024-02-21T09:16:28.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", - "location": "В оффисе", - "summary": "Новое событие", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "j4nonfcc0m2mtop1vc8ivo8tb8", - "etag": "\"3417013976948000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 4 +--- + +# Создать событие + Создает новое событие + + +*Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОписаниеСобытия | --props | Соответствие Из КлючИЗначение | Описание события | + + + Возвращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google + +```bsl title="Пример кода" + + + Вложения = Новый Соответствие; + Вложения.Вставить("Картинка1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); + Вложения.Вставить("Картинка2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"); + + СоответствиеСобытия = Новый Соответствие; + СоответствиеСобытия.Вставить("Описание" , Описание); + СоответствиеСобытия.Вставить("Заголовок" , Наименование); + СоответствиеСобытия.Вставить("МестоПроведения" , "В оффисе"); + СоответствиеСобытия.Вставить("ДатаНачала" , ТекущаяДатаСеанса()); + СоответствиеСобытия.Вставить("ДатаОкончания" , СоответствиеСобытия["ДатаНачала"] + 3600); + СоответствиеСобытия.Вставить("МассивURLФайловВложений" , Вложения); + СоответствиеСобытия.Вставить("ОтправлятьУведомления" , Истина); + + Ответ = OPI_GoogleCalendar.СоздатьСобытие(Токен, Календарь, СоответствиеСобытия); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar СоздатьСобытие --token %token% --calendar %calendar% --props %props% + + +``` + + +```json title="Результат" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Картинка2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Картинка1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T15:16:25+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T16:16:25+03:00" + }, + "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", + "description": "Описание тестового события", + "updated": "2024-02-21T09:16:28.474Z", + "created": "2024-02-21T09:16:28.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", + "location": "В оффисе", + "summary": "Новое событие", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "j4nonfcc0m2mtop1vc8ivo8tb8", + "etag": "\"3417013976948000\"", + "kind": "calendar#event" + } + +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Delete-event.md b/docs/ru/md/Google_Calendar/Event-management/Delete-event.md index e7c37d60c9..ad3e7110e0 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Delete-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Delete-event.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 7 ---- - -# Удалить событие - Удаляет событие по ID - - -*Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | Событие | --event | Строка | ID события | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.УдалитьСобытие(Токен, "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar УдалитьСобытие --token %token% --calendar %calendar% --event %event% - - -``` - - -```json title="Результат" - -"" - -``` +--- +sidebar_position: 7 +--- + +# Удалить событие + Удаляет событие по ID + + +*Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Событие | --event | Строка | ID события | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.УдалитьСобытие(Токен, "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar УдалитьСобытие --token %token% --calendar %calendar% --event %event% + + +``` + + +```json title="Результат" + +"" + +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Edit-event.md b/docs/ru/md/Google_Calendar/Event-management/Edit-event.md index 5186a60f65..3383fba5b4 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Edit-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Edit-event.md @@ -1,91 +1,91 @@ ---- -sidebar_position: 6 ---- - -# Изменить событие - Изменяет существующее событие - - -*Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия, Событие);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | ОписаниеСобытия | --props | Строка | Новое описание события | - | Событие | --event | Строка | ID события | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - СоответствиеСобытия = Новый Соответствие; - СоответствиеСобытия.Вставить("Описание", "Описание тестового события (изм.)"); - - Ответ = OPI_GoogleCalendar.ИзменитьСобытие(Токен, "55868c32be16935f0...", СоответствиеСобытия, "j4nonfcc0m2..."); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ИзменитьСобытие --token %token% --calendar %calendar% --props %props% --event %event% - - -``` - - -```json title="Результат" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Картинка2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Картинка1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T16:42:28+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T17:42:28+03:00" - }, - "iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com", - "description": "Описание тестового события (изм.)", - "updated": "2024-02-24T10:42:42.401Z", - "created": "2024-02-24T10:42:32.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ", - "location": "В офисе", - "summary": "Новое событие", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "7c2s6g3k6ib1mr2v1b7lnt9kfk", - "etag": "\"3417542724802000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 6 +--- + +# Изменить событие + Изменяет существующее событие + + +*Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия, Событие);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОписаниеСобытия | --props | Строка | Новое описание события | + | Событие | --event | Строка | ID события | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + СоответствиеСобытия = Новый Соответствие; + СоответствиеСобытия.Вставить("Описание", "Описание тестового события (изм.)"); + + Ответ = OPI_GoogleCalendar.ИзменитьСобытие(Токен, "55868c32be16935f0...", СоответствиеСобытия, "j4nonfcc0m2..."); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ИзменитьСобытие --token %token% --calendar %calendar% --props %props% --event %event% + + +``` + + +```json title="Результат" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Картинка2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Картинка1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T16:42:28+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T17:42:28+03:00" + }, + "iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com", + "description": "Описание тестового события (изм.)", + "updated": "2024-02-24T10:42:42.401Z", + "created": "2024-02-24T10:42:32.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ", + "location": "В офисе", + "summary": "Новое событие", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "7c2s6g3k6ib1mr2v1b7lnt9kfk", + "etag": "\"3417542724802000\"", + "kind": "calendar#event" + } + +``` 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 index 04a6fba298..4daa2b2950 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 1 ---- - -# Получить описание события - - - -*Функция ПолучитьОписаниеСобытия() Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПолучитьОписаниеСобытия - - -``` - - -```json title="Результат" - -СоответствиеСобытия = Новый Соответствие; - СоответствиеСобытия.Вставить("Описание" , ""); // Описание события - СоответствиеСобытия.Вставить("Заголовок" , "Новое событие"); // Заголовок события - СоответствиеСобытия.Вставить("МестоПроведения" , ""); // Строка описание места проведения - СоответствиеСобытия.Вставить("ДатаНачала" , ТекущаяДатаСеанса()); // Дата начала события - СоответствиеСобытия.Вставить("ДатаОкончания" , СоответствиеСобытия["ДатаНачала"] + 3600); // Дата окончания события - СоответствиеСобытия.Вставить("МассивURLФайловВложений" , Новый Соответствие); // Ключ - название, Значение - URL к файлу - СоответствиеСобытия.Вставить("ОтправлятьУведомления" , Истина); // Признак отправки уведомлений участникам - -``` +--- +sidebar_position: 1 +--- + +# Получить описание события + + + +*Функция ПолучитьОписаниеСобытия() Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПолучитьОписаниеСобытия + + +``` + + +```json title="Результат" + +СоответствиеСобытия = Новый Соответствие; + СоответствиеСобытия.Вставить("Описание" , ""); // Описание события + СоответствиеСобытия.Вставить("Заголовок" , "Новое событие"); // Заголовок события + СоответствиеСобытия.Вставить("МестоПроведения" , ""); // Строка описание места проведения + СоответствиеСобытия.Вставить("ДатаНачала" , ТекущаяДатаСеанса()); // Дата начала события + СоответствиеСобытия.Вставить("ДатаОкончания" , СоответствиеСобытия["ДатаНачала"] + 3600); // Дата окончания события + СоответствиеСобытия.Вставить("МассивURLФайловВложений" , Новый Соответствие); // Ключ - название, Значение - URL к файлу + СоответствиеСобытия.Вставить("ОтправлятьУведомления" , Истина); // Признак отправки уведомлений участникам + +``` 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 index 35e4ff5304..d03f8d3121 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md @@ -1,90 +1,90 @@ ---- -sidebar_position: 2 ---- - -# Получить список событий - Получает список всех событий календаря - - -*Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ПолучитьСписокСобытий(Токен, "55868c32be16935f0..."); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПолучитьСписокСобытий --token %token% --calendar %calendar% - - -``` - - -```json title="Результат" - -[ - - { - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - }, - { - "iconLink": "", - "title": "", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-20T05:31:12+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-20T06:31:12+03:00" - }, - "iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com", - "description": "Описание тестового события", - "updated": "2024-02-20T11:31:13.044Z", - "created": "2024-02-20T11:31:13.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ", - "location": "В оффисе", - "summary": "Новое событие", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "o6dt8kbedrmu15o53pgbrrv35o", - "etag": "\"3416857346088000\"", - "kind": "calendar#event" - }, - - ] - -``` +--- +sidebar_position: 2 +--- + +# Получить список событий + Получает список всех событий календаря + + +*Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ПолучитьСписокСобытий(Токен, "55868c32be16935f0..."); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПолучитьСписокСобытий --token %token% --calendar %calendar% + + +``` + + +```json title="Результат" + +[ + + { + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + }, + { + "iconLink": "", + "title": "", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-20T05:31:12+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-20T06:31:12+03:00" + }, + "iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com", + "description": "Описание тестового события", + "updated": "2024-02-20T11:31:13.044Z", + "created": "2024-02-20T11:31:13.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ", + "location": "В оффисе", + "summary": "Новое событие", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "o6dt8kbedrmu15o53pgbrrv35o", + "etag": "\"3416857346088000\"", + "kind": "calendar#event" + }, + + ] + +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event.md b/docs/ru/md/Google_Calendar/Event-management/Get-event.md index aad42463a3..fc5ff60495 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 3 ---- - -# Получить событие - Получает событие по ID - - -*Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Календарь | --calendar | Строка | ID календаря | - | Событие | --event | Строка | ID события | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ПолучитьСобытие(Токен, "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПолучитьСобытие --token %token% --calendar %calendar% --event %event% - - -``` - - -```json title="Результат" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Картинка2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Картинка1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T15:16:25+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-21T16:16:25+03:00" - }, - "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", - "description": "Описание тестового события", - "updated": "2024-02-21T09:16:28.474Z", - "created": "2024-02-21T09:16:28.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", - "location": "В оффисе", - "summary": "Новое событие", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "j4nonfcc0m2mtop1vc8ivo8tb8", - "etag": "\"3417013976948000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 3 +--- + +# Получить событие + Получает событие по ID + + +*Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Событие | --event | Строка | ID события | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ПолучитьСобытие(Токен, "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПолучитьСобытие --token %token% --calendar %calendar% --event %event% + + +``` + + +```json title="Результат" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Картинка2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Картинка1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T15:16:25+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-21T16:16:25+03:00" + }, + "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", + "description": "Описание тестового события", + "updated": "2024-02-21T09:16:28.474Z", + "created": "2024-02-21T09:16:28.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", + "location": "В оффисе", + "summary": "Новое событие", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "j4nonfcc0m2mtop1vc8ivo8tb8", + "etag": "\"3417013976948000\"", + "kind": "calendar#event" + } + +``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Move-event.md b/docs/ru/md/Google_Calendar/Event-management/Move-event.md index 056c761b97..7e49cd8db6 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Move-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Move-event.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 5 ---- - -# Переместить событие - Перемещает событие в другой календарь - - -*Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | КалендарьИсточник | --from | Строка | ID календаря источника | - | КалендарьПриемник | --to | Строка | ID календаря приемника | - | Событие | --event | Строка | ID события календаря источника | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Ответ = OPI_GoogleCalendar.ПереместитьСобытие(Токен, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gcalendar ПереместитьСобытие --token %token% --from %from% --to %to% --event %event% - - -``` - - -```json title="Результат" - -{ - "eventType": "default", - "attachments": [ - { - "iconLink": "", - "title": "Картинка2", - "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" - }, - { - "iconLink": "", - "title": "Картинка1", - "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" - } - ], - "reminders": { - "useDefault": true - }, - "sequence": 0, - "start": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T16:20:49+03:00" - }, - "creator": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "end": { - "timeZone": "Europe/Minsk", - "dateTime": "2024-02-24T17:20:49+03:00" - }, - "iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com", - "description": "Описание тестового события", - "updated": "2024-02-24T10:20:51.234Z", - "created": "2024-02-24T10:20:49.000Z", - "htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ", - "location": "В офисе", - "summary": "Новое событие", - "organizer": { - "self": true, - "email": "bayselonarrend@gmail.com" - }, - "status": "confirmed", - "id": "f9kkj2omsqtt67g12qh2jig8uk", - "etag": "\"3417540102468000\"", - "kind": "calendar#event" - } - -``` +--- +sidebar_position: 5 +--- + +# Переместить событие + Перемещает событие в другой календарь + + +*Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | КалендарьИсточник | --from | Строка | ID календаря источника | + | КалендарьПриемник | --to | Строка | ID календаря приемника | + | Событие | --event | Строка | ID события календаря источника | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Ответ = OPI_GoogleCalendar.ПереместитьСобытие(Токен, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gcalendar ПереместитьСобытие --token %token% --from %from% --to %to% --event %event% + + +``` + + +```json title="Результат" + +{ + "eventType": "default", + "attachments": [ + { + "iconLink": "", + "title": "Картинка2", + "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" + }, + { + "iconLink": "", + "title": "Картинка1", + "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" + } + ], + "reminders": { + "useDefault": true + }, + "sequence": 0, + "start": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T16:20:49+03:00" + }, + "creator": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "end": { + "timeZone": "Europe/Minsk", + "dateTime": "2024-02-24T17:20:49+03:00" + }, + "iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com", + "description": "Описание тестового события", + "updated": "2024-02-24T10:20:51.234Z", + "created": "2024-02-24T10:20:49.000Z", + "htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ", + "location": "В офисе", + "summary": "Новое событие", + "organizer": { + "self": true, + "email": "bayselonarrend@gmail.com" + }, + "status": "confirmed", + "id": "f9kkj2omsqtt67g12qh2jig8uk", + "etag": "\"3417540102468000\"", + "kind": "calendar#event" + } + +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Create-comment.md b/docs/ru/md/Google_Drive/Comment-management/Create-comment.md index a27b114ef5..1e027f3900 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Create-comment.md +++ b/docs/ru/md/Google_Drive/Comment-management/Create-comment.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 1 ---- - -# Создать комментарий - Создает комментарий к файлу или каталогу - - -*Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор объекта, для которого необходим комментарий | - | Комментарий | --text | Строка | Текст комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Идентификатор = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; - Комментарий = "Новый комментарий"; - - Ответ = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive СоздатьКомментарий --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text% - - -``` - - -```json title="Результат" - -{ - "content": "Новый комментарий", - "htmlContent": "Новый комментарий", - "author": { - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - }, - "replies": [], - "modifiedTime": "2024-03-17T12:53:45.469Z", - "createdTime": "2024-03-17T12:53:45.469Z", - "kind": "drive#comment", - "deleted": false, - "id": "AAABI3NNNAY" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать комментарий + Создает комментарий к файлу или каталогу + + +*Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта, для которого необходим комментарий | + | Комментарий | --text | Строка | Текст комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Идентификатор = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; + Комментарий = "Новый комментарий"; + + Ответ = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive СоздатьКомментарий --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text% + + +``` + + +```json title="Результат" + +{ + "content": "Новый комментарий", + "htmlContent": "Новый комментарий", + "author": { + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + }, + "replies": [], + "modifiedTime": "2024-03-17T12:53:45.469Z", + "createdTime": "2024-03-17T12:53:45.469Z", + "kind": "drive#comment", + "deleted": false, + "id": "AAABI3NNNAY" + } + +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md index bb67e5068f..09864ae726 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md +++ b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 4 ---- - -# Удалить комментарий - Удаляет комментарий по ID - - -*Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | - | ИДКомментария | --comment | Строка | Идентификатор комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Ответ = OPI_GoogleDrive.УдалитьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive УдалитьКомментарий --token %token% --object %object% --comment %comment% - - -``` - - -```json title="Результат" - -'' - -``` +--- +sidebar_position: 4 +--- + +# Удалить комментарий + Удаляет комментарий по ID + + +*Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | + | ИДКомментария | --comment | Строка | Идентификатор комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Ответ = OPI_GoogleDrive.УдалитьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive УдалитьКомментарий --token %token% --object %object% --comment %comment% + + +``` + + +```json title="Результат" + +'' + +``` 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 index c0c7474199..71913ccc62 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md +++ b/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 3 ---- - -# Получить список комментариев - Получает список всех комментариев объекта - - -*Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДОбъекта | --object | Строка | Идентификатор объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; - - Ответ = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, ИДФайла); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ПолучитьСписокКомментариев --token %token% --object %object% - - -``` - - -```json title="Результат" - -{ - "comments": [ - { - "content": "Новый комментарий", - "htmlContent": "Новый комментарий", - "author": { - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - }, - "replies": [], - "modifiedTime": "2024-03-17T12:53:45.469Z", - "createdTime": "2024-03-17T12:53:45.469Z", - "kind": "drive#comment", - "deleted": false, - "id": "AAABI3NNNAY" - } - ], - "kind": "drive#commentList" - } - -``` +--- +sidebar_position: 3 +--- + +# Получить список комментариев + Получает список всех комментариев объекта + + +*Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; + + Ответ = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, ИДФайла); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ПолучитьСписокКомментариев --token %token% --object %object% + + +``` + + +```json title="Результат" + +{ + "comments": [ + { + "content": "Новый комментарий", + "htmlContent": "Новый комментарий", + "author": { + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + }, + "replies": [], + "modifiedTime": "2024-03-17T12:53:45.469Z", + "createdTime": "2024-03-17T12:53:45.469Z", + "kind": "drive#comment", + "deleted": false, + "id": "AAABI3NNNAY" + } + ], + "kind": "drive#commentList" + } + +``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment.md b/docs/ru/md/Google_Drive/Comment-management/Get-comment.md index 44014e7b1f..c0339a2956 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Get-comment.md +++ b/docs/ru/md/Google_Drive/Comment-management/Get-comment.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 2 ---- - -# Получить комментарий - Получает комментарий по ID - - -*Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | - | ИДКомментария | --comment | Строка | Идентификатор комментария | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; - ИДКомментария = AAABI3NNNAY; - - Ответ = OPI_GoogleDrive.ПолучитьКомментарий(Токен, ИДФайла, ИДКомментария); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ПолучитьКомментарий --token %token% --object %object% --comment "AAABI3NNNAY" - - -``` - - -```json title="Результат" - -{ - "content": "Новый комментарий", - "htmlContent": "Новый комментарий", - "author": { - "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - }, - "replies": [], - "modifiedTime": "2024-03-17T12:53:45.469Z", - "createdTime": "2024-03-17T12:53:45.469Z", - "kind": "drive#comment", - "deleted": false, - "id": "AAABI3NNNAY" - } - -``` +--- +sidebar_position: 2 +--- + +# Получить комментарий + Получает комментарий по ID + + +*Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | + | ИДКомментария | --comment | Строка | Идентификатор комментария | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; + ИДКомментария = AAABI3NNNAY; + + Ответ = OPI_GoogleDrive.ПолучитьКомментарий(Токен, ИДФайла, ИДКомментария); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ПолучитьКомментарий --token %token% --object %object% --comment "AAABI3NNNAY" + + +``` + + +```json title="Результат" + +{ + "content": "Новый комментарий", + "htmlContent": "Новый комментарий", + "author": { + "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + }, + "replies": [], + "modifiedTime": "2024-03-17T12:53:45.469Z", + "createdTime": "2024-03-17T12:53:45.469Z", + "kind": "drive#comment", + "deleted": false, + "id": "AAABI3NNNAY" + } + +``` 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 index f91ec3ccca..9963852858 100644 --- 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 @@ -1,52 +1,52 @@ ---- -sidebar_position: 7 ---- - -# Скоприровать объект - Копирует файл или каталог - - -*Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор объекта | - | НовоеИмя | --title | Строка | Новое имя объекта | - | НовыйРодитель | --catalog | Строка | Новый каталог размещения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - НовоеИмя = "Скопированный файл.jpeg"; - НовоеРасположение = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; - Идентификатор = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk"; - - Ответ = OPI_GoogleDrive.СкопироватьОбъект(Токен, Идентификатор, НовоеИмя, НовоеРасположение) //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive СкопироватьОбъект --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "Скопированный файл.jpeg" --catalog %catalog% - - -``` - - -```json title="Результат" - -{ - "mimeType": "image/jpeg", - "name": "Скопированный файл.jpeg", - "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 7 +--- + +# Скоприровать объект + Копирует файл или каталог + + +*Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта | + | НовоеИмя | --title | Строка | Новое имя объекта | + | НовыйРодитель | --catalog | Строка | Новый каталог размещения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + НовоеИмя = "Скопированный файл.jpeg"; + НовоеРасположение = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; + Идентификатор = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk"; + + Ответ = OPI_GoogleDrive.СкопироватьОбъект(Токен, Идентификатор, НовоеИмя, НовоеРасположение) //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive СкопироватьОбъект --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "Скопированный файл.jpeg" --catalog %catalog% + + +``` + + +```json title="Результат" + +{ + "mimeType": "image/jpeg", + "name": "Скопированный файл.jpeg", + "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", + "kind": "drive#file" + } + +``` 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 index 3a9ec30164..6353140c9c 100644 --- 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 @@ -1,49 +1,49 @@ ---- -sidebar_position: 5 ---- - -# Создать папку - Создает пустой каталог на диске - - -*Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Имя | --title | Строка | Имя папки | - | Родитель | --catalog | Строка | Родитель | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Имя = "Тестовая папка"; - - Ответ = OPI_GoogleDrive.СоздатьПапку(Токен, Имя); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive СоздатьПапку --token %token% --title "Тестовая папка" --catalog %catalog% - - -``` - - -```json title="Результат" - -{ - "mimeType": "application/vnd.google-apps.folder", - "name": "Тестовая папка", - "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 5 +--- + +# Создать папку + Создает пустой каталог на диске + + +*Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Имя | --title | Строка | Имя папки | + | Родитель | --catalog | Строка | Родитель | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Имя = "Тестовая папка"; + + Ответ = OPI_GoogleDrive.СоздатьПапку(Токен, Имя); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive СоздатьПапку --token %token% --title "Тестовая папка" --catalog %catalog% + + +``` + + +```json title="Результат" + +{ + "mimeType": "application/vnd.google-apps.folder", + "name": "Тестовая папка", + "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", + "kind": "drive#file" + } + +``` 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 index 6d471ab1ab..12f7ec162e 100644 --- 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 @@ -1,42 +1,42 @@ ---- -sidebar_position: 9 ---- - -# Удалить объект - Удаляет файл или каталог по ID - - -*Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор объекта для удаления | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Ответ = OPI_GoogleDrive.УдалитьОбъект(Токен, Идентификатор); //Соответствие - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive УдалитьОбъект --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" - - -``` - - -```json title="Результат" - -'' - -``` +--- +sidebar_position: 9 +--- + +# Удалить объект + Удаляет файл или каталог по ID + + +*Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта для удаления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Ответ = OPI_GoogleDrive.УдалитьОбъект(Токен, Идентификатор); //Соответствие + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive УдалитьОбъект --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" + + +``` + + +```json title="Результат" + +'' + +``` 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 index bb16267cf2..b452d96a70 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 6 ---- - -# Скачать файл - Получает файл по ID - - -*Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор файла | - | ПутьСохранения | --out | Строка | Путь сохранения файла | - - - Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения - -```bsl title="Пример кода" - - - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Ответ = OPI_GoogleDrive.СкачатьФайл(Токен, Идентификатор); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive СкачатьФайл --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 6 +--- + +# Скачать файл + Получает файл по ID + + +*Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор файла | + | ПутьСохранения | --out | Строка | Путь сохранения файла | + + + Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + +```bsl title="Пример кода" + + + Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Ответ = OPI_GoogleDrive.СкачатьФайл(Токен, Идентификатор); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive СкачатьФайл --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out% + + +``` + + +```json title="Результат" + + + +``` 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 index d051fe7563..87d6207139 100644 --- 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 @@ -1,148 +1,148 @@ ---- -sidebar_position: 2 ---- - -# Получить список каталогов - Получает список каталогов диска - - -*Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИмяСодержит | --querry | Строка | Отбор по имени | - | Подробно | --depth | Булево | Добавляет список файлов к полям каталога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов - -```bsl title="Пример кода" - - - Имя = "Описание"; - Ответ = OPI_GoogleDrive.ПолучитьСписокКаталогов(Токен, Имя, Ложь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ПолучитьСписокКаталогов --token %token% --querry %querry% --depth %depth% - - -``` - - -```json title="Результат" - -[ - { - "linkShareMetadata": { - "securityUpdateEnabled": true, - "securityUpdateEligible": false - }, - "modifiedByMe": true, - "quotaBytesUsed": "0", - "viewedByMeTime": "2024-03-13T06:02:50.470Z", - "createdTime": "2024-03-13T06:02:50.470Z", - "permissionIds": [ - "07468399490707249352" - ], - "modifiedByMeTime": "2024-03-13T06:02:50.470Z", - "explicitlyTrashed": false, - "trashed": true, - "id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", - "starred": false, - "name": "ОписаниеДвижений", - "permissions": [ - { - "pendingOwner": false, - "role": "owner", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "kind": "drive#permission", - "type": "user", - "deleted": false, - "displayName": "Антон Титовец", - "id": "07468399490707249352" - } - ], - "spaces": [ - "drive" - ], - "webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", - "isAppAuthorized": false, - "owners": [ - { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - } - ], - "version": "2", - "lastModifyingUser": { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - }, - "shared": false, - "hasThumbnail": false, - "parents": [ - "1PAFI1-rThB46uix012xmLQ01h-JARjaz" - ], - "ownedByMe": true, - "mimeType": "application/vnd.google-apps.folder", - "viewersCanCopyContent": true, - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "viewedByMe": true, - "writersCanShare": true, - "folderColorRgb": "#8f8f8f", - "copyRequiresWriterPermission": false, - "capabilities": { - "canRemoveContentRestriction": false, - "canModifyOwnerContentRestriction": false, - "canModifyLabels": false, - "canAcceptOwnership": false, - "canChangeSecurityUpdateEnabled": false, - "canMoveItemWithinDrive": true, - "canRemoveMyDriveParent": true, - "canReadLabels": false, - "canAddMyDriveParent": false, - "canShare": true, - "canModifyContent": true, - "canUntrash": true, - "canMoveItemOutOfDrive": false, - "canMoveItemIntoTeamDrive": false, - "canModifyContentRestriction": false, - "canReadRevisions": false, - "canTrash": true, - "canRemoveChildren": true, - "canListChildren": true, - "canDownload": true, - "canDelete": true, - "canRename": true, - "canChangeCopyRequiresWriterPermission": false, - "canAddChildren": true, - "canComment": true, - "canModifyEditorContentRestriction": false, - "canMoveChildrenWithinDrive": true, - "canCopy": false, - "canChangeViewersCanCopyContent": false, - "canEdit": true - }, - "modifiedTime": "2024-03-13T06:02:50.470Z", - "thumbnailVersion": "0", - "kind": "drive#file" - } - ] - -``` +--- +sidebar_position: 2 +--- + +# Получить список каталогов + Получает список каталогов диска + + +*Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяСодержит | --querry | Строка | Отбор по имени | + | Подробно | --depth | Булево | Добавляет список файлов к полям каталога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов + +```bsl title="Пример кода" + + + Имя = "Описание"; + Ответ = OPI_GoogleDrive.ПолучитьСписокКаталогов(Токен, Имя, Ложь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ПолучитьСписокКаталогов --token %token% --querry %querry% --depth %depth% + + +``` + + +```json title="Результат" + +[ + { + "linkShareMetadata": { + "securityUpdateEnabled": true, + "securityUpdateEligible": false + }, + "modifiedByMe": true, + "quotaBytesUsed": "0", + "viewedByMeTime": "2024-03-13T06:02:50.470Z", + "createdTime": "2024-03-13T06:02:50.470Z", + "permissionIds": [ + "07468399490707249352" + ], + "modifiedByMeTime": "2024-03-13T06:02:50.470Z", + "explicitlyTrashed": false, + "trashed": true, + "id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", + "starred": false, + "name": "ОписаниеДвижений", + "permissions": [ + { + "pendingOwner": false, + "role": "owner", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "kind": "drive#permission", + "type": "user", + "deleted": false, + "displayName": "Антон Титовец", + "id": "07468399490707249352" + } + ], + "spaces": [ + "drive" + ], + "webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", + "isAppAuthorized": false, + "owners": [ + { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + } + ], + "version": "2", + "lastModifyingUser": { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + }, + "shared": false, + "hasThumbnail": false, + "parents": [ + "1PAFI1-rThB46uix012xmLQ01h-JARjaz" + ], + "ownedByMe": true, + "mimeType": "application/vnd.google-apps.folder", + "viewersCanCopyContent": true, + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "viewedByMe": true, + "writersCanShare": true, + "folderColorRgb": "#8f8f8f", + "copyRequiresWriterPermission": false, + "capabilities": { + "canRemoveContentRestriction": false, + "canModifyOwnerContentRestriction": false, + "canModifyLabels": false, + "canAcceptOwnership": false, + "canChangeSecurityUpdateEnabled": false, + "canMoveItemWithinDrive": true, + "canRemoveMyDriveParent": true, + "canReadLabels": false, + "canAddMyDriveParent": false, + "canShare": true, + "canModifyContent": true, + "canUntrash": true, + "canMoveItemOutOfDrive": false, + "canMoveItemIntoTeamDrive": false, + "canModifyContentRestriction": false, + "canReadRevisions": false, + "canTrash": true, + "canRemoveChildren": true, + "canListChildren": true, + "canDownload": true, + "canDelete": true, + "canRename": true, + "canChangeCopyRequiresWriterPermission": false, + "canAddChildren": true, + "canComment": true, + "canModifyEditorContentRestriction": false, + "canMoveChildrenWithinDrive": true, + "canCopy": false, + "canChangeViewersCanCopyContent": false, + "canEdit": true + }, + "modifiedTime": "2024-03-13T06:02:50.470Z", + "thumbnailVersion": "0", + "kind": "drive#file" + } + ] + +``` 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 index e9644abf26..753368acb1 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 10 ---- - -# Получить описание файла - - - -*Функция ПолучитьОписаниеФайла() Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Описание файла - -```bsl title="Пример кода" - - - Описание = Новый Соответствие; - Описание.Вставить("MIME" , "image/jpeg"); // MIME-тип загружаемого файла - Описание.Вставить("Имя" , "Новый файл.jpg"); // Имя файла с расширением - Описание.Вставить("Описание" , "Это новый файл"); // Описание файла - Описание.Вставить("Родитель" , "root"); // ID каталога загрузки или "root" для загрузки в корень - - Возврат Описание; - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ПолучитьОписаниеФайла - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 10 +--- + +# Получить описание файла + + + +*Функция ПолучитьОписаниеФайла() Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Описание файла + +```bsl title="Пример кода" + + + Описание = Новый Соответствие; + Описание.Вставить("MIME" , "image/jpeg"); // MIME-тип загружаемого файла + Описание.Вставить("Имя" , "Новый файл.jpg"); // Имя файла с расширением + Описание.Вставить("Описание" , "Это новый файл"); // Описание файла + Описание.Вставить("Родитель" , "root"); // ID каталога загрузки или "root" для загрузки в корень + + Возврат Описание; + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ПолучитьОписаниеФайла + + +``` + + +```json title="Результат" + + + +``` 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 index 9c31213e78..76bdc70d31 100644 --- 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 @@ -1,177 +1,177 @@ ---- -sidebar_position: 3 ---- - -# Получить список файлов - Получает список файлов - - -*Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИмяСодержит | --querry | Строка | Отбор по имени | - | Каталог | --catalog | Строка | Отбор по ID каталога родителя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов - -```bsl title="Пример кода" - - - Каталог = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; - Ответ = OPI_GoogleDrive.ПолучитьСписокФайлов(Токен, , Каталог); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ПолучитьСписокФайлов --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" - - -``` - - -```json title="Результат" - -[ - { - "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", - "linkShareMetadata": { - "securityUpdateEnabled": true, - "securityUpdateEligible": false - }, - "imageMediaMetadata": { - "exposureBias": 0, - "focalLength": 5.2, - "exposureTime": 0.00125, - "cameraMake": "SONY", - "isoSpeed": 100, - "time": "2012:08:03 08:21:50", - "width": 3264, - "cameraModel": "DSC-H7", - "whiteBalance": "Auto", - "colorSpace": "sRGB", - "aperture": 5.6, - "exposureMode": "Auto", - "rotation": 0, - "height": 2448, - "meteringMode": "Pattern", - "maxApertureValue": 2.875, - "flashUsed": true - }, - "modifiedByMe": true, - "thumbnailVersion": "1", - "fullFileExtension": "jpg", - "quotaBytesUsed": "2114025", - "viewedByMeTime": "2024-03-17T08:09:01.753Z", - "permissionIds": [ - "07468399490707249352" - ], - "modifiedByMeTime": "2024-03-17T08:05:59.327Z", - "explicitlyTrashed": false, - "trashed": false, - "description": "Это новый файл", - "createdTime": "2024-03-17T08:05:59.327Z", - "id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD", - "starred": false, - "spaces": [ - "drive" - ], - "name": "Новый файл.jpg", - "permissions": [ - { - "pendingOwner": false, - "role": "owner", - "emailAddress": "bayselonarrend@gmail.com", - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "kind": "drive#permission", - "type": "user", - "deleted": false, - "displayName": "Антон Титовец", - "id": "07468399490707249352" - } - ], - "webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download", - "isAppAuthorized": true, - "webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk", - "version": "4", - "owners": [ - { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - } - ], - "lastModifyingUser": { - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "kind": "drive#user", - "displayName": "Антон Титовец" - }, - "hasThumbnail": true, - "shared": false, - "ownedByMe": true, - "parents": [ - "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" - ], - "sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2", - "viewedByMe": true, - "headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ", - "writersCanShare": true, - "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220", - "modifiedTime": "2024-03-17T08:05:59.327Z", - "capabilities": { - "canRemoveContentRestriction": false, - "canModifyOwnerContentRestriction": true, - "canModifyLabels": false, - "canAcceptOwnership": false, - "canChangeSecurityUpdateEnabled": false, - "canMoveItemWithinDrive": true, - "canRemoveMyDriveParent": true, - "canReadLabels": false, - "canAddMyDriveParent": false, - "canShare": true, - "canModifyContent": true, - "canUntrash": true, - "canMoveItemOutOfDrive": true, - "canMoveItemIntoTeamDrive": true, - "canModifyContentRestriction": true, - "canReadRevisions": true, - "canTrash": true, - "canRemoveChildren": false, - "canListChildren": false, - "canDownload": true, - "canDelete": true, - "canRename": true, - "canChangeCopyRequiresWriterPermission": true, - "canAddChildren": false, - "canComment": true, - "canModifyEditorContentRestriction": true, - "canMoveChildrenWithinDrive": false, - "canCopy": true, - "canChangeViewersCanCopyContent": true, - "canEdit": true - }, - "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", - "copyRequiresWriterPermission": false, - "fileExtension": "jpg", - "originalFilename": "Новый файл.jpg", - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", - "viewersCanCopyContent": true, - "mimeType": "image/jpeg", - "kind": "drive#file", - "size": "2114025" - } - ] - -``` +--- +sidebar_position: 3 +--- + +# Получить список файлов + Получает список файлов + + +*Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяСодержит | --querry | Строка | Отбор по имени | + | Каталог | --catalog | Строка | Отбор по ID каталога родителя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов + +```bsl title="Пример кода" + + + Каталог = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; + Ответ = OPI_GoogleDrive.ПолучитьСписокФайлов(Токен, , Каталог); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ПолучитьСписокФайлов --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" + + +``` + + +```json title="Результат" + +[ + { + "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", + "linkShareMetadata": { + "securityUpdateEnabled": true, + "securityUpdateEligible": false + }, + "imageMediaMetadata": { + "exposureBias": 0, + "focalLength": 5.2, + "exposureTime": 0.00125, + "cameraMake": "SONY", + "isoSpeed": 100, + "time": "2012:08:03 08:21:50", + "width": 3264, + "cameraModel": "DSC-H7", + "whiteBalance": "Auto", + "colorSpace": "sRGB", + "aperture": 5.6, + "exposureMode": "Auto", + "rotation": 0, + "height": 2448, + "meteringMode": "Pattern", + "maxApertureValue": 2.875, + "flashUsed": true + }, + "modifiedByMe": true, + "thumbnailVersion": "1", + "fullFileExtension": "jpg", + "quotaBytesUsed": "2114025", + "viewedByMeTime": "2024-03-17T08:09:01.753Z", + "permissionIds": [ + "07468399490707249352" + ], + "modifiedByMeTime": "2024-03-17T08:05:59.327Z", + "explicitlyTrashed": false, + "trashed": false, + "description": "Это новый файл", + "createdTime": "2024-03-17T08:05:59.327Z", + "id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD", + "starred": false, + "spaces": [ + "drive" + ], + "name": "Новый файл.jpg", + "permissions": [ + { + "pendingOwner": false, + "role": "owner", + "emailAddress": "bayselonarrend@gmail.com", + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "kind": "drive#permission", + "type": "user", + "deleted": false, + "displayName": "Антон Титовец", + "id": "07468399490707249352" + } + ], + "webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download", + "isAppAuthorized": true, + "webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk", + "version": "4", + "owners": [ + { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + } + ], + "lastModifyingUser": { + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "kind": "drive#user", + "displayName": "Антон Титовец" + }, + "hasThumbnail": true, + "shared": false, + "ownedByMe": true, + "parents": [ + "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" + ], + "sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2", + "viewedByMe": true, + "headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ", + "writersCanShare": true, + "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220", + "modifiedTime": "2024-03-17T08:05:59.327Z", + "capabilities": { + "canRemoveContentRestriction": false, + "canModifyOwnerContentRestriction": true, + "canModifyLabels": false, + "canAcceptOwnership": false, + "canChangeSecurityUpdateEnabled": false, + "canMoveItemWithinDrive": true, + "canRemoveMyDriveParent": true, + "canReadLabels": false, + "canAddMyDriveParent": false, + "canShare": true, + "canModifyContent": true, + "canUntrash": true, + "canMoveItemOutOfDrive": true, + "canMoveItemIntoTeamDrive": true, + "canModifyContentRestriction": true, + "canReadRevisions": true, + "canTrash": true, + "canRemoveChildren": false, + "canListChildren": false, + "canDownload": true, + "canDelete": true, + "canRename": true, + "canChangeCopyRequiresWriterPermission": true, + "canAddChildren": false, + "canComment": true, + "canModifyEditorContentRestriction": true, + "canMoveChildrenWithinDrive": false, + "canCopy": true, + "canChangeViewersCanCopyContent": true, + "canEdit": true + }, + "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", + "copyRequiresWriterPermission": false, + "fileExtension": "jpg", + "originalFilename": "Новый файл.jpg", + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", + "viewersCanCopyContent": true, + "mimeType": "image/jpeg", + "kind": "drive#file", + "size": "2114025" + } + ] + +``` 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 index 07b3d555d7..1f7f6cf4e6 100644 --- 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 @@ -1,146 +1,146 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию об объекте - Получает информацию о папке или файле по ID - - -*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор файла или каталога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; - - Ответ = OPI_GoogleDrive.ПолучитьИнформациюОбОбъекте(Токен, Идентификатор); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ПолучитьИнформациюОбОбъекте --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" - - -``` - - -```json title="Результат" - -{ - "linkShareMetadata": { - "securityUpdateEnabled": true, - "securityUpdateEligible": false - }, - "quotaBytesUsed": "0", - "folderColorRgb": "#8f8f8f", - "writersCanShare": true, - "lastModifyingUser": { - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "displayName": "Антон Титовец", - "kind": "drive#user" - }, - "modifiedByMe": true, - "capabilities": { - "canUntrash": true, - "canTrash": true, - "canRemoveMyDriveParent": true, - "canRemoveContentRestriction": false, - "canRemoveChildren": true, - "canMoveItemWithinDrive": true, - "canMoveItemOutOfDrive": true, - "canMoveItemIntoTeamDrive": true, - "canModifyLabels": false, - "canModifyOwnerContentRestriction": false, - "canReadRevisions": false, - "canModifyContentRestriction": false, - "canShare": true, - "canModifyContent": true, - "canDownload": true, - "canMoveChildrenWithinDrive": true, - "canCopy": false, - "canModifyEditorContentRestriction": false, - "canChangeSecurityUpdateEnabled": false, - "canRename": true, - "canChangeCopyRequiresWriterPermission": false, - "canDelete": true, - "canChangeViewersCanCopyContent": false, - "canEdit": true, - "canReadLabels": false, - "canAddMyDriveParent": false, - "canComment": true, - "canAddChildren": true, - "canListChildren": true, - "canAcceptOwnership": false - }, - "copyRequiresWriterPermission": false, - "modifiedTime": "2023-12-28T13:22:03.333Z", - "createdTime": "2023-12-28T13:22:00.683Z", - "viewedByMeTime": "2023-12-28T13:22:00.683Z", - "viewedByMe": true, - "shared": false, - "hasThumbnail": false, - "version": "3", - "owners": [ - { - "emailAddress": "bayselonarrend@gmail.com", - "permissionId": "07468399490707249352", - "me": true, - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "displayName": "Антон Титовец", - "kind": "drive#user" - } - ], - "isAppAuthorized": false, - "webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm", - "spaces": [ - "drive" - ], - "modifiedByMeTime": "2023-12-28T13:22:03.333Z", - "permissionIds": [ - "07468399490707249352" - ], - "explicitlyTrashed": false, - "parents": [ - "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ" - ], - "ownedByMe": true, - "trashed": false, - "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", - "viewersCanCopyContent": true, - "mimeType": "application/vnd.google-apps.folder", - "permissions": [ - { - "pendingOwner": false, - "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", - "role": "owner", - "emailAddress": "bayselonarrend@gmail.com", - "type": "user", - "deleted": false, - "displayName": "Антон Титовец", - "id": "07468399490707249352", - "kind": "drive#permission" - } - ], - "name": "ОПИ", - "starred": false, - "id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa", - "kind": "drive#file", - "thumbnailVersion": "0" - } - -``` +--- +sidebar_position: 1 +--- + +# Получить информацию об объекте + Получает информацию о папке или файле по ID + + +*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор файла или каталога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; + + Ответ = OPI_GoogleDrive.ПолучитьИнформациюОбОбъекте(Токен, Идентификатор); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ПолучитьИнформациюОбОбъекте --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" + + +``` + + +```json title="Результат" + +{ + "linkShareMetadata": { + "securityUpdateEnabled": true, + "securityUpdateEligible": false + }, + "quotaBytesUsed": "0", + "folderColorRgb": "#8f8f8f", + "writersCanShare": true, + "lastModifyingUser": { + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "displayName": "Антон Титовец", + "kind": "drive#user" + }, + "modifiedByMe": true, + "capabilities": { + "canUntrash": true, + "canTrash": true, + "canRemoveMyDriveParent": true, + "canRemoveContentRestriction": false, + "canRemoveChildren": true, + "canMoveItemWithinDrive": true, + "canMoveItemOutOfDrive": true, + "canMoveItemIntoTeamDrive": true, + "canModifyLabels": false, + "canModifyOwnerContentRestriction": false, + "canReadRevisions": false, + "canModifyContentRestriction": false, + "canShare": true, + "canModifyContent": true, + "canDownload": true, + "canMoveChildrenWithinDrive": true, + "canCopy": false, + "canModifyEditorContentRestriction": false, + "canChangeSecurityUpdateEnabled": false, + "canRename": true, + "canChangeCopyRequiresWriterPermission": false, + "canDelete": true, + "canChangeViewersCanCopyContent": false, + "canEdit": true, + "canReadLabels": false, + "canAddMyDriveParent": false, + "canComment": true, + "canAddChildren": true, + "canListChildren": true, + "canAcceptOwnership": false + }, + "copyRequiresWriterPermission": false, + "modifiedTime": "2023-12-28T13:22:03.333Z", + "createdTime": "2023-12-28T13:22:00.683Z", + "viewedByMeTime": "2023-12-28T13:22:00.683Z", + "viewedByMe": true, + "shared": false, + "hasThumbnail": false, + "version": "3", + "owners": [ + { + "emailAddress": "bayselonarrend@gmail.com", + "permissionId": "07468399490707249352", + "me": true, + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "displayName": "Антон Титовец", + "kind": "drive#user" + } + ], + "isAppAuthorized": false, + "webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm", + "spaces": [ + "drive" + ], + "modifiedByMeTime": "2023-12-28T13:22:03.333Z", + "permissionIds": [ + "07468399490707249352" + ], + "explicitlyTrashed": false, + "parents": [ + "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ" + ], + "ownedByMe": true, + "trashed": false, + "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", + "viewersCanCopyContent": true, + "mimeType": "application/vnd.google-apps.folder", + "permissions": [ + { + "pendingOwner": false, + "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", + "role": "owner", + "emailAddress": "bayselonarrend@gmail.com", + "type": "user", + "deleted": false, + "displayName": "Антон Титовец", + "id": "07468399490707249352", + "kind": "drive#permission" + } + ], + "name": "ОПИ", + "starred": false, + "id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa", + "kind": "drive#file", + "thumbnailVersion": "0" + } + +``` 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 index f3038e8797..0fedd96517 100644 --- 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 @@ -1,52 +1,52 @@ ---- -sidebar_position: 8 ---- - -# Обновить файл - Обновляет двоичные данные файла - - -*Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --object | Строка | Идентификатор обновляемого объекта | - | Файл | --file | ДвоичныеДанные,Строка | Файл источник обновления | - | НовоеИмя | --title | Строка | Новое имя файла (если необходимо) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - НовоеИмя = "Обновленный файл.jpeg"; - КартинкаЗамены = "C:\OPI\image2.jpg"; - Идентификатор = "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ"; - - Ответ = OPI_GoogleDrive.ОбновитьФайл(Токен, Идентификатор, КартинкаЗамены, НовоеИмя) //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ОбновитьФайл --token %token% --object "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ" --file %file% --title "Обновленный файл.jpeg" - - -``` - - -```json title="Результат" - -{ - "mimeType": "image/jpeg", - "name": "Обновленный файл.jpg", - "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 8 +--- + +# Обновить файл + Обновляет двоичные данные файла + + +*Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор обновляемого объекта | + | Файл | --file | ДвоичныеДанные,Строка | Файл источник обновления | + | НовоеИмя | --title | Строка | Новое имя файла (если необходимо) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + НовоеИмя = "Обновленный файл.jpeg"; + КартинкаЗамены = "C:\OPI\image2.jpg"; + Идентификатор = "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ"; + + Ответ = OPI_GoogleDrive.ОбновитьФайл(Токен, Идентификатор, КартинкаЗамены, НовоеИмя) //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ОбновитьФайл --token %token% --object "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ" --file %file% --title "Обновленный файл.jpeg" + + +``` + + +```json title="Результат" + +{ + "mimeType": "image/jpeg", + "name": "Обновленный файл.jpg", + "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", + "kind": "drive#file" + } + +``` 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 index 5b53e8b7ac..14d779f141 100644 --- 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 @@ -1,55 +1,55 @@ ---- -sidebar_position: 4 ---- - -# Загрузить файл - Загружает файл на диск - - -*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) ЭкспортВозврат УправлениеФайлом(Токен, Файл, Описание);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Файл | --file | ДвоичныеДанные,Строка | Загружаемый файл | - | Описание | --props | Соответствие Из КлючИЗначение | JSON описания или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Описание = Новый Соответствие; - Описание.Вставить("MIME" , "image/jpeg"); - Описание.Вставить("Имя" , "Новый файл.jpg"); - Описание.Вставить("Описание" , "Это новый файл"); - Описание.Вставить("Родитель" , "root"); - - Картинка = "C:\OPI\image.jpg"; - - Ответ = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Картинка, Описание); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint gdrive ЗагрузитьФайл --token %token% --file %file% --props %props% - - -``` - - -```json title="Результат" - -{ - "mimeType": "image/jpeg", - "name": "Новый файл.jpg", - "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", - "kind": "drive#file" - } - -``` +--- +sidebar_position: 4 +--- + +# Загрузить файл + Загружает файл на диск + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) ЭкспортВозврат УправлениеФайлом(Токен, Файл, Описание);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Файл | --file | ДвоичныеДанные,Строка | Загружаемый файл | + | Описание | --props | Соответствие Из КлючИЗначение | JSON описания или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Описание = Новый Соответствие; + Описание.Вставить("MIME" , "image/jpeg"); + Описание.Вставить("Имя" , "Новый файл.jpg"); + Описание.Вставить("Описание" , "Это новый файл"); + Описание.Вставить("Родитель" , "root"); + + Картинка = "C:\OPI\image.jpg"; + + Ответ = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Картинка, Описание); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint gdrive ЗагрузитьФайл --token %token% --file %file% --props %props% + + +``` + + +```json title="Результат" + +{ + "mimeType": "image/jpeg", + "name": "Новый файл.jpg", + "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", + "kind": "drive#file" + } + +``` diff --git a/docs/ru/md/Google_Sheets/Book-work/Create-book.md b/docs/ru/md/Google_Sheets/Book-work/Create-book.md index d069ba5c50..3dbe403fa1 100644 --- a/docs/ru/md/Google_Sheets/Book-work/Create-book.md +++ b/docs/ru/md/Google_Sheets/Book-work/Create-book.md @@ -1,208 +1,208 @@ ---- -sidebar_position: 1 ---- - -# Создать книгу - Создает новую книгу - - -*Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Наименование | --title | Строка | Наименование | - | МассивИменЛистов | --sheets | Массив из Строка | Массив имен для добавления новых листов в книгу | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - МассивИменЛистов = Новый Массив; - МассивИменЛистов.Добавить("Лист1"); - МассивИменЛистов.Добавить("Лист2"); - - Наименование = "Тестовая таблица"; - - Ответ = OPI_GoogleSheets.СоздатьКнигу(Токен, Наименование, МассивИменЛистов); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets СоздатьКнигу --token %token% --title "Тестовая таблица" --sheets %sheets% - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "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": 1999766427, - "title": "Лист1", - "index": 0, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - }, - { - "properties": { - "sheetId": 225184494, - "title": "Лист2", - "index": 1, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - ], - "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать книгу + Создает новую книгу + + +*Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Наименование | --title | Строка | Наименование | + | МассивИменЛистов | --sheets | Массив из Строка | Массив имен для добавления новых листов в книгу | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + МассивИменЛистов = Новый Массив; + МассивИменЛистов.Добавить("Лист1"); + МассивИменЛистов.Добавить("Лист2"); + + Наименование = "Тестовая таблица"; + + Ответ = OPI_GoogleSheets.СоздатьКнигу(Токен, Наименование, МассивИменЛистов); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets СоздатьКнигу --token %token% --title "Тестовая таблица" --sheets %sheets% + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "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": 1999766427, + "title": "Лист1", + "index": 0, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + }, + { + "properties": { + "sheetId": 225184494, + "title": "Лист2", + "index": 1, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + ], + "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" + } + +``` diff --git a/docs/ru/md/Google_Sheets/Book-work/Edit-book-title.md b/docs/ru/md/Google_Sheets/Book-work/Edit-book-title.md index bf58980b92..79ae21eebd 100644 --- a/docs/ru/md/Google_Sheets/Book-work/Edit-book-title.md +++ b/docs/ru/md/Google_Sheets/Book-work/Edit-book-title.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 3 ---- - -# Изменить наименование книги - Изменяет наименование существующей книги - - -*Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | Наименование | --title | Строка | Новое наименование | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Наименование = "Тестовая таблица (изм.)"; - - Ответ = OPI_GoogleSheets.ИзменитьНаименованиеКниги(Токен, Книга, Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets ИзменитьНаименованиеКниги --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Тестовая таблица (изм.)" - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "replies": [ - {} - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Изменить наименование книги + Изменяет наименование существующей книги + + +*Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | Наименование | --title | Строка | Новое наименование | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Наименование = "Тестовая таблица (изм.)"; + + Ответ = OPI_GoogleSheets.ИзменитьНаименованиеКниги(Токен, Книга, Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets ИзменитьНаименованиеКниги --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Тестовая таблица (изм.)" + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "replies": [ + {} + ] + } + +``` diff --git a/docs/ru/md/Google_Sheets/Book-work/Get-book.md b/docs/ru/md/Google_Sheets/Book-work/Get-book.md index d1cf51942c..6aca2985db 100644 --- a/docs/ru/md/Google_Sheets/Book-work/Get-book.md +++ b/docs/ru/md/Google_Sheets/Book-work/Get-book.md @@ -1,203 +1,203 @@ ---- -sidebar_position: 2 ---- - -# Получить книгу - Получает информацию о книге по ID - - -*Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Идентификатор | --spreadsheet | Строка | Идентификатор книги | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Идентификатор = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - - Ответ = OPI_GoogleSheets.ПолучитьКнигу(Токен, Идентификатор); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets ПолучитьКнигу --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "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": 1999766427, - "title": "Лист1", - "index": 0, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - }, - { - "properties": { - "sheetId": 225184494, - "title": "Лист2", - "index": 1, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - ], - "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" - } - -``` +--- +sidebar_position: 2 +--- + +# Получить книгу + Получает информацию о книге по ID + + +*Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --spreadsheet | Строка | Идентификатор книги | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Идентификатор = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + + Ответ = OPI_GoogleSheets.ПолучитьКнигу(Токен, Идентификатор); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets ПолучитьКнигу --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "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": 1999766427, + "title": "Лист1", + "index": 0, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + }, + { + "properties": { + "sheetId": 225184494, + "title": "Лист2", + "index": 1, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + ], + "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" + } + +``` diff --git a/docs/ru/md/Google_Sheets/Data-work/Clear-cells.md b/docs/ru/md/Google_Sheets/Data-work/Clear-cells.md index ba85a6a298..caa9cc6380 100644 --- a/docs/ru/md/Google_Sheets/Data-work/Clear-cells.md +++ b/docs/ru/md/Google_Sheets/Data-work/Clear-cells.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 2 ---- - -# Очистить ячейки - Очищает значение в ячейках - - -*Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для очистки | - | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - МассивЯчеек = Новый Массив; - МассивЯчеек.Добавить("B2"); - МассивЯчеек.Добавить("A3"); - МассивЯчеек.Добавить("B4"); - - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Лист = "Лист2"; - - Ответ = OPI_GoogleSheets.ОчиститьЯчейки(Токен, Книга, МассивЯчеек, Лист); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets ОчиститьЯчейки --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Лист2" - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "clearedRanges": [ - "'Лист2'!B2", - "'Лист2'!A3", - "'Лист2'!B4" - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Очистить ячейки + Очищает значение в ячейках + + +*Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для очистки | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + МассивЯчеек = Новый Массив; + МассивЯчеек.Добавить("B2"); + МассивЯчеек.Добавить("A3"); + МассивЯчеек.Добавить("B4"); + + Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Лист = "Лист2"; + + Ответ = OPI_GoogleSheets.ОчиститьЯчейки(Токен, Книга, МассивЯчеек, Лист); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets ОчиститьЯчейки --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Лист2" + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "clearedRanges": [ + "'Лист2'!B2", + "'Лист2'!A3", + "'Лист2'!B4" + ] + } + +``` diff --git a/docs/ru/md/Google_Sheets/Data-work/Get-cell-values.md b/docs/ru/md/Google_Sheets/Data-work/Get-cell-values.md index 415dc837a1..29bef56c11 100644 --- a/docs/ru/md/Google_Sheets/Data-work/Get-cell-values.md +++ b/docs/ru/md/Google_Sheets/Data-work/Get-cell-values.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 3 ---- - -# Получить значения ячеек - Получает значения ячеек таблицы - - -*Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для получения (весь лист, если не заполнено) | - | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - МассивЯчеек = Новый Массив; - МассивЯчеек.Добавить("B2"); - МассивЯчеек.Добавить("A3"); - МассивЯчеек.Добавить("B4"); - - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Лист = "Лист2"; - - Ответ = OPI_GoogleSheets.ПолучитьЗначенияЯчеек(Токен, Книга, МассивЯчеек, Лист); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets ПолучитьЗначенияЯчеек --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Лист2" - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "valueRanges": [ - { - "range": "'Лист2'!B2", - "majorDimension": "ROWS", - "values": [ - [ - "Это B2" - ] - ] - }, - { - "range": "'Лист2'!A3", - "majorDimension": "ROWS", - "values": [ - [ - "Это A3" - ] - ] - }, - { - "range": "'Лист2'!B4", - "majorDimension": "ROWS", - "values": [ - [ - "Это B4" - ] - ] - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Получить значения ячеек + Получает значения ячеек таблицы + + +*Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для получения (весь лист, если не заполнено) | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + МассивЯчеек = Новый Массив; + МассивЯчеек.Добавить("B2"); + МассивЯчеек.Добавить("A3"); + МассивЯчеек.Добавить("B4"); + + Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Лист = "Лист2"; + + Ответ = OPI_GoogleSheets.ПолучитьЗначенияЯчеек(Токен, Книга, МассивЯчеек, Лист); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets ПолучитьЗначенияЯчеек --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Лист2" + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "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-work/Set-cell-values.md b/docs/ru/md/Google_Sheets/Data-work/Set-cell-values.md index 475f3dd27a..4f0efbb443 100644 --- a/docs/ru/md/Google_Sheets/Data-work/Set-cell-values.md +++ b/docs/ru/md/Google_Sheets/Data-work/Set-cell-values.md @@ -1,121 +1,121 @@ ---- -sidebar_position: 1 ---- - -# Установить значения ячеек - Устанавливает значения ячеек листа - - -*Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | ID книги | - | СоответствиеЗначений | --data | Соответствие Из КлючИЗначение | Данные заполнения, где ключ это имя ячейки вида A1 | - | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | - | ОсновноеИзмерение | --dim | Строка | Основное измерение при заполнении диапазона массивом | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - СоответствиеЗначений = Новый Соответствие; - СоответствиеЗначений.Вставить("A1", "Это A1"); - СоответствиеЗначений.Вставить("A2", "Это A2"); - СоответствиеЗначений.Вставить("B2", "Это B2"); - СоответствиеЗначений.Вставить("B3", "Это B3"); - СоответствиеЗначений.Вставить("A3", "Это A3"); - СоответствиеЗначений.Вставить("A4", "Это A4"); - СоответствиеЗначений.Вставить("B1", "Это B1"); - СоответствиеЗначений.Вставить("B4", "Это B4"); - - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Лист = "Лист2"; - - Ответ = OPI_GoogleSheets.УстановитьЗначенияЯчеек(Токен, Книга, СоответствиеЗначений, Лист); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets УстановитьЗначенияЯчеек --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --data %data% --sheetname "Лист2" --dim %dim% - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "totalUpdatedRows": 4, - "totalUpdatedColumns": 2, - "totalUpdatedCells": 8, - "totalUpdatedSheets": 1, - "responses": [ - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!A1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!A2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!B2", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!B3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!A3", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!A4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!B1", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - }, - { - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "updatedRange": "'Лист2'!B4", - "updatedRows": 1, - "updatedColumns": 1, - "updatedCells": 1 - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Установить значения ячеек + Устанавливает значения ячеек листа + + +*Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | СоответствиеЗначений | --data | Соответствие Из КлючИЗначение | Данные заполнения, где ключ это имя ячейки вида A1 | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + | ОсновноеИзмерение | --dim | Строка | Основное измерение при заполнении диапазона массивом | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + СоответствиеЗначений = Новый Соответствие; + СоответствиеЗначений.Вставить("A1", "Это A1"); + СоответствиеЗначений.Вставить("A2", "Это A2"); + СоответствиеЗначений.Вставить("B2", "Это B2"); + СоответствиеЗначений.Вставить("B3", "Это B3"); + СоответствиеЗначений.Вставить("A3", "Это A3"); + СоответствиеЗначений.Вставить("A4", "Это A4"); + СоответствиеЗначений.Вставить("B1", "Это B1"); + СоответствиеЗначений.Вставить("B4", "Это B4"); + + Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Лист = "Лист2"; + + Ответ = OPI_GoogleSheets.УстановитьЗначенияЯчеек(Токен, Книга, СоответствиеЗначений, Лист); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets УстановитьЗначенияЯчеек --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --data %data% --sheetname "Лист2" --dim %dim% + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "totalUpdatedRows": 4, + "totalUpdatedColumns": 2, + "totalUpdatedCells": 8, + "totalUpdatedSheets": 1, + "responses": [ + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!A1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!A2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!B2", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!B3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!A3", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!A4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!B1", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + }, + { + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "updatedRange": "'Лист2'!B4", + "updatedRows": 1, + "updatedColumns": 1, + "updatedCells": 1 + } + ] + } + +``` diff --git a/docs/ru/md/Google_Sheets/Sheet-work/Add-sheet.md b/docs/ru/md/Google_Sheets/Sheet-work/Add-sheet.md index e3a63e0a48..381fa0b0a4 100644 --- a/docs/ru/md/Google_Sheets/Sheet-work/Add-sheet.md +++ b/docs/ru/md/Google_Sheets/Sheet-work/Add-sheet.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 1 ---- - -# Добавить лист - Добавляет новый лист в книгу - - -*Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | Идентификатор книги | - | Наименование | --title | Строка | Наименование нового листа | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Наименование = "Тестовый лист"; - - Ответ = OPI_GoogleSheets.ДобавитьЛист(Токен, Книга, Наименование); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets ДобавитьЛист --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Тестовый лист" - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "replies": [ - { - "addSheet": { - "properties": { - "sheetId": 321892522, - "title": "Тестовый лист", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - } - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Добавить лист + Добавляет новый лист в книгу + + +*Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | Идентификатор книги | + | Наименование | --title | Строка | Наименование нового листа | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Наименование = "Тестовый лист"; + + Ответ = OPI_GoogleSheets.ДобавитьЛист(Токен, Книга, Наименование); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets ДобавитьЛист --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Тестовый лист" + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "replies": [ + { + "addSheet": { + "properties": { + "sheetId": 321892522, + "title": "Тестовый лист", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + } + } + ] + } + +``` diff --git a/docs/ru/md/Google_Sheets/Sheet-work/Copy-sheet.md b/docs/ru/md/Google_Sheets/Sheet-work/Copy-sheet.md index 6b19720c0a..c21bc8e74a 100644 --- a/docs/ru/md/Google_Sheets/Sheet-work/Copy-sheet.md +++ b/docs/ru/md/Google_Sheets/Sheet-work/Copy-sheet.md @@ -1,56 +1,56 @@ ---- -sidebar_position: 3 ---- - -# Копировать лист - Копирует лист из одной книги в другую - - -*Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Откуда | --from | Строка | ID книги источника | - | Куда | --to | Строка | ID книги приемника | - | Лист | --sheet | Строка | ID копируемого листа | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Откуда = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Куда = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; - Лист = "25093199"; - - Ответ = OPI_GoogleSheets.КопироватьЛист(Токен, Откуда, Куда, Лист); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets КопироватьЛист --token %token% --from "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --to "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s" --sheet "25093199" - - -``` - - -```json title="Результат" - -{ - "sheetId": 1790807910, - "title": "Лист2 (копия)", - "index": 2, - "sheetType": "GRID", - "gridProperties": { - "rowCount": 1000, - "columnCount": 26 - } - } - -``` +--- +sidebar_position: 3 +--- + +# Копировать лист + Копирует лист из одной книги в другую + + +*Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --from | Строка | ID книги источника | + | Куда | --to | Строка | ID книги приемника | + | Лист | --sheet | Строка | ID копируемого листа | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Откуда = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Куда = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; + Лист = "25093199"; + + Ответ = OPI_GoogleSheets.КопироватьЛист(Токен, Откуда, Куда, Лист); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets КопироватьЛист --token %token% --from "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --to "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s" --sheet "25093199" + + +``` + + +```json title="Результат" + +{ + "sheetId": 1790807910, + "title": "Лист2 (копия)", + "index": 2, + "sheetType": "GRID", + "gridProperties": { + "rowCount": 1000, + "columnCount": 26 + } + } + +``` diff --git a/docs/ru/md/Google_Sheets/Sheet-work/Delete-sheet.md b/docs/ru/md/Google_Sheets/Sheet-work/Delete-sheet.md index bdc55dfec3..a15d0e0eda 100644 --- a/docs/ru/md/Google_Sheets/Sheet-work/Delete-sheet.md +++ b/docs/ru/md/Google_Sheets/Sheet-work/Delete-sheet.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 2 ---- - -# Удалить лист - Удаляет лист из книги - - -*Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Книга | --spreadsheet | Строка | Идентификатор книги | - | Лист | --sheet | Строка | Идентификатор удаляемого листа | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google - -```bsl title="Пример кода" - - - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Лист = "1790807910"; - - Ответ = OPI_GoogleSheets.УдалитьЛист(Токен, Книга, Лист); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint gsheets УдалитьЛист --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --sheet "1790807910" - - -``` - - -```json title="Результат" - -{ - "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", - "replies": [ - {} - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Удалить лист + Удаляет лист из книги + + +*Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | Идентификатор книги | + | Лист | --sheet | Строка | Идентификатор удаляемого листа | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; + Лист = "1790807910"; + + Ответ = OPI_GoogleSheets.УдалитьЛист(Токен, Книга, Лист); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint gsheets УдалитьЛист --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --sheet "1790807910" + + +``` + + +```json title="Результат" + +{ + "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", + "replies": [ + {} + ] + } + +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Create-block.md b/docs/ru/md/Notion/Blocks-managment/Create-block.md index 4047b63623..3a0cdb2b97 100644 --- a/docs/ru/md/Notion/Blocks-managment/Create-block.md +++ b/docs/ru/md/Notion/Blocks-managment/Create-block.md @@ -1,102 +1,102 @@ ---- -sidebar_position: 1 ---- - -# Создать блок - Создает новый блок на основе существующего блока - - -*Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --page | Строка | ID родительского блока или страницы | - | Блок | --block | Строка,Соответствие Из КлючИЗначение | ID блока или сам блок образец | - | ВставитьПосле | --prev | Строка | ID блока, после которого необходимо встаивть новый | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff9..."; - - Блок = OPI_Notion.ВернутьБлок(Токен, "ca18df269bd24407852b91c30e..."); //Блок как соответствие. С ним можно свершать манипуляции. - - Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, Блок); - Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, "46c1500ed40c4e89ba6a229003..."); - Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, "aa4137d4c8cc445d9f969c3968..."); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion СоздатьБлок --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --block %block% --prev %prev% - - -``` - - -```json title="Результат" - -{ - "request_id": "4de46f5b-d38b-4df5-b26e-32127db1096b", - "block": {}, - "type": "block", - "has_more": false, - "next_cursor": null, - "results": [ - { - "type": "numbered_list_item", - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T17:11:00.000Z", - "created_time": "2024-01-26T17:11:00.000Z", - "has_children": false, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "b147fabd-53ea-42d5-bd23-85968f627f88", - "numbered_list_item": { - "color": "default", - "rich_text": [ - { - "plain_text": "Во-вторых, стильно", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Во-вторых, стильно" - }, - "href": null, - "type": "text" - } - ] - }, - "object": "block" - } - ], - "object": "list" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать блок + Создает новый блок на основе существующего блока + + +*Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID родительского блока или страницы | + | Блок | --block | Строка,Соответствие Из КлючИЗначение | ID блока или сам блок образец | + | ВставитьПосле | --prev | Строка | ID блока, после которого необходимо встаивть новый | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff9..."; + + Блок = OPI_Notion.ВернутьБлок(Токен, "ca18df269bd24407852b91c30e..."); //Блок как соответствие. С ним можно свершать манипуляции. + + Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, Блок); + Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, "46c1500ed40c4e89ba6a229003..."); + Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, "aa4137d4c8cc445d9f969c3968..."); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion СоздатьБлок --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --block %block% --prev %prev% + + +``` + + +```json title="Результат" + +{ + "request_id": "4de46f5b-d38b-4df5-b26e-32127db1096b", + "block": {}, + "type": "block", + "has_more": false, + "next_cursor": null, + "results": [ + { + "type": "numbered_list_item", + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T17:11:00.000Z", + "created_time": "2024-01-26T17:11:00.000Z", + "has_children": false, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "b147fabd-53ea-42d5-bd23-85968f627f88", + "numbered_list_item": { + "color": "default", + "rich_text": [ + { + "plain_text": "Во-вторых, стильно", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Во-вторых, стильно" + }, + "href": null, + "type": "text" + } + ] + }, + "object": "block" + } + ], + "object": "list" + } + +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Delete-block.md b/docs/ru/md/Notion/Blocks-managment/Delete-block.md index 022ae98321..3f492c5d4b 100644 --- a/docs/ru/md/Notion/Blocks-managment/Delete-block.md +++ b/docs/ru/md/Notion/Blocks-managment/Delete-block.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 4 ---- - -# Удалить блок - Удаляет блок по ID - - -*Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДБлока | --block | Строка | ID блока | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Блок = "ca18df269bd24407852b91c30..."; - - Ответ = OPI_Notion.УдалитьБлок(Токен, ИДБлока); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion УдалитьБлок --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% - - -``` - - -```json title="Результат" - -{ - "request_id": "62b95ed2-c9af-4be8-b75a-f6e4f69aef14", - "to_do": { - "color": "default", - "checked": false, - "rich_text": [ - { - "plain_text": "Привет", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Привет" - }, - "href": null, - "type": "text" - } - ] - }, - "type": "to_do", - "archived": true, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:43:00.000Z", - "created_time": "2024-01-26T11:03:00.000Z", - "has_children": false, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", - "object": "block" - } - -``` +--- +sidebar_position: 4 +--- + +# Удалить блок + Удаляет блок по ID + + +*Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Блок = "ca18df269bd24407852b91c30..."; + + Ответ = OPI_Notion.УдалитьБлок(Токен, ИДБлока); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion УдалитьБлок --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% + + +``` + + +```json title="Результат" + +{ + "request_id": "62b95ed2-c9af-4be8-b75a-f6e4f69aef14", + "to_do": { + "color": "default", + "checked": false, + "rich_text": [ + { + "plain_text": "Привет", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Привет" + }, + "href": null, + "type": "text" + } + ] + }, + "type": "to_do", + "archived": true, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:43:00.000Z", + "created_time": "2024-01-26T11:03:00.000Z", + "has_children": false, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", + "object": "block" + } + +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-block.md b/docs/ru/md/Notion/Blocks-managment/Return-block.md index b277ca3e63..ef40287c0b 100644 --- a/docs/ru/md/Notion/Blocks-managment/Return-block.md +++ b/docs/ru/md/Notion/Blocks-managment/Return-block.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 2 ---- - -# Вернуть блок. - - - -*Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДБлока | --block | Строка | ID блока | - | ТолькоОснова | --core | Булево | Истина > служебные поля удаляются, остается только сам блок | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Блок = "ca18df269bd24407852b91c30..."; - - Ответ = OPI_Notion.ВернутьБлок(Токен, ИДБлока); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ВернутьБлок --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% --core %core% - - -``` - - -```json title="Результат" - -{ - "request_id": "031886cc-537d-4025-b480-ecfdc9f2870c", - "to_do": { - "color": "default", - "checked": false, - "rich_text": [ - { - "plain_text": "Привет", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Привет" - }, - "href": null, - "type": "text" - } - ] - }, - "type": "to_do", - "archived": true, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:43:00.000Z", - "created_time": "2024-01-26T11:03:00.000Z", - "has_children": false, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", - "object": "block" - } - -``` +--- +sidebar_position: 2 +--- + +# Вернуть блок. + + + +*Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока | + | ТолькоОснова | --core | Булево | Истина > служебные поля удаляются, остается только сам блок | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Блок = "ca18df269bd24407852b91c30..."; + + Ответ = OPI_Notion.ВернутьБлок(Токен, ИДБлока); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ВернутьБлок --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% --core %core% + + +``` + + +```json title="Результат" + +{ + "request_id": "031886cc-537d-4025-b480-ecfdc9f2870c", + "to_do": { + "color": "default", + "checked": false, + "rich_text": [ + { + "plain_text": "Привет", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Привет" + }, + "href": null, + "type": "text" + } + ] + }, + "type": "to_do", + "archived": true, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:43:00.000Z", + "created_time": "2024-01-26T11:03:00.000Z", + "has_children": false, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", + "object": "block" + } + +``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md index 9fee38cb5f..463dd19fe7 100644 --- a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md +++ b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md @@ -1,139 +1,139 @@ ---- -sidebar_position: 3 ---- - -# Вернуть дочерние блоки - Созвращает список дочерних блоков блока-родителя - - -*Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДБлока | --block | Строка | ID блока родителя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Блок = "46c1500ed40c4e89ba6a22900..."; - - Ответ = OPI_Notion.ВернутьДочерниеБлоки(Токен, ИДБлока); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ВернутьДочерниеБлоки --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% - - -``` - - -```json title="Результат" - -{ - "request_id": "fea2a37b-5507-451d-a4be-14433811a69e", - "block": {}, - "type": "block", - "has_more": false, - "next_cursor": null, - "results": [ - { - "type": "numbered_list_item", - "archived": false, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T20:33:00.000Z", - "created_time": "2024-01-26T17:02:00.000Z", - "has_children": false, - "parent": { - "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", - "type": "block_id" - }, - "last_edited_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "id": "aa4137d4-c8cc-445d-9f96-9c3968334e74", - "numbered_list_item": { - "color": "default", - "rich_text": [ - { - "plain_text": "Два", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Два" - }, - "href": null, - "type": "text" - } - ] - }, - "object": "block" - }, - { - "type": "numbered_list_item", - "archived": false, - "created_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "last_edited_time": "2024-01-26T20:33:00.000Z", - "created_time": "2024-01-26T20:30:00.000Z", - "has_children": false, - "parent": { - "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", - "type": "block_id" - }, - "last_edited_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "id": "6fb45895-0350-49d3-a5c7-e0cb1e24061e", - "numbered_list_item": { - "color": "default", - "rich_text": [ - { - "plain_text": "Три", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Три" - }, - "href": null, - "type": "text" - } - ] - }, - "object": "block" - } - ], - "object": "list" - } - -``` +--- +sidebar_position: 3 +--- + +# Вернуть дочерние блоки + Созвращает список дочерних блоков блока-родителя + + +*Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока родителя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Блок = "46c1500ed40c4e89ba6a22900..."; + + Ответ = OPI_Notion.ВернутьДочерниеБлоки(Токен, ИДБлока); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ВернутьДочерниеБлоки --token "secret_9RsfMrRMqZwqp0Zl0B..." --block %block% + + +``` + + +```json title="Результат" + +{ + "request_id": "fea2a37b-5507-451d-a4be-14433811a69e", + "block": {}, + "type": "block", + "has_more": false, + "next_cursor": null, + "results": [ + { + "type": "numbered_list_item", + "archived": false, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T20:33:00.000Z", + "created_time": "2024-01-26T17:02:00.000Z", + "has_children": false, + "parent": { + "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", + "type": "block_id" + }, + "last_edited_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "id": "aa4137d4-c8cc-445d-9f96-9c3968334e74", + "numbered_list_item": { + "color": "default", + "rich_text": [ + { + "plain_text": "Два", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Два" + }, + "href": null, + "type": "text" + } + ] + }, + "object": "block" + }, + { + "type": "numbered_list_item", + "archived": false, + "created_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "last_edited_time": "2024-01-26T20:33:00.000Z", + "created_time": "2024-01-26T20:30:00.000Z", + "has_children": false, + "parent": { + "block_id": "46c1500e-d40c-4e89-ba6a-229003d81ded", + "type": "block_id" + }, + "last_edited_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "id": "6fb45895-0350-49d3-a5c7-e0cb1e24061e", + "numbered_list_item": { + "color": "default", + "rich_text": [ + { + "plain_text": "Три", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Три" + }, + "href": null, + "type": "text" + } + ] + }, + "object": "block" + } + ], + "object": "list" + } + +``` diff --git a/docs/ru/md/Notion/Database-management/Create-database.md b/docs/ru/md/Notion/Database-management/Create-database.md index 930fda9886..e0e1937465 100644 --- a/docs/ru/md/Notion/Database-management/Create-database.md +++ b/docs/ru/md/Notion/Database-management/Create-database.md @@ -1,201 +1,201 @@ ---- -sidebar_position: 1 ---- - -# Создать базу данных - Создает базу данных - - -*Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --page | Строка | ID страницы родителя | - | Заголовок | --title | Строка | Заголовок базы данных | - | Свойства | --props | Структура Из Строка | Свойства базы данных | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff9..."; - Заголовок = "Эта база была создана из 1С"; - - Свойства = Новый Соответствие; - Свойства.Вставить("Имя" , "title"); //Поле с типом title - обязательно - Свойства.Вставить("Описание" , "rich_text"); - Свойства.Вставить("Номер" , "number"); - Свойства.Вставить("Статус" , "status"); - Свойства.Вставить("Дата создания" , "date"); - Свойства.Вставить("Картинка" , "files"); - Свойства.Вставить("Активен" , "checkbox"); - Свойства.Вставить("Сайт" , "url"); - Свойства.Вставить("Почта" , "email"); - Свойства.Вставить("Телефон" , "phone_number"); - Свойства.Вставить("Пользователь" , "people"); - - ВыборЗначения = Новый Соответствие; - ВыборЗначения.Вставить("Новый", "green"); - ВыборЗначения.Вставить("В работе", "yellow"); - ВыборЗначения.Вставить("Удаленный", "red"); - Свойства.Вставить("Статус", ВыборЗначения); - - Ответ = OPI_Notion.СоздатьБазуДанных(Токен, Родитель, Заголовок, Свойства); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion СоздатьБазуДанных --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "Эта база была создана из 1С" --props %props% - - -``` - - -```json title="Результат" - -{ - "request_id": "43adcae7-c8ee-4a7d-aba6-c2c43ad2c33b", - "public_url": null, - "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "properties": { - "Картинка": { - "files": {}, - "type": "files", - "name": "Картинка", - "id": "r%3Dfa" - }, - "Активен": { - "checkbox": {}, - "type": "checkbox", - "name": "Активен", - "id": "q%3FQF" - }, - "Телефон": { - "phone_number": {}, - "type": "phone_number", - "name": "Телефон", - "id": "hDII" - }, - "Пользователь": { - "people": {}, - "type": "people", - "name": "Пользователь", - "id": "%5D%40Md" - }, - "Сайт": { - "url": {}, - "type": "url", - "name": "Сайт", - "id": "THre" - }, - "Описание": { - "rich_text": {}, - "type": "rich_text", - "name": "Описание", - "id": "KnG%3F" - }, - "Статус": { - "select": { - "options": [ - { - "description": null, - "color": "red", - "name": "Удаленный", - "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" - }, - { - "description": null, - "color": "yellow", - "name": "В работе", - "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" - }, - { - "description": null, - "color": "green", - "name": "Новый", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - } - ] - }, - "type": "select", - "name": "Статус", - "id": "IDW%3C" - }, - "Номер": { - "type": "number", - "name": "Номер", - "number": { - "format": "number" - }, - "id": "CH__" - }, - "Дата создания": { - "date": {}, - "type": "date", - "name": "Дата создания", - "id": "BQN%5B" - }, - "Имя": { - "title": {}, - "type": "title", - "name": "Имя", - "id": "title" - }, - "Почта": { - "email": {}, - "type": "email", - "name": "Почта", - "id": "%3CO%3AD" - } - }, - "last_edited_time": "2024-01-26T16:49:00.000Z", - "description": [], - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "archived": false, - "icon": null, - "created_time": "2024-01-26T16:49:00.000Z", - "title": [ - { - "plain_text": "Эта база была создана из 1С", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Эта база была создана из 1С" - }, - "href": null, - "type": "text" - } - ], - "cover": null, - "is_inline": false, - "id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "object": "database" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать базу данных + Создает базу данных + + +*Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID страницы родителя | + | Заголовок | --title | Строка | Заголовок базы данных | + | Свойства | --props | Структура Из Строка | Свойства базы данных | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff9..."; + Заголовок = "Эта база была создана из 1С"; + + Свойства = Новый Соответствие; + Свойства.Вставить("Имя" , "title"); //Поле с типом title - обязательно + Свойства.Вставить("Описание" , "rich_text"); + Свойства.Вставить("Номер" , "number"); + Свойства.Вставить("Статус" , "status"); + Свойства.Вставить("Дата создания" , "date"); + Свойства.Вставить("Картинка" , "files"); + Свойства.Вставить("Активен" , "checkbox"); + Свойства.Вставить("Сайт" , "url"); + Свойства.Вставить("Почта" , "email"); + Свойства.Вставить("Телефон" , "phone_number"); + Свойства.Вставить("Пользователь" , "people"); + + ВыборЗначения = Новый Соответствие; + ВыборЗначения.Вставить("Новый", "green"); + ВыборЗначения.Вставить("В работе", "yellow"); + ВыборЗначения.Вставить("Удаленный", "red"); + Свойства.Вставить("Статус", ВыборЗначения); + + Ответ = OPI_Notion.СоздатьБазуДанных(Токен, Родитель, Заголовок, Свойства); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion СоздатьБазуДанных --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "Эта база была создана из 1С" --props %props% + + +``` + + +```json title="Результат" + +{ + "request_id": "43adcae7-c8ee-4a7d-aba6-c2c43ad2c33b", + "public_url": null, + "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "properties": { + "Картинка": { + "files": {}, + "type": "files", + "name": "Картинка", + "id": "r%3Dfa" + }, + "Активен": { + "checkbox": {}, + "type": "checkbox", + "name": "Активен", + "id": "q%3FQF" + }, + "Телефон": { + "phone_number": {}, + "type": "phone_number", + "name": "Телефон", + "id": "hDII" + }, + "Пользователь": { + "people": {}, + "type": "people", + "name": "Пользователь", + "id": "%5D%40Md" + }, + "Сайт": { + "url": {}, + "type": "url", + "name": "Сайт", + "id": "THre" + }, + "Описание": { + "rich_text": {}, + "type": "rich_text", + "name": "Описание", + "id": "KnG%3F" + }, + "Статус": { + "select": { + "options": [ + { + "description": null, + "color": "red", + "name": "Удаленный", + "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" + }, + { + "description": null, + "color": "yellow", + "name": "В работе", + "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" + }, + { + "description": null, + "color": "green", + "name": "Новый", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + } + ] + }, + "type": "select", + "name": "Статус", + "id": "IDW%3C" + }, + "Номер": { + "type": "number", + "name": "Номер", + "number": { + "format": "number" + }, + "id": "CH__" + }, + "Дата создания": { + "date": {}, + "type": "date", + "name": "Дата создания", + "id": "BQN%5B" + }, + "Имя": { + "title": {}, + "type": "title", + "name": "Имя", + "id": "title" + }, + "Почта": { + "email": {}, + "type": "email", + "name": "Почта", + "id": "%3CO%3AD" + } + }, + "last_edited_time": "2024-01-26T16:49:00.000Z", + "description": [], + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "archived": false, + "icon": null, + "created_time": "2024-01-26T16:49:00.000Z", + "title": [ + { + "plain_text": "Эта база была создана из 1С", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Эта база была создана из 1С" + }, + "href": null, + "type": "text" + } + ], + "cover": null, + "is_inline": false, + "id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "object": "database" + } + +``` diff --git a/docs/ru/md/Notion/Database-management/Edit-database-properties.md b/docs/ru/md/Notion/Database-management/Edit-database-properties.md index 25a8ca4046..3d24f847d1 100644 --- a/docs/ru/md/Notion/Database-management/Edit-database-properties.md +++ b/docs/ru/md/Notion/Database-management/Edit-database-properties.md @@ -1,200 +1,200 @@ ---- -sidebar_position: 3 ---- - -# Изменить свойства базы - Изменяет свойства существующей базы - - -*Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | ID целевой базы | - | Свойства | --props | Соответствие из КлючИЗначение | Новые или изменяемые свойства базы данных | - | Заголовок | --title | Строка | Новый заголовок базы | - | Описание | --description | Строка | Новое описание базы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - База = "5dd94c34fab04bff9..."; - Заголовок = "Обновленный заголовок"; - Описание = "Обновленное описание базы"; - - Свойства = Новый Соответствие; - Свойства.Вставить("Почта", "rich_text"); //Тип поля "Почта" будет изменен с email на текст - Свойства.Вставить("Сайт"); //Поле "Сайт" будет удалено - - Ответ = OPI_Notion.ИзменитьСвойстваБазы(Токен, База, Свойства, Заголовок, Описание); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ИзменитьСвойстваБазы --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --props %props% --title "Обновленный заголовок" --description "Обновленное описание базы" - - -``` - - -```json title="Результат" - -{ - "request_id": "d42b5700-9325-439e-98ce-252a007f5ed7", - "public_url": null, - "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "properties": { - "Картинка": { - "files": {}, - "type": "files", - "name": "Картинка", - "id": "r%3Dfa" - }, - "Активен": { - "checkbox": {}, - "type": "checkbox", - "name": "Активен", - "id": "q%3FQF" - }, - "Телефон": { - "phone_number": {}, - "type": "phone_number", - "name": "Телефон", - "id": "hDII" - }, - "Пользователь": { - "people": {}, - "type": "people", - "name": "Пользователь", - "id": "%5D%40Md" - }, - "Описание": { - "rich_text": {}, - "type": "rich_text", - "name": "Описание", - "id": "KnG%3F" - }, - "Статус": { - "select": { - "options": [ - { - "description": null, - "color": "red", - "name": "Удаленный", - "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" - }, - { - "description": null, - "color": "yellow", - "name": "В работе", - "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" - }, - { - "description": null, - "color": "green", - "name": "Новый", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - } - ] - }, - "type": "select", - "name": "Статус", - "id": "IDW%3C" - }, - "Номер": { - "type": "number", - "name": "Номер", - "number": { - "format": "number" - }, - "id": "CH__" - }, - "Дата создания": { - "date": {}, - "type": "date", - "name": "Дата создания", - "id": "BQN%5B" - }, - "Имя": { - "title": {}, - "type": "title", - "name": "Имя", - "id": "title" - }, - "Почта": { - "rich_text": {}, - "type": "rich_text", - "name": "Почта", - "id": "%3CO%3AD" - } - }, - "last_edited_time": "2024-01-26T18:26:00.000Z", - "description": [ - { - "plain_text": "Обновленное описание базы", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Обновленное описание базы" - }, - "href": null, - "type": "text" - } - ], - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "archived": false, - "icon": null, - "created_time": "2024-01-26T16:49:00.000Z", - "title": [ - { - "plain_text": "Обновленный заголовок", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Обновленный заголовок" - }, - "href": null, - "type": "text" - } - ], - "cover": null, - "is_inline": false, - "id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "object": "database" - } - -``` +--- +sidebar_position: 3 +--- + +# Изменить свойства базы + Изменяет свойства существующей базы + + +*Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | ID целевой базы | + | Свойства | --props | Соответствие из КлючИЗначение | Новые или изменяемые свойства базы данных | + | Заголовок | --title | Строка | Новый заголовок базы | + | Описание | --description | Строка | Новое описание базы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + База = "5dd94c34fab04bff9..."; + Заголовок = "Обновленный заголовок"; + Описание = "Обновленное описание базы"; + + Свойства = Новый Соответствие; + Свойства.Вставить("Почта", "rich_text"); //Тип поля "Почта" будет изменен с email на текст + Свойства.Вставить("Сайт"); //Поле "Сайт" будет удалено + + Ответ = OPI_Notion.ИзменитьСвойстваБазы(Токен, База, Свойства, Заголовок, Описание); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ИзменитьСвойстваБазы --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --props %props% --title "Обновленный заголовок" --description "Обновленное описание базы" + + +``` + + +```json title="Результат" + +{ + "request_id": "d42b5700-9325-439e-98ce-252a007f5ed7", + "public_url": null, + "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "properties": { + "Картинка": { + "files": {}, + "type": "files", + "name": "Картинка", + "id": "r%3Dfa" + }, + "Активен": { + "checkbox": {}, + "type": "checkbox", + "name": "Активен", + "id": "q%3FQF" + }, + "Телефон": { + "phone_number": {}, + "type": "phone_number", + "name": "Телефон", + "id": "hDII" + }, + "Пользователь": { + "people": {}, + "type": "people", + "name": "Пользователь", + "id": "%5D%40Md" + }, + "Описание": { + "rich_text": {}, + "type": "rich_text", + "name": "Описание", + "id": "KnG%3F" + }, + "Статус": { + "select": { + "options": [ + { + "description": null, + "color": "red", + "name": "Удаленный", + "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" + }, + { + "description": null, + "color": "yellow", + "name": "В работе", + "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" + }, + { + "description": null, + "color": "green", + "name": "Новый", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + } + ] + }, + "type": "select", + "name": "Статус", + "id": "IDW%3C" + }, + "Номер": { + "type": "number", + "name": "Номер", + "number": { + "format": "number" + }, + "id": "CH__" + }, + "Дата создания": { + "date": {}, + "type": "date", + "name": "Дата создания", + "id": "BQN%5B" + }, + "Имя": { + "title": {}, + "type": "title", + "name": "Имя", + "id": "title" + }, + "Почта": { + "rich_text": {}, + "type": "rich_text", + "name": "Почта", + "id": "%3CO%3AD" + } + }, + "last_edited_time": "2024-01-26T18:26:00.000Z", + "description": [ + { + "plain_text": "Обновленное описание базы", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Обновленное описание базы" + }, + "href": null, + "type": "text" + } + ], + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "archived": false, + "icon": null, + "created_time": "2024-01-26T16:49:00.000Z", + "title": [ + { + "plain_text": "Обновленный заголовок", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Обновленный заголовок" + }, + "href": null, + "type": "text" + } + ], + "cover": null, + "is_inline": false, + "id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "object": "database" + } + +``` diff --git a/docs/ru/md/Notion/Database-management/Get-database.md b/docs/ru/md/Notion/Database-management/Get-database.md index e61d2ad56a..176511abfd 100644 --- a/docs/ru/md/Notion/Database-management/Get-database.md +++ b/docs/ru/md/Notion/Database-management/Get-database.md @@ -1,191 +1,191 @@ ---- -sidebar_position: 2 ---- - -# Получить базу данных - Получить данные о базе данных - - -*Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | База | --base | Строка | ID базы данных | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - База = "048ba0ce4f474e33900540d24..."; - - Ответ = OPI_Notion.ПолучитьБазуДанных(Токен, База); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ПолучитьБазуДанных --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "048ba0ce4f474e33900540d24..." - - -``` - - -```json title="Результат" - -{ - "request_id": "9c6e06e9-ffa5-4a3c-b4ff-0368553ca066", - "public_url": null, - "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "properties": { - "Картинка": { - "files": {}, - "type": "files", - "name": "Картинка", - "id": "r%3Dfa" - }, - "Активен": { - "checkbox": {}, - "type": "checkbox", - "name": "Активен", - "id": "q%3FQF" - }, - "Телефон": { - "phone_number": {}, - "type": "phone_number", - "name": "Телефон", - "id": "hDII" - }, - "Пользователь": { - "people": {}, - "type": "people", - "name": "Пользователь", - "id": "%5D%40Md" - }, - "Описание": { - "rich_text": {}, - "type": "rich_text", - "name": "Описание", - "id": "KnG%3F" - }, - "Статус": { - "select": { - "options": [ - { - "description": null, - "color": "red", - "name": "Удаленный", - "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" - }, - { - "description": null, - "color": "yellow", - "name": "В работе", - "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" - }, - { - "description": null, - "color": "green", - "name": "Новый", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - } - ] - }, - "type": "select", - "name": "Статус", - "id": "IDW%3C" - }, - "Номер": { - "type": "number", - "name": "Номер", - "number": { - "format": "number" - }, - "id": "CH__" - }, - "Дата создания": { - "date": {}, - "type": "date", - "name": "Дата создания", - "id": "BQN%5B" - }, - "Имя": { - "title": {}, - "type": "title", - "name": "Имя", - "id": "title" - }, - "Почта": { - "rich_text": {}, - "type": "rich_text", - "name": "Почта", - "id": "%3CO%3AD" - } - }, - "last_edited_time": "2024-01-26T18:28:00.000Z", - "description": [ - { - "plain_text": "Обновленное описание базы", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Обновленное описание базы" - }, - "href": null, - "type": "text" - } - ], - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "archived": false, - "icon": null, - "created_time": "2024-01-26T16:49:00.000Z", - "title": [ - { - "plain_text": "Обновленный заголовок", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Обновленный заголовок" - }, - "href": null, - "type": "text" - } - ], - "cover": null, - "is_inline": false, - "id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "last_edited_by": { - "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", - "object": "user" - }, - "object": "database" - } - -``` +--- +sidebar_position: 2 +--- + +# Получить базу данных + Получить данные о базе данных + + +*Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | ID базы данных | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + База = "048ba0ce4f474e33900540d24..."; + + Ответ = OPI_Notion.ПолучитьБазуДанных(Токен, База); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ПолучитьБазуДанных --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "048ba0ce4f474e33900540d24..." + + +``` + + +```json title="Результат" + +{ + "request_id": "9c6e06e9-ffa5-4a3c-b4ff-0368553ca066", + "public_url": null, + "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "properties": { + "Картинка": { + "files": {}, + "type": "files", + "name": "Картинка", + "id": "r%3Dfa" + }, + "Активен": { + "checkbox": {}, + "type": "checkbox", + "name": "Активен", + "id": "q%3FQF" + }, + "Телефон": { + "phone_number": {}, + "type": "phone_number", + "name": "Телефон", + "id": "hDII" + }, + "Пользователь": { + "people": {}, + "type": "people", + "name": "Пользователь", + "id": "%5D%40Md" + }, + "Описание": { + "rich_text": {}, + "type": "rich_text", + "name": "Описание", + "id": "KnG%3F" + }, + "Статус": { + "select": { + "options": [ + { + "description": null, + "color": "red", + "name": "Удаленный", + "id": "a71d6e8a-4f3e-4dfd-9f0e-4d90e400fde7" + }, + { + "description": null, + "color": "yellow", + "name": "В работе", + "id": "aa6300b4-c635-4ab4-b5cd-87d14e45dd11" + }, + { + "description": null, + "color": "green", + "name": "Новый", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + } + ] + }, + "type": "select", + "name": "Статус", + "id": "IDW%3C" + }, + "Номер": { + "type": "number", + "name": "Номер", + "number": { + "format": "number" + }, + "id": "CH__" + }, + "Дата создания": { + "date": {}, + "type": "date", + "name": "Дата создания", + "id": "BQN%5B" + }, + "Имя": { + "title": {}, + "type": "title", + "name": "Имя", + "id": "title" + }, + "Почта": { + "rich_text": {}, + "type": "rich_text", + "name": "Почта", + "id": "%3CO%3AD" + } + }, + "last_edited_time": "2024-01-26T18:28:00.000Z", + "description": [ + { + "plain_text": "Обновленное описание базы", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Обновленное описание базы" + }, + "href": null, + "type": "text" + } + ], + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "archived": false, + "icon": null, + "created_time": "2024-01-26T16:49:00.000Z", + "title": [ + { + "plain_text": "Обновленный заголовок", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Обновленный заголовок" + }, + "href": null, + "type": "text" + } + ], + "cover": null, + "is_inline": false, + "id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "last_edited_by": { + "id": "ed71865a-9891-46bc-86cd-a92aa499cfdb", + "object": "user" + }, + "object": "database" + } + +``` 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 index 8f891d7eb8..cafeee924c 100644 --- a/docs/ru/md/Notion/Page-management/Create-page-in-database.md +++ b/docs/ru/md/Notion/Page-management/Create-page-in-database.md @@ -1,204 +1,204 @@ ---- -sidebar_position: 2 ---- - -# Создать страницу в базу - Создает страницу в базе-родителе - - -*Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --base | Строка | ID родительской базы | - | Данные | --data | Соответствие Из КлючИЗначение | Соответствие свойств | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff9..."; - Картинка = Новый Соответствие; - Картинка.Вставить("Лого", "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg"); - - Данные = Новый Соответствие; - Данные.Вставить("Имя" , "ООО Вектор"); - Данные.Вставить("Описание" , "Наш первый клиент"); - Данные.Вставить("Номер" , 1); - Данные.Вставить("Статус" , "Обычный"); - Данные.Вставить("Дата создания" , ТекущаяДатаСеанса()); - Данные.Вставить("Картинка" , Картинка); - Данные.Вставить("Активен" , Истина); - Данные.Вставить("Почта" , "mail@vector.ru"); - Данные.Вставить("Телефон" , "88005553535"); - Данные.Вставить("Статус" , "Новый"); - - Ответ = OPI_Notion.СоздатьСтраницуВБазу(Токен, База, Данные); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion СоздатьСтраницуВБазу --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --data %data% - - -``` - - -```json title="Результат" - -{ - "request_id": "03fd3bd2-6dd1-4ca2-bf85-9233748a745f", - "public_url": null, - "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", - "properties": { - "Картинка": { - "files": [ - { - "external": { - "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" - }, - "type": "external", - "name": "Лого" - } - ], - "type": "files", - "id": "r%3Dfa" - }, - "Активен": { - "checkbox": true, - "type": "checkbox", - "id": "q%3FQF" - }, - "Телефон": { - "phone_number": "88005553535", - "type": "phone_number", - "id": "hDII" - }, - "Пользователь": { - "people": [], - "type": "people", - "id": "%5D%40Md" - }, - "Описание": { - "rich_text": [ - { - "plain_text": "Наш первый клиент", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Наш первый клиент" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "KnG%3F" - }, - "Статус": { - "select": { - "color": "green", - "name": "Новый", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - }, - "type": "select", - "id": "IDW%3C" - }, - "Номер": { - "type": "number", - "number": 1, - "id": "CH__" - }, - "Дата создания": { - "date": { - "time_zone": null, - "end": null, - "start": "2024-01-26T09:45:00.000+00:00" - }, - "type": "date", - "id": "BQN%5B" - }, - "Имя": { - "title": [ - { - "plain_text": "ООО Вектор", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "ООО Вектор" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - }, - "Почта": { - "rich_text": [ - { - "plain_text": "mail@vector.ru", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "mail@vector.ru" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "%3CO%3AD" - } - }, - "parent": { - "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "type": "database_id" - }, - "cover": null, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T18:45:00.000Z", - "icon": null, - "created_time": "2024-01-26T18:45:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "a5742816-1417-4169-bf55-dbae44f46d9c", - "object": "page" - } - -``` +--- +sidebar_position: 2 +--- + +# Создать страницу в базу + Создает страницу в базе-родителе + + +*Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --base | Строка | ID родительской базы | + | Данные | --data | Соответствие Из КлючИЗначение | Соответствие свойств | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff9..."; + Картинка = Новый Соответствие; + Картинка.Вставить("Лого", "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg"); + + Данные = Новый Соответствие; + Данные.Вставить("Имя" , "ООО Вектор"); + Данные.Вставить("Описание" , "Наш первый клиент"); + Данные.Вставить("Номер" , 1); + Данные.Вставить("Статус" , "Обычный"); + Данные.Вставить("Дата создания" , ТекущаяДатаСеанса()); + Данные.Вставить("Картинка" , Картинка); + Данные.Вставить("Активен" , Истина); + Данные.Вставить("Почта" , "mail@vector.ru"); + Данные.Вставить("Телефон" , "88005553535"); + Данные.Вставить("Статус" , "Новый"); + + Ответ = OPI_Notion.СоздатьСтраницуВБазу(Токен, База, Данные); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion СоздатьСтраницуВБазу --token "secret_9RsfMrRMqZwqp0Zl0B..." --base "5dd94c34fab04bff9..." --data %data% + + +``` + + +```json title="Результат" + +{ + "request_id": "03fd3bd2-6dd1-4ca2-bf85-9233748a745f", + "public_url": null, + "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", + "properties": { + "Картинка": { + "files": [ + { + "external": { + "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" + }, + "type": "external", + "name": "Лого" + } + ], + "type": "files", + "id": "r%3Dfa" + }, + "Активен": { + "checkbox": true, + "type": "checkbox", + "id": "q%3FQF" + }, + "Телефон": { + "phone_number": "88005553535", + "type": "phone_number", + "id": "hDII" + }, + "Пользователь": { + "people": [], + "type": "people", + "id": "%5D%40Md" + }, + "Описание": { + "rich_text": [ + { + "plain_text": "Наш первый клиент", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Наш первый клиент" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "KnG%3F" + }, + "Статус": { + "select": { + "color": "green", + "name": "Новый", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + }, + "type": "select", + "id": "IDW%3C" + }, + "Номер": { + "type": "number", + "number": 1, + "id": "CH__" + }, + "Дата создания": { + "date": { + "time_zone": null, + "end": null, + "start": "2024-01-26T09:45:00.000+00:00" + }, + "type": "date", + "id": "BQN%5B" + }, + "Имя": { + "title": [ + { + "plain_text": "ООО Вектор", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "ООО Вектор" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + }, + "Почта": { + "rich_text": [ + { + "plain_text": "mail@vector.ru", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "mail@vector.ru" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "%3CO%3AD" + } + }, + "parent": { + "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "type": "database_id" + }, + "cover": null, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T18:45:00.000Z", + "icon": null, + "created_time": "2024-01-26T18:45:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "a5742816-1417-4169-bf55-dbae44f46d9c", + "object": "page" + } + +``` diff --git a/docs/ru/md/Notion/Page-management/Create-page.md b/docs/ru/md/Notion/Page-management/Create-page.md index 25d7d5d91b..fa43b117f6 100644 --- a/docs/ru/md/Notion/Page-management/Create-page.md +++ b/docs/ru/md/Notion/Page-management/Create-page.md @@ -1,94 +1,94 @@ ---- -sidebar_position: 1 ---- - -# Создать страницу - Создает дочернюю страницу над другой страницей-родителем - - -*Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Родитель | --page | Строка | ID Родителя | - | Заголовок | --title | Строка | Заголовок страницы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Родитель = "5dd94c34fab04bff9..."; - Заголовок = "Создано из 1С"; - - Ответ = OPI_Notion.СоздатьСтраницу(Токен, Родитель, Заголовок); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion СоздатьСтраницу --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "Создано из 1С" - - -``` - - -```json title="Результат" - -{ - "request_id": "f145f634-ea3a-4f74-b079-f365ecbcf583", - "public_url": null, - "url": "https://www.notion.so/1-4392f919813c4c8d84017d973bddaabf", - "properties": { - "title": { - "title": [ - { - "plain_text": "Создано из 1С", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Создано из 1С" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - } - }, - "parent": { - "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", - "type": "page_id" - }, - "cover": null, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T17:20:00.000Z", - "icon": null, - "created_time": "2024-01-26T17:20:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "4392f919-813c-4c8d-8401-7d973bddaabf", - "object": "page" - } - -``` +--- +sidebar_position: 1 +--- + +# Создать страницу + Создает дочернюю страницу над другой страницей-родителем + + +*Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID Родителя | + | Заголовок | --title | Строка | Заголовок страницы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Родитель = "5dd94c34fab04bff9..."; + Заголовок = "Создано из 1С"; + + Ответ = OPI_Notion.СоздатьСтраницу(Токен, Родитель, Заголовок); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion СоздатьСтраницу --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --title "Создано из 1С" + + +``` + + +```json title="Результат" + +{ + "request_id": "f145f634-ea3a-4f74-b079-f365ecbcf583", + "public_url": null, + "url": "https://www.notion.so/1-4392f919813c4c8d84017d973bddaabf", + "properties": { + "title": { + "title": [ + { + "plain_text": "Создано из 1С", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Создано из 1С" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + } + }, + "parent": { + "page_id": "5dd94c34-fab0-4bff-986b-7511c0779f77", + "type": "page_id" + }, + "cover": null, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T17:20:00.000Z", + "icon": null, + "created_time": "2024-01-26T17:20:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "4392f919-813c-4c8d-8401-7d973bddaabf", + "object": "page" + } + +``` diff --git a/docs/ru/md/Notion/Page-management/Edit-page-properties.md b/docs/ru/md/Notion/Page-management/Edit-page-properties.md index c5d2708872..88e349155b 100644 --- a/docs/ru/md/Notion/Page-management/Edit-page-properties.md +++ b/docs/ru/md/Notion/Page-management/Edit-page-properties.md @@ -1,215 +1,215 @@ ---- -sidebar_position: 4 ---- - -# Изменить свойства страницы. - - - -*Функция ИзменитьСвойстваСтраницы(Знач Токен, Знач Страница, Знач Данные = "", Знач Иконка = "", Знач Обложка = "", Знач Архивирована = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Страница | --page | Строка | ID изменяемой страницы | - | Данные | --data | Соответствие Из КлючИЗначение | Соответствие изменяемых параметров | - | Иконка | --icon | Строка | URL картинки иконки страницы | - | Обложка | --cover | Строка | URL картинки обложки страницы | - | Архивирована | --archive | Булево | Архивировать страницу или нет (булево) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Страница = "5dd94c34fab04bff9..."; - Иконка = "https://opi.neocities.org/img/logo.png"; - Обложка = "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png"; - - Свойства = Новый Соответствие; - Свойства.Вставить("Активен" , Ложь); - Свойства.Вставить("Почта" , "vector@mail.ru"); - - Ответ = OPI_Notion.ИзменитьСвойстваСтраницы(Токен - , Страница - , Свойства - , Иконка - , Обложка - , Архивировать); - - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ИзменитьСвойстваСтраницы --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --data %data% --icon "https://opi.neocities.org/img/logo.png" --cover "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" --archive %archive% - - -``` - - -```json title="Результат" - -{ - "request_id": "a02741b2-4eb8-43ae-9a2e-542d5dd10687", - "public_url": null, - "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", - "properties": { - "Картинка": { - "files": [ - { - "external": { - "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" - }, - "type": "external", - "name": "Лого" - } - ], - "type": "files", - "id": "r%3Dfa" - }, - "Активен": { - "checkbox": false, - "type": "checkbox", - "id": "q%3FQF" - }, - "Телефон": { - "phone_number": "88005553535", - "type": "phone_number", - "id": "hDII" - }, - "Пользователь": { - "people": [], - "type": "people", - "id": "%5D%40Md" - }, - "Описание": { - "rich_text": [ - { - "plain_text": "Наш первый клиент", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Наш первый клиент" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "KnG%3F" - }, - "Статус": { - "select": { - "color": "green", - "name": "Новый", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - }, - "type": "select", - "id": "IDW%3C" - }, - "Номер": { - "type": "number", - "number": 1, - "id": "CH__" - }, - "Дата создания": { - "date": { - "time_zone": null, - "end": null, - "start": "2024-01-26T09:45:00.000+00:00" - }, - "type": "date", - "id": "BQN%5B" - }, - "Имя": { - "title": [ - { - "plain_text": "ООО Вектор", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "ООО Вектор" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - }, - "Почта": { - "rich_text": [ - { - "plain_text": "vector@mail.ru", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "vector@mail.ru" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "%3CO%3AD" - } - }, - "parent": { - "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "type": "database_id" - }, - "cover": { - "external": { - "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" - }, - "type": "external" - }, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:30:00.000Z", - "icon": { - "external": { - "url": "https://opi.neocities.org/img/logo.png" - }, - "type": "external" - }, - "created_time": "2024-01-26T18:45:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "a5742816-1417-4169-bf55-dbae44f46d9c", - "object": "page" - } - -``` +--- +sidebar_position: 4 +--- + +# Изменить свойства страницы. + + + +*Функция ИзменитьСвойстваСтраницы(Знач Токен, Знач Страница, Знач Данные = "", Знач Иконка = "", Знач Обложка = "", Знач Архивирована = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Страница | --page | Строка | ID изменяемой страницы | + | Данные | --data | Соответствие Из КлючИЗначение | Соответствие изменяемых параметров | + | Иконка | --icon | Строка | URL картинки иконки страницы | + | Обложка | --cover | Строка | URL картинки обложки страницы | + | Архивирована | --archive | Булево | Архивировать страницу или нет (булево) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Страница = "5dd94c34fab04bff9..."; + Иконка = "https://opi.neocities.org/img/logo.png"; + Обложка = "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png"; + + Свойства = Новый Соответствие; + Свойства.Вставить("Активен" , Ложь); + Свойства.Вставить("Почта" , "vector@mail.ru"); + + Ответ = OPI_Notion.ИзменитьСвойстваСтраницы(Токен + , Страница + , Свойства + , Иконка + , Обложка + , Архивировать); + + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ИзменитьСвойстваСтраницы --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "5dd94c34fab04bff9..." --data %data% --icon "https://opi.neocities.org/img/logo.png" --cover "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" --archive %archive% + + +``` + + +```json title="Результат" + +{ + "request_id": "a02741b2-4eb8-43ae-9a2e-542d5dd10687", + "public_url": null, + "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", + "properties": { + "Картинка": { + "files": [ + { + "external": { + "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" + }, + "type": "external", + "name": "Лого" + } + ], + "type": "files", + "id": "r%3Dfa" + }, + "Активен": { + "checkbox": false, + "type": "checkbox", + "id": "q%3FQF" + }, + "Телефон": { + "phone_number": "88005553535", + "type": "phone_number", + "id": "hDII" + }, + "Пользователь": { + "people": [], + "type": "people", + "id": "%5D%40Md" + }, + "Описание": { + "rich_text": [ + { + "plain_text": "Наш первый клиент", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Наш первый клиент" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "KnG%3F" + }, + "Статус": { + "select": { + "color": "green", + "name": "Новый", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + }, + "type": "select", + "id": "IDW%3C" + }, + "Номер": { + "type": "number", + "number": 1, + "id": "CH__" + }, + "Дата создания": { + "date": { + "time_zone": null, + "end": null, + "start": "2024-01-26T09:45:00.000+00:00" + }, + "type": "date", + "id": "BQN%5B" + }, + "Имя": { + "title": [ + { + "plain_text": "ООО Вектор", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "ООО Вектор" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + }, + "Почта": { + "rich_text": [ + { + "plain_text": "vector@mail.ru", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "vector@mail.ru" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "%3CO%3AD" + } + }, + "parent": { + "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "type": "database_id" + }, + "cover": { + "external": { + "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" + }, + "type": "external" + }, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:30:00.000Z", + "icon": { + "external": { + "url": "https://opi.neocities.org/img/logo.png" + }, + "type": "external" + }, + "created_time": "2024-01-26T18:45:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "a5742816-1417-4169-bf55-dbae44f46d9c", + "object": "page" + } + +``` diff --git a/docs/ru/md/Notion/Page-management/Get-page.md b/docs/ru/md/Notion/Page-management/Get-page.md index 3c2bf6c88d..231b0c6e78 100644 --- a/docs/ru/md/Notion/Page-management/Get-page.md +++ b/docs/ru/md/Notion/Page-management/Get-page.md @@ -1,199 +1,199 @@ ---- -sidebar_position: 3 ---- - -# Получить страницу - Получает информацию о странице по ID - - -*Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Страница | --page | Строка | ID страницы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Страница = "a574281614174169bf55dbae4..."; - - Ответ = OPI_Notion.ПолучитьСтраницу(Токен, Страница); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ПолучитьСтраницу --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "a574281614174169bf55dbae4..." - - -``` - - -```json title="Результат" - -{ - "request_id": "61eaaa91-41fc-4523-a445-602805afb281", - "public_url": null, - "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", - "properties": { - "Картинка": { - "files": [ - { - "external": { - "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" - }, - "type": "external", - "name": "Лого" - } - ], - "type": "files", - "id": "r%3Dfa" - }, - "Активен": { - "checkbox": false, - "type": "checkbox", - "id": "q%3FQF" - }, - "Телефон": { - "phone_number": "88005553535", - "type": "phone_number", - "id": "hDII" - }, - "Пользователь": { - "people": [], - "type": "people", - "id": "%5D%40Md" - }, - "Описание": { - "rich_text": [ - { - "plain_text": "Наш первый клиент", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "Наш первый клиент" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "KnG%3F" - }, - "Статус": { - "select": { - "color": "green", - "name": "Новый", - "id": "202b1d30-2095-40f1-8b91-f627d475d560" - }, - "type": "select", - "id": "IDW%3C" - }, - "Номер": { - "type": "number", - "number": 1, - "id": "CH__" - }, - "Дата создания": { - "date": { - "time_zone": null, - "end": null, - "start": "2024-01-26T09:45:00.000+00:00" - }, - "type": "date", - "id": "BQN%5B" - }, - "Имя": { - "title": [ - { - "plain_text": "ООО Вектор", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "ООО Вектор" - }, - "href": null, - "type": "text" - } - ], - "type": "title", - "id": "title" - }, - "Почта": { - "rich_text": [ - { - "plain_text": "vector@mail.ru", - "annotations": { - "color": "default", - "code": false, - "underline": false, - "strikethrough": false, - "italic": false, - "bold": false - }, - "text": { - "link": null, - "content": "vector@mail.ru" - }, - "href": null, - "type": "text" - } - ], - "type": "rich_text", - "id": "%3CO%3AD" - } - }, - "parent": { - "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", - "type": "database_id" - }, - "cover": { - "external": { - "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" - }, - "type": "external" - }, - "archived": false, - "created_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "last_edited_time": "2024-01-26T19:30:00.000Z", - "icon": { - "external": { - "url": "https://opi.neocities.org/img/logo.png" - }, - "type": "external" - }, - "created_time": "2024-01-26T18:45:00.000Z", - "last_edited_by": { - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - }, - "id": "a5742816-1417-4169-bf55-dbae44f46d9c", - "object": "page" - } - -``` +--- +sidebar_position: 3 +--- + +# Получить страницу + Получает информацию о странице по ID + + +*Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Страница | --page | Строка | ID страницы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Страница = "a574281614174169bf55dbae4..."; + + Ответ = OPI_Notion.ПолучитьСтраницу(Токен, Страница); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ПолучитьСтраницу --token "secret_9RsfMrRMqZwqp0Zl0B..." --page "a574281614174169bf55dbae4..." + + +``` + + +```json title="Результат" + +{ + "request_id": "61eaaa91-41fc-4523-a445-602805afb281", + "public_url": null, + "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", + "properties": { + "Картинка": { + "files": [ + { + "external": { + "url": "https://pricep-farkop.ru/wp-content/uploads/2017/02/17.jpg" + }, + "type": "external", + "name": "Лого" + } + ], + "type": "files", + "id": "r%3Dfa" + }, + "Активен": { + "checkbox": false, + "type": "checkbox", + "id": "q%3FQF" + }, + "Телефон": { + "phone_number": "88005553535", + "type": "phone_number", + "id": "hDII" + }, + "Пользователь": { + "people": [], + "type": "people", + "id": "%5D%40Md" + }, + "Описание": { + "rich_text": [ + { + "plain_text": "Наш первый клиент", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "Наш первый клиент" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "KnG%3F" + }, + "Статус": { + "select": { + "color": "green", + "name": "Новый", + "id": "202b1d30-2095-40f1-8b91-f627d475d560" + }, + "type": "select", + "id": "IDW%3C" + }, + "Номер": { + "type": "number", + "number": 1, + "id": "CH__" + }, + "Дата создания": { + "date": { + "time_zone": null, + "end": null, + "start": "2024-01-26T09:45:00.000+00:00" + }, + "type": "date", + "id": "BQN%5B" + }, + "Имя": { + "title": [ + { + "plain_text": "ООО Вектор", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "ООО Вектор" + }, + "href": null, + "type": "text" + } + ], + "type": "title", + "id": "title" + }, + "Почта": { + "rich_text": [ + { + "plain_text": "vector@mail.ru", + "annotations": { + "color": "default", + "code": false, + "underline": false, + "strikethrough": false, + "italic": false, + "bold": false + }, + "text": { + "link": null, + "content": "vector@mail.ru" + }, + "href": null, + "type": "text" + } + ], + "type": "rich_text", + "id": "%3CO%3AD" + } + }, + "parent": { + "database_id": "048ba0ce-4f47-4e33-9005-40d249b01949", + "type": "database_id" + }, + "cover": { + "external": { + "url": "https://opi.neocities.org/assets/images/logo_long-e69f28017feff1759ffcfe3f4e7bbf2a.png" + }, + "type": "external" + }, + "archived": false, + "created_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "last_edited_time": "2024-01-26T19:30:00.000Z", + "icon": { + "external": { + "url": "https://opi.neocities.org/img/logo.png" + }, + "type": "external" + }, + "created_time": "2024-01-26T18:45:00.000Z", + "last_edited_by": { + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + }, + "id": "a5742816-1417-4169-bf55-dbae44f46d9c", + "object": "page" + } + +``` diff --git a/docs/ru/md/Notion/Users/Get-user-data.md b/docs/ru/md/Notion/Users/Get-user-data.md index a8907a3592..91e09acb40 100644 --- a/docs/ru/md/Notion/Users/Get-user-data.md +++ b/docs/ru/md/Notion/Users/Get-user-data.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 2 ---- - -# Получить данные пользователя - Получает данные пользователя по ID - - -*Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИДПользователя | --user | Строка | ID целевого пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - ИДПользователя = "ed71865a989146bc86cdwdf24..."; - - Ответ = OPI_Notion.ПолучитьДанныеПользователя(Токен, ИДПользователя); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion ПолучитьДанныеПользователя --token "secret_9RsfMrRMqZwqp0Zl0B..." --user "ed71865a989146bc86cdwdf24..." - - -``` - - -```json title="Результат" - -{ - "request_id": "f33d34a8-f3cf-41b5-bdf5-4a07cf7d7118", - "person": { - "email": "ex@gmail.com" - }, - "type": "person", - "avatar_url": null, - "name": "Bayselonarrend", - "id": "ed71865a-9891-1111-86cd-1111111", - "object": "user" - } - -``` +--- +sidebar_position: 2 +--- + +# Получить данные пользователя + Получает данные пользователя по ID + + +*Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДПользователя | --user | Строка | ID целевого пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + ИДПользователя = "ed71865a989146bc86cdwdf24..."; + + Ответ = OPI_Notion.ПолучитьДанныеПользователя(Токен, ИДПользователя); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion ПолучитьДанныеПользователя --token "secret_9RsfMrRMqZwqp0Zl0B..." --user "ed71865a989146bc86cdwdf24..." + + +``` + + +```json title="Результат" + +{ + "request_id": "f33d34a8-f3cf-41b5-bdf5-4a07cf7d7118", + "person": { + "email": "ex@gmail.com" + }, + "type": "person", + "avatar_url": null, + "name": "Bayselonarrend", + "id": "ed71865a-9891-1111-86cd-1111111", + "object": "user" + } + +``` diff --git a/docs/ru/md/Notion/Users/User-list.md b/docs/ru/md/Notion/Users/User-list.md index 45986d7404..b580a8e8b7 100644 --- a/docs/ru/md/Notion/Users/User-list.md +++ b/docs/ru/md/Notion/Users/User-list.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 1 ---- - -# Список пользователей - Возвращает список пользователей рабочего пространства - - -*Функция СписокПользователей(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion - -```bsl title="Пример кода" - - - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; - Ответ = OPI_Notion.СписокПользователей(Токен); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint notion СписокПользователей --token "secret_9RsfMrRMqZwqp0Zl0B..." - - -``` - - -```json title="Результат" - -{ - "request_id": "ea9a6b96-0b02-4866-a60a-2958e514af38", - "user": {}, - "type": "user", - "has_more": false, - "next_cursor": null, - "results": [ - { - "person": { - "email": "ex@gmail.com" - }, - "type": "person", - "avatar_url": null, - "name": "Bayselonarrends", - "id": "ed71865a-9891-1111-86cd-11111111", - "object": "user" - }, - { - "type": "bot", - "avatar_url": null, - "name": "1C Integration", - "bot": { - "workspace_name": "Bayselonarrends Notion", - "owner": { - "workspace": true, - "type": "workspace" - } - }, - "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", - "object": "user" - } - ], - "object": "list" - } - -``` +--- +sidebar_position: 1 +--- + +# Список пользователей + Возвращает список пользователей рабочего пространства + + +*Функция СписокПользователей(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; + Ответ = OPI_Notion.СписокПользователей(Токен); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint notion СписокПользователей --token "secret_9RsfMrRMqZwqp0Zl0B..." + + +``` + + +```json title="Результат" + +{ + "request_id": "ea9a6b96-0b02-4866-a60a-2958e514af38", + "user": {}, + "type": "user", + "has_more": false, + "next_cursor": null, + "results": [ + { + "person": { + "email": "ex@gmail.com" + }, + "type": "person", + "avatar_url": null, + "name": "Bayselonarrends", + "id": "ed71865a-9891-1111-86cd-11111111", + "object": "user" + }, + { + "type": "bot", + "avatar_url": null, + "name": "1C Integration", + "bot": { + "workspace_name": "Bayselonarrends Notion", + "owner": { + "workspace": true, + "type": "workspace" + } + }, + "id": "8b07422e-eeea-40d1-8d5e-c784211825b0", + "object": "user" + } + ], + "object": "list" + } + +``` diff --git a/docs/ru/md/Slack/Block-formation/Generate-image-block.md b/docs/ru/md/Slack/Block-formation/Generate-image-block.md index 404c71a192..fb5b3df135 100644 --- a/docs/ru/md/Slack/Block-formation/Generate-image-block.md +++ b/docs/ru/md/Slack/Block-formation/Generate-image-block.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 1 ---- - -# Сформировать блок картинку - Формирует блок с картинкой для добавления в массив блоков сообщения - - -*Функция СформироватьБлокКартинку(Знач URL, Знач АльтернативныйТекст = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --picture | Строка | URL картинки | - | АльтернативныйТекст | --alt | Строка | Альтернативный текст картинки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Блок картинки - -```bsl title="Пример кода" - - - Текст = "Картинка альпаки"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"; - - Ответ = OPI_Slack.СформироватьБлокКартинку(URL, Текст); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack СформироватьБлокКартинку --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" --alt %alt% - - -``` - - -```json title="Результат" - -{ - "alt_text": "Yo", - "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1", - "type": "image" - } - -``` +--- +sidebar_position: 1 +--- + +# Сформировать блок картинку + Формирует блок с картинкой для добавления в массив блоков сообщения + + +*Функция СформироватьБлокКартинку(Знач URL, Знач АльтернативныйТекст = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --picture | Строка | URL картинки | + | АльтернативныйТекст | --alt | Строка | Альтернативный текст картинки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Блок картинки + +```bsl title="Пример кода" + + + Текст = "Картинка альпаки"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"; + + Ответ = OPI_Slack.СформироватьБлокКартинку(URL, Текст); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack СформироватьБлокКартинку --picture "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" --alt %alt% + + +``` + + +```json title="Результат" + +{ + "alt_text": "Yo", + "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1", + "type": "image" + } + +``` diff --git a/docs/ru/md/Slack/Channel-management/Archive-channel.md b/docs/ru/md/Slack/Channel-management/Archive-channel.md index 75cb063e0b..9dba5b58f9 100644 --- a/docs/ru/md/Slack/Channel-management/Archive-channel.md +++ b/docs/ru/md/Slack/Channel-management/Archive-channel.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 4 ---- - -# Архивировать канал - Архивирует активный канал - - -*Функция АрхивироватьКанал(Знач Токен, Знач Канал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.АрхивироватьКанал(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack АрхивироватьКанал --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Результат" - -{ - "ok": true - } - -``` +--- +sidebar_position: 4 +--- + +# Архивировать канал + Архивирует активный канал + + +*Функция АрхивироватьКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.АрхивироватьКанал(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack АрхивироватьКанал --token %token% --channel "C070VPMKN8J" + + +``` + + +```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 index 7269ec0c80..3e35ef4645 100644 --- a/docs/ru/md/Slack/Channel-management/Create-channel.md +++ b/docs/ru/md/Slack/Channel-management/Create-channel.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 3 ---- - -# Создать канал - Создает новый канал - - -*Функция СоздатьКанал(Знач Токен, Знач Название, Знач Приватный = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Название | --title | Строка | Наименование канала | - | Приватный | --private | Булево | Создать канал приватным | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Название = "testcov" + Строка(Новый УникальныйИдентификатор); - - Ответ = OPI_Slack.СоздатьКанал(Токен, Название, Ложь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack СоздатьКанал --token %token% --title %title% --private %private% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542419, - "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 - } - } - -``` +--- +sidebar_position: 3 +--- + +# Создать канал + Создает новый канал + + +*Функция СоздатьКанал(Знач Токен, Знач Название, Знач Приватный = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Название | --title | Строка | Наименование канала | + | Приватный | --private | Булево | Создать канал приватным | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Название = "testcov" + Строка(Новый УникальныйИдентификатор); + + Ответ = OPI_Slack.СоздатьКанал(Токен, Название, Ложь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack СоздатьКанал --token %token% --title %title% --private %private% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542419, + "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 index 052cd1178c..41ab9ee8e4 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel-history.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel-history.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 6 ---- - -# Получить историю канала - Получает информацию событиях канала - - -*Функция ПолучитьИсториюКанала(Знач Токен, Знач Канал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПолучитьИсториюКанала(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьИсториюКанала --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "messages": [ - { - "subtype": "channel_join", - "user": "U06UABH3APP", - "text": "<@U06UABH3APP> has joined the channel", - "inviter": "U06UG1CAYH2", - "type": "message", - "ts": "1714146543.286219" - }, - { - "subtype": "channel_purpose", - "user": "U06UG1CAYH2", - "purpose": "Тестовая цель", - "text": "set the channel description: Тестовая цель", - "type": "message", - "ts": "1714146543.014349" - }, - { - "subtype": "channel_topic", - "user": "U06UG1CAYH2", - "topic": "Тестовая тема", - "text": "set the channel topic: Тестовая тема", - "type": "message", - "ts": "1714146542.849559" - }, - { - "subtype": "channel_join", - "user": "U06UG1CAYH2", - "text": "<@U06UG1CAYH2> has joined the channel", - "type": "message", - "ts": "1714146542.605859" - } - ], - "has_more": false, - "pin_count": 0, - "channel_actions_ts": null, - "channel_actions_count": 0 - } - -``` +--- +sidebar_position: 6 +--- + +# Получить историю канала + Получает информацию событиях канала + + +*Функция ПолучитьИсториюКанала(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПолучитьИсториюКанала(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьИсториюКанала --token %token% --channel "C070VPMKN8J" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "messages": [ + { + "subtype": "channel_join", + "user": "U06UABH3APP", + "text": "<@U06UABH3APP> has joined the channel", + "inviter": "U06UG1CAYH2", + "type": "message", + "ts": "1714146543.286219" + }, + { + "subtype": "channel_purpose", + "user": "U06UG1CAYH2", + "purpose": "Тестовая цель", + "text": "set the channel description: Тестовая цель", + "type": "message", + "ts": "1714146543.014349" + }, + { + "subtype": "channel_topic", + "user": "U06UG1CAYH2", + "topic": "Тестовая тема", + "text": "set the channel topic: Тестовая тема", + "type": "message", + "ts": "1714146542.849559" + }, + { + "subtype": "channel_join", + "user": "U06UG1CAYH2", + "text": "<@U06UG1CAYH2> has joined the channel", + "type": "message", + "ts": "1714146542.605859" + } + ], + "has_more": 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 index 9364899c1f..c8f5a1a1ad 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel-list.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel-list.md @@ -1,91 +1,91 @@ ---- -sidebar_position: 1 ---- - -# Получить список каналов - Получает список доступных каналов - - -*Функция ПолучитьСписокКаналов(Знач Токен, Знач ИсключатьАрхивированные = Ложь, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИсключатьАрхивированные | --notarchived | Булево | Признак исключения архивированных каналов | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - ИсключатьАрхивированные = Истина; - - Ответ = OPI_Slack.ПолучитьСписокКаналов(Токен, ИсключатьАрхивированные); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокКаналов --token %token% --notarchived "Истина" --cursor %cursor% - - -``` - - -```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": 1713202497794, - "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 - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Получить список каналов + Получает список доступных каналов + + +*Функция ПолучитьСписокКаналов(Знач Токен, Знач ИсключатьАрхивированные = Ложь, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИсключатьАрхивированные | --notarchived | Булево | Признак исключения архивированных каналов | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + ИсключатьАрхивированные = Истина; + + Ответ = OPI_Slack.ПолучитьСписокКаналов(Токен, ИсключатьАрхивированные); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокКаналов --token %token% --notarchived "Истина" --cursor %cursor% + + +``` + + +```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": 1713202497794, + "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 + } + ] + } + +``` 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 index beee46dcf4..22565cfbb2 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 2 ---- - -# Получить список пользователей канала - Получает список пользователей указанного канала - - -*Функция ПолучитьСписокПользователейКанала(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПолучитьСписокПользователейКанала(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокПользователейКанала --token %token% --channel "C070VPMKN8J" --cursor %cursor% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "members": [ - "U06UG1CAYH2" - ], - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +sidebar_position: 2 +--- + +# Получить список пользователей канала + Получает список пользователей указанного канала + + +*Функция ПолучитьСписокПользователейКанала(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПолучитьСписокПользователейКанала(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокПользователейКанала --token %token% --channel "C070VPMKN8J" --cursor %cursor% + + +``` + + +```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 index f484111ce1..5a42a9f0b4 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel.md @@ -1,85 +1,85 @@ ---- -sidebar_position: 5 ---- - -# Получить канал - Получает информацию о канале - - -*Функция ПолучитьКанал(Знач Токен, Знач Канал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПолучитьКанал(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьКанал --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "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": 1714146542 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 5 +--- + +# Получить канал + Получает информацию о канале + + +*Функция ПолучитьКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПолучитьКанал(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьКанал --token %token% --channel "C070VPMKN8J" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "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": 1714146542 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "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 index ddc352b956..7aa00d8881 100644 --- a/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md +++ b/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 7 ---- - -# Пригласить пользователей в канал - Добавляет указанных пользователей в канал - - -*Функция ПригласитьПользователейВКанал(Знач Токен, Знач Канал, Знач МассивПользователей) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | МассивПользователей | --users | Массив Из Строка | Массив ID пользователей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - МассивПользователей = Новый Массив; - МассивПользователей.Добавить("U06UG1CAYH2"); - - Ответ = OPI_Slack.ПригласитьПользователейВКанал(Токен, Канал, МассивПользователей); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПригласитьПользователейВКанал --token %token% --channel "C070VPMKN8J" --users %users% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "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": 1714146542 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 7 +--- + +# Пригласить пользователей в канал + Добавляет указанных пользователей в канал + + +*Функция ПригласитьПользователейВКанал(Знач Токен, Знач Канал, Знач МассивПользователей) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | МассивПользователей | --users | Массив Из Строка | Массив ID пользователей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + МассивПользователей = Новый Массив; + МассивПользователей.Добавить("U06UG1CAYH2"); + + Ответ = OPI_Slack.ПригласитьПользователейВКанал(Токен, Канал, МассивПользователей); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПригласитьПользователейВКанал --token %token% --channel "C070VPMKN8J" --users %users% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "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": 1714146542 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "previous_names": [] + } + } + +``` diff --git a/docs/ru/md/Slack/Channel-management/Join-channel.md b/docs/ru/md/Slack/Channel-management/Join-channel.md index 541709042b..f3c73d0b01 100644 --- a/docs/ru/md/Slack/Channel-management/Join-channel.md +++ b/docs/ru/md/Slack/Channel-management/Join-channel.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 9 ---- - -# Вступить в канал - Добавляет текущего бота в канал - - -*Функция ВступитьВКанал(Знач Токен, Знач Канал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ВступитьВКанал(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ВступитьВКанал --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1714146543.286219", - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [], - "priority": 0 - } - } - -``` +--- +sidebar_position: 9 +--- + +# Вступить в канал + Добавляет текущего бота в канал + + +*Функция ВступитьВКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ВступитьВКанал(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ВступитьВКанал --token %token% --channel "C070VPMKN8J" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1714146543.286219", + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "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 index e5352790a2..c21b67a5a4 100644 --- a/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md +++ b/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 8 ---- - -# Выгнать пользователя из канала - Удаляет указанного пользователя из канала - - -*Функция ВыгнатьПользователяИзКанала(Знач Токен, Знач Канал, Знач Пользователь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Пользователь | --user | Строка | ID пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Пользователь = "U06UG1CAYH2"; - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ВыгнатьПользователяИзКанала(Токен, Канал, Пользователь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ВыгнатьПользователяИзКанала --token %token% --channel "C070VPMKN8J" --user "U06UG1CAYH2" - - -``` - - -```json title="Результат" - -{ - "ok": true - } - -``` +--- +sidebar_position: 8 +--- + +# Выгнать пользователя из канала + Удаляет указанного пользователя из канала + + +*Функция ВыгнатьПользователяИзКанала(Знач Токен, Знач Канал, Знач Пользователь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Пользователь | --user | Строка | ID пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Пользователь = "U06UG1CAYH2"; + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ВыгнатьПользователяИзКанала(Токен, Канал, Пользователь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ВыгнатьПользователяИзКанала --token %token% --channel "C070VPMKN8J" --user "U06UG1CAYH2" + + +``` + + +```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 index 410b6fe223..3e4ea891e0 100644 --- a/docs/ru/md/Slack/Channel-management/Leave-channel.md +++ b/docs/ru/md/Slack/Channel-management/Leave-channel.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 10 ---- - -# Покинуть канал - Удаляет текущего бота из канала - - -*Функция ПокинутьКанал(Знач Токен, Знач Канал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПокинутьКанал(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПокинутьКанал --token %token% --channel "C070VPMKN8J" - - -``` - - -```json title="Результат" - -{ - "ok": true - } - -``` +--- +sidebar_position: 10 +--- + +# Покинуть канал + Удаляет текущего бота из канала + + +*Функция ПокинутьКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПокинутьКанал(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПокинутьКанал --token %token% --channel "C070VPMKN8J" + + +``` + + +```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 index 61f5f0f28d..20ca91e215 100644 --- a/docs/ru/md/Slack/Channel-management/Rename-channel.md +++ b/docs/ru/md/Slack/Channel-management/Rename-channel.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 13 ---- - -# Переименовать канал - Изменяет название канала - - -*Функция ПереименоватьКанал(Знач Токен, Знач Канал, Знач Название) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Название | --title | Строка | Новое название канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Название = "testcov" + Строка(Новый УникальныйИдентификатор); - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПереименоватьКанал(Токен, Канал, Название); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПереименоватьКанал --token %token% --channel "C070VPMKN8J" --title %title% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146544414, - "parent_conversation": null, - "creator": "U06UG1CAYH2", - "is_ext_shared": false, - "shared_team_ids": [ - "T06UD92BS3C" - ], - "pending_connected_team_ids": [], - "is_member": true, - "last_read": "1714146543.286219", - "topic": { - "value": "Тестовая тема", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [ - "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c" - ] - } - } - -``` +--- +sidebar_position: 13 +--- + +# Переименовать канал + Изменяет название канала + + +*Функция ПереименоватьКанал(Знач Токен, Знач Канал, Знач Название) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Название | --title | Строка | Новое название канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Название = "testcov" + Строка(Новый УникальныйИдентификатор); + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПереименоватьКанал(Токен, Канал, Название); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПереименоватьКанал --token %token% --channel "C070VPMKN8J" --title %title% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv42a25b36-8de3-4293-a6a9-6b92e6ea81ec", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146544414, + "parent_conversation": null, + "creator": "U06UG1CAYH2", + "is_ext_shared": false, + "shared_team_ids": [ + "T06UD92BS3C" + ], + "pending_connected_team_ids": [], + "is_member": true, + "last_read": "1714146543.286219", + "topic": { + "value": "Тестовая тема", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "previous_names": [ + "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c" + ] + } + } + +``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-goal.md b/docs/ru/md/Slack/Channel-management/Set-channel-goal.md index 5e2c77807c..ed327263ef 100644 --- a/docs/ru/md/Slack/Channel-management/Set-channel-goal.md +++ b/docs/ru/md/Slack/Channel-management/Set-channel-goal.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 12 ---- - -# Установить цель канала - Устанавливает цель (описание) канала - - -*Функция УстановитьЦельКанала(Знач Токен, Знач Канал, Знач Цель) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Цель | --purpose | Строка | Цель канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Цель = "Тестовая цель"; - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.УстановитьЦельКанала(Токен, Канал, Цель); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack УстановитьЦельКанала --token %token% --channel "C070VPMKN8J" --purpose "Тестовая цель" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542983, - "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": 1714146542 - }, - "purpose": { - "value": "Тестовая цель", - "creator": "U06UG1CAYH2", - "last_set": 1714146542 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 12 +--- + +# Установить цель канала + Устанавливает цель (описание) канала + + +*Функция УстановитьЦельКанала(Знач Токен, Знач Канал, Знач Цель) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Цель | --purpose | Строка | Цель канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Цель = "Тестовая цель"; + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.УстановитьЦельКанала(Токен, Канал, Цель); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack УстановитьЦельКанала --token %token% --channel "C070VPMKN8J" --purpose "Тестовая цель" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542983, + "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": 1714146542 + }, + "purpose": { + "value": "Тестовая цель", + "creator": "U06UG1CAYH2", + "last_set": 1714146542 + }, + "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 index 4a39e46ac3..ec806826ab 100644 --- a/docs/ru/md/Slack/Channel-management/Set-channel-topic.md +++ b/docs/ru/md/Slack/Channel-management/Set-channel-topic.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 11 ---- - -# Установить тему канала - Устанавливает тему канала - - -*Функция УстановитьТемуКанала(Знач Токен, Знач Канал, Знач Тема) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | ID канала | - | Тема | --theme | Строка | Тема канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - Тема = "Тестовая тема"; - - Ответ = OPI_Slack.УстановитьТемуКанала(Токен, Канал, Тема); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack УстановитьТемуКанала --token %token% --channel "C070VPMKN8J" --theme "Тестовая тема" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": { - "id": "C070VPMKN8J", - "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_channel": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_private": false, - "created": 1714146542, - "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", - "is_shared": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "pending_shared": [], - "context_team_id": "T06UD92BS3C", - "updated": 1714146542817, - "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": 1714146542 - }, - "purpose": { - "value": "", - "creator": "", - "last_set": 0 - }, - "previous_names": [] - } - } - -``` +--- +sidebar_position: 11 +--- + +# Установить тему канала + Устанавливает тему канала + + +*Функция УстановитьТемуКанала(Знач Токен, Знач Канал, Знач Тема) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Тема | --theme | Строка | Тема канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + Тема = "Тестовая тема"; + + Ответ = OPI_Slack.УстановитьТемуКанала(Токен, Канал, Тема); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack УстановитьТемуКанала --token %token% --channel "C070VPMKN8J" --theme "Тестовая тема" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": { + "id": "C070VPMKN8J", + "name": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_channel": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_private": false, + "created": 1714146542, + "is_archived": false, + "is_general": false, + "unlinked": 0, + "name_normalized": "testconv9a14fe4d-2fb1-4e47-b1e4-9bc1e4f7a05c", + "is_shared": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "pending_shared": [], + "context_team_id": "T06UD92BS3C", + "updated": 1714146542817, + "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": 1714146542 + }, + "purpose": { + "value": "", + "creator": "", + "last_set": 0 + }, + "previous_names": [] + } + } + +``` diff --git a/docs/ru/md/Slack/Deleted-files-management/Add-external-file.md b/docs/ru/md/Slack/Deleted-files-management/Add-external-file.md index 09b930e3da..bfb4d40195 100644 --- a/docs/ru/md/Slack/Deleted-files-management/Add-external-file.md +++ b/docs/ru/md/Slack/Deleted-files-management/Add-external-file.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 3 ---- - -# Добавить внешний файл - Добавляет новый внешний файл - - -*Функция ДобавитьВнешнийФайл(Знач Токен, Знач URL, Знач Заголовок) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | URL | --url | Строка | URL к внешнему файлу | - | Заголовок | --title | Строка | Заголовок файла для Slack | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - URL = https://opi.neocities.org/test_data/document.docx; - Заголовок = "Новый файл"; - - Ответ = OPI_Slack.ДобавитьВнешнийФайл(Токен, URL, Заголовок); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ДобавитьВнешнийФайл --token %token% --url "https://opi.neocities.org/test_data/document.docx" --title %title% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "file": { - "id": "F070P52CU94", - "created": 1714146552, - "timestamp": 1714146552, - "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/F070P52CU94/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } - } - -``` +--- +sidebar_position: 3 +--- + +# Добавить внешний файл + Добавляет новый внешний файл + + +*Функция ДобавитьВнешнийФайл(Знач Токен, Знач URL, Знач Заголовок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | URL | --url | Строка | URL к внешнему файлу | + | Заголовок | --title | Строка | Заголовок файла для Slack | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + URL = https://opi.neocities.org/test_data/document.docx; + Заголовок = "Новый файл"; + + Ответ = OPI_Slack.ДобавитьВнешнийФайл(Токен, URL, Заголовок); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ДобавитьВнешнийФайл --token %token% --url "https://opi.neocities.org/test_data/document.docx" --title %title% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "file": { + "id": "F070P52CU94", + "created": 1714146552, + "timestamp": 1714146552, + "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/F070P52CU94/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } + } + +``` diff --git a/docs/ru/md/Slack/Deleted-files-management/Delete-external-file.md b/docs/ru/md/Slack/Deleted-files-management/Delete-external-file.md index e80b689af8..145070f734 100644 --- a/docs/ru/md/Slack/Deleted-files-management/Delete-external-file.md +++ b/docs/ru/md/Slack/Deleted-files-management/Delete-external-file.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Удалить внешний файл - Удаляет внешний файл из Slack - - -*Функция УдалитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - ИдентификаторФайла = "F070P52CU94"; - - Ответ = OPI_Slack.УдалитьВнешнийФайл(Токен, ИдентификаторФайла); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack УдалитьВнешнийФайл --token %token% --fileid "F070P52CU94" - - -``` - - -```json title="Результат" - -{ - "ok": true - } - -``` +--- +sidebar_position: 5 +--- + +# Удалить внешний файл + Удаляет внешний файл из Slack + + +*Функция УдалитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + ИдентификаторФайла = "F070P52CU94"; + + Ответ = OPI_Slack.УдалитьВнешнийФайл(Токен, ИдентификаторФайла); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack УдалитьВнешнийФайл --token %token% --fileid "F070P52CU94" + + +``` + + +```json title="Результат" + +{ + "ok": true + } + +``` diff --git a/docs/ru/md/Slack/Deleted-files-management/Get-external-file-list.md b/docs/ru/md/Slack/Deleted-files-management/Get-external-file-list.md index 8f13f651db..812db110be 100644 --- a/docs/ru/md/Slack/Deleted-files-management/Get-external-file-list.md +++ b/docs/ru/md/Slack/Deleted-files-management/Get-external-file-list.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 1 ---- - -# Получить список внешних файлов - Получает список внешних файлов пользователя или канала - - -*Функция ПолучитьСписокВнешнихФайлов(Знач Токен, Знач Канал = "", Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Канал для отбора | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПолучитьСписокВнешнихФайлов(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокВнешнихФайлов --token %token% --channel "C070VPMKN8J" --cursor %cursor% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "files": [], - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +sidebar_position: 1 +--- + +# Получить список внешних файлов + Получает список внешних файлов пользователя или канала + + +*Функция ПолучитьСписокВнешнихФайлов(Знач Токен, Знач Канал = "", Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Канал для отбора | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПолучитьСписокВнешнихФайлов(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокВнешнихФайлов --token %token% --channel "C070VPMKN8J" --cursor %cursor% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "files": [], + "response_metadata": { + "next_cursor": "" + } + } + +``` diff --git a/docs/ru/md/Slack/Deleted-files-management/Get-external-file.md b/docs/ru/md/Slack/Deleted-files-management/Get-external-file.md index 120ba1f139..197e5f1a17 100644 --- a/docs/ru/md/Slack/Deleted-files-management/Get-external-file.md +++ b/docs/ru/md/Slack/Deleted-files-management/Get-external-file.md @@ -1,80 +1,80 @@ ---- -sidebar_position: 2 ---- - -# Получить внешний файл - Получает информацию о внешнем файле - - -*Функция ПолучитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - ИдентификаторФайла = "F070P52CU94"; - - Ответ = OPI_Slack.ПолучитьВнешнийФайл(Токен, ИдентификаторФайла); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьВнешнийФайл --token %token% --fileid "F070P52CU94" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "file": { - "id": "F070P52CU94", - "created": 1714146552, - "timestamp": 1714146552, - "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/F070P52CU94/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } - } - -``` +--- +sidebar_position: 2 +--- + +# Получить внешний файл + Получает информацию о внешнем файле + + +*Функция ПолучитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + ИдентификаторФайла = "F070P52CU94"; + + Ответ = OPI_Slack.ПолучитьВнешнийФайл(Токен, ИдентификаторФайла); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьВнешнийФайл --token %token% --fileid "F070P52CU94" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "file": { + "id": "F070P52CU94", + "created": 1714146552, + "timestamp": 1714146552, + "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/F070P52CU94/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": {}, + "channels": [], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } + } + +``` diff --git a/docs/ru/md/Slack/Deleted-files-management/Send-external-file.md b/docs/ru/md/Slack/Deleted-files-management/Send-external-file.md index 6bf1a981fc..da623a70d4 100644 --- a/docs/ru/md/Slack/Deleted-files-management/Send-external-file.md +++ b/docs/ru/md/Slack/Deleted-files-management/Send-external-file.md @@ -1,99 +1,99 @@ ---- -sidebar_position: 4 ---- - -# Отправить внешний файл - Отправляет внейшний файл по списку каналов - - -*Функция ОтправитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла, Знач МассивКаналов) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - | МассивКаналов | --channels | Массив Из Строка | Массив каналов для отправки | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - ИдентификаторФайла = "F070P52CU94"; - - Ответ = OPI_Slack.ОтправитьВнешнийФайл(Токен, ИдентификаторФайла, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ОтправитьВнешнийФайл --token %token% --fileid "F070P52CU94" --channels %channels% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "file": { - "id": "F070P52CU94", - "created": 1714146552, - "timestamp": 1714146552, - "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/F070P52CU94/novyj_fajl", - "comments_count": 0, - "is_starred": false, - "shares": { - "public": { - "C06UFNUTKUL": [ - { - "reply_users": [], - "reply_users_count": 0, - "reply_count": 0, - "ts": "1714146553.217059", - "channel_name": "slack-api-librarry", - "team_id": "T06UD92BS3C", - "share_user_id": "U06UG1CAYH2", - "source": "UNKNOWN" - } - ] - } - }, - "channels": [ - "C06UFNUTKUL" - ], - "groups": [], - "ims": [], - "has_more_shares": false, - "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", - "external_url": "https://slack.com/api/files.remote.add", - "has_rich_preview": false, - "file_access": "visible" - } - } - -``` +--- +sidebar_position: 4 +--- + +# Отправить внешний файл + Отправляет внейшний файл по списку каналов + + +*Функция ОтправитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла, Знач МассивКаналов) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + | МассивКаналов | --channels | Массив Из Строка | Массив каналов для отправки | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + ИдентификаторФайла = "F070P52CU94"; + + Ответ = OPI_Slack.ОтправитьВнешнийФайл(Токен, ИдентификаторФайла, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ОтправитьВнешнийФайл --token %token% --fileid "F070P52CU94" --channels %channels% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "file": { + "id": "F070P52CU94", + "created": 1714146552, + "timestamp": 1714146552, + "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/F070P52CU94/novyj_fajl", + "comments_count": 0, + "is_starred": false, + "shares": { + "public": { + "C06UFNUTKUL": [ + { + "reply_users": [], + "reply_users_count": 0, + "reply_count": 0, + "ts": "1714146553.217059", + "channel_name": "slack-api-librarry", + "team_id": "T06UD92BS3C", + "share_user_id": "U06UG1CAYH2", + "source": "UNKNOWN" + } + ] + } + }, + "channels": [ + "C06UFNUTKUL" + ], + "groups": [], + "ims": [], + "has_more_shares": false, + "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", + "external_url": "https://slack.com/api/files.remote.add", + "has_rich_preview": false, + "file_access": "visible" + } + } + +``` diff --git a/docs/ru/md/Slack/Dialog-management/Close-dialog.md b/docs/ru/md/Slack/Dialog-management/Close-dialog.md index 81bc1ac72f..25fa75dcae 100644 --- a/docs/ru/md/Slack/Dialog-management/Close-dialog.md +++ b/docs/ru/md/Slack/Dialog-management/Close-dialog.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 2 ---- - -# Закрыть диалог - Закрывает существующий диалог - - -*Функция ЗакрытьДиалог(Знач Токен, Знач Диалог) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Диалог | --conv | Строка | ID диалога | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Диалог = "D06UAKK1C6R"; - - Ответ = OPI_Slack.ЗакрытьДиалог(Токен, Диалог); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ЗакрытьДиалог --token %token% --conv "D06UAKK1C6R" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "already_closed": false, - "no_op": false - } - -``` +--- +sidebar_position: 2 +--- + +# Закрыть диалог + Закрывает существующий диалог + + +*Функция ЗакрытьДиалог(Знач Токен, Знач Диалог) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Диалог | --conv | Строка | ID диалога | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Диалог = "D06UAKK1C6R"; + + Ответ = OPI_Slack.ЗакрытьДиалог(Токен, Диалог); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ЗакрытьДиалог --token %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 index f70897702b..1f7954e341 100644 --- a/docs/ru/md/Slack/Dialog-management/Open-dialog.md +++ b/docs/ru/md/Slack/Dialog-management/Open-dialog.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 1 ---- - -# Открыть диалог - Открывает новый диалог с одним или несколькими пользователями - - -*Функция ОткрытьДиалог(Знач Токен, Знач МассивПользователей) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | МассивПользователей | --users | Массив из Строка | Массив ID пользователей | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - МассивПользователей = Новый Массив; - МассивПользователей.Добавить("U123456"); - МассивПользователей.Добавить("U654321"); - - Ответ = OPI_Slack.ОткрытьДиалог(Токен, МассивПользователей); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ОткрытьДиалог --token %token% --users %users% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "no_op": false, - "already_open": false, - "channel": { - "id": "D06UAKK1C6R" - } - } - -``` +--- +sidebar_position: 1 +--- + +# Открыть диалог + Открывает новый диалог с одним или несколькими пользователями + + +*Функция ОткрытьДиалог(Знач Токен, Знач МассивПользователей) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | МассивПользователей | --users | Массив из Строка | Массив ID пользователей | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + МассивПользователей = Новый Массив; + МассивПользователей.Добавить("U123456"); + МассивПользователей.Добавить("U654321"); + + Ответ = OPI_Slack.ОткрытьДиалог(Токен, МассивПользователей); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ОткрытьДиалог --token %token% --users %users% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "no_op": false, + "already_open": false, + "channel": { + "id": "D06UAKK1C6R" + } + } + +``` diff --git a/docs/ru/md/Slack/File-work/Delete-file.md b/docs/ru/md/Slack/File-work/Delete-file.md index f4d6e84e4b..dc625b1a04 100644 --- a/docs/ru/md/Slack/File-work/Delete-file.md +++ b/docs/ru/md/Slack/File-work/Delete-file.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 4 ---- - -# Удалить файл - Удаляет файл на Slack - - -*Функция УдалитьФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - ИдентификаторФайла = "F070VL6FQFM"; - - Ответ = OPI_Slack.УдалитьФайл(Токен, ИдентификаторФайла); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack УдалитьФайл --token %token% --fileid "F070VL6FQFM" - - -``` - - -```json title="Результат" - -{ - "ok": true - } - -``` +--- +sidebar_position: 4 +--- + +# Удалить файл + Удаляет файл на Slack + + +*Функция УдалитьФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + ИдентификаторФайла = "F070VL6FQFM"; + + Ответ = OPI_Slack.УдалитьФайл(Токен, ИдентификаторФайла); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack УдалитьФайл --token %token% --fileid "F070VL6FQFM" + + +``` + + +```json title="Результат" + +{ + "ok": true + } + +``` diff --git a/docs/ru/md/Slack/File-work/Get-file-data.md b/docs/ru/md/Slack/File-work/Get-file-data.md index db3df69361..199ff87ed9 100644 --- a/docs/ru/md/Slack/File-work/Get-file-data.md +++ b/docs/ru/md/Slack/File-work/Get-file-data.md @@ -1,84 +1,84 @@ ---- -sidebar_position: 3 ---- - -# Получить данные файла - Получает информацию о файле - - -*Функция ПолучитьДанныеФайла(Знач Токен, Знач ИдентификаторФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - ИдентификаторФайла = "F070VL6FQFM"; - - Ответ = OPI_Slack.ПолучитьДанныеФайла(Токен, ИдентификаторФайла); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьДанныеФайла --token %token% --fileid "F070VL6FQFM" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "file": { - "id": "F070VL6FQFM", - "created": 1714146550, - "timestamp": 1714146550, - "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-F070VL6FQFM/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070VL6FQFM/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F070VL6FQFM-9fb2618d36", - "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": "" - } - } - -``` +--- +sidebar_position: 3 +--- + +# Получить данные файла + Получает информацию о файле + + +*Функция ПолучитьДанныеФайла(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + ИдентификаторФайла = "F070VL6FQFM"; + + Ответ = OPI_Slack.ПолучитьДанныеФайла(Токен, ИдентификаторФайла); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьДанныеФайла --token %token% --fileid "F070VL6FQFM" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "file": { + "id": "F070VL6FQFM", + "created": 1714146550, + "timestamp": 1714146550, + "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-F070VL6FQFM/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070VL6FQFM/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F070VL6FQFM-9fb2618d36", + "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-work/Get-files-list.md b/docs/ru/md/Slack/File-work/Get-files-list.md index ee9aa1b9d7..d049a54d50 100644 --- a/docs/ru/md/Slack/File-work/Get-files-list.md +++ b/docs/ru/md/Slack/File-work/Get-files-list.md @@ -1,84 +1,84 @@ ---- -sidebar_position: 1 ---- - -# Получить список файлов - Получает список файлов бота или канала - - -*Функция ПолучитьСписокФайлов(Знач Токен, Знач Канал = "", Знач НомерСтраницы = 1) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Канал для отбора | - | НомерСтраницы | --page | Число, Строка | Номер страницы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - НомерСтраницы = 1; - Канал = "C123456"; - - Ответ = OPI_Slack.ПолучитьСписокФайлов(Токен, Канал, НомерСтраницы); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокФайлов --token %token% --channel "C123456" --page "1" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "files": [ - { - "id": "F070V4U7Y4R", - "created": 1713978714, - "timestamp": 1713978714, - "name": "megadoc.docx", - "title": "Новый файл", - "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "filetype": "docx", - "pretty_type": "Word Document", - "user": "U06UG1CAYH2", - "user_team": "T06UD92BS3C", - "editable": false, - "size": 24069, - "mode": "hosted", - "is_external": false, - "external_type": "", - "is_public": true, - "public_url_shared": false, - "display_as_bot": false, - "username": "", - "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/download/megadoc.docx", - "media_display_type": "unknown", - "converted_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_converted.pdf", - "thumb_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_thumb_pdf.png", - "thumb_pdf_w": 909, - "thumb_pdf_h": 1286, - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070V4U7Y4R/megadoc.docx", - "channels": [ - "C06UFNUTKUL" - ], - "groups": [], - "ims": [], - "comments_count": 0 - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Получить список файлов + Получает список файлов бота или канала + + +*Функция ПолучитьСписокФайлов(Знач Токен, Знач Канал = "", Знач НомерСтраницы = 1) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Канал для отбора | + | НомерСтраницы | --page | Число, Строка | Номер страницы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + НомерСтраницы = 1; + Канал = "C123456"; + + Ответ = OPI_Slack.ПолучитьСписокФайлов(Токен, Канал, НомерСтраницы); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокФайлов --token %token% --channel "C123456" --page "1" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "files": [ + { + "id": "F070V4U7Y4R", + "created": 1713978714, + "timestamp": 1713978714, + "name": "megadoc.docx", + "title": "Новый файл", + "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "filetype": "docx", + "pretty_type": "Word Document", + "user": "U06UG1CAYH2", + "user_team": "T06UD92BS3C", + "editable": false, + "size": 24069, + "mode": "hosted", + "is_external": false, + "external_type": "", + "is_public": true, + "public_url_shared": false, + "display_as_bot": false, + "username": "", + "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/download/megadoc.docx", + "media_display_type": "unknown", + "converted_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_converted.pdf", + "thumb_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_thumb_pdf.png", + "thumb_pdf_w": 909, + "thumb_pdf_h": 1286, + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070V4U7Y4R/megadoc.docx", + "channels": [ + "C06UFNUTKUL" + ], + "groups": [], + "ims": [], + "comments_count": 0 + } + ] + } + +``` diff --git a/docs/ru/md/Slack/File-work/Make-file-private.md b/docs/ru/md/Slack/File-work/Make-file-private.md index 5be8cdbc20..b06da76d43 100644 --- a/docs/ru/md/Slack/File-work/Make-file-private.md +++ b/docs/ru/md/Slack/File-work/Make-file-private.md @@ -1,37 +1,37 @@ ---- -sidebar_position: 6 ---- - -# Сделать файл приватным - Удаляет публичный URL у файла. Требует токен пользователя - - -*Функция СделатьФайлПриватным(Знач Токен, Знач ИдентификаторФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен пользователя | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint slack СделатьФайлПриватным --token %token% --fileid %fileid% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 6 +--- + +# Сделать файл приватным + Удаляет публичный URL у файла. Требует токен пользователя + + +*Функция СделатьФайлПриватным(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен пользователя | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint slack СделатьФайлПриватным --token %token% --fileid %fileid% + + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/ru/md/Slack/File-work/Make-file-public.md b/docs/ru/md/Slack/File-work/Make-file-public.md index d0f4e75313..3c7d394ac9 100644 --- a/docs/ru/md/Slack/File-work/Make-file-public.md +++ b/docs/ru/md/Slack/File-work/Make-file-public.md @@ -1,37 +1,37 @@ ---- -sidebar_position: 5 ---- - -# Сделать файл публичным - Создает публичный URL для файла. Требует токен пользователя - - -*Функция СделатьФайлПубличным(Знач Токен, Знач ИдентификаторФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен пользователя | - | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint slack СделатьФайлПубличным --token %token% --fileid %fileid% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 5 +--- + +# Сделать файл публичным + Создает публичный URL для файла. Требует токен пользователя + + +*Функция СделатьФайлПубличным(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен пользователя | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint slack СделатьФайлПубличным --token %token% --fileid %fileid% + + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/ru/md/Slack/File-work/Upload-file.md b/docs/ru/md/Slack/File-work/Upload-file.md index e1e3627136..90b0ad240d 100644 --- a/docs/ru/md/Slack/File-work/Upload-file.md +++ b/docs/ru/md/Slack/File-work/Upload-file.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 2 ---- - -# Загрузить файл - Загружает файл на сервера Slack - - -*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач ИмяФайла, Знач Заголовок, Знач Канал = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | - | ИмяФайла | --filename | Строка | Имя файла с расширением | - | Заголовок | --title | Строка | Имя файла в Slack | - | Канал | --channel | Строка | ID канала | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - ИмяФайла = "megadoc.docx"; - Файл = Новый ДвоичныеДанные("D:\" + ИмяФайла); - Заголовок = "Новый файл"; - Канал = "C123456"; - - Ответ = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ЗагрузитьФайл --token %token% --file %file% --filename "megadoc.docx" --title %title% --channel "C123456" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "files": [ - { - "id": "F070SS4UHNZ", - "created": 1714146549, - "timestamp": 1714146549, - "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-F070SS4UHNZ/megadoc.docx", - "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/download/megadoc.docx", - "media_display_type": "unknown", - "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070SS4UHNZ/megadoc.docx", - "permalink_public": "https://slack-files.com/T06UD92BS3C-F070SS4UHNZ-e68bef4a91", - "comments_count": 0, - "is_starred": false, - "shares": {}, - "channels": [], - "groups": [], - "ims": [], - "has_more_shares": false, - "has_rich_preview": false, - "file_access": "visible" - } - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Загрузить файл + Загружает файл на сервера Slack + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач ИмяФайла, Знач Заголовок, Знач Канал = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | + | ИмяФайла | --filename | Строка | Имя файла с расширением | + | Заголовок | --title | Строка | Имя файла в Slack | + | Канал | --channel | Строка | ID канала | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + ИмяФайла = "megadoc.docx"; + Файл = Новый ДвоичныеДанные("D:\" + ИмяФайла); + Заголовок = "Новый файл"; + Канал = "C123456"; + + Ответ = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ЗагрузитьФайл --token %token% --file %file% --filename "megadoc.docx" --title %title% --channel "C123456" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "files": [ + { + "id": "F070SS4UHNZ", + "created": 1714146549, + "timestamp": 1714146549, + "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-F070SS4UHNZ/megadoc.docx", + "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/download/megadoc.docx", + "media_display_type": "unknown", + "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070SS4UHNZ/megadoc.docx", + "permalink_public": "https://slack-files.com/T06UD92BS3C-F070SS4UHNZ-e68bef4a91", + "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 index fe076ad973..9b72fcaa6c 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о боте - Получает основную информацию о боте - - -*Функция ПолучитьИнформациюОБоте(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - - Ответ = OPI_Slack.ПолучитьИнформациюОБоте(Токен); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьИнформациюОБоте --token %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 - } - -``` +--- +sidebar_position: 1 +--- + +# Получить информацию о боте + Получает основную информацию о боте + + +*Функция ПолучитьИнформациюОБоте(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + + Ответ = OPI_Slack.ПолучитьИнформациюОБоте(Токен); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьИнформациюОБоте --token %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 index 172641d9d9..1128c3bc46 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-user-list.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-user-list.md @@ -1,196 +1,196 @@ ---- -sidebar_position: 3 ---- - -# Получить список пользователей - Получает список пользователей рабочей области - - -*Функция ПолучитьСписокПользователей(Знач Токен, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - - Ответ = OPI_Slack.ПолучитьСписокПользователей(Токен, Курсор); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокПользователей --token %token% --cursor %cursor% - - -``` - - -```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" - } - ], - "cache_ts": 1714215811, - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +sidebar_position: 3 +--- + +# Получить список пользователей + Получает список пользователей рабочей области + + +*Функция ПолучитьСписокПользователей(Знач Токен, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + + Ответ = OPI_Slack.ПолучитьСписокПользователей(Токен, Курсор); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокПользователей --token %token% --cursor %cursor% + + +``` + + +```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" + } + ], + "cache_ts": 1714215811, + "response_metadata": { + "next_cursor": "" + } + } + +``` 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 index 1b169c4509..51241ddec3 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 2 ---- - -# Получить список рабочих областей - Получает список рабочих областей, в которых подключен бот - - -*Функция ПолучитьСписокРабочихОбластей(Знач Токен, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - - Ответ = OPI_Slack.ПолучитьСписокРабочихОбластей(Токен); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокРабочихОбластей --token %token% --cursor %cursor% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "teams": [ - { - "id": "T06UD92BS3C", - "name": "OpenIntegrations" - } - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Получить список рабочих областей + Получает список рабочих областей, в которых подключен бот + + +*Функция ПолучитьСписокРабочихОбластей(Знач Токен, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + + Ответ = OPI_Slack.ПолучитьСписокРабочихОбластей(Токен); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокРабочихОбластей --token %token% --cursor %cursor% + + +``` + + +```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 index 92596b3fd4..81547cbb30 100644 --- a/docs/ru/md/Slack/Message-management/Delete-message.md +++ b/docs/ru/md/Slack/Message-management/Delete-message.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 4 ---- - -# Удалить сообщение - Удаляет сообщение канала по timestamp - - -*Функция УдалитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач ЭтоОтложенное = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка или ID сообщения | - | ЭтоОтложенное | --issheduled | Булево | Признак удаления отложенного сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C06UFNUTKUL"; - Отметка = "1714146538.221929"; - - Ответ = OPI_Slack.УдалитьСообщение(Токен, Канал, Отметка); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack УдалитьСообщение --token %token% --channel "C06UFNUTKUL" --stamp "1714146538.221929" --issheduled %issheduled% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1714146538.221929" - } - -``` +--- +sidebar_position: 4 +--- + +# Удалить сообщение + Удаляет сообщение канала по timestamp + + +*Функция УдалитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач ЭтоОтложенное = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + | ЭтоОтложенное | --issheduled | Булево | Признак удаления отложенного сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C06UFNUTKUL"; + Отметка = "1714146538.221929"; + + Ответ = OPI_Slack.УдалитьСообщение(Токен, Канал, Отметка); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack УдалитьСообщение --token %token% --channel "C06UFNUTKUL" --stamp "1714146538.221929" --issheduled %issheduled% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1714146538.221929" + } + +``` diff --git a/docs/ru/md/Slack/Message-management/Edit-message.md b/docs/ru/md/Slack/Message-management/Edit-message.md index 1c1ccf540e..b0e02773ea 100644 --- a/docs/ru/md/Slack/Message-management/Edit-message.md +++ b/docs/ru/md/Slack/Message-management/Edit-message.md @@ -1,91 +1,91 @@ ---- -sidebar_position: 3 ---- - -# Изменить сообщение - Изменяет состав существующего сообщения - - -*Функция ИзменитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Текст = "", Знач МассивБлоков = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка сообщения | - | Текст | --text | Строка | Новый текст сообщения | - | МассивБлоков | --blocks | Массив Из Структура | JSON массива описаний блоков | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - Отметка = "1714146538.221929"; - Текст = "Тестовое сообщение 2"; - - Ответ = OPI_Slack.ИзменитьСообщение(Токен, Канал, Отметка, Текст); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ИзменитьСообщение --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --text "Тестовое сообщение 2" --blocks %blocks% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1714146538.221929", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1714146538.221929", - "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": "MO6", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "Тестовое сообщение 2" - } - ] - } - ] - } - ] - } - } - -``` +--- +sidebar_position: 3 +--- + +# Изменить сообщение + Изменяет состав существующего сообщения + + +*Функция ИзменитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Текст = "", Знач МассивБлоков = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка сообщения | + | Текст | --text | Строка | Новый текст сообщения | + | МассивБлоков | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + Отметка = "1714146538.221929"; + Текст = "Тестовое сообщение 2"; + + Ответ = OPI_Slack.ИзменитьСообщение(Токен, Канал, Отметка, Текст); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ИзменитьСообщение --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --text "Тестовое сообщение 2" --blocks %blocks% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1714146538.221929", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1714146538.221929", + "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": "MO6", + "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 index 9f5a31dabf..4da534affc 100644 --- a/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md +++ b/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 5 ---- - -# Получить список отложенных сообщений - Получает список отложенных сообщений канала - - -*Функция ПолучитьСписокОтложенныхСообщений(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - - Ответ = OPI_Slack.ПолучитьСписокОтложенныхСообщений(Токен, Канал); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокОтложенныхСообщений --token %token% --channel "C070VPMKN8J" --cursor %cursor% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "scheduled_messages": [], - "response_metadata": { - "next_cursor": "" - } - } - -``` +--- +sidebar_position: 5 +--- + +# Получить список отложенных сообщений + Получает список отложенных сообщений канала + + +*Функция ПолучитьСписокОтложенныхСообщений(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + + Ответ = OPI_Slack.ПолучитьСписокОтложенныхСообщений(Токен, Канал); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокОтложенныхСообщений --token %token% --channel "C070VPMKN8J" --cursor %cursor% + + +``` + + +```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 index 6c6353ed05..4c58ffe785 100644 --- a/docs/ru/md/Slack/Message-management/Get-message-link.md +++ b/docs/ru/md/Slack/Message-management/Get-message-link.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 6 ---- - -# Получить ссылку на сообщение - Получает постоянный UTL к сообщению канала - - -*Функция ПолучитьСсылкуНаСообщение(Знач Токен, Знач Канал, Знач Отметка) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка или ID сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - Отметка = "1714146538.221929"; - - Ответ = OPI_Slack.ПолучитьСсылкуНаСообщение(Токен, Канал, Отметка); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСсылкуНаСообщение --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1714146538221929", - "channel": "C06UFNUTKUL" - } - -``` +--- +sidebar_position: 6 +--- + +# Получить ссылку на сообщение + Получает постоянный UTL к сообщению канала + + +*Функция ПолучитьСсылкуНаСообщение(Знач Токен, Знач Канал, Знач Отметка) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + Отметка = "1714146538.221929"; + + Ответ = OPI_Slack.ПолучитьСсылкуНаСообщение(Токен, Канал, Отметка); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСсылкуНаСообщение --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1714146538221929", + "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 index be1dbab6bf..45e64a04b0 100644 --- a/docs/ru/md/Slack/Message-management/Get-message-reply-list.md +++ b/docs/ru/md/Slack/Message-management/Get-message-reply-list.md @@ -1,94 +1,94 @@ ---- -sidebar_position: 7 ---- - -# Получить список ответов на сообщение - Получает массив сообщений, которые являются ответом на указанное - - -*Функция ПолучитьСписокОтветовНаСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Курсор = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Отметка | --stamp | Строка | Временная отметка или ID сообщения | - | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - Отметка = "1714146538.221929"; - - Ответ = OPI_Slack.ПолучитьСписокОтветовНаСообщение(Токен, Канал, Отметка); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ПолучитьСписокОтветовНаСообщение --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --cursor %cursor% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "messages": [ - { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1714215813.399779", - "edited": { - "user": "B06TZ0MJV5M", - "ts": "1714215813.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": "04z", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "Тестовое сообщение 2" - } - ] - } - ] - } - ] - } - ], - "has_more": false - } - -``` +--- +sidebar_position: 7 +--- + +# Получить список ответов на сообщение + Получает массив сообщений, которые являются ответом на указанное + + +*Функция ПолучитьСписокОтветовНаСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + Отметка = "1714146538.221929"; + + Ответ = OPI_Slack.ПолучитьСписокОтветовНаСообщение(Токен, Канал, Отметка); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ПолучитьСписокОтветовНаСообщение --token %token% --channel "C070VPMKN8J" --stamp "1714146538.221929" --cursor %cursor% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "messages": [ + { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1714215813.399779", + "edited": { + "user": "B06TZ0MJV5M", + "ts": "1714215813.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": "04z", + "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 index 812774898a..4127f0318d 100644 --- a/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md +++ b/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 2 ---- - -# Отправить эфемерное сообщение -Отправляет сообщение, которое приходит в канал, но видно только конкретному пользователю - - -*Функция ОтправитьЭфемерноеСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач Пользователь = "", Знач Блоки = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Текст | --text | Строка | Текст сообщения | - | Пользователь | --user | Строка | ID пользователя | - | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - Блок = OPI_Slack.СформироватьБлокКартинку("https://opi.neocities.org/test_data/picture.jpg", "Картинка"); - - Ответ = OPI_Slack.ОтправитьЭфемерноеСообщение(Токен, Канал, , Пользователь, Блок); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ОтправитьЭфемерноеСообщение --token %token% --channel "C070VPMKN8J" --text %text% --user %user% --blocks %blocks% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "message_ts": "1714146540.000300" - } - -``` +--- +sidebar_position: 2 +--- + +# Отправить эфемерное сообщение +Отправляет сообщение, которое приходит в канал, но видно только конкретному пользователю + + +*Функция ОтправитьЭфемерноеСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач Пользователь = "", Знач Блоки = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Текст | --text | Строка | Текст сообщения | + | Пользователь | --user | Строка | ID пользователя | + | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + Блок = OPI_Slack.СформироватьБлокКартинку("https://opi.neocities.org/test_data/picture.jpg", "Картинка"); + + Ответ = OPI_Slack.ОтправитьЭфемерноеСообщение(Токен, Канал, , Пользователь, Блок); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ОтправитьЭфемерноеСообщение --token %token% --channel "C070VPMKN8J" --text %text% --user %user% --blocks %blocks% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "message_ts": "1714146540.000300" + } + +``` diff --git a/docs/ru/md/Slack/Message-management/Send-message.md b/docs/ru/md/Slack/Message-management/Send-message.md index 93e365d1d0..e9e226d266 100644 --- a/docs/ru/md/Slack/Message-management/Send-message.md +++ b/docs/ru/md/Slack/Message-management/Send-message.md @@ -1,90 +1,90 @@ ---- -sidebar_position: 1 ---- - -# Отправить сообщение - Отправляет сообщение в выбранный час - - -*Функция ОтправитьСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач ДатаОтправки = "", Знач Блоки = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Канал | --channel | Строка | Идентификатор канала | - | Текст | --text | Строка | Текст сообщения | - | ДатаОтправки | --date | Дата | Дата отправки для отложенного сообщения | - | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack - -```bsl title="Пример кода" - - - Канал = "C070VPMKN8J"; - Текст = "Тестовое сообщение"; - - Ответ = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint slack ОтправитьСообщение --token %token% --channel "C070VPMKN8J" --text "Тестовое сообщение" --date %date% --blocks %blocks% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "channel": "C06UFNUTKUL", - "ts": "1714146538.221929", - "message": { - "user": "U06UG1CAYH2", - "type": "message", - "ts": "1714146538.221929", - "bot_id": "B06TZ0MJV5M", - "app_id": "A06TYNH45RV", - "text": "Тестовое сообщение", - "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": "MO6", - "elements": [ - { - "type": "rich_text_section", - "elements": [ - { - "type": "text", - "text": "Тестовое сообщение" - } - ] - } - ] - } - ] - } - } - -``` +--- +sidebar_position: 1 +--- + +# Отправить сообщение + Отправляет сообщение в выбранный час + + +*Функция ОтправитьСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач ДатаОтправки = "", Знач Блоки = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Текст | --text | Строка | Текст сообщения | + | ДатаОтправки | --date | Дата | Дата отправки для отложенного сообщения | + | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + Канал = "C070VPMKN8J"; + Текст = "Тестовое сообщение"; + + Ответ = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint slack ОтправитьСообщение --token %token% --channel "C070VPMKN8J" --text "Тестовое сообщение" --date %date% --blocks %blocks% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "channel": "C06UFNUTKUL", + "ts": "1714146538.221929", + "message": { + "user": "U06UG1CAYH2", + "type": "message", + "ts": "1714146538.221929", + "bot_id": "B06TZ0MJV5M", + "app_id": "A06TYNH45RV", + "text": "Тестовое сообщение", + "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": "MO6", + "elements": [ + { + "type": "rich_text_section", + "elements": [ + { + "type": "text", + "text": "Тестовое сообщение" + } + ] + } + ] + } + ] + } + } + +``` diff --git a/docs/ru/md/Telegram/Administration/Ban.md b/docs/ru/md/Telegram/Administration/Ban.md index b0c853ddb5..c0042ad559 100644 --- a/docs/ru/md/Telegram/Administration/Ban.md +++ b/docs/ru/md/Telegram/Administration/Ban.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 1 ---- - -# Бан - Банит пользователя в выбранном чате - - -*Функция Бан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | IDПользователя | --user | Строка,Число | ID целевого пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDПользователя = "461699897"; - IDКанала = "@testsichee"; - - Результат = OPI_Telegram.Бан(Токен, IDКанала, IDПользователя); - - -``` - -```sh title="Пример команды CLI" - - oint telegram Бан --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897" - - -``` - - -```json title="Результат" - -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} - -``` +--- +sidebar_position: 1 +--- + +# Бан + Банит пользователя в выбранном чате + + +*Функция Бан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | IDПользователя | --user | Строка,Число | ID целевого пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDПользователя = "461699897"; + IDКанала = "@testsichee"; + + Результат = OPI_Telegram.Бан(Токен, IDКанала, IDПользователя); + + +``` + +```sh title="Пример команды CLI" + + oint telegram Бан --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --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 index c07c392e66..f63705761e 100644 --- a/docs/ru/md/Telegram/Administration/Create-invitation-link.md +++ b/docs/ru/md/Telegram/Administration/Create-invitation-link.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 3 ---- - -# Создать ссылку-приглашение - Создает ссылку для вступления в закрытый чат - - -*Функция СоздатьСсылкуПриглашение(Знач Токен, Знач IDЧата, Знач Заголовок = "", Знач ДатаИстечения = "", Знач ЛимитПользователей = 0) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Заголовок | --title | Строка | Заголовок приглашения | - | ДатаИстечения | --expire | Дата | Дата окончания жизни ссылки (безсрочно, если не указано) | - | ЛимитПользователей | --limit | Число | Лимит пользователей (бесконечно, если не указано) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - Сутки = 86400; - ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); - - Заголовок = "Ссылка " + Строка(ТекущаяДата); - Истечение = ТекущаяДата + Сутки; - UnixИстечение = OPI_Инструменты.UNIXTime(Истечение); - - Результат = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, IDКанала, Заголовок, Истечение, 200); - - -``` - -```sh title="Пример команды CLI" - - oint telegram СоздатьСсылкуПриглашение --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --title %title% --expire %expire% --limit %limit% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "invite_link": "https://t.me/+W-9MzjOejStiYzYy", - "name": "Ссылка 05/30/2024 12:34:59", - "creator": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "expire_date": 1717155300, - "member_limit": 200, - "creates_join_request": false, - "is_primary": false, - "is_revoked": false - } -} - -``` +--- +sidebar_position: 3 +--- + +# Создать ссылку-приглашение + Создает ссылку для вступления в закрытый чат + + +*Функция СоздатьСсылкуПриглашение(Знач Токен, Знач IDЧата, Знач Заголовок = "", Знач ДатаИстечения = "", Знач ЛимитПользователей = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Заголовок | --title | Строка | Заголовок приглашения | + | ДатаИстечения | --expire | Дата | Дата окончания жизни ссылки (безсрочно, если не указано) | + | ЛимитПользователей | --limit | Число | Лимит пользователей (бесконечно, если не указано) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + Сутки = 86400; + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + + Заголовок = "Ссылка " + Строка(ТекущаяДата); + Истечение = ТекущаяДата + Сутки; + UnixИстечение = OPI_Инструменты.UNIXTime(Истечение); + + Результат = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, IDКанала, Заголовок, Истечение, 200); + + +``` + +```sh title="Пример команды CLI" + + oint telegram СоздатьСсылкуПриглашение --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --title %title% --expire %expire% --limit %limit% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "invite_link": "https://t.me/+W-9MzjOejStiYzYy", + "name": "Ссылка 05/30/2024 12:34:59", + "creator": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "expire_date": 1717155300, + "member_limit": 200, + "creates_join_request": false, + "is_primary": false, + "is_revoked": false + } +} + +``` diff --git a/docs/ru/md/Telegram/Administration/Get-participant-count.md b/docs/ru/md/Telegram/Administration/Get-participant-count.md index aa8d3a05cc..ea7d3db71f 100644 --- a/docs/ru/md/Telegram/Administration/Get-participant-count.md +++ b/docs/ru/md/Telegram/Administration/Get-participant-count.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 6 ---- - -# Получить число участников - Получает общее число участников чата - - -*Функция ПолучитьЧислоУчастников(Знач Токен, Знач IDЧата) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - - Результат = OPI_Telegram.ПолучитьЧислоУчастников(Токен, IDКанала); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ПолучитьЧислоУчастников --token "6129457865:AAFyzNYOAFbu..." --chat %chat% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": 2 -} - -``` +--- +sidebar_position: 6 +--- + +# Получить число участников + Получает общее число участников чата + + +*Функция ПолучитьЧислоУчастников(Знач Токен, Знач IDЧата) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + + Результат = OPI_Telegram.ПолучитьЧислоУчастников(Токен, IDКанала); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ПолучитьЧислоУчастников --token "6129457865:AAFyzNYOAFbu..." --chat %chat% + + +``` + + +```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 index 22780acfa6..44871c6e79 100644 --- a/docs/ru/md/Telegram/Administration/Pin-message.md +++ b/docs/ru/md/Telegram/Administration/Pin-message.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 4 ---- - -# Закрепить сообщение - Закрепляет сообщение в шапке чата - - -*Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --chat | Строка,Число | ID целевого чата | - | IDСообщения | --message | Строка,Число | ID целевого сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - IDСообщения = "4951"; - - Результат = OPI_Telegram.ЗакрепитьСообщение(Токен, IDКанала, IDСообщения); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ЗакрепитьСообщение --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 4 +--- + +# Закрепить сообщение + Закрепляет сообщение в шапке чата + + +*Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --chat | Строка,Число | ID целевого чата | + | IDСообщения | --message | Строка,Число | ID целевого сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + IDСообщения = "4951"; + + Результат = OPI_Telegram.ЗакрепитьСообщение(Токен, IDКанала, IDСообщения); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ЗакрепитьСообщение --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": true +} + +``` diff --git a/docs/ru/md/Telegram/Administration/Unban.md b/docs/ru/md/Telegram/Administration/Unban.md index 7f485bc653..2b15c2e994 100644 --- a/docs/ru/md/Telegram/Administration/Unban.md +++ b/docs/ru/md/Telegram/Administration/Unban.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 2 ---- - -# Разбан - Разбанивает забаненного ранее пользователя - - -*Функция Разбан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | IDПользователя | --user | Строка,Число | ID целевого пользователя | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDПользователя = "461699897"; - IDКанала = "@testsichee"; - - Результат = OPI_Telegram.Разбан(Токен, IDКанала, IDПользователя); - - -``` - -```sh title="Пример команды CLI" - - oint telegram Разбан --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897" - - -``` - - -```json title="Результат" - -{ - "ok": false, - "error_code": 400, - "description": "Bad Request: can't remove chat owner" -} - -``` +--- +sidebar_position: 2 +--- + +# Разбан + Разбанивает забаненного ранее пользователя + + +*Функция Разбан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | IDПользователя | --user | Строка,Число | ID целевого пользователя | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDПользователя = "461699897"; + IDКанала = "@testsichee"; + + Результат = OPI_Telegram.Разбан(Токен, IDКанала, IDПользователя); + + +``` + +```sh title="Пример команды CLI" + + oint telegram Разбан --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --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 index 3d3de89567..62487c6b1c 100644 --- a/docs/ru/md/Telegram/Administration/Unpin-message.md +++ b/docs/ru/md/Telegram/Administration/Unpin-message.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 5 ---- - -# Открепить сообщение - Открепляет сообщение в шапке чата - - -*Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата | - | IDСообщения | --message | Строка,Число | ID целевого сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDКанала = "@testsichee"; - IDСообщения = "4951"; - - Результат = OPI_Telegram.ОткрепитьСообщение(Токен, IDКанала, IDСообщения); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОткрепитьСообщение --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 5 +--- + +# Открепить сообщение + Открепляет сообщение в шапке чата + + +*Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата | + | IDСообщения | --message | Строка,Число | ID целевого сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDКанала = "@testsichee"; + IDСообщения = "4951"; + + Результат = OPI_Telegram.ОткрепитьСообщение(Токен, IDКанала, IDСообщения); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОткрепитьСообщение --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951" + + +``` + + +```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 index 3e3cc74dc1..d457b7454d 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 4 ---- - -# Удалить Webhook - Удаляет URL обработчика событий бота для работы в режиме Webhook - - -*Функция УдалитьWebhook(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.УдалитьWebhook(Токен); - - -``` - -```sh title="Пример команды CLI" - - oint telegram УдалитьWebhook --token "6129457865:AAFyzNYOAFbu..." - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true, - "description": "Webhook was deleted" -} - -``` +--- +sidebar_position: 4 +--- + +# Удалить Webhook + Удаляет URL обработчика событий бота для работы в режиме Webhook + + +*Функция УдалитьWebhook(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.УдалитьWebhook(Токен); + + +``` + +```sh title="Пример команды CLI" + + oint telegram УдалитьWebhook --token "6129457865:AAFyzNYOAFbu..." + + +``` + + +```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 index 1de94c36b9..adf0b29ac1 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md @@ -1,41 +1,41 @@ ---- -sidebar_position: 5 ---- - -# Скачать файл - Скачивает файл с серверов Telegram - - -*Функция СкачатьФайл(Знач Токен, Знач IDФайла) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDФайла | --fileid | Строка | ID файла для скачивания | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - IDФайла = "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE"; - Токен = "6129457865:AAFyzNYOAFbu..."; - - Результат = OPI_Telegram.СкачатьФайл(Токен, IDФайла); - - -``` - -```sh title="Пример команды CLI" - - oint telegram СкачатьФайл --token "6129457865:AAFyzNYOAFbu..." --fileid "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE" - - -``` - - -```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… - -``` +--- +sidebar_position: 5 +--- + +# Скачать файл + Скачивает файл с серверов Telegram + + +*Функция СкачатьФайл(Знач Токен, Знач IDФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла для скачивания | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + IDФайла = "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE"; + Токен = "6129457865:AAFyzNYOAFbu..."; + + Результат = OPI_Telegram.СкачатьФайл(Токен, IDФайла); + + +``` + +```sh title="Пример команды CLI" + + oint telegram СкачатьФайл --token "6129457865:AAFyzNYOAFbu..." --fileid "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE" + + +``` + + +```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 index ea0bf1ceca..5cdb54661a 100644 --- 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 @@ -1,50 +1,50 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о боте -Выполняет запрос getMe, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д. - - -*Функция ПолучитьИнформациюБота(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.ПолучитьИнформациюБота(Токен); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ПолучитьИнформациюБота --token "6129457865:AAFyzNYOAFbu..." - - -``` - - -```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 - } -} - -``` +--- +sidebar_position: 1 +--- + +# Получить информацию о боте +Выполняет запрос getMe, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д. + + +*Функция ПолучитьИнформациюБота(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.ПолучитьИнформациюБота(Токен); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ПолучитьИнформациюБота --token "6129457865:AAFyzNYOAFbu..." + + +``` + + +```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 + } +} + +``` 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 index 19b89eded1..3cd161ad35 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md @@ -1,366 +1,366 @@ ---- -sidebar_position: 2 ---- - -# Получить обновления -Выполняет запрос getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме - - -*Функция ПолучитьОбновления(Знач Токен, Знач Таймаут = 0, Знач Смещение = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | Таймаут | --timeout | Строка,Число | Время ожидания новых событий | - | Смещение | --offset | Строка,Число | Смещение в списке получаемых сообщений | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Результат = OPI_Telegram.ПолучитьОбновления(Токен); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ПолучитьОбновления --token "6129457865:AAFyzNYOAFbu..." --timeout %timeout% --offset %offset% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": [ - { - "update_id": 291366000, - "channel_post": { - "message_id": 4685, - "sender_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "date": 1717054881, - "pinned_message": { - "message_id": 4670, - "sender_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "date": 1717054721, - "text": "Строковое значение" - } - } - }, - { - "update_id": 291366001, - "message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - } - }, - { - "update_id": 291366002, - "message": { - "message_id": 2448, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054907, - "message_thread_id": 2446, - "reply_to_message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", - "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": 291366003, - "message": { - "message_id": 2449, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054912, - "forum_topic_reopened": {} - } - }, - { - "update_id": 291366004, - "message": { - "message_id": 2450, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054912, - "forum_topic_closed": {} - } - }, - { - "update_id": 291366005, - "message": { - "message_id": 2451, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054912, - "message_thread_id": 2446, - "reply_to_message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - }, - "forum_topic_closed": {}, - "is_topic_message": true - } - }, - { - "update_id": 291366006, - "message": { - "message_id": 2452, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054937, - "forum_topic_reopened": {} - } - }, - { - "update_id": 291366007, - "message": { - "message_id": 2453, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054937, - "message_thread_id": 2446, - "reply_to_message": { - "message_id": 2446, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054906, - "message_thread_id": 2446, - "forum_topic_created": { - "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - }, - "is_topic_message": true - }, - "forum_topic_reopened": {}, - "is_topic_message": true - } - }, - { - "update_id": 291366008, - "message": { - "message_id": 2454, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717054995, - "forum_topic_edited": { - "name": "Новое имя главной темы b7ff8b12-563b-417f-8218-a460d59d7f7f" - } - } - }, - { - "update_id": 291366009, - "message": { - "message_id": 2455, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717055002, - "general_forum_topic_hidden": {} - } - }, - { - "update_id": 291366010, - "message": { - "message_id": 2456, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": -1001971186208, - "title": "Тест", - "is_forum": true, - "type": "supergroup" - }, - "date": 1717055007, - "general_forum_topic_unhidden": {} - } - } - ] -} - -``` +--- +sidebar_position: 2 +--- + +# Получить обновления +Выполняет запрос getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме + + +*Функция ПолучитьОбновления(Знач Токен, Знач Таймаут = 0, Знач Смещение = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Таймаут | --timeout | Строка,Число | Время ожидания новых событий | + | Смещение | --offset | Строка,Число | Смещение в списке получаемых сообщений | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Результат = OPI_Telegram.ПолучитьОбновления(Токен); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ПолучитьОбновления --token "6129457865:AAFyzNYOAFbu..." --timeout %timeout% --offset %offset% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": [ + { + "update_id": 291366000, + "channel_post": { + "message_id": 4685, + "sender_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "date": 1717054881, + "pinned_message": { + "message_id": 4670, + "sender_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "date": 1717054721, + "text": "Строковое значение" + } + } + }, + { + "update_id": 291366001, + "message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + } + }, + { + "update_id": 291366002, + "message": { + "message_id": 2448, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054907, + "message_thread_id": 2446, + "reply_to_message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", + "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": 291366003, + "message": { + "message_id": 2449, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054912, + "forum_topic_reopened": {} + } + }, + { + "update_id": 291366004, + "message": { + "message_id": 2450, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054912, + "forum_topic_closed": {} + } + }, + { + "update_id": 291366005, + "message": { + "message_id": 2451, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054912, + "message_thread_id": 2446, + "reply_to_message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + }, + "forum_topic_closed": {}, + "is_topic_message": true + } + }, + { + "update_id": 291366006, + "message": { + "message_id": 2452, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054937, + "forum_topic_reopened": {} + } + }, + { + "update_id": 291366007, + "message": { + "message_id": 2453, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054937, + "message_thread_id": 2446, + "reply_to_message": { + "message_id": 2446, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054906, + "message_thread_id": 2446, + "forum_topic_created": { + "name": "Тестовая тема fb0492fb-3a2d-4496-8309-b119226ef9f9", + "icon_color": 7322096, + "icon_custom_emoji_id": "5357419403325481346" + }, + "is_topic_message": true + }, + "forum_topic_reopened": {}, + "is_topic_message": true + } + }, + { + "update_id": 291366008, + "message": { + "message_id": 2454, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717054995, + "forum_topic_edited": { + "name": "Новое имя главной темы b7ff8b12-563b-417f-8218-a460d59d7f7f" + } + } + }, + { + "update_id": 291366009, + "message": { + "message_id": 2455, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717055002, + "general_forum_topic_hidden": {} + } + }, + { + "update_id": 291366010, + "message": { + "message_id": 2456, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": -1001971186208, + "title": "Тест", + "is_forum": true, + "type": "supergroup" + }, + "date": 1717055007, + "general_forum_topic_unhidden": {} + } + } + ] +} + +``` 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 index 18a2df14d8..5ea58d8a1b 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 3 ---- - -# Установить Webhook - Устанавливает URL обработчика событий бота для работы в режиме Webhook - - -*Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | URL | --url | Строка | Адрес обработки запросов от Telegram (с https:) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - URL = "https://api.athenaeum.digital/opi/hs/twitter"; - - Результат = OPI_Telegram.УстановитьWebhook(Токен, URL); - - -``` - -```sh title="Пример команды CLI" - - oint telegram УстановитьWebhook --token "6129457865:AAFyzNYOAFbu..." --url "https://api.athenaeum.digital/opi/hs/twitter" - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true, - "description": "Webhook was set" -} - -``` +--- +sidebar_position: 3 +--- + +# Установить Webhook + Устанавливает URL обработчика событий бота для работы в режиме Webhook + + +*Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | URL | --url | Строка | Адрес обработки запросов от Telegram (с https:) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + URL = "https://api.athenaeum.digital/opi/hs/twitter"; + + Результат = OPI_Telegram.УстановитьWebhook(Токен, URL); + + +``` + +```sh title="Пример команды CLI" + + oint telegram УстановитьWebhook --token "6129457865:AAFyzNYOAFbu..." --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 index 1a46f673af..e36bdb19fd 100644 --- 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 @@ -1,68 +1,68 @@ ---- -sidebar_position: 12 ---- - -# Сформировать клавиатуру по массиву кнопок - Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели - - -*Функция СформироватьКлавиатуруПоМассивуКнопок(Знач МассивКнопок, Знач ПодСообщением = Ложь, Знач ОднаПодОдной = Истина) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | - | ПодСообщением | --under | Булево | Клавиатура под сообщением или на нижней панели | - | ОднаПодОдной | --column | Булево | Истина > кнопки выводятся в столбик, Ложь > в строку | - - - Возвращаемое значение: Строка - JSON клавиатуры - -```bsl title="Пример кода" - - - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Отлично"); - МассивКнопок.Добавить("Нормально"); - МассивКнопок.Добавить("Плохо"); - - Клавиатура = OPI_Telegram.СформироватьКлавиатуруПоМассивуКнопок(МассивКнопок, Истина, Истина); - - - -``` - -```sh title="Пример команды CLI" - - oint telegram СформироватьКлавиатуруПоМассивуКнопок --buttons %buttons% --under %under% --column %column% - - -``` - - -```json title="Результат" - -{ - "inline_keyboard":[ - [ - { - "text":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E", - "callback_data":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E" - } - ], - [ - { - "text":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E", - "callback_data":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E" - } - ], - [ - { - "text":"\u041F\u043B\u043E\u0445\u043E", - "callback_data":"\u041F\u043B\u043E\u0445\u043E" - } - ] - ], - "rows":1 - } - -``` +--- +sidebar_position: 12 +--- + +# Сформировать клавиатуру по массиву кнопок + Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели + + +*Функция СформироватьКлавиатуруПоМассивуКнопок(Знач МассивКнопок, Знач ПодСообщением = Ложь, Знач ОднаПодОдной = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | + | ПодСообщением | --under | Булево | Клавиатура под сообщением или на нижней панели | + | ОднаПодОдной | --column | Булево | Истина > кнопки выводятся в столбик, Ложь > в строку | + + + Возвращаемое значение: Строка - JSON клавиатуры + +```bsl title="Пример кода" + + + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Отлично"); + МассивКнопок.Добавить("Нормально"); + МассивКнопок.Добавить("Плохо"); + + Клавиатура = OPI_Telegram.СформироватьКлавиатуруПоМассивуКнопок(МассивКнопок, Истина, Истина); + + + +``` + +```sh title="Пример команды CLI" + + oint telegram СформироватьКлавиатуруПоМассивуКнопок --buttons %buttons% --under %under% --column %column% + + +``` + + +```json title="Результат" + +{ + "inline_keyboard":[ + [ + { + "text":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E", + "callback_data":"\u041E\u0442\u043B\u0438\u0447\u043D\u043E" + } + ], + [ + { + "text":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E", + "callback_data":"\u041D\u043E\u0440\u043C\u0430\u043B\u044C\u043D\u043E" + } + ], + [ + { + "text":"\u041F\u043B\u043E\u0445\u043E", + "callback_data":"\u041F\u043B\u043E\u0445\u043E" + } + ] + ], + "rows":1 + } + +``` diff --git a/docs/ru/md/Telegram/Data-sending/Forward-message.md b/docs/ru/md/Telegram/Data-sending/Forward-message.md index da084133c9..cab98b123c 100644 --- a/docs/ru/md/Telegram/Data-sending/Forward-message.md +++ b/docs/ru/md/Telegram/Data-sending/Forward-message.md @@ -1,84 +1,84 @@ ---- -sidebar_position: 11 ---- - -# Переслать сообщение - Пересылает сообщение между чатами или в рамках одного чата - - -*Функция ПереслатьСообщение(Знач Токен, Знач IDОригинала, Знач ОткудаID, Знач КудаID) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDОригинала | --message | Строка,Число | ID оригинального сообщения | - | ОткудаID | --from | Строка,Число | ID чата оригинального сообщения | - | КудаID | --to | Строка,Число | ID целевого чата или IDЧата*IDТемы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - IDСообщения = "4951"; - - Результат = OPI_Telegram.ПереслатьСообщение(Токен, IDСообщения, IDКанала, IDЧата); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ПереслатьСообщение --token "6129457865:AAFyzNYOAFbu..." --message %message% --from %from% --to %to% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4649, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072482, - "forward_origin": { - "type": "channel", - "chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "message_id": 4686, - "date": 1717072354 - }, - "forward_from_chat": { - "id": -1001893407333, - "title": "Тестовый канал", - "username": "testsichee", - "type": "channel" - }, - "forward_from_message_id": 4686, - "forward_date": 1717072354, - "text": "Строковое значение" - } -} - -``` +--- +sidebar_position: 11 +--- + +# Переслать сообщение + Пересылает сообщение между чатами или в рамках одного чата + + +*Функция ПереслатьСообщение(Знач Токен, Знач IDОригинала, Знач ОткудаID, Знач КудаID) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDОригинала | --message | Строка,Число | ID оригинального сообщения | + | ОткудаID | --from | Строка,Число | ID чата оригинального сообщения | + | КудаID | --to | Строка,Число | ID целевого чата или IDЧата*IDТемы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + IDСообщения = "4951"; + + Результат = OPI_Telegram.ПереслатьСообщение(Токен, IDСообщения, IDКанала, IDЧата); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ПереслатьСообщение --token "6129457865:AAFyzNYOAFbu..." --message %message% --from %from% --to %to% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4649, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072482, + "forward_origin": { + "type": "channel", + "chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "message_id": 4686, + "date": 1717072354 + }, + "forward_from_chat": { + "id": -1001893407333, + "title": "Тестовый канал", + "username": "testsichee", + "type": "channel" + }, + "forward_from_message_id": 4686, + "forward_date": 1717072354, + "text": "Строковое значение" + } +} + +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-audio.md b/docs/ru/md/Telegram/Data-sending/Send-audio.md index ebac582118..3b5158ebcc 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-audio.md +++ b/docs/ru/md/Telegram/Data-sending/Send-audio.md @@ -1,85 +1,85 @@ ---- -sidebar_position: 4 ---- - -# Отправить аудио - Отправляет аудиофайл в чат или канал - - -*Функция ОтправитьАудио(Знач Токен, Знач IDЧата, Знач Текст, Знач Аудио, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Аудио | --audio | ДвоичныеДанные,Строка | Файл аудио | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Аудио = "https://openintegrations.dev/test_data/song.mp3"; - - АудиоПуть = ПолучитьИмяВременногоФайла("mp3"); - КопироватьФайл(Аудио, АудиоПуть); - - АудиоДД = Новый ДвоичныеДанные(АудиоПуть); - - Результат = OPI_Telegram.ОтправитьАудио(Токен, IDЧата, Текст, Аудио); - Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоПуть); - Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоДД); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьАудио --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --audio "https://openintegrations.dev/test_data/song.mp3" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4641, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072399, - "audio": { - "duration": 228, - "file_name": "audio", - "mime_type": "audio/mpeg", - "title": "Dogs", - "performer": "Motorhead", - "file_id": "CQACAgIAAxkDAAISIWZYcg_Kxij0GylJNbAlQXeFsOL_AAKsUAACYCjISuJ28LqFPDf3NQQ", - "file_unique_id": "AgADrFAAAmAoyEo", - "file_size": 9229352 - }, - "caption": "Строковое значение" - } -} - -``` +--- +sidebar_position: 4 +--- + +# Отправить аудио + Отправляет аудиофайл в чат или канал + + +*Функция ОтправитьАудио(Знач Токен, Знач IDЧата, Знач Текст, Знач Аудио, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Аудио | --audio | ДвоичныеДанные,Строка | Файл аудио | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Аудио = "https://openintegrations.dev/test_data/song.mp3"; + + АудиоПуть = ПолучитьИмяВременногоФайла("mp3"); + КопироватьФайл(Аудио, АудиоПуть); + + АудиоДД = Новый ДвоичныеДанные(АудиоПуть); + + Результат = OPI_Telegram.ОтправитьАудио(Токен, IDЧата, Текст, Аудио); + Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоПуть); + Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоДД); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьАудио --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --audio "https://openintegrations.dev/test_data/song.mp3" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4641, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072399, + "audio": { + "duration": 228, + "file_name": "audio", + "mime_type": "audio/mpeg", + "title": "Dogs", + "performer": "Motorhead", + "file_id": "CQACAgIAAxkDAAISIWZYcg_Kxij0GylJNbAlQXeFsOL_AAKsUAACYCjISuJ28LqFPDf3NQQ", + "file_unique_id": "AgADrFAAAmAoyEo", + "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 index 6c1194ed87..1085365da3 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-contact.md +++ b/docs/ru/md/Telegram/Data-sending/Send-contact.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 9 ---- - -# Отправить контакт - Отправляет контакт с именем и номером телефона - - -*Функция ОтправитьКонтакт(Знач Токен, Знач IDЧата, Знач Имя, Знач Фамилия, Знач Телефон, Знач Клавиатура = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Имя | --name | Строка | Имя контакта | - | Фамилия | --surname | Строка | Фамилия контакта | - | Телефон | --phone | Строка | Телефон контакта | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Имя = "Петр"; - Фамилия = "Петров"; - Телефон = "88005553535"; - - Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDЧата , Имя, Фамилия, Телефон); - Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDКанала, Имя, Фамилия, Телефон); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьКонтакт --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --name "Петр" --surname "Петров" --phone "88005553535" --keyboard %keyboard% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4647, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072448, - "contact": { - "phone_number": "88005553535", - "first_name": "Петр", - "last_name": "Петров" - } - } -} - -``` +--- +sidebar_position: 9 +--- + +# Отправить контакт + Отправляет контакт с именем и номером телефона + + +*Функция ОтправитьКонтакт(Знач Токен, Знач IDЧата, Знач Имя, Знач Фамилия, Знач Телефон, Знач Клавиатура = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Имя | --name | Строка | Имя контакта | + | Фамилия | --surname | Строка | Фамилия контакта | + | Телефон | --phone | Строка | Телефон контакта | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Имя = "Петр"; + Фамилия = "Петров"; + Телефон = "88005553535"; + + Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDЧата , Имя, Фамилия, Телефон); + Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDКанала, Имя, Фамилия, Телефон); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьКонтакт --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --name "Петр" --surname "Петров" --phone "88005553535" --keyboard %keyboard% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4647, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072448, + "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 index 5e4157346e..710e5f509c 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-document.md +++ b/docs/ru/md/Telegram/Data-sending/Send-document.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 5 ---- - -# Отправить документ - Отправляет документ в чат или канал - - -*Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Документ | --doc | ДвоичныеДанные,Строка | Файл документа | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Документ = "https://openintegrations.dev/test_data/document.docx"; - - ДокументПуть = ПолучитьИмяВременногоФайла("docx"); - КопироватьФайл(Документ, ДокументПуть); - - ДокументДД = Новый ДвоичныеДанные(ДокументПуть); - - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ); - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументПуть); - Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументДД); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьДокумент --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --doc "https://openintegrations.dev/test_data/document.docx" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4642, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072414, - "document": { - "file_name": "document.docx", - "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", - "file_id": "BQACAgIAAxkDAAISImZYch5MDU2ibeJ0S46yZfw6Dmb2AAKtUAACYCjISp3o6gzXeDCVNQQ", - "file_unique_id": "AgADrVAAAmAoyEo", - "file_size": 24069 - }, - "caption": "Строковое значение" - } -} - -``` +--- +sidebar_position: 5 +--- + +# Отправить документ + Отправляет документ в чат или канал + + +*Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Документ | --doc | ДвоичныеДанные,Строка | Файл документа | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Документ = "https://openintegrations.dev/test_data/document.docx"; + + ДокументПуть = ПолучитьИмяВременногоФайла("docx"); + КопироватьФайл(Документ, ДокументПуть); + + ДокументДД = Новый ДвоичныеДанные(ДокументПуть); + + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ); + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументПуть); + Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументДД); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьДокумент --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --doc "https://openintegrations.dev/test_data/document.docx" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4642, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072414, + "document": { + "file_name": "document.docx", + "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "file_id": "BQACAgIAAxkDAAISImZYch5MDU2ibeJ0S46yZfw6Dmb2AAKtUAACYCjISp3o6gzXeDCVNQQ", + "file_unique_id": "AgADrVAAAmAoyEo", + "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 index 30b9d8633c..63c4f64294 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-gif.md +++ b/docs/ru/md/Telegram/Data-sending/Send-gif.md @@ -1,120 +1,120 @@ ---- -sidebar_position: 6 ---- - -# Отправить гифку - Отправляет гифку в чат или канал - - -*Функция ОтправитьГифку(Знач Токен, Знач IDЧата, Знач Текст, Знач Гифка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Гифка | --gif | ДвоичныеДанные,Строка | Файл гифки | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Гифка = "https://openintegrations.dev/test_data/animation.gif"; - - ГифкаПуть = ПолучитьИмяВременногоФайла("gif"); - КопироватьФайл(Гифка, ГифкаПуть); - - ГифкаДД = Новый ДвоичныеДанные(ГифкаПуть); - - Результат = OPI_Telegram.ОтправитьГифку(Токен, IDЧата, Текст, Гифка); - Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаПуть); - Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаДД); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьГифку --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --gif "https://openintegrations.dev/test_data/animation.gif" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4643, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072423, - "animation": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "duration": 3, - "width": 220, - "height": 220, - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", - "file_unique_id": "AgADrlAAAmAoyEo", - "file_size": 84940 - }, - "document": { - "file_name": "animation.gif.mp4", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", - "file_unique_id": "AQADrlAAAmAoyEpy", - "file_size": 11352, - "width": 220, - "height": 220 - }, - "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", - "file_unique_id": "AgADrlAAAmAoyEo", - "file_size": 84940 - }, - "caption": "Строковое значение" - } -} - -``` +--- +sidebar_position: 6 +--- + +# Отправить гифку + Отправляет гифку в чат или канал + + +*Функция ОтправитьГифку(Знач Токен, Знач IDЧата, Знач Текст, Знач Гифка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Гифка | --gif | ДвоичныеДанные,Строка | Файл гифки | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Гифка = "https://openintegrations.dev/test_data/animation.gif"; + + ГифкаПуть = ПолучитьИмяВременногоФайла("gif"); + КопироватьФайл(Гифка, ГифкаПуть); + + ГифкаДД = Новый ДвоичныеДанные(ГифкаПуть); + + Результат = OPI_Telegram.ОтправитьГифку(Токен, IDЧата, Текст, Гифка); + Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаПуть); + Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаДД); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьГифку --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --gif "https://openintegrations.dev/test_data/animation.gif" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4643, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072423, + "animation": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "duration": 3, + "width": 220, + "height": 220, + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", + "file_unique_id": "AgADrlAAAmAoyEo", + "file_size": 84940 + }, + "document": { + "file_name": "animation.gif.mp4", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIjZlhyJr32tGqAiRbJXXmTK6ATld0AAq5QAAJgKMhKlmRvtTyqyUgBAAdtAAM1BA", + "file_unique_id": "AQADrlAAAmAoyEpy", + "file_size": 11352, + "width": 220, + "height": 220 + }, + "file_id": "CgACAgIAAxkDAAISI2ZYcia99rRqgIkWyV15kyugE5XdAAKuUAACYCjISpZkb7U8qslINQQ", + "file_unique_id": "AgADrlAAAmAoyEo", + "file_size": 84940 + }, + "caption": "Строковое значение" + } +} + +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-image.md b/docs/ru/md/Telegram/Data-sending/Send-image.md index ed4e2e13ca..3553ee46ef 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-image.md +++ b/docs/ru/md/Telegram/Data-sending/Send-image.md @@ -1,112 +1,112 @@ ---- -sidebar_position: 2 ---- - -# Отправить картинку - Отправляет картинку в чат или канал - - -*Функция ОтправитьКартинку(Знач Токен, Знач IDЧата, Знач Текст, Знач Картинка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; - - КартинкаПуть = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, КартинкаПуть); - - КартинкаДД = Новый ДвоичныеДанные(КартинкаПуть); - - Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка); - Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаПуть); - Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаДД); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьКартинку --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --picture "https://openintegrations.dev/test_data/picture.jpg" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4639, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072364, - "photo": [ - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", - "file_unique_id": "AQADmtkxG77-sUpy", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", - "file_unique_id": "AQADmtkxG77-sUp9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", - "file_unique_id": "AQADmtkxG77-sUp-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "Строковое значение" - } -} - -``` +--- +sidebar_position: 2 +--- + +# Отправить картинку + Отправляет картинку в чат или канал + + +*Функция ОтправитьКартинку(Знач Токен, Знач IDЧата, Знач Текст, Знач Картинка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; + + КартинкаПуть = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, КартинкаПуть); + + КартинкаДД = Новый ДвоичныеДанные(КартинкаПуть); + + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка); + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаПуть); + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаДД); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьКартинку --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --picture "https://openintegrations.dev/test_data/picture.jpg" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4639, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072364, + "photo": [ + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", + "file_unique_id": "AQADmtkxG77-sUpy", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", + "file_unique_id": "AQADmtkxG77-sUp9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", + "file_unique_id": "AQADmtkxG77-sUp-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAISH2ZYcewv1LaJnVI1E6pdq0EyR0QJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp8", + "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 index 699b91f362..60eea14ed9 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-location.md +++ b/docs/ru/md/Telegram/Data-sending/Send-location.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 8 ---- - -# Отправить местоположение - Отправляет местоположение по географической широте и долготе в чат или канал - - -*Функция ОтправитьМестоположение(Знач Токен, Знач IDЧата, Знач Широта, Знач Долгота, Знач Клавиатура = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Широта | --lat | Строка,Число | Географическая широта | - | Долгота | --long | Строка,Число | Географическая долгота | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Ширина = "48.87373649724122"; - Долгота = "48.87373649724122"; - - Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDЧата, Ширина, Долгота); - Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDКанала, Ширина, Долгота); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьМестоположение --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --lat %lat% --long "48.87373649724122" --keyboard %keyboard% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4646, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072442, - "location": { - "latitude": 48.873739, - "longitude": 48.873733 - } - } -} - -``` +--- +sidebar_position: 8 +--- + +# Отправить местоположение + Отправляет местоположение по географической широте и долготе в чат или канал + + +*Функция ОтправитьМестоположение(Знач Токен, Знач IDЧата, Знач Широта, Знач Долгота, Знач Клавиатура = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Широта | --lat | Строка,Число | Географическая широта | + | Долгота | --long | Строка,Число | Географическая долгота | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Ширина = "48.87373649724122"; + Долгота = "48.87373649724122"; + + Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDЧата, Ширина, Долгота); + Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDКанала, Ширина, Долгота); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьМестоположение --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --lat %lat% --long "48.87373649724122" --keyboard %keyboard% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4646, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072442, + "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 index 2393a2a43f..3b4014181a 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-media-group.md +++ b/docs/ru/md/Telegram/Data-sending/Send-media-group.md @@ -1,153 +1,153 @@ ---- -sidebar_position: 7 ---- - -# Отправить группу медиафайлов - Отправляет набор файлов в чат или канал. Варианты типов медиа: audio, document, photo, video - - -*Функция ОтправитьМедиагруппу(Знач Токен, Знач IDЧата, Знач Текст, Знач СоответствиеФайлов, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | СоответствиеФайлов | --media | Соответствие из Строка | JSON файлов или путь к .json | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - - Токен = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ"; - Описание = "Группа картинок"; - СоответствиеФайлов = Новый Соответствие; - СоответствиеФайлов.Вставить("C:\OPI\alpaca.png" , "photo"); - СоответствиеФайлов.Вставить("C:\OPI\alpaca_text.png", "photo"); - - Ответ = OPI_Telegram.ОтправитьМедиагруппу(Токен, 1234567890, Описание, СоответствиеФайлов); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ_); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьМедиагруппу --token "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ" --chat %chat% --text %text% --media %media% --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": [ - { - "message_id": 4644, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072435, - "media_group_id": "13736579485142714", - "photo": [ - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp4", - "file_size": 1568, - "width": 90, - "height": 67 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", - "file_unique_id": "AQADmtkxG77-sUpy", - "file_size": 21633, - "width": 320, - "height": 240 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", - "file_unique_id": "AQADmtkxG77-sUp9", - "file_size": 99260, - "width": 800, - "height": 600 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", - "file_unique_id": "AQADmtkxG77-sUp-", - "file_size": 218651, - "width": 1280, - "height": 960 - }, - { - "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", - "file_unique_id": "AQADmtkxG77-sUp8", - "file_size": 650214, - "width": 2560, - "height": 1920 - } - ], - "caption": "Строковое значение" - }, - { - "message_id": 4645, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072435, - "media_group_id": "13736579485142714", - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video1", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", - "file_unique_id": "AQADr1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", - "file_unique_id": "AQADr1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxkDAAISJWZYcjPG5UBlLcgCf53SUY366x0_AAKvUAACYCjISu2YyUUvFzLSNQQ", - "file_unique_id": "AgADr1AAAmAoyEo", - "file_size": 1137878 - } - } - ] -} - -``` +--- +sidebar_position: 7 +--- + +# Отправить группу медиафайлов + Отправляет набор файлов в чат или канал. Варианты типов медиа: audio, document, photo, video + + +*Функция ОтправитьМедиагруппу(Знач Токен, Знач IDЧата, Знач Текст, Знач СоответствиеФайлов, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | СоответствиеФайлов | --media | Соответствие из Строка | JSON файлов или путь к .json | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + + Токен = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ"; + Описание = "Группа картинок"; + СоответствиеФайлов = Новый Соответствие; + СоответствиеФайлов.Вставить("C:\OPI\alpaca.png" , "photo"); + СоответствиеФайлов.Вставить("C:\OPI\alpaca_text.png", "photo"); + + Ответ = OPI_Telegram.ОтправитьМедиагруппу(Токен, 1234567890, Описание, СоответствиеФайлов); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ_); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьМедиагруппу --token "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ" --chat %chat% --text %text% --media %media% --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": [ + { + "message_id": 4644, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072435, + "media_group_id": "13736579485142714", + "photo": [ + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADcwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp4", + "file_size": 1568, + "width": 90, + "height": 67 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADbQADNQQ", + "file_unique_id": "AQADmtkxG77-sUpy", + "file_size": 21633, + "width": 320, + "height": 240 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeAADNQQ", + "file_unique_id": "AQADmtkxG77-sUp9", + "file_size": 99260, + "width": 800, + "height": 600 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADeQADNQQ", + "file_unique_id": "AQADmtkxG77-sUp-", + "file_size": 218651, + "width": 1280, + "height": 960 + }, + { + "file_id": "AgACAgIAAxkDAAISJGZYcjMH_sZQUquUAgQ99ai1gbJJAAKa2TEbvv6xSgxyd39G8AuyAQADAgADdwADNQQ", + "file_unique_id": "AQADmtkxG77-sUp8", + "file_size": 650214, + "width": 2560, + "height": 1920 + } + ], + "caption": "Строковое значение" + }, + { + "message_id": 4645, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072435, + "media_group_id": "13736579485142714", + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video1", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", + "file_unique_id": "AQADr1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIlZlhyM8blQGUtyAJ_ndJRjfrrHT8AAq9QAAJgKMhK7ZjJRS8XMtIBAAdtAAM1BA", + "file_unique_id": "AQADr1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxkDAAISJWZYcjPG5UBlLcgCf53SUY366x0_AAKvUAACYCjISu2YyUUvFzLSNQQ", + "file_unique_id": "AgADr1AAAmAoyEo", + "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 index 03af56420b..eefc978b35 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-poll.md +++ b/docs/ru/md/Telegram/Data-sending/Send-poll.md @@ -1,99 +1,99 @@ ---- -sidebar_position: 10 ---- - -# Отправить опрос - Отправляет опрос с вариантами ответа - - -*Функция ОтправитьОпрос(Знач Токен, Знач IDЧата, Знач Вопрос, Знач МассивОтветов, Знач Анонимный = Истина) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Вопрос | --question | Строка | Вопрос опроса | - | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | - | Анонимный | --anonymous | Булево | Анонимность опроса | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Вопрос = "Какой ваш любимый цвет?"; - - МассивОтветов = Новый Массив; - МассивОтветов.Добавить("Красный"); - МассивОтветов.Добавить("Желтый"); - МассивОтветов.Добавить("Зеленый"); - МассивОтветов.Добавить("Синий"); - - Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDЧата , Вопрос, МассивОтветов, Ложь); - Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDКанала, Вопрос, МассивОтветов, Истина); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьОпрос --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --question %question% --options %options% --anonymous %anonymous% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4648, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072475, - "poll": { - "id": "5388601346930772585", - "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 - } - } -} - -``` +--- +sidebar_position: 10 +--- + +# Отправить опрос + Отправляет опрос с вариантами ответа + + +*Функция ОтправитьОпрос(Знач Токен, Знач IDЧата, Знач Вопрос, Знач МассивОтветов, Знач Анонимный = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Вопрос | --question | Строка | Вопрос опроса | + | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | + | Анонимный | --anonymous | Булево | Анонимность опроса | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Вопрос = "Какой ваш любимый цвет?"; + + МассивОтветов = Новый Массив; + МассивОтветов.Добавить("Красный"); + МассивОтветов.Добавить("Желтый"); + МассивОтветов.Добавить("Зеленый"); + МассивОтветов.Добавить("Синий"); + + Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDЧата , Вопрос, МассивОтветов, Ложь); + Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDКанала, Вопрос, МассивОтветов, Истина); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьОпрос --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --question %question% --options %options% --anonymous %anonymous% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4648, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072475, + "poll": { + "id": "5388601346930772585", + "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 index 54ee84e7f6..6148891805 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-text-message.md +++ b/docs/ru/md/Telegram/Data-sending/Send-text-message.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 1 ---- - -# Отправить текстовое сообщение - Отправляет текстовое сообщение в чат или канал - - -*Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - - Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); - Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDКанала, Текст); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьТекстовоеСообщение --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4638, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072354, - "text": "Строковое значение" - } -} - -``` +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат или канал + + +*Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + + Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); + Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDКанала, Текст); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьТекстовоеСообщение --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4638, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072354, + "text": "Строковое значение" + } +} + +``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-video.md b/docs/ru/md/Telegram/Data-sending/Send-video.md index baa57abc6b..15d775ed2f 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-video.md +++ b/docs/ru/md/Telegram/Data-sending/Send-video.md @@ -1,99 +1,99 @@ ---- -sidebar_position: 3 ---- - -# Отправить видео - Отправляет видео в чат или канал - - -*Функция ОтправитьВидео(Знач Токен, Знач IDЧата, Знач Текст, Знач Видео, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | - | Текст | --text | Строка | Текст сообщения | - | Видео | --video | ДвоичныеДанные,Строка | Файл видео | - | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | - | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - IDЧата = "461699897"; - IDКанала = "@testsichee"; - Текст = "Строковое значение"; - Видео = "https://openintegrations.dev/test_data/video.mp4"; - - ВидеоПуть = ПолучитьИмяВременногоФайла("mp4"); - КопироватьФайл(Видео, ВидеоПуть); - - ВидеоДД = Новый ДвоичныеДанные(ВидеоПуть); - - Результат = OPI_Telegram.ОтправитьВидео(Токен, IDЧата, Текст, Видео); - Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоПуть); - Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоДД); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОтправитьВидео --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --video "https://openintegrations.dev/test_data/video.mp4" --keyboard %keyboard% --parsemode %parsemode% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_id": 4640, - "from": { - "id": 6129457865, - "is_bot": true, - "first_name": "Бот Виталий", - "username": "sicheebot" - }, - "chat": { - "id": 461699897, - "first_name": "Anton", - "last_name": "Titowets", - "username": "JKIee", - "type": "private" - }, - "date": 1717072376, - "video": { - "duration": 5, - "width": 640, - "height": 480, - "file_name": "video", - "mime_type": "video/mp4", - "thumbnail": { - "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", - "file_unique_id": "AQADq1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "thumb": { - "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", - "file_unique_id": "AQADq1AAAmAoyEpy", - "file_size": 20106, - "width": 320, - "height": 240 - }, - "file_id": "BAACAgIAAxkDAAISIGZYcfd2b2c_lBihqowoDy15WD0oAAKrUAACYCjISh7uoJd1agn6NQQ", - "file_unique_id": "AgADq1AAAmAoyEo", - "file_size": 1137878 - }, - "caption": "Строковое значение" - } -} - -``` +--- +sidebar_position: 3 +--- + +# Отправить видео + Отправляет видео в чат или канал + + +*Функция ОтправитьВидео(Знач Токен, Знач IDЧата, Знач Текст, Знач Видео, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chat | Строка,Число | ID целевого чата или IDЧата*IDТемы | + | Текст | --text | Строка | Текст сообщения | + | Видео | --video | ДвоичныеДанные,Строка | Файл видео | + | Клавиатура | --keyboard | Строка | JSON клавиатуры или путь к .json | + | Разметка | --parsemode | Строка | Вид обработки текста (HTML, Markdown, MarkdownV2) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + IDКанала = "@testsichee"; + Текст = "Строковое значение"; + Видео = "https://openintegrations.dev/test_data/video.mp4"; + + ВидеоПуть = ПолучитьИмяВременногоФайла("mp4"); + КопироватьФайл(Видео, ВидеоПуть); + + ВидеоДД = Новый ДвоичныеДанные(ВидеоПуть); + + Результат = OPI_Telegram.ОтправитьВидео(Токен, IDЧата, Текст, Видео); + Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоПуть); + Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоДД); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОтправитьВидео --token "6129457865:AAFyzNYOAFbu..." --chat "461699897" --text "Строковое значение" --video "https://openintegrations.dev/test_data/video.mp4" --keyboard %keyboard% --parsemode %parsemode% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_id": 4640, + "from": { + "id": 6129457865, + "is_bot": true, + "first_name": "Бот Виталий", + "username": "sicheebot" + }, + "chat": { + "id": 461699897, + "first_name": "Anton", + "last_name": "Titowets", + "username": "JKIee", + "type": "private" + }, + "date": 1717072376, + "video": { + "duration": 5, + "width": 640, + "height": 480, + "file_name": "video", + "mime_type": "video/mp4", + "thumbnail": { + "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", + "file_unique_id": "AQADq1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "thumb": { + "file_id": "AAMCAgADGQMAAhIgZlhx93ZvZz-UGKGqjCgPLXlYPSgAAqtQAAJgKMhKHu6gl3VqCfoBAAdtAAM1BA", + "file_unique_id": "AQADq1AAAmAoyEpy", + "file_size": 20106, + "width": 320, + "height": 240 + }, + "file_id": "BAACAgIAAxkDAAISIGZYcfd2b2c_lBihqowoDy15WD0oAAKrUAACYCjISh7uoJd1agn6NQQ", + "file_unique_id": "AgADq1AAAmAoyEo", + "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 index 0a0c40285f..6b0a6da3cf 100644 --- 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 @@ -1,47 +1,47 @@ ---- -sidebar_position: 10 ---- - -# Очистить список закрепленных сообщений темы - Очищает список закрепленных сообщений в теме форума - - -*Функция ОчиститьСписокЗакрепленныхСообщенийТемы(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - | IDТемы | --topic | Строка,Число | ID темы. Главная, если не заполнено | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "2673"; - - Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат); - Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат, Тема); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 10 +--- + +# Очистить список закрепленных сообщений темы + Очищает список закрепленных сообщений в теме форума + + +*Функция ОчиститьСписокЗакрепленныхСообщенийТемы(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + | IDТемы | --topic | Строка,Число | ID темы. Главная, если не заполнено | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "2673"; + + Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат); + Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат, Тема); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% + + +``` + + +```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 index c3856a3a65..342adc7719 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 4 ---- - -# Закрыть тему форума - Закрывает тему для новых сообщений - - -*Функция ЗакрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") ЭкспортВозврат УправлениеСостояниемТемыФорума(Токен, IDЧата, 2, IDТемы);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - | IDТемы | --topic | Строка,Число | ID темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "2673"; - - Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат); // Закрывает главную тему - Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат, Тема); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ЗакрытьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 4 +--- + +# Закрыть тему форума + Закрывает тему для новых сообщений + + +*Функция ЗакрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") ЭкспортВозврат УправлениеСостояниемТемыФорума(Токен, IDЧата, 2, IDТемы);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + | IDТемы | --topic | Строка,Число | ID темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "2673"; + + Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат); // Закрывает главную тему + Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат, Тема); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ЗакрытьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% + + +``` + + +```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 index e693d89d36..13365fb4a4 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 2 ---- - -# Создать тему форума - Создает новую тему в группе с включенным функционалом тем - - -*Функция СоздатьТемуФорума(Знач Токен, Знач IDЧата, Знач Заголовок, Знач IDИконки = "") ЭкспортВозврат УправлениеТемойФорума(Токен, IDЧата, Заголовок, IDИконки);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата создания темы | - | Заголовок | --title | Строка | Заголовок темы | - | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Иконка = "5357419403325481346"; - Имя = "Тестовая тема " + Строка(Новый УникальныйИдентификатор); - - Результат = OPI_Telegram.СоздатьТемуФорума(Токен, Чат, Имя, Иконка); - - -``` - -```sh title="Пример команды CLI" - - oint telegram СоздатьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% --icon %icon% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": { - "message_thread_id": 2457, - "name": "Тестовая тема bb6937b8-0372-4118-81f5-cb75b85c4627", - "icon_color": 7322096, - "icon_custom_emoji_id": "5357419403325481346" - } -} - -``` +--- +sidebar_position: 2 +--- + +# Создать тему форума + Создает новую тему в группе с включенным функционалом тем + + +*Функция СоздатьТемуФорума(Знач Токен, Знач IDЧата, Знач Заголовок, Знач IDИконки = "") ЭкспортВозврат УправлениеТемойФорума(Токен, IDЧата, Заголовок, IDИконки);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата создания темы | + | Заголовок | --title | Строка | Заголовок темы | + | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Иконка = "5357419403325481346"; + Имя = "Тестовая тема " + Строка(Новый УникальныйИдентификатор); + + Результат = OPI_Telegram.СоздатьТемуФорума(Токен, Чат, Имя, Иконка); + + +``` + +```sh title="Пример команды CLI" + + oint telegram СоздатьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% --icon %icon% + + +``` + + +```json title="Результат" + +{ + "ok": true, + "result": { + "message_thread_id": 2457, + "name": "Тестовая тема bb6937b8-0372-4118-81f5-cb75b85c4627", + "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 index ac833064d0..7905f67f7f 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 6 ---- - -# Удалить тему форума - Удаляет тему форума - - -*Функция УдалитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы) ЭкспортВозврат УправлениеСостояниемТемыФорума(Токен, IDЧата, 3, IDТемы);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - | IDТемы | --topic | Строка,Число | ID темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "2673"; - - Результат = OPI_Telegram.УдалитьТемуФорума(Токен, Чат, Тема); - - -``` - -```sh title="Пример команды CLI" - - oint telegram УдалитьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 6 +--- + +# Удалить тему форума + Удаляет тему форума + + +*Функция УдалитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы) ЭкспортВозврат УправлениеСостояниемТемыФорума(Токен, IDЧата, 3, IDТемы);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + | IDТемы | --topic | Строка,Число | ID темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "2673"; + + Результат = OPI_Telegram.УдалитьТемуФорума(Токен, Чат, Тема); + + +``` + +```sh title="Пример команды CLI" + + oint telegram УдалитьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% + + +``` + + +```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 index 150f9cf5f6..462478c062 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 3 ---- - -# Изменить тему форума - Создает новую тему в группе с включенным функционалом тем - - -*Функция ИзменитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы, Знач Заголовок = Неопределено, Знач IDИконки = Неопределено) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата создания темы | - | IDТемы | --topic | Строка,Число | ID темы | - | Заголовок | --title | Строка | Новый заголовок | - | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "2673"; - НовоеИмя = "Новый тестовый заголовок"; - НовяИконка = "5310132165583840589"; - - Результат = OPI_Telegram.ИзменитьТемуФорума(Токен, Чат, Тема, НовоеИмя, НовяИконка); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ИзменитьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% --title %title% --icon %icon% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 3 +--- + +# Изменить тему форума + Создает новую тему в группе с включенным функционалом тем + + +*Функция ИзменитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы, Знач Заголовок = Неопределено, Знач IDИконки = Неопределено) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата создания темы | + | IDТемы | --topic | Строка,Число | ID темы | + | Заголовок | --title | Строка | Новый заголовок | + | IDИконки | --icon | Строка | См. ПолучитьСписокИконокАватаров | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "2673"; + НовоеИмя = "Новый тестовый заголовок"; + НовяИконка = "5310132165583840589"; + + Результат = OPI_Telegram.ИзменитьТемуФорума(Токен, Чат, Тема, НовоеИмя, НовяИконка); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ИзменитьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% --title %title% --icon %icon% + + +``` + + +```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 index 4a03bb0184..af740ad913 100644 --- 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 @@ -1,45 +1,45 @@ ---- -sidebar_position: 9 ---- - -# Изменить имя главной темы форума - Изменяет имя главной темы форума - - -*Функция ИзменитьИмяГлавнойТемыФорума(Знач Токен, Знач IDЧата, Знач Заголовок) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - | Заголовок | --title | Строка | Новое имя главной темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Заголовок = "Новое имя главной темы " + Строка(Новый УникальныйИдентификатор); - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Результат = OPI_Telegram.ИзменитьИмяГлавнойТемыФорума(Токен, Чат, Заголовок); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ИзменитьИмяГлавнойТемыФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 9 +--- + +# Изменить имя главной темы форума + Изменяет имя главной темы форума + + +*Функция ИзменитьИмяГлавнойТемыФорума(Знач Токен, Знач IDЧата, Знач Заголовок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + | Заголовок | --title | Строка | Новое имя главной темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Заголовок = "Новое имя главной темы " + Строка(Новый УникальныйИдентификатор); + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Результат = OPI_Telegram.ИзменитьИмяГлавнойТемыФорума(Токен, Чат, Заголовок); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ИзменитьИмяГлавнойТемыФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --title %title% + + +``` + + +```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 index c788b3f463..0d7cef0e0d 100644 --- 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 @@ -1,153 +1,153 @@ ---- -sidebar_position: 1 ---- - -# Получить список иконок-аватаров - Получает соответствие ID Emoji для установки в качестве иконок тем форума - - -*Функция ПолучитьСписокИконокАватаров(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Ключ > ID, Значение > Emoji - -```bsl title="Пример кода" - - - Ответ = ПолучитьСписокИконокАватаров("6129457325:BWDF..."); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint telegram ПолучитьСписокИконокАватаров --token %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": "🐈" -} - -``` +--- +sidebar_position: 1 +--- + +# Получить список иконок-аватаров + Получает соответствие ID Emoji для установки в качестве иконок тем форума + + +*Функция ПолучитьСписокИконокАватаров(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Ключ > ID, Значение > Emoji + +```bsl title="Пример кода" + + + Ответ = ПолучитьСписокИконокАватаров("6129457325:BWDF..."); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint telegram ПолучитьСписокИконокАватаров --token %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 index e47f217132..8ce35b3bfb 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 7 ---- - -# Скрыть главную тему форума - Скрывает главную тему форума - - -*Функция СкрытьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) ЭкспортВозврат УправлениеВидимостьюГлавнойТемыФорума(Токен, IDЧата, Истина);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - - Результат = OPI_Telegram.СкрытьГлавнуюТемуФорума(Токен, Чат); - - -``` - -```sh title="Пример команды CLI" - - oint telegram СкрытьГлавнуюТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 7 +--- + +# Скрыть главную тему форума + Скрывает главную тему форума + + +*Функция СкрытьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) ЭкспортВозврат УправлениеВидимостьюГлавнойТемыФорума(Токен, IDЧата, Истина);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + + Результат = OPI_Telegram.СкрытьГлавнуюТемуФорума(Токен, Чат); + + +``` + +```sh title="Пример команды CLI" + + oint telegram СкрытьГлавнуюТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% + + +``` + + +```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 index 732c795106..704b0ed677 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 5 ---- - -# Открыть тему форума - Повторно открывает ранее закрытую тему форума - - -*Функция ОткрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") ЭкспортВозврат УправлениеСостояниемТемыФорума(Токен, IDЧата, 1, IDТемы);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - | IDТемы | --topic | Строка,Число | ID темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - Тема = "2673"; - - Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат); // Открывает главную тему - Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат, Тема); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ОткрытьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 5 +--- + +# Открыть тему форума + Повторно открывает ранее закрытую тему форума + + +*Функция ОткрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") ЭкспортВозврат УправлениеСостояниемТемыФорума(Токен, IDЧата, 1, IDТемы);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + | IDТемы | --topic | Строка,Число | ID темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + Тема = "2673"; + + Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат); // Открывает главную тему + Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат, Тема); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ОткрытьТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% --topic %topic% + + +``` + + +```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 index 49997563df..ffce67fe2a 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 8 ---- - -# Показать главную тему форума - Показывает ранее скрытую главную тему форума - - -*Функция ПоказатьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) ЭкспортВозврат УправлениеВидимостьюГлавнойТемыФорума(Токен, IDЧата, Ложь);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDЧата | --forum | Строка,Число | ID чата темы | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram - -```bsl title="Пример кода" - - Токен = "6129457865:AAFyzNYOAFbu..."; - Чат = "-1001971186208"; - - Результат = OPI_Telegram.ПоказатьГлавнуюТемуФорума(Токен, Чат); - - -``` - -```sh title="Пример команды CLI" - - oint telegram ПоказатьГлавнуюТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% - - -``` - - -```json title="Результат" - -{ - "ok": true, - "result": true -} - -``` +--- +sidebar_position: 8 +--- + +# Показать главную тему форума + Показывает ранее скрытую главную тему форума + + +*Функция ПоказатьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) ЭкспортВозврат УправлениеВидимостьюГлавнойТемыФорума(Токен, IDЧата, Ложь);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDЧата | --forum | Строка,Число | ID чата темы | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + +```bsl title="Пример кода" + + Токен = "6129457865:AAFyzNYOAFbu..."; + Чат = "-1001971186208"; + + Результат = OPI_Telegram.ПоказатьГлавнуюТемуФорума(Токен, Чат); + + +``` + +```sh title="Пример команды CLI" + + oint telegram ПоказатьГлавнуюТемуФорума --token "6129457865:AAFyzNYOAFbu..." --forum %forum% + + +``` + + +```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 index 782aa8877c..4337038e82 100644 --- a/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md +++ b/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md @@ -1,39 +1,39 @@ ---- -sidebar_position: 1 ---- - -# Получить ссылку для авторизации - Формирует ссылку для авторизации через браузер - - -*Функция ПолучитьСсылкуАвторизации(Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Строка - URL для перехода в браузере - -```bsl title="Пример кода" - - - Ответ = OPI_Twitter.ПолучитьСсылкуАвторизации(Параметры); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter ПолучитьСсылкуАвторизации --auth %auth% - - -``` - - -```json title="Результат" - -"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&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" - -``` +--- +sidebar_position: 1 +--- + +# Получить ссылку для авторизации + Формирует ссылку для авторизации через браузер + + +*Функция ПолучитьСсылкуАвторизации(Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Строка - URL для перехода в браузере + +```bsl title="Пример кода" + + + Ответ = OPI_Twitter.ПолучитьСсылкуАвторизации(Параметры); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter ПолучитьСсылкуАвторизации --auth %auth% + + +``` + + +```json title="Результат" + +"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&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 index befb102c3f..02ca0cecc5 100644 --- a/docs/ru/md/Twitter/Data-and-settings/Get-token.md +++ b/docs/ru/md/Twitter/Data-and-settings/Get-token.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 2 ---- - -# Получить токен - Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации - - -*Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Код | --code | Строка | Код, полученный из авторизации См.ПолучитьСсылкуАвторизации | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - Ответ = OPI_Twitter.ПолучитьТокен(Код, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter ПолучитьТокен --code %code% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", - "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", - "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", - "expires_in": 7200, - "token_type": "bearer" - } - -``` +--- +sidebar_position: 2 +--- + +# Получить токен + Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации + + +*Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Код | --code | Строка | Код, полученный из авторизации См.ПолучитьСсылкуАвторизации | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + Ответ = OPI_Twitter.ПолучитьТокен(Код, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter ПолучитьТокен --code %code% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", + "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", + "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", + "expires_in": 7200, + "token_type": "bearer" + } + +``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md index 732ebb7479..64411c68ea 100644 --- a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md +++ b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 3 ---- - -# Обновить токен - Обновляет v2 токен при помощи refresh_token - - -*Функция ОбновитьТокен(Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - Ответ = OPI_Twitter.ОбновитьТокен(Параметры); - Константы.TwitterToken.Установить(Ответ["access_token"]); - Константы.TwitterRefresh.Установить(Ответ["refresh_token"]); - - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter ОбновитьТокен --auth %auth% - - -``` - - -```json title="Результат" - -{ - "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", - "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", - "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", - "expires_in": 7200, - "token_type": "bearer" - } - -``` +--- +sidebar_position: 3 +--- + +# Обновить токен + Обновляет v2 токен при помощи refresh_token + + +*Функция ОбновитьТокен(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + Ответ = OPI_Twitter.ОбновитьТокен(Параметры); + Константы.TwitterToken.Установить(Ответ["access_token"]); + Константы.TwitterRefresh.Установить(Ответ["refresh_token"]); + + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter ОбновитьТокен --auth %auth% + + +``` + + +```json title="Результат" + +{ + "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", + "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", + "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", + "expires_in": 7200, + "token_type": "bearer" + } + +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md index 68373c0e32..1f3d9d2105 100644 --- a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 3 ---- - -# Создать твит гифки - Создает твит с вложением-гифкой - - -*Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивГифок | --gifs | Массив из Строка,ДвоичныеДанные | Массив файлов гифок | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить("C:\1.gif"); - МассивКартинок.Добавить("C:\2.gif"); - - Ответ = OPI_Twitter.СоздатьТвитГифки("Гифки", МассивКартинок, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter СоздатьТвитГифки --text %text% --gifs %gifs% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "data": { - "text": "Природа https://t.co/VWkWU11111", - "id": "1746086669499924991", - "edit_history_tweet_ids": [ - "1746086669499924991" - ] - } - } - -``` +--- +sidebar_position: 3 +--- + +# Создать твит гифки + Создает твит с вложением-гифкой + + +*Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивГифок | --gifs | Массив из Строка,ДвоичныеДанные | Массив файлов гифок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить("C:\1.gif"); + МассивКартинок.Добавить("C:\2.gif"); + + Ответ = OPI_Twitter.СоздатьТвитГифки("Гифки", МассивКартинок, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter СоздатьТвитГифки --text %text% --gifs %gifs% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "data": { + "text": "Природа https://t.co/VWkWU11111", + "id": "1746086669499924991", + "edit_history_tweet_ids": [ + "1746086669499924991" + ] + } + } + +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-image-tweet.md b/docs/ru/md/Twitter/Tweets/Create-image-tweet.md index 23c59145b4..3add357749 100644 --- a/docs/ru/md/Twitter/Tweets/Create-image-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-image-tweet.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 2 ---- - -# Создать твит картинки - Создает твит с картинкой вложением - - -*Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив файлов картинок | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить("C:\logo.png"); - МассивКартинок.Добавить("C:\logo_long.png"); - - Ответ = OPI_Twitter.СоздатьТвитКартинки("Альпака", МассивКартинок, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter СоздатьТвитКартинки --text %text% --pictures %pictures% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "data": { - "text": "Альпака https://t.co/OodoWT1AAA", - "id": "1745753004542726629", - "edit_history_tweet_ids": [ - "1745753004542726629" - ] - } - } - -``` +--- +sidebar_position: 2 +--- + +# Создать твит картинки + Создает твит с картинкой вложением + + +*Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив файлов картинок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить("C:\logo.png"); + МассивКартинок.Добавить("C:\logo_long.png"); + + Ответ = OPI_Twitter.СоздатьТвитКартинки("Альпака", МассивКартинок, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter СоздатьТвитКартинки --text %text% --pictures %pictures% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "data": { + "text": "Альпака https://t.co/OodoWT1AAA", + "id": "1745753004542726629", + "edit_history_tweet_ids": [ + "1745753004542726629" + ] + } + } + +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md index 24fd3e234e..f732dbfd94 100644 --- a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md @@ -1,56 +1,56 @@ ---- -sidebar_position: 5 ---- - -# Создать твит опрос - Создает твит с опросом - - -*Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , МассивВариантов, Длительность, Параметры);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивВариантов | --options | Массив из Строка | Массив вариантов опроса | - | Длительность | --duration | Строка,Число | Длительность опроса | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - МассивВариантов = Новый Массив; - МассивВариантов.Добавить("Хорошо"); - МассивВариантов.Добавить("Ничего особенного"); - МассивВариантов.Добавить("Плохо"); - - Ответ = OPI_Twitter.СоздатьТвитОпрос("Как дела?", МассивВариантов, 60, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter СоздатьТвитОпрос --text %text% --options %options% --duration %duration% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "data": { - "text": "Как дела?", - "id": "1746082302268969388", - "edit_history_tweet_ids": [ - "1746082302268969388" - ] - } - } - -``` +--- +sidebar_position: 5 +--- + +# Создать твит опрос + Создает твит с опросом + + +*Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , МассивВариантов, Длительность, Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивВариантов | --options | Массив из Строка | Массив вариантов опроса | + | Длительность | --duration | Строка,Число | Длительность опроса | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + МассивВариантов = Новый Массив; + МассивВариантов.Добавить("Хорошо"); + МассивВариантов.Добавить("Ничего особенного"); + МассивВариантов.Добавить("Плохо"); + + Ответ = OPI_Twitter.СоздатьТвитОпрос("Как дела?", МассивВариантов, 60, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter СоздатьТвитОпрос --text %text% --options %options% --duration %duration% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "data": { + "text": "Как дела?", + "id": "1746082302268969388", + "edit_history_tweet_ids": [ + "1746082302268969388" + ] + } + } + +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-text-tweet.md b/docs/ru/md/Twitter/Tweets/Create-text-tweet.md index 3c1d94628a..e6c2b4cb91 100644 --- a/docs/ru/md/Twitter/Tweets/Create-text-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-text-tweet.md @@ -1,49 +1,49 @@ ---- -sidebar_position: 1 ---- - -# Создать текстовый твит - Создает твит без вложений - - -*Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , , , Параметры);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - Ответ = OPI_Twitter.СоздатьТекстовыйТвит("Обычный текстовый твит", Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter СоздатьТекстовыйТвит --text %text% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "data": { - "text": "Обычный текстовый твит", - "id": "1745752006310895822", - "edit_history_tweet_ids": [ - "1745752006310895822" - ] - } - } - -``` +--- +sidebar_position: 1 +--- + +# Создать текстовый твит + Создает твит без вложений + + +*Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , , , Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + Ответ = OPI_Twitter.СоздатьТекстовыйТвит("Обычный текстовый твит", Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter СоздатьТекстовыйТвит --text %text% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "data": { + "text": "Обычный текстовый твит", + "id": "1745752006310895822", + "edit_history_tweet_ids": [ + "1745752006310895822" + ] + } + } + +``` diff --git a/docs/ru/md/Twitter/Tweets/Create-video-tweet.md b/docs/ru/md/Twitter/Tweets/Create-video-tweet.md index 942e18528d..8d4c469bfe 100644 --- a/docs/ru/md/Twitter/Tweets/Create-video-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-video-tweet.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 4 ---- - -# Создать твит видео - Создает твит с видеовложением - - -*Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст твита | - | МассивВидео | --videos | Массив из Строка,ДвоичныеДанные | Массив файлов видео | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter - -```bsl title="Пример кода" - - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить("C:\1.mp4"); - МассивКартинок.Добавить("C:\2.mp4"); - - Ответ = OPI_Twitter.СоздатьТвитВидео("Природа", МассивКартинок, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint twitter СоздатьТвитВидео --text %text% --videos %videos% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "data": { - "text": "Альпака https://t.co/OodoWT1AAA", - "id": "1745753004542726629", - "edit_history_tweet_ids": [ - "1745753004542726629" - ] - } - } - -``` +--- +sidebar_position: 4 +--- + +# Создать твит видео + Создает твит с видеовложением + + +*Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивВидео | --videos | Массив из Строка,ДвоичныеДанные | Массив файлов видео | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить("C:\1.mp4"); + МассивКартинок.Добавить("C:\2.mp4"); + + Ответ = OPI_Twitter.СоздатьТвитВидео("Природа", МассивКартинок, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint twitter СоздатьТвитВидео --text %text% --videos %videos% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "data": { + "text": "Альпака https://t.co/OodoWT1AAA", + "id": "1745753004542726629", + "edit_history_tweet_ids": [ + "1745753004542726629" + ] + } + } + +``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-ad.md b/docs/ru/md/VK/Ad-account-management/Create-ad.md index b7c5cd6753..e721cea37a 100644 --- a/docs/ru/md/VK/Ad-account-management/Create-ad.md +++ b/docs/ru/md/VK/Ad-account-management/Create-ad.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 2 ---- - -# Создать рекламное объявление - Создает рекламное объявление на основе поста - - -*Функция СоздатьРекламноеОбъявление(Знач НомерКампании, Знач ДневнойЛимит, Знач НомерКатегории, Знач IDПоста, Знач IDКабинета, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | НомерКампании | --campaign | Строка,Число | ID рекламной кампании | - | ДневнойЛимит | --limit | Строка,Число | Дневной лимит в рублях | - | НомерКатегории | --category | Строка,Число | Номер рекламной категории | - | IDПоста | --post | Строка,Число | ID поста, используемого в качетсве рекламы | - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.СоздатьРекламноеОбъявление(1029683999, 166, 126, 221, 1607951446, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьРекламноеОбъявление --campaign %campaign% --limit %limit% --category %category% --post %post% --cabinet %cabinet% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": [ - { - "id": 171372386 - } - ] - } - -``` +--- +sidebar_position: 2 +--- + +# Создать рекламное объявление + Создает рекламное объявление на основе поста + + +*Функция СоздатьРекламноеОбъявление(Знач НомерКампании, Знач ДневнойЛимит, Знач НомерКатегории, Знач IDПоста, Знач IDКабинета, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | НомерКампании | --campaign | Строка,Число | ID рекламной кампании | + | ДневнойЛимит | --limit | Строка,Число | Дневной лимит в рублях | + | НомерКатегории | --category | Строка,Число | Номер рекламной категории | + | IDПоста | --post | Строка,Число | ID поста, используемого в качетсве рекламы | + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.СоздатьРекламноеОбъявление(1029683999, 166, 126, 221, 1607951446, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьРекламноеОбъявление --campaign %campaign% --limit %limit% --category %category% --post %post% --cabinet %cabinet% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": [ + { + "id": 171372386 + } + ] + } + +``` 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 index 19bda6103c..a4eaeddcee 100644 --- a/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md +++ b/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 1 ---- - -# Создать рекламную кампанию - Создает кампанию в выбранном рекламном кабинете - - -*Функция СоздатьРекламнуюКампанию(Знач IDКабинета, Знач Наименование, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | Наименование | --title | Строка | Наименование кампании | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.СоздатьРекламнуюКампанию(1234567890, "Новая рекламная кампания", Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьРекламнуюКампанию --cabinet %cabinet% --title %title% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": [ - { - "id": 1029701085 - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Создать рекламную кампанию + Создает кампанию в выбранном рекламном кабинете + + +*Функция СоздатьРекламнуюКампанию(Знач IDКабинета, Знач Наименование, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | Наименование | --title | Строка | Наименование кампании | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.СоздатьРекламнуюКампанию(1234567890, "Новая рекламная кампания", Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьРекламнуюКампанию --cabinet %cabinet% --title %title% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": [ + { + "id": 1029701085 + } + ] + } + +``` 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 index e88f6d5f48..b64c555caf 100644 --- 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 @@ -1,71 +1,71 @@ ---- -sidebar_position: 4 ---- - -# Получить список рекламных категорий - Получает список id рекламных категорий для создания рекламного объявления - - -*Функция ПолучитьСписокРекламныхКатегорий(Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьСписокРекламныхКатегорий(Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСписокРекламныхКатегорий --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "v2": [ - { - "subcategories": [ - { - "subcategories": [ - { - "name": "Мобильные телефоны и планшеты", - "id": 202 - }, - { - "name": "Аудио и видеотехника", - "id": 203 - }, - { - "name": "Портативная техника", - "id": 204 - }, - { - "name": "Игровые приставки", - "id": 205 - }, - - ... - ] - } - ] - } - ] - } - } - -``` +--- +sidebar_position: 4 +--- + +# Получить список рекламных категорий + Получает список id рекламных категорий для создания рекламного объявления + + +*Функция ПолучитьСписокРекламныхКатегорий(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьСписокРекламныхКатегорий(Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСписокРекламныхКатегорий --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "v2": [ + { + "subcategories": [ + { + "subcategories": [ + { + "name": "Мобильные телефоны и планшеты", + "id": 202 + }, + { + "name": "Аудио и видеотехника", + "id": 203 + }, + { + "name": "Портативная техника", + "id": 204 + }, + { + "name": "Игровые приставки", + "id": 205 + }, + + ... + ] + } + ] + } + ] + } + } + +``` diff --git a/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md b/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md index ea369b5af3..5fd5a3f088 100644 --- a/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md +++ b/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 3 ---- - -# Приостановить рекламное объявление - Приостанавливает показ рекламного объявления - - -*Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | IDОбъявления | --adv | Строка,Число | ID объявления | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПриостановитьРекламноеОбъявление(1234567890, 1029701085, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПриостановитьРекламноеОбъявление --cabinet %cabinet% --adv %adv% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": [ - { - "id": 1029701085 - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Приостановить рекламное объявление + Приостанавливает показ рекламного объявления + + +*Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | IDОбъявления | --adv | Строка,Число | ID объявления | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПриостановитьРекламноеОбъявление(1234567890, 1029701085, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПриостановитьРекламноеОбъявление --cabinet %cabinet% --adv %adv% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": [ + { + "id": 1029701085 + } + ] + } + +``` diff --git a/docs/ru/md/VK/Discussion-management/Close-discussion.md b/docs/ru/md/VK/Discussion-management/Close-discussion.md index cb39deb888..c6f7467774 100644 --- a/docs/ru/md/VK/Discussion-management/Close-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Close-discussion.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 2 ---- - -# Закрыть обсуждение - Закрывает или удаляет обсуждение - - -*Функция ЗакрытьОбсуждение(Знач IDОбсуждения, Знач УдалитьПолностью = Ложь, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDОбсуждения | --topic | Строка,Число | ID обсуждения | - | УдалитьПолностью | --remove | Булево | Удалить полностью (Истина) или закрыть | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ИДОбсуждения = "51206275"; - Результат = OPI_VK.ЗакрытьОбсуждение(ИДОбсуждения, Ложь, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk ЗакрытьОбсуждение --topic %topic% --remove %remove% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 2 +--- + +# Закрыть обсуждение + Закрывает или удаляет обсуждение + + +*Функция ЗакрытьОбсуждение(Знач IDОбсуждения, Знач УдалитьПолностью = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | УдалитьПолностью | --remove | Булево | Удалить полностью (Истина) или закрыть | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "51206275"; + Результат = OPI_VK.ЗакрытьОбсуждение(ИДОбсуждения, Ложь, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk ЗакрытьОбсуждение --topic %topic% --remove %remove% --auth %auth% + + +``` + + +```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 index 43a8f3f4db..e3a4448eb3 100644 --- a/docs/ru/md/VK/Discussion-management/Create-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Create-discussion.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 1 ---- - -# Создать обсуждение - Создает новое обсуждение - - -*Функция СоздатьОбсуждение(Знач Наименование, Знач ТекстПервогоСообщения, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование обсуждения | - | ТекстПервогоСообщения | --text | Строка | Текст первого сообщения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - Название = "Обсуждаем: какой цвет лучше?"; - Сообщение = "Красный, желтый, синий или какой-то другой?"; - - Результат = OPI_VK.СоздатьОбсуждение(Название, Сообщение, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьОбсуждение --title %title% --text %text% --auth "ПолучитьПараметрыВК()" - - -``` - - -```json title="Результат" - -{ - "response": 51182455 -} - -``` +--- +sidebar_position: 1 +--- + +# Создать обсуждение + Создает новое обсуждение + + +*Функция СоздатьОбсуждение(Знач Наименование, Знач ТекстПервогоСообщения, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование обсуждения | + | ТекстПервогоСообщения | --text | Строка | Текст первого сообщения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + Название = "Обсуждаем: какой цвет лучше?"; + Сообщение = "Красный, желтый, синий или какой-то другой?"; + + Результат = OPI_VK.СоздатьОбсуждение(Название, Сообщение, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьОбсуждение --title %title% --text %text% --auth "ПолучитьПараметрыВК()" + + +``` + + +```json title="Результат" + +{ + "response": 51182455 +} + +``` diff --git a/docs/ru/md/VK/Discussion-management/Open-discussion.md b/docs/ru/md/VK/Discussion-management/Open-discussion.md index b442889d42..44d8ffabe0 100644 --- a/docs/ru/md/VK/Discussion-management/Open-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Open-discussion.md @@ -1,42 +1,42 @@ ---- -sidebar_position: 3 ---- - -# Открыть обсуждение - Открывает ранее закрытое обсуждение - - -*Функция ОткрытьОбсуждение(Знач IDОбсуждения, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDОбсуждения | --topic | Строка,Число | ID обсуждения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ИДОбсуждения = "51206275"; - Результат = OPI_VK.ОткрытьОбсуждение(ИДОбсуждения, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk ОткрытьОбсуждение --topic %topic% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 3 +--- + +# Открыть обсуждение + Открывает ранее закрытое обсуждение + + +*Функция ОткрытьОбсуждение(Знач IDОбсуждения, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "51206275"; + Результат = OPI_VK.ОткрытьОбсуждение(ИДОбсуждения, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk ОткрытьОбсуждение --topic %topic% --auth %auth% + + +``` + + +```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 index 8b791548f4..b402f613ce 100644 --- a/docs/ru/md/VK/Discussion-management/Write-in-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Write-in-discussion.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 4 ---- - -# Написать в обсуждение - Добавляет сообщение в обсуждение от имени группы - - -*Функция НаписатьВОбсуждение(Знач IDОбсуждения, Знач Текст, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDОбсуждения | --topic | Строка,Число | ID обсуждения | - | Текст | --text | Строка | Текст сообщения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ИДОбсуждения = "51206275"; - Сообщение = "Мне больше нравится желтый"; - - Результат = OPI_VK.НаписатьВОбсуждение(ИДОбсуждения, Сообщение, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk НаписатьВОбсуждение --topic %topic% --text %text% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 705 -} - -``` +--- +sidebar_position: 4 +--- + +# Написать в обсуждение + Добавляет сообщение в обсуждение от имени группы + + +*Функция НаписатьВОбсуждение(Знач IDОбсуждения, Знач Текст, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | Текст | --text | Строка | Текст сообщения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "51206275"; + Сообщение = "Мне больше нравится желтый"; + + Результат = OPI_VK.НаписатьВОбсуждение(ИДОбсуждения, Сообщение, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk НаписатьВОбсуждение --topic %topic% --text %text% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": 705 +} + +``` diff --git a/docs/ru/md/VK/Group-work/Create-album.md b/docs/ru/md/VK/Group-work/Create-album.md index bfc8376eb2..9fab005dea 100644 --- a/docs/ru/md/VK/Group-work/Create-album.md +++ b/docs/ru/md/VK/Group-work/Create-album.md @@ -1,59 +1,59 @@ ---- -sidebar_position: 5 ---- - -# Создать альбом - Создает альбом для хранения картинок - - -*Функция СоздатьАльбом(Знач Наименование, Знач Описание = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование альбома | - | Описание | --description | Строка | Описание альбома | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - Имя = "Альбом из автотеста"; - Описание = "Новый альбом из автотеста"; - - Результат = OPI_VK.СоздатьАльбом(Имя, Описание, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьАльбом --title %title% --description %description% --auth "ПолучитьПараметрыВК()" - - -``` - - -```json title="Результат" - -{ - "response": { - "id": 304498513, - "owner_id": -218861756, - "size": 0, - "title": "Альбом из автотеста", - "feed_disabled": 0, - "feed_has_pinned": 0, - "can_upload": 1, - "comments_disabled": 0, - "created": 1717072416, - "description": "Новый альбом из автотеста", - "thumb_id": 0, - "updated": 1717072416, - "upload_by_admins_only": 1 - } -} - -``` +--- +sidebar_position: 5 +--- + +# Создать альбом + Создает альбом для хранения картинок + + +*Функция СоздатьАльбом(Знач Наименование, Знач Описание = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование альбома | + | Описание | --description | Строка | Описание альбома | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + Имя = "Альбом из автотеста"; + Описание = "Новый альбом из автотеста"; + + Результат = OPI_VK.СоздатьАльбом(Имя, Описание, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьАльбом --title %title% --description %description% --auth "ПолучитьПараметрыВК()" + + +``` + + +```json title="Результат" + +{ + "response": { + "id": 304498513, + "owner_id": -218861756, + "size": 0, + "title": "Альбом из автотеста", + "feed_disabled": 0, + "feed_has_pinned": 0, + "can_upload": 1, + "comments_disabled": 0, + "created": 1717072416, + "description": "Новый альбом из автотеста", + "thumb_id": 0, + "updated": 1717072416, + "upload_by_admins_only": 1 + } +} + +``` diff --git a/docs/ru/md/VK/Group-work/Create-composite-post.md b/docs/ru/md/VK/Group-work/Create-composite-post.md index 1b82fb400a..d1a87175db 100644 --- a/docs/ru/md/VK/Group-work/Create-composite-post.md +++ b/docs/ru/md/VK/Group-work/Create-composite-post.md @@ -1,68 +1,68 @@ ---- -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://openintegrations.dev/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Видео = "https://openintegrations.dev/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, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьСоставнойПост --text %text% --objects %objects% --ad %ad% --url %url% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "post_id": 2126 - } -} - -``` +--- +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://openintegrations.dev/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Видео = "https://openintegrations.dev/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, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьСоставнойПост --text %text% --objects %objects% --ad %ad% --url %url% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "post_id": 2126 + } +} + +``` diff --git a/docs/ru/md/VK/Group-work/Create-poll.md b/docs/ru/md/VK/Group-work/Create-poll.md index 96df7a3d6d..d49f47eba6 100644 --- a/docs/ru/md/VK/Group-work/Create-poll.md +++ b/docs/ru/md/VK/Group-work/Create-poll.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 4 ---- - -# Создать опрос - Создает опрос с вариантами ответа - - -*Функция СоздатьОпрос(Знач Вопрос, Знач МассивОтветов, Знач Картинка = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Вопрос | --question | Строка | Вопрос опроса | - | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | - | Картинка | --picture | Строка,ДвоичныеДанные | Картинка опроса | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - Вопрос = "Какой ваш любимый цвет?"; - - МассивВариантов = Новый Массив; - МассивВариантов.Добавить("Красный"); - МассивВариантов.Добавить("Желтый"); - МассивВариантов.Добавить("Зеленый"); - - Результат = OPI_VK.СоздатьОпрос(Вопрос, МассивВариантов, , Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьОпрос --question "Какой ваш любимый цвет?" --options %options% --picture %picture% --auth "ПолучитьПараметрыВК()" - - -``` - - -```json title="Результат" - -{ - "response": { - "post_id": 2127 - } -} - -``` +--- +sidebar_position: 4 +--- + +# Создать опрос + Создает опрос с вариантами ответа + + +*Функция СоздатьОпрос(Знач Вопрос, Знач МассивОтветов, Знач Картинка = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Вопрос | --question | Строка | Вопрос опроса | + | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | + | Картинка | --picture | Строка,ДвоичныеДанные | Картинка опроса | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + Вопрос = "Какой ваш любимый цвет?"; + + МассивВариантов = Новый Массив; + МассивВариантов.Добавить("Красный"); + МассивВариантов.Добавить("Желтый"); + МассивВариантов.Добавить("Зеленый"); + + Результат = OPI_VK.СоздатьОпрос(Вопрос, МассивВариантов, , Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьОпрос --question "Какой ваш любимый цвет?" --options %options% --picture %picture% --auth "ПолучитьПараметрыВК()" + + +``` + + +```json title="Результат" + +{ + "response": { + "post_id": 2127 + } +} + +``` diff --git a/docs/ru/md/VK/Group-work/Create-post.md b/docs/ru/md/VK/Group-work/Create-post.md index dc5cf81fb0..ce91597ca2 100644 --- a/docs/ru/md/VK/Group-work/Create-post.md +++ b/docs/ru/md/VK/Group-work/Create-post.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 1 ---- - -# Создать пост - Создает пост с картинками - - -*Функция СоздатьПост(Знач Текст, Знач МассивКартинок, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст поста | - | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив картинок | - | Реклама | --ad | Булево | Признак ""Это реклама"" | - | СсылкаПодЗаписью | --url | Строка | Ссылка (URL) под записью | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - Текст = "Пост из автотеста"; - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь или Двоичные данные - Картинка2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Путь или Двоичные данные - - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка2, ИВФ); - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить(Картинка); - МассивКартинок.Добавить(ИВФ); - - Результат = OPI_VK.СоздатьПост(Текст, МассивКартинок, Истина, URL, Параметры); - Результат = OPI_VK.СоздатьПост(Текст, Картинка, Ложь , , Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьПост --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "post_id": 2123 - } -} - -``` +--- +sidebar_position: 1 +--- + +# Создать пост + Создает пост с картинками + + +*Функция СоздатьПост(Знач Текст, Знач МассивКартинок, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст поста | + | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив картинок | + | Реклама | --ad | Булево | Признак ""Это реклама"" | + | СсылкаПодЗаписью | --url | Строка | Ссылка (URL) под записью | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + Текст = "Пост из автотеста"; + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь или Двоичные данные + Картинка2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Путь или Двоичные данные + + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка2, ИВФ); + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка); + МассивКартинок.Добавить(ИВФ); + + Результат = OPI_VK.СоздатьПост(Текст, МассивКартинок, Истина, URL, Параметры); + Результат = OPI_VK.СоздатьПост(Текст, Картинка, Ложь , , Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьПост --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "post_id": 2123 + } +} + +``` diff --git a/docs/ru/md/VK/Group-work/Create-story.md b/docs/ru/md/VK/Group-work/Create-story.md index f7182dee54..579665aef7 100644 --- a/docs/ru/md/VK/Group-work/Create-story.md +++ b/docs/ru/md/VK/Group-work/Create-story.md @@ -1,140 +1,140 @@ ---- -sidebar_position: 7 ---- - -# Создать историю - Создает историю из картинки - - -*Функция СоздатьИсторию(Знач Картинка, Знач URL = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Картинка | --picture | Строка,ДвоичныеДанные | Фон истории | - | URL | --url | Строка | URL для кнопки под историей | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - URL = "https://github.com/Bayselonarrend/OpenIntegrations"; - - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, ИВФ); - Картинка = Новый ДвоичныеДанные(ИВФ); - - Результат = OPI_VK.СоздатьИсторию(Картинка , URL, Параметры); - Результат = OPI_VK.СоздатьИсторию(ИВФ, , Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьИсторию --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "count": 1, - "items": [ - { - "id": 456239491, - "owner_id": -218861756, - "access_key": "story", - "can_comment": 1, - "can_reply": 1, - "can_see": 1, - "can_like": true, - "can_share": 1, - "can_hide": 1, - "date": 1717072436, - "expires_at": 1717158836, - "link": { - "text": "Ещё", - "url": "https://github.com/Bayselonarrend/OpenIntegrations" - }, - "photo": { - "album_id": -81, - "date": 1717072436, - "id": 457244016, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun6-20.userapi.com/s/v1/ig2/TUrQJn6Un8LHB0aNIOPtaqEt3K_J4tZbV2notqyJ1TUyHCj9m-bbiOZKm1u07WpGGAZfH1LFXbg95EM-uS0JHKX9.jpg?size=75x56&quality=95&type=story" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun6-20.userapi.com/s/v1/ig2/lASmJS8sUOYvtmSKkFOsBGNIWpcqoqenWSBOdBHSXQE9PuZjUx_aVVA3Zd6DOV08nssSEYQgXJ6Vam6TiPx2Lcpm.jpg?size=130x97&quality=95&type=story" - }, - { - "height": 192, - "type": "j", - "width": 256, - "url": "https://sun6-20.userapi.com/s/v1/ig2/mmYPgPQo3uRxhAH1qIKIijT-5j87fr0A5PEe1X8k3kdo5MmagHYZIdECvXyFL9KubVsKzTZTWFJSQgskL5a09dhS.jpg?size=256x192&quality=95&type=story" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun6-20.userapi.com/s/v1/ig2/APnAEUFfn6z-WwqFWAM0_jbv9cRo4zrIPx3RSFrsSNdh8bXpv6438yZqB_BDM3pMfSfl6Gsx751T7mJ8yEf_zCi9.jpg?size=604x453&quality=95&type=story" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun6-20.userapi.com/s/v1/ig2/vou57hqLWC875j9nOB1HbiEWaVcSXCHmxNlyzyKEyKv6UO97Mm67PyKNftSvW0RvaHARFvl7Hc9noOv2TAV8Tq6X.jpg?size=807x605&quality=95&type=story" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun6-20.userapi.com/s/v1/ig2/WGh4yRLRWsT4baZUDXiIUZU90sFYcZKcme9nnAPSy8CW_uYDQRDQSy8s0SkNRDEBteCyRBPG0Ka7tPwRQzp5M6Cx.jpg?size=1280x960&quality=95&type=story" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun6-20.userapi.com/s/v1/ig2/QugTL2gH3oV88GUPKhP1GOUfKWONc8iSt_v-Qt6TOsmioQPJ9nyq4L2a1yBHu2eSJKjsql1VhMtEx6wpt3fVVnly.jpg?size=2560x1920&quality=95&type=story" - } - ], - "text": "", - "user_id": 100, - "web_view_token": "404a88e5d32e0ff306", - "has_tags": false - }, - "replies": { - "count": 0, - "new": 0 - }, - "is_one_time": false, - "track_code": "story/3AAQAdLy9G9EAs4bMamDA84nNfHkBAAFoAagB6AIAA==", - "type": "photo", - "views": 0, - "likes_count": 0, - "reaction_set_id": "reactions", - "no_sound": false, - "can_ask": 0, - "can_ask_anonymous": 0, - "narratives_count": 0, - "can_use_in_narrative": true - } - ] - } -} - -``` +--- +sidebar_position: 7 +--- + +# Создать историю + Создает историю из картинки + + +*Функция СоздатьИсторию(Знач Картинка, Знач URL = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Картинка | --picture | Строка,ДвоичныеДанные | Фон истории | + | URL | --url | Строка | URL для кнопки под историей | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + URL = "https://github.com/Bayselonarrend/OpenIntegrations"; + + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, ИВФ); + Картинка = Новый ДвоичныеДанные(ИВФ); + + Результат = OPI_VK.СоздатьИсторию(Картинка , URL, Параметры); + Результат = OPI_VK.СоздатьИсторию(ИВФ, , Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьИсторию --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "count": 1, + "items": [ + { + "id": 456239491, + "owner_id": -218861756, + "access_key": "story", + "can_comment": 1, + "can_reply": 1, + "can_see": 1, + "can_like": true, + "can_share": 1, + "can_hide": 1, + "date": 1717072436, + "expires_at": 1717158836, + "link": { + "text": "Ещё", + "url": "https://github.com/Bayselonarrend/OpenIntegrations" + }, + "photo": { + "album_id": -81, + "date": 1717072436, + "id": 457244016, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun6-20.userapi.com/s/v1/ig2/TUrQJn6Un8LHB0aNIOPtaqEt3K_J4tZbV2notqyJ1TUyHCj9m-bbiOZKm1u07WpGGAZfH1LFXbg95EM-uS0JHKX9.jpg?size=75x56&quality=95&type=story" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun6-20.userapi.com/s/v1/ig2/lASmJS8sUOYvtmSKkFOsBGNIWpcqoqenWSBOdBHSXQE9PuZjUx_aVVA3Zd6DOV08nssSEYQgXJ6Vam6TiPx2Lcpm.jpg?size=130x97&quality=95&type=story" + }, + { + "height": 192, + "type": "j", + "width": 256, + "url": "https://sun6-20.userapi.com/s/v1/ig2/mmYPgPQo3uRxhAH1qIKIijT-5j87fr0A5PEe1X8k3kdo5MmagHYZIdECvXyFL9KubVsKzTZTWFJSQgskL5a09dhS.jpg?size=256x192&quality=95&type=story" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun6-20.userapi.com/s/v1/ig2/APnAEUFfn6z-WwqFWAM0_jbv9cRo4zrIPx3RSFrsSNdh8bXpv6438yZqB_BDM3pMfSfl6Gsx751T7mJ8yEf_zCi9.jpg?size=604x453&quality=95&type=story" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun6-20.userapi.com/s/v1/ig2/vou57hqLWC875j9nOB1HbiEWaVcSXCHmxNlyzyKEyKv6UO97Mm67PyKNftSvW0RvaHARFvl7Hc9noOv2TAV8Tq6X.jpg?size=807x605&quality=95&type=story" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun6-20.userapi.com/s/v1/ig2/WGh4yRLRWsT4baZUDXiIUZU90sFYcZKcme9nnAPSy8CW_uYDQRDQSy8s0SkNRDEBteCyRBPG0Ka7tPwRQzp5M6Cx.jpg?size=1280x960&quality=95&type=story" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun6-20.userapi.com/s/v1/ig2/QugTL2gH3oV88GUPKhP1GOUfKWONc8iSt_v-Qt6TOsmioQPJ9nyq4L2a1yBHu2eSJKjsql1VhMtEx6wpt3fVVnly.jpg?size=2560x1920&quality=95&type=story" + } + ], + "text": "", + "user_id": 100, + "web_view_token": "404a88e5d32e0ff306", + "has_tags": false + }, + "replies": { + "count": 0, + "new": 0 + }, + "is_one_time": false, + "track_code": "story/3AAQAdLy9G9EAs4bMamDA84nNfHkBAAFoAagB6AIAA==", + "type": "photo", + "views": 0, + "likes_count": 0, + "reaction_set_id": "reactions", + "no_sound": false, + "can_ask": 0, + "can_ask_anonymous": 0, + "narratives_count": 0, + "can_use_in_narrative": true + } + ] + } +} + +``` diff --git a/docs/ru/md/VK/Group-work/Delete-album.md b/docs/ru/md/VK/Group-work/Delete-album.md index 815c123ec3..e4cc603f29 100644 --- a/docs/ru/md/VK/Group-work/Delete-album.md +++ b/docs/ru/md/VK/Group-work/Delete-album.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 6 ---- - -# Удалить альбом - Удаляет ранее созданный альбом - - -*Функция УдалитьАльбом(Знач IDАльбома, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDАльбома | --album | Строка,Число | ID альбома | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ИДАльбома = "304549394"; - - Результат = OPI_VK.УдалитьАльбом(ИДАльбома, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьАльбом --album %album% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 6 +--- + +# Удалить альбом + Удаляет ранее созданный альбом + + +*Функция УдалитьАльбом(Знач IDАльбома, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDАльбома | --album | Строка,Число | ID альбома | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДАльбома = "304549394"; + + Результат = OPI_VK.УдалитьАльбом(ИДАльбома, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьАльбом --album %album% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": 1 +} + +``` diff --git a/docs/ru/md/VK/Group-work/Delete-image.md b/docs/ru/md/VK/Group-work/Delete-image.md index ca02812f28..ff6e8ecc8f 100644 --- a/docs/ru/md/VK/Group-work/Delete-image.md +++ b/docs/ru/md/VK/Group-work/Delete-image.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 9 ---- - -# Удалить картинку - Удалить картинку из альбома - - -*Функция УдалитьКартинку(Знач IDКартинки, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКартинки | --pictureid | Строка,Число | ID картинки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ИДКартинки = "457244340"; - - Результат = OPI_VK.УдалитьКартинку(ИДКартинки, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьКартинку --pictureid %pictureid% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 9 +--- + +# Удалить картинку + Удалить картинку из альбома + + +*Функция УдалитьКартинку(Знач IDКартинки, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКартинки | --pictureid | Строка,Число | ID картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДКартинки = "457244340"; + + Результат = OPI_VK.УдалитьКартинку(ИДКартинки, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьКартинку --pictureid %pictureid% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": 1 +} + +``` diff --git a/docs/ru/md/VK/Group-work/Delete-post.md b/docs/ru/md/VK/Group-work/Delete-post.md index a20828326d..0a301289b7 100644 --- a/docs/ru/md/VK/Group-work/Delete-post.md +++ b/docs/ru/md/VK/Group-work/Delete-post.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 3 ---- - -# Удалить пост - Удаляет пост по id - - -*Функция УдалитьПост(Знач IDПоста, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID поста | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ИДПоста = "2304"; - - Результат = OPI_VK.УдалитьПост(ИДПоста, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьПост --post %post% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 -} - -``` +--- +sidebar_position: 3 +--- + +# Удалить пост + Удаляет пост по id + + +*Функция УдалитьПост(Знач IDПоста, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДПоста = "2304"; + + Результат = OPI_VK.УдалитьПост(ИДПоста, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьПост --post %post% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": 1 +} + +``` diff --git a/docs/ru/md/VK/Group-work/Save-image-to-album.md b/docs/ru/md/VK/Group-work/Save-image-to-album.md index 02834e80f9..5bb55e2c8f 100644 --- a/docs/ru/md/VK/Group-work/Save-image-to-album.md +++ b/docs/ru/md/VK/Group-work/Save-image-to-album.md @@ -1,126 +1,126 @@ ---- -sidebar_position: 8 ---- - -# Сохранить картинку в альбом - Сохраняет картинку в альбом сообщества - - -*Функция СохранитьКартинкуВАльбом(Знач IDАльбома, Знач Картинка, Знач Описание = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDАльбома | --album | Строка,Число | ID альбома | - | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | - | Описание | --description | Строка | Описание картинки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - Параметры = ПолучитьПараметрыВК(); - ОписаниеКартинки = "Картинка автотест"; - ИДАльбома = "304549394"; - - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные - ИВФ = ПолучитьИмяВременногоФайла("png"); - КопироватьФайл(Картинка, ИВФ); - - Картинка = Новый ДвоичныеДанные(ИВФ); - - Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, Картинка, ОписаниеКартинки, Параметры); - Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, ИВФ, ОписаниеКартинки, Параметры); - - -``` - -```sh title="Пример команды CLI" - - oint vk СохранитьКартинкуВАльбом --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": [ - { - "album_id": 304498513, - "date": 1717072420, - "id": 457244015, - "owner_id": -218861756, - "sizes": [ - { - "height": 56, - "type": "s", - "width": 75, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=75x56&quality=96&sign=025829abd0851633ab894cc48e64dbbb&c_uniq_tag=2CLDgToJpt6arrVUiZQ9l04lyJ415VJvA6WDs7UOnoI&type=album" - }, - { - "height": 97, - "type": "m", - "width": 130, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" - }, - { - "height": 453, - "type": "x", - "width": 604, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=604x453&quality=96&sign=13ca3aaef94483586ace112657fe8241&c_uniq_tag=_pon027js3STBAQDQY4UbPdMBOh0AzKmalzEJnHAb-8&type=album" - }, - { - "height": 605, - "type": "y", - "width": 807, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=807x605&quality=96&sign=ca6a02d61aa6e88bbd63631e32c49895&c_uniq_tag=NSEWtM7U9s0sKGN84elYe-6ayOzx8dJXPD5JxUFUSK8&type=album" - }, - { - "height": 960, - "type": "z", - "width": 1280, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=1280x960&quality=96&sign=b10c42d8778cd2ac306fdeed0d7c77e9&c_uniq_tag=OsjHk58Ztn163AK2vT9xOw8tz75w00HoqpQSzJ9DOzo&type=album" - }, - { - "height": 1920, - "type": "w", - "width": 2560, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=2560x1920&quality=96&sign=2b5cb4cd90cd4d100b394da5cd1d2540&c_uniq_tag=JXApXjELC3QaCHRgTV2wAZ9xT_1uGPHx2DnJ15ZrfqQ&type=album" - }, - { - "height": 97, - "type": "o", - "width": 130, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" - }, - { - "height": 150, - "type": "p", - "width": 200, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=200x150&quality=96&sign=aea8308f1793d48319babde7d4cf7a2a&c_uniq_tag=0oVRnXvNOW_41uhPO1-daYe0KK2SgLDPeMJ4gk2Js5g&type=album" - }, - { - "height": 240, - "type": "q", - "width": 320, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=320x240&quality=96&sign=f3d612a2ac0b297964e48d1775fa0c70&c_uniq_tag=LAynb-BcGM4BS_ew4PYMa93V627AEj8nTMcnq8Wy5gY&type=album" - }, - { - "height": 382, - "type": "r", - "width": 510, - "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=510x382&quality=96&sign=88209c9869f3522afe0a292a5884e246&c_uniq_tag=eMrSiFeVaca-qCgJXIxD1U1wU6ZInBYxsJVHxKn8CbY&type=album" - } - ], - "text": "Картинка автотест", - "user_id": 100, - "web_view_token": "dcacf60c612a67607b", - "has_tags": false - } - ] -} - -``` +--- +sidebar_position: 8 +--- + +# Сохранить картинку в альбом + Сохраняет картинку в альбом сообщества + + +*Функция СохранитьКартинкуВАльбом(Знач IDАльбома, Знач Картинка, Знач Описание = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDАльбома | --album | Строка,Число | ID альбома | + | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | + | Описание | --description | Строка | Описание картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ОписаниеКартинки = "Картинка автотест"; + ИДАльбома = "304549394"; + + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, ИВФ); + + Картинка = Новый ДвоичныеДанные(ИВФ); + + Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, Картинка, ОписаниеКартинки, Параметры); + Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, ИВФ, ОписаниеКартинки, Параметры); + + +``` + +```sh title="Пример команды CLI" + + oint vk СохранитьКартинкуВАльбом --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": [ + { + "album_id": 304498513, + "date": 1717072420, + "id": 457244015, + "owner_id": -218861756, + "sizes": [ + { + "height": 56, + "type": "s", + "width": 75, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=75x56&quality=96&sign=025829abd0851633ab894cc48e64dbbb&c_uniq_tag=2CLDgToJpt6arrVUiZQ9l04lyJ415VJvA6WDs7UOnoI&type=album" + }, + { + "height": 97, + "type": "m", + "width": 130, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" + }, + { + "height": 453, + "type": "x", + "width": 604, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=604x453&quality=96&sign=13ca3aaef94483586ace112657fe8241&c_uniq_tag=_pon027js3STBAQDQY4UbPdMBOh0AzKmalzEJnHAb-8&type=album" + }, + { + "height": 605, + "type": "y", + "width": 807, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=807x605&quality=96&sign=ca6a02d61aa6e88bbd63631e32c49895&c_uniq_tag=NSEWtM7U9s0sKGN84elYe-6ayOzx8dJXPD5JxUFUSK8&type=album" + }, + { + "height": 960, + "type": "z", + "width": 1280, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=1280x960&quality=96&sign=b10c42d8778cd2ac306fdeed0d7c77e9&c_uniq_tag=OsjHk58Ztn163AK2vT9xOw8tz75w00HoqpQSzJ9DOzo&type=album" + }, + { + "height": 1920, + "type": "w", + "width": 2560, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=2560x1920&quality=96&sign=2b5cb4cd90cd4d100b394da5cd1d2540&c_uniq_tag=JXApXjELC3QaCHRgTV2wAZ9xT_1uGPHx2DnJ15ZrfqQ&type=album" + }, + { + "height": 97, + "type": "o", + "width": 130, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" + }, + { + "height": 150, + "type": "p", + "width": 200, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=200x150&quality=96&sign=aea8308f1793d48319babde7d4cf7a2a&c_uniq_tag=0oVRnXvNOW_41uhPO1-daYe0KK2SgLDPeMJ4gk2Js5g&type=album" + }, + { + "height": 240, + "type": "q", + "width": 320, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=320x240&quality=96&sign=f3d612a2ac0b297964e48d1775fa0c70&c_uniq_tag=LAynb-BcGM4BS_ew4PYMa93V627AEj8nTMcnq8Wy5gY&type=album" + }, + { + "height": 382, + "type": "r", + "width": 510, + "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=510x382&quality=96&sign=88209c9869f3522afe0a292a5884e246&c_uniq_tag=eMrSiFeVaca-qCgJXIxD1U1wU6ZInBYxsJVHxKn8CbY&type=album" + } + ], + "text": "Картинка автотест", + "user_id": 100, + "web_view_token": "dcacf60c612a67607b", + "has_tags": false + } + ] +} + +``` diff --git a/docs/ru/md/VK/Group-work/Upload-photo-to-server.md b/docs/ru/md/VK/Group-work/Upload-photo-to-server.md index 0c09236449..182ec87acf 100644 --- a/docs/ru/md/VK/Group-work/Upload-photo-to-server.md +++ b/docs/ru/md/VK/Group-work/Upload-photo-to-server.md @@ -1,38 +1,38 @@ ---- -sidebar_position: 11 ---- - -# Загрузить фото на сервер - Загружает фото на сервер для его дальнейшего использования - - -*Функция ЗагрузитьФотоНаСервер(Знач Картинка, Знач Параметры = "", Знач Вид = "Пост") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Картинка | --file | Строка, ДвоичныеДанные | Файл картинки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - | Вид | --type | Строка | Вид загрузки (Пост, Товар, История, Опрос, Прочее) | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint vk ЗагрузитьФотоНаСервер --file %file% --auth %auth% --type %type% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 11 +--- + +# Загрузить фото на сервер + Загружает фото на сервер для его дальнейшего использования + + +*Функция ЗагрузитьФотоНаСервер(Знач Картинка, Знач Параметры = "", Знач Вид = "Пост") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Картинка | --file | Строка, ДвоичныеДанные | Файл картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + | Вид | --type | Строка | Вид загрузки (Пост, Товар, История, Опрос, Прочее) | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint vk ЗагрузитьФотоНаСервер --file %file% --auth %auth% --type %type% + + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/ru/md/VK/Group-work/Upload-video-to-server.md b/docs/ru/md/VK/Group-work/Upload-video-to-server.md index 81b5554a89..00a8461c0d 100644 --- a/docs/ru/md/VK/Group-work/Upload-video-to-server.md +++ b/docs/ru/md/VK/Group-work/Upload-video-to-server.md @@ -1,40 +1,40 @@ ---- -sidebar_position: 10 ---- - -# Загрузить видео на сервер - Загружает видео в группу с возможностью его дальнейшего использования - - -*Функция ЗагрузитьВидеоНаСервер(Знач Видео, Знач Наименование, Знач Описание = "", Знач Альбом = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Видео | --file | Строка, ДвоичныеДанные | Файл видео | - | Наименование | --title | Строка | Наименование видео | - | Описание | --description | Строка | Описание видео | - | Альбом | --album | Строка | ID альбома, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint vk ЗагрузитьВидеоНаСервер --file %file% --title %title% --description %description% --album %album% --auth %auth% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 10 +--- + +# Загрузить видео на сервер + Загружает видео в группу с возможностью его дальнейшего использования + + +*Функция ЗагрузитьВидеоНаСервер(Знач Видео, Знач Наименование, Знач Описание = "", Знач Альбом = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Видео | --file | Строка, ДвоичныеДанные | Файл видео | + | Наименование | --title | Строка | Наименование видео | + | Описание | --description | Строка | Описание видео | + | Альбом | --album | Строка | ID альбома, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint vk ЗагрузитьВидеоНаСервер --file %file% --title %title% --description %description% --album %album% --auth %auth% + + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/ru/md/VK/Interactive-actions/Like-post.md b/docs/ru/md/VK/Interactive-actions/Like-post.md index 3f949211fd..4dd5aafc03 100644 --- a/docs/ru/md/VK/Interactive-actions/Like-post.md +++ b/docs/ru/md/VK/Interactive-actions/Like-post.md @@ -1,46 +1,46 @@ ---- -sidebar_position: 1 ---- - -# Поставить лайк - Ставит лайк на пост - - -*Функция ПоставитьЛайк(Знач IDПоста, Знач IDСтены = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID поста | - | IDСтены | --wall | Строка,Число | ID стены расположения поста | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПоставитьЛайк(221, ,Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПоставитьЛайк --post %post% --wall %wall% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "likes": 1 - } - } - -``` +--- +sidebar_position: 1 +--- + +# Поставить лайк + Ставит лайк на пост + + +*Функция ПоставитьЛайк(Знач IDПоста, Знач IDСтены = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | IDСтены | --wall | Строка,Число | ID стены расположения поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПоставитьЛайк(221, ,Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПоставитьЛайк --post %post% --wall %wall% --auth %auth% + + +``` + + +```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 index d6106f19d1..0dc1c29b0d 100644 --- a/docs/ru/md/VK/Interactive-actions/Make-repost.md +++ b/docs/ru/md/VK/Interactive-actions/Make-repost.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 2 ---- - -# Сделать репост - Делает репост записи - - -*Функция СделатьРепост(Знач IDПоста, Знач IDСтены = "", Знач ЦелеваяСтена = "", Знач Рекламный = Ложь, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID поста | - | IDСтены | --from | Строка,Число | ID стены расположения поста | - | ЦелеваяСтена | --to | Строка,Число | ID целевой стены или группы | - | Рекламный | --ad | Булево | Признак рекламного поста | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.СделатьРепост(2571, -218704372, , , Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СделатьРепост --post %post% --from %from% --to %to% --ad %ad% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "mail_repost_count": 2, - "likes_count": 7, - "reposts_count": 3, - "post_id": 228, - "badges": { - "owner_id": -218704372, - "id": 2571, - "type": 11 - }, - "wall_repost_count": 1, - "success": 1 - } - } - -``` +--- +sidebar_position: 2 +--- + +# Сделать репост + Делает репост записи + + +*Функция СделатьРепост(Знач IDПоста, Знач IDСтены = "", Знач ЦелеваяСтена = "", Знач Рекламный = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | IDСтены | --from | Строка,Число | ID стены расположения поста | + | ЦелеваяСтена | --to | Строка,Число | ID целевой стены или группы | + | Рекламный | --ad | Булево | Признак рекламного поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.СделатьРепост(2571, -218704372, , , Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СделатьРепост --post %post% --from %from% --to %to% --ad %ad% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "mail_repost_count": 2, + "likes_count": 7, + "reposts_count": 3, + "post_id": 228, + "badges": { + "owner_id": -218704372, + "id": 2571, + "type": 11 + }, + "wall_repost_count": 1, + "success": 1 + } + } + +``` diff --git a/docs/ru/md/VK/Interactive-actions/Shorten-link.md b/docs/ru/md/VK/Interactive-actions/Shorten-link.md index 0710ced850..2edfb64481 100644 --- a/docs/ru/md/VK/Interactive-actions/Shorten-link.md +++ b/docs/ru/md/VK/Interactive-actions/Shorten-link.md @@ -1,40 +1,40 @@ ---- -sidebar_position: 5 ---- - -# Сократить ссылку - Создает сокращенный URL из обычного - - -*Функция СократитьСсылку(Знач URL, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL для сокращения | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Строка - Сокращенный URL - -```bsl title="Пример кода" - - - Ответ = OPI_VK.СократитьСсылку("https://github.com/Bayselonarrend/OpenIntegrations", Параметры); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СократитьСсылку --url %url% --auth %auth% - - -``` - - -```json title="Результат" - -https://vk.cc/ctL1sM - -``` +--- +sidebar_position: 5 +--- + +# Сократить ссылку + Создает сокращенный URL из обычного + + +*Функция СократитьСсылку(Знач URL, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL для сокращения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Строка - Сокращенный URL + +```bsl title="Пример кода" + + + Ответ = OPI_VK.СократитьСсылку("https://github.com/Bayselonarrend/OpenIntegrations", Параметры); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СократитьСсылку --url %url% --auth %auth% + + +``` + + +```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 index cef10bbca2..f354dece4b 100644 --- a/docs/ru/md/VK/Interactive-actions/Write-comment.md +++ b/docs/ru/md/VK/Interactive-actions/Write-comment.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 4 ---- - -# Написать комментарий - Создает комментарий под выбранной записью - - -*Функция НаписатьКомментарий(Знач IDПоста, Знач IDСтены, Знач Текст, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDПоста | --post | Строка,Число | ID целевого поста | - | IDСтены | --wall | Строка,Число | ID стены расположения поста | - | Текст | --text | Строка | Текст комментария | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.НаписатьКомментарий(221, -218861756, "Привет", Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk НаписатьКомментарий --post %post% --wall %wall% --text %text% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "parents_stack": [], - "comment_id": 229 - } - } - -``` +--- +sidebar_position: 4 +--- + +# Написать комментарий + Создает комментарий под выбранной записью + + +*Функция НаписатьКомментарий(Знач IDПоста, Знач IDСтены, Знач Текст, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID целевого поста | + | IDСтены | --wall | Строка,Число | ID стены расположения поста | + | Текст | --text | Строка | Текст комментария | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.НаписатьКомментарий(221, -218861756, "Привет", Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk НаписатьКомментарий --post %post% --wall %wall% --text %text% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "parents_stack": [], + "comment_id": 229 + } + } + +``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-message.md b/docs/ru/md/VK/Interactive-actions/Write-message.md index 2852d76d58..fbbabfcc53 100644 --- a/docs/ru/md/VK/Interactive-actions/Write-message.md +++ b/docs/ru/md/VK/Interactive-actions/Write-message.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 3 ---- - -# Написать сообщение - Написать сообщение пользователю в диалоге сообщества - - -*Функция НаписатьСообщение(Знач Текст, Знач IDПользователя, Знач Communitytoken, Знач Клавиатура = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Текст | --text | Строка | Текст сообщения | - | IDПользователя | --user | Строка | ID пользователя адресата | - | Communitytoken | --ct | Строка | Токен бота чата сообщества, котрый можно получить в настройках | - | Клавиатура | --keyboard | Строка | JSON клавиатуры. См.СформироватьКлавиатуру | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - КТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb..."; - Ответ = OPI_VK.НаписатьСообщение("Я бот, а ты нет >:)", 657811122, КТ, , Параметры); - - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk НаписатьСообщение --text %text% --user %user% --ct %ct% --keyboard %keyboard% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 7 - } - -``` +--- +sidebar_position: 3 +--- + +# Написать сообщение + Написать сообщение пользователю в диалоге сообщества + + +*Функция НаписатьСообщение(Знач Текст, Знач IDПользователя, Знач Communitytoken, Знач Клавиатура = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст сообщения | + | IDПользователя | --user | Строка | ID пользователя адресата | + | Communitytoken | --ct | Строка | Токен бота чата сообщества, котрый можно получить в настройках | + | Клавиатура | --keyboard | Строка | JSON клавиатуры. См.СформироватьКлавиатуру | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + КТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb..."; + Ответ = OPI_VK.НаписатьСообщение("Я бот, а ты нет >:)", 657811122, КТ, , Параметры); + + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk НаписатьСообщение --text %text% --user %user% --ct %ct% --keyboard %keyboard% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": 7 + } + +``` diff --git a/docs/ru/md/VK/Order-management/Get-order-list.md b/docs/ru/md/VK/Order-management/Get-order-list.md index b36720e7be..c8bccb51db 100644 --- a/docs/ru/md/VK/Order-management/Get-order-list.md +++ b/docs/ru/md/VK/Order-management/Get-order-list.md @@ -1,36 +1,36 @@ ---- -sidebar_position: 1 ---- - -# Получить список заказов - Возвращает список заказов сообщества - - -*Функция ПолучитьСписокЗаказов(Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСписокЗаказов --auth %auth% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 1 +--- + +# Получить список заказов + Возвращает список заказов сообщества + + +*Функция ПолучитьСписокЗаказов(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСписокЗаказов --auth %auth% + + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/ru/md/VK/Others/Form-keyboard.md b/docs/ru/md/VK/Others/Form-keyboard.md index 195b45e103..6f6979975b 100644 --- a/docs/ru/md/VK/Others/Form-keyboard.md +++ b/docs/ru/md/VK/Others/Form-keyboard.md @@ -1,65 +1,65 @@ ---- -sidebar_position: 1 ---- - -# Сформировать клавиатуру - Формирует клавиатуру по массиву кнопок - - -*Функция СформироватьКлавиатуру(Знач МассивКнопок) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивКнопок | --buttons | Массив из Строка | Массив заголовков кнопок | - - - Возвращаемое значение: Строка - JSON клавиатуры - -```bsl title="Пример кода" - - - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Кнопка 1"); - МассивКнопок.Добавить("Кнопка 2"); - - Клавиатура = OPI_VK.СформироватьКлавиатуру(МассивКнопок); - КТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYC..."; - Ответ = OPI_VK.НаписатьСообщение("Я бот, а ты нет >:)", 657846756, КТ, Клавиатура, Параметры); - - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СформироватьКлавиатуру --buttons %buttons% - - -``` - - -```json title="Результат" - -{ - "buttons": [ - [ - { - "action": { - "type": "text", - "label": "Кнопка 1" - } - }, - { - "action": { - "type": "text", - "label": "Кнопка 2" - } - } - ] - ], - "one_time": false - } - -``` +--- +sidebar_position: 1 +--- + +# Сформировать клавиатуру + Формирует клавиатуру по массиву кнопок + + +*Функция СформироватьКлавиатуру(Знач МассивКнопок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив заголовков кнопок | + + + Возвращаемое значение: Строка - JSON клавиатуры + +```bsl title="Пример кода" + + + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Кнопка 1"); + МассивКнопок.Добавить("Кнопка 2"); + + Клавиатура = OPI_VK.СформироватьКлавиатуру(МассивКнопок); + КТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYC..."; + Ответ = OPI_VK.НаписатьСообщение("Я бот, а ты нет >:)", 657846756, КТ, Клавиатура, Параметры); + + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СформироватьКлавиатуру --buttons %buttons% + + +``` + + +```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 index a66e868059..bddadea5e7 100644 --- a/docs/ru/md/VK/Product-management/Add-product.md +++ b/docs/ru/md/VK/Product-management/Add-product.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 4 ---- - -# Добавить товар - Добавляет новый товар в каталог сообщества - - -*Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") ЭкспортВозврат УправлениеТоваром(ОписаниеТовара, , Подборка, Параметры);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | - | Подборка | --sel | Строка | ID подборка для помещения товара, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - МассивКартинок = Новый Массив; - МассивКартинок.Добавить(Картинка); - МассивКартинок.Добавить(Картинка); - - Товар = Новый Соответствие(); - Товар.Вставить("Имя" , "Тестовый товар"); - Товар.Вставить("Описание" , "Описание товара"); - Товар.Вставить("Категория" , "20173"); - Товар.Вставить("Цена" , 1); - Товар.Вставить("СтараяЦена" , 15); - Товар.Вставить("ОсновноеФото" , Картинка); - Товар.Вставить("URL" , "https://github.com/Bayselonarrend/OpenIntegrations"); - Товар.Вставить("ДополнительныеФото" , МассивКартинок); - Товар.Вставить("ГлавныйВГруппе" , Истина); - Товар.Вставить("Ширина" , 20); - Товар.Вставить("Высота" , 30); - Товар.Вставить("Глубина" , 40); - Товар.Вставить("Вес" , 100); - Товар.Вставить("SKU" , "12345"); - Товар.Вставить("ДоступныйОстаток" , "10"); - - Ответ = OPI_VK.ДобавитьТовар(Товар, ИДПодборки, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ДобавитьТовар --product %product% --sel %sel% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "market_item_id": 8656047 - } - } - -``` +--- +sidebar_position: 4 +--- + +# Добавить товар + Добавляет новый товар в каталог сообщества + + +*Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") ЭкспортВозврат УправлениеТоваром(ОписаниеТовара, , Подборка, Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | + | Подборка | --sel | Строка | ID подборка для помещения товара, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка); + МассивКартинок.Добавить(Картинка); + + Товар = Новый Соответствие(); + Товар.Вставить("Имя" , "Тестовый товар"); + Товар.Вставить("Описание" , "Описание товара"); + Товар.Вставить("Категория" , "20173"); + Товар.Вставить("Цена" , 1); + Товар.Вставить("СтараяЦена" , 15); + Товар.Вставить("ОсновноеФото" , Картинка); + Товар.Вставить("URL" , "https://github.com/Bayselonarrend/OpenIntegrations"); + Товар.Вставить("ДополнительныеФото" , МассивКартинок); + Товар.Вставить("ГлавныйВГруппе" , Истина); + Товар.Вставить("Ширина" , 20); + Товар.Вставить("Высота" , 30); + Товар.Вставить("Глубина" , 40); + Товар.Вставить("Вес" , 100); + Товар.Вставить("SKU" , "12345"); + Товар.Вставить("ДоступныйОстаток" , "10"); + + Ответ = OPI_VK.ДобавитьТовар(Товар, ИДПодборки, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ДобавитьТовар --product %product% --sel %sel% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "market_item_id": 8656047 + } + } + +``` diff --git a/docs/ru/md/VK/Product-management/Delete-product.md b/docs/ru/md/VK/Product-management/Delete-product.md index e206dcabd1..b76388323c 100644 --- a/docs/ru/md/VK/Product-management/Delete-product.md +++ b/docs/ru/md/VK/Product-management/Delete-product.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 6 ---- - -# Удалить товар - Удаляет ранее созданный товар - - -*Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товар | --item | Строка,Число | ID товара | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.УдалитьТовар(ИДТовара, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьТовар --item %item% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 6 +--- + +# Удалить товар + Удаляет ранее созданный товар + + +*Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Строка,Число | ID товара | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.УдалитьТовар(ИДТовара, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьТовар --item %item% --auth %auth% + + +``` + + +```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 index c078c5768c..e03f0e086f 100644 --- a/docs/ru/md/VK/Product-management/Edit-product.md +++ b/docs/ru/md/VK/Product-management/Edit-product.md @@ -1,48 +1,48 @@ ---- -sidebar_position: 5 ---- - -# Изменить товар - Изменяет ранее созданный товар - - -*Функция ИзменитьТовар(Знач Товар, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") ЭкспортВозврат УправлениеТоваром(ОписаниеТовара, Товар, Подборка, Параметры);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товар | --item | Число,Строка | Идентификатор изменяемого товара | - | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | - | Подборка | --sel | Строка | Идентификатор новой подборки, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Товар = Новый Соответствие; - Товар.Вставить("Имя", "Тестовый товар измененный"); - - Ответ = OPI_VK.ИзменитьТовар(ИДТовара, Товар, , Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ИзменитьТовар --item %item% --product %product% --sel %sel% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 5 +--- + +# Изменить товар + Изменяет ранее созданный товар + + +*Функция ИзменитьТовар(Знач Товар, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") ЭкспортВозврат УправлениеТоваром(ОписаниеТовара, Товар, Подборка, Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Число,Строка | Идентификатор изменяемого товара | + | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | + | Подборка | --sel | Строка | Идентификатор новой подборки, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Товар = Новый Соответствие; + Товар.Вставить("Имя", "Тестовый товар измененный"); + + Ответ = OPI_VK.ИзменитьТовар(ИДТовара, Товар, , Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ИзменитьТовар --item %item% --product %product% --sel %sel% --auth %auth% + + +``` + + +```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 index a505703dc0..71dfddc536 100644 --- a/docs/ru/md/VK/Product-management/Get-product-category-list.md +++ b/docs/ru/md/VK/Product-management/Get-product-category-list.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 1 ---- - -# Получить список категорий товаров - Получает список ID товарных категорий для указания при создании товара - - -*Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из Строка - Ключ - ID, Значение - Имя - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьСписокКатегорийТоваров(Параметры); //Соответствие - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСписокКатегорийТоваров --auth %auth% - - -``` - - -```json title="Результат" - -Ключ Значение - - 1210 "Деловые услуги" - 1200 "Фото- и видеоуслуги" - 2162 "Ремонт и строительство" - ... - -``` +--- +sidebar_position: 1 +--- + +# Получить список категорий товаров + Получает список ID товарных категорий для указания при создании товара + + +*Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из Строка - Ключ - ID, Значение - Имя + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьСписокКатегорийТоваров(Параметры); //Соответствие + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСписокКатегорийТоваров --auth %auth% + + +``` + + +```json title="Результат" + +Ключ Значение + + 1210 "Деловые услуги" + 1200 "Фото- и видеоуслуги" + 2162 "Ремонт и строительство" + ... + +``` diff --git a/docs/ru/md/VK/Product-management/Get-product-description.md b/docs/ru/md/VK/Product-management/Get-product-description.md index 3f0d192177..cc4210ee40 100644 --- a/docs/ru/md/VK/Product-management/Get-product-description.md +++ b/docs/ru/md/VK/Product-management/Get-product-description.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 8 ---- - -# Получить описание товара. - - - -*Функция ПолучитьОписаниеТовара() Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Пустое описание товара: - - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьОписаниеТовара - - -``` - - -```json title="Результат" - -Товар = Новый Соответствие(); - Товар.Вставить("Имя" , "Новый товар"); // Имя товара - Товар.Вставить("Описание" , "Описание товара"); // Описание товара - Товар.Вставить("Категория" , "20173"); // См ПолучитьСписокКатегорийТоваров() - Товар.Вставить("Цена" , 1); // Цена. - Товар.Вставить("СтараяЦена" , Неопределено); // Для отражения изменения цены - Товар.Вставить("ОсновноеФото" , Неопределено); // ДД или путь к осн. фото - Товар.Вставить("URL" , Неопределено); // Ссылка на страницу магазина - Товар.Вставить("ДополнительныеФото" , Новый Массив); // Массив путей или ДД для доп. фото - Товар.Вставить("ЗначенияСвойств" , Новый Массив); // Значения свойств (варианты). Максимум 2 - Товар.Вставить("ГлавныйВГруппе" , Ложь); // Сделать главным в своей группе - Товар.Вставить("Ширина" , Неопределено); // В миллиметрах - Товар.Вставить("Высота" , Неопределено); // В миллиметрах - Товар.Вставить("Глубина" , Неопределено); // В миллиметрах - Товар.Вставить("Вес" , Неопределено); // В граммах - Товар.Вставить("SKU" , Неопределено); // Артикул - Товар.Вставить("ДоступныйОстаток" , 1); - -``` +--- +sidebar_position: 8 +--- + +# Получить описание товара. + + + +*Функция ПолучитьОписаниеТовара() Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Пустое описание товара: + + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьОписаниеТовара + + +``` + + +```json title="Результат" + +Товар = Новый Соответствие(); + Товар.Вставить("Имя" , "Новый товар"); // Имя товара + Товар.Вставить("Описание" , "Описание товара"); // Описание товара + Товар.Вставить("Категория" , "20173"); // См ПолучитьСписокКатегорийТоваров() + Товар.Вставить("Цена" , 1); // Цена. + Товар.Вставить("СтараяЦена" , Неопределено); // Для отражения изменения цены + Товар.Вставить("ОсновноеФото" , Неопределено); // ДД или путь к осн. фото + Товар.Вставить("URL" , Неопределено); // Ссылка на страницу магазина + Товар.Вставить("ДополнительныеФото" , Новый Массив); // Массив путей или ДД для доп. фото + Товар.Вставить("ЗначенияСвойств" , Новый Массив); // Значения свойств (варианты). Максимум 2 + Товар.Вставить("ГлавныйВГруппе" , Ложь); // Сделать главным в своей группе + Товар.Вставить("Ширина" , Неопределено); // В миллиметрах + Товар.Вставить("Высота" , Неопределено); // В миллиметрах + Товар.Вставить("Глубина" , Неопределено); // В миллиметрах + Товар.Вставить("Вес" , Неопределено); // В граммах + Товар.Вставить("SKU" , Неопределено); // Артикул + Товар.Вставить("ДоступныйОстаток" , 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 index 41d0bda5a6..6cdd861f73 100644 --- a/docs/ru/md/VK/Product-management/Get-product-list.md +++ b/docs/ru/md/VK/Product-management/Get-product-list.md @@ -1,348 +1,348 @@ ---- -sidebar_position: 2 ---- - -# Получить список товаров - Получает список товаров сообщества - - -*Функция ПолучитьСписокТоваров(Знач Подборка = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Подборка | --sel | Строка,Число | ID подборки, если нужен отбор | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий товаров - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьСписокТоваров(, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСписокТоваров --sel %sel% --auth %auth% - - -``` - - -```json title="Результат" - -[ - { - "sku": "12 345", - "is_main_variant": true, - "is_owner": true, - "date": 1708079311, - "can_show_convert_to_service": true, - "can_delete": true, - "views_count": 1, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=a4094440c3769389eefbbb6f63fb3b06&c_uniq_tag=wg_JEvsvTTjzR-t_GyVXH_8VjxbraezNWRHCn7b6mBQ", - "likes": { - "user_likes": 0, - "count": 0 - }, - "can_recover": false, - "can_repost": 1, - "reject_info": { - "buttons": [ - { - "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653408&type=market", - "type": "market_edit" - }, - { - "type": "market_delete" - } - ], - "in_progress": false, - "description": "Описание тестового товара", - "moderation_status": 2, - "title": "" - }, - "photos": [ - { - "has_tags": false, - "web_view_token": "8aafd75b91f2cf1425", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=75x75&quality=95&sign=8799f9f279ce65bf9ac62a5724971675&c_uniq_tag=RBTqNLzMstWYqH3UP-8FEDlMyg31ogY38n3XLQ-lOCE&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=604x604&quality=95&sign=5dc945bfe9e7f79888d73004eae343eb&c_uniq_tag=V4KYZPU3iIF3RVCqYXXq8g8p0Trd2jQRKnY7AFlKDe8&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=807x807&quality=95&sign=d278b813303eb31bdb730e51ef8f6b6d&c_uniq_tag=aFbbqQ4bPqGp5BMBy917bpLCshpOoZjf5YA89T9UCec&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=1024x1024&quality=95&sign=f8881fbbded9f8840ee4b02c4c6cb879&c_uniq_tag=tHRje1Xf1jctFzjuO4X4aJBAAYxJ1_rK5JKFNIx17N8&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=200x200&quality=95&sign=cd430561bb7b2746fb6eb6fe75360ec6&c_uniq_tag=vApE_jC2x9G_pE2o_Sa0VbdXZbhyYpJ6stb7bWAnP-4&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=320x320&quality=95&sign=8e1438dda0f54fb11756668e2fee6c1a&c_uniq_tag=Vn2w0zG8YDCc0KftpKmikpLL3YyydcLrGgcqB3wKi2s&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=510x510&quality=95&sign=e91c847e2415d0ee15512c123421c276&c_uniq_tag=ZWDwoheiysNResAKNuM2WxUUsip8_r6MfNbvtGkh73Y&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "c9794503a593bd9cec", - "user_id": 100, - "owner_id": -218861756, - "id": 457239678, - "date": 1708079308, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "624c0066d8978afcac", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=75x75&quality=95&sign=2d38b31b4c3e10582b0679289e30e9b7&c_uniq_tag=NHINy4_e18wRuW7wSk8qdZAyddbb6UvEYe3tCKVzy1c&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=604x604&quality=95&sign=ff313c468d0b77929619430847063235&c_uniq_tag=babY_J2d40AbSOscXypcBkEgicxrrDxlYD74ZDTjIJA&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=807x807&quality=95&sign=5ed25ec65ddf75807a40592fa3a57b85&c_uniq_tag=QXMQTItlMkDqUZvYOS36ygz-eqDElNch6kznQpHNtUs&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=1024x1024&quality=95&sign=43a67fdc1397e5eb5c5c87c9dcc64a16&c_uniq_tag=b7XxwzUXLkL9jIg7PjcUdEGQJUMcnn_D6ZwTWaBwXkQ&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=200x200&quality=95&sign=87d8cd030f6312d3e914895882a0fd1f&c_uniq_tag=5s7vPvuFFNHVaieG0xd_Izcw3WnuOR2mRRlDZtw8zJU&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=320x320&quality=95&sign=37a2a53a35d6a2c1451e5ccd524b878c&c_uniq_tag=BX5IGPc0xpKDoYtTPlHGSbIoucM1H2-cpOg_7VQGgAs&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=510x510&quality=95&sign=925dbfb3a9b9b85d328880f9342cc7d8&c_uniq_tag=JGGgvPjVHXrx7PgK3FVuk9X1KNeg5skBMMNeSN9fg4s&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "266753958e3c5635cb", - "user_id": 100, - "owner_id": -218861756, - "id": 457239679, - "date": 1708079309, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "4d22638dbca11b42dc", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=75x75&quality=95&sign=b5c353c838e289bf4dfe012e93c8d96f&c_uniq_tag=M99VG2d-cv9h8UPexKNwfDIpFp59CFVbZ5B8ksQLr4I&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=604x604&quality=95&sign=0a958b351a1d2301159c30e4e57f3fd3&c_uniq_tag=02RQFt-o1HuSw8GYCWY_a7STB4ua28_zFb7a4CD5BO8&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=807x807&quality=95&sign=18fd0f4c4d1097074cc761211e5904c7&c_uniq_tag=HS0b1Fur_f2LFs3_NHY8kCaJyQrv11_I6wjaeMYcmA8&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=1024x1024&quality=95&sign=6f59f9c6c1bb8ee0458c9d970a95eb37&c_uniq_tag=9N6uQC5vMHptVulrxwY6a_uJIx3ND4Q65klbzMDGguE&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=200x200&quality=95&sign=80a6e97e3262ccc6ff80e30d609b39c8&c_uniq_tag=5fZY8t9mBrikvu-J0q4JkrOg0wHERphSEGIfscG2_t0&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=320x320&quality=95&sign=4bff4c938faaab606aeb85451951a175&c_uniq_tag=-mFXyFqoRGG2T0uDx1ZKZiMrU7vCzIUuzN56k1Xrd7o&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=510x510&quality=95&sign=bcefcff03c4cd3f6ca30f41f6e6f19df&c_uniq_tag=1BHfm_IEucSBPtWGWR-xDhdJ8w5L_tw0Tf3iTj8UixU&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "78ed3a6ff11c40a07c", - "user_id": 100, - "owner_id": -218861756, - "id": 457239680, - "date": 1708079310, - "album_id": -53 - } - ], - "cart_quantity": 0, - "albums_ids": [ - 9 - ], - "weight": 100, - "dimensions": { - "length": 40, - "height": 30, - "width": 20 - }, - "title": "Тестовый товар измененный", - "other_items": [ - { - "item_ids": [ - "-218861756_8655960", - "-218861756_8655800", - "-218861756_8655797", - "-218861756_8653766", - "-218861756_8653760", - "-218861756_8653404", - "-218861756_8653395", - "-218861756_8653393", - "-218861756_8653391", - "-218861756_8653387" - ], - "referrer_item_type": "other_goods", - "view_type": 1, - "title": "Другие товары сообщества" - } - ], - "reposts": { - "count": 0 - }, - "price": { - "old_amount_text": "15 ₽", - "old_amount": "1500", - "discount_rate": -93, - "text": "1 ₽", - "currency": { - "title": "₽", - "name": "RUB", - "id": 643 - }, - "amount": "100" - }, - "can_edit": true, - "owner_id": -218861756, - "can_comment": 1, - "is_adult": false, - "id": 8653408, - "description": "Описание товара", - "owner_info": { - "market_type": "pro", - "category": "Тестовая подборка", - "is_corporated_market": false, - "name": "Test", - "category_url": "/market-218861756?section=album_9", - "avatar": [] - }, - "category": { - "section": { - "name": "Канцелярские товары", - "id": 10016 - }, - "name": "Батарейки", - "id": 20173, - "inner_type": "market_market_category_old" - }, - "promotion": { - "is_available": false - }, - "availability": 0 - } - ] - -``` +--- +sidebar_position: 2 +--- + +# Получить список товаров + Получает список товаров сообщества + + +*Функция ПолучитьСписокТоваров(Знач Подборка = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборка | --sel | Строка,Число | ID подборки, если нужен отбор | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий товаров + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьСписокТоваров(, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСписокТоваров --sel %sel% --auth %auth% + + +``` + + +```json title="Результат" + +[ + { + "sku": "12 345", + "is_main_variant": true, + "is_owner": true, + "date": 1708079311, + "can_show_convert_to_service": true, + "can_delete": true, + "views_count": 1, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=a4094440c3769389eefbbb6f63fb3b06&c_uniq_tag=wg_JEvsvTTjzR-t_GyVXH_8VjxbraezNWRHCn7b6mBQ", + "likes": { + "user_likes": 0, + "count": 0 + }, + "can_recover": false, + "can_repost": 1, + "reject_info": { + "buttons": [ + { + "url": "https://vk.com/app7702617#owner_id=-218861756&item_id=8653408&type=market", + "type": "market_edit" + }, + { + "type": "market_delete" + } + ], + "in_progress": false, + "description": "Описание тестового товара", + "moderation_status": 2, + "title": "" + }, + "photos": [ + { + "has_tags": false, + "web_view_token": "8aafd75b91f2cf1425", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=75x75&quality=95&sign=8799f9f279ce65bf9ac62a5724971675&c_uniq_tag=RBTqNLzMstWYqH3UP-8FEDlMyg31ogY38n3XLQ-lOCE&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=604x604&quality=95&sign=5dc945bfe9e7f79888d73004eae343eb&c_uniq_tag=V4KYZPU3iIF3RVCqYXXq8g8p0Trd2jQRKnY7AFlKDe8&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=807x807&quality=95&sign=d278b813303eb31bdb730e51ef8f6b6d&c_uniq_tag=aFbbqQ4bPqGp5BMBy917bpLCshpOoZjf5YA89T9UCec&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=1024x1024&quality=95&sign=f8881fbbded9f8840ee4b02c4c6cb879&c_uniq_tag=tHRje1Xf1jctFzjuO4X4aJBAAYxJ1_rK5JKFNIx17N8&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=130x130&quality=95&sign=68127c81f17e0792a39275ac56a00349&c_uniq_tag=AYaHXxR8M9NOwGxm3W7OCKV8m8r1_TbAjXNWxH6WPyw&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=200x200&quality=95&sign=cd430561bb7b2746fb6eb6fe75360ec6&c_uniq_tag=vApE_jC2x9G_pE2o_Sa0VbdXZbhyYpJ6stb7bWAnP-4&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=320x320&quality=95&sign=8e1438dda0f54fb11756668e2fee6c1a&c_uniq_tag=Vn2w0zG8YDCc0KftpKmikpLL3YyydcLrGgcqB3wKi2s&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/Gfx6FaCjN0Q.jpg?size=510x510&quality=95&sign=e91c847e2415d0ee15512c123421c276&c_uniq_tag=ZWDwoheiysNResAKNuM2WxUUsip8_r6MfNbvtGkh73Y&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "c9794503a593bd9cec", + "user_id": 100, + "owner_id": -218861756, + "id": 457239678, + "date": 1708079308, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "624c0066d8978afcac", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=75x75&quality=95&sign=2d38b31b4c3e10582b0679289e30e9b7&c_uniq_tag=NHINy4_e18wRuW7wSk8qdZAyddbb6UvEYe3tCKVzy1c&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=604x604&quality=95&sign=ff313c468d0b77929619430847063235&c_uniq_tag=babY_J2d40AbSOscXypcBkEgicxrrDxlYD74ZDTjIJA&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=807x807&quality=95&sign=5ed25ec65ddf75807a40592fa3a57b85&c_uniq_tag=QXMQTItlMkDqUZvYOS36ygz-eqDElNch6kznQpHNtUs&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=1024x1024&quality=95&sign=43a67fdc1397e5eb5c5c87c9dcc64a16&c_uniq_tag=b7XxwzUXLkL9jIg7PjcUdEGQJUMcnn_D6ZwTWaBwXkQ&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=130x130&quality=95&sign=dcab9e1f769ca79c1e68297cd4044c0a&c_uniq_tag=fBtDGHdUJpSPkEySW8vLlWPPExva3dsBFyQPrLk0ydI&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=200x200&quality=95&sign=87d8cd030f6312d3e914895882a0fd1f&c_uniq_tag=5s7vPvuFFNHVaieG0xd_Izcw3WnuOR2mRRlDZtw8zJU&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=320x320&quality=95&sign=37a2a53a35d6a2c1451e5ccd524b878c&c_uniq_tag=BX5IGPc0xpKDoYtTPlHGSbIoucM1H2-cpOg_7VQGgAs&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/WiZKcZ4m7Lg.jpg?size=510x510&quality=95&sign=925dbfb3a9b9b85d328880f9342cc7d8&c_uniq_tag=JGGgvPjVHXrx7PgK3FVuk9X1KNeg5skBMMNeSN9fg4s&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "266753958e3c5635cb", + "user_id": 100, + "owner_id": -218861756, + "id": 457239679, + "date": 1708079309, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "4d22638dbca11b42dc", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=75x75&quality=95&sign=b5c353c838e289bf4dfe012e93c8d96f&c_uniq_tag=M99VG2d-cv9h8UPexKNwfDIpFp59CFVbZ5B8ksQLr4I&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=604x604&quality=95&sign=0a958b351a1d2301159c30e4e57f3fd3&c_uniq_tag=02RQFt-o1HuSw8GYCWY_a7STB4ua28_zFb7a4CD5BO8&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=807x807&quality=95&sign=18fd0f4c4d1097074cc761211e5904c7&c_uniq_tag=HS0b1Fur_f2LFs3_NHY8kCaJyQrv11_I6wjaeMYcmA8&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=1024x1024&quality=95&sign=6f59f9c6c1bb8ee0458c9d970a95eb37&c_uniq_tag=9N6uQC5vMHptVulrxwY6a_uJIx3ND4Q65klbzMDGguE&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=130x130&quality=95&sign=4b24ca5c809108db6b21bc3c22d91433&c_uniq_tag=tsVEaIow1-Z7fdq4AQh2LhwdNEX2tGaGrmbY-nU2ztc&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=200x200&quality=95&sign=80a6e97e3262ccc6ff80e30d609b39c8&c_uniq_tag=5fZY8t9mBrikvu-J0q4JkrOg0wHERphSEGIfscG2_t0&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=320x320&quality=95&sign=4bff4c938faaab606aeb85451951a175&c_uniq_tag=-mFXyFqoRGG2T0uDx1ZKZiMrU7vCzIUuzN56k1Xrd7o&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/FuhHZ4B20Po.jpg?size=510x510&quality=95&sign=bcefcff03c4cd3f6ca30f41f6e6f19df&c_uniq_tag=1BHfm_IEucSBPtWGWR-xDhdJ8w5L_tw0Tf3iTj8UixU&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "78ed3a6ff11c40a07c", + "user_id": 100, + "owner_id": -218861756, + "id": 457239680, + "date": 1708079310, + "album_id": -53 + } + ], + "cart_quantity": 0, + "albums_ids": [ + 9 + ], + "weight": 100, + "dimensions": { + "length": 40, + "height": 30, + "width": 20 + }, + "title": "Тестовый товар измененный", + "other_items": [ + { + "item_ids": [ + "-218861756_8655960", + "-218861756_8655800", + "-218861756_8655797", + "-218861756_8653766", + "-218861756_8653760", + "-218861756_8653404", + "-218861756_8653395", + "-218861756_8653393", + "-218861756_8653391", + "-218861756_8653387" + ], + "referrer_item_type": "other_goods", + "view_type": 1, + "title": "Другие товары сообщества" + } + ], + "reposts": { + "count": 0 + }, + "price": { + "old_amount_text": "15 ₽", + "old_amount": "1500", + "discount_rate": -93, + "text": "1 ₽", + "currency": { + "title": "₽", + "name": "RUB", + "id": 643 + }, + "amount": "100" + }, + "can_edit": true, + "owner_id": -218861756, + "can_comment": 1, + "is_adult": false, + "id": 8653408, + "description": "Описание товара", + "owner_info": { + "market_type": "pro", + "category": "Тестовая подборка", + "is_corporated_market": false, + "name": "Test", + "category_url": "/market-218861756?section=album_9", + "avatar": [] + }, + "category": { + "section": { + "name": "Канцелярские товары", + "id": 10016 + }, + "name": "Батарейки", + "id": 20173, + "inner_type": "market_market_category_old" + }, + "promotion": { + "is_available": false + }, + "availability": 0 + } + ] + +``` 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 index cf307fc725..ba8b1b3453 100644 --- a/docs/ru/md/VK/Product-management/Get-products-by-id.md +++ b/docs/ru/md/VK/Product-management/Get-products-by-id.md @@ -1,713 +1,713 @@ ---- -sidebar_position: 3 ---- - -# Получить товары по ID - Получает информацию о товарах по массиву ID - - -*Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товары | --items | Строка, Массив Из Строка | Массив ID товаров | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - МассивТоваров = Новый Массив; - МассивТоваров.Добавить("8656033"); - МассивТоваров.Добавить("8656034"); - - Ответ = OPI_VK.ПолучитьТоварыПоИД(МассивТоваров, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьТоварыПоИД --items %items% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "items": [ - { - "sku": "12 345", - "is_main_variant": true, - "is_owner": true, - "date": 1708170274, - "can_show_convert_to_service": true, - "can_delete": true, - "properties": [ - { - "variants": [ - { - "title": "Желтый (изм.)", - "id": 971 - }, - { - "title": "Синий (изм.)", - "id": 972 - }, - { - "title": "Красный (изм.)", - "id": 973 - } - ], - "type": "text", - "title": "Цвет (изм.)", - "id": 258 - } - ], - "views_count": 0, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=589be01d2fc8e371862518142ccb7462&c_uniq_tag=3UKP-MAlxuqYtgy6jOhFLiWDMayz_V8bqjCYnh35JhM", - "likes": { - "user_likes": 0, - "count": 0 - }, - "can_repost": 1, - "can_recover": false, - "photos": [ - { - "has_tags": false, - "web_view_token": "92862d343958147ed4", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=75x75&quality=95&sign=75b8b9ecc41139c3c1b0d17bbf6e0c32&c_uniq_tag=FXd5BlAEmMnIGfUpqwLUWhaJwb8irsAIJ4-lUHfbZ_E&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=604x604&quality=95&sign=8d173aac7ac1259e516a6d926ce80544&c_uniq_tag=ap7TLKtgI6zBnvGjJaFp_zROOKQiBg6NENjMCk1ZdBc&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=807x807&quality=95&sign=d7536ec7a9f84e511f21182dea67a70a&c_uniq_tag=VIIaPDSt68vRlOqCymz9grEM5RQG1Ocx0wyevX4xb6Q&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=1024x1024&quality=95&sign=106d75b1819f1976d40d66200db9ef8c&c_uniq_tag=Bo7Hk6h0bNaaYET9k36N25VbSyysB6r2RT_66bUW_hs&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=200x200&quality=95&sign=8b70ea4984f97979ce995dd37bcf3133&c_uniq_tag=Y4CfVHj6Hih0lhp8txhKpNhaVSgQnjr7WlH_B01N1EU&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=320x320&quality=95&sign=0a5c91e112ef0c02425bdbf27f2a65a1&c_uniq_tag=V9Q3PNtkF8XD02aYEbvcbny0jrGZ5LUTaanYB5ulArI&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=510x510&quality=95&sign=45b47460e1a4dce2692355265114f996&c_uniq_tag=IuTEvNe-qW6JGpt4guLe2R3vH4l4899EaWrr77ZtQlk&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "66dc21beb4d43f2a3c", - "user_id": 100, - "owner_id": -218861756, - "id": 457239799, - "date": 1708170270, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "a6344b5c5e566b3d0f", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=75x75&quality=95&sign=008ec0a154820e532df70a27551bed4f&c_uniq_tag=V6vBDJlnnQSlWj7dtWCH_i1oXJgW_m1q47Dtgiip_Es&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=604x604&quality=95&sign=458343fa9344319daced2b0996e5ee74&c_uniq_tag=ausjWwNUoPL003iQ4jKsFx_46Hf-lpCcaAOrGXV82cQ&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=807x807&quality=95&sign=487b910daf99d58f09bb84e7f4955e12&c_uniq_tag=pGkpJrVh8zKvIdRG74G9NuXamkrHe25ybGMfmcVGKfk&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=1024x1024&quality=95&sign=db36ba2bdc5176946b44c9d7bddc173b&c_uniq_tag=LupvbVz1DM9ZHGGCd2GWH8rVcanmneNhRvzt_keB_r0&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=200x200&quality=95&sign=92b5fbc6456d64a450f2798d0f4b2907&c_uniq_tag=wilVvQyyONq1VsFP42UIlM6DnUetObxgjPwEOU87bcI&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=320x320&quality=95&sign=6fb75856a87c217c4e033c17ef340c70&c_uniq_tag=gGcnPnWWjfd5zD7qQMhZdDV_BjGWb3vk_p4Q0mXIFlo&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=510x510&quality=95&sign=9f4deabcdf7a1e52128a1cc08b3f51ba&c_uniq_tag=cX_tQwscXoWRbH4WF-rq7EFmr8Sddv_P4JQ7rEzF9Ws&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "306f176545bea47727", - "user_id": 100, - "owner_id": -218861756, - "id": 457239800, - "date": 1708170272, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "0f912989fe5cda4777", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=75x75&quality=95&sign=68afdefe830d4be39b04ba23a61c26ce&c_uniq_tag=Xc5-AjRx8tqr0Zo5pMZ4jIGFgD1YoRU1La4aDMIQEC4&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=604x604&quality=95&sign=79f669caf7b26acfdeed6715c85fe9ed&c_uniq_tag=17W-VKiO2S8SrmCSItPAoWq5PKqcQhHggCVD3jAf6B0&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=807x807&quality=95&sign=3bc1e4917a25c52fb37a821f7c83bf85&c_uniq_tag=P1wmEHLW5WNZhBYfsoKFdKFFWGoVj89Y7v6JmqpcumE&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=1024x1024&quality=95&sign=f7f1d87da40cc7070770d2a2f45f557b&c_uniq_tag=XZ-FwW1W54vlkhc3jVRdBI2xEQ53BSLTyKVPl3RGAXU&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=200x200&quality=95&sign=3e7d2483ff4d3a889cc38eea4727d471&c_uniq_tag=xQQVVr-_nJ8Vxha5_EpmDfTxow2rZM516lXgezq74p8&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=320x320&quality=95&sign=f118def9cbea6e5e4eeb8e33a9d0c0b3&c_uniq_tag=1TTdudzMdBLTi3Jo7BZGXK16S_fIMBxE2zvlYDVrPmc&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=510x510&quality=95&sign=f78d1f8e32dd8d7826749d236165afaf&c_uniq_tag=JwqjdnieaCRm_wk4q3GmzwSiuYuS6Xz0QTjN_ncx7rM&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "fbd338a4c3be88ff3c", - "user_id": 100, - "owner_id": -218861756, - "id": 457239801, - "date": 1708170273, - "album_id": -53 - } - ], - "cart_quantity": 0, - "albums_ids": [], - "weight": 100, - "dimensions": { - "length": 40, - "height": 30, - "width": 20 - }, - "title": "Тестовый товар (Желтый)", - "other_items": [ - { - "item_ids": [ - "-218861756_8656034", - "-218861756_8655800", - "-218861756_8655797", - "-218861756_8653766", - "-218861756_8653760", - "-218861756_8653408", - "-218861756_8653404", - "-218861756_8653395", - "-218861756_8653393", - "-218861756_8653391" - ], - "referrer_item_type": "other_goods", - "view_type": 1, - "title": "Другие товары сообщества" - } - ], - "reposts": { - "count": 0 - }, - "price": { - "old_amount_text": "15 ₽", - "old_amount": "1500", - "discount_rate": -93, - "text": "1 ₽", - "currency": { - "title": "₽", - "name": "RUB", - "id": 643 - }, - "amount": "100" - }, - "can_edit": true, - "can_comment": 1, - "owner_id": -218861756, - "is_adult": false, - "id": 8656033, - "variants_grid": [ - { - "variants": [ - { - "is_selected": true, - "item_id": 8656033, - "name": "Желтый (изм.)", - "variant_id": 971 - } - ], - "type": "text", - "name": "Цвет (изм.)" - } - ], - "description": "Описание товара", - "owner_info": { - "market_type": "pro", - "category": "Батарейки", - "is_corporated_market": false, - "name": "Test", - "category_url": "/market-218861756", - "avatar": [] - }, - "property_values": [ - { - "property_name": "Цвет (изм.)", - "variant_name": "Желтый (изм.)", - "variant_id": 971 - } - ], - "category": { - "section": { - "name": "Канцелярские товары", - "id": 10016 - }, - "name": "Батарейки", - "id": 20173, - "inner_type": "market_market_category_old" - }, - "availability": 0, - "promotion": { - "is_available": true - } - }, - { - "sku": "12 345", - "is_main_variant": true, - "is_owner": true, - "date": 1708170288, - "can_show_convert_to_service": true, - "can_delete": true, - "properties": [ - { - "variants": [ - { - "title": "Желтый (изм.)", - "id": 971 - }, - { - "title": "Синий (изм.)", - "id": 972 - }, - { - "title": "Красный (изм.)", - "id": 973 - } - ], - "type": "text", - "title": "Цвет (изм.)", - "id": 258 - } - ], - "views_count": 0, - "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6fe8502b6de244ccb70eebb1ff4ab23a&c_uniq_tag=Juovt6U5F84vc8uZw_2u5ejCgNGxNqYse3fKfIORYsA", - "likes": { - "user_likes": 0, - "count": 0 - }, - "can_repost": 1, - "can_recover": false, - "photos": [ - { - "has_tags": false, - "web_view_token": "93d071511c9e966e9a", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=75x75&quality=95&sign=dfe0b24adf5f3705cf02a1702f45036b&c_uniq_tag=EQgp0KDeFcPWq8dm6l05egD_z2uHaN-DT8Cr5dQQkBo&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=604x604&quality=95&sign=779f24d1abc0fe24a4a424b7a57bb093&c_uniq_tag=QNmQQTT76Mhu8Oinz-5qrMzwVVwKmJFABeTE9bd-M04&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=807x807&quality=95&sign=68cf71539a9242931d48a0cd0be1a0ce&c_uniq_tag=MQO9LYERwp1e6tS9OJYz-YeyEAoWa4yTD6CX3C_FUzA&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=1024x1024&quality=95&sign=b609734c59b0229115c911fc20f3df2d&c_uniq_tag=bdm1GIOMPi0B6oy29CZnJYw23shE3eghtMSsCI8JYGg&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=200x200&quality=95&sign=c64e879b106ab293043bb60563312cb6&c_uniq_tag=3vfMLZacvzwhJSWS51xEo0DHeRFy6KS_TLPN0xEQWBY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=320x320&quality=95&sign=59810b1b5192658255ab539a40149880&c_uniq_tag=-MpQ7yEq8wm5U6P-GJWHqfOSq6xA8l3czg2ggwlSNnQ&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=510x510&quality=95&sign=36ab4a9f54e0a96f4ea92302e855894d&c_uniq_tag=tHaCIm_9DjSqiDUDZUBe_tjn7zOH5oZfwwpWXYRx_70&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "10037480cb2af9af0d", - "user_id": 100, - "owner_id": -218861756, - "id": 457239802, - "date": 1708170285, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "d1181c5d59752488a2", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=75x75&quality=95&sign=d5cfeb6f122274ca04226d23818c2436&c_uniq_tag=g_yta3-5oqlvRCBKknktnRsJ7lnlP2VnnxLk9cfxkHg&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=604x604&quality=95&sign=3aafaad6b865a4326ebb066c7dd96ffc&c_uniq_tag=ZD3QYn27B-77k_Ky6EvfTkQpWRvvdquZgKq4aWhPc0M&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=807x807&quality=95&sign=9d3a2122bca8a751fdddc22af862740f&c_uniq_tag=OQVkuFFazrrA-5LmkWDdTdsrC6YzHpvFlMjXZNcKa8A&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=1024x1024&quality=95&sign=f00777c18a9e2a8690abec2518459c85&c_uniq_tag=oa7b3R9OPg0LGnMZwVd5tkmRQtFZ97uuCkmOdIPgxNQ&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=200x200&quality=95&sign=19663322aa62b505f4204c27d75304cd&c_uniq_tag=ZIEbwDmIZR-vEFRWjmw-Qp_PSX7EacMIEG9PF7GpBEs&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=320x320&quality=95&sign=454278ef305df41f60bbd66588e235da&c_uniq_tag=ZJhu-b2l8_3WCJlFirFZQxoVgtsaLK65yW0mvx8J08A&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=510x510&quality=95&sign=8de646064ff8be8c896b90dc2f773722&c_uniq_tag=VpnbvqL0oDTt2ZKV-irlb2RpQv229T-EHaeIyVS5Vpc&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "f3a1fb96168aea29f8", - "user_id": 100, - "owner_id": -218861756, - "id": 457239803, - "date": 1708170287, - "album_id": -53 - }, - { - "has_tags": false, - "web_view_token": "81fb7553b335d5b014", - "text": "", - "sizes": [ - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=75x75&quality=95&sign=6ecdc8b90775ddf376b0b8188dbffe92&c_uniq_tag=swVsbxdS4C74XKjml3-ZfJyK2APAKb5zukLSREgvgPA&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=604x604&quality=95&sign=e15ba3df9b63bd7c793cd9fb12a08539&c_uniq_tag=i7wKGLU0jk2qPnzhl4ah1EuupPe7-XeFPRs8krcbzr4&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=807x807&quality=95&sign=6ce24dc60c88b14dd50f72b157ecb68d&c_uniq_tag=4GU58hsK_GvHsoc9_SzqN2EdgRu8arCCOqIqJ8TxErI&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=1024x1024&quality=95&sign=93706c2f263ea67b93a17dcb0c1a03d9&c_uniq_tag=w8oS3d2yXrNChsDA1g5jcyJmihuegLAmiNUkIwTEcfI&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=200x200&quality=95&sign=bd9d8e4629660da0502be09ecbf30c0c&c_uniq_tag=SH9RVt_MXCjYWtCw68wDIz7ILMHO3QMF4t8GWvtA7qY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=320x320&quality=95&sign=513e44d6745d2dcf3134e0518584841d&c_uniq_tag=60HVud6C_z47D5l2delWwgf0ghIvEaFfvA5s1_MoPWE&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=510x510&quality=95&sign=13e3f25a80b3c8e332bd8f9d0abde28c&c_uniq_tag=TTjqylVQf7Wgu03X6HCu1TqVTy07G11FecGeXsiZUbk&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "access_key": "4aa836406d898be665", - "user_id": 100, - "owner_id": -218861756, - "id": 457239804, - "date": 1708170288, - "album_id": -53 - } - ], - "cart_quantity": 0, - "albums_ids": [], - "weight": 100, - "dimensions": { - "length": 40, - "height": 30, - "width": 20 - }, - "title": "Тестовый товар (Красный)", - "other_items": [ - { - "item_ids": [ - "-218861756_8656033", - "-218861756_8655800", - "-218861756_8655797", - "-218861756_8653766", - "-218861756_8653760", - "-218861756_8653408", - "-218861756_8653404", - "-218861756_8653395", - "-218861756_8653393", - "-218861756_8653391" - ], - "referrer_item_type": "other_goods", - "view_type": 1, - "title": "Другие товары сообщества" - } - ], - "reposts": { - "count": 0 - }, - "price": { - "old_amount_text": "15 ₽", - "old_amount": "1500", - "discount_rate": -93, - "text": "1 ₽", - "currency": { - "title": "₽", - "name": "RUB", - "id": 643 - }, - "amount": "100" - }, - "can_edit": true, - "can_comment": 1, - "owner_id": -218861756, - "is_adult": false, - "id": 8656034, - "variants_grid": [ - { - "variants": [ - { - "is_selected": true, - "item_id": 8656034, - "name": "Красный (изм.)", - "variant_id": 973 - } - ], - "type": "text", - "name": "Цвет (изм.)" - } - ], - "description": "Описание товара", - "owner_info": { - "market_type": "pro", - "category": "Батарейки", - "is_corporated_market": false, - "name": "Test", - "category_url": "/market-218861756", - "avatar": [] - }, - "property_values": [ - { - "property_name": "Цвет (изм.)", - "variant_name": "Красный (изм.)", - "variant_id": 973 - } - ], - "category": { - "section": { - "name": "Канцелярские товары", - "id": 10016 - }, - "name": "Батарейки", - "id": 20173, - "inner_type": "market_market_category_old" - }, - "availability": 0, - "promotion": { - "is_available": true - } - } - ], - "count": 2 - } - } - -``` +--- +sidebar_position: 3 +--- + +# Получить товары по ID + Получает информацию о товарах по массиву ID + + +*Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товары | --items | Строка, Массив Из Строка | Массив ID товаров | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + МассивТоваров = Новый Массив; + МассивТоваров.Добавить("8656033"); + МассивТоваров.Добавить("8656034"); + + Ответ = OPI_VK.ПолучитьТоварыПоИД(МассивТоваров, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьТоварыПоИД --items %items% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "items": [ + { + "sku": "12 345", + "is_main_variant": true, + "is_owner": true, + "date": 1708170274, + "can_show_convert_to_service": true, + "can_delete": true, + "properties": [ + { + "variants": [ + { + "title": "Желтый (изм.)", + "id": 971 + }, + { + "title": "Синий (изм.)", + "id": 972 + }, + { + "title": "Красный (изм.)", + "id": 973 + } + ], + "type": "text", + "title": "Цвет (изм.)", + "id": 258 + } + ], + "views_count": 0, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=589be01d2fc8e371862518142ccb7462&c_uniq_tag=3UKP-MAlxuqYtgy6jOhFLiWDMayz_V8bqjCYnh35JhM", + "likes": { + "user_likes": 0, + "count": 0 + }, + "can_repost": 1, + "can_recover": false, + "photos": [ + { + "has_tags": false, + "web_view_token": "92862d343958147ed4", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=75x75&quality=95&sign=75b8b9ecc41139c3c1b0d17bbf6e0c32&c_uniq_tag=FXd5BlAEmMnIGfUpqwLUWhaJwb8irsAIJ4-lUHfbZ_E&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=604x604&quality=95&sign=8d173aac7ac1259e516a6d926ce80544&c_uniq_tag=ap7TLKtgI6zBnvGjJaFp_zROOKQiBg6NENjMCk1ZdBc&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=807x807&quality=95&sign=d7536ec7a9f84e511f21182dea67a70a&c_uniq_tag=VIIaPDSt68vRlOqCymz9grEM5RQG1Ocx0wyevX4xb6Q&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=1024x1024&quality=95&sign=106d75b1819f1976d40d66200db9ef8c&c_uniq_tag=Bo7Hk6h0bNaaYET9k36N25VbSyysB6r2RT_66bUW_hs&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=130x130&quality=95&sign=70543f236ac062f0010f885208bc55b6&c_uniq_tag=RIT_VUoSuci5B2h1VizCJyAlynAAD8GjsNsXcM225qc&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=200x200&quality=95&sign=8b70ea4984f97979ce995dd37bcf3133&c_uniq_tag=Y4CfVHj6Hih0lhp8txhKpNhaVSgQnjr7WlH_B01N1EU&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=320x320&quality=95&sign=0a5c91e112ef0c02425bdbf27f2a65a1&c_uniq_tag=V9Q3PNtkF8XD02aYEbvcbny0jrGZ5LUTaanYB5ulArI&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/_s-jhmAAmOs.jpg?size=510x510&quality=95&sign=45b47460e1a4dce2692355265114f996&c_uniq_tag=IuTEvNe-qW6JGpt4guLe2R3vH4l4899EaWrr77ZtQlk&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "66dc21beb4d43f2a3c", + "user_id": 100, + "owner_id": -218861756, + "id": 457239799, + "date": 1708170270, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "a6344b5c5e566b3d0f", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=75x75&quality=95&sign=008ec0a154820e532df70a27551bed4f&c_uniq_tag=V6vBDJlnnQSlWj7dtWCH_i1oXJgW_m1q47Dtgiip_Es&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=604x604&quality=95&sign=458343fa9344319daced2b0996e5ee74&c_uniq_tag=ausjWwNUoPL003iQ4jKsFx_46Hf-lpCcaAOrGXV82cQ&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=807x807&quality=95&sign=487b910daf99d58f09bb84e7f4955e12&c_uniq_tag=pGkpJrVh8zKvIdRG74G9NuXamkrHe25ybGMfmcVGKfk&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=1024x1024&quality=95&sign=db36ba2bdc5176946b44c9d7bddc173b&c_uniq_tag=LupvbVz1DM9ZHGGCd2GWH8rVcanmneNhRvzt_keB_r0&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=130x130&quality=95&sign=5249e2e00c2a3cd91c46f9c0d6c87108&c_uniq_tag=o3riwc5uwsy0Od6lw80XJzs1d7UP0WXQA0zjNuKJtjo&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=200x200&quality=95&sign=92b5fbc6456d64a450f2798d0f4b2907&c_uniq_tag=wilVvQyyONq1VsFP42UIlM6DnUetObxgjPwEOU87bcI&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=320x320&quality=95&sign=6fb75856a87c217c4e033c17ef340c70&c_uniq_tag=gGcnPnWWjfd5zD7qQMhZdDV_BjGWb3vk_p4Q0mXIFlo&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/jVXnxHBkfM4.jpg?size=510x510&quality=95&sign=9f4deabcdf7a1e52128a1cc08b3f51ba&c_uniq_tag=cX_tQwscXoWRbH4WF-rq7EFmr8Sddv_P4JQ7rEzF9Ws&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "306f176545bea47727", + "user_id": 100, + "owner_id": -218861756, + "id": 457239800, + "date": 1708170272, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "0f912989fe5cda4777", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=75x75&quality=95&sign=68afdefe830d4be39b04ba23a61c26ce&c_uniq_tag=Xc5-AjRx8tqr0Zo5pMZ4jIGFgD1YoRU1La4aDMIQEC4&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=604x604&quality=95&sign=79f669caf7b26acfdeed6715c85fe9ed&c_uniq_tag=17W-VKiO2S8SrmCSItPAoWq5PKqcQhHggCVD3jAf6B0&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=807x807&quality=95&sign=3bc1e4917a25c52fb37a821f7c83bf85&c_uniq_tag=P1wmEHLW5WNZhBYfsoKFdKFFWGoVj89Y7v6JmqpcumE&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=1024x1024&quality=95&sign=f7f1d87da40cc7070770d2a2f45f557b&c_uniq_tag=XZ-FwW1W54vlkhc3jVRdBI2xEQ53BSLTyKVPl3RGAXU&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=130x130&quality=95&sign=82e01ddf5fa7dc6a8cdbadf254759259&c_uniq_tag=ZzK-w6E9jC_DsexMRVdZDE5egemG8PDAjKoZygNLKr0&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=200x200&quality=95&sign=3e7d2483ff4d3a889cc38eea4727d471&c_uniq_tag=xQQVVr-_nJ8Vxha5_EpmDfTxow2rZM516lXgezq74p8&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=320x320&quality=95&sign=f118def9cbea6e5e4eeb8e33a9d0c0b3&c_uniq_tag=1TTdudzMdBLTi3Jo7BZGXK16S_fIMBxE2zvlYDVrPmc&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/F5zJCyhU2K8.jpg?size=510x510&quality=95&sign=f78d1f8e32dd8d7826749d236165afaf&c_uniq_tag=JwqjdnieaCRm_wk4q3GmzwSiuYuS6Xz0QTjN_ncx7rM&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "fbd338a4c3be88ff3c", + "user_id": 100, + "owner_id": -218861756, + "id": 457239801, + "date": 1708170273, + "album_id": -53 + } + ], + "cart_quantity": 0, + "albums_ids": [], + "weight": 100, + "dimensions": { + "length": 40, + "height": 30, + "width": 20 + }, + "title": "Тестовый товар (Желтый)", + "other_items": [ + { + "item_ids": [ + "-218861756_8656034", + "-218861756_8655800", + "-218861756_8655797", + "-218861756_8653766", + "-218861756_8653760", + "-218861756_8653408", + "-218861756_8653404", + "-218861756_8653395", + "-218861756_8653393", + "-218861756_8653391" + ], + "referrer_item_type": "other_goods", + "view_type": 1, + "title": "Другие товары сообщества" + } + ], + "reposts": { + "count": 0 + }, + "price": { + "old_amount_text": "15 ₽", + "old_amount": "1500", + "discount_rate": -93, + "text": "1 ₽", + "currency": { + "title": "₽", + "name": "RUB", + "id": 643 + }, + "amount": "100" + }, + "can_edit": true, + "can_comment": 1, + "owner_id": -218861756, + "is_adult": false, + "id": 8656033, + "variants_grid": [ + { + "variants": [ + { + "is_selected": true, + "item_id": 8656033, + "name": "Желтый (изм.)", + "variant_id": 971 + } + ], + "type": "text", + "name": "Цвет (изм.)" + } + ], + "description": "Описание товара", + "owner_info": { + "market_type": "pro", + "category": "Батарейки", + "is_corporated_market": false, + "name": "Test", + "category_url": "/market-218861756", + "avatar": [] + }, + "property_values": [ + { + "property_name": "Цвет (изм.)", + "variant_name": "Желтый (изм.)", + "variant_id": 971 + } + ], + "category": { + "section": { + "name": "Канцелярские товары", + "id": 10016 + }, + "name": "Батарейки", + "id": 20173, + "inner_type": "market_market_category_old" + }, + "availability": 0, + "promotion": { + "is_available": true + } + }, + { + "sku": "12 345", + "is_main_variant": true, + "is_owner": true, + "date": 1708170288, + "can_show_convert_to_service": true, + "can_delete": true, + "properties": [ + { + "variants": [ + { + "title": "Желтый (изм.)", + "id": 971 + }, + { + "title": "Синий (изм.)", + "id": 972 + }, + { + "title": "Красный (изм.)", + "id": 973 + } + ], + "type": "text", + "title": "Цвет (изм.)", + "id": 258 + } + ], + "views_count": 0, + "thumb_photo": "https://sun56-2.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?crop=0,0,1,1&size=0x400&quality=95&sign=6fe8502b6de244ccb70eebb1ff4ab23a&c_uniq_tag=Juovt6U5F84vc8uZw_2u5ejCgNGxNqYse3fKfIORYsA", + "likes": { + "user_likes": 0, + "count": 0 + }, + "can_repost": 1, + "can_recover": false, + "photos": [ + { + "has_tags": false, + "web_view_token": "93d071511c9e966e9a", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=75x75&quality=95&sign=dfe0b24adf5f3705cf02a1702f45036b&c_uniq_tag=EQgp0KDeFcPWq8dm6l05egD_z2uHaN-DT8Cr5dQQkBo&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=604x604&quality=95&sign=779f24d1abc0fe24a4a424b7a57bb093&c_uniq_tag=QNmQQTT76Mhu8Oinz-5qrMzwVVwKmJFABeTE9bd-M04&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=807x807&quality=95&sign=68cf71539a9242931d48a0cd0be1a0ce&c_uniq_tag=MQO9LYERwp1e6tS9OJYz-YeyEAoWa4yTD6CX3C_FUzA&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=1024x1024&quality=95&sign=b609734c59b0229115c911fc20f3df2d&c_uniq_tag=bdm1GIOMPi0B6oy29CZnJYw23shE3eghtMSsCI8JYGg&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=130x130&quality=95&sign=29176aff6558e2a971556b274d6e62e8&c_uniq_tag=1GLs-TDaHQLExpYAtCfuXfgVLEM4Y9lAFZAQfSar204&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=200x200&quality=95&sign=c64e879b106ab293043bb60563312cb6&c_uniq_tag=3vfMLZacvzwhJSWS51xEo0DHeRFy6KS_TLPN0xEQWBY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=320x320&quality=95&sign=59810b1b5192658255ab539a40149880&c_uniq_tag=-MpQ7yEq8wm5U6P-GJWHqfOSq6xA8l3czg2ggwlSNnQ&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/e3aoPo9yc_M.jpg?size=510x510&quality=95&sign=36ab4a9f54e0a96f4ea92302e855894d&c_uniq_tag=tHaCIm_9DjSqiDUDZUBe_tjn7zOH5oZfwwpWXYRx_70&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "10037480cb2af9af0d", + "user_id": 100, + "owner_id": -218861756, + "id": 457239802, + "date": 1708170285, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "d1181c5d59752488a2", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=75x75&quality=95&sign=d5cfeb6f122274ca04226d23818c2436&c_uniq_tag=g_yta3-5oqlvRCBKknktnRsJ7lnlP2VnnxLk9cfxkHg&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=604x604&quality=95&sign=3aafaad6b865a4326ebb066c7dd96ffc&c_uniq_tag=ZD3QYn27B-77k_Ky6EvfTkQpWRvvdquZgKq4aWhPc0M&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=807x807&quality=95&sign=9d3a2122bca8a751fdddc22af862740f&c_uniq_tag=OQVkuFFazrrA-5LmkWDdTdsrC6YzHpvFlMjXZNcKa8A&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=1024x1024&quality=95&sign=f00777c18a9e2a8690abec2518459c85&c_uniq_tag=oa7b3R9OPg0LGnMZwVd5tkmRQtFZ97uuCkmOdIPgxNQ&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=130x130&quality=95&sign=ddd0426be9fa770ee416d091e1d5db3d&c_uniq_tag=DyZ9sA4W6WwLKeSGRj3G1Bitoz5G2-Y6AVt7sh8XN2o&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=200x200&quality=95&sign=19663322aa62b505f4204c27d75304cd&c_uniq_tag=ZIEbwDmIZR-vEFRWjmw-Qp_PSX7EacMIEG9PF7GpBEs&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=320x320&quality=95&sign=454278ef305df41f60bbd66588e235da&c_uniq_tag=ZJhu-b2l8_3WCJlFirFZQxoVgtsaLK65yW0mvx8J08A&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/mv73TKmJ_FU.jpg?size=510x510&quality=95&sign=8de646064ff8be8c896b90dc2f773722&c_uniq_tag=VpnbvqL0oDTt2ZKV-irlb2RpQv229T-EHaeIyVS5Vpc&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "f3a1fb96168aea29f8", + "user_id": 100, + "owner_id": -218861756, + "id": 457239803, + "date": 1708170287, + "album_id": -53 + }, + { + "has_tags": false, + "web_view_token": "81fb7553b335d5b014", + "text": "", + "sizes": [ + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=75x75&quality=95&sign=6ecdc8b90775ddf376b0b8188dbffe92&c_uniq_tag=swVsbxdS4C74XKjml3-ZfJyK2APAKb5zukLSREgvgPA&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=604x604&quality=95&sign=e15ba3df9b63bd7c793cd9fb12a08539&c_uniq_tag=i7wKGLU0jk2qPnzhl4ah1EuupPe7-XeFPRs8krcbzr4&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=807x807&quality=95&sign=6ce24dc60c88b14dd50f72b157ecb68d&c_uniq_tag=4GU58hsK_GvHsoc9_SzqN2EdgRu8arCCOqIqJ8TxErI&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=1024x1024&quality=95&sign=93706c2f263ea67b93a17dcb0c1a03d9&c_uniq_tag=w8oS3d2yXrNChsDA1g5jcyJmihuegLAmiNUkIwTEcfI&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=130x130&quality=95&sign=4abcfb7fae4b783eadb29abd35d02025&c_uniq_tag=5C_zLY9QatErqJsBEuM-v8jfSUp1DeDwx15ag_gZAcE&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=200x200&quality=95&sign=bd9d8e4629660da0502be09ecbf30c0c&c_uniq_tag=SH9RVt_MXCjYWtCw68wDIz7ILMHO3QMF4t8GWvtA7qY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=320x320&quality=95&sign=513e44d6745d2dcf3134e0518584841d&c_uniq_tag=60HVud6C_z47D5l2delWwgf0ghIvEaFfvA5s1_MoPWE&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-32.userapi.com/impg/XRrzu8dbsPmwF35EnWBibiQ-Sgo7O5rgWY4fUg/6Dbk6jKbWh4.jpg?size=510x510&quality=95&sign=13e3f25a80b3c8e332bd8f9d0abde28c&c_uniq_tag=TTjqylVQf7Wgu03X6HCu1TqVTy07G11FecGeXsiZUbk&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "access_key": "4aa836406d898be665", + "user_id": 100, + "owner_id": -218861756, + "id": 457239804, + "date": 1708170288, + "album_id": -53 + } + ], + "cart_quantity": 0, + "albums_ids": [], + "weight": 100, + "dimensions": { + "length": 40, + "height": 30, + "width": 20 + }, + "title": "Тестовый товар (Красный)", + "other_items": [ + { + "item_ids": [ + "-218861756_8656033", + "-218861756_8655800", + "-218861756_8655797", + "-218861756_8653766", + "-218861756_8653760", + "-218861756_8653408", + "-218861756_8653404", + "-218861756_8653395", + "-218861756_8653393", + "-218861756_8653391" + ], + "referrer_item_type": "other_goods", + "view_type": 1, + "title": "Другие товары сообщества" + } + ], + "reposts": { + "count": 0 + }, + "price": { + "old_amount_text": "15 ₽", + "old_amount": "1500", + "discount_rate": -93, + "text": "1 ₽", + "currency": { + "title": "₽", + "name": "RUB", + "id": 643 + }, + "amount": "100" + }, + "can_edit": true, + "can_comment": 1, + "owner_id": -218861756, + "is_adult": false, + "id": 8656034, + "variants_grid": [ + { + "variants": [ + { + "is_selected": true, + "item_id": 8656034, + "name": "Красный (изм.)", + "variant_id": 973 + } + ], + "type": "text", + "name": "Цвет (изм.)" + } + ], + "description": "Описание товара", + "owner_info": { + "market_type": "pro", + "category": "Батарейки", + "is_corporated_market": false, + "name": "Test", + "category_url": "/market-218861756", + "avatar": [] + }, + "property_values": [ + { + "property_name": "Цвет (изм.)", + "variant_name": "Красный (изм.)", + "variant_id": 973 + } + ], + "category": { + "section": { + "name": "Канцелярские товары", + "id": 10016 + }, + "name": "Батарейки", + "id": 20173, + "inner_type": "market_market_category_old" + }, + "availability": 0, + "promotion": { + "is_available": true + } + } + ], + "count": 2 + } + } + +``` diff --git a/docs/ru/md/VK/Product-management/Group-products.md b/docs/ru/md/VK/Product-management/Group-products.md index d2e70f23ab..ec565a66c1 100644 --- a/docs/ru/md/VK/Product-management/Group-products.md +++ b/docs/ru/md/VK/Product-management/Group-products.md @@ -1,50 +1,50 @@ ---- -sidebar_position: 7 ---- - -# Сгруппировать товары - Группирует товары на основе одинаковых наборов свойств - - -*Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивТоваров | --items | Массив Из Строка | Массив ID товаров | - | СуществующаяГруппа | --sellgroup | Строка | ID существующей группы, если необходимо | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - МассивТоваров = Новый Массив; - МассивТоваров.Добавить(ИДЖелтогоТовара); - МассивТоваров.Добавить(ИДКрасногоТовара); - - Ответ = OPI_VK.СгруппироватьТовары(МассивТоваров, , Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СгруппироватьТовары --items %items% --sellgroup %sellgroup% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "item_group_id": 5957 - } - } - -``` +--- +sidebar_position: 7 +--- + +# Сгруппировать товары + Группирует товары на основе одинаковых наборов свойств + + +*Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив Из Строка | Массив ID товаров | + | СуществующаяГруппа | --sellgroup | Строка | ID существующей группы, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + МассивТоваров = Новый Массив; + МассивТоваров.Добавить(ИДЖелтогоТовара); + МассивТоваров.Добавить(ИДКрасногоТовара); + + Ответ = OPI_VK.СгруппироватьТовары(МассивТоваров, , Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СгруппироватьТовары --items %items% --sellgroup %sellgroup% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "item_group_id": 5957 + } + } + +``` 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 index 60c42dd29b..d1d7a57017 100644 --- 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 @@ -1,46 +1,46 @@ ---- -sidebar_position: 5 ---- - -# Добавить вариант свойства товара - Добавляет вариант для существующего свойства - - -*Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Значение | --value | Строка | Значение свойства | - | Свойство | --prop | Строка,Число | ID свойства, куда добавляется вариант | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ДобавитьВариантСвойстваТовара("Красный", 260, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ДобавитьВариантСвойстваТовара --value %value% --prop %prop% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "variant_id": 980 - } - } - -``` +--- +sidebar_position: 5 +--- + +# Добавить вариант свойства товара + Добавляет вариант для существующего свойства + + +*Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Значение | --value | Строка | Значение свойства | + | Свойство | --prop | Строка,Число | ID свойства, куда добавляется вариант | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ДобавитьВариантСвойстваТовара("Красный", 260, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ДобавитьВариантСвойстваТовара --value %value% --prop %prop% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "variant_id": 980 + } + } + +``` 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 index dfa97c283c..9ce9ea40b6 100644 --- a/docs/ru/md/VK/Product-properties-management/Create-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Create-product-property.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 2 ---- - -# Создать свойство товара - Создает новое свойство для использования в товарах - - -*Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Название свойства | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.СоздатьСвойствоТовара("Цвет", Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьСвойствоТовара --title %title% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "property_id": 260 - } - } - -``` +--- +sidebar_position: 2 +--- + +# Создать свойство товара + Создает новое свойство для использования в товарах + + +*Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Название свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.СоздатьСвойствоТовара("Цвет", Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьСвойствоТовара --title %title% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "property_id": 260 + } + } + +``` 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 index 23fcb4f35c..866264022c 100644 --- 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 @@ -1,43 +1,43 @@ ---- -sidebar_position: 7 ---- - -# Удалить вариант свойства товара - Удаляет ранее созданный вариант свойства - - -*Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Вариант | --option | Строка,Число | ID варианта | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.УдалитьВариантСвойстваТовара(980 Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьВариантСвойстваТовара --option %option% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 7 +--- + +# Удалить вариант свойства товара + Удаляет ранее созданный вариант свойства + + +*Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Вариант | --option | Строка,Число | ID варианта | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.УдалитьВариантСвойстваТовара(980 Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьВариантСвойстваТовара --option %option% --auth %auth% + + +``` + + +```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 index fd67ded2d7..25ff00eaab 100644 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 4 ---- - -# Удалить свойство товара - Удаляет существующее свойство товара - - -*Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Свойство | --prop | Строка,Число | ID свойства | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.УдалитьСвойствоТовара(260, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьСвойствоТовара --prop %prop% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 4 +--- + +# Удалить свойство товара + Удаляет существующее свойство товара + + +*Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Свойство | --prop | Строка,Число | ID свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.УдалитьСвойствоТовара(260, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьСвойствоТовара --prop %prop% --auth %auth% + + +``` + + +```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 index 27ed178c96..93747897a6 100644 --- 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 @@ -1,45 +1,45 @@ ---- -sidebar_position: 6 ---- - -# Изменить вариант свойства товара - Изменяет значение варианта существующего свойства товара - - -*Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Значение | --value | Строка | Новое значение свойства | - | Свойство | --prop | Строка,Число | ID свойства | - | Вариант | --option | Строка,Число | ID варианта | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ИзменитьВариантСвойстваТовара("Желтый", 260, 980 Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ИзменитьВариантСвойстваТовара --value %value% --prop %prop% --option %option% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 6 +--- + +# Изменить вариант свойства товара + Изменяет значение варианта существующего свойства товара + + +*Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Значение | --value | Строка | Новое значение свойства | + | Свойство | --prop | Строка,Число | ID свойства | + | Вариант | --option | Строка,Число | ID варианта | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ИзменитьВариантСвойстваТовара("Желтый", 260, 980 Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ИзменитьВариантСвойстваТовара --value %value% --prop %prop% --option %option% --auth %auth% + + +``` + + +```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 index 9ef10e934b..e4c1b33bbf 100644 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 3 ---- - -# Изменить свойство товара - Изменяет существующее свойство товара - - -*Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Новое название | - | Свойство | --prop | Строка,Число | ID свойства | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ИзменитьСвойствоТовара("Цвет (изм.)", Свойство, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ИзменитьСвойствоТовара --title %title% --prop %prop% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 3 +--- + +# Изменить свойство товара + Изменяет существующее свойство товара + + +*Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Новое название | + | Свойство | --prop | Строка,Число | ID свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ИзменитьСвойствоТовара("Цвет (изм.)", Свойство, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ИзменитьСвойствоТовара --title %title% --prop %prop% --auth %auth% + + +``` + + +```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 index bf721ef637..ac7a8c44e7 100644 --- a/docs/ru/md/VK/Product-properties-management/Get-property-list.md +++ b/docs/ru/md/VK/Product-properties-management/Get-property-list.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 1 ---- - -# Получить список свойств - Получает список свойств товаров группы - - -*Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьСписокСвойств(Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСписокСвойств --auth %auth% - - -``` - - -```json title="Результат" - -[ - { - "variants": [ - { - "title": "Желтый", - "id": 962 - }, - { - "title": "Синий", - "id": 963 - }, - { - "title": "Красный", - "id": 964 - } - ], - "type": "text", - "title": "Цвет", - "id": 255 - } - ] - -``` +--- +sidebar_position: 1 +--- + +# Получить список свойств + Получает список свойств товаров группы + + +*Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьСписокСвойств(Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСписокСвойств --auth %auth% + + +``` + + +```json title="Результат" + +[ + { + "variants": [ + { + "title": "Желтый", + "id": 962 + }, + { + "title": "Синий", + "id": 963 + }, + { + "title": "Красный", + "id": 964 + } + ], + "type": "text", + "title": "Цвет", + "id": 255 + } + ] + +``` diff --git a/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md b/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md index 10f819ef23..638c085695 100644 --- a/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md +++ b/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md @@ -1,44 +1,44 @@ ---- -sidebar_position: 5 ---- - -# Добавить товар в подборку - Добавляет товар в подборку - - -*Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ДобавитьТоварВПодборку(8656559, 40, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ДобавитьТоварВПодборку --items %items% --sel %sel% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 5 +--- + +# Добавить товар в подборку + Добавляет товар в подборку + + +*Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ДобавитьТоварВПодборку(8656559, 40, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ДобавитьТоварВПодборку --items %items% --sel %sel% --auth %auth% + + +``` + + +```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 index d0cdc4b01e..f048c13d72 100644 --- a/docs/ru/md/VK/Product-selection-management/Create-product-collection.md +++ b/docs/ru/md/VK/Product-selection-management/Create-product-collection.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 3 ---- - -# Создать подборку товаров - Создает пустую подборку товаров - - -*Функция СоздатьПодборкуТоваров(Знач Название, Знач Картинка, Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Название подборки | - | Картинка | --picture | Строка,ДвоичныеДанные | Файл картинки | - | Основная | --main | Булево | Основная | - | Скрытая | --hidden | Булево | Скрытая | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.СоздатьПодборкуТоваров("Тестовая подборка" - , Картинка - , Истина - , Ложь - , Параметры); - - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьПодборкуТоваров --title %title% --picture %picture% --main %main% --hidden %hidden% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": { - "albums_count": 23, - "market_album_id": 39 - } - } - -``` +--- +sidebar_position: 3 +--- + +# Создать подборку товаров + Создает пустую подборку товаров + + +*Функция СоздатьПодборкуТоваров(Знач Название, Знач Картинка, Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Название подборки | + | Картинка | --picture | Строка,ДвоичныеДанные | Файл картинки | + | Основная | --main | Булево | Основная | + | Скрытая | --hidden | Булево | Скрытая | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.СоздатьПодборкуТоваров("Тестовая подборка" + , Картинка + , Истина + , Ложь + , Параметры); + + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьПодборкуТоваров --title %title% --picture %picture% --main %main% --hidden %hidden% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": { + "albums_count": 23, + "market_album_id": 39 + } + } + +``` diff --git a/docs/ru/md/VK/Product-selection-management/Delete-selection.md b/docs/ru/md/VK/Product-selection-management/Delete-selection.md index c85ffb018b..ce2418774c 100644 --- a/docs/ru/md/VK/Product-selection-management/Delete-selection.md +++ b/docs/ru/md/VK/Product-selection-management/Delete-selection.md @@ -1,43 +1,43 @@ ---- -sidebar_position: 7 ---- - -# Удалить подборку - Удаляет подборку по ID - - -*Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.УдалитьПодборку(40, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьПодборку --sel %sel% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 7 +--- + +# Удалить подборку + Удаляет подборку по ID + + +*Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.УдалитьПодборку(40, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьПодборку --sel %sel% --auth %auth% + + +``` + + +```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 index 074f5791d9..65fab895bc 100644 --- a/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md +++ b/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 4 ---- - -# Изменить подборку товаров - Изменяет свойства подборки товаров - - -*Функция ИзменитьПодборкуТоваров(Знач Название, Знач Подборка, Знач Картинка = "", Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Название | --title | Строка | Новое название подборки | - | Подборка | --sel | Строка | ID подборки | - | Картинка | --picture | Строка,ДвоичныеДанные | Новая картинка подборки | - | Основная | --main | Булево | Основная | - | Скрытая | --hidden | Булево | Скрытая | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ИзменитьПодборкуТоваров("Измененная подборка" - , 40 - , Картинка - , Истина - , Ложь - , Параметры); - - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ИзменитьПодборкуТоваров --title %title% --sel %sel% --picture %picture% --main %main% --hidden %hidden% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 4 +--- + +# Изменить подборку товаров + Изменяет свойства подборки товаров + + +*Функция ИзменитьПодборкуТоваров(Знач Название, Знач Подборка, Знач Картинка = "", Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Новое название подборки | + | Подборка | --sel | Строка | ID подборки | + | Картинка | --picture | Строка,ДвоичныеДанные | Новая картинка подборки | + | Основная | --main | Булево | Основная | + | Скрытая | --hidden | Булево | Скрытая | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ИзменитьПодборкуТоваров("Измененная подборка" + , 40 + , Картинка + , Истина + , Ложь + , Параметры); + + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ИзменитьПодборкуТоваров --title %title% --sel %sel% --picture %picture% --main %main% --hidden %hidden% --auth %auth% + + +``` + + +```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 index 1b882f1e50..a6df0d97b2 100644 --- a/docs/ru/md/VK/Product-selection-management/Get-selection-list.md +++ b/docs/ru/md/VK/Product-selection-management/Get-selection-list.md @@ -1,116 +1,116 @@ ---- -sidebar_position: 1 ---- - -# Получить список подборок - Получает список подборок товаров - - -*Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий подборок - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьСписокПодборок(Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСписокПодборок --auth %auth% - - -``` - - -```json title="Результат" - -[ - { - "is_hidden": false, - "is_main": true, - "photo": { - "has_tags": false, - "web_view_token": "6e66fabe30412b7a20", - "text": "", - "sizes": [ - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "user_id": 100, - "owner_id": -218861756, - "id": 457239823, - "date": 1708173749, - "album_id": -53 - }, - "count": 0, - "title": "Тестовая подборка", - "updated_time": 1708173749, - "owner_id": -218861756, - "id": 38 - } - ] - -``` +--- +sidebar_position: 1 +--- + +# Получить список подборок + Получает список подборок товаров + + +*Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий подборок + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьСписокПодборок(Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСписокПодборок --auth %auth% + + +``` + + +```json title="Результат" + +[ + { + "is_hidden": false, + "is_main": true, + "photo": { + "has_tags": false, + "web_view_token": "6e66fabe30412b7a20", + "text": "", + "sizes": [ + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "user_id": 100, + "owner_id": -218861756, + "id": 457239823, + "date": 1708173749, + "album_id": -53 + }, + "count": 0, + "title": "Тестовая подборка", + "updated_time": 1708173749, + "owner_id": -218861756, + "id": 38 + } + ] + +``` 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 index db9d66243c..536b63e2f3 100644 --- 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 @@ -1,117 +1,117 @@ ---- -sidebar_position: 2 ---- - -# Получить подборки по ID - Получить список подборок по массиву ID - - -*Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Подборки | --sels | Строка, Массив Из Строка | ID подборок | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьПодборкиПоИД(Подборки, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьПодборкиПоИД --sels %sels% --auth %auth% - - -``` - - -```json title="Результат" - -[ - { - "is_hidden": false, - "is_main": true, - "photo": { - "has_tags": false, - "web_view_token": "6e66fabe30412b7a20", - "text": "", - "sizes": [ - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", - "width": 75, - "type": "s", - "height": 75 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "m", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", - "width": 604, - "type": "x", - "height": 604 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", - "width": 807, - "type": "y", - "height": 807 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", - "width": 1024, - "type": "z", - "height": 1024 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", - "width": 130, - "type": "o", - "height": 130 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", - "width": 200, - "type": "p", - "height": 200 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", - "width": 320, - "type": "q", - "height": 320 - }, - { - "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", - "width": 510, - "type": "r", - "height": 510 - } - ], - "user_id": 100, - "owner_id": -218861756, - "id": 457239823, - "date": 1708173749, - "album_id": -53 - }, - "count": 0, - "title": "Тестовая подборка", - "updated_time": 1708173749, - "owner_id": -218861756, - "id": 38 - } - ] - -``` +--- +sidebar_position: 2 +--- + +# Получить подборки по ID + Получить список подборок по массиву ID + + +*Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборки | --sels | Строка, Массив Из Строка | ID подборок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьПодборкиПоИД(Подборки, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьПодборкиПоИД --sels %sels% --auth %auth% + + +``` + + +```json title="Результат" + +[ + { + "is_hidden": false, + "is_main": true, + "photo": { + "has_tags": false, + "web_view_token": "6e66fabe30412b7a20", + "text": "", + "sizes": [ + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=75x75&quality=95&sign=5266db2d411d1405c216c1a266b5b364&c_uniq_tag=oV8dPGRw_KGUAIUM7eQzswdDli0YNRSvC4anBj9DTBk&type=album", + "width": 75, + "type": "s", + "height": 75 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "m", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=604x604&quality=95&sign=0817353d2d87543a885a2b03be59bd24&c_uniq_tag=E0Nkb7roSyIY91bW48CdhVr1WaVYoh_n9-l7mfEMgG0&type=album", + "width": 604, + "type": "x", + "height": 604 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=807x807&quality=95&sign=38b3fc3cd99265d719fc5c9adf25d9eb&c_uniq_tag=PCQhHT3fe1NNNKmRpdsV1FfZE1Qa89Z8RBqbjS0Ubbs&type=album", + "width": 807, + "type": "y", + "height": 807 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=1024x1024&quality=95&sign=61d2e2bf1b70d31c95644cd054a4d399&c_uniq_tag=o5BEt4FmMLFsNBEWBJI4ik-IJSQXrUQFGgMoKOqiTH8&type=album", + "width": 1024, + "type": "z", + "height": 1024 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=130x130&quality=95&sign=79718f97df5bd878bc82b6fa8b6b377b&c_uniq_tag=KL9wgGeHU5xcseZyDQ556di7Qn56NOK5YcEVL5o4S8c&type=album", + "width": 130, + "type": "o", + "height": 130 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=200x200&quality=95&sign=dc5da94a81a43690469c118483d453a8&c_uniq_tag=c4TcOjDX5iUmfB_6zKeFUNqh34cipnMDe2gUEn4vTfY&type=album", + "width": 200, + "type": "p", + "height": 200 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=320x320&quality=95&sign=aefedf52f6f0392ae9d6414064d21604&c_uniq_tag=DPgVLnoagpciN0RayVjNVrWa1s3FBjyliV8W6u4ywWA&type=album", + "width": 320, + "type": "q", + "height": 320 + }, + { + "url": "https://sun9-78.userapi.com/impg/2fYK5pQ5Otg9sjAgetNjVCQQWnDK8GPcNfXIHQ/ApxbNHQYcFs.jpg?size=510x510&quality=95&sign=3158e1e84b5ad304550efee67d71210f&c_uniq_tag=_OYJK4FylGsClBCL1jiQVouUwnOMexRmb47Boh6VlE0&type=album", + "width": 510, + "type": "r", + "height": 510 + } + ], + "user_id": 100, + "owner_id": -218861756, + "id": 457239823, + "date": 1708173749, + "album_id": -53 + }, + "count": 0, + "title": "Тестовая подборка", + "updated_time": 1708173749, + "owner_id": -218861756, + "id": 38 + } + ] + +``` 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 index d5d9e58e95..c2f53caeb4 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 6 ---- - -# Удалить товар из подборки - Удаляет ранее добавленный товар из подборки - - -*Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Товар | --item | Строка | ID товара | - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.УдалитьТоварИзПодборки(8656559, 40, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk УдалитьТоварИзПодборки --item %item% --sel %sel% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` +--- +sidebar_position: 6 +--- + +# Удалить товар из подборки + Удаляет ранее добавленный товар из подборки + + +*Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Строка | ID товара | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.УдалитьТоварИзПодборки(8656559, 40, Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk УдалитьТоварИзПодборки --item %item% --sel %sel% --auth %auth% + + +``` + + +```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 index 3ad3f4e70e..b6b7895483 100644 --- a/docs/ru/md/VK/Statistics/Get-post-statistics.md +++ b/docs/ru/md/VK/Statistics/Get-post-statistics.md @@ -1,90 +1,90 @@ ---- -sidebar_position: 2 ---- - -# Получить статистику по постам - Получает статистику в разрезе постов - - -*Функция ПолучитьСтатистикуПостов(Знач МассивИДПостов, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивИДПостов | --posts | Массив из Строка,Число | Массив ID постов | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Массив из Произвольный - Массив данных статистики по постам - -```bsl title="Пример кода" - - - МассивПостов = Новый Массив; - МассивПостов.Добавить(214); - МассивПостов.Добавить(215); - - Ответ = OPI_VK.ПолучитьСтатистикуПостов(МассивПостов, VK_Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСтатистикуПостов --posts %posts% --auth %auth% - - -``` - - -```json title="Результат" - -[ - { - "ad_report": 0, - "ad_coverage": 0, - "ad_to_group": 0, - "ad_unsubscribe": 0, - "ad_hide": 0, - "ad_join_group": 0, - "ad_subscribers": 0, - "ad_links": 0, - "ad_views": 0, - "reach_viral": 0, - "reach_total": 1, - "reach_ads": 0, - "report": 0, - "join_group": 0, - "links": 0, - "unsubscribe": 0, - "hide": 0, - "reach_subscribers": 1, - "to_group": 1, - "post_id": 214 - }, - { - "ad_report": 0, - "ad_coverage": 0, - "ad_to_group": 0, - "ad_unsubscribe": 0, - "ad_hide": 0, - "ad_join_group": 0, - "ad_subscribers": 0, - "ad_links": 0, - "ad_views": 0, - "reach_viral": 0, - "reach_total": 1, - "reach_ads": 0, - "report": 0, - "join_group": 0, - "links": 0, - "unsubscribe": 0, - "hide": 0, - "reach_subscribers": 1, - "to_group": 0, - "post_id": 215 - } - ] - -``` +--- +sidebar_position: 2 +--- + +# Получить статистику по постам + Получает статистику в разрезе постов + + +*Функция ПолучитьСтатистикуПостов(Знач МассивИДПостов, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивИДПостов | --posts | Массив из Строка,Число | Массив ID постов | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Массив из Произвольный - Массив данных статистики по постам + +```bsl title="Пример кода" + + + МассивПостов = Новый Массив; + МассивПостов.Добавить(214); + МассивПостов.Добавить(215); + + Ответ = OPI_VK.ПолучитьСтатистикуПостов(МассивПостов, VK_Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСтатистикуПостов --posts %posts% --auth %auth% + + +``` + + +```json title="Результат" + +[ + { + "ad_report": 0, + "ad_coverage": 0, + "ad_to_group": 0, + "ad_unsubscribe": 0, + "ad_hide": 0, + "ad_join_group": 0, + "ad_subscribers": 0, + "ad_links": 0, + "ad_views": 0, + "reach_viral": 0, + "reach_total": 1, + "reach_ads": 0, + "report": 0, + "join_group": 0, + "links": 0, + "unsubscribe": 0, + "hide": 0, + "reach_subscribers": 1, + "to_group": 1, + "post_id": 214 + }, + { + "ad_report": 0, + "ad_coverage": 0, + "ad_to_group": 0, + "ad_unsubscribe": 0, + "ad_hide": 0, + "ad_join_group": 0, + "ad_subscribers": 0, + "ad_links": 0, + "ad_views": 0, + "reach_viral": 0, + "reach_total": 1, + "reach_ads": 0, + "report": 0, + "join_group": 0, + "links": 0, + "unsubscribe": 0, + "hide": 0, + "reach_subscribers": 1, + "to_group": 0, + "post_id": 215 + } + ] + +``` diff --git a/docs/ru/md/VK/Statistics/Get-statistics.md b/docs/ru/md/VK/Statistics/Get-statistics.md index f418ed1487..c4f57dbcb5 100644 --- a/docs/ru/md/VK/Statistics/Get-statistics.md +++ b/docs/ru/md/VK/Statistics/Get-statistics.md @@ -1,549 +1,549 @@ ---- -sidebar_position: 1 ---- - -# Получить статистику - Получает общую статистику сообщества за период - - -*Функция ПолучитьСтатистику(Знач ДатаНачала, Знач ДатаОкончания, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | ДатаНачала | --datefrom | Дата | Дата начала периода | - | ДатаОкончания | --dateto | Дата | Дата окончания периода | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПолучитьСтатистику(ТекущаяДатаСеанса() - 60 * 60 * 24, ТекущаяДатаСеанса(), Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - - -``` - -```sh title="Пример команды CLI" - - oint vk ПолучитьСтатистику --datefrom %datefrom% --dateto %dateto% --auth %auth% - - -``` - - -```json title="Результат" - -{ - "response": [ - { - "visitors": { - "views": 8, - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "mobile_views": 0, - "countries": [ - { - "value": 3, - "name": "Беларусь", - "count": 1, - "code": "BY" - } - ], - "visitors": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "reach": { - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "reach": 1, - "mobile_reach": 0, - "countries": [ - { - "value": 3, - "name": "Беларусь", - "count": 1, - "code": "BY" - } - ], - "reach_subscribers": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "period_to": 1704671999, - "period_from": 1704585600 - }, - { - "visitors": { - "views": 3, - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "mobile_views": 0, - "countries": [ - { - "value": 3, - "name": "Беларусь", - "count": 1, - "code": "BY" - } - ], - "visitors": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "reach": { - "sex_age": [ - { - "count": 0, - "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": 1, - "value": "m;21-24" - }, - { - "count": 0, - "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" - } - ], - "sex": [ - { - "count": 0, - "value": "f" - }, - { - "count": 1, - "value": "m" - } - ], - "reach": 1, - "mobile_reach": 0, - "countries": [ - { - "value": 3, - "name": "Беларусь", - "count": 1, - "code": "BY" - } - ], - "reach_subscribers": 1, - "cities": [], - "age": [ - { - "count": 0, - "value": "12-18" - }, - { - "count": 0, - "value": "18-21" - }, - { - "count": 1, - "value": "21-24" - }, - { - "count": 0, - "value": "24-27" - }, - { - "count": 0, - "value": "27-30" - }, - { - "count": 0, - "value": "30-35" - }, - { - "count": 0, - "value": "35-45" - }, - { - "count": 0, - "value": "45-100" - } - ] - }, - "period_to": 1704585599, - "period_from": 1704499200 - } - ] - } - -``` +--- +sidebar_position: 1 +--- + +# Получить статистику + Получает общую статистику сообщества за период + + +*Функция ПолучитьСтатистику(Знач ДатаНачала, Знач ДатаОкончания, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ДатаНачала | --datefrom | Дата | Дата начала периода | + | ДатаОкончания | --dateto | Дата | Дата окончания периода | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + Ответ = OPI_VK.ПолучитьСтатистику(ТекущаяДатаСеанса() - 60 * 60 * 24, ТекущаяДатаСеанса(), Параметры); + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); + + + +``` + +```sh title="Пример команды CLI" + + oint vk ПолучитьСтатистику --datefrom %datefrom% --dateto %dateto% --auth %auth% + + +``` + + +```json title="Результат" + +{ + "response": [ + { + "visitors": { + "views": 8, + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "mobile_views": 0, + "countries": [ + { + "value": 3, + "name": "Беларусь", + "count": 1, + "code": "BY" + } + ], + "visitors": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "reach": { + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "reach": 1, + "mobile_reach": 0, + "countries": [ + { + "value": 3, + "name": "Беларусь", + "count": 1, + "code": "BY" + } + ], + "reach_subscribers": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "period_to": 1704671999, + "period_from": 1704585600 + }, + { + "visitors": { + "views": 3, + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "mobile_views": 0, + "countries": [ + { + "value": 3, + "name": "Беларусь", + "count": 1, + "code": "BY" + } + ], + "visitors": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "reach": { + "sex_age": [ + { + "count": 0, + "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": 1, + "value": "m;21-24" + }, + { + "count": 0, + "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" + } + ], + "sex": [ + { + "count": 0, + "value": "f" + }, + { + "count": 1, + "value": "m" + } + ], + "reach": 1, + "mobile_reach": 0, + "countries": [ + { + "value": 3, + "name": "Беларусь", + "count": 1, + "code": "BY" + } + ], + "reach_subscribers": 1, + "cities": [], + "age": [ + { + "count": 0, + "value": "12-18" + }, + { + "count": 0, + "value": "18-21" + }, + { + "count": 1, + "value": "21-24" + }, + { + "count": 0, + "value": "24-27" + }, + { + "count": 0, + "value": "27-30" + }, + { + "count": 0, + "value": "30-35" + }, + { + "count": 0, + "value": "35-45" + }, + { + "count": 0, + "value": "45-100" + } + ] + }, + "period_to": 1704585599, + "period_from": 1704499200 + } + ] + } + +``` 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 index 5637b467ba..c5c6681658 100644 --- a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md @@ -1,38 +1,38 @@ ---- -sidebar_position: 1 ---- - -# Создать ссылку получения токена -Получение ссылки для интерактивного получения токена (access_token), который необходим для дальнейших действий - - -*Функция СоздатьСсылкуПолученияТокена(Знач App_id) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | app_id | --app | Строка,Число | app_id из настроек приложения | - - - Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере - -```bsl title="Пример кода" - - Приложение = "51694790"; - Результат = OPI_VK.СоздатьСсылкуПолученияТокена(Приложение); - - -``` - -```sh title="Пример команды CLI" - - oint vk СоздатьСсылкуПолученияТокена --app %app% - - -``` - - -```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" - -``` +--- +sidebar_position: 1 +--- + +# Создать ссылку получения токена +Получение ссылки для интерактивного получения токена (access_token), который необходим для дальнейших действий + + +*Функция СоздатьСсылкуПолученияТокена(Знач App_id) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | app_id | --app | Строка,Число | app_id из настроек приложения | + + + Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере + +```bsl title="Пример кода" + + Приложение = "51694790"; + Результат = OPI_VK.СоздатьСсылкуПолученияТокена(Приложение); + + +``` + +```sh title="Пример команды CLI" + + oint vk СоздатьСсылкуПолученияТокена --app %app% + + +``` + + +```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/Viber/Message-sending/Create-keyboard-from-array-button.md b/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md index 06f1cfa997..bc27be001c 100644 --- 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 @@ -1,72 +1,72 @@ ---- -sidebar_position: 7 ---- - -# Сформировать клавиатуру из массива кнопок - Возвращает структура клавиатуры для сообщений - - -*Функция СформироватьКлавиатуруИзМассиваКнопок(Знач МассивКнопок, Знач ЦветКнопок = "#2db9b9") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | - | ЦветКнопок | --color | Строка | HEX цвет кнопок с # в начале | - - - Возвращаемое значение: Структура - Сформировать клавиатуру из массива кнопок: - - -```bsl title="Пример кода" - - - МассивКнопок = Новый Массив; - МассивКнопок.Добавить("Кнопка 1"); - МассивКнопок.Добавить("Кнопка 2"); - МассивКнопок.Добавить("Кнопка 3"); - - Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); //Структура - JSON = OPI_Инструменты.JSONСтрокой(Клавиатура); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber СформироватьКлавиатуруИзМассиваКнопок --buttons %buttons% --color %color% - - -``` - - -```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" - } - -``` +--- +sidebar_position: 7 +--- + +# Сформировать клавиатуру из массива кнопок + Возвращает структура клавиатуры для сообщений + + +*Функция СформироватьКлавиатуруИзМассиваКнопок(Знач МассивКнопок, Знач ЦветКнопок = "#2db9b9") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | + | ЦветКнопок | --color | Строка | HEX цвет кнопок с # в начале | + + + Возвращаемое значение: Структура - Сформировать клавиатуру из массива кнопок: + + +```bsl title="Пример кода" + + + МассивКнопок = Новый Массив; + МассивКнопок.Добавить("Кнопка 1"); + МассивКнопок.Добавить("Кнопка 2"); + МассивКнопок.Добавить("Кнопка 3"); + + Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); //Структура + JSON = OPI_Инструменты.JSONСтрокой(Клавиатура); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber СформироватьКлавиатуруИзМассиваКнопок --buttons %buttons% --color %color% + + +``` + + +```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 index 98f6752d3d..992af91989 100644 --- a/docs/ru/md/Viber/Message-sending/Send-contact.md +++ b/docs/ru/md/Viber/Message-sending/Send-contact.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 4 ---- - -# Отправить контакт - Отправляет контакт с номером телефона в чат или канал - - -*Функция ОтправитьКонтакт(Знач Токен, Знач ИмяКонтакта, Знач НомерТелефона, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | ИмяКонтакта | --name | Строка | Имя контакта | - | НомерТелефона | --phone | Строка | Номер телефона | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - IDПользователя = "d3jxe1111111111jYGgZg=="; - - Ответ = OPI_Viber.ОтправитьКонтакт(ТокенБота, "Пётр Петров", "+749521231", IDПользователя, Ложь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ОтправитьКонтакт --token %token% --name %name% --phone %phone% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% - - -``` - - -```json title="Результат" - -{ - "billing_status": 1, - "chat_hostname": "SN-CHAT-15_", - "message_token": 5925747984748149627, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 4 +--- + +# Отправить контакт + Отправляет контакт с номером телефона в чат или канал + + +*Функция ОтправитьКонтакт(Знач Токен, Знач ИмяКонтакта, Знач НомерТелефона, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяКонтакта | --name | Строка | Имя контакта | + | НомерТелефона | --phone | Строка | Номер телефона | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + IDПользователя = "d3jxe1111111111jYGgZg=="; + + Ответ = OPI_Viber.ОтправитьКонтакт(ТокенБота, "Пётр Петров", "+749521231", IDПользователя, Ложь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ОтправитьКонтакт --token %token% --name %name% --phone %phone% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% + + +``` + + +```json title="Результат" + +{ + "billing_status": 1, + "chat_hostname": "SN-CHAT-15_", + "message_token": 5925747984748149627, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-file.md b/docs/ru/md/Viber/Message-sending/Send-file.md index 3692906b93..7124e7b738 100644 --- a/docs/ru/md/Viber/Message-sending/Send-file.md +++ b/docs/ru/md/Viber/Message-sending/Send-file.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 3 ---- - -# Отправить файл - Отправляет файл (документ) в чат или канал - - -*Функция ОтправитьФайл(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Расширение, Знач Размер = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --file | Строка | URL файла | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - | Расширение | --ext | Строка | Расширение файла | - | Размер | --size | Число | Размер файла. Если не заполнен > определяется автоматически скачиванием файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - ТокенКанала = "523b58ba82afffaa-111111111111111-2222222222222222"; - IDПользователя = "tMNGh111111111D+bT4g=="; - - Ответ = OPI_Viber.ОтправитьФайл(ТокенКанала, "https://api.athenaeum.digital/1.txt", IDПользователя, Истина, "txt"); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ОтправитьФайл --token %token% --file %file% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --ext %ext% --size %size% - - -``` - - -```json title="Результат" - -{ - "chat_hostname": "SN-CHAT-09_", - "message_token": 5925491906424759104, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 3 +--- + +# Отправить файл + Отправляет файл (документ) в чат или канал + + +*Функция ОтправитьФайл(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Расширение, Знач Размер = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --file | Строка | URL файла | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + | Расширение | --ext | Строка | Расширение файла | + | Размер | --size | Число | Размер файла. Если не заполнен > определяется автоматически скачиванием файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + ТокенКанала = "523b58ba82afffaa-111111111111111-2222222222222222"; + IDПользователя = "tMNGh111111111D+bT4g=="; + + Ответ = OPI_Viber.ОтправитьФайл(ТокенКанала, "https://api.athenaeum.digital/1.txt", IDПользователя, Истина, "txt"); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ОтправитьФайл --token %token% --file %file% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --ext %ext% --size %size% + + +``` + + +```json title="Результат" + +{ + "chat_hostname": "SN-CHAT-09_", + "message_token": 5925491906424759104, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-image.md b/docs/ru/md/Viber/Message-sending/Send-image.md index a34e6a0ebc..63071e97f3 100644 --- a/docs/ru/md/Viber/Message-sending/Send-image.md +++ b/docs/ru/md/Viber/Message-sending/Send-image.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 2 ---- - -# Отправить картинку - Отправляет картинку в чат или канал - - -*Функция ОтправитьКартинку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Описание = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --picture | Строка | URL картинки | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | булево | Отправка в канал или в чат бота | - | Описание | --description | Строка | Аннотация к картинке | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - ТокенКанала = "523b58ba82afffaa-111111111111111-2222222222222222"; - IDПользователя = "tMNGh111111111D+bT4g=="; - - Ответ = OPI_Viber.ОтправитьКартинку(ТокенКанала, "https://api.athenaeum.digital/logo.png", IDПользователя, Истина, "Альпака"); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ОтправитьКартинку --token %token% --picture %picture% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --description %description% - - -``` - - -```json title="Результат" - -{ - "chat_hostname": "SN-CHAT-12_", - "message_token": 5925484936191962157, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 2 +--- + +# Отправить картинку + Отправляет картинку в чат или канал + + +*Функция ОтправитьКартинку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --picture | Строка | URL картинки | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | булево | Отправка в канал или в чат бота | + | Описание | --description | Строка | Аннотация к картинке | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + ТокенКанала = "523b58ba82afffaa-111111111111111-2222222222222222"; + IDПользователя = "tMNGh111111111D+bT4g=="; + + Ответ = OPI_Viber.ОтправитьКартинку(ТокенКанала, "https://api.athenaeum.digital/logo.png", IDПользователя, Истина, "Альпака"); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ОтправитьКартинку --token %token% --picture %picture% --user "tMNGh111111111D+bT4g" --ischannel %ischannel% --description %description% + + +``` + + +```json title="Результат" + +{ + "chat_hostname": "SN-CHAT-12_", + "message_token": 5925484936191962157, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-link.md b/docs/ru/md/Viber/Message-sending/Send-link.md index 5c84b38237..31654bd77d 100644 --- a/docs/ru/md/Viber/Message-sending/Send-link.md +++ b/docs/ru/md/Viber/Message-sending/Send-link.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 6 ---- - -# Отправить ссылку - Отправляет URL с предпросмотром в чат или канал - - -*Функция ОтправитьСсылку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Отправляемая ссылка | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - IDПользователя = "d3jxe1111111111jYGgZg=="; - - Ответ = OPI_Viber.ОтправитьСсылку(ТокенБота, "https://github.com/Bayselonarrend", IDПользователя, Ложь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ОтправитьСсылку --token %token% --url %url% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% - - -``` - - -```json title="Результат" - -{ - "billing_status": 1, - "chat_hostname": "SN-CHAT-15_", - "message_token": 5925752472607291800, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 6 +--- + +# Отправить ссылку + Отправляет URL с предпросмотром в чат или канал + + +*Функция ОтправитьСсылку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Отправляемая ссылка | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + IDПользователя = "d3jxe1111111111jYGgZg=="; + + Ответ = OPI_Viber.ОтправитьСсылку(ТокенБота, "https://github.com/Bayselonarrend", IDПользователя, Ложь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ОтправитьСсылку --token %token% --url %url% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% + + +``` + + +```json title="Результат" + +{ + "billing_status": 1, + "chat_hostname": "SN-CHAT-15_", + "message_token": 5925752472607291800, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-location.md b/docs/ru/md/Viber/Message-sending/Send-location.md index 559f137455..844854cb04 100644 --- a/docs/ru/md/Viber/Message-sending/Send-location.md +++ b/docs/ru/md/Viber/Message-sending/Send-location.md @@ -1,53 +1,53 @@ ---- -sidebar_position: 5 ---- - -# Отправить локацию - Отправляет географические координаты в чат или канал - - -*Функция ОтправитьЛокацию(Знач Токен, Знач Широта, Знач Долгота, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Широта | --lat | Строка,Число | Географическая широта | - | Долгота | --long | Строка,Число | Географическая долгота | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - IDПользователя = "d3jxe1111111111jYGgZg=="; - - Ответ = OPI_Viber.ОтправитьЛокацию(ТокенБота, "55.75", "37.6167", IDПользователя, Ложь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ОтправитьЛокацию --token %token% --lat %lat% --long %long% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% - - -``` - - -```json title="Результат" - -{ - "billing_status": 1, - "chat_hostname": "SN-CHAT-10_", - "message_token": 5925751017338988046, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 5 +--- + +# Отправить локацию + Отправляет географические координаты в чат или канал + + +*Функция ОтправитьЛокацию(Знач Токен, Знач Широта, Знач Долгота, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Широта | --lat | Строка,Число | Географическая широта | + | Долгота | --long | Строка,Число | Географическая долгота | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + IDПользователя = "d3jxe1111111111jYGgZg=="; + + Ответ = OPI_Viber.ОтправитьЛокацию(ТокенБота, "55.75", "37.6167", IDПользователя, Ложь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ОтправитьЛокацию --token %token% --lat %lat% --long %long% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% + + +``` + + +```json title="Результат" + +{ + "billing_status": 1, + "chat_hostname": "SN-CHAT-10_", + "message_token": 5925751017338988046, + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/ru/md/Viber/Message-sending/Send-text-message.md b/docs/ru/md/Viber/Message-sending/Send-text-message.md index 3057d0b444..f04d9a3021 100644 --- a/docs/ru/md/Viber/Message-sending/Send-text-message.md +++ b/docs/ru/md/Viber/Message-sending/Send-text-message.md @@ -1,60 +1,60 @@ ---- -sidebar_position: 1 ---- - -# Отправить текстовое сообщение - Отправляет текстовое сообщение в чат или канал - - -*Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач Текст, Знач IDПользователя, Знач ОтправкаВКанал, Знач Клавиатура = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Текст | --text | Строка | Текст сообщения | - | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | - | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | - | Клавиатура | --keyboard | Структура из Строка | См. СформироватьКлавиатуруИзМассиваКнопок | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; - IDПользователя = "d3jxe1111111111jYGgZg=="; - - МассивКнопок = Новый Массив; - - МассивКнопок.Добавить("Кнопка 1"); - МассивКнопок.Добавить("Кнопка 2"); - МассивКнопок.Добавить("Кнопка 3"); - - Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); - - Ответ = OPI_Viber.ОтправитьТекстовоеСообщение(ТокенБота, "Привет", IDПользователя, Ложь, Клавиатура); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ОтправитьТекстовоеСообщение --token %token% --text %text% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% --keyboard %keyboard% - - -``` - - -```json title="Результат" - -{ - "chat_hostname": "SN-CHAT-10_", - "message_token": 5925400810709476620, - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат или канал + + +*Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач Текст, Знач IDПользователя, Знач ОтправкаВКанал, Знач Клавиатура = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Текст | --text | Строка | Текст сообщения | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + | Клавиатура | --keyboard | Структура из Строка | См. СформироватьКлавиатуруИзМассиваКнопок | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; + IDПользователя = "d3jxe1111111111jYGgZg=="; + + МассивКнопок = Новый Массив; + + МассивКнопок.Добавить("Кнопка 1"); + МассивКнопок.Добавить("Кнопка 2"); + МассивКнопок.Добавить("Кнопка 3"); + + Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); + + Ответ = OPI_Viber.ОтправитьТекстовоеСообщение(ТокенБота, "Привет", IDПользователя, Ложь, Клавиатура); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ОтправитьТекстовоеСообщение --token %token% --text %text% --user "d3jxe1111111111jYGgZg" --ischannel %ischannel% --keyboard %keyboard% + + +``` + + +```json title="Результат" + +{ + "chat_hostname": "SN-CHAT-10_", + "message_token": 5925400810709476620, + "status_message": "ok", + "status": 0 + } + +``` 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 index 72327f4a04..a6d18e86cb 100644 --- a/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md +++ b/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 2 ---- - -# Получить информацию о канале -Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook ID пользователя из информации о канале не подойдет для отправки сообщений через бота - они разные - - -*Функция ПолучитьИнформациюОКанале(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - Ответ = OPI_Viber.ПолучитьИнформациюОКанале(ТокенКанала); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ПолучитьИнформациюОКанале --token %token% - - -``` - - -```json title="Результат" - -{ - "members": [ - { - "role": "admin", - "name": "John", - "id": "d3jxe611111111kjYGgZg==" - } - ], - "subcategory": "Advertising Service", - "category": "Local Businesses", - "location": { - "lon": -73.96878, - "lat": 40.7691018 - }, - "icon": "https://media-direct.cdn.viber.com/pg_download?pgtp=icons&dlid=0-04-01-05bfe24da13dddf32cf52976b099dc6965c03300763e6a9316de26986e5dea05&fltp=jpg&imsz=0000", - "subscribers_count": 0, - "name": "1CTestBot", - "chat_hostname": "SN-CHAT-01_", - "id": "pa:5925429953186752236", - "country": "US", - "uri": "1ctestbot", - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 2 +--- + +# Получить информацию о канале +Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook ID пользователя из информации о канале не подойдет для отправки сообщений через бота - они разные + + +*Функция ПолучитьИнформациюОКанале(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + Ответ = OPI_Viber.ПолучитьИнформациюОКанале(ТокенКанала); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ПолучитьИнформациюОКанале --token %token% + + +``` + + +```json title="Результат" + +{ + "members": [ + { + "role": "admin", + "name": "John", + "id": "d3jxe611111111kjYGgZg==" + } + ], + "subcategory": "Advertising Service", + "category": "Local Businesses", + "location": { + "lon": -73.96878, + "lat": 40.7691018 + }, + "icon": "https://media-direct.cdn.viber.com/pg_download?pgtp=icons&dlid=0-04-01-05bfe24da13dddf32cf52976b099dc6965c03300763e6a9316de26986e5dea05&fltp=jpg&imsz=0000", + "subscribers_count": 0, + "name": "1CTestBot", + "chat_hostname": "SN-CHAT-01_", + "id": "pa:5925429953186752236", + "country": "US", + "uri": "1ctestbot", + "status_message": "ok", + "status": 0 + } + +``` 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 index 2d366ed91c..c4221d719d 100644 --- a/docs/ru/md/Viber/Settings-and-information/Get-online-users.md +++ b/docs/ru/md/Viber/Settings-and-information/Get-online-users.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 4 ---- - -# Получить онлайн пользователей - Получает статус пользователя или нескольких пользователей по ID - - -*Функция ПолучитьОнлайнПользователей(Знач Токен, Знач IDПользователей) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен Viber | - | IDПользователей | --users | Строка,Число,Массив из Строка,Число | ID пользователей(я) Viber | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - Ответ = OPI_Viber.ПолучитьОнлайнПользователей(Токен, IDПользователя); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ПолучитьОнлайнПользователей --token %token% --users %users% - - -``` - - -```json title="Результат" - -{ - "users": [ - { - "last_online": 1704796869778, - "online_status_message": "offline", - "online_status": 1, - "id": "d3jxe111111111YGgZg==" - } - ], - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 4 +--- + +# Получить онлайн пользователей + Получает статус пользователя или нескольких пользователей по ID + + +*Функция ПолучитьОнлайнПользователей(Знач Токен, Знач IDПользователей) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен Viber | + | IDПользователей | --users | Строка,Число,Массив из Строка,Число | ID пользователей(я) Viber | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + Ответ = OPI_Viber.ПолучитьОнлайнПользователей(Токен, IDПользователя); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ПолучитьОнлайнПользователей --token %token% --users %users% + + +``` + + +```json title="Результат" + +{ + "users": [ + { + "last_online": 1704796869778, + "online_status_message": "offline", + "online_status": 1, + "id": "d3jxe111111111YGgZg==" + } + ], + "status_message": "ok", + "status": 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 index 62bdbe7820..a8232e24b9 100644 --- a/docs/ru/md/Viber/Settings-and-information/Get-user-data.md +++ b/docs/ru/md/Viber/Settings-and-information/Get-user-data.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 3 ---- - -# Получить данные пользователя - Получает информацию о пользователе по ID - - -*Функция ПолучитьДанныеПользователя(Знач Токен, Знач IDПользователя) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | IDПользователя | --user | Строка, Число | ID пользователя Viber | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber - -```bsl title="Пример кода" - - - Ответ = OPI_Viber.ПолучитьДанныеПользователя(Токен, IDПользователя); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber ПолучитьДанныеПользователя --token %token% --user %user% - - -``` - - -```json title="Результат" - -{ - "user": { - "device_type": "iPhone8,4", - "mnc": 1, - "mcc": 257, - "api_version": 10, - "primary_device_os": "iOS 15.6.1", - "viber_version": "21.6.0.18", - "country": "FR", - "language": "ru", - "avatar": "http://dl-media.viber.com/1/share/2/long/bots/generic-avatar%402x.png", - "name": "Subscriber", - "id": "d3jxe6111111NkjYGgZg==" - }, - "chat_hostname": "SN-CHAT-07_", - "status_message": "ok", - "status": 0 - } - -``` +--- +sidebar_position: 3 +--- + +# Получить данные пользователя + Получает информацию о пользователе по ID + + +*Функция ПолучитьДанныеПользователя(Знач Токен, Знач IDПользователя) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПользователя | --user | Строка, Число | ID пользователя Viber | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + Ответ = OPI_Viber.ПолучитьДанныеПользователя(Токен, IDПользователя); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber ПолучитьДанныеПользователя --token %token% --user %user% + + +``` + + +```json title="Результат" + +{ + "user": { + "device_type": "iPhone8,4", + "mnc": 1, + "mcc": 257, + "api_version": 10, + "primary_device_os": "iOS 15.6.1", + "viber_version": "21.6.0.18", + "country": "FR", + "language": "ru", + "avatar": "http://dl-media.viber.com/1/share/2/long/bots/generic-avatar%402x.png", + "name": "Subscriber", + "id": "d3jxe6111111NkjYGgZg==" + }, + "chat_hostname": "SN-CHAT-07_", + "status_message": "ok", + "status": 0 + } + +``` diff --git a/docs/ru/md/Viber/Settings-and-information/Set-webhook.md b/docs/ru/md/Viber/Settings-and-information/Set-webhook.md index 376eea0208..c5c3d87f03 100644 --- a/docs/ru/md/Viber/Settings-and-information/Set-webhook.md +++ b/docs/ru/md/Viber/Settings-and-information/Set-webhook.md @@ -1,57 +1,57 @@ ---- -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="Пример кода" - - - Ответ = OPI_Viber.УстановитьWebhook(Токен, "https://api.athenaeum.digital/opi/hs/viber"); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - - - -``` - -```sh title="Пример команды CLI" - - oint viber УстановитьWebhook --token %token% --url %url% - - -``` - - -```json title="Результат" - -{ - "event_types": [ - "subscribed", - "unsubscribed", - "webhook", - "conversation_started", - "client_status", - "action", - "delivered", - "failed", - "message", - "seen" - ], - "chat_hostname": "SN-CHAT-12_", - "status_message": "ok", - "status": 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="Пример кода" + + + Ответ = OPI_Viber.УстановитьWebhook(Токен, "https://api.athenaeum.digital/opi/hs/viber"); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка + + + +``` + +```sh title="Пример команды CLI" + + oint viber УстановитьWebhook --token %token% --url %url% + + +``` + + +```json title="Результат" + +{ + "event_types": [ + "subscribed", + "unsubscribed", + "webhook", + "conversation_started", + "client_status", + "action", + "delivered", + "failed", + "message", + "seen" + ], + "chat_hostname": "SN-CHAT-12_", + "status_message": "ok", + "status": 0 + } + +``` 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 index ffb6526e44..901422d353 100644 --- 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 @@ -1,64 +1,64 @@ ---- -sidebar_position: 2 ---- - -# Создать папку - Создает каталог на диске - - -*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к созаваемой папке | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Тестовая папка" - Ответ = OPI_YandexDisk.СоздатьПапку(Токен, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk СоздатьПапку --token "y0_AgAAAABdylaOAA..." --path "/Тестовая папка" - - -``` - - -```json title="Результат" - -{ - "revision": 1707461457546792, - "comment_ids": { - "public_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", - "private_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac" - }, - "path": "disk:/Тестовая папка", - "modified": "2024-02-09T06:50:57+00:00", - "created": "2024-02-09T06:50:57+00:00", - "resource_id": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", - "type": "dir", - "name": "Тестовая папка", - "exif": {}, - "_embedded": { - "total": 0, - "path": "disk:/Тестовая папка", - "limit": 20, - "offset": 0, - "items": [], - "sort": "" - } - } - -``` +--- +sidebar_position: 2 +--- + +# Создать папку + Создает каталог на диске + + +*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к созаваемой папке | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Тестовая папка" + Ответ = OPI_YandexDisk.СоздатьПапку(Токен, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk СоздатьПапку --token "y0_AgAAAABdylaOAA..." --path "/Тестовая папка" + + +``` + + +```json title="Результат" + +{ + "revision": 1707461457546792, + "comment_ids": { + "public_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", + "private_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac" + }, + "path": "disk:/Тестовая папка", + "modified": "2024-02-09T06:50:57+00:00", + "created": "2024-02-09T06:50:57+00:00", + "resource_id": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", + "type": "dir", + "name": "Тестовая папка", + "exif": {}, + "_embedded": { + "total": 0, + "path": "disk:/Тестовая папка", + "limit": 20, + "offset": 0, + "items": [], + "sort": "" + } + } + +``` 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 index 5bc216d010..1428359eea 100644 --- 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 @@ -1,118 +1,118 @@ ---- -sidebar_position: 5 ---- - -# Создать копию объекта - Создает копию объекта по заданному пути и пути к оригиналу - - -*Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Оригинал | --from | Строка | Путь к оригинальному файлу или каталогу | - | Путь | --to | Строка | Путь назначения для копии | - | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Оригинал = "/Альпака.png"; - Путь = "/Альпака (копия).png"; - - Ответ = OPI_YandexDisk.СоздатьКопиюОбъекта(Токен, Оригинал, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk СоздатьКопиюОбъекта --token "y0_AgAAAABdylaOAA..." --from "/Альпака.png" --to "/Альпака (копия).png" --rewrite %rewrite% - - -``` - - -```json title="Результат" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707469147481281, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T08:59:07+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", - "preview": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T08:59:07+00:00", - "exif": {}, - "name": "Альпака (копия).png", - "type": "file", - "size": 440431, - "path": "disk:/Альпака (копия).png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", - "private_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c" - }, - "mime_type": "multipart" - } - -``` +--- +sidebar_position: 5 +--- + +# Создать копию объекта + Создает копию объекта по заданному пути и пути к оригиналу + + +*Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Оригинал | --from | Строка | Путь к оригинальному файлу или каталогу | + | Путь | --to | Строка | Путь назначения для копии | + | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Оригинал = "/Альпака.png"; + Путь = "/Альпака (копия).png"; + + Ответ = OPI_YandexDisk.СоздатьКопиюОбъекта(Токен, Оригинал, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk СоздатьКопиюОбъекта --token "y0_AgAAAABdylaOAA..." --from "/Альпака.png" --to "/Альпака (копия).png" --rewrite %rewrite% + + +``` + + +```json title="Результат" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707469147481281, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T08:59:07+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/42396f94cb31c4bee977b94c0eaab5feba796297f50f7db2f9562a339c0651ee/65c6219c/gwThwhLBKYvLhQCNnqAHildyZs8NXNIgEfk0D4t03wR34GkBTG2Ij-0FzXGoNbALdlrssshQrGMpyJBpokoyOw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=multipart&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", + "preview": "https://downloader.disk.yandex.ru/preview/814293809e2e0775d04497a5b6c833b8f6c290816f3955eefa531409d18c55d8/inf/ZWOpbA1ecNxReAZlEDZe9iiWCPOJvrRoOl9Cq1Z-fLjQhsztUkb2q2NfXTaGx05Kc5h2Uo5V6MOYf--FqAAxIQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%BA%D0%BE%D0%BF%D0%B8%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T08:59:07+00:00", + "exif": {}, + "name": "Альпака (копия).png", + "type": "file", + "size": 440431, + "path": "disk:/Альпака (копия).png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c", + "private_resource": "1573541518:b9d51b6b673516c986d863bd782d158d5945d9aa52cb67adad3364ace064043c" + }, + "mime_type": "multipart" + } + +``` 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 index a5146f6a35..040dd00600 100644 --- 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 @@ -1,44 +1,44 @@ ---- -sidebar_position: 4 ---- - -# Удалить объект - Удаляет объект по заданному пути - - -*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к удаляемой папке или файлу | - | ВКорзину | --can | Булево | В корзину | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Альпака.png" - Ответ = OPI_YandexDisk.УдалитьОбъект(Токен, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk УдалитьОбъект --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" --can %can% - - -``` - - -```json title="Результат" - -<пустая строка> - -``` +--- +sidebar_position: 4 +--- + +# Удалить объект + Удаляет объект по заданному пути + + +*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к удаляемой папке или файлу | + | ВКорзину | --can | Булево | В корзину | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Альпака.png" + Ответ = OPI_YandexDisk.УдалитьОбъект(Токен, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk УдалитьОбъект --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" --can %can% + + +``` + + +```json title="Результат" + +<пустая строка> + +``` 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 index 40db9cd41f..9ad4376e29 100644 --- 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 @@ -1,38 +1,38 @@ ---- -sidebar_position: 7 ---- - -# Скачать файл - Скачивает файл по указанному пути - - -*Функция СкачатьФайл(Знач Токен, Знач Путь, Знач ПутьСохранения = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к файлу для скачивания | - | ПутьСохранения | --out | Строка | Путь сохранения файла | - - - Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk СкачатьФайл --token %token% --path %path% --out %out% - - -``` - - -```json title="Результат" - - - -``` +--- +sidebar_position: 7 +--- + +# Скачать файл + Скачивает файл по указанному пути + + +*Функция СкачатьФайл(Знач Токен, Знач Путь, Знач ПутьСохранения = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к файлу для скачивания | + | ПутьСохранения | --out | Строка | Путь сохранения файла | + + + Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk СкачатьФайл --token %token% --path %path% --out %out% + + +``` + + +```json title="Результат" + + + +``` 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 index 75025f9fcc..10376fedf6 100644 --- 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 @@ -1,76 +1,76 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о диске - Получает информацию о текущем диске - - -*Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Ответ = OPI_YandexDisk.ПолучитьИнформациюОДиске(Токен); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьИнформациюОДиске --token "y0_AgAAAABdylaOAA..." - - -``` - - -```json title="Результат" - -{ - "user": { - "login": "bayselonarrend", - "country": "by", - "uid": "1573541111", - "display_name": "bayselonarrend", - "is_child": false, - "reg_time": "2024-02-01T22:13:41+00:00" - }, - "revision": 1707416628219047, - "system_folders": { - "photostream": "disk:/Фотокамера/", - "screenshots": "disk:/Скриншоты/", - "scans": "disk:/Сканы", - "messenger": "disk:/Файлы Мессенджера", - "facebook": "disk:/Социальные сети/Facebook", - "applications": "disk:/Приложения", - "downloads": "disk:/Загрузки/", - "mailru": "disk:/Социальные сети/Мой Мир", - "attach": "disk:/Почтовые вложения", - "instagram": "disk:/Социальные сети/Instagram", - "calendar": "disk:/Материалы встреч", - "social": "disk:/Социальные сети/", - "vkontakte": "disk:/Социальные сети/ВКонтакте", - "google": "disk:/Социальные сети/Google+", - "odnoklassniki": "disk:/Социальные сети/Одноклассники" - }, - "unlimited_autoupload_enabled": false, - "used_space": 73372937, - "trash_size": 0, - "reg_time": "2024-02-01T12:13:41+00:00", - "total_space": 5368709120, - "is_paid": false, - "paid_max_file_size": 53687091200, - "max_file_size": 1073741824 - } - -``` +--- +sidebar_position: 1 +--- + +# Получить информацию о диске + Получает информацию о текущем диске + + +*Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Ответ = OPI_YandexDisk.ПолучитьИнформациюОДиске(Токен); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьИнформациюОДиске --token "y0_AgAAAABdylaOAA..." + + +``` + + +```json title="Результат" + +{ + "user": { + "login": "bayselonarrend", + "country": "by", + "uid": "1573541111", + "display_name": "bayselonarrend", + "is_child": false, + "reg_time": "2024-02-01T22:13:41+00:00" + }, + "revision": 1707416628219047, + "system_folders": { + "photostream": "disk:/Фотокамера/", + "screenshots": "disk:/Скриншоты/", + "scans": "disk:/Сканы", + "messenger": "disk:/Файлы Мессенджера", + "facebook": "disk:/Социальные сети/Facebook", + "applications": "disk:/Приложения", + "downloads": "disk:/Загрузки/", + "mailru": "disk:/Социальные сети/Мой Мир", + "attach": "disk:/Почтовые вложения", + "instagram": "disk:/Социальные сети/Instagram", + "calendar": "disk:/Материалы встреч", + "social": "disk:/Социальные сети/", + "vkontakte": "disk:/Социальные сети/ВКонтакте", + "google": "disk:/Социальные сети/Google+", + "odnoklassniki": "disk:/Социальные сети/Одноклассники" + }, + "unlimited_autoupload_enabled": false, + "used_space": 73372937, + "trash_size": 0, + "reg_time": "2024-02-01T12:13:41+00:00", + "total_space": 5368709120, + "is_paid": false, + "paid_max_file_size": 53687091200, + "max_file_size": 1073741824 + } + +``` 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 index 343174660d..dd7a5d6c7d 100644 --- 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 @@ -1,47 +1,47 @@ ---- -sidebar_position: 6 ---- - -# Получить ссылку для скачивания - Получает ссылку для скачивания файла - - -*Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к файлу для скачивания | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Альпака.png" - Ответ = OPI_YandexDisk.ПолучитьСсылкуДляСкачивания(Токен, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьСсылкуДляСкачивания --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" - - -``` - - -```json title="Результат" - -{ - "templated": false, - "method": "GET", - "href": "https://downloader.disk.yandex.ru/disk/5e035e14f3580573be69477a0a5a41a598227875d7c471604e386ee2dcfc7067/65c62a93/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - } - -``` +--- +sidebar_position: 6 +--- + +# Получить ссылку для скачивания + Получает ссылку для скачивания файла + + +*Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к файлу для скачивания | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Альпака.png" + Ответ = OPI_YandexDisk.ПолучитьСсылкуДляСкачивания(Токен, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьСсылкуДляСкачивания --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" + + +``` + + +```json title="Результат" + +{ + "templated": false, + "method": "GET", + "href": "https://downloader.disk.yandex.ru/disk/5e035e14f3580573be69477a0a5a41a598227875d7c471604e386ee2dcfc7067/65c62a93/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + } + +``` 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 index 6cdf695834..c8055ead38 100644 --- 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 @@ -1,198 +1,198 @@ ---- -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_AgAAAABdylaOAA..."; - Ответ = OPI_YandexDisk.ПолучитьСписокФайлов(Токен, 2, 1, "image"); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьСписокФайлов --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% --type %type% --datesort %datesort% - - -``` - - -```json title="Результат" - -{ - "limit": 2, - "offset": 1, - "items": [ - { - "md5": "d27d72a3059ad5ebed7a5470459d2670", - "sha256": "fe9e2ea0d191ff0eb9d2129464f87da5fd5f02f370a4889492efc18947c70172", - "revision": 1706789623558058, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/600aa748c7064a155b01d3906b075cd77b14610e224ea20f629220e132a23add/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670", - "modified": "2024-02-01T12:13:43+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/386674328ba45b839defa451b28ce532a3027e32db910efce2a92a3b578fed65/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", - "preview": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-01T12:13:43+00:00", - "exif": { - "date_time": "2014-12-13T11:59:54+00:00" - }, - "name": "Москва.jpg", - "type": "file", - "size": 1454228, - "path": "disk:/Москва.jpg", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", - "private_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565" - }, - "mime_type": "image/jpeg" - }, - { - "md5": "ab903d9cab031eca2a8f12f37bbc9d37", - "sha256": "21f14018436c3dca7a47c5bd83f3b9bbc8b6c113b2a1d23ce7f5a0c80ce0e687", - "revision": 1706789624992463, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/1c893a2d6e3b1940e5705cb1e6c3dca9f47c9b79f2c2841615b8ae8868353186/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37", - "modified": "2024-02-01T12:13:44+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/a7af85df25252eb792b08de6bee2fb681dee549b375589a12574d6db2b97e770/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", - "preview": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-01T12:13:44+00:00", - "exif": { - "date_time": "2014-12-13T10:31:34+00:00" - }, - "name": "Море.jpg", - "type": "file", - "size": 1080301, - "path": "disk:/Море.jpg", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", - "private_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3" - }, - "mime_type": "image/jpeg" - } - ] - } - -``` +--- +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_AgAAAABdylaOAA..."; + Ответ = OPI_YandexDisk.ПолучитьСписокФайлов(Токен, 2, 1, "image"); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьСписокФайлов --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% --type %type% --datesort %datesort% + + +``` + + +```json title="Результат" + +{ + "limit": 2, + "offset": 1, + "items": [ + { + "md5": "d27d72a3059ad5ebed7a5470459d2670", + "sha256": "fe9e2ea0d191ff0eb9d2129464f87da5fd5f02f370a4889492efc18947c70172", + "revision": 1706789623558058, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/600aa748c7064a155b01d3906b075cd77b14610e224ea20f629220e132a23add/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670", + "modified": "2024-02-01T12:13:43+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/386674328ba45b839defa451b28ce532a3027e32db910efce2a92a3b578fed65/65c62e41/8Ng7aqpQFqID9pDAoIfkzJNiNSME7Q0O0DrXr5-IhMhsc2sfDe4WYN63DQe_2uMcRJgJ9rEomrz3OKR_LVAEqg%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1454228&hid=427d5900ad807ada37f94079f0fe7806&media_type=image&tknv=v2&etag=d27d72a3059ad5ebed7a5470459d2670" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", + "preview": "https://downloader.disk.yandex.ru/preview/a11d0906a8fde188cd289507e178fff87a2a594c292f3a7058f53d6451f4f0ae/inf/PNec8rFbFd0WPJMSAfUc7pNiNSME7Q0O0DrXr5-IhMgAOITNajybxvIo7yfrDcZbCvINiUpbWSnJA594N-sTjQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-01T12:13:43+00:00", + "exif": { + "date_time": "2014-12-13T11:59:54+00:00" + }, + "name": "Москва.jpg", + "type": "file", + "size": 1454228, + "path": "disk:/Москва.jpg", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565", + "private_resource": "1573541518:aa71f7560c6a3080746acde64bc791aaae70942505fcc987f2c0dc9e95384565" + }, + "mime_type": "image/jpeg" + }, + { + "md5": "ab903d9cab031eca2a8f12f37bbc9d37", + "sha256": "21f14018436c3dca7a47c5bd83f3b9bbc8b6c113b2a1d23ce7f5a0c80ce0e687", + "revision": 1706789624992463, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/1c893a2d6e3b1940e5705cb1e6c3dca9f47c9b79f2c2841615b8ae8868353186/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=attachment&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37", + "modified": "2024-02-01T12:13:44+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/a7af85df25252eb792b08de6bee2fb681dee549b375589a12574d6db2b97e770/65c62e41/WkVZq2fSNyX4Wj1eGp5xvVuQ-biYzXHMfURW4VIc4rnTDhDv_2FACX-6brYvo5Lna_4TuhGY_HuTtgY7RM8VkQ%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&fsize=1080301&hid=d7c189c9f94c684a2a2e6cfd66ed312d&media_type=image&tknv=v2&etag=ab903d9cab031eca2a8f12f37bbc9d37" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", + "preview": "https://downloader.disk.yandex.ru/preview/25fe5fde8d0e768d2827a69b600e5ea36c1cd53d0052bb7e3bc0ee072265a6ae/inf/e4WTSuwXNwLjbjwaWi1vXFuQ-biYzXHMfURW4VIc4rmBxZhGf6N5b4MEf_ueh3VwZDJ7I3Qq7cU45yvpQs5vyA%3D%3D?uid=1573541518&filename=%D0%9C%D0%BE%D1%80%D0%B5.jpg&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-01T12:13:44+00:00", + "exif": { + "date_time": "2014-12-13T10:31:34+00:00" + }, + "name": "Море.jpg", + "type": "file", + "size": 1080301, + "path": "disk:/Море.jpg", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3", + "private_resource": "1573541518:d239b48c0b8ec4690eca0dea331d6b5981694233186ee5252b6d63d552319eb3" + }, + "mime_type": "image/jpeg" + } + ] + } + +``` 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 index a187c26a69..0be4b10f3c 100644 --- 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 @@ -1,114 +1,114 @@ ---- -sidebar_position: 3 ---- - -# Получить объект - Получает информацию об объекте диска по заданному пути - - -*Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к папке или файлу | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Альпака.png" - Ответ = OPI_YandexDisk.ПолучитьОбъект(Токен, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьОбъект --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" - - -``` - - -```json title="Результат" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707464146094880, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/dde91b59521a82943bf471bd567cbfc5d1743e47c070612cb12142b1539dee31/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T07:35:46+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/30f5ad2a163156a249c62177447abd5e88c7dc54491b67cd378c354abf67d7e5/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", - "preview": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-08T10:56:19+00:00", - "exif": {}, - "name": "Альпака.png", - "type": "file", - "size": 440431, - "path": "disk:/Альпака.png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", - "private_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb" - }, - "mime_type": "image/png" - } - -``` +--- +sidebar_position: 3 +--- + +# Получить объект + Получает информацию об объекте диска по заданному пути + + +*Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к папке или файлу | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Альпака.png" + Ответ = OPI_YandexDisk.ПолучитьОбъект(Токен, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьОбъект --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" + + +``` + + +```json title="Результат" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707464146094880, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/dde91b59521a82943bf471bd567cbfc5d1743e47c070612cb12142b1539dee31/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T07:35:46+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/30f5ad2a163156a249c62177447abd5e88c7dc54491b67cd378c354abf67d7e5/65c60e42/gwThwhLBKYvLhQCNnqAHipkvjZhVNNxGTNig_llGPhLRP5nDBmXsdEg4Fhk78dfjZAaSvO2bMDHgtfB5lLZkXQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", + "preview": "https://downloader.disk.yandex.ru/preview/69709cc2cbb959f6e2d0c73114daf31bb0c928fee1ac6fa07ad49d6880a45bb0/inf/C_BTcM66RTR0fZaok1Kn-da5QIF3lhb76OqICnyTAmG6ZHxPEuwL760R39ZLYBuZNUGPqM-Xip6PIzqzAs2hpg%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-08T10:56:19+00:00", + "exif": {}, + "name": "Альпака.png", + "type": "file", + "size": 440431, + "path": "disk:/Альпака.png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb", + "private_resource": "1573541518:0c7e8321400e442148c5dedba88c043536e0fdafbb005577de3aba090a4b21eb" + }, + "mime_type": "image/png" + } + +``` 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 index d6beb384a0..5364c62bb2 100644 --- 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 @@ -1,118 +1,118 @@ ---- -sidebar_position: 9 ---- - -# Переместить объект - Перемещает объект по заданному пути и пути к оригиналу - - -*Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Оригинал | --from | Строка | Путь к оригинальному файлу или папке | - | Путь | --to | Строка | Путь назначение для перемещения | - | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Оригинал = "/Альпака.png"; - Путь = "/Тестовая папка/Альпака (Перемещенная).png"; - - Ответ = OPI_YandexDisk.ПереместитьОбъект(Токен, Оригинал, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПереместитьОбъект --token "y0_AgAAAABdylaOAA..." --from "/Альпака.png" --to "/Тестовая папка/Альпака (Перемещенная).png" --rewrite %rewrite% - - -``` - - -```json title="Результат" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707469557170087, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/ac927eda1a0a731aa738bf31fa798a35970b5b47c2720a198574e124f462f7d8/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T09:05:57+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/a63112c5e420fa188f83cb59424d4149d181903e5fe2278da40cae9b9b0c3fb7/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", - "preview": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T09:05:22+00:00", - "exif": {}, - "name": "Альпака (Перемещенная).png", - "type": "file", - "size": 440431, - "path": "disk:/Тестовая папка/Альпака (Перемещенная).png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", - "private_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e" - }, - "mime_type": "image/png" - } - -``` +--- +sidebar_position: 9 +--- + +# Переместить объект + Перемещает объект по заданному пути и пути к оригиналу + + +*Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Оригинал | --from | Строка | Путь к оригинальному файлу или папке | + | Путь | --to | Строка | Путь назначение для перемещения | + | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Оригинал = "/Альпака.png"; + Путь = "/Тестовая папка/Альпака (Перемещенная).png"; + + Ответ = OPI_YandexDisk.ПереместитьОбъект(Токен, Оригинал, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПереместитьОбъект --token "y0_AgAAAABdylaOAA..." --from "/Альпака.png" --to "/Тестовая папка/Альпака (Перемещенная).png" --rewrite %rewrite% + + +``` + + +```json title="Результат" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707469557170087, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/ac927eda1a0a731aa738bf31fa798a35970b5b47c2720a198574e124f462f7d8/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T09:05:57+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/a63112c5e420fa188f83cb59424d4149d181903e5fe2278da40cae9b9b0c3fb7/65c62335/gwThwhLBKYvLhQCNnqAHiu5_P-LAXSWQpiYxeWy28AYzViDSLmmlo4AMASIOKrFH-haFSWaa3uoDrU66PbIwmw%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", + "preview": "https://downloader.disk.yandex.ru/preview/b83f5dc8a3121e8b1b722697b32c8ddc0717d638cb697d798cf273a02af47a0d/inf/StxpE_qJqBBzAjlLh7JimOHZa_BuL1QLmWV8zhtBuW68cceWoRVkrNu3pSqZYxenrNBK4JyRN727YrVI43zvFQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0%20%28%D0%9F%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%29.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T09:05:22+00:00", + "exif": {}, + "name": "Альпака (Перемещенная).png", + "type": "file", + "size": 440431, + "path": "disk:/Тестовая папка/Альпака (Перемещенная).png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e", + "private_resource": "1573541518:c4db4caacc0c28fb3f6af82e939d5077d9b6dbb940bf7dbbe069a20aee59864e" + }, + "mime_type": "image/png" + } + +``` 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 index 31718b7e62..0e471432e0 100644 --- 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 @@ -1,50 +1,50 @@ ---- -sidebar_position: 11 ---- - -# Загрузить файл по URL - Загружает файл на диск, забирая его по заданному URL - - -*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь помещения загруженного файла | - | Адрес | --url | Строка | URL файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Альпака.png"; - Адрес = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png"; - - Ответ = OPI_YandexDisk.ЗагрузитьФайлПоURL(Токен, Путь, Адрес); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ЗагрузитьФайлПоURL --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" --url "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png" - - -``` - - -```json title="Результат" - -{ - "templated": false, - "method": "GET", - "href": "https://cloud-api.yandex.net/v1/disk/operations/b78a7ef2dd49971aa22e5e72f2e615db885da9947d7c61b2822de23a99e855a1" - } - -``` +--- +sidebar_position: 11 +--- + +# Загрузить файл по URL + Загружает файл на диск, забирая его по заданному URL + + +*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь помещения загруженного файла | + | Адрес | --url | Строка | URL файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Альпака.png"; + Адрес = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png"; + + Ответ = OPI_YandexDisk.ЗагрузитьФайлПоURL(Токен, Путь, Адрес); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ЗагрузитьФайлПоURL --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" --url "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/Media/logo.png" + + +``` + + +```json title="Результат" + +{ + "templated": false, + "method": "GET", + "href": "https://cloud-api.yandex.net/v1/disk/operations/b78a7ef2dd49971aa22e5e72f2e615db885da9947d7c61b2822de23a99e855a1" + } + +``` 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 index 18ab58b059..dbef4bb9bc 100644 --- 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 @@ -1,47 +1,47 @@ ---- -sidebar_position: 10 ---- - -# Загрузить файл - Загружает файл на диск по заданному пути - - -*Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь для сохранение файла на Диске | - | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | - | Перезаписывать | --rewrite | Булево | Перезаписывать, если файл с таким именем уже существует | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/АльпакаИзФайла.png"; - Файл = "C:\logo.png"; - - Ответ = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь, Файл); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ЗагрузитьФайл --token "y0_AgAAAABdylaOAA..." --path "/АльпакаИзФайла.png" --file "C:\logo.png" --rewrite %rewrite% - - -``` - - -```json title="Результат" - -<пустая строка> - -``` +--- +sidebar_position: 10 +--- + +# Загрузить файл + Загружает файл на диск по заданному пути + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь для сохранение файла на Диске | + | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | + | Перезаписывать | --rewrite | Булево | Перезаписывать, если файл с таким именем уже существует | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/АльпакаИзФайла.png"; + Файл = "C:\logo.png"; + + Ответ = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь, Файл); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ЗагрузитьФайл --token "y0_AgAAAABdylaOAA..." --path "/АльпакаИзФайла.png" --file "C:\logo.png" --rewrite %rewrite% + + +``` + + +```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 index 08a5e41766..55e10546d5 100644 --- 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 @@ -1,114 +1,114 @@ ---- -sidebar_position: 2 ---- - -# Отменить публикацию объекта - Отменяет публикацию ранее опубликованного объекта - - -*Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) ЭкспортВозврат ПереключениеОбщегоДоступа(Токен, Путь, Ложь);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к опубликованному ранее объекту | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Альпака.png" - Ответ = OPI_YandexDisk.ОтменитьПубликациюОбъекта(Токен, Путь); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ОтменитьПубликациюОбъекта --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" - - -``` - - -```json title="Результат" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707477571749555, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/975f34b37717b6e83f8d3ff4102e45e3425dc27fe0b15f296941f40b9e42fafb/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T10:50:41+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/ab19200794efaae9cda8243cf7531ee1d1345a757e45232ce030ab3a74309dc1/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T10:50:41+00:00", - "exif": {}, - "name": "Альпака.png", - "type": "file", - "size": 440431, - "path": "disk:/Альпака.png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" - }, - "mime_type": "image/png" - } - -``` +--- +sidebar_position: 2 +--- + +# Отменить публикацию объекта + Отменяет публикацию ранее опубликованного объекта + + +*Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) ЭкспортВозврат ПереключениеОбщегоДоступа(Токен, Путь, Ложь);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к опубликованному ранее объекту | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Альпака.png" + Ответ = OPI_YandexDisk.ОтменитьПубликациюОбъекта(Токен, Путь); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ОтменитьПубликациюОбъекта --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" + + +``` + + +```json title="Результат" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707477571749555, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/975f34b37717b6e83f8d3ff4102e45e3425dc27fe0b15f296941f40b9e42fafb/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T10:50:41+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/ab19200794efaae9cda8243cf7531ee1d1345a757e45232ce030ab3a74309dc1/65c64284/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T10:50:41+00:00", + "exif": {}, + "name": "Альпака.png", + "type": "file", + "size": 440431, + "path": "disk:/Альпака.png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" + }, + "mime_type": "image/png" + } + +``` 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 index 8ef365438d..e7766d968c 100644 --- 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 @@ -1,49 +1,49 @@ ---- -sidebar_position: 5 ---- - -# Получить ссылку скачивания публичного объекта - Получает прямую ссылку для скачивания публичного объекта - - -*Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Адрес объекта | - | Путь | --path | Строка | Путь внутри объекта | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" - - Ответ = OPI_YandexDisk.ПолучитьСсылкуСкачиванияПубличногоОбъекта(Токен, URL); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --path %path% - - -``` - - -```json title="Результат" - -{ - "templated": false, - "method": "GET", - "href": "https://downloader.disk.yandex.ru/disk/e43662271abc4a5afd5b2122004e702e97e20c36932d687bbca183cfee10413d/65c63eba/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=O%2BtgG9OfyuyJgwBRM%2BBJVaHN3Kg0nH8yi5xbEKU3m%2Bd8vVVsZCwR%2BLHB8oeN%2BwcTq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2" - } - -``` +--- +sidebar_position: 5 +--- + +# Получить ссылку скачивания публичного объекта + Получает прямую ссылку для скачивания публичного объекта + + +*Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Путь | --path | Строка | Путь внутри объекта | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" + + Ответ = OPI_YandexDisk.ПолучитьСсылкуСкачиванияПубличногоОбъекта(Токен, URL); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --path %path% + + +``` + + +```json title="Результат" + +{ + "templated": false, + "method": "GET", + "href": "https://downloader.disk.yandex.ru/disk/e43662271abc4a5afd5b2122004e702e97e20c36932d687bbca183cfee10413d/65c63eba/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=O%2BtgG9OfyuyJgwBRM%2BBJVaHN3Kg0nH8yi5xbEKU3m%2Bd8vVVsZCwR%2BLHB8oeN%2BwcTq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2" + } + +``` 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 index 9bd5dc9825..b444c77a15 100644 --- 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 @@ -1,125 +1,125 @@ ---- -sidebar_position: 4 ---- - -# Получить публичный объект - Получает информацию об опубликованном объекте по его URL - - -*Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Адрес объекта | - | Количество | --amount | Число | Количество возвращаемых вложенных объектов (для каталога) | - | СмещениеОтНачала | --offset | Число | Смещение для получение вложенных объектов не из начала списка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" - - Ответ = OPI_YandexDisk.ПолучитьПубличныйОбъект(Токен, URL); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьПубличныйОбъект --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --amount %amount% --offset %offset% - - -``` - - -```json title="Результат" - -{ - "modified": "2024-02-09T10:50:41+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/6c21ad3881d0b63ff36b4e8dac62f92bcad19123eb5089651351bfe8bf9a1ffc/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" - } - ], - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", - "name": "Альпака.png", - "type": "file", - "media_type": "image", - "revision": 1707476320145658, - "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", - "exif": {}, - "size": 440431, - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "owner": { - "uid": "1573541518", - "display_name": "bayselonarrend", - "login": "bayselonarrend" - }, - "file": "https://downloader.disk.yandex.ru/disk/625f72fc8f1f169d498e24b1c3531b81b6e26dc742ecaed842fa527a930965ec/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "preview": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0", - "created": "2024-02-09T10:50:41+00:00", - "views_count": 1, - "path": "/", - "comment_ids": { - "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" - }, - "antivirus_status": "clean", - "mime_type": "image/png" - } - -``` +--- +sidebar_position: 4 +--- + +# Получить публичный объект + Получает информацию об опубликованном объекте по его URL + + +*Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Количество | --amount | Число | Количество возвращаемых вложенных объектов (для каталога) | + | СмещениеОтНачала | --offset | Число | Смещение для получение вложенных объектов не из начала списка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" + + Ответ = OPI_YandexDisk.ПолучитьПубличныйОбъект(Токен, URL); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьПубличныйОбъект --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --amount %amount% --offset %offset% + + +``` + + +```json title="Результат" + +{ + "modified": "2024-02-09T10:50:41+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/6c21ad3881d0b63ff36b4e8dac62f92bcad19123eb5089651351bfe8bf9a1ffc/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0" + } + ], + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", + "name": "Альпака.png", + "type": "file", + "media_type": "image", + "revision": 1707476320145658, + "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", + "exif": {}, + "size": 440431, + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "owner": { + "uid": "1573541518", + "display_name": "bayselonarrend", + "login": "bayselonarrend" + }, + "file": "https://downloader.disk.yandex.ru/disk/625f72fc8f1f169d498e24b1c3531b81b6e26dc742ecaed842fa527a930965ec/65c63da1/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "preview": "https://downloader.disk.yandex.ru/preview/7d6b87fc78363f962283ce76b3244800b75209a63c6665ef6181a9e27b288ce8/65c63da1/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=0&tknv=v2&size=S&crop=0", + "created": "2024-02-09T10:50:41+00:00", + "views_count": 1, + "path": "/", + "comment_ids": { + "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" + }, + "antivirus_status": "clean", + "mime_type": "image/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 index 381d190b19..281d8ad2db 100644 --- 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 @@ -1,193 +1,193 @@ ---- -sidebar_position: 3 ---- - -# Получить список опубликованных объектов. - Получает список опубликованных объектов - - -*Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Количество | --amount | Число | Количество возвращаемых объектов | - | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - - Ответ = OPI_YandexDisk.ПолучитьСписокОпубликованныхОбъектов(Токен, 2, 1); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ПолучитьСписокОпубликованныхОбъектов --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% - - -``` - - -```json title="Результат" - -{ - "limit": 2, - "offset": 1, - "items": [ - { - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707467847758751, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/ec7c4af09602f08ba661fb602a8e4db7c8ca13285ffbeab9d8506dff136bae19/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-08T16:17:21+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/57195ff44cc3ad6aae4f76ce041f034cbc8d2b58e39de212d8f1a2c3a699db43/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", - "preview": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "size": 440431, - "created": "2024-02-08T16:17:21+00:00", - "type": "file", - "name": "305ac06e-8d73-4d58-ae46-0ea29a7406da.png", - "exif": {}, - "public_url": "https://yadi.sk/i/E_la61R-mzUT5A", - "public_key": "NZQPwaOubeMinNBV4E6vzBEuymih3ZMAHHopRVwcS/Xu163y7YXBNfzquJP61v+5q/J6bpmRyOJonT3VoXnDag==", - "path": "disk:/305ac06e-8d73-4d58-ae46-0ea29a7406da.png", - "antivirus_status": "clean", - "mime_type": "image/png", - "comment_ids": { - "public_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", - "private_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f" - } - }, - { - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707061681378003, - "media_type": "unknown", - "file": "https://downloader.disk.yandex.ru/disk/1901f85f01b5fe49b247379130d99dd0241ceb8f29943842febf7b8da6da3f1f/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=New&disposition=attachment&hash=&limit=0&content_type=mixed&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=unknown&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-02T17:08:06+00:00", - "sizes": [ - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", - "preview": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "size": 440431, - "created": "2024-02-02T17:08:06+00:00", - "type": "file", - "name": "New", - "exif": {}, - "public_url": "https://yadi.sk/i/BpLVpspCDVp0rw", - "public_key": "jOttD+xa1Q27aw1F5pZ2cFZi6bFYThmnpmJkkbmvD1bLErfIx4L0xd2KMy430kUEq/J6bpmRyOJonT3VoXnDag==", - "path": "disk:/New", - "antivirus_status": "clean", - "mime_type": "mixed", - "comment_ids": { - "public_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", - "private_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326" - } - } - ] - } - -``` +--- +sidebar_position: 3 +--- + +# Получить список опубликованных объектов. + Получает список опубликованных объектов + + +*Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Количество | --amount | Число | Количество возвращаемых объектов | + | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + + Ответ = OPI_YandexDisk.ПолучитьСписокОпубликованныхОбъектов(Токен, 2, 1); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ПолучитьСписокОпубликованныхОбъектов --token "y0_AgAAAABdylaOAA..." --amount %amount% --offset %offset% + + +``` + + +```json title="Результат" + +{ + "limit": 2, + "offset": 1, + "items": [ + { + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707467847758751, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/ec7c4af09602f08ba661fb602a8e4db7c8ca13285ffbeab9d8506dff136bae19/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-08T16:17:21+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/57195ff44cc3ad6aae4f76ce041f034cbc8d2b58e39de212d8f1a2c3a699db43/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", + "preview": "https://downloader.disk.yandex.ru/preview/23006fe00bfa57b1864ad410e7ddc2c65c3b55824897c2a7ffbe8d78a64159ff/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=305ac06e-8d73-4d58-ae46-0ea29a7406da.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "size": 440431, + "created": "2024-02-08T16:17:21+00:00", + "type": "file", + "name": "305ac06e-8d73-4d58-ae46-0ea29a7406da.png", + "exif": {}, + "public_url": "https://yadi.sk/i/E_la61R-mzUT5A", + "public_key": "NZQPwaOubeMinNBV4E6vzBEuymih3ZMAHHopRVwcS/Xu163y7YXBNfzquJP61v+5q/J6bpmRyOJonT3VoXnDag==", + "path": "disk:/305ac06e-8d73-4d58-ae46-0ea29a7406da.png", + "antivirus_status": "clean", + "mime_type": "image/png", + "comment_ids": { + "public_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f", + "private_resource": "1573541518:c19122683683dbd529ee214569132fa1f710392869aec1f0981d474d212c910f" + } + }, + { + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707061681378003, + "media_type": "unknown", + "file": "https://downloader.disk.yandex.ru/disk/1901f85f01b5fe49b247379130d99dd0241ceb8f29943842febf7b8da6da3f1f/65c642de/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=New&disposition=attachment&hash=&limit=0&content_type=mixed&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=unknown&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-02T17:08:06+00:00", + "sizes": [ + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", + "preview": "https://downloader.disk.yandex.ru/preview/8ce27e7a570623f7b06d354f0437cda7387958c1e2ee2cc4e35af235e1bd6cd3/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=New&disposition=inline&hash=&limit=0&content_type=image%2Fjpeg&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "size": 440431, + "created": "2024-02-02T17:08:06+00:00", + "type": "file", + "name": "New", + "exif": {}, + "public_url": "https://yadi.sk/i/BpLVpspCDVp0rw", + "public_key": "jOttD+xa1Q27aw1F5pZ2cFZi6bFYThmnpmJkkbmvD1bLErfIx4L0xd2KMy430kUEq/J6bpmRyOJonT3VoXnDag==", + "path": "disk:/New", + "antivirus_status": "clean", + "mime_type": "mixed", + "comment_ids": { + "public_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326", + "private_resource": "1573541518:a02ca75403668d64be8a4fc5ab17864ecd69ef3e3b95f9ec6fe41a64abfc2326" + } + } + ] + } + +``` 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 index 34510676cc..463d75abf3 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md @@ -1,116 +1,116 @@ ---- -sidebar_position: 1 ---- - -# Опубликовать объект - Публикует объект диска в публичный доступ - - -*Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) ЭкспортВозврат ПереключениеОбщегоДоступа(Токен, Путь, Истина);КонецФункции* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | Путь | --path | Строка | Путь к публикуемому объекту | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - Путь = "/Альпака.png" - Ответ = OPI_YandexDisk.ОпубликоватьОбъект(Токен, Путь); //Соответствие; Ссылка на файл - Ответ["public_url"] - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk ОпубликоватьОбъект --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" - - -``` - - -```json title="Результат" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707475863191537, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/8124011f47d668473ec5556e7aa03ed0c825d2bce0777c5f268ab3b133fa366b/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T10:50:41+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/df3f57d6fee627517405de91b959bc7585d9f1ca0afbba833a216be01699d04f/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "size": 440431, - "created": "2024-02-09T10:50:41+00:00", - "type": "file", - "name": "Альпака.png", - "exif": {}, - "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", - "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", - "path": "disk:/Альпака.png", - "antivirus_status": "clean", - "mime_type": "image/png", - "comment_ids": { - "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", - "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" - } - } - -``` +--- +sidebar_position: 1 +--- + +# Опубликовать объект + Публикует объект диска в публичный доступ + + +*Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) ЭкспортВозврат ПереключениеОбщегоДоступа(Токен, Путь, Истина);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к публикуемому объекту | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + Путь = "/Альпака.png" + Ответ = OPI_YandexDisk.ОпубликоватьОбъект(Токен, Путь); //Соответствие; Ссылка на файл - Ответ["public_url"] + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk ОпубликоватьОбъект --token "y0_AgAAAABdylaOAA..." --path "/Альпака.png" + + +``` + + +```json title="Результат" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707475863191537, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/8124011f47d668473ec5556e7aa03ed0c825d2bce0777c5f268ab3b133fa366b/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T10:50:41+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/df3f57d6fee627517405de91b959bc7585d9f1ca0afbba833a216be01699d04f/65c63bd7/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "size": 440431, + "created": "2024-02-09T10:50:41+00:00", + "type": "file", + "name": "Альпака.png", + "exif": {}, + "public_url": "https://yadi.sk/i/txwzakUVtxgjoQ", + "public_key": "O+tgG9OfyuyJgwBRM+BJVaHN3Kg0nH8yi5xbEKU3m+d8vVVsZCwR+LHB8oeN+wcTq/J6bpmRyOJonT3VoXnDag==", + "path": "disk:/Альпака.png", + "antivirus_status": "clean", + "mime_type": "image/png", + "comment_ids": { + "public_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3", + "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" + } + } + +``` 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 index e7152a5f82..dafb52de86 100644 --- 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 @@ -1,117 +1,117 @@ ---- -sidebar_position: 6 ---- - -# Сохранить публичный объект на диск - Сохраняет публичный объект на ваш диск - - -*Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен | - | URL | --url | Строка | Адрес объекта | - | Откуда | --from | Строка | Путь внутри публичного каталога (только для папок) | - | Куда | --to | Строка | Путь сохранения файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex - -```bsl title="Пример кода" - - - Токен = "y0_AgAAAABdylaOAA..."; - URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" - - Ответ = OPI_YandexDisk.СохранитьПубличныйОбъектНаДиск(Токен, URL); //Соответствие - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - - - -``` - -```sh title="Пример команды CLI" - - oint yadisk СохранитьПубличныйОбъектНаДиск --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --from %from% --to %to% - - -``` - - -```json title="Результат" - -{ - "md5": "8d7bf7d7ee61113f9044f3a28496e458", - "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", - "revision": 1707476319349747, - "media_type": "image", - "file": "https://downloader.disk.yandex.ru/disk/e0c18f0f93c86c78b56f0927b8a7b2ff688cbe986c5825cb5b705f387e88ccac/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", - "modified": "2024-02-09T10:58:39+00:00", - "sizes": [ - { - "name": "ORIGINAL", - "url": "https://downloader.disk.yandex.ru/disk/9ad20ff719c0cc685af46a7043850faee074fd93cfbb610a9e0edbd22ec3e459/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" - }, - { - "name": "DEFAULT", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" - }, - { - "name": "XXXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" - }, - { - "name": "XXS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" - }, - { - "name": "XS", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" - }, - { - "name": "S", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - }, - { - "name": "M", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" - }, - { - "name": "L", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" - }, - { - "name": "XL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" - }, - { - "name": "XXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" - }, - { - "name": "XXXL", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" - }, - { - "name": "C", - "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" - } - ], - "resource_id": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", - "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", - "created": "2024-02-09T10:58:39+00:00", - "exif": {}, - "name": "Альпака.png", - "type": "file", - "size": 440431, - "path": "disk:/Загрузки/Альпака.png", - "antivirus_status": "clean", - "comment_ids": { - "public_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", - "private_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3" - }, - "mime_type": "image/png" - } - -``` +--- +sidebar_position: 6 +--- + +# Сохранить публичный объект на диск + Сохраняет публичный объект на ваш диск + + +*Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Откуда | --from | Строка | Путь внутри публичного каталога (только для папок) | + | Куда | --to | Строка | Путь сохранения файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + Токен = "y0_AgAAAABdylaOAA..."; + URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" + + Ответ = OPI_YandexDisk.СохранитьПубличныйОбъектНаДиск(Токен, URL); //Соответствие + Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка + + + +``` + +```sh title="Пример команды CLI" + + oint yadisk СохранитьПубличныйОбъектНаДиск --token "y0_AgAAAABdylaOAA..." --url "https://disk.yandex.by/i/txwzakUVtxgjoQ" --from %from% --to %to% + + +``` + + +```json title="Результат" + +{ + "md5": "8d7bf7d7ee61113f9044f3a28496e458", + "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", + "revision": 1707476319349747, + "media_type": "image", + "file": "https://downloader.disk.yandex.ru/disk/e0c18f0f93c86c78b56f0927b8a7b2ff688cbe986c5825cb5b705f387e88ccac/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458", + "modified": "2024-02-09T10:58:39+00:00", + "sizes": [ + { + "name": "ORIGINAL", + "url": "https://downloader.disk.yandex.ru/disk/9ad20ff719c0cc685af46a7043850faee074fd93cfbb610a9e0edbd22ec3e459/65c63da0/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" + }, + { + "name": "DEFAULT", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2" + }, + { + "name": "XXXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXS&crop=0" + }, + { + "name": "XXS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXS&crop=0" + }, + { + "name": "XS", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XS&crop=0" + }, + { + "name": "S", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + }, + { + "name": "M", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=M&crop=0" + }, + { + "name": "L", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=L&crop=0" + }, + { + "name": "XL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XL&crop=0" + }, + { + "name": "XXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXL&crop=0" + }, + { + "name": "XXXL", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=XXXL&crop=0" + }, + { + "name": "C", + "url": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0" + } + ], + "resource_id": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", + "preview": "https://downloader.disk.yandex.ru/preview/8d337cd1c2b4da544bff6d006bed0b0b7c8defb109da3fa71920174d9c757d52/inf/GyInrPTZYscNNkZ1el2hXGYA_rTREbdNcSWvdp6e5r4TWFuEVaJ-PEvHuuMV9iIpDSzaDO4ey5V7KB1TSxCHmA%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=inline&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&tknv=v2&size=S&crop=0", + "created": "2024-02-09T10:58:39+00:00", + "exif": {}, + "name": "Альпака.png", + "type": "file", + "size": 440431, + "path": "disk:/Загрузки/Альпака.png", + "antivirus_status": "clean", + "comment_ids": { + "public_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3", + "private_resource": "1573541518:cdd95740529a9a67d1b9aa294b1909c1e891b9b9585e117b4cae8a7ffcbfc6a3" + }, + "mime_type": "image/png" + } + +```