diff --git a/docs/md/Airtable/Rabota-s-bazami/Poluchit-spisok-baz.md b/docs/md/Airtable/Rabota-s-bazami/Poluchit-spisok-baz.md new file mode 100644 index 000000000..c93210750 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-bazami/Poluchit-spisok-baz.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Получить список баз + Получает список доступных баз + + +*Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Отступ | --offset | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьСписокБаз --token %token% --offset %offset% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-bazami/Poluchit-tablitsy-bazy.md b/docs/md/Airtable/Rabota-s-bazami/Poluchit-tablitsy-bazy.md new file mode 100644 index 000000000..b002b277c --- /dev/null +++ b/docs/md/Airtable/Rabota-s-bazami/Poluchit-tablitsy-bazy.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить таблицы базы + Получает схему таблиц базы + + +*Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьТаблицыБазы --token %token% --base %base% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-bazami/Sozdat-bazu.md b/docs/md/Airtable/Rabota-s-bazami/Sozdat-bazu.md new file mode 100644 index 000000000..6f9547888 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-bazami/Sozdat-bazu.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 3 +--- + +# Создать базу + Создает новую базу данных + + +*Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | РабочееПространство | --ws | Строка | Идентификатор рабочего пространства | + | Наименование | --title | Строка | Наименование новой базы | + | КоллекцияТаблиц | --tablesdata | Соответствие Из КлючИЗначение | Описание таблиц: Ключ > имя, Значение > массив полей | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable СоздатьБазу --token %token% --ws %ws% --title %title% --tablesdata %tablesdata% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-bazami/_category_.json b/docs/md/Airtable/Rabota-s-bazami/_category_.json new file mode 100644 index 000000000..31b011e1d --- /dev/null +++ b/docs/md/Airtable/Rabota-s-bazami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с базами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Airtable/Rabota-s-kommentariyami/Izmenit-kommentariy.md b/docs/md/Airtable/Rabota-s-kommentariyami/Izmenit-kommentariy.md new file mode 100644 index 000000000..0cce897b7 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-kommentariyami/Izmenit-kommentariy.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 3 +--- + +# Изменить комментарий + Изменяет текст существующего комментария + + +*Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Комментарий | --comment | Строка | Идентификатор комментария | + | Текст | --text | Строка | Новый текст комментария | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ИзменитьКомментарий --token %token% --base %base% --table %table% --record %record% --comment %comment% --text %text% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-kommentariyami/Poluchit-kommentarii.md b/docs/md/Airtable/Rabota-s-kommentariyami/Poluchit-kommentarii.md new file mode 100644 index 000000000..11697e6cd --- /dev/null +++ b/docs/md/Airtable/Rabota-s-kommentariyami/Poluchit-kommentarii.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# Получить комментарии + Получает список комментариев к записи в таблице + + +*Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьКомментарии --token %token% --base %base% --table %table% --record %record% --offset %offset% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-kommentariyami/Sozdat-kommentariy.md b/docs/md/Airtable/Rabota-s-kommentariyami/Sozdat-kommentariy.md new file mode 100644 index 000000000..57f08a67c --- /dev/null +++ b/docs/md/Airtable/Rabota-s-kommentariyami/Sozdat-kommentariy.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 2 +--- + +# Создать комментарий + Создает комментарий к записи в таблице + + +*Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Текст | --text | Строка | Текст комментария | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable СоздатьКомментарий --token %token% --base %base% --table %table% --record %record% --text %text% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-kommentariyami/Udalit-kommentariy.md b/docs/md/Airtable/Rabota-s-kommentariyami/Udalit-kommentariy.md new file mode 100644 index 000000000..0ecec04b1 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-kommentariyami/Udalit-kommentariy.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 4 +--- + +# Удалить комментарий + Удаляет комментарий к записи таблицы + + +*Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + | Комментарий | --comment | Строка | Идентификатор комментария | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable УдалитьКомментарий --token %token% --base %base% --table %table% --record %record% --comment %comment% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-kommentariyami/_category_.json b/docs/md/Airtable/Rabota-s-kommentariyami/_category_.json new file mode 100644 index 000000000..c33ac2192 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-kommentariyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с комментариями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Airtable/Rabota-s-polyami/Izmenit-pole.md b/docs/md/Airtable/Rabota-s-polyami/Izmenit-pole.md new file mode 100644 index 000000000..9b55a44d7 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Izmenit-pole.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 2 +--- + +# Изменить поле + Изменяет имя и|или описание существующего поля таблицы + + +*Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы База | + | Таблица | --table | Строка | Идентификатор таблицы | + | Поле | --field | Строка | Идентификатор поля | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ИзменитьПоле --token %token% --base %base% --table %table% --field %field% --title %title% --description %description% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-chislovoe.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-chislovoe.md new file mode 100644 index 000000000..904094754 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-chislovoe.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Получить поле (числовое) + Получает описание поля числового типа + + +*Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование нового поля | + | Точность | --precision | Число,Строка | Число знаков после запятой | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеНомера --title %title% --precision %precision% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-data.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-data.md new file mode 100644 index 000000000..c224a2234 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-data.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 7 +--- + +# Получить поле (дата) + Получает описание поля типа дата + + +*Функция ПолучитьПолеДаты(Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеДаты --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-email.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-email.md new file mode 100644 index 000000000..7d3ef2517 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-email.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 8 +--- + +# Получить поле (email) + Получает описание поля с электронной почтой + + +*Функция ПолучитьПолеПочты(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "email");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеПочты --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-fayl.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-fayl.md new file mode 100644 index 000000000..e774ebc8e --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-fayl.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 5 +--- + +# Получить поле (файл) + Получает описание поля файлового типа + + +*Функция ПолучитьПолеВложения(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "multipleAttachments");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеВложения --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-flazhok.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-flazhok.md new file mode 100644 index 000000000..ba273d9d2 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-flazhok.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 6 +--- + +# Получить поле (флажок) + Получает описание поля типа булево + + +*Функция ПолучитьПолеФлажка(Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеФлажка --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-strokovoe.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-strokovoe.md new file mode 100644 index 000000000..c0ccbea8f --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-strokovoe.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 3 +--- + +# Получить поле (строковое) + Получает описание поля строкового типа + + +*Функция ПолучитьПолеСтроковое(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "richText");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование нового поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеСтроковое --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-telefon.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-telefon.md new file mode 100644 index 000000000..a0652147c --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-telefon.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 9 +--- + +# Получить поле (телефон) + Получает описание поля с номером телефона + + +*Функция ПолучитьПолеТелефона(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "phoneNumber");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеТелефона --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-url.md b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-url.md new file mode 100644 index 000000000..e062abeaa --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Poluchit-pole-url.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 10 +--- + +# Получить поле (url) + Получает описание поля с URL + + +*Функция ПолучитьПолеСсылки(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "url");КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование поля | + + + Вовзращаемое значение: Структура - Описание поля + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьПолеСсылки --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/Sozdat-pole.md b/docs/md/Airtable/Rabota-s-polyami/Sozdat-pole.md new file mode 100644 index 000000000..16cf5446e --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/Sozdat-pole.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Создать поле + Создет новое поле в таблице + + +*Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Таблица | --table | Строка | Идентификатор таблицы | + | СтруктураПоля | --fielddata | Структура Из КлючИЗначение | Описание нового поля | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable СоздатьПоле --token %token% --base %base% --table %table% --fielddata %fielddata% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-polyami/_category_.json b/docs/md/Airtable/Rabota-s-polyami/_category_.json new file mode 100644 index 000000000..717a2f672 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-polyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с полями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Airtable/Rabota-s-tablitsami/Izmenit-tablitsu.md b/docs/md/Airtable/Rabota-s-tablitsami/Izmenit-tablitsu.md new file mode 100644 index 000000000..adf74286d --- /dev/null +++ b/docs/md/Airtable/Rabota-s-tablitsami/Izmenit-tablitsu.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 2 +--- + +# Изменить таблицу + Изменяет наименование и|или описание базы + + +*Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Таблица | --table | Строка | Идентификатор таблицы | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ИзменитьТаблицу --token %token% --base %base% --table %table% --title %title% --description %description% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-tablitsami/Sozdat-tablitsu.md b/docs/md/Airtable/Rabota-s-tablitsami/Sozdat-tablitsu.md new file mode 100644 index 000000000..ae83d6b02 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-tablitsami/Sozdat-tablitsu.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# Создать таблицу + Создает новую таблицу в базе + + +*Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы | + | Наименование | --title | Строка | Наименование новой таблицы | + | МассивПолей | --fieldsdata | Массив Из Структура | Массив описаний полей | + | Описание | --description | Строка | Описание таблицы | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable СоздатьТаблицу --token %token% --base %base% --title %title% --fieldsdata %fieldsdata% --description %description% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-tablitsami/_category_.json b/docs/md/Airtable/Rabota-s-tablitsami/_category_.json new file mode 100644 index 000000000..4e574c0df --- /dev/null +++ b/docs/md/Airtable/Rabota-s-tablitsami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с таблицами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Airtable/Rabota-s-zapisyami/Poluchit-spisok-zapisey.md b/docs/md/Airtable/Rabota-s-zapisyami/Poluchit-spisok-zapisey.md new file mode 100644 index 000000000..5eb092683 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-zapisyami/Poluchit-spisok-zapisey.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Получить список записей + Получает список записей выбранной таблицы + + +*Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьСписокЗаписей --token %token% --base %base% --table %table% --offset %offset% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-zapisyami/Poluchit-zapis.md b/docs/md/Airtable/Rabota-s-zapisyami/Poluchit-zapis.md new file mode 100644 index 000000000..2a09cfc4a --- /dev/null +++ b/docs/md/Airtable/Rabota-s-zapisyami/Poluchit-zapis.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 2 +--- + +# Получить запись + Получает данные строки таблицы по идентификатору + + +*Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Запись | --record | Строка | Идентификатор записи в таблице | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable ПолучитьЗапись --token %token% --base %base% --table %table% --record %record% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-zapisyami/Sozdat-zapisi.md b/docs/md/Airtable/Rabota-s-zapisyami/Sozdat-zapisi.md new file mode 100644 index 000000000..273fe632f --- /dev/null +++ b/docs/md/Airtable/Rabota-s-zapisyami/Sozdat-zapisi.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 3 +--- + +# Создать записи + Создает одну или массив записей по описанию или массиву описаний значений полей + + +*Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Данные | --data | Структура, Массив из Структура | Набор или массив наборов пар Ключ : Значение > Поле : Показатель | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable СоздатьЗаписи --token %token% --base %base% --table %table% --data %data% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-zapisyami/Udalit-zapisi.md b/docs/md/Airtable/Rabota-s-zapisyami/Udalit-zapisi.md new file mode 100644 index 000000000..0a30055ab --- /dev/null +++ b/docs/md/Airtable/Rabota-s-zapisyami/Udalit-zapisi.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 4 +--- + +# Удалить записи + Удаляет одну или массив записей по идентификаторам + + +*Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | Идентификатор базы данных | + | Таблица | --table | Строка | Идентификатор таблицы | + | Записи | --records | Строка, Массив из Строка | Идентификатор или массив индентификаторов записей | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint airtable УдалитьЗаписи --token %token% --base %base% --table %table% --records %records% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Airtable/Rabota-s-zapisyami/_category_.json b/docs/md/Airtable/Rabota-s-zapisyami/_category_.json new file mode 100644 index 000000000..601d10856 --- /dev/null +++ b/docs/md/Airtable/Rabota-s-zapisyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с записями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Obnovit-token.md b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Obnovit-token.md new file mode 100644 index 000000000..aa120a60f --- /dev/null +++ b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Obnovit-token.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 3 +--- + +# Обновить токен + Получает новый токен на основе рефреш токена + + +*Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + | СекретПриложения | --appsecret | Строка | Секрет приложения | + | РефрешТокен | --refresh | Строка | Рефреш токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Ключ = "oynqxds..."; + Секрет = "tk2oewn..."; + Рефреш = "MJIG2TBhD-kAAAAAAAAAAd3oNph_4iTy..."; + + Результат = OPI_Dropbox.ОбновитьТокен(Ключ, Секрет, Рефреш); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ОбновитьТокен --appkey %appkey% --appsecret %appsecret% --refresh %refresh% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-dannye-ispolzovaniya-prostranstva.md b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-dannye-ispolzovaniya-prostranstva.md new file mode 100644 index 000000000..2588bc57c --- /dev/null +++ b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-dannye-ispolzovaniya-prostranstva.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 5 +--- + +# Получить данные использования пространства + Получает информацию о количестве использованного дискового пространства + + +*Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьДанныеИспользованияПространства --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-informatsiu-ob-akkaunte.md b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-informatsiu-ob-akkaunte.md new file mode 100644 index 000000000..3f3faaf97 --- /dev/null +++ b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-informatsiu-ob-akkaunte.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 4 +--- + +# Получить информацию об аккаунте + Получает информацию об аккаунте + + +*Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Аккаунт | --account | Строка | ID аккаунта. Текущий аккаунт токена, если не заполнено | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьИнформациюОбАккаунте --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --account %account% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-ssylku-avtorizatsii.md b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-ssylku-avtorizatsii.md new file mode 100644 index 000000000..c016f87af --- /dev/null +++ b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-ssylku-avtorizatsii.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Получить ссылку авторизации + Генерирует ссылку авторизации для перехода в браузере + + +*Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + + + Вовзращаемое значение: Строка - URL для перехода в браузере + +```bsl title="Пример кода" + + Ключ = "oynqxds..."; + Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(Ключ); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьСсылкуАвторизации --appkey %appkey% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-token.md b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-token.md new file mode 100644 index 000000000..7be483105 --- /dev/null +++ b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/Poluchit-token.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Получить токен + Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации + + +*Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | КлючПриложения | --appkey | Строка | Ключ приложения | + | СекретПриложения | --appsecret | Строка | Секрет приложения | + | Код | --code | Строка | Код со страницы авторизации | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьТокен --appkey %appkey% --appsecret %appsecret% --code %code% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/_category_.json b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/_category_.json new file mode 100644 index 000000000..7cb939708 --- /dev/null +++ b/docs/md/Dropbox/Akkaunt-i-avtorizatsiya/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Аккаунт и авторизация", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Dobavit-polzovateley-k-papke.md b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Dobavit-polzovateley-k-papke.md new file mode 100644 index 000000000..ef29c5ac9 --- /dev/null +++ b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Dobavit-polzovateley-k-papke.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 4 +--- + +# Добавить пользователей к папке + Предоставляет стороннии пользователям доступ к каталогу + + +*Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | + | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | + | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Почта = "h5bk6ft62s@privaterelay.appleid.com"; + Папка = "4999224241"; // shared_folder_id + + Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ДобавитьПользователейКПапке --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --folder %folder% --emails %emails% --readonly %readonly% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Dobavit-polzovatelya-k-faylu.md b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Dobavit-polzovatelya-k-faylu.md new file mode 100644 index 000000000..2816a2713 --- /dev/null +++ b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Dobavit-polzovatelya-k-faylu.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 3 +--- + +# Добавить пользователя к файлу + Определяет доступ к файлу для стороннего пользователя + + +*Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ | + | АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей | + | ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Почта = "h5bk6ft62s@privaterelay.appleid.com"; + Файл = "kJU6-a-pT48AAAAAAAAABw"; + + Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ДобавитьПользователейКФайлу --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --fileid %fileid% --emails %emails% --readonly %readonly% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Opublikovat-papku.md b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Opublikovat-papku.md new file mode 100644 index 000000000..a6e9ff364 --- /dev/null +++ b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Opublikovat-papku.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 1 +--- + +# Опубликовать папку + Переводит каталог в режим публичного доступа + + +*Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к целевому каталогу | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New"; + + Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ОпубликоватьПапку --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Otmenit-publikatsiu-papki.md b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Otmenit-publikatsiu-papki.md new file mode 100644 index 000000000..65470c631 --- /dev/null +++ b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/Otmenit-publikatsiu-papki.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 2 +--- + +# Отменить публикацию папки + Отменяет режим общего доступа для каталога + + +*Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Папка = "4999224241"; + + Результат = OPI_Dropbox.ОтменитьПубликациюПапки(Токен, Папка); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ОтменитьПубликациюПапки --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --folder %folder% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/_category_.json b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/_category_.json new file mode 100644 index 000000000..0dee62cc0 --- /dev/null +++ b/docs/md/Dropbox/Nastroyki-sovmestnogo-dostupa/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Настройки совместного доступа", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Kopirovat-obekt.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Kopirovat-obekt.md new file mode 100644 index 000000000..b9cbf1bf6 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Kopirovat-obekt.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 8 +--- + +# Копировать объект + Копирует файл или каталог по выбранному пути + + +*Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --form | Строка | Путь к объекту оригинала | + | Куда | --to | Строка | Целевой путь для нового объекта | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Оригинал = "/New/pic.png"; + Копия = "/New/pic_copy.png"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox КопироватьОбъект --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --form %form% --to %to% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Peremestit-obekt.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Peremestit-obekt.md new file mode 100644 index 000000000..1883e690a --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Peremestit-obekt.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 9 +--- + +# Переместить объект + Перемещает объект по выбранному пути + + +*Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --form | Строка | Путь к объекту оригинала | + | Куда | --to | Строка | Целевой путь для нового объекта | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + ОригиналныйПуть = "/New/pic.png"; + ЦелевойПуть = "/pic.png"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПереместитьОбъект --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --form %form% --to %to% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-informatsiu-ob-obekte.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-informatsiu-ob-obekte.md new file mode 100644 index 000000000..93cd1e894 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-informatsiu-ob-obekte.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +# Получить информацию об объекте + Получает информацию о файле или каталоге + + +*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/pic.png"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьИнформациюОбОбъекте --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --detail %detail% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-prevu.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-prevu.md new file mode 100644 index 000000000..a5bf099cb --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-prevu.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 3 +--- + +# Получить превью + Получает PDF или HTML превью объекта (только для токументов) + + +*Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + + + Вовзращаемое значение: ДвоичныеДанные - превью документа + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьПревью --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-spisok-faylov-papki.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-spisok-faylov-papki.md new file mode 100644 index 000000000..9fcc9e621 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-spisok-faylov-papki.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 2 +--- + +# Получить список файлов папки + Получает список первых файлов каталога или продолжает получение следующих при указании курсора + + +*Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к каталогу. Необязателен, если указан курсор | + | Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов | + | Курсор | --cursor | Строка | Курсор из предыдущего запроса для получения следующего набора файлов | + + + Вовзращаемое значение: HTTPОтвет - Получить список файлов папки + +```bsl title="Пример кода" + + Путь = "/New"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьСписокФайловПапки --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --detail %detail% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-spisok-versiy-obekta.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-spisok-versiy-obekta.md new file mode 100644 index 000000000..d098367f2 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-spisok-versiy-obekta.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 13 +--- + +# Получить список версий объекта + Получает список версий (ревизий) объекта + + +*Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Количество | --amount | Строка, Число | Число последних версий объекта для отображения | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьСписокВерсийОбъекта --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --amount %amount% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-status-zagruzki-po-url.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-status-zagruzki-po-url.md new file mode 100644 index 000000000..10e19fe14 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Poluchit-status-zagruzki-po-url.md @@ -0,0 +1,50 @@ +--- +sidebar_position: 6 +--- + +# Получить статус загрузки по URL + Получает статус загрузки файла по URL + + +*Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDРаботы | --job | Строка | ID асинхронной работы из ответа ЗагрузитьФайлПоURL | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + ИДРаботы = "kwvJIcRS7eAAAAAAAAAAAQ"; + Статус = "in_progress"; + + Пока Статус = "in_progress" Цикл + + Результат = OPI_Dropbox.ПолучитьСтатусЗагрузкиПоURL(Токен, ИДРаботы); + Статус = Результат[".tag"]; + + OPI_Инструменты.Пауза(5); + + OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьСтатусЗагрузкиПоURL", "Dropbox"); + + КонецЦикла; + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьСтатусЗагрузкиПоURL --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --job %job% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Skachat-fayl.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Skachat-fayl.md new file mode 100644 index 000000000..5e0c8a1b2 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Skachat-fayl.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 11 +--- + +# Скачать файл + Скачивает файл по указанному пути или ID + + +*Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь или ID файла | + + + Вовзращаемое значение: ДвоичныеДанные - двоичные данные файла + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox СкачатьФайл --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Skachat-papku.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Skachat-papku.md new file mode 100644 index 000000000..477e35ed3 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Skachat-papku.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 12 +--- + +# Скачать папку + Скачивает zip архив с содержимым указанного каталога + + +*Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь или ID каталога | + + + Вовзращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New"; + + Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox СкачатьПапку --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Sozdat-papku.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Sozdat-papku.md new file mode 100644 index 000000000..cde90c061 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Sozdat-papku.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 10 +--- + +# Создать папку + Создает пустой каталог по выбранному пути + + +*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Целевой путь создания каталога | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/Новый каталог"; + + Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox СоздатьПапку --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Udalit-obekt.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Udalit-obekt.md new file mode 100644 index 000000000..198620352 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Udalit-obekt.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 7 +--- + +# Удалить объект + Удаляет объект с облачного диска + + +*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту удаления | + | БезВозвратно | --permanently | Строка | Удалить объект без возможности востановления | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/pic.png"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + + Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox УдалитьОбъект --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --permanently %permanently% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Vostanovit-obekt-k-versii.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Vostanovit-obekt-k-versii.md new file mode 100644 index 000000000..d336f3383 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Vostanovit-obekt-k-versii.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 14 +--- + +# Востановить объект к версии + Востанавливает состояние объекта к необходимой версии (ревизии) + + +*Функция ВостановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту | + | Версия | --rev | Строка | ID версии (ревизии) для востановления | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Версия = "61947933c4742bd841553"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New/pic.png"; + + Результат = OPI_Dropbox.ВостановитьОбъектКВерсии(Токен, Путь, Версия); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ВостановитьОбъектКВерсии --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --rev "61947933c4742bd841553" + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Zagruzit-fayl-po-url.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Zagruzit-fayl-po-url.md new file mode 100644 index 000000000..7ac0a0d05 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Zagruzit-fayl-po-url.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 5 +--- + +# Загрузить файл по URL + Загружает файл на облачный диск, получая его по указанному URL + + +*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URLФайла | --url | Строка | URL источник файла | + | Путь | --path | Строка | Путь сохранения на Dropbox | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/url_doc.docx"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + URL = "https://openintegrations.dev/test_data/document.docx"; + + Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ЗагрузитьФайлПоURL --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --url %url% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Zagruzit-fayl.md b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Zagruzit-fayl.md new file mode 100644 index 000000000..5361c421d --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/Zagruzit-fayl.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 4 +--- + +# Загрузить файл + Загружает файл на облачный диск + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Файл | --file | Строка, ДвоичныеДанные | Данные файл для загрузки | + | Путь | --path | Строка | Путь сохранения на Dropbox | + | Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Путь = "/New/pic.png"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; + + КартинкаПуть = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, КартинкаПуть); + + Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ЗагрузитьФайл --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --file %file% --path %path% --overwrite %overwrite% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/_category_.json b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/_category_.json new file mode 100644 index 000000000..4e6e0610b --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-faylami-i-katalogami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с файлами и каталогами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Dropbox/Rabota-s-tegami/Dobavit-teg.md b/docs/md/Dropbox/Rabota-s-tegami/Dobavit-teg.md new file mode 100644 index 000000000..b1517659d --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-tegami/Dobavit-teg.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 2 +--- + +# Добавить тег + Добавляет новый текстовый тег к файлу или каталогу + + +*Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту, для которого необходимо создать тег | + | Тег | --tag | Строка | Текст тега | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Тег = "Важное"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ДобавитьТег --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --tag %tag% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-tegami/Poluchit-spisok-tegov.md b/docs/md/Dropbox/Rabota-s-tegami/Poluchit-spisok-tegov.md new file mode 100644 index 000000000..3f0c9de84 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-tegami/Poluchit-spisok-tegov.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Получить список тегов + Получает список тегов выбранных файлов + + +*Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Пути | --paths | Строка, Массив Из Строка | Путь или набору путей к файлам | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint dropbox ПолучитьСписокТегов --token %token% --paths %paths% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-tegami/Udalit-teg.md b/docs/md/Dropbox/Rabota-s-tegami/Udalit-teg.md new file mode 100644 index 000000000..c31de5551 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-tegami/Udalit-teg.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 3 +--- + +# Удалить тег + Удаляет текстовый тег файла или каталога + + +*Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к объекту, тег которого необходимо удалить | + | Тег | --tag | Строка | Текст тега | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + +```bsl title="Пример кода" + + Тег = "Важное"; + Токен = "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..."; + Путь = "/New/mydoc.docx"; + + Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег); + + +``` + +```sh title="Пример команд CLI" + + oint dropbox УдалитьТег --token "sl.B17cqxbDyPFFIOUOnGtEqpFGF9gIqUvxX70TTaWmpA1BudA7xI0IR4UK3WuJkeHL7f229VtvwT..." --path %path% --tag %tag% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Dropbox/Rabota-s-tegami/_category_.json b/docs/md/Dropbox/Rabota-s-tegami/_category_.json new file mode 100644 index 000000000..45203f7d4 --- /dev/null +++ b/docs/md/Dropbox/Rabota-s-tegami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с тегами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Izmenit-kalendar.md b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Izmenit-kalendar.md new file mode 100644 index 000000000..d66948b95 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Izmenit-kalendar.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 3 +--- + +# Изменить календарь + Изменяет свойства существуещего календаря + + +*Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Наименование | --title | Строка | Новое наименование | + | Описание | --description | Строка | Новое описание календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ИзменитьМетаданныеКалендаря --token %token% --calendar %calendar% --title %title% --description %description% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Ochistit-osnovnoy-kalendar.md b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Ochistit-osnovnoy-kalendar.md new file mode 100644 index 000000000..47b370782 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Ochistit-osnovnoy-kalendar.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 4 +--- + +# Очистить основной календарь + Очищает список событий основного календаря + + +*Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ОчиститьОсновнойКалендарь --token %token% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Poluchit-kalendar.md b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Poluchit-kalendar.md new file mode 100644 index 000000000..5dba77e2f --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Poluchit-kalendar.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить календарь + Получает информацию о календаре по ID + + +*Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПолучитьМетаданныеКалендаря --token %token% --calendar %calendar% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Sozdat-kalendar.md b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Sozdat-kalendar.md new file mode 100644 index 000000000..9fa3d0c8a --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Sozdat-kalendar.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Создать календарь + Создает пустой календарь + + +*Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Наименование | --title | Строка | Наименование создаваемого календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar СоздатьКалендарь --token %token% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Udalit-kalendar.md b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Udalit-kalendar.md new file mode 100644 index 000000000..6891a5410 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/Udalit-kalendar.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 5 +--- + +# Удалить календарь + Удаляет календарь по ID + + +*Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar УдалитьКалендарь --token %token% --calendar %calendar% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/_category_.json b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/_category_.json new file mode 100644 index 000000000..f4e182739 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-metadannymi-kalendarey/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с метаданными календарей", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Izmenit-sobytie.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Izmenit-sobytie.md new file mode 100644 index 000000000..d81235f3b --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Izmenit-sobytie.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +--- + +# Изменить событие + Изменяет существующее событие + + +*Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия, Событие);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОписаниеСобытия | --props | Строка | Новое описание события | + | Событие | --event | Строка | ID события | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ИзменитьСобытие --token %token% --calendar %calendar% --props %props% --event %event% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Peremestit-sobytie.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Peremestit-sobytie.md new file mode 100644 index 000000000..638d74cc4 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Peremestit-sobytie.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 5 +--- + +# Переместить событие + Перемещает событие в другой календарь + + +*Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | КалендарьИсточник | --from | Строка | ID календаря источника | + | КалендарьПриемник | --to | Строка | ID календаря приемника | + | Событие | --event | Строка | ID события календаря источника | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПереместитьСобытие --token %token% --from %from% --to %to% --event %event% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-opisanie-sobytiya-.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-opisanie-sobytiya-.md new file mode 100644 index 000000000..0ea3230e6 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-opisanie-sobytiya-.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +# Получить описание события + + + +*Функция ПолучитьОписаниеСобытия() Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПолучитьОписаниеСобытия + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-sobytie.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-sobytie.md new file mode 100644 index 000000000..cee285bba --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-sobytie.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Получить событие + Получает событие по ID + + +*Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Событие | --event | Строка | ID события | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПолучитьСобытие --token %token% --calendar %calendar% --event %event% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-spisok-sobytiy.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-spisok-sobytiy.md new file mode 100644 index 000000000..1f6ff6b9d --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Poluchit-spisok-sobytiy.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить список событий + Получает список всех событий календаря + + +*Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПолучитьСписокСобытий --token %token% --calendar %calendar% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Sozdat-sobytie.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Sozdat-sobytie.md new file mode 100644 index 000000000..273309d07 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Sozdat-sobytie.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Создать событие + Создает новое событие + + +*Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОписаниеСобытия | --props | Соответствие Из КлючИЗначение | Описание события | + + + Вовзращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar СоздатьСобытие --token %token% --calendar %calendar% --props %props% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/Udalit-sobytie.md b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Udalit-sobytie.md new file mode 100644 index 000000000..681b1b8fa --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/Udalit-sobytie.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 7 +--- + +# Удалить событие + Удаляет событие по ID + + +*Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | Событие | --event | Строка | ID события | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar УдалитьСобытие --token %token% --calendar %calendar% --event %event% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-s-sobytiyami/_category_.json b/docs/md/Google_Calendar/Rabota-s-sobytiyami/_category_.json new file mode 100644 index 000000000..274a5946d --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-s-sobytiyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с событиями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Dobavit-kalendar-v-spisok.md b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Dobavit-kalendar-v-spisok.md new file mode 100644 index 000000000..cf46de87d --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Dobavit-kalendar-v-spisok.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Добавить календарь в список + Добавляет существующий календарь в список пользователя + + +*Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ДобавитьКалендарьВСписок --token %token% --calendar %calendar% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Izmenit-kalendar-spiska.md b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Izmenit-kalendar-spiska.md new file mode 100644 index 000000000..ee5c7bcf3 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Izmenit-kalendar-spiska.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 5 +--- + +# Изменить календарь списка + Изменяет свойства календаря из списка пользователей + + +*Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + | ОсновнойЦвет | --primary | Строка | HEX основного цвета (#ffffff) | + | ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (#ffffff) | + | Скрытый | --hidden | Булево | Скрытый календарь | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ИзменитьКалендарьСписка --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Poluchit-kalendar-spiska.md b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Poluchit-kalendar-spiska.md new file mode 100644 index 000000000..ff9840cdb --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Poluchit-kalendar-spiska.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить календарь списка + Получает календарь из списка пользователя по ID + + +*Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПолучитьКалендарьСписка --token %token% --calendar %calendar% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Poluchit-spisok-kalendarey.md b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Poluchit-spisok-kalendarey.md new file mode 100644 index 000000000..4cbcac4a1 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Poluchit-spisok-kalendarey.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить список календарей + Получает массив календарей аккаунта + + +*Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar ПолучитьСписокКалендарей --token %token% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Udalit-kalendar-iz-spiska.md b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Udalit-kalendar-iz-spiska.md new file mode 100644 index 000000000..d5a775948 --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/Udalit-kalendar-iz-spiska.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Удалить календарь из списка + Удаляет календарь из списка пользователя + + +*Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Календарь | --calendar | Строка | ID календаря | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gcalendar УдалитьКалендарьИзСписка --token %token% --calendar %calendar% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/_category_.json b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/_category_.json new file mode 100644 index 000000000..2c98030fc --- /dev/null +++ b/docs/md/Google_Calendar/Rabota-so-spiskom-kalendarey/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа со списком календарей", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Obnovit-fayl.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Obnovit-fayl.md new file mode 100644 index 000000000..2ea4c190b --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Obnovit-fayl.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 8 +--- + +# Обновить файл + Обновляет двоичные данные файла + + +*Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор обновляемого объекта | + | Файл | --file | ДвоичныеДанные,Строка | Файл источник обновления | + | НовоеИмя | --title | Строка | Новое имя файла (если необходимо) | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ОбновитьФайл --token %token% --object %object% --file %file% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-informatsiu-ob-obekte.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-informatsiu-ob-obekte.md new file mode 100644 index 000000000..547fe3a2c --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-informatsiu-ob-obekte.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Получить информацию об объекте + Получает информацию о папке или файле по ID + + +*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор файла или каталога | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ПолучитьИнформациюОбОбъекте --token %token% --object %object% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-opisanie-fayla-.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-opisanie-fayla-.md new file mode 100644 index 000000000..644800659 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-opisanie-fayla-.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 10 +--- + +# Получить описание файла + + + +*Функция ПолучитьОписаниеФайла() Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Описание файла + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ПолучитьОписаниеФайла + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-spisok-faylov.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-spisok-faylov.md new file mode 100644 index 000000000..e21c145b9 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-spisok-faylov.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Получить список файлов + Получает список файлов + + +*Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяСодержит | --querry | Строка | Отбор по имени | + | Каталог | --catalog | Строка | Отбор по ID каталога родителя | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ПолучитьСписокФайлов --token %token% --querry %querry% --catalog %catalog% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-spisok-katalogov.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-spisok-katalogov.md new file mode 100644 index 000000000..8da75ef6e --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Poluchit-spisok-katalogov.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Получить список каталогов + Получает список каталогов диска + + +*Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяСодержит | --querry | Строка | Отбор по имени | + | Подробно | --depth | Булево | Добавляет список файлов к полям каталога | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ПолучитьСписокКаталогов --token %token% --querry %querry% --depth %depth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Skachat-fayl.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Skachat-fayl.md new file mode 100644 index 000000000..3eab648ef --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Skachat-fayl.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 6 +--- + +# Скачать файл + Получает файл по ID + + +*Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор файла | + | ПутьСохранения | --out | Строка | Путь сохранения файла | + + + Вовзращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive СкачатьФайл --token %token% --object %object% --out %out% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Skoprirovat-obekt.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Skoprirovat-obekt.md new file mode 100644 index 000000000..7bba2da53 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Skoprirovat-obekt.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 7 +--- + +# Скоприровать объект + Копирует файл или каталог + + +*Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта | + | НовоеИмя | --title | Строка | Новое имя объекта | + | НовыйРодитель | --catalog | Строка | Новый каталог размещения | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive СкопироватьОбъект --token %token% --object %object% --title %title% --catalog %catalog% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Sozdat-papku.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Sozdat-papku.md new file mode 100644 index 000000000..f18c636a0 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Sozdat-papku.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 5 +--- + +# Создать папку + Создает пустой каталог на диске + + +*Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Имя | --title | Строка | Имя папки | + | Родитель | --catalog | Строка | Родитель | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive СоздатьПапку --token %token% --title %title% --catalog %catalog% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Udalit-obekt.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Udalit-obekt.md new file mode 100644 index 000000000..79cc546a3 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Udalit-obekt.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 9 +--- + +# Удалить объект + Удаляет файл или каталог по ID + + +*Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта для удаления | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive УдалитьОбъект --token %token% --object %object% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Zagruzit-fayl.md b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Zagruzit-fayl.md new file mode 100644 index 000000000..af5f5e310 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/Zagruzit-fayl.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Загрузить файл + Загружает файл на диск + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) ЭкспортВозврат УправлениеФайлом(Токен, Файл, Описание);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Файл | --file | ДвоичныеДанные,Строка | Загружаемый файл | + | Описание | --props | Соответствие Из КлючИЗначение | JSON описания или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ЗагрузитьФайл --token %token% --file %file% --props %props% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/_category_.json b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/_category_.json new file mode 100644 index 000000000..4e6e0610b --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-faylami-i-katalogami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с файлами и каталогами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Drive/Rabota-s-kommentariyami/Poluchit-kommentariy.md b/docs/md/Google_Drive/Rabota-s-kommentariyami/Poluchit-kommentariy.md new file mode 100644 index 000000000..7b5a924b9 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-kommentariyami/Poluchit-kommentariy.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Получить комментарий + Получает комментарий по ID + + +*Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | + | ИДКомментария | --comment | Строка | Идентификатор комментария | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ПолучитьКомментарий --token %token% --object %object% --comment %comment% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-kommentariyami/Poluchit-spisok-kommentariev.md b/docs/md/Google_Drive/Rabota-s-kommentariyami/Poluchit-spisok-kommentariev.md new file mode 100644 index 000000000..d8d389a71 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-kommentariyami/Poluchit-spisok-kommentariev.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить список комментариев + Получает список всех комментариев объекта + + +*Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор объекта | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive ПолучитьСписокКомментариев --token %token% --object %object% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-kommentariyami/Sozdat-kommentariy.md b/docs/md/Google_Drive/Rabota-s-kommentariyami/Sozdat-kommentariy.md new file mode 100644 index 000000000..10a93e37c --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-kommentariyami/Sozdat-kommentariy.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Создать комментарий + Создает комментарий к файлу или каталогу + + +*Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --object | Строка | Идентификатор объекта, для которого необходим комментарий | + | Комментарий | --text | Строка | Текст комментария | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive СоздатьКомментарий --token %token% --object %object% --text %text% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-kommentariyami/Udalit-kommentariy.md b/docs/md/Google_Drive/Rabota-s-kommentariyami/Udalit-kommentariy.md new file mode 100644 index 000000000..d1044385c --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-kommentariyami/Udalit-kommentariy.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Удалить комментарий + Удаляет комментарий по ID + + +*Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария | + | ИДКомментария | --comment | Строка | Идентификатор комментария | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gdrive УдалитьКомментарий --token %token% --object %object% --comment %comment% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Drive/Rabota-s-kommentariyami/_category_.json b/docs/md/Google_Drive/Rabota-s-kommentariyami/_category_.json new file mode 100644 index 000000000..c33ac2192 --- /dev/null +++ b/docs/md/Google_Drive/Rabota-s-kommentariyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с комментариями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Sheets/Rabota-s-dannymi/Ochistit-yacheyki.md b/docs/md/Google_Sheets/Rabota-s-dannymi/Ochistit-yacheyki.md new file mode 100644 index 000000000..a06e1b5a4 --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-dannymi/Ochistit-yacheyki.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 2 +--- + +# Очистить ячейки + Очищает значение в ячейках + + +*Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для очистки | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets ОчиститьЯчейки --token %token% --spreadsheet %spreadsheet% --cells %cells% --sheetname %sheetname% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-dannymi/Poluchit-znacheniya-yacheek.md b/docs/md/Google_Sheets/Rabota-s-dannymi/Poluchit-znacheniya-yacheek.md new file mode 100644 index 000000000..110645ab7 --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-dannymi/Poluchit-znacheniya-yacheek.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 3 +--- + +# Получить значения ячеек + Получает значения ячеек таблицы + + +*Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для получения (весь лист, если не заполнено) | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets ПолучитьЗначенияЯчеек --token %token% --spreadsheet %spreadsheet% --cells %cells% --sheetname %sheetname% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-dannymi/Ustanovit-znacheniya-yacheek.md b/docs/md/Google_Sheets/Rabota-s-dannymi/Ustanovit-znacheniya-yacheek.md new file mode 100644 index 000000000..43fea1b45 --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-dannymi/Ustanovit-znacheniya-yacheek.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# Установить значения ячеек + Устанавливает значения ячеек листа + + +*Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | СоответствиеЗначений | --data | Соответствие Из КлючИЗначение | Данные заполнения, где ключ это имя ячейки вида A1 | + | Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) | + | ОсновноеИзмерение | --dim | Строка | Основное измерение при заполнении диапазона массивом | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets УстановитьЗначенияЯчеек --token %token% --spreadsheet %spreadsheet% --data %data% --sheetname %sheetname% --dim %dim% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-dannymi/_category_.json b/docs/md/Google_Sheets/Rabota-s-dannymi/_category_.json new file mode 100644 index 000000000..bafd7539a --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-dannymi/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с данными", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Sheets/Rabota-s-knigami/Izmenit-naimenovanie-knigi.md b/docs/md/Google_Sheets/Rabota-s-knigami/Izmenit-naimenovanie-knigi.md new file mode 100644 index 000000000..21dde322a --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-knigami/Izmenit-naimenovanie-knigi.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Изменить наименование книги + Изменяет наименование существующей книги + + +*Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | ID книги | + | Наименование | --title | Строка | Новое наименование | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets ИзменитьНаименованиеКниги --token %token% --spreadsheet %spreadsheet% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-knigami/Poluchit-knigu.md b/docs/md/Google_Sheets/Rabota-s-knigami/Poluchit-knigu.md new file mode 100644 index 000000000..16ed70207 --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-knigami/Poluchit-knigu.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить книгу + Получает информацию о книге по ID + + +*Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Идентификатор | --spreadsheet | Строка | Идентификатор книги | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets ПолучитьКнигу --token %token% --spreadsheet %spreadsheet% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-knigami/Sozdat-knigu.md b/docs/md/Google_Sheets/Rabota-s-knigami/Sozdat-knigu.md new file mode 100644 index 000000000..e90a42b15 --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-knigami/Sozdat-knigu.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Создать книгу + Создает новую книгу + + +*Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Наименование | --title | Строка | Наименование | + | МассивИменЛистов | --sheets | Массив из Строка | Массив имен для добавления новых листов в книгу | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets СоздатьКнигу --token %token% --title %title% --sheets %sheets% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-knigami/_category_.json b/docs/md/Google_Sheets/Rabota-s-knigami/_category_.json new file mode 100644 index 000000000..a8c3e774d --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-knigami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с книгами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Sheets/Rabota-s-listami/Dobavit-list.md b/docs/md/Google_Sheets/Rabota-s-listami/Dobavit-list.md new file mode 100644 index 000000000..2986eadbf --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-listami/Dobavit-list.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Добавить лист + Добавляет новый лист в книгу + + +*Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | Идентификатор книги | + | Наименование | --title | Строка | Наименование нового листа | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets ДобавитьЛист --token %token% --spreadsheet %spreadsheet% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-listami/Kopirovat-list.md b/docs/md/Google_Sheets/Rabota-s-listami/Kopirovat-list.md new file mode 100644 index 000000000..aa27165cb --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-listami/Kopirovat-list.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 3 +--- + +# Копировать лист + Копирует лист из одной книги в другую + + +*Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Откуда | --from | Строка | ID книги источника | + | Куда | --to | Строка | ID книги приемника | + | Лист | --sheet | Строка | ID копируемого листа | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets КопироватьЛист --token %token% --from %from% --to %to% --sheet %sheet% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-listami/Udalit-list.md b/docs/md/Google_Sheets/Rabota-s-listami/Udalit-list.md new file mode 100644 index 000000000..5d0d9c1e6 --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-listami/Udalit-list.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Удалить лист + Удаляет лист из книги + + +*Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Книга | --spreadsheet | Строка | Идентификатор книги | + | Лист | --sheet | Строка | Идентификатор удаляемого листа | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint gsheets УдалитьЛист --token %token% --spreadsheet %spreadsheet% --sheet %sheet% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Sheets/Rabota-s-listami/_category_.json b/docs/md/Google_Sheets/Rabota-s-listami/_category_.json new file mode 100644 index 000000000..21209b0bf --- /dev/null +++ b/docs/md/Google_Sheets/Rabota-s-listami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с листами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Google_Workspace/Programmnyy-interfeys/Obnovit-token.md b/docs/md/Google_Workspace/Programmnyy-interfeys/Obnovit-token.md new file mode 100644 index 000000000..be99411f2 --- /dev/null +++ b/docs/md/Google_Workspace/Programmnyy-interfeys/Obnovit-token.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Обновить токен + Обновляет токен по Refresh token + + +*Функция ОбновитьТокен(Знач ClientID, Знач ClientSecret, Знач RefreshToken) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ClientID | --id | Строка | Client ID | + | ClientSecret | --secret | Строка | Client secret | + | RefreshToken | --refresh | Строка | Refresh token | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint google ОбновитьТокен --id %id% --secret %secret% --refresh %refresh% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Workspace/Programmnyy-interfeys/Poluchit-token-po-kodu.md b/docs/md/Google_Workspace/Programmnyy-interfeys/Poluchit-token-po-kodu.md new file mode 100644 index 000000000..8d4bb7008 --- /dev/null +++ b/docs/md/Google_Workspace/Programmnyy-interfeys/Poluchit-token-po-kodu.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Получить токен по коду + Получает токен по коду из авторизации в бразуере + + +*Функция ПолучитьТокенПоКоду(Знач ClientID, Знач ClientSecret, Знач Code) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ClientID | --id | Строка | Client ID | + | ClientSecret | --secret | Строка | Client secret | + | Code | --code | Строка | Code из браузера | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint google ПолучитьТокенПоКоду --id %id% --secret %secret% --code %code% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Workspace/Programmnyy-interfeys/Sformirovat-ssylku-polucheniya-koda.md b/docs/md/Google_Workspace/Programmnyy-interfeys/Sformirovat-ssylku-polucheniya-koda.md new file mode 100644 index 000000000..0417fc88e --- /dev/null +++ b/docs/md/Google_Workspace/Programmnyy-interfeys/Sformirovat-ssylku-polucheniya-koda.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Сформировать ссылку получения кода + Возвращает URL для авторизации в браузере + + +*Функция СформироватьСсылкуПолученияКода(Знач ClientID, Знач Calendar = Истина, Знач Drive = Истина, Знач Sheets = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ClientID | --id | Строка | Client ID | + | Calendar | --calendar | Булево | разрешение на методы Calendar | + | Drive | --drive | Булево | разрешение на методы Drive | + | Sheets | --sheets | Булево | разрешение на методы Sheets | + + + Вовзращаемое значение: Строка - Ссылка получения кода + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint google СформироватьСсылкуПолученияКода --id %id% --calendar %calendar% --drive %drive% --sheets %sheets% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Google_Workspace/Programmnyy-interfeys/_category_.json b/docs/md/Google_Workspace/Programmnyy-interfeys/_category_.json new file mode 100644 index 000000000..2edf112a0 --- /dev/null +++ b/docs/md/Google_Workspace/Programmnyy-interfeys/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Программный интерфейс", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Notion/Polzovateli/Poluchit-dannye-polzovatelya.md b/docs/md/Notion/Polzovateli/Poluchit-dannye-polzovatelya.md new file mode 100644 index 000000000..96535b434 --- /dev/null +++ b/docs/md/Notion/Polzovateli/Poluchit-dannye-polzovatelya.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить данные пользователя + Получает данные пользователя по ID + + +*Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДПользователя | --user | Строка | ID целевого пользователя | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ПолучитьДанныеПользователя --token %token% --user %user% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Polzovateli/Spisok-polzovateley.md b/docs/md/Notion/Polzovateli/Spisok-polzovateley.md new file mode 100644 index 000000000..b4fc53af1 --- /dev/null +++ b/docs/md/Notion/Polzovateli/Spisok-polzovateley.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Список пользователей + Возвращает список пользователей рабочего пространства + + +*Функция СписокПользователей(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion СписокПользователей --token %token% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Polzovateli/_category_.json b/docs/md/Notion/Polzovateli/_category_.json new file mode 100644 index 000000000..dddc927c7 --- /dev/null +++ b/docs/md/Notion/Polzovateli/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Пользователи", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Notion/Rabota-s-bazami-dannyh/Izmenit-svoystva-bazy.md b/docs/md/Notion/Rabota-s-bazami-dannyh/Izmenit-svoystva-bazy.md new file mode 100644 index 000000000..686a9d024 --- /dev/null +++ b/docs/md/Notion/Rabota-s-bazami-dannyh/Izmenit-svoystva-bazy.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 3 +--- + +# Изменить свойства базы + Изменяет свойства существующей базы + + +*Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | ID целевой базы | + | Свойства | --props | Соответствие из КлючИЗначение | Новые или изменяемые свойства базы данных | + | Заголовок | --title | Строка | Новый заголовок базы | + | Описание | --description | Строка | Новое описание базы | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ИзменитьСвойстваБазы --token %token% --base %base% --props %props% --title %title% --description %description% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-bazami-dannyh/Poluchit-bazu-dannyh.md b/docs/md/Notion/Rabota-s-bazami-dannyh/Poluchit-bazu-dannyh.md new file mode 100644 index 000000000..7e4748f72 --- /dev/null +++ b/docs/md/Notion/Rabota-s-bazami-dannyh/Poluchit-bazu-dannyh.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить базу данных + Получить данные о базе данных + + +*Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | База | --base | Строка | ID базы данных | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ПолучитьБазуДанных --token %token% --base %base% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-bazami-dannyh/Sozdat-bazu-dannyh.md b/docs/md/Notion/Rabota-s-bazami-dannyh/Sozdat-bazu-dannyh.md new file mode 100644 index 000000000..ab1af12d0 --- /dev/null +++ b/docs/md/Notion/Rabota-s-bazami-dannyh/Sozdat-bazu-dannyh.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Создать базу данных + Создает базу данных + + +*Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID страницы родителя | + | Заголовок | --title | Строка | Заголовок базы данных | + | Свойства | --props | Структура Из Строка | Свойства базы данных | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion СоздатьБазуДанных --token %token% --page %page% --title %title% --props %props% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-bazami-dannyh/_category_.json b/docs/md/Notion/Rabota-s-bazami-dannyh/_category_.json new file mode 100644 index 000000000..681486577 --- /dev/null +++ b/docs/md/Notion/Rabota-s-bazami-dannyh/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с базами данных", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Notion/Rabota-s-blokami/Sozdat-blok.md b/docs/md/Notion/Rabota-s-blokami/Sozdat-blok.md new file mode 100644 index 000000000..8820e922f --- /dev/null +++ b/docs/md/Notion/Rabota-s-blokami/Sozdat-blok.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Создать блок + Создает новый блок на основе существующего блока + + +*Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID родительского блока или страницы | + | Блок | --block | Строка,Соответствие Из КлючИЗначение | ID блока или сам блок образец | + | ВставитьПосле | --prev | Строка | ID блока, после которого необходимо встаивть новый | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion СоздатьБлок --token %token% --page %page% --block %block% --prev %prev% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-blokami/Udalit-blok.md b/docs/md/Notion/Rabota-s-blokami/Udalit-blok.md new file mode 100644 index 000000000..efebba6af --- /dev/null +++ b/docs/md/Notion/Rabota-s-blokami/Udalit-blok.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Удалить блок + Удаляет блок по ID + + +*Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion УдалитьБлок --token %token% --block %block% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-blokami/Vernut-blok..md b/docs/md/Notion/Rabota-s-blokami/Vernut-blok..md new file mode 100644 index 000000000..4ae3cae15 --- /dev/null +++ b/docs/md/Notion/Rabota-s-blokami/Vernut-blok..md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Вернуть блок. + + + +*Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока | + | ТолькоОснова | --core | Булево | Истина > служебные поля удаляются, остается только сам блок | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ВернутьБлок --token %token% --block %block% --core %core% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-blokami/Vernut-dochernie-bloki.md b/docs/md/Notion/Rabota-s-blokami/Vernut-dochernie-bloki.md new file mode 100644 index 000000000..ca12198cd --- /dev/null +++ b/docs/md/Notion/Rabota-s-blokami/Vernut-dochernie-bloki.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Вернуть дочерние блоки + Созвращает список дочерних блоков блока-родителя + + +*Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИДБлока | --block | Строка | ID блока родителя | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ВернутьДочерниеБлоки --token %token% --block %block% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-s-blokami/_category_.json b/docs/md/Notion/Rabota-s-blokami/_category_.json new file mode 100644 index 000000000..18bc40dbe --- /dev/null +++ b/docs/md/Notion/Rabota-s-blokami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с блоками", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Notion/Rabota-so-stranitsami/Izmenit-svoystva-stranitsy..md b/docs/md/Notion/Rabota-so-stranitsami/Izmenit-svoystva-stranitsy..md new file mode 100644 index 000000000..cb7bfda2c --- /dev/null +++ b/docs/md/Notion/Rabota-so-stranitsami/Izmenit-svoystva-stranitsy..md @@ -0,0 +1,40 @@ +--- +sidebar_position: 4 +--- + +# Изменить свойства страницы. + + + +*Функция ИзменитьСвойстваСтраницы(Знач Токен, Знач Страница, Знач Данные = "", Знач Иконка = "", Знач Обложка = "", Знач Архивирована = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Страница | --page | Строка | ID изменяемой страницы | + | Данные | --data | Соответствие Из КлючИЗначение | Соответствие изменяемых параметров | + | Иконка | --icon | Строка | URL картинки иконки страницы | + | Обложка | --cover | Строка | URL картинки обложки страницы | + | Архивирована | --archive | Булево | Архивировать страницу или нет (булево) | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ИзменитьСвойстваСтраницы --token %token% --page %page% --data %data% --icon %icon% --cover %cover% --archive %archive% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-so-stranitsami/Poluchit-stranitsu.md b/docs/md/Notion/Rabota-so-stranitsami/Poluchit-stranitsu.md new file mode 100644 index 000000000..345d1fd93 --- /dev/null +++ b/docs/md/Notion/Rabota-so-stranitsami/Poluchit-stranitsu.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить страницу + Получает информацию о странице по ID + + +*Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Страница | --page | Строка | ID страницы | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion ПолучитьСтраницу --token %token% --page %page% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-so-stranitsami/Sozdat-stranitsu-v-bazu.md b/docs/md/Notion/Rabota-so-stranitsami/Sozdat-stranitsu-v-bazu.md new file mode 100644 index 000000000..c5b8475eb --- /dev/null +++ b/docs/md/Notion/Rabota-so-stranitsami/Sozdat-stranitsu-v-bazu.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Создать страницу в базу + Создает страницу в базе-родителе + + +*Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --base | Строка | ID родительской базы | + | Данные | --data | Соответствие Из КлючИЗначение | Соответствие свойств | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion СоздатьСтраницуВБазу --token %token% --base %base% --data %data% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-so-stranitsami/Sozdat-stranitsu.md b/docs/md/Notion/Rabota-so-stranitsami/Sozdat-stranitsu.md new file mode 100644 index 000000000..396055bb7 --- /dev/null +++ b/docs/md/Notion/Rabota-so-stranitsami/Sozdat-stranitsu.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Создать страницу + Создает дочернюю страницу над другой страницей-родителем + + +*Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Родитель | --page | Строка | ID Родителя | + | Заголовок | --title | Строка | Заголовок страницы | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint notion СоздатьСтраницу --token %token% --page %page% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Notion/Rabota-so-stranitsami/_category_.json b/docs/md/Notion/Rabota-so-stranitsami/_category_.json new file mode 100644 index 000000000..9e2e5637a --- /dev/null +++ b/docs/md/Notion/Rabota-so-stranitsami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа со страницами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Formirovanie-blokov/Sformirovat-blok-kartinku.md b/docs/md/Slack/Formirovanie-blokov/Sformirovat-blok-kartinku.md new file mode 100644 index 000000000..d0c60e03e --- /dev/null +++ b/docs/md/Slack/Formirovanie-blokov/Sformirovat-blok-kartinku.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Сформировать блок картинку + Формирует блок с картинкой для добавления в массив блоков сообщения + + +*Функция СформироватьБлокКартинку(Знач URL, Знач АльтернативныйТекст = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --picture | Строка | URL картинки | + | АльтернативныйТекст | --alt | Строка | Альтернативный текст картинки | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Блок картинки + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack СформироватьБлокКартинку --picture %picture% --alt %alt% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Formirovanie-blokov/_category_.json b/docs/md/Slack/Formirovanie-blokov/_category_.json new file mode 100644 index 000000000..6f07b1b64 --- /dev/null +++ b/docs/md/Slack/Formirovanie-blokov/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Формирование блоков", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Rabota-s-dialogami/Otkryt-dialog.md b/docs/md/Slack/Rabota-s-dialogami/Otkryt-dialog.md new file mode 100644 index 000000000..25e5e695c --- /dev/null +++ b/docs/md/Slack/Rabota-s-dialogami/Otkryt-dialog.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Открыть диалог + Открывает новый диалог с одним или несколькими пользователями + + +*Функция ОткрытьДиалог(Знач Токен, Знач МассивПользователей) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | МассивПользователей | --users | Массив из Строка | Массив ID пользователей | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ОткрытьДиалог --token %token% --users %users% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-dialogami/Zakryt-dialog.md b/docs/md/Slack/Rabota-s-dialogami/Zakryt-dialog.md new file mode 100644 index 000000000..db57ce7ab --- /dev/null +++ b/docs/md/Slack/Rabota-s-dialogami/Zakryt-dialog.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Закрыть диалог + Закрывает существующий диалог + + +*Функция ЗакрытьДиалог(Знач Токен, Знач Диалог) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Диалог | --conv | Строка | ID диалога | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ЗакрытьДиалог --token %token% --conv %conv% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-dialogami/_category_.json b/docs/md/Slack/Rabota-s-dialogami/_category_.json new file mode 100644 index 000000000..0d2b8f709 --- /dev/null +++ b/docs/md/Slack/Rabota-s-dialogami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с диалогами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Rabota-s-faylami/Poluchit-dannye-fayla.md b/docs/md/Slack/Rabota-s-faylami/Poluchit-dannye-fayla.md new file mode 100644 index 000000000..05dac4af4 --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/Poluchit-dannye-fayla.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить данные файла + Получает информацию о файле + + +*Функция ПолучитьДанныеФайла(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьДанныеФайла --token %token% --fileid %fileid% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-faylami/Poluchit-spisok-faylov.md b/docs/md/Slack/Rabota-s-faylami/Poluchit-spisok-faylov.md new file mode 100644 index 000000000..f35530abc --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/Poluchit-spisok-faylov.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Получить список файлов + Получает список файлов бота или канала + + +*Функция ПолучитьСписокФайлов(Знач Токен, Знач Канал = "", Знач НомерСтраницы = 1) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Канал для отбора | + | НомерСтраницы | --page | Число, Строка | Номер страницы | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокФайлов --token %token% --channel %channel% --page %page% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-faylami/Sdelat-fayl-privatnym.md b/docs/md/Slack/Rabota-s-faylami/Sdelat-fayl-privatnym.md new file mode 100644 index 000000000..2ee1b93e1 --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/Sdelat-fayl-privatnym.md @@ -0,0 +1,36 @@ +--- +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/md/Slack/Rabota-s-faylami/Sdelat-fayl-publichnym.md b/docs/md/Slack/Rabota-s-faylami/Sdelat-fayl-publichnym.md new file mode 100644 index 000000000..d0308a6f2 --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/Sdelat-fayl-publichnym.md @@ -0,0 +1,36 @@ +--- +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/md/Slack/Rabota-s-faylami/Udalit-fayl.md b/docs/md/Slack/Rabota-s-faylami/Udalit-fayl.md new file mode 100644 index 000000000..cb62b0f6b --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/Udalit-fayl.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Удалить файл + Удаляет файл на Slack + + +*Функция УдалитьФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack УдалитьФайл --token %token% --fileid %fileid% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-faylami/Zagruzit-fayl.md b/docs/md/Slack/Rabota-s-faylami/Zagruzit-fayl.md new file mode 100644 index 000000000..46fc17343 --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/Zagruzit-fayl.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 2 +--- + +# Загрузить файл + Загружает файл на сервера Slack + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач ИмяФайла, Знач Заголовок, Знач Канал = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | + | ИмяФайла | --filename | Строка | Имя файла с расширением | + | Заголовок | --title | Строка | Имя файла в Slack | + | Канал | --channel | Строка | ID канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ЗагрузитьФайл --token %token% --file %file% --filename %filename% --title %title% --channel %channel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-faylami/_category_.json b/docs/md/Slack/Rabota-s-faylami/_category_.json new file mode 100644 index 000000000..c08ab3ce5 --- /dev/null +++ b/docs/md/Slack/Rabota-s-faylami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с файлами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Rabota-s-kanalami/Arhivirovat-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Arhivirovat-kanal.md new file mode 100644 index 000000000..9ca32d0b0 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Arhivirovat-kanal.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Архивировать канал + Архивирует активный канал + + +*Функция АрхивироватьКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack АрхивироватьКанал --token %token% --channel %channel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Pereimenovat-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Pereimenovat-kanal.md new file mode 100644 index 000000000..1fad686e2 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Pereimenovat-kanal.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 13 +--- + +# Переименовать канал + Изменяет название канала + + +*Функция ПереименоватьКанал(Знач Токен, Знач Канал, Знач Название) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Название | --title | Строка | Новое название канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПереименоватьКанал --token %token% --channel %channel% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Pokinut-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Pokinut-kanal.md new file mode 100644 index 000000000..2194b373c --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Pokinut-kanal.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 10 +--- + +# Покинуть канал + Удаляет текущего бота из канала + + +*Функция ПокинутьКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПокинутьКанал --token %token% --channel %channel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Poluchit-istoriu-kanala.md b/docs/md/Slack/Rabota-s-kanalami/Poluchit-istoriu-kanala.md new file mode 100644 index 000000000..1072e7d85 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Poluchit-istoriu-kanala.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 6 +--- + +# Получить историю канала + Получает информацию событиях канала + + +*Функция ПолучитьИсториюКанала(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьИсториюКанала --token %token% --channel %channel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Poluchit-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Poluchit-kanal.md new file mode 100644 index 000000000..3329b055d --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Poluchit-kanal.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 5 +--- + +# Получить канал + Получает информацию о канале + + +*Функция ПолучитьКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьКанал --token %token% --channel %channel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Poluchit-spisok-kanalov.md b/docs/md/Slack/Rabota-s-kanalami/Poluchit-spisok-kanalov.md new file mode 100644 index 000000000..cf8b4ad82 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Poluchit-spisok-kanalov.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Получить список каналов + Получает список доступных каналов + + +*Функция ПолучитьСписокКаналов(Знач Токен, Знач ИсключатьАрхивированные = Ложь, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИсключатьАрхивированные | --notarchived | Булево | Признак исключения архивированных каналов | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокКаналов --token %token% --notarchived %notarchived% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Poluchit-spisok-polzovateley-kanala.md b/docs/md/Slack/Rabota-s-kanalami/Poluchit-spisok-polzovateley-kanala.md new file mode 100644 index 000000000..bb7b3f835 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Poluchit-spisok-polzovateley-kanala.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +--- + +# Получить список пользователей канала + Получает список пользователей указанного канала + + +*Функция ПолучитьСписокПользователейКанала(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокПользователейКанала --token %token% --channel %channel% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Priglasit-polzovateley-v-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Priglasit-polzovateley-v-kanal.md new file mode 100644 index 000000000..259f57f7f --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Priglasit-polzovateley-v-kanal.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 7 +--- + +# Пригласить пользователей в канал + Добавляет указанных пользователей в канал + + +*Функция ПригласитьПользователейВКанал(Знач Токен, Знач Канал, Знач МассивПользователей) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | МассивПользователей | --users | Массив Из Строка | Массив ID пользователей | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПригласитьПользователейВКанал --token %token% --channel %channel% --users %users% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Sozdat-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Sozdat-kanal.md new file mode 100644 index 000000000..9d68caf18 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Sozdat-kanal.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Создать канал + Создает новый канал + + +*Функция СоздатьКанал(Знач Токен, Знач Название, Знач Приватный = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Название | --title | Строка | Наименование канала | + | Приватный | --private | Булево | Создать канал приватным | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack СоздатьКанал --token %token% --title %title% --private %private% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Ustanovit-temu-kanala.md b/docs/md/Slack/Rabota-s-kanalami/Ustanovit-temu-kanala.md new file mode 100644 index 000000000..44294d289 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Ustanovit-temu-kanala.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 11 +--- + +# Установить тему канала + Устанавливает тему канала + + +*Функция УстановитьТемуКанала(Знач Токен, Знач Канал, Знач Тема) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Тема | --theme | Строка | Тема канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack УстановитьТемуКанала --token %token% --channel %channel% --theme %theme% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Ustanovit-tsel-kanala.md b/docs/md/Slack/Rabota-s-kanalami/Ustanovit-tsel-kanala.md new file mode 100644 index 000000000..38d135321 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Ustanovit-tsel-kanala.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 12 +--- + +# Установить цель канала + Устанавливает цель (описание) канала + + +*Функция УстановитьЦельКанала(Знач Токен, Знач Канал, Знач Цель) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Цель | --purpose | Строка | Цель канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack УстановитьЦельКанала --token %token% --channel %channel% --purpose %purpose% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Vstupit-v-kanal.md b/docs/md/Slack/Rabota-s-kanalami/Vstupit-v-kanal.md new file mode 100644 index 000000000..e1ce6c16e --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Vstupit-v-kanal.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 9 +--- + +# Вступить в канал + Добавляет текущего бота в канал + + +*Функция ВступитьВКанал(Знач Токен, Знач Канал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ВступитьВКанал --token %token% --channel %channel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/Vygnat-polzovatelya-iz-kanala.md b/docs/md/Slack/Rabota-s-kanalami/Vygnat-polzovatelya-iz-kanala.md new file mode 100644 index 000000000..cc411dfc7 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/Vygnat-polzovatelya-iz-kanala.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 8 +--- + +# Выгнать пользователя из канала + Удаляет указанного пользователя из канала + + +*Функция ВыгнатьПользователяИзКанала(Знач Токен, Знач Канал, Знач Пользователь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | ID канала | + | Пользователь | --user | Строка | ID пользователя | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ВыгнатьПользователяИзКанала --token %token% --channel %channel% --user %user% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-kanalami/_category_.json b/docs/md/Slack/Rabota-s-kanalami/_category_.json new file mode 100644 index 000000000..f132ac973 --- /dev/null +++ b/docs/md/Slack/Rabota-s-kanalami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с каналами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Izmenit-soobschenie.md b/docs/md/Slack/Rabota-s-soobscheniyami/Izmenit-soobschenie.md new file mode 100644 index 000000000..a11e1dbea --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Izmenit-soobschenie.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 3 +--- + +# Изменить сообщение + Изменяет состав существующего сообщения + + +*Функция ИзменитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Текст = "", Знач МассивБлоков = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка сообщения | + | Текст | --text | Строка | Новый текст сообщения | + | МассивБлоков | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ИзменитьСообщение --token %token% --channel %channel% --stamp %stamp% --text %text% --blocks %blocks% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Otpravit-efemernoe-soobschenie.md b/docs/md/Slack/Rabota-s-soobscheniyami/Otpravit-efemernoe-soobschenie.md new file mode 100644 index 000000000..48297f1fa --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Otpravit-efemernoe-soobschenie.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 2 +--- + +# Отправить эфемерное сообщение +Отправляет сообщение, которое приходит в канал, но видно только конкретному пользователю + + +*Функция ОтправитьЭфемерноеСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач Пользователь = "", Знач Блоки = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Текст | --text | Строка | Текст сообщения | + | Пользователь | --user | Строка | ID пользователя | + | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ОтправитьЭфемерноеСообщение --token %token% --channel %channel% --text %text% --user %user% --blocks %blocks% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Otpravit-soobschenie.md b/docs/md/Slack/Rabota-s-soobscheniyami/Otpravit-soobschenie.md new file mode 100644 index 000000000..cc7c18219 --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Otpravit-soobschenie.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# Отправить сообщение + Отправляет сообщение в выбранный час + + +*Функция ОтправитьСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач ДатаОтправки = "", Знач Блоки = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Текст | --text | Строка | Текст сообщения | + | ДатаОтправки | --date | Дата | Дата отправки для отложенного сообщения | + | Блоки | --blocks | Массив Из Структура | JSON массива описаний блоков | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ОтправитьСообщение --token %token% --channel %channel% --text %text% --date %date% --blocks %blocks% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-spisok-otlozhennyh-soobscheniy.md b/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-spisok-otlozhennyh-soobscheniy.md new file mode 100644 index 000000000..4249b9d1d --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-spisok-otlozhennyh-soobscheniy.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 5 +--- + +# Получить список отложенных сообщений + Получает список отложенных сообщений канала + + +*Функция ПолучитьСписокОтложенныхСообщений(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокОтложенныхСообщений --token %token% --channel %channel% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-spisok-otvetov-na-soobschenie.md b/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-spisok-otvetov-na-soobschenie.md new file mode 100644 index 000000000..38060b264 --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-spisok-otvetov-na-soobschenie.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 7 +--- + +# Получить список ответов на сообщение + Получает массив сообщений, которые являются ответом на указанное + + +*Функция ПолучитьСписокОтветовНаСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокОтветовНаСообщение --token %token% --channel %channel% --stamp %stamp% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-ssylku-na-soobschenie.md b/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-ssylku-na-soobschenie.md new file mode 100644 index 000000000..e14380f36 --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Poluchit-ssylku-na-soobschenie.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 6 +--- + +# Получить ссылку на сообщение + Получает постоянный UTL к сообщению канала + + +*Функция ПолучитьСсылкуНаСообщение(Знач Токен, Знач Канал, Знач Отметка) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСсылкуНаСообщение --token %token% --channel %channel% --stamp %stamp% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/Udalit-soobschenie.md b/docs/md/Slack/Rabota-s-soobscheniyami/Udalit-soobschenie.md new file mode 100644 index 000000000..18654ca74 --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/Udalit-soobschenie.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 4 +--- + +# Удалить сообщение + Удаляет сообщение канала по timestamp + + +*Функция УдалитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач ЭтоОтложенное = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Идентификатор канала | + | Отметка | --stamp | Строка | Временная отметка или ID сообщения | + | ЭтоОтложенное | --issheduled | Булево | Признак удаления отложенного сообщения | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack УдалитьСообщение --token %token% --channel %channel% --stamp %stamp% --issheduled %issheduled% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-soobscheniyami/_category_.json b/docs/md/Slack/Rabota-s-soobscheniyami/_category_.json new file mode 100644 index 000000000..115046190 --- /dev/null +++ b/docs/md/Slack/Rabota-s-soobscheniyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с сообщениями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Rabota-s-udalennymi-faylami/Dobavit-vneshniy-fayl.md b/docs/md/Slack/Rabota-s-udalennymi-faylami/Dobavit-vneshniy-fayl.md new file mode 100644 index 000000000..13a2c6b2e --- /dev/null +++ b/docs/md/Slack/Rabota-s-udalennymi-faylami/Dobavit-vneshniy-fayl.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Добавить внешний файл + Добавляет новый внешний файл + + +*Функция ДобавитьВнешнийФайл(Знач Токен, Знач URL, Знач Заголовок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | URL | --url | Строка | URL к внешнему файлу | + | Заголовок | --title | Строка | Заголовок файла для Slack | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ДобавитьВнешнийФайл --token %token% --url %url% --title %title% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-udalennymi-faylami/Otpravit-vneshniy-fayl.md b/docs/md/Slack/Rabota-s-udalennymi-faylami/Otpravit-vneshniy-fayl.md new file mode 100644 index 000000000..a8524f569 --- /dev/null +++ b/docs/md/Slack/Rabota-s-udalennymi-faylami/Otpravit-vneshniy-fayl.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Отправить внешний файл + Отправляет внейшний файл по списку каналов + + +*Функция ОтправитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла, Знач МассивКаналов) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + | МассивКаналов | --channels | Массив Из Строка | Массив каналов для отправки | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ОтправитьВнешнийФайл --token %token% --fileid %fileid% --channels %channels% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-udalennymi-faylami/Poluchit-spisok-vneshnih-faylov.md b/docs/md/Slack/Rabota-s-udalennymi-faylami/Poluchit-spisok-vneshnih-faylov.md new file mode 100644 index 000000000..3dfe98f22 --- /dev/null +++ b/docs/md/Slack/Rabota-s-udalennymi-faylami/Poluchit-spisok-vneshnih-faylov.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Получить список внешних файлов + Получает список внешних файлов пользователя или канала + + +*Функция ПолучитьСписокВнешнихФайлов(Знач Токен, Знач Канал = "", Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Канал | --channel | Строка | Канал для отбора | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокВнешнихФайлов --token %token% --channel %channel% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-udalennymi-faylami/Poluchit-vneshniy-fayl.md b/docs/md/Slack/Rabota-s-udalennymi-faylami/Poluchit-vneshniy-fayl.md new file mode 100644 index 000000000..5e4083503 --- /dev/null +++ b/docs/md/Slack/Rabota-s-udalennymi-faylami/Poluchit-vneshniy-fayl.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить внешний файл + Получает информацию о внешнем файле + + +*Функция ПолучитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьВнешнийФайл --token %token% --fileid %fileid% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-udalennymi-faylami/Udalit-vneshniy-fayl.md b/docs/md/Slack/Rabota-s-udalennymi-faylami/Udalit-vneshniy-fayl.md new file mode 100644 index 000000000..a0fd7efb9 --- /dev/null +++ b/docs/md/Slack/Rabota-s-udalennymi-faylami/Udalit-vneshniy-fayl.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 5 +--- + +# Удалить внешний файл + Удаляет внешний файл из Slack + + +*Функция УдалитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | ИдентификаторФайла | --fileid | Строка | Идентификатор файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack УдалитьВнешнийФайл --token %token% --fileid %fileid% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Rabota-s-udalennymi-faylami/_category_.json b/docs/md/Slack/Rabota-s-udalennymi-faylami/_category_.json new file mode 100644 index 000000000..0c70a6fbb --- /dev/null +++ b/docs/md/Slack/Rabota-s-udalennymi-faylami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с удаленными файлами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-informatsiu-o-bote.md b/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-informatsiu-o-bote.md new file mode 100644 index 000000000..b28fddb73 --- /dev/null +++ b/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-informatsiu-o-bote.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить информацию о боте + Получает основную информацию о боте + + +*Функция ПолучитьИнформациюОБоте(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьИнформациюОБоте --token %token% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-spisok-polzovateley.md b/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-spisok-polzovateley.md new file mode 100644 index 000000000..41d551863 --- /dev/null +++ b/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-spisok-polzovateley.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить список пользователей + Получает список пользователей рабочей области + + +*Функция ПолучитьСписокПользователей(Знач Токен, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокПользователей --token %token% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-spisok-rabochih-oblastey.md b/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-spisok-rabochih-oblastey.md new file mode 100644 index 000000000..6594b3f3e --- /dev/null +++ b/docs/md/Slack/Upravlenie-i-nastroyki/Poluchit-spisok-rabochih-oblastey.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить список рабочих областей + Получает список рабочих областей, в которых подключен бот + + +*Функция ПолучитьСписокРабочихОбластей(Знач Токен, Знач Курсор = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | Курсор | --cursor | Строка | Указатель из предыдущего запроса, если строк результата > 100 | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint slack ПолучитьСписокРабочихОбластей --token %token% --cursor %cursor% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Slack/Upravlenie-i-nastroyki/_category_.json b/docs/md/Slack/Upravlenie-i-nastroyki/_category_.json new file mode 100644 index 000000000..1e012ab17 --- /dev/null +++ b/docs/md/Slack/Upravlenie-i-nastroyki/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Управление и настройки", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Twitter/Dannye-i-nastroyka/.md b/docs/md/Twitter/Dannye-i-nastroyka/.md new file mode 100644 index 000000000..80b8953dc --- /dev/null +++ b/docs/md/Twitter/Dannye-i-nastroyka/.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 4 +--- + +# +Метод для вставки в http-сервис, адрес которого указывается в redirect_uri Вызывает метод получения токена, так как для получения токена из кода, приходящего на redirect_uri после авторизации через браузер есть всего 30 секунд + + +*Функция ОбработкаВходящегоЗапросаПослеАвторизации(Запрос) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Запрос | --сервис | HTTPСервисЗапрос | Запрос, приходящий на http | + + + Вовзращаемое значение: HTTPОтвет, Произвольный, ДвоичныеДанные - Результат чтения JSON ответа сервера + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter ОбработкаВходящегоЗапросаПослеАвторизации --сервис %сервис% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Dannye-i-nastroyka/Obnovit-token.md b/docs/md/Twitter/Dannye-i-nastroyka/Obnovit-token.md new file mode 100644 index 000000000..ab47174d0 --- /dev/null +++ b/docs/md/Twitter/Dannye-i-nastroyka/Obnovit-token.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 3 +--- + +# Обновить токен + Обновляет v2 токен при помощи refresh_token + + +*Функция ОбновитьТокен(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter ОбновитьТокен --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Dannye-i-nastroyka/Poluchit-ssylku-dlya-avtorizatsii.md b/docs/md/Twitter/Dannye-i-nastroyka/Poluchit-ssylku-dlya-avtorizatsii.md new file mode 100644 index 000000000..736d42352 --- /dev/null +++ b/docs/md/Twitter/Dannye-i-nastroyka/Poluchit-ssylku-dlya-avtorizatsii.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить ссылку для авторизации + Формирует ссылку для авторизации через браузер + + +*Функция ПолучитьСсылкуАвторизации(Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Строка - URL для перехода в браузере + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter ПолучитьСсылкуАвторизации --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Dannye-i-nastroyka/Poluchit-token.md b/docs/md/Twitter/Dannye-i-nastroyka/Poluchit-token.md new file mode 100644 index 000000000..f24f75591 --- /dev/null +++ b/docs/md/Twitter/Dannye-i-nastroyka/Poluchit-token.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить токен + Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации + + +*Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Код | --code | Строка | Код, полученный из авторизации См.ПолучитьСсылкуАвторизации | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter ПолучитьТокен --code %code% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Dannye-i-nastroyka/_category_.json b/docs/md/Twitter/Dannye-i-nastroyka/_category_.json new file mode 100644 index 000000000..8e095beb8 --- /dev/null +++ b/docs/md/Twitter/Dannye-i-nastroyka/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Данные и настройка", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Twitter/Tvity/.md b/docs/md/Twitter/Tvity/.md new file mode 100644 index 000000000..58319b7a7 --- /dev/null +++ b/docs/md/Twitter/Tvity/.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# + Создать произвольный твит + + +*Функция СоздатьПроизвольныйТвит(Знач Текст = "", Знач МассивМедиа = "", Знач МассивВариантовОпроса = "", Знач ДлительностьОпроса = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | | Строка | Текст твита | + | МассивМедиа | | Массив из Строка,ДвоичныеДанные | Массив двоичных данных или путей к файлам | + | МассивВариантовОпроса | | Массив из Строка | Массив вариантов опроса, если необходимо | + | ДлительностьОпроса | | Строка,Число | Длительность опроса, если необходимо (опрос без длительности не создается) | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter СоздатьПроизвольныйТвит %% %% %% %% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/Sozdat-tekstovyy-tvit.md b/docs/md/Twitter/Tvity/Sozdat-tekstovyy-tvit.md new file mode 100644 index 000000000..f03b65683 --- /dev/null +++ b/docs/md/Twitter/Tvity/Sozdat-tekstovyy-tvit.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Создать текстовый твит + Создает твит без вложений + + +*Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , , , Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter СоздатьТекстовыйТвит --text %text% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/Sozdat-tvit-gifki.md b/docs/md/Twitter/Tvity/Sozdat-tvit-gifki.md new file mode 100644 index 000000000..9cd7da37b --- /dev/null +++ b/docs/md/Twitter/Tvity/Sozdat-tvit-gifki.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Создать твит гифки + Создает твит с вложением-гифкой + + +*Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивГифок | --gifs | Массив из Строка,ДвоичныеДанные | Массив файлов гифок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter СоздатьТвитГифки --text %text% --gifs %gifs% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/Sozdat-tvit-kartinki.md b/docs/md/Twitter/Tvity/Sozdat-tvit-kartinki.md new file mode 100644 index 000000000..be98a034d --- /dev/null +++ b/docs/md/Twitter/Tvity/Sozdat-tvit-kartinki.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Создать твит картинки + Создает твит с картинкой вложением + + +*Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивКартинок | --pictures | Массив из Строка,ДвоичныеДанные | Массив файлов картинок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter СоздатьТвитКартинки --text %text% --pictures %pictures% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/Sozdat-tvit-opros.md b/docs/md/Twitter/Tvity/Sozdat-tvit-opros.md new file mode 100644 index 000000000..d1eed4554 --- /dev/null +++ b/docs/md/Twitter/Tvity/Sozdat-tvit-opros.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +--- + +# Создать твит опрос + Создает твит с опросом + + +*Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , МассивВариантов, Длительность, Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивВариантов | --options | Массив из Строка | Массив вариантов опроса | + | Длительность | --duration | Строка,Число | Длительность опроса | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter СоздатьТвитОпрос --text %text% --options %options% --duration %duration% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/Sozdat-tvit-video.md b/docs/md/Twitter/Tvity/Sozdat-tvit-video.md new file mode 100644 index 000000000..0b9b72457 --- /dev/null +++ b/docs/md/Twitter/Tvity/Sozdat-tvit-video.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 5 +--- + +# Создать твит видео + Создает твит с видеовложением + + +*Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст твита | + | МассивВидео | --videos | Массив из Строка,ДвоичныеДанные | Массив файлов видео | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter СоздатьТвитВидео --text %text% --videos %videos% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/Zagruzit-massiv-vlozheniy-.md b/docs/md/Twitter/Tvity/Zagruzit-massiv-vlozheniy-.md new file mode 100644 index 000000000..8ba798530 --- /dev/null +++ b/docs/md/Twitter/Tvity/Zagruzit-massiv-vlozheniy-.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 7 +--- + +# Загрузить массив вложений + Загружает файлы на сервер и возвращает их ID + + +*Функция ЗагрузитьМассивВложений(Знач МассивФайлов, Знач ТипВложений, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивФайлов | | Массив из Строка, ДвоичныеДанные | Массив файлов | + | ТипВложений | | Строка | Тип вложений | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Массив Из Строка - Массив ID медиа + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint twitter ЗагрузитьМассивВложений %% %% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Twitter/Tvity/_category_.json b/docs/md/Twitter/Tvity/_category_.json new file mode 100644 index 000000000..ed45a9f08 --- /dev/null +++ b/docs/md/Twitter/Tvity/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Твиты", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Interaktivnye-deystviya/Napisat-kommentariy.md b/docs/md/VK/Interaktivnye-deystviya/Napisat-kommentariy.md new file mode 100644 index 000000000..f06119194 --- /dev/null +++ b/docs/md/VK/Interaktivnye-deystviya/Napisat-kommentariy.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 4 +--- + +# Написать комментарий + Создает комментарий под выбранной записью + + +*Функция НаписатьКомментарий(Знач IDПоста, Знач IDСтены, Знач Текст, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID целевого поста | + | IDСтены | --wall | Строка,Число | ID стены расположения поста | + | Текст | --text | Строка | Текст комментария | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk НаписатьКомментарий --post %post% --wall %wall% --text %text% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Interaktivnye-deystviya/Napisat-soobschenie.md b/docs/md/VK/Interaktivnye-deystviya/Napisat-soobschenie.md new file mode 100644 index 000000000..d0d29d67d --- /dev/null +++ b/docs/md/VK/Interaktivnye-deystviya/Napisat-soobschenie.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 3 +--- + +# Написать сообщение + Написать сообщение пользователю в диалоге сообщества + + +*Функция НаписатьСообщение(Знач Текст, Знач IDПользователя, Знач Communitytoken, Знач Клавиатура = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Текст | --text | Строка | Текст сообщения | + | IDПользователя | --user | Строка | ID пользователя адресата | + | Communitytoken | --ct | Строка | Токен бота чата сообщества, котрый можно получить в настройках | + | Клавиатура | --keyboard | Строка | JSON клавиатуры. См.СформироватьКлавиатуру | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk НаписатьСообщение --text %text% --user %user% --ct %ct% --keyboard %keyboard% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Interaktivnye-deystviya/Postavit-layk.md b/docs/md/VK/Interaktivnye-deystviya/Postavit-layk.md new file mode 100644 index 000000000..f33bbcad0 --- /dev/null +++ b/docs/md/VK/Interaktivnye-deystviya/Postavit-layk.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Поставить лайк + Ставит лайк на пост + + +*Функция ПоставитьЛайк(Знач IDПоста, Знач IDСтены = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | IDСтены | --wall | Строка,Число | ID стены расположения поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПоставитьЛайк --post %post% --wall %wall% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Interaktivnye-deystviya/Sdelat-repost.md b/docs/md/VK/Interaktivnye-deystviya/Sdelat-repost.md new file mode 100644 index 000000000..d81e7ad81 --- /dev/null +++ b/docs/md/VK/Interaktivnye-deystviya/Sdelat-repost.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 2 +--- + +# Сделать репост + Делает репост записи + + +*Функция СделатьРепост(Знач IDПоста, Знач IDСтены = "", Знач ЦелеваяСтена = "", Знач Рекламный = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | IDСтены | --from | Строка,Число | ID стены расположения поста | + | ЦелеваяСтена | --to | Строка,Число | ID целевой стены или группы | + | Рекламный | --ad | Булево | Признак рекламного поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СделатьРепост --post %post% --from %from% --to %to% --ad %ad% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Interaktivnye-deystviya/Sokratit-ssylku.md b/docs/md/VK/Interaktivnye-deystviya/Sokratit-ssylku.md new file mode 100644 index 000000000..9f37d95d0 --- /dev/null +++ b/docs/md/VK/Interaktivnye-deystviya/Sokratit-ssylku.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 5 +--- + +# Сократить ссылку + Создает сокращенный URL из обычного + + +*Функция СократитьСсылку(Знач URL, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL для сокращения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Строка - Сокращенный URL + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СократитьСсылку --url %url% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Interaktivnye-deystviya/_category_.json b/docs/md/VK/Interaktivnye-deystviya/_category_.json new file mode 100644 index 000000000..93ac7f55c --- /dev/null +++ b/docs/md/VK/Interaktivnye-deystviya/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Интерактивные действия", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Poluchenie-tokena/Sozdat-ssylku-polucheniya-tokena.md b/docs/md/VK/Poluchenie-tokena/Sozdat-ssylku-polucheniya-tokena.md new file mode 100644 index 000000000..2523d6a26 --- /dev/null +++ b/docs/md/VK/Poluchenie-tokena/Sozdat-ssylku-polucheniya-tokena.md @@ -0,0 +1,37 @@ +--- +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="Результат" + + + +``` diff --git a/docs/md/VK/Poluchenie-tokena/_category_.json b/docs/md/VK/Poluchenie-tokena/_category_.json new file mode 100644 index 000000000..6a6f59b7e --- /dev/null +++ b/docs/md/VK/Poluchenie-tokena/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Получение токена", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Prochie/Sformirovat-klaviaturu.md b/docs/md/VK/Prochie/Sformirovat-klaviaturu.md new file mode 100644 index 000000000..33843c61c --- /dev/null +++ b/docs/md/VK/Prochie/Sformirovat-klaviaturu.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Сформировать клавиатуру + Формирует клавиатуру по массиву кнопок + + +*Функция СформироватьКлавиатуру(Знач МассивКнопок) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив заголовков кнопок | + + + Вовзращаемое значение: Строка - JSON клавиатуры + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СформироватьКлавиатуру --buttons %buttons% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Prochie/_category_.json b/docs/md/VK/Prochie/_category_.json new file mode 100644 index 000000000..5195f59e4 --- /dev/null +++ b/docs/md/VK/Prochie/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Прочие", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-s-gruppoy/Sohranit-kartinku-v-albom.md b/docs/md/VK/Rabota-s-gruppoy/Sohranit-kartinku-v-albom.md new file mode 100644 index 000000000..ec4bb9cb5 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Sohranit-kartinku-v-albom.md @@ -0,0 +1,55 @@ +--- +sidebar_position: 8 +--- + +# Сохранить картинку в альбом + Сохраняет картинку в альбом сообщества + + +*Функция СохранитьКартинкуВАльбом(Знач IDАльбома, Знач Картинка, Знач Описание = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDАльбома | --album | Строка,Число | ID альбома | + | Картинка | --picture | ДвоичныеДанные,Строка | Файл картинки | + | Описание | --description | Строка | Описание картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ОписаниеКартинки = "Картинка автотест"; + ИДАльбома = "304369700"; + + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь к файлу или Двоичные данные + ИВФ = ПолучитьИмяВременногоФайла("png"); + КопироватьФайл(Картинка, ИВФ); + Картинка = Новый ДвоичныеДанные(ИВФ); + + + Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, Картинка, ОписаниеКартинки, Параметры); + + 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="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Sozdat-albom.md b/docs/md/VK/Rabota-s-gruppoy/Sozdat-albom.md new file mode 100644 index 000000000..30b214a72 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Sozdat-albom.md @@ -0,0 +1,42 @@ +--- +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 %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Sozdat-istoriu.md b/docs/md/VK/Rabota-s-gruppoy/Sozdat-istoriu.md new file mode 100644 index 000000000..832c6f87b --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Sozdat-istoriu.md @@ -0,0 +1,51 @@ +--- +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"); + + + Результат = OPI_VK.СоздатьИсторию(ИВФ, , Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьИсторию --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Sozdat-opros.md b/docs/md/VK/Rabota-s-gruppoy/Sozdat-opros.md new file mode 100644 index 000000000..474d91fed --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Sozdat-opros.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 4 +--- + +# Создать опрос + Создает опрос с вариантами ответа + + +*Функция СоздатьОпрос(Знач Вопрос, Знач МассивОтветов, Знач Картинка = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Вопрос | --question | Строка | Вопрос опроса | + | МассивОтветов | --options | Массив из Строка | Массив вариантов ответа | + | Картинка | --picture | Строка,ДвоичныеДанные | Картинка опроса | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + Вопрос = "Какой ваш любимый цвет?"; + + МассивВариантов = Новый Массив; + МассивВариантов.Добавить("Красный"); + МассивВариантов.Добавить("Желтый"); + МассивВариантов.Добавить("Зеленый"); + + Результат = OPI_VK.СоздатьОпрос(Вопрос, МассивВариантов, , Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьОпрос --question %question% --options %options% --picture %picture% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Sozdat-post.md b/docs/md/VK/Rabota-s-gruppoy/Sozdat-post.md new file mode 100644 index 000000000..2568e9cfc --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Sozdat-post.md @@ -0,0 +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"); + + + + Результат = OPI_VK.СоздатьПост(Текст, Картинка, Ложь , , Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьПост --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Sozdat-sostavnoy-post.md b/docs/md/VK/Rabota-s-gruppoy/Sozdat-sostavnoy-post.md new file mode 100644 index 000000000..36dcad327 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Sozdat-sostavnoy-post.md @@ -0,0 +1,63 @@ +--- +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="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Udalit-albom.md b/docs/md/VK/Rabota-s-gruppoy/Udalit-albom.md new file mode 100644 index 000000000..04d3da358 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Udalit-albom.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 6 +--- + +# Удалить альбом + Удаляет ранее созданный альбом + + +*Функция УдалитьАльбом(Знач IDАльбома, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDАльбома | --album | Строка,Число | ID альбома | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДАльбома = "304369700"; + + Результат = OPI_VK.УдалитьАльбом(ИДАльбома, Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьАльбом --album %album% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Udalit-kartinku.md b/docs/md/VK/Rabota-s-gruppoy/Udalit-kartinku.md new file mode 100644 index 000000000..69c97a5e4 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Udalit-kartinku.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 9 +--- + +# Удалить картинку + Удалить картинку из альбома + + +*Функция УдалитьКартинку(Знач IDКартинки, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКартинки | --pictureid | Строка,Число | ID картинки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДКартинки = "457243771"; + + Результат = OPI_VK.УдалитьКартинку(ИДКартинки, Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьКартинку --pictureid %pictureid% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Udalit-post.md b/docs/md/VK/Rabota-s-gruppoy/Udalit-post.md new file mode 100644 index 000000000..098a3e013 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Udalit-post.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 3 +--- + +# Удалить пост + Удаляет пост по id + + +*Функция УдалитьПост(Знач IDПоста, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDПоста | --post | Строка,Число | ID поста | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДПоста = "2021"; + + Результат = OPI_VK.УдалитьПост(ИДПоста, Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьПост --post %post% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-gruppoy/Zagruzit-foto-na-server.md b/docs/md/VK/Rabota-s-gruppoy/Zagruzit-foto-na-server.md new file mode 100644 index 000000000..7dc5a93d5 --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Zagruzit-foto-na-server.md @@ -0,0 +1,37 @@ +--- +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/md/VK/Rabota-s-gruppoy/Zagruzit-video-na-server.md b/docs/md/VK/Rabota-s-gruppoy/Zagruzit-video-na-server.md new file mode 100644 index 000000000..30b25ddff --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/Zagruzit-video-na-server.md @@ -0,0 +1,39 @@ +--- +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/md/VK/Rabota-s-gruppoy/_category_.json b/docs/md/VK/Rabota-s-gruppoy/_category_.json new file mode 100644 index 000000000..d2110e45c --- /dev/null +++ b/docs/md/VK/Rabota-s-gruppoy/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с группой", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-s-obsuzhdeniyami/Napisat-v-obsuzhdenie.md b/docs/md/VK/Rabota-s-obsuzhdeniyami/Napisat-v-obsuzhdenie.md new file mode 100644 index 000000000..89660b758 --- /dev/null +++ b/docs/md/VK/Rabota-s-obsuzhdeniyami/Napisat-v-obsuzhdenie.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 4 +--- + +# Написать в обсуждение + Добавляет сообщение в обсуждение от имени группы + + +*Функция НаписатьВОбсуждение(Знач IDОбсуждения, Знач Текст, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | Текст | --text | Строка | Текст сообщения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "51136513"; + Сообщение = "Мне больше нравится желтый"; + + Результат = OPI_VK.НаписатьВОбсуждение(ИДОбсуждения, Сообщение, Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk НаписатьВОбсуждение --topic %topic% --text %text% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-obsuzhdeniyami/Otkryt-obsuzhdenie.md b/docs/md/VK/Rabota-s-obsuzhdeniyami/Otkryt-obsuzhdenie.md new file mode 100644 index 000000000..119f44eb8 --- /dev/null +++ b/docs/md/VK/Rabota-s-obsuzhdeniyami/Otkryt-obsuzhdenie.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 3 +--- + +# Открыть обсуждение + Открывает ранее закрытое обсуждение + + +*Функция ОткрытьОбсуждение(Знач IDОбсуждения, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "51136513"; + Результат = OPI_VK.ОткрытьОбсуждение(ИДОбсуждения, Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk ОткрытьОбсуждение --topic %topic% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-obsuzhdeniyami/Sozdat-obsuzhdenie.md b/docs/md/VK/Rabota-s-obsuzhdeniyami/Sozdat-obsuzhdenie.md new file mode 100644 index 000000000..fe3da8968 --- /dev/null +++ b/docs/md/VK/Rabota-s-obsuzhdeniyami/Sozdat-obsuzhdenie.md @@ -0,0 +1,42 @@ +--- +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 %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-obsuzhdeniyami/Zakryt-obsuzhdenie.md b/docs/md/VK/Rabota-s-obsuzhdeniyami/Zakryt-obsuzhdenie.md new file mode 100644 index 000000000..9e4d4f63d --- /dev/null +++ b/docs/md/VK/Rabota-s-obsuzhdeniyami/Zakryt-obsuzhdenie.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 2 +--- + +# Закрыть обсуждение + Закрывает или удаляет обсуждение + + +*Функция ЗакрытьОбсуждение(Знач IDОбсуждения, Знач УдалитьПолностью = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDОбсуждения | --topic | Строка,Число | ID обсуждения | + | УдалитьПолностью | --remove | Булево | Удалить полностью (Истина) или закрыть | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + Параметры = ПолучитьПараметрыВК(); + ИДОбсуждения = "51136513"; + Результат = OPI_VK.ЗакрытьОбсуждение(ИДОбсуждения, Ложь, Параметры); + + +``` + +```sh title="Пример команд CLI" + + oint vk ЗакрытьОбсуждение --topic %topic% --remove %remove% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-obsuzhdeniyami/_category_.json b/docs/md/VK/Rabota-s-obsuzhdeniyami/_category_.json new file mode 100644 index 000000000..c392ed626 --- /dev/null +++ b/docs/md/VK/Rabota-s-obsuzhdeniyami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с обсуждениями", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Dobavit-tovar-v-podborku.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Dobavit-tovar-v-podborku.md new file mode 100644 index 000000000..432020301 --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Dobavit-tovar-v-podborku.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 5 +--- + +# Добавить товар в подборку + Добавляет товар в подборку + + +*Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ДобавитьТоварВПодборку --items %items% --sel %sel% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Izmenit-podborku-tovarov.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Izmenit-podborku-tovarov.md new file mode 100644 index 000000000..5da57029e --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Izmenit-podborku-tovarov.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 4 +--- + +# Изменить подборку товаров + Изменяет свойства подборки товаров + + +*Функция ИзменитьПодборкуТоваров(Знач Название, Знач Подборка, Знач Картинка = "", Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Новое название подборки | + | Подборка | --sel | Строка | ID подборки | + | Картинка | --picture | Строка,ДвоичныеДанные | Новая картинка подборки | + | Основная | --main | Булево | Основная | + | Скрытая | --hidden | Булево | Скрытая | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ИзменитьПодборкуТоваров --title %title% --sel %sel% --picture %picture% --main %main% --hidden %hidden% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Poluchit-podborki-po-id.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Poluchit-podborki-po-id.md new file mode 100644 index 000000000..dcdbfdba0 --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Poluchit-podborki-po-id.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить подборки по ID + Получить список подборок по массиву ID + + +*Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборки | --sels | Строка, Массив Из Строка | ID подборок | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьПодборкиПоИД --sels %sels% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Poluchit-spisok-podborok.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Poluchit-spisok-podborok.md new file mode 100644 index 000000000..0171d29ae --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Poluchit-spisok-podborok.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить список подборок + Получает список подборок товаров + + +*Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий подборок + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСписокПодборок --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Sozdat-podborku-tovarov.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Sozdat-podborku-tovarov.md new file mode 100644 index 000000000..5b1d7913e --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Sozdat-podborku-tovarov.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 3 +--- + +# Создать подборку товаров + Создает пустую подборку товаров + + +*Функция СоздатьПодборкуТоваров(Знач Название, Знач Картинка, Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Название подборки | + | Картинка | --picture | Строка,ДвоичныеДанные | Файл картинки | + | Основная | --main | Булево | Основная | + | Скрытая | --hidden | Булево | Скрытая | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьПодборкуТоваров --title %title% --picture %picture% --main %main% --hidden %hidden% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Udalit-podborku.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Udalit-podborku.md new file mode 100644 index 000000000..06b3ee149 --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Udalit-podborku.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 7 +--- + +# Удалить подборку + Удаляет подборку по ID + + +*Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьПодборку --sel %sel% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/Udalit-tovar-iz-podborki.md b/docs/md/VK/Rabota-s-podborkami-tovarov/Udalit-tovar-iz-podborki.md new file mode 100644 index 000000000..207ba8bf6 --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/Udalit-tovar-iz-podborki.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 6 +--- + +# Удалить товар из подборки + Удаляет ранее добавленный товар из подборки + + +*Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Строка | ID товара | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьТоварИзПодборки --item %item% --sel %sel% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-podborkami-tovarov/_category_.json b/docs/md/VK/Rabota-s-podborkami-tovarov/_category_.json new file mode 100644 index 000000000..0a7ba2e2c --- /dev/null +++ b/docs/md/VK/Rabota-s-podborkami-tovarov/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с подборками товаров", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-s-reklamnym-kabinetom/Poluchit-spisok-reklamnyh-kategoriy.md b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Poluchit-spisok-reklamnyh-kategoriy.md new file mode 100644 index 000000000..81aba0604 --- /dev/null +++ b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Poluchit-spisok-reklamnyh-kategoriy.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 4 +--- + +# Получить список рекламных категорий + Получает список id рекламных категорий для создания рекламного объявления + + +*Функция ПолучитьСписокРекламныхКатегорий(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСписокРекламныхКатегорий --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-reklamnym-kabinetom/Priostanovit-reklamnoe-obyavlenie.md b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Priostanovit-reklamnoe-obyavlenie.md new file mode 100644 index 000000000..8c7c80f0b --- /dev/null +++ b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Priostanovit-reklamnoe-obyavlenie.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Приостановить рекламное объявление + Приостанавливает показ рекламного объявления + + +*Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | IDОбъявления | --adv | Строка,Число | ID объявления | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПриостановитьРекламноеОбъявление --cabinet %cabinet% --adv %adv% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-reklamnym-kabinetom/Sozdat-reklamnoe-obyavlenie.md b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Sozdat-reklamnoe-obyavlenie.md new file mode 100644 index 000000000..2a60ff1a3 --- /dev/null +++ b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Sozdat-reklamnoe-obyavlenie.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 2 +--- + +# Создать рекламное объявление + Создает рекламное объявление на основе поста + + +*Функция СоздатьРекламноеОбъявление(Знач НомерКампании, Знач ДневнойЛимит, Знач НомерКатегории, Знач IDПоста, Знач IDКабинета, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | НомерКампании | --campaign | Строка,Число | ID рекламной кампании | + | ДневнойЛимит | --limit | Строка,Число | Дневной лимит в рублях | + | НомерКатегории | --category | Строка,Число | Номер рекламной категории | + | IDПоста | --post | Строка,Число | ID поста, используемого в качетсве рекламы | + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьРекламноеОбъявление --campaign %campaign% --limit %limit% --category %category% --post %post% --cabinet %cabinet% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-reklamnym-kabinetom/Sozdat-reklamnuu-kampaniu.md b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Sozdat-reklamnuu-kampaniu.md new file mode 100644 index 000000000..fde7969c5 --- /dev/null +++ b/docs/md/VK/Rabota-s-reklamnym-kabinetom/Sozdat-reklamnuu-kampaniu.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Создать рекламную кампанию + Создает кампанию в выбранном рекламном кабинете + + +*Функция СоздатьРекламнуюКампанию(Знач IDКабинета, Знач Наименование, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | Наименование | --title | Строка | Наименование кампании | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьРекламнуюКампанию --cabinet %cabinet% --title %title% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-reklamnym-kabinetom/_category_.json b/docs/md/VK/Rabota-s-reklamnym-kabinetom/_category_.json new file mode 100644 index 000000000..adf898c93 --- /dev/null +++ b/docs/md/VK/Rabota-s-reklamnym-kabinetom/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с рекламным кабинетом", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-s-tovarami/Dobavit-tovar.md b/docs/md/VK/Rabota-s-tovarami/Dobavit-tovar.md new file mode 100644 index 000000000..9d85f3a0a --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Dobavit-tovar.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Добавить товар + Добавляет новый товар в каталог сообщества + + +*Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") ЭкспортВозврат УправлениеТоваром(ОписаниеТовара, , Подборка, Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | + | Подборка | --sel | Строка | ID подборка для помещения товара, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ДобавитьТовар --product %product% --sel %sel% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Izmenit-tovar.md b/docs/md/VK/Rabota-s-tovarami/Izmenit-tovar.md new file mode 100644 index 000000000..471c5a8f9 --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Izmenit-tovar.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 5 +--- + +# Изменить товар + Изменяет ранее созданный товар + + +*Функция ИзменитьТовар(Знач Товар, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") ЭкспортВозврат УправлениеТоваром(ОписаниеТовара, Товар, Подборка, Параметры);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Число,Строка | Идентификатор изменяемого товара | + | ОписаниеТовара | --product | Соответствие Из КлючИЗначение | JSON описание товара или путь | + | Подборка | --sel | Строка | Идентификатор новой подборки, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ИзменитьТовар --item %item% --product %product% --sel %sel% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Poluchit-opisanie-tovara.-.md b/docs/md/VK/Rabota-s-tovarami/Poluchit-opisanie-tovara.-.md new file mode 100644 index 000000000..2f562bb71 --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Poluchit-opisanie-tovara.-.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 8 +--- + +# Получить описание товара. + + + +*Функция ПолучитьОписаниеТовара() Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Пустое описание товара: + + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьОписаниеТовара + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Poluchit-spisok-kategoriy-tovarov.md b/docs/md/VK/Rabota-s-tovarami/Poluchit-spisok-kategoriy-tovarov.md new file mode 100644 index 000000000..0e1c0385d --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Poluchit-spisok-kategoriy-tovarov.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить список категорий товаров + Получает список ID товарных категорий для указания при создании товара + + +*Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из Строка - Ключ - ID, Значение - Имя + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСписокКатегорийТоваров --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Poluchit-spisok-tovarov.md b/docs/md/VK/Rabota-s-tovarami/Poluchit-spisok-tovarov.md new file mode 100644 index 000000000..5bb1f07a1 --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Poluchit-spisok-tovarov.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить список товаров + Получает список товаров сообщества + + +*Функция ПолучитьСписокТоваров(Знач Подборка = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Подборка | --sel | Строка,Число | ID подборки, если нужен отбор | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий товаров + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСписокТоваров --sel %sel% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Poluchit-tovary-po-id.md b/docs/md/VK/Rabota-s-tovarami/Poluchit-tovary-po-id.md new file mode 100644 index 000000000..c4495e341 --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Poluchit-tovary-po-id.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить товары по ID + Получает информацию о товарах по массиву ID + + +*Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товары | --items | Строка, Массив Из Строка | Массив ID товаров | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьТоварыПоИД --items %items% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Sgruppirovat-tovary.md b/docs/md/VK/Rabota-s-tovarami/Sgruppirovat-tovary.md new file mode 100644 index 000000000..59178f81b --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Sgruppirovat-tovary.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 7 +--- + +# Сгруппировать товары + Группирует товары на основе одинаковых наборов свойств + + +*Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив Из Строка | Массив ID товаров | + | СуществующаяГруппа | --sellgroup | Строка | ID существующей группы, если необходимо | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СгруппироватьТовары --items %items% --sellgroup %sellgroup% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/Udalit-tovar.md b/docs/md/VK/Rabota-s-tovarami/Udalit-tovar.md new file mode 100644 index 000000000..d03387cb3 --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/Udalit-tovar.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 6 +--- + +# Удалить товар + Удаляет ранее созданный товар + + +*Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Товар | --item | Строка,Число | ID товара | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьТовар --item %item% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-tovarami/_category_.json b/docs/md/VK/Rabota-s-tovarami/_category_.json new file mode 100644 index 000000000..a146f5e45 --- /dev/null +++ b/docs/md/VK/Rabota-s-tovarami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с товарами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-s-zakazami/Poluchit-spisok-zakazov.md b/docs/md/VK/Rabota-s-zakazami/Poluchit-spisok-zakazov.md new file mode 100644 index 000000000..3e963ab2a --- /dev/null +++ b/docs/md/VK/Rabota-s-zakazami/Poluchit-spisok-zakazov.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить список заказов + Возвращает список заказов сообщества + + +*Функция ПолучитьСписокЗаказов(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСписокЗаказов --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-s-zakazami/_category_.json b/docs/md/VK/Rabota-s-zakazami/_category_.json new file mode 100644 index 000000000..b1b32ded2 --- /dev/null +++ b/docs/md/VK/Rabota-s-zakazami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с заказами", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Dobavit-variant-svoystva-tovara.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Dobavit-variant-svoystva-tovara.md new file mode 100644 index 000000000..ac05c09c2 --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Dobavit-variant-svoystva-tovara.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 5 +--- + +# Добавить вариант свойства товара + Добавляет вариант для существующего свойства + + +*Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Значение | --value | Строка | Значение свойства | + | Свойство | --prop | Строка,Число | ID свойства, куда добавляется вариант | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ДобавитьВариантСвойстваТовара --value %value% --prop %prop% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Izmenit-svoystvo-tovara.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Izmenit-svoystvo-tovara.md new file mode 100644 index 000000000..a897be91d --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Izmenit-svoystvo-tovara.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Изменить свойство товара + Изменяет существующее свойство товара + + +*Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Новое название | + | Свойство | --prop | Строка,Число | ID свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ИзменитьСвойствоТовара --title %title% --prop %prop% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Izmenit-variant-svoystva-tovara.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Izmenit-variant-svoystva-tovara.md new file mode 100644 index 000000000..99626a5ce --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Izmenit-variant-svoystva-tovara.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +--- + +# Изменить вариант свойства товара + Изменяет значение варианта существующего свойства товара + + +*Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Значение | --value | Строка | Новое значение свойства | + | Свойство | --prop | Строка,Число | ID свойства | + | Вариант | --option | Строка,Число | ID варианта | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ИзменитьВариантСвойстваТовара --value %value% --prop %prop% --option %option% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Poluchit-spisok-svoystv.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Poluchit-spisok-svoystv.md new file mode 100644 index 000000000..42962a726 --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Poluchit-spisok-svoystv.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить список свойств + Получает список свойств товаров группы + + +*Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСписокСвойств --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Sozdat-svoystvo-tovara.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Sozdat-svoystvo-tovara.md new file mode 100644 index 000000000..c5ef337be --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Sozdat-svoystvo-tovara.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Создать свойство товара + Создает новое свойство для использования в товарах + + +*Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Название | --title | Строка | Название свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk СоздатьСвойствоТовара --title %title% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Udalit-svoystvo-tovara.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Udalit-svoystvo-tovara.md new file mode 100644 index 000000000..0fd7068c7 --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Udalit-svoystvo-tovara.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Удалить свойство товара + Удаляет существующее свойство товара + + +*Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Свойство | --prop | Строка,Число | ID свойства | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьСвойствоТовара --prop %prop% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/Udalit-variant-svoystva-tovara.md b/docs/md/VK/Rabota-so-svoystvami-tovarov/Udalit-variant-svoystva-tovara.md new file mode 100644 index 000000000..5706243ca --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/Udalit-variant-svoystva-tovara.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 7 +--- + +# Удалить вариант свойства товара + Удаляет ранее созданный вариант свойства + + +*Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Вариант | --option | Строка,Число | ID варианта | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk УдалитьВариантСвойстваТовара --option %option% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Rabota-so-svoystvami-tovarov/_category_.json b/docs/md/VK/Rabota-so-svoystvami-tovarov/_category_.json new file mode 100644 index 000000000..04782dd8f --- /dev/null +++ b/docs/md/VK/Rabota-so-svoystvami-tovarov/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа со свойствами товаров", +"position": "" +} \ No newline at end of file diff --git a/docs/md/VK/Statistika/Poluchit-statistiku-po-postam.md b/docs/md/VK/Statistika/Poluchit-statistiku-po-postam.md new file mode 100644 index 000000000..99a1332e2 --- /dev/null +++ b/docs/md/VK/Statistika/Poluchit-statistiku-po-postam.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Получить статистику по постам + Получает статистику в разрезе постов + + +*Функция ПолучитьСтатистикуПостов(Знач МассивИДПостов, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивИДПостов | --posts | Массив из Строка,Число | Массив ID постов | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Массив из Произвольный - Массив данных статистики по постам + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСтатистикуПостов --posts %posts% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Statistika/Poluchit-statistiku.md b/docs/md/VK/Statistika/Poluchit-statistiku.md new file mode 100644 index 000000000..aa3c24fba --- /dev/null +++ b/docs/md/VK/Statistika/Poluchit-statistiku.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +# Получить статистику + Получает общую статистику сообщества за период + + +*Функция ПолучитьСтатистику(Знач ДатаНачала, Знач ДатаОкончания, Знач Параметры = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | ДатаНачала | --datefrom | Дата | Дата начала периода | + | ДатаОкончания | --dateto | Дата | Дата окончания периода | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint vk ПолучитьСтатистику --datefrom %datefrom% --dateto %dateto% --auth %auth% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/VK/Statistika/_category_.json b/docs/md/VK/Statistika/_category_.json new file mode 100644 index 000000000..109cf09a4 --- /dev/null +++ b/docs/md/VK/Statistika/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Статистика", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-dannye-polzovatelya.md b/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-dannye-polzovatelya.md new file mode 100644 index 000000000..eba463fba --- /dev/null +++ b/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-dannye-polzovatelya.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить данные пользователя + Получает информацию о пользователе по ID + + +*Функция ПолучитьДанныеПользователя(Знач Токен, Знач IDПользователя) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | IDПользователя | --user | Строка, Число | ID пользователя Viber | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ПолучитьДанныеПользователя --token %token% --user %user% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-informatsiu-o-kanale.md b/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-informatsiu-o-kanale.md new file mode 100644 index 000000000..b130db9b4 --- /dev/null +++ b/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-informatsiu-o-kanale.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 2 +--- + +# Получить информацию о канале +Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook ID пользователя из информации о канале не подойдет для отправки сообщений через бота - они разные + + +*Функция ПолучитьИнформациюОКанале(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ПолучитьИнформациюОКанале --token %token% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-onlayn-polzovateley.md b/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-onlayn-polzovateley.md new file mode 100644 index 000000000..fc8ee87e6 --- /dev/null +++ b/docs/md/Viber/Nastroyki-i-informatsiya/Poluchit-onlayn-polzovateley.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Получить онлайн пользователей + Получает статус пользователя или нескольких пользователей по ID + + +*Функция ПолучитьОнлайнПользователей(Знач Токен, Знач IDПользователей) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен Viber | + | IDПользователей | --users | Строка,Число,Массив из Строка,Число | ID пользователей(я) Viber | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ПолучитьОнлайнПользователей --token %token% --users %users% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Nastroyki-i-informatsiya/Ustanovit-webhook.md b/docs/md/Viber/Nastroyki-i-informatsiya/Ustanovit-webhook.md new file mode 100644 index 000000000..9e5bd9b92 --- /dev/null +++ b/docs/md/Viber/Nastroyki-i-informatsiya/Ustanovit-webhook.md @@ -0,0 +1,36 @@ +--- +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="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber УстановитьWebhook --token %token% --url %url% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Nastroyki-i-informatsiya/_category_.json b/docs/md/Viber/Nastroyki-i-informatsiya/_category_.json new file mode 100644 index 000000000..d0147d965 --- /dev/null +++ b/docs/md/Viber/Nastroyki-i-informatsiya/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Настройки и информация", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Viber/Otpravka-soobscheniy/Otpravit-fayl.md b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-fayl.md new file mode 100644 index 000000000..20243e33b --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-fayl.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 3 +--- + +# Отправить файл + Отправляет файл (документ) в чат или канал + + +*Функция ОтправитьФайл(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Расширение, Знач Размер = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --file | Строка | URL файла | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + | Расширение | --ext | Строка | Расширение файла | + | Размер | --size | Число | Размер файла. Если не заполнен > определяется автоматически скачиванием файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ОтправитьФайл --token %token% --file %file% --user %user% --ischannel %ischannel% --ext %ext% --size %size% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/Otpravit-kartinku.md b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-kartinku.md new file mode 100644 index 000000000..ce7a11f0c --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-kartinku.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 2 +--- + +# Отправить картинку + Отправляет картинку в чат или канал + + +*Функция ОтправитьКартинку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Описание = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --picture | Строка | URL картинки | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | булево | Отправка в канал или в чат бота | + | Описание | --description | Строка | Аннотация к картинке | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ОтправитьКартинку --token %token% --picture %picture% --user %user% --ischannel %ischannel% --description %description% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/Otpravit-kontakt.md b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-kontakt.md new file mode 100644 index 000000000..a67d56830 --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-kontakt.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 4 +--- + +# Отправить контакт + Отправляет контакт с номером телефона в чат или канал + + +*Функция ОтправитьКонтакт(Знач Токен, Знач ИмяКонтакта, Знач НомерТелефона, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | ИмяКонтакта | --name | Строка | Имя контакта | + | НомерТелефона | --phone | Строка | Номер телефона | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ОтправитьКонтакт --token %token% --name %name% --phone %phone% --user %user% --ischannel %ischannel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/Otpravit-lokatsiu.md b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-lokatsiu.md new file mode 100644 index 000000000..0b772d97e --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-lokatsiu.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 5 +--- + +# Отправить локацию + Отправляет географические координаты в чат или канал + + +*Функция ОтправитьЛокацию(Знач Токен, Знач Широта, Знач Долгота, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Широта | --lat | Строка,Число | Географическая широта | + | Долгота | --long | Строка,Число | Географическая долгота | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ОтправитьЛокацию --token %token% --lat %lat% --long %long% --user %user% --ischannel %ischannel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/Otpravit-ssylku.md b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-ssylku.md new file mode 100644 index 000000000..7f0d2b7e7 --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-ssylku.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +--- + +# Отправить ссылку + Отправляет URL с предпросмотром в чат или канал + + +*Функция ОтправитьСсылку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Отправляемая ссылка | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ОтправитьСсылку --token %token% --url %url% --user %user% --ischannel %ischannel% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/Otpravit-tekstovoe-soobschenie.md b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-tekstovoe-soobschenie.md new file mode 100644 index 000000000..2cb699012 --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Otpravit-tekstovoe-soobschenie.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат или канал + + +*Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач Текст, Знач IDПользователя, Знач ОтправкаВКанал, Знач Клавиатура = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Текст | --text | Строка | Текст сообщения | + | IDПользователя | --user | Строка,Число | ID пользователя. Для канала > администратора, для бота > получателя | + | ОтправкаВКанал | --ischannel | Булево | Отправка в канал или в чат бота | + | Клавиатура | --keyboard | Структура из Строка | См. СформироватьКлавиатуруИзМассиваКнопок | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber ОтправитьТекстовоеСообщение --token %token% --text %text% --user %user% --ischannel %ischannel% --keyboard %keyboard% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/Sformirovat-klaviaturu-iz-massiva-knopok.md b/docs/md/Viber/Otpravka-soobscheniy/Sformirovat-klaviaturu-iz-massiva-knopok.md new file mode 100644 index 000000000..020621ea7 --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/Sformirovat-klaviaturu-iz-massiva-knopok.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 7 +--- + +# Сформировать клавиатуру из массива кнопок + Возвращает структура клавиатуры для сообщений + + +*Функция СформироватьКлавиатуруИзМассиваКнопок(Знач МассивКнопок, Знач ЦветКнопок = "#2db9b9") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивКнопок | --buttons | Массив из Строка | Массив кнопок | + | ЦветКнопок | --color | Строка | HEX цвет кнопок с # в начале | + + + Вовзращаемое значение: Структура - Сформировать клавиатуру из массива кнопок: + + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint viber СформироватьКлавиатуруИзМассиваКнопок --buttons %buttons% --color %color% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Viber/Otpravka-soobscheniy/_category_.json b/docs/md/Viber/Otpravka-soobscheniy/_category_.json new file mode 100644 index 000000000..bacf9cdfd --- /dev/null +++ b/docs/md/Viber/Otpravka-soobscheniy/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Отправка сообщений", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Peremestit-obekt.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Peremestit-obekt.md new file mode 100644 index 000000000..6b3f7efda --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Peremestit-obekt.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 9 +--- + +# Переместить объект + Перемещает объект по заданному пути и пути к оригиналу + + +*Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Оригинал | --from | Строка | Путь к оригинальному файлу или папке | + | Путь | --to | Строка | Путь назначение для перемещения | + | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПереместитьОбъект --token %token% --from %from% --to %to% --rewrite %rewrite% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-informatsiu-o-diske.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-informatsiu-o-diske.md new file mode 100644 index 000000000..688709fea --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-informatsiu-o-diske.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# Получить информацию о диске + Получает информацию о текущем диске + + +*Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьИнформациюОДиске --token %token% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-obekt.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-obekt.md new file mode 100644 index 000000000..afeb36646 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-obekt.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Получить объект + Получает информацию об объекте диска по заданному пути + + +*Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к папке или файлу | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьОбъект --token %token% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-spisok-faylov.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-spisok-faylov.md new file mode 100644 index 000000000..a9e3bb153 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-spisok-faylov.md @@ -0,0 +1,39 @@ +--- +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="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьСписокФайлов --token %token% --amount %amount% --offset %offset% --type %type% --datesort %datesort% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-ssylku-dlya-skachivaniya.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-ssylku-dlya-skachivaniya.md new file mode 100644 index 000000000..05f168f33 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Poluchit-ssylku-dlya-skachivaniya.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 6 +--- + +# Получить ссылку для скачивания + Получает ссылку для скачивания файла + + +*Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к файлу для скачивания | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьСсылкуДляСкачивания --token %token% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Skachat-fayl.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Skachat-fayl.md new file mode 100644 index 000000000..375cee868 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Skachat-fayl.md @@ -0,0 +1,37 @@ +--- +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/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Sozdat-kopiu-obekta.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Sozdat-kopiu-obekta.md new file mode 100644 index 000000000..94371b3f9 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Sozdat-kopiu-obekta.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 5 +--- + +# Создать копию объекта + Создает копию объекта по заданному пути и пути к оригиналу + + +*Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Оригинал | --from | Строка | Путь к оригинальному файлу или каталогу | + | Путь | --to | Строка | Путь назначения для копии | + | Перезаписывать | --rewrite | Булево | Перезаписывать если файл с таким именем уже существует | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk СоздатьКопиюОбъекта --token %token% --from %from% --to %to% --rewrite %rewrite% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Sozdat-papku.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Sozdat-papku.md new file mode 100644 index 000000000..eb9a355f6 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Sozdat-papku.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Создать папку + Создает каталог на диске + + +*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к созаваемой папке | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk СоздатьПапку --token %token% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Udalit-obekt.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Udalit-obekt.md new file mode 100644 index 000000000..52f539d98 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Udalit-obekt.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 4 +--- + +# Удалить объект + Удаляет объект по заданному пути + + +*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к удаляемой папке или файлу | + | ВКорзину | --can | Булево | В корзину | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk УдалитьОбъект --token %token% --path %path% --can %can% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Zagruzit-fayl-po-url.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Zagruzit-fayl-po-url.md new file mode 100644 index 000000000..63b96b2e0 --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Zagruzit-fayl-po-url.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 11 +--- + +# Загрузить файл по URL + Загружает файл на диск, забирая его по заданному URL + + +*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь помещения загруженного файла | + | Адрес | --url | Строка | URL файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ЗагрузитьФайлПоURL --token %token% --path %path% --url %url% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Zagruzit-fayl.md b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Zagruzit-fayl.md new file mode 100644 index 000000000..81d89043f --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/Zagruzit-fayl.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 10 +--- + +# Загрузить файл + Загружает файл на диск по заданному пути + + +*Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь для сохранение файла на Диске | + | Файл | --file | Строка,ДвоичныеДанные | Файл для загрузки | + | Перезаписывать | --rewrite | Булево | Перезаписывать, если файл с таким именем уже существует | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ЗагрузитьФайл --token %token% --path %path% --file %file% --rewrite %rewrite% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/_category_.json b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/_category_.json new file mode 100644 index 000000000..54b960dfd --- /dev/null +++ b/docs/md/Yandex_Disk/Rabota-s-faylami-i-papkami/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с файлами и папками", +"position": "" +} \ No newline at end of file diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Opublikovat-obekt.md b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Opublikovat-obekt.md new file mode 100644 index 000000000..777b8a99a --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Opublikovat-obekt.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +# Опубликовать объект + Публикует объект диска в публичный доступ + + +*Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) ЭкспортВозврат ПереключениеОбщегоДоступа(Токен, Путь, Истина);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к публикуемому объекту | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ОпубликоватьОбъект --token %token% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Otmenit-publikatsiu-obekta.md b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Otmenit-publikatsiu-obekta.md new file mode 100644 index 000000000..bc512d892 --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Otmenit-publikatsiu-obekta.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 2 +--- + +# Отменить публикацию объекта + Отменяет публикацию ранее опубликованного объекта + + +*Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) ЭкспортВозврат ПереключениеОбщегоДоступа(Токен, Путь, Ложь);КонецФункции* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Путь | --path | Строка | Путь к опубликованному ранее объекту | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ОтменитьПубликациюОбъекта --token %token% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-publichnyy-obekt.md b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-publichnyy-obekt.md new file mode 100644 index 000000000..4e3f52e69 --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-publichnyy-obekt.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 4 +--- + +# Получить публичный объект + Получает информацию об опубликованном объекте по его URL + + +*Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Количество | --amount | Число | Количество возвращаемых вложенных объектов (для каталога) | + | СмещениеОтНачала | --offset | Число | Смещение для получение вложенных объектов не из начала списка | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьПубличныйОбъект --token %token% --url %url% --amount %amount% --offset %offset% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-spisok-opublikovannyh-obektov..md b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-spisok-opublikovannyh-obektov..md new file mode 100644 index 000000000..056090d73 --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-spisok-opublikovannyh-obektov..md @@ -0,0 +1,37 @@ +--- +sidebar_position: 3 +--- + +# Получить список опубликованных объектов. + Получает список опубликованных объектов + + +*Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | Количество | --amount | Число | Количество возвращаемых объектов | + | СмещениеОтНачала | --offset | Число | Смещение для получение объектов не из начала списка | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьСписокОпубликованныхОбъектов --token %token% --amount %amount% --offset %offset% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-ssylku-skachivaniya-publichnogo-obekta.md b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-ssylku-skachivaniya-publichnogo-obekta.md new file mode 100644 index 000000000..93ae5db95 --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Poluchit-ssylku-skachivaniya-publichnogo-obekta.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 5 +--- + +# Получить ссылку скачивания публичного объекта + Получает прямую ссылку для скачивания публичного объекта + + +*Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Путь | --path | Строка | Путь внутри объекта | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk ПолучитьСсылкуСкачиванияПубличногоОбъекта --token %token% --url %url% --path %path% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Sohranit-publichnyy-obekt-na-disk.md b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Sohranit-publichnyy-obekt-na-disk.md new file mode 100644 index 000000000..5f6130cae --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/Sohranit-publichnyy-obekt-na-disk.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +--- + +# Сохранить публичный объект на диск + Сохраняет публичный объект на ваш диск + + +*Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен | + | URL | --url | Строка | Адрес объекта | + | Откуда | --from | Строка | Путь внутри публичного каталога (только для папок) | + | Куда | --to | Строка | Путь сохранения файла | + + + Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + +```bsl title="Пример кода" + + + +``` + +```sh title="Пример команд CLI" + + oint yadisk СохранитьПубличныйОбъектНаДиск --token %token% --url %url% --from %from% --to %to% + +``` + + +```json title="Результат" + + + +``` diff --git a/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/_category_.json b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/_category_.json new file mode 100644 index 000000000..e8d073e40 --- /dev/null +++ b/docs/md/Yandex_Disk/Upravlenie-publichnym-dostupom/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Управление публичным доступом", +"position": "" +} \ No newline at end of file