1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-29 21:57:16 +02:00
Code Issues Releases Activity

Перевод документации

Browse Source
This commit is contained in:
Anton 2024-06-04 21:55:01 +03:00
parent 40a83a12cb
commit 509bd660e0
1213 changed files with 21892 additions and 19928 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
.github/workflows/docs_deploy_en.yml vendored Normal file
View File

@ -0,0 +1,40 @@
name: Документация | Развернуть на Neocities (английская версия)
on:
workflow_dispatch:
concurrency:
group: deploy-to-neocities
cancel-in-progress: true
jobs:
Deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
- name: Установка зависимостей
run: |
cd ./docs/docusaurus
npm install
- name: Сборка
run: |
cp -r ./docs/en/md ./docs/docusaurus/docs
cd ./docs/docusaurus
yarn build
- name: Развертывание на neocities
uses: jonchang/deploy-neocities@e557d8b4aa935cd3e1a437c038bb043c9b4064f6
with:
key: ${{ secrets.NEOCITIES_EN_API_TOKEN }}
dir: ./docs/docusaurus/build
clean: false

3
.github/workflows/docs_deploy.yml → .github/workflows/docs_deploy_ru.yml vendored
View File

@ -1,4 +1,4 @@
name: Документация | Развернуть на Neocities
name: Документация | Развернуть на Neocities (русская версия)
on:
workflow_dispatch:
@ -28,6 +28,7 @@ jobs:
- name: Сборка
run: |
cp -r ./docs/ru/md ./docs/docusaurus/docs
cd ./docs/docusaurus
yarn build

235
.github/workflows/os/docs_extract.os vendored
View File

@ -1,110 +1,169 @@
ПутьКДокам = "./docs/ru/md";
ПутьКПримерам = "./docs/ru/examples/";
ПутьКРезультатам = "./docs/ru/results/";
КаталогиБиблиотек = НайтиФайлы(ПутьКДокам, "*", Ложь);
Процедура ИзвлечениеДанных()
ПутьКДокам = "./docs/ru/md";
ПутьКПримерам = "./docs/ru/examples/";
ПутьКРезультатам = "./docs/ru/results/";
ПутьКДанным = "./docs/ru/data/";
Для Каждого Каталог Из КаталогиБиблиотек Цикл
КаталогиБиблиотек = НайтиФайлы(ПутьКДокам, "*", Ложь);
ФайлыДокументации = НайтиФайлы(Каталог.ПолноеИмя, "*.md", Истина);
ИмяБиблиотеки = Каталог.Имя;
Для Каждого Каталог Из КаталогиБиблиотек Цикл
Для Каждого Документ Из ФайлыДокументации Цикл
ФайлыДокументации = НайтиФайлы(Каталог.ПолноеИмя, "*.md", Истина);
ИмяБиблиотеки = Каталог.Имя;
ТекущийДокумент = Новый ТекстовыйДокумент();
ТекущийДокумент.Прочитать(Документ.ПолноеИмя, "UTF-8");
Для Каждого Документ Из ФайлыДокументации Цикл
ЗаписьПримера = Ложь;
ЗаписьРезультата = Ложь;
Пример = "";
Результат = "";
ИмяФункции = "";
Для Н = 1 По ТекущийДокумент.КоличествоСтрок() Цикл
ТекущийДокумент = Новый ТекстовыйДокумент();
ТекущийДокумент.Прочитать(Документ.ПолноеИмя, "UTF-8");
ТекущаяСтрока = СокрЛП(ТекущийДокумент.ПолучитьСтроку(Н));
СоответствиеДанных = Новый Соответствие;
Если СтрНачинаетсяС(ТекущаяСтрока, "*Функция ")
Или СтрНачинаетсяС(ТекущаяСтрока, "Функция ") Тогда
ЗаписьПримера = Ложь;
ЗаписьРезультата = Ложь;
Пример = "";
Результат = "";
ИмяФункции = "";
Для Н = 1 По ТекущийДокумент.КоличествоСтрок() Цикл
ИмяФункции = СтрЗаменить(ТекущаяСтрока, "*Функция ", "");
ИмяФункции = СтрЗаменить(ИмяФункции, "Функция ", "");
ИмяФункции = Лев(ИмяФункции, СтрНайти(ИмяФункции, "(") - 1);
ТекущаяСтрока = СокрЛП(ТекущийДокумент.ПолучитьСтроку(Н));
КонецЕсли;
Если СтрНачинаетсяС(ТекущаяСтрока, "*Функция ")
Или СтрНачинаетсяС(ТекущаяСтрока, "Функция ") Тогда
Если СтрНачинаетсяС(ТекущаяСтрока, "```bsl") Тогда
ЗаписьПримера = Истина;
ИначеЕсли СтрНачинаетсяС(ТекущаяСтрока, "```json") Тогда
ЗаписьРезультата = Истина;
ИначеЕсли СтрНачинаетсяС(ТекущаяСтрока, "```") Тогда
ЗаписьРезультата = Ложь;
ЗаписьПримера = Ложь;
Иначе
ИмяФункции = СтрЗаменить(ТекущаяСтрока, "*Функция ", "");
ИмяФункции = СтрЗаменить(ИмяФункции, "Функция ", "");
ИмяФункции = Лев(ИмяФункции, СтрНайти(ИмяФункции, "(") - 1);
Если ЗаписьПримера Тогда
Пример = Пример + " " + ТекущаяСтрока + Символы.ПС;
КонецЕсли;
Если ЗаписьРезультата Тогда
Результат = Результат + " " + ТекущаяСтрока + Символы.ПС;
Если СтрНачинаетсяС(ТекущаяСтрока, "```bsl") Тогда
ЗаписьПримера = Истина;
ИначеЕсли СтрНачинаетсяС(ТекущаяСтрока, "```json") Тогда
ЗаписьРезультата = Истина;
ИначеЕсли СтрНачинаетсяС(ТекущаяСтрока, "```") Тогда
ЗаписьРезультата = Ложь;
ЗаписьПримера = Ложь;
Иначе
Если ЗаписьПримера Тогда
Пример = Пример + " " + ТекущаяСтрока + Символы.ПС;
ОпределитьНаличиеДанных(СоответствиеДанных, ТекущаяСтрока);
КонецЕсли;
Если ЗаписьРезультата Тогда
Результат = Результат + " " + ТекущаяСтрока + Символы.ПС;
КонецЕсли;
КонецЕсли;
КонецЦикла;
Если Не ЗначениеЗаполнено(ИмяФункции) Тогда
Сообщить("Документ без имени функции: " + Документ.ПолноеИмя);
Продолжить;
КонецЕсли;
Если ЗначениеЗаполнено(СокрЛП(Результат)) Тогда
ПутьБиблиотеки = ПутьКРезультатам + СтрЗаменить(ИмяБиблиотеки, "_", "");
КаталогБиблиотеки = Новый Файл(ПутьБиблиотеки);
Если Не КаталогБиблиотеки.Существует() Тогда
СоздатьКаталог(ПутьБиблиотеки);
КонецЕсли;
ПутьРезультата = ПутьБиблиотеки + "/" + ИмяФункции + ".log";
ФайлРезультата = Новый Файл(ПутьРезультата);
Если ФайлРезультата.Существует() Тогда
Сообщить("Файл результата существует: " + ПутьРезультата);
Иначе
ДокументРезультата = Новый ТекстовыйДокумент();
ДокументРезультата.УстановитьТекст(Результат);
ДокументРезультата.Записать(ПутьРезультата);
Сообщить("Файл результата записан: " + ПутьРезультата);
КонецЕсли;
КонецЕсли;
Если ЗначениеЗаполнено(СокрЛП(Пример)) Тогда
ПутьБиблиотеки = ПутьКПримерам + СтрЗаменить(ИмяБиблиотеки, "_", "");
КаталогБиблиотеки = Новый Файл(ПутьБиблиотеки);
Если Не КаталогБиблиотеки.Существует() Тогда
СоздатьКаталог(ПутьБиблиотеки);
КонецЕсли;
ПутьПримера = ПутьБиблиотеки + "/" + ИмяФункции + ".txt";
ФайлПримера = Новый Файл(ПутьПримера);
Если ФайлПримера.Существует() Тогда
Сообщить("Файл примера существует: " + ПутьПримера);
Иначе
ДокументПримера = Новый ТекстовыйДокумент();
ДокументПримера.УстановитьТекст(Пример);
ДокументПримера.Записать(ПутьПримера);
Сообщить("Файл примера записан: " + ПутьПримера);
КонецЕсли;
КонецЕсли;
Если ЗначениеЗаполнено(СоответствиеДанных) Тогда
ПутьБиблиотеки = ПутьКДанным + СтрЗаменить(ИмяБиблиотеки, "_", "");
КаталогБиблиотеки = Новый Файл(ПутьБиблиотеки);
Если Не КаталогБиблиотеки.Существует() Тогда
СоздатьКаталог(ПутьБиблиотеки);
КонецЕсли;
ПутьДанных = ПутьБиблиотеки + "/" + ИмяФункции + ".json";
ФайлДанных = Новый Файл(ПутьДанных);
Если ФайлДанных.Существует() Тогда
Сообщить("Файл данных существует: " + ПутьДанных);
Иначе
ЗаписьJSON = Новый ЗаписьJSON();
ЗаписьJSON.ОткрытьФайл(ПутьДанных);
ЗаписатьJSON(ЗаписьJSON, СоответствиеДанных);
ЗаписьJSON.Закрыть();
Сообщить("Файл данных записан: " + ПутьДанных);
КонецЕсли;
КонецЕсли;
КонецЦикла;
Если Не ЗначениеЗаполнено(ИмяФункции) Тогда
Сообщить("Документ без имени функции: " + Документ.ПолноеИмя);
Продолжить;
КонецЕсли;
Если ЗначениеЗаполнено(СокрЛП(Результат)) Тогда
ПутьБиблиотеки = ПутьКРезультатам + СтрЗаменить(ИмяБиблиотеки, "_", "");
КаталогБиблиотеки = Новый Файл(ПутьБиблиотеки);
Если Не КаталогБиблиотеки.Существует() Тогда
СоздатьКаталог(ПутьБиблиотеки);
КонецЕсли;
ПутьРезультата = ПутьБиблиотеки + "/" + ИмяФункции + ".log";
ФайлРезультата = Новый Файл(ПутьРезультата);
Если ФайлРезультата.Существует() Тогда
Сообщить("Файл результата существует: " + ПутьРезультата);
Иначе
ДокументРезультата = Новый ТекстовыйДокумент();
ДокументРезультата.УстановитьТекст(Результат);
ДокументРезультата.Записать(ПутьРезультата);
Сообщить("Файл результата записан: " + ПутьРезультата);
КонецЕсли;
КонецЕсли;
Если ЗначениеЗаполнено(СокрЛП(Пример)) Тогда
ПутьБиблиотеки = ПутьКПримерам + СтрЗаменить(ИмяБиблиотеки, "_", "");
КаталогБиблиотеки = Новый Файл(ПутьБиблиотеки);
Если Не КаталогБиблиотеки.Существует() Тогда
СоздатьКаталог(ПутьБиблиотеки);
КонецЕсли;
ПутьПримера = ПутьБиблиотеки + "/" + ИмяФункции + ".txt";
ФайлПримера = Новый Файл(ПутьПримера);
Если ФайлПримера.Существует() Тогда
Сообщить("Файл примера существует: " + ПутьПримера);
Иначе
ДокументПримера = Новый ТекстовыйДокумент();
ДокументПримера.УстановитьТекст(Пример);
ДокументПримера.Записать(ПутьПримера);
Сообщить("Файл примера записан: " + ПутьПримера);
КонецЕсли;
КонецЕсли;
КонецЦикла;
КонецЦикла;
КонецПроцедуры
Процедура ОпределитьНаличиеДанных(СоответствиеДанных, Знач ТекущаяСтрока)
ОбрабатываемаяСтрока = СокрЛП(ТекущаяСтрока);
Если СтрНайти(ТекущаяСтрока, "=") = 0 Тогда
Возврат;
КонецЕсли;
ЕстьДанные = СтрНайти(ТекущаяСтрока, "Новый") = 0
И СтрНайти(ТекущаяСтрока, "OPI") = 0
И СтрНайти(ТекущаяСтрока, "Запрос.") = 0;
Если ЕстьДанные Тогда
ОбрабатываемаяСтрока = СтрЗаменить(ОбрабатываемаяСтрока, """", "");
ОбрабатываемаяСтрока = СтрЗаменить(ОбрабатываемаяСтрока, ";", "");
МассивДанных = СтрРазделить(ОбрабатываемаяСтрока, "=", Ложь);
Если МассивДанных.Количество() = 2 Тогда
СоответствиеДанных.Вставить(СокрЛП(МассивДанных[0]), СокрЛП(МассивДанных[1]));
КонецЕсли;
КонецЕсли;
КонецПроцедуры
ИзвлечениеДанных();

201
.github/workflows/os/oint_docs.os vendored
View File

@ -6,6 +6,7 @@
Перем Расположение;
Перем СПодкаталогами;
Перем КаталогДокументации;
Перем КаталогЛокализации;
Перем КаталогЛогов;
Перем КаталогПримеров;
Перем КаталогЗначений;
@ -13,12 +14,14 @@
Перем ТекущаяОбласть;
Перем СчетчикОбласти;
Перем Словарь;
Перем Транслитация;
Процедура ПриСозданииОбъекта()
Расположение = ".\src\ru\OInt";
СПодкаталогами = Истина;
КаталогДокументации = ".\docs\ru\md\!temp";
КаталогДокументации = ".\docs\ru\md";
КаталогЛокализации = ".\docs\en\md";
КаталогЛогов = ".\docs\ru\results\";
КаталогПримеров = ".\docs\ru\examples\";
КаталогЗначений = ".\docs\ru\data\";
@ -32,8 +35,12 @@
Словарь = ПрочитатьJSON(ЧтениеJSON, Истина);
ЧтениеJSON.Закрыть();
ПолучитьТаблицуТранслитации();
ПроверитьСоздатьКаталог(КаталогДокументации);
СоздатьФайлыДокументации();
ПеревестиДокументацию();
КонецПроцедуры
@ -127,6 +134,11 @@
Для каждого ПараметрМетода Из СтруктураМетода["Параметры"] Цикл
Если Не ЗначениеЗаполнено(ПараметрМетода.Опция) Или Не СтруктураМетода["ЕстьCLI"] Тогда
Сообщить("Метод не имеет опции: " + СтруктураМетода["Заголовок"]);
Возврат;
КонецЕсли;
ТаблицаПараметров = ТаблицаПараметров + " | "
+ ПараметрМетода.Имя + " | "
+ ПараметрМетода.Опция + " | "
@ -449,44 +461,6 @@
Функция ТранслитироватьСтроку(Знач Значение)
Значение = нРег(Значение);
Транслитация = Новый Соответствие();
Транслитация.Вставить("а", "a");
Транслитация.Вставить("б", "b");
Транслитация.Вставить("в", "v");
Транслитация.Вставить("г", "g");
Транслитация.Вставить("д", "d");
Транслитация.Вставить("е", "e");
Транслитация.Вставить("ё", "e");
Транслитация.Вставить("ж", "zh");
Транслитация.Вставить("з", "z");
Транслитация.Вставить("и", "i");
Транслитация.Вставить("й", "y");
Транслитация.Вставить("к", "k");
Транслитация.Вставить("л", "l");
Транслитация.Вставить("м", "m");
Транслитация.Вставить("н", "n");
Транслитация.Вставить("о", "o");
Транслитация.Вставить("п", "p");
Транслитация.Вставить("р", "r");
Транслитация.Вставить("с", "s");
Транслитация.Вставить("т", "t");
Транслитация.Вставить("у", "u");
Транслитация.Вставить("ф", "f");
Транслитация.Вставить("х", "h");
Транслитация.Вставить("ц", "ts");
Транслитация.Вставить("ч", "ch");
Транслитация.Вставить("ш", "sh");
Транслитация.Вставить("щ", "sch");
Транслитация.Вставить("ъ", "");
Транслитация.Вставить("ы", "y");
Транслитация.Вставить("ь", "");
Транслитация.Вставить("э", "e");
Транслитация.Вставить("ю", "u");
Транслитация.Вставить("я", "ya");
Транслитация.Вставить(" ", "-");
Транслитация.Вставить("(", "");
Транслитация.Вставить(")", "");
Для Каждого ЗаменяемыйСимвол Из Транслитация Цикл
Значение = СтрЗаменить(Значение, ЗаменяемыйСимвол.Ключ, ЗаменяемыйСимвол.Значение);
@ -503,6 +477,9 @@
Если Не ЗначениеЗаполнено(ПереведенноеИмя) Тогда
ПереведенноеИмя = ТранслитироватьСтроку(Значение);
ПереведенноеИмя = СтрЗаменить(ПереведенноеИмя, "(", "");
ПереведенноеИмя = СтрЗаменить(ПереведенноеИмя, ")", "");
ПереведенноеИмя = СтрЗаменить(ПереведенноеИмя, "-", " ");
КонецЕсли;
Возврат ПереведенноеИмя;
@ -565,8 +542,152 @@
КонецФункции
Процедура ПолучитьТаблицуТранслитации()
Транслитация = Новый Соответствие();
Транслитация.Вставить("а", "a");
Транслитация.Вставить("б", "b");
Транслитация.Вставить("в", "v");
Транслитация.Вставить("г", "g");
Транслитация.Вставить("д", "d");
Транслитация.Вставить("е", "e");
Транслитация.Вставить("ё", "e");
Транслитация.Вставить("ж", "zh");
Транслитация.Вставить("з", "z");
Транслитация.Вставить("и", "i");
Транслитация.Вставить("й", "y");
Транслитация.Вставить("к", "k");
Транслитация.Вставить("л", "l");
Транслитация.Вставить("м", "m");
Транслитация.Вставить("н", "n");
Транслитация.Вставить("о", "o");
Транслитация.Вставить("п", "p");
Транслитация.Вставить("р", "r");
Транслитация.Вставить("с", "s");
Транслитация.Вставить("т", "t");
Транслитация.Вставить("у", "u");
Транслитация.Вставить("ф", "f");
Транслитация.Вставить("х", "h");
Транслитация.Вставить("ц", "ts");
Транслитация.Вставить("ч", "ch");
Транслитация.Вставить("ш", "sh");
Транслитация.Вставить("щ", "sch");
Транслитация.Вставить("ъ", "");
Транслитация.Вставить("ы", "y");
Транслитация.Вставить("ь", "");
Транслитация.Вставить("э", "e");
Транслитация.Вставить("ю", "u");
Транслитация.Вставить("я", "ya");
КонецПроцедуры
Процедура СкопироватьФайлы(Знач КаталогИсточник, Знач КаталогПриемник)
Сообщить("Каталог источник: " + КаталогИсточник);
Сообщить("Каталог приемника: " + КаталогПриемник);
Сообщить("Создание каталога " + КаталогПриемник);
СоздатьКаталог(КаталогПриемник);
МассивФайлов = НайтиФайлы(КаталогИсточник, "*.*", Истина);
Для Каждого Файл Из МассивФайлов Цикл
Если СтрНайти(Файл.ПолноеИмя, "cli") <> 0 Тогда
Продолжить;
КонецЕсли;
ПолноеИмяИсточник = Файл.ПолноеИмя;
ПолноеИмяПриемник = КаталогПриемник + СтрЗаменить(Файл.ПолноеИмя, КаталогИсточник, "");
Если Файл.ЭтоКаталог() Тогда
СоздатьКаталог(ПолноеИмяПриемник);
Сообщить("Создание каталога " + ПолноеИмяПриемник);
Иначе
КопироватьФайл(ПолноеИмяИсточник, ПолноеИмяПриемник);
Сообщить("Копирование файла" + ПолноеИмяИсточник + " в " + ПолноеИмяПриемник);
КонецЕсли;
КонецЦикла;
КонецПроцедуры
#КонецОбласти
#Область Локализация
Процедура ПеревестиДокументацию()
Сообщить("////////////////////////////////////////////////");
Сообщить("");
Сообщить("Начало перевода...");
Сообщить("");
ФайлКаталогаДокументации = Новый Файл(КаталогДокументации);
ФайлКаталогаЛокализации = Новый Файл(КаталогЛокализации);
УдалитьФайлы(ФайлКаталогаЛокализации.ПолноеИмя);
СкопироватьФайлы(ФайлКаталогаДокументации.ПолноеИмя, ФайлКаталогаЛокализации.ПолноеИмя);
ТаблицаСловаря = Новый ТаблицаЗначений();
ТаблицаСловаря.Колонки.Добавить("Ключ");
ТаблицаСловаря.Колонки.Добавить("Значение");
ТаблицаСловаря.Колонки.Добавить("Длина");
Для Каждого КлючевоеСлово Из Словарь Цикл
НоваяСтрокаСловаря = ТаблицаСловаря.Добавить();
НоваяСтрокаСловаря.Ключ = КлючевоеСлово.Ключ;
НоваяСтрокаСловаря.Значение = КлючевоеСлово.Значение;
НоваяСтрокаСловаря.Длина = СтрДлина(КлючевоеСлово.Ключ);
КонецЦикла;
ТаблицаСловаря.Сортировать("Длина УБЫВ");
ФайлыЛокализации = НайтиФайлы(ФайлКаталогаЛокализации.ПолноеИмя, "*.md", Истина);
JsonЛокализации = НайтиФайлы(ФайлКаталогаЛокализации.ПолноеИмя, "*.json", Истина);
Для Каждого JSON из JsonЛокализации Цикл
ФайлыЛокализации.Добавить(JSON);
КонецЦикла;
Для Каждого Файл Из ФайлыЛокализации Цикл
Если Файл.ЭтоКаталог() Тогда
Продолжить;
КонецЕсли;
ТекущийДокумент = Новый ТекстовыйДокумент();
ТекущийДокумент.Прочитать(Файл.ПолноеИмя, "UTF-8");
ТекстДокумента = ТекущийДокумент.ПолучитьТекст();
Для Каждого Слово Из ТаблицаСловаря Цикл
ТекстДокумента = СтрЗаменить(ТекстДокумента, Слово.Ключ, Слово.Значение);
КонецЦикла;
Пока СтрНайти(ТекстДокумента, " ") <> 0 Цикл
ТекстДокумента = СтрЗаменить(ТекстДокумента, " ", " ");
КонецЦикла;
ТекстДокумента = СтрЗаменить(ТекстДокумента, " ,", ",");
ТекущийДокумент.УстановитьТекст(ТекстДокумента);
ТекущийДокумент.Записать(Файл.ПолноеИмя);
Для Каждого Буква Из Транслитация Цикл
Если СтрНайти(ТекстДокумента, Буква.Ключ) <> 0 Тогда
Сообщить("Ошибка перевода | " + Файл.ПолноеИмя);
Прервать;
КонецЕсли;
КонецЦикла;
КонецЦикла;
Сообщить("Перевод завершен!");
КонецПроцедуры
#КонецОбласти
#КонецОбласти
ПриСозданииОбъекта();
//ПриСозданииОбъекта();

2
.github/workflows/os/opi_translate.os vendored
View File

@ -193,7 +193,7 @@
НоваяСтрокаСловаря = ТаблицаСловаря.Добавить();
НоваяСтрокаСловаря.Ключ = КлючевоеСлово.Ключ;
НоваяСтрокаСловаря.Значение = КлючевоеСлово.Значение;
НоваяСтрокаСловаря.Длина = СтрДлина(Элемент.Ключ);
НоваяСтрокаСловаря.Длина = СтрДлина(КлючевоеСлово.Ключ);
НоваяСтрокаСловаря.ИмяМодуля = Ложь;
КонецЦикла;

4
.github/workflows/os/template.md vendored
View File

@ -12,7 +12,7 @@ sidebar_position: @Счетчик
|-|-|-|-|
@ТаблицаПараметров
Вовзращаемое значение: @ВозвращаемоеЗначение
Возвращаемое значение: @ВозвращаемоеЗначение
```bsl title="Пример кода"
@ -20,7 +20,7 @@ sidebar_position: @Счетчик
```
```sh title="Пример команд CLI"
```sh title="Пример команды CLI"
@ВызовCLI

2
coverage/genericCoverage.xml
View File

@ -1,2 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<coverage version="1"/>

58
docs/en/md/Airtable/Comment-management/Create-comment.md Normal file
View File

@ -0,0 +1,58 @@
---
sidebar_position: 2
---
# Create comment
Creates a comment for a record in the table
*Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table |
| Text | --text | String | Comment text |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk";
Text = "TestComment";
Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreateComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "TestComment"
```
```json title="Result"
{
"id": "comL1oGEDJvIQlMs1",
"author": {
"id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com",
"name": "Anton Titovets"
},
"text": "TestComment",
"createdTime": "2024-05-10T19:39:51.561Z",
"lastUpdatedTime": null
}
```

51
docs/en/md/Airtable/Comment-management/Delete-comment.md Normal file
View File

@ -0,0 +1,51 @@
---
sidebar_position: 4
---
# Delete comment
Deletes a comment for a table record
*Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table |
| Comment | --comment | String | Comment identifier |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk";
Comment = "comL1oGEDJvIQlMs1";
Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable DeleteComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment%
```
```json title="Result"
{
"id": "comL1oGEDJvIQlMs1",
"deleted": true
}
```

60
docs/en/md/Airtable/Comment-management/Edit-comment.md Normal file
View File

@ -0,0 +1,60 @@
---
sidebar_position: 3
---
# Modify comment
Changes the text of an existing comment
*Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table |
| Comment | --comment | String | Comment identifier |
| Text | --text | String | New comment text |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk";
Comment = "comL1oGEDJvIQlMs1";
Text = "Test comment (change.)";
Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable EditComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Test comment (change.)"
```
```json title="Result"
{
"id": "comL1oGEDJvIQlMs1",
"author": {
"id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com",
"name": "Anton Titovets"
},
"text": "Test comment (change.)",
"createdTime": "2024-05-10T19:39:52Z",
"lastUpdatedTime": "2024-05-10T19:39:51.967Z"
}
```

62
docs/en/md/Airtable/Comment-management/Get-comments.md Normal file
View File

@ -0,0 +1,62 @@
---
sidebar_position: 1
---
# Get comments
Gets the list of comments for a record in the table
*Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table |
| Indent | --offset | String | Next page identifier of data from the previous request |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk";
Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetComments --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset%
```
```json title="Result"
{
"comments": [
{
"id": "comL1oGEDJvIQlMs1",
"author": {
"id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com",
"name": "Anton Titovets"
},
"text": "Test comment (change.)",
"createdTime": "2024-05-10T19:39:52Z",
"lastUpdatedTime": "2024-05-10T19:39:52Z"
}
],
"offset": null
}
```

4
docs/en/md/Airtable/Comment-management/_category_.json Normal file
View File

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

85
docs/en/md/Airtable/Database-work/Create-database.md Normal file
View File

@ -0,0 +1,85 @@
---
sidebar_position: 3
---
# Create base
Creates a new database
*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Workspace | --ws | String | Workspace identifier |
| Name | --title | String | New base name |
| TableCollection | --tablesdata | Key-Value Pair | Table description: Key > name, Value > array of fields |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Workspace = "wspdf8yl1yZz3PmWZ";
Name = "TestDatabase";
FieldArray = New Array;
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
FieldArray.Add(OPI_Airtable.GetStringField("String"));
TableName = "TestTable";
TableCollection = New Map;
TableCollection.Insert(TableName, FieldArray);
Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata%
```
```json title="Result"
{
"id": "applEsyJmBRm12AuN",
"tables": [
{
"id": "tblqZzW78Rvsdt9gt",
"name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldj9Z3fEpLzv40d0",
"name": "Number"
},
{
"type": "richText",
"id": "fldX1kR7lienmcdEj",
"name": "String"
}
],
"views": [
{
"id": "viwbKE3PS9jl6bqJl",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```

72
docs/en/md/Airtable/Database-work/Get-database-tables.md Normal file
View File

@ -0,0 +1,72 @@
---
sidebar_position: 2
---
# Get base tables
Gets the schema of base tables
*Function GetDatabaseTables(Val Token, Val Base) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ"
```
```json title="Result"
{
"tables": [
{
"id": "tblqZzW78Rvsdt9gt",
"name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldj9Z3fEpLzv40d0",
"name": "Number"
},
{
"type": "richText",
"id": "fldX1kR7lienmcdEj",
"name": "String"
}
],
"views": [
{
"id": "viwbKE3PS9jl6bqJl",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```

89
docs/en/md/Airtable/Database-work/Get-list-of-bases.md Normal file
View File

@ -0,0 +1,89 @@
---
sidebar_position: 1
---
# Get list of bases
Gets the list of available bases
*Function GetListOfBases(Val Token, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Indent | --offset | String | Next page identifier of the base list from the previous request |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Response = OPI_Airtable.GetListOfBases(Token); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetListOfBases --token %token% --offset %offset%
```
```json title="Result"
{
"bases": [
{
"id": "appGarzKZ0lu3gzoa",
"name": "Test",
"permissionLevel": "create"
},
{
"id": "app9WRfJirwn3yXuG",
"name": "Product catalog",
"permissionLevel": "create"
},
{
"id": "app6gigUYTzlDEq4X",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "app5hJGyK8asYYe1Q",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appRQ6VxxOZb40Uwi",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appM6FaGofV2XSfFA",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "apptm8Xqo7TwMaipQ",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "appsyQyGrF8aVN2Wm",
"name": "TestDatabase",
"permissionLevel": "create"
},
{
"id": "applEsyJmBRm12AuN",
"name": "TestDatabase",
"permissionLevel": "create"
}
]
}
```

4
docs/en/md/Airtable/Database-work/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Database work",
"position": ""
}

54
docs/en/md/Airtable/Field-work/Create-field.md Normal file
View File

@ -0,0 +1,54 @@
---
sidebar_position: 1
---
# Create field
Creates a new field in the table
*Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier |
| Table | --table | String | Table identifier |
| FieldStructure | --fielddata | Structure of Key-Value | Description of the new field |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Name = String(New UUID);
Field = OPI_Airtable.GetNumberField(Name);
Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata%
```
```json title="Result"
{
"type": "number",
"options": {
"precision": 0
},
"id": "fld3IbFtHZtBHQwsk",
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5"
}
```

44
docs/en/md/Airtable/Field-work/Get-attachment-field.md Normal file
View File

@ -0,0 +1,44 @@
---
sidebar_position: 5
---
# Get field (file)
Gets the description of a file field
*Function GetAttachmentField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "multipleAttachments");EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Attachment";
Response = OPI_Airtable.GetAttachmentField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetAttachmentField --title "Attachment"
```
```json title="Result"
{
"name": "Attachment",
"type": "multipleAttachments"
}
```

48
docs/en/md/Airtable/Field-work/Get-checkbox-field.md Normal file
View File

@ -0,0 +1,48 @@
---
sidebar_position: 6
---
# Get field (checkbox)
Gets the description of a boolean field
*Function GetCheckboxField(Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Checkbox";
Response = OPI_Airtable.GetCheckboxField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetCheckboxField --title "Checkbox"
```
```json title="Result"
{
"name": "Checkbox",
"type": "checkbox",
"options": {
"icon": "check",
"color": "yellowBright"
}
}
```

50
docs/en/md/Airtable/Field-work/Get-date-field.md Normal file
View File

@ -0,0 +1,50 @@
---
sidebar_position: 7
---
# Get field (date)
Gets the description of a date field
*Function GetDateField(Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Date";
Response = OPI_Airtable.GetDateField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetDateField --title "Date"
```
```json title="Result"
{
"name": "Date",
"type": "date",
"options": {
"dateFormat": {
"format": "YYYY-MM-DD",
"name": "iso"
}
}
}
```

44
docs/en/md/Airtable/Field-work/Get-email-field.md Normal file
View File

@ -0,0 +1,44 @@
---
sidebar_position: 8
---
# Get field (email)
Gets the description of an email field
*Function GetEmailField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "email");EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Email";
Response = OPI_Airtable.GetEmailField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetEmailField --title "Email"
```
```json title="Result"
{
"name": "Email",
"type": "email"
}
```

44
docs/en/md/Airtable/Field-work/Get-link-field.md Normal file
View File

@ -0,0 +1,44 @@
---
sidebar_position: 10
---
# Get field (url)
Gets the description of a URL field
*Function GetLinkField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "url");EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Link";
Response = OPI_Airtable.GetLinkField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetLinkField --title "Link"
```
```json title="Result"
{
"name": "Link",
"type": "url"
}
```

49
docs/en/md/Airtable/Field-work/Get-number-field.md Normal file
View File

@ -0,0 +1,49 @@
---
sidebar_position: 4
---
# Get field (numeric)
Gets the description of a numeric field
*Function GetNumberField(Val Name, Val Precision = 0) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | New field name |
| Precision | --precision | Number, String | Number of decimal places |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Number";
Precision = "0";
Response = OPI_Airtable.GetNumberField(Name, Precision); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetNumberField --title "Number" --precision "0"
```
```json title="Result"
{
"name": "Number",
"type": "number",
"options": {
"precision": 0
}
}
```

44
docs/en/md/Airtable/Field-work/Get-phone-field.md Normal file
View File

@ -0,0 +1,44 @@
---
sidebar_position: 9
---
# Get field (phone)
Gets the description of a phone number field
*Function GetPhoneField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "phoneNumber");EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "Phone";
Response = OPI_Airtable.GetPhoneField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetPhoneField --title "Phone"
```
```json title="Result"
{
"name": "Phone",
"type": "phoneNumber"
}
```

44
docs/en/md/Airtable/Field-work/Get-string-field.md Normal file
View File

@ -0,0 +1,44 @@
---
sidebar_position: 3
---
# Get field (string)
Gets the description of a string field
*Function GetStringField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "richText");EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | New field name |
Returns: Structure - Field description
```bsl title="Code example"
Name = "String";
Response = OPI_Airtable.GetStringField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetStringField --title "String"
```
```json title="Result"
{
"name": "String",
"type": "richText"
}
```

58
docs/en/md/Airtable/Field-work/Modify-field.md Normal file
View File

@ -0,0 +1,58 @@
---
sidebar_position: 2
---
# Modify field
Changes the name and/or description of an existing table field
*Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier Base |
| Table | --table | String | Table identifier |
| Field | --field | String | Field identifier |
| Name | --title | String | New name |
| Description | --description | String | New description |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Field = "fld3IbFtHZtBHQwsk";
Name = String(New UUID) + "(change.)";
Description = "New description";
Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description"
```
```json title="Result"
{
"type": "number",
"options": {
"precision": 0
},
"id": "fld3IbFtHZtBHQwsk",
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)",
"description": "New description"
}
```

4
docs/en/md/Airtable/Field-work/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Field work",
"position": ""
}

73
docs/en/md/Airtable/Record-management/Create-posts.md Normal file
View File

@ -0,0 +1,73 @@
---
sidebar_position: 3
---
# Create records
Creates one or an array of records by description or an array of field value descriptions
*Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Data | --data | Structure, Array of Structure | Set or array of sets of Key : Value pairs > Field : Indicator |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Numeric = 10;
StringType = "Hello";
RowDescription1 = New Structure("Number,String", Numeric, StringType);
RowDescription2 = New Structure("Number,String", Numeric, StringType);
Data = New Array;
Data.Add(RowDescription1);
Data.Add(RowDescription2);
Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreatePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data%
```
```json title="Result"
{
"records": [
{
"id": "recjHNKNZBWLZkZ7A",
"createdTime": "2024-05-10T19:39:51Z",
"fields": {
"Number": 10,
"String": "Hello\n"
}
},
{
"id": "recGyJ0MlN1H3GMuN",
"createdTime": "2024-05-10T19:39:51Z",
"fields": {
"Number": 10,
"String": "Hello\n"
}
}
]
}
```

60
docs/en/md/Airtable/Record-management/Delete-posts.md Normal file
View File

@ -0,0 +1,60 @@
---
sidebar_position: 4
---
# Delete records
Deletes one or an array of records by identifiers
*Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Records | --records | String, Array of String | Identifier or array of record identifiers |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Records = New Array;
Records.Add("recjHNKNZBWLZkZ7A");
Records.Add("recGyJ0MlN1H3GMuN");
Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable DeletePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records%
```
```json title="Result"
{
"records": [
{
"deleted": true,
"id": "recjHNKNZBWLZkZ7A"
},
{
"deleted": true,
"id": "recGyJ0MlN1H3GMuN"
}
]
}
```

72
docs/en/md/Airtable/Record-management/Get-list-of-records.md Normal file
View File

@ -0,0 +1,72 @@
---
sidebar_position: 1
---
# Get list of records
Gets the list of records of the selected table
*Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Indent | --offset | String | Next page identifier of data from the previous request |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetListOfRecords --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset%
```
```json title="Result"
{
"records": [
{
"id": "recGyJ0MlN1H3GMuN",
"createdTime": "2024-05-10T19:39:51Z",
"fields": {
"Number": 10,
"String": "Hello\n"
}
},
{
"id": "recV6DxeLQMBNJrUk",
"createdTime": "2024-05-10T19:39:51Z",
"fields": {
"Number": 10,
"String": "Hello\n"
}
},
{
"id": "recjHNKNZBWLZkZ7A",
"createdTime": "2024-05-10T19:39:51Z",
"fields": {
"Number": 10,
"String": "Hello\n"
}
}
]
}
```

53
docs/en/md/Airtable/Record-management/Get-record.md Normal file
View File

@ -0,0 +1,53 @@
---
sidebar_position: 2
---
# Get record
Gets row data of the table by identifier
*Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Database identifier |
| Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk";
Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable GetRecord --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk"
```
```json title="Result"
{
"id": "recV6DxeLQMBNJrUk",
"createdTime": "2024-05-10T19:39:51Z",
"fields": {
"Number": 10,
"String": "Hello\n"
}
}
```

4
docs/en/md/Airtable/Record-management/_category_.json Normal file
View File

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

127
docs/en/md/Airtable/Table-management/Create-table.md Normal file
View File

@ -0,0 +1,127 @@
---
sidebar_position: 1
---
# Create table
Creates a new table in the base
*Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier |
| Name | --title | String | New table name |
| FieldArray | --fieldsdata | Array of Structure | Array of field descriptions |
| Description | --description | String | Table description |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
TableName = "TestTable2";
Description = "NewTable";
FieldArray = New Array;
FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
FieldArray.Add(OPI_Airtable.GetStringField("String"));
FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment"));
FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox"));
FieldArray.Add(OPI_Airtable.GetDateField("Date"));
FieldArray.Add(OPI_Airtable.GetPhoneField("Phone"));
FieldArray.Add(OPI_Airtable.GetEmailField("Email"));
FieldArray.Add(OPI_Airtable.GetLinkField("Link"));
Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable CreateTable --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "NewTable"
```
```json title="Result"
{
"id": "tblT64aWyrMUAbUmF",
"name": "TestTable2",
"description": "NewTable",
"primaryFieldId": "fldoHs3kv6RLc8pjo",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldoHs3kv6RLc8pjo",
"name": "Number"
},
{
"type": "richText",
"id": "fldzY5xRHDY7ClKxa",
"name": "String"
},
{
"type": "multipleAttachments",
"options": {
"isReversed": false
},
"id": "fldYHxxXPALKl3yHp",
"name": "Attachment"
},
{
"type": "checkbox",
"options": {
"icon": "check",
"color": "yellowBright"
},
"id": "fldRUoggUObfqckXh",
"name": "Checkbox"
},
{
"type": "date",
"options": {
"dateFormat": {
"name": "iso",
"format": "YYYY-MM-DD"
}
},
"id": "fldvtwjapJM7s99nN",
"name": "Date"
},
{
"type": "phoneNumber",
"id": "flda4VY8dVd2mbqz9",
"name": "Phone"
},
{
"type": "email",
"id": "fld8ZLKndqBIkT72s",
"name": "Email"
},
{
"type": "url",
"id": "fldqjsCp1c2KaAS53",
"name": "Link"
}
],
"views": [
{
"id": "viwX3vEGO5vB2Km4k",
"name": "Grid view",
"type": "grid"
}
]
}
```

118
docs/en/md/Airtable/Table-management/Modify-table.md Normal file
View File

@ -0,0 +1,118 @@
---
sidebar_position: 2
---
# Modify table
Changes the name and/or description of the base
*Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Base | --base | String | Base identifier |
| Table | --table | String | Table identifier |
| Name | --title | String | New name |
| Description | --description | String | New description |
Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY";
Name = "Test table 2 (change.)";
Description = "New table (change.)";
Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint airtable ModifyTable --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Test table 2 (change.)" --description "New table (change.)"
```
```json title="Result"
{
"id": "tblT64aWyrMUAbUmF",
"name": "Test table 2 (change.)",
"description": "New table (change.)",
"primaryFieldId": "fldoHs3kv6RLc8pjo",
"fields": [
{
"id": "fldoHs3kv6RLc8pjo",
"name": "Number",
"type": "number",
"options": {
"precision": 0
}
},
{
"id": "fldzY5xRHDY7ClKxa",
"name": "String",
"type": "richText"
},
{
"id": "fldYHxxXPALKl3yHp",
"name": "Attachment",
"type": "multipleAttachments",
"options": {
"isReversed": false
}
},
{
"id": "fldRUoggUObfqckXh",
"name": "Checkbox",
"type": "checkbox",
"options": {
"icon": "check",
"color": "yellowBright"
}
},
{
"id": "fldvtwjapJM7s99nN",
"name": "Date",
"type": "date",
"options": {
"dateFormat": {
"name": "iso",
"format": "YYYY-MM-DD"
}
}
},
{
"id": "flda4VY8dVd2mbqz9",
"name": "Phone",
"type": "phoneNumber"
},
{
"id": "fld8ZLKndqBIkT72s",
"name": "Email",
"type": "email"
},
{
"id": "fldqjsCp1c2KaAS53",
"name": "Link",
"type": "url"
}
],
"views": [
{
"id": "viwX3vEGO5vB2Km4k",
"name": "Grid view",
"type": "grid"
}
]
}
```

4
docs/en/md/Airtable/Table-management/_category_.json Normal file
View File

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

63
docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md Normal file
View File

@ -0,0 +1,63 @@
---
sidebar_position: 4
---
# Get account information
Gets account information
*Function GetAccountInformation(Val Token, Val Account = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Account | --account | String | Account ID. Current token account if not filled |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetAccountInformation(Token);
```
```sh title="CLI command example"
oint dropbox GetAccountInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account%
```
```json title="Result"
{
"account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE",
"name": {
"given_name": "Anton",
"surname": "Titovets",
"familiar_name": "Anton",
"display_name": "Anton Titovets",
"abbreviated_name": "АТ"
},
"email": "bayselonarrend@gmail.com",
"email_verified": true,
"disabled": false,
"country": "BY",
"locale": "en",
"referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483",
"is_paired": false,
"account_type": {
".tag": "basic"
},
"root_info": {
".tag": "user",
"root_namespace_id": "3179550035",
"home_namespace_id": "3179550035"
}
}
```

37
docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md Normal file
View File

@ -0,0 +1,37 @@
---
sidebar_position: 1
---
# Get authorization link
Generates an authorization link for browser transition
*Function GetAuthorizationLink(Val AppKey) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| AppKey | --appkey | String | Application key |
Returns: String - URL for browser transition
```bsl title="Code example"
AppKey = "oynqxds...";
Result = OPI_Dropbox.GetAuthorizationLink(AppKey);
```
```sh title="CLI command example"
oint dropbox GetAuthorizationLink --appkey "oynqxds..."
```
```json title="Result"
"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline"
```

44
docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md Normal file
View File

@ -0,0 +1,44 @@
---
sidebar_position: 5
---
# Get space usage data
Gets information on the amount of used disk space
*Function GetSpaceUsageData(Val Token) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetSpaceUsageData(Token);
```
```sh title="CLI command example"
oint dropbox GetSpaceUsageData --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."
```
```json title="Result"
{
"used": 1477493597,
"allocation": {
".tag": "individual",
"allocated": 2147483648
}
}
```

45
docs/en/md/Dropbox/Account-and-authorization/Get-token.md Normal file
View File

@ -0,0 +1,45 @@
---
sidebar_position: 2
---
# Get token
Gets token based on the code from the GetAuthorizationLink page
*Function GetToken(Val AppKey, Val AppSecret, Val Code) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| AppKey | --appkey | String | Application key |
| AppSecret | --appsecret | String | Application secret |
| Code | --code | String | Code from the authorization page |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
AppKey = "oynqxds...";
AppSecret = "tk2oewn...";
Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8";
Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code);
```
```sh title="CLI command example"
oint dropbox GetToken --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"
```
```json title="Result"
{
"error": "invalid_grant",
"error_description": "code doesn't exist or has expired"
}
```

46
docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md Normal file
View File

@ -0,0 +1,46 @@
---
sidebar_position: 3
---
# Refresh token
Gets a new token based on the refresh token
*Function RefreshToken(Val AppKey, Val AppSecret, Val RefreshToken) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| AppKey | --appkey | String | Application key |
| AppSecret | --appsecret | String | Application secret |
| RefreshToken | --refresh | String | Refresh token |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
AppKey = "oynqxds...";
AppSecret = "tk2oewn...";
RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV...";
Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken);
```
```sh title="CLI command example"
oint dropbox RefreshToken --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."
```
```json title="Result"
{
"access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU",
"token_type": "bearer",
"expires_in": 14400
}
```

4
docs/en/md/Dropbox/Account-and-authorization/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Account and authorization",
"position": ""
}

56
docs/en/md/Dropbox/File-and-directory-management/Copy-object.md Normal file
View File

@ -0,0 +1,56 @@
---
sidebar_position: 8
---
# Copy object
Copies a file or directory to the selected path
*Function CopyObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Original = "/New/pic.png";
Copy = "/New/pic_copy.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.CopyObject(Token, Original, Copy);
```
```sh title="CLI command example"
oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Result"
{
"metadata": {
".tag": "file",
"name": "pic_copy.png",
"path_lower": "/new/pic_copy.png",
"path_display": "/New/pic_copy.png",
"id": "id:kJU6-a-pT48AAAAAAAABYg",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:54Z",
"rev": "619ab10ed491ebd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

47
docs/en/md/Dropbox/File-and-directory-management/Create-folder.md Normal file
View File

@ -0,0 +1,47 @@
---
sidebar_position: 10
---
# Create folder
Creates an empty directory at the selected path
*Function CreateFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Target path for creating the directory |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New catalog";
Result = OPI_Dropbox.CreateFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
{
"metadata": {
"name": "New catalog",
"path_lower": "/new catalog",
"path_display": "/New catalog",
"id": "id:kJU6-a-pT48AAAAAAAABZA"
}
}
```

55
docs/en/md/Dropbox/File-and-directory-management/Delete-object.md Normal file
View File

@ -0,0 +1,55 @@
---
sidebar_position: 7
---
# Delete object
Deletes an object from the cloud drive
*Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object to delete |
| Irrecoverable | --permanently | String | Delete object without the possibility of recovery |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.DeleteObject(Token, Path);
```
```sh title="CLI command example"
oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --permanently %permanently%
```
```json title="Result"
{
"metadata": {
".tag": "file",
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:48Z",
"rev": "619ab108e3d3dbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

40
docs/en/md/Dropbox/File-and-directory-management/Download-file.md Normal file
View File

@ -0,0 +1,40 @@
---
sidebar_position: 11
---
# Download file
Downloads a file by the specified path or ID
*Function DownloadFile(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path or ID of the file |
Returns: BinaryData - binary data of the file
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.DownloadFile(Token, Path);
```
```sh title="CLI command example"
oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png"
```
```json title="Result"
NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00…
```

40
docs/en/md/Dropbox/File-and-directory-management/Download-folder.md Normal file
View File

@ -0,0 +1,40 @@
---
sidebar_position: 12
---
# Download folder
Downloads a zip archive with the contents of the specified directory
*Function DownloadFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path or ID of the directory |
Returns: BinaryData - binary data of the zip archive with the contents of the directory
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New";
Result = OPI_Dropbox.DownloadFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New"
```
```json title="Result"
NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00…
```

42
docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md Normal file
View File

@ -0,0 +1,42 @@
---
sidebar_position: 2
---
# Get list of folder files
Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified
*Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the directory. Optional if the cursor is specified |
| Detailed | --detail | Boolean | Adds additional information fields for media files |
| Cursor | --cursor | String | Cursor from the previous request to get the next set of files |
Returns: HTTPResponse - Get list of folder files
```bsl title="Code example"
Path = "/New";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True);
```
```sh title="CLI command example"
oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New" --detail %detail% --cursor %cursor%
```
```json title="Result"
```

53
docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md Normal file
View File

@ -0,0 +1,53 @@
---
sidebar_position: 1
---
# Get object information
Gets information about a file or directory
*Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Detailed | --detail | Boolean | Adds additional information fields for media files |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetObjectInformation(Token, Path, True);
```
```sh title="CLI command example"
oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --detail %detail%
```
```json title="Result"
{
".tag": "file",
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

57
docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md Normal file
View File

@ -0,0 +1,57 @@
---
sidebar_position: 13
---
# Get list of object versions
Gets the list of versions (revisions) of the object
*Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Count | --amount | String, Number | Number of the latest versions of the object to display |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1);
```
```sh title="CLI command example"
oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --amount %amount%
```
```json title="Result"
{
"is_deleted": false,
"entries": [
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
]
}
```

40
docs/en/md/Dropbox/File-and-directory-management/Get-preview.md Normal file
View File

@ -0,0 +1,40 @@
---
sidebar_position: 3
---
# Get preview
Gets PDF or HTML preview of the object (for documents only)
*Function GetPreview(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
Returns: BinaryData - document preview
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx";
Result = OPI_Dropbox.GetPreview(Token, Path);
```
```sh title="CLI command example"
oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/mydoc.docx"
```
```json title="Result"
NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53…
```

62
docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md Normal file
View File

@ -0,0 +1,62 @@
---
sidebar_position: 6
---
# Get upload status by URL
Gets the upload status of the file by URL
*Function GetUploadStatusByURL(Val Token, Val JobID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
WorkID = "G8YbueOu2nsAAAAAAAAAAQ";
Status = "in_progress";
WHile Status = "in_progress" Do
Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID);
Status = Result[".tag"];
OPI_Tools.Pause(5);
OPI_TestDataRetrieval.WriteLog(Result, "GetUploadStatusByURL", "Dropbox");
EndDo;
```
```sh title="CLI command example"
oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job%
```
```json title="Result"
{
".tag": "complete",
"name": "url_doc.docx",
"path_lower": "/new/url_doc.docx",
"path_display": "/New/url_doc.docx",
"id": "id:kJU6-a-pT48AAAAAAAABYw",
"client_modified": "2024-05-30T12:33:07Z",
"server_modified": "2024-05-30T12:33:08Z",
"rev": "619ab11c37fb9bd841553",
"size": 24069,
"is_downloadable": true,
"content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c"
}
```

42
docs/en/md/Dropbox/File-and-directory-management/Move-object.md Normal file
View File

@ -0,0 +1,42 @@
---
sidebar_position: 9
---
# Move object
Moves an object to the selected path
*Function MoveObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
OriginalPath = "/New/pic.png";
TargetPath = "/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath);
```
```sh title="CLI command example"
oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Result"
```

53
docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md Normal file
View File

@ -0,0 +1,53 @@
---
sidebar_position: 14
---
# Restore object to version
Restores object state to required version (revision)
*Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Version | --rev | String | ID of the version (revision) for restoration |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Version = "61a0b76320a6fbd841553";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version);
```
```sh title="CLI command example"
oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --rev "61a0b76320a6fbd841553"
```
```json title="Result"
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

45
docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md Normal file
View File

@ -0,0 +1,45 @@
---
sidebar_position: 5
---
# Upload file by URL
Uploads a file to the cloud drive by fetching it from the specified URL
*Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FileURL | --url | String | URL source of the file |
| Path | --path | String | Save path on Dropbox |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/url_doc.docx";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
URL = "https://openintegrations.dev/test_data/document.docx";
Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path);
```
```sh title="CLI command example"
oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path "/New/url_doc.docx"
```
```json title="Result"
{
".tag": "async_job_id",
"async_job_id": "41d0vPCn2mYAAAAAAAAAAQ"
}
```

57
docs/en/md/Dropbox/File-and-directory-management/Upload-file.md Normal file
View File

@ -0,0 +1,57 @@
---
sidebar_position: 4
---
# Upload file
Uploads a file to the cloud drive
*Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| File | --file | String, BinaryData | Data file for upload |
| Path | --path | String | Save path on Dropbox |
| Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Image = "https://openintegrations.dev/test_data/picture.jpg";
ImagePath = GetTempFileName("png");
CopyFile(Image, ImagePath);
Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True);
```
```sh title="CLI command example"
oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path "/New/pic.png" --overwrite %overwrite%
```
```json title="Result"
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

4
docs/en/md/Dropbox/File-and-directory-management/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "File and directory management",
"position": ""
}

43
docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md Normal file
View File

@ -0,0 +1,43 @@
---
sidebar_position: 3
---
# Add user to file
Defines access to the file for an external user
*Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FileID | --fileid | String | ID of the file to be accessed |
| EmailAddresses | --emails | String, Array of String | List of email addresses of users being added |
| ViewOnly | --readonly | Boolean | Prohibits file editing for the external user |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Email = "h5bk6ft62s@privaterelay.appleid.com";
File = "kJU6-a-pT48AAAAAAAAABw";
Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False);
```
```sh title="CLI command example"
oint dropbox AddUsersToFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly%
```
```json title="Result"
```

43
docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md Normal file
View File

@ -0,0 +1,43 @@
---
sidebar_position: 4
---
# Add users to folder
Grants external users access to the directory
*Function AddUsersToFolder(Val Token, Val FolderID, Val EmailAddresses, Val ViewOnly = True) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FolderID | --folder | String | ID of the public catalog (shared folder ID) |
| EmailAddresses | --emails | String, Array of String | List of email addresses of users being added |
| ViewOnly | --readonly | Boolean | Prohibits file editing for the external user |
Returns: Undefined - empty response
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Email = "h5bk6ft62s@privaterelay.appleid.com";
Folder = "5022319569"; // shared_folder_id
Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False);
```
```sh title="CLI command example"
oint dropbox AddUsersToFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly%
```
```json title="Result"
```

40
docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md Normal file
View File

@ -0,0 +1,40 @@
---
sidebar_position: 6
---
# Unpublish file
Prohibits access to the file for external users
*Function CancelFilePublication(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FileID | --fileid | String | ID of the file to be accessed |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
File = "kJU6-a-pT48AAAAAAAAABw";
Result = OPI_Dropbox.CancelFilePublication(Token, File);
```
```sh title="CLI command example"
oint dropbox CancelFilePublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid%
```
```json title="Result"
{}
```

50
docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md Normal file
View File

@ -0,0 +1,50 @@
---
sidebar_position: 2
---
# Unpublish folder
Cancels the public access mode for the directory
*Function CancelFolderPublication(Val Token, Val FolderID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FolderID | --folder | String | ID of the public catalog (shared folder ID) |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Folder = "5022319569";
Result = OPI_Dropbox.CancelFolderPublication(Token, Folder);
CurrentStatus = "in_progress";
JobID = Result["async_job_id"];
WHile CurrentStatus = "in_progress" Do
Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID);
CurrentStatus = Result[".tag"];
OPI_Tools.Pause(3);
EndDo;
```
```sh title="CLI command example"
oint dropbox CancelFolderPublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder%
```
```json title="Result"
{
".tag": "complete"
}
```

36
docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md Normal file
View File

@ -0,0 +1,36 @@
---
sidebar_position: 5
---
# Get asynchronous change status
Gets the status of the asynchronous access change job
*Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| JobID | --job | String | AsynchronousJobID |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
```
```sh title="CLI command example"
oint dropbox GetAsynchronousChangeStatus --token %token% --job %job%
```
```json title="Result"
```

68
docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md Normal file
View File

@ -0,0 +1,68 @@
---
sidebar_position: 1
---
# Publish folder
Sets the directory to public access mode
*Function PublishFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the target directory |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New";
Result = OPI_Dropbox.PublishFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox PublishFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New"
```
```json title="Result"
{
".tag": "complete",
"access_type": {
".tag": "owner"
},
"is_inside_team_folder": false,
"is_team_folder": false,
"path_display": "/New",
"path_lower": "/new",
"name": "New",
"policy": {
"acl_update_policy": {
".tag": "editors"
},
"shared_link_policy": {
".tag": "anyone"
},
"viewer_info_policy": {
".tag": "enabled"
}
},
"preview_url": "https://www.dropbox.com/scl/fo/0eu3zz5f05vymefoq6yyl/h?dl=0",
"shared_folder_id": "5009428129",
"time_invited": "2024-05-30T12:35:34Z",
"access_inheritance": {
".tag": "inherit"
},
"folder_id": "id:kJU6-a-pT48AAAAAAAABXw"
}
```

4
docs/en/md/Dropbox/Shared-access-settings/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Shared access settings",
"position": ""
}

42
docs/en/md/Dropbox/Tag-work/Add-tag.md Normal file
View File

@ -0,0 +1,42 @@
---
sidebar_position: 2
---
# Add tag
Adds a new text tag to a file or directory
*Function AddTag(Val Token, Val Path, Val Tag) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object for which the tag needs to be created |
| Tag | --tag | String | Tag text |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Tag = "Important";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx";
Result = OPI_Dropbox.AddTag(Token, Path, Tag);
```
```sh title="CLI command example"
oint dropbox AddTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/mydoc.docx" --tag "Important"
```
```json title="Result"
{}
```

42
docs/en/md/Dropbox/Tag-work/Delete-tag.md Normal file
View File

@ -0,0 +1,42 @@
---
sidebar_position: 3
---
# Delete tag
Deletes the text tag of a file or directory
*Function DeleteTag(Val Token, Val Path, Val Tag) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object whose tag needs to be deleted |
| Tag | --tag | String | Tag text |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Tag = "Important";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx";
Result = OPI_Dropbox.DeleteTag(Token, Path, Tag);
```
```sh title="CLI command example"
oint dropbox DeleteTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/mydoc.docx" --tag "Important"
```
```json title="Result"
{}
```

52
docs/en/md/Dropbox/Tag-work/Get-tag-list.md Normal file
View File

@ -0,0 +1,52 @@
---
sidebar_position: 1
---
# Get list of tags
Gets the list of tags of the selected files
*Function GetTagList(Val Token, Val Paths) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Paths | --paths | String, Array of String | Path or set of paths to the files |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
```
```sh title="CLI command example"
oint dropbox GetTagList --token %token% --paths %paths%
```
```json title="Result"
{
"paths_to_tags": [
{
"path": "/New/Dogs.mp3",
"tags": []
},
{
"path": "/New/mydoc.docx",
"tags": [
{
".tag": "user_generated_tag",
"tag_text": "important"
}
]
}
]
}
```

4
docs/en/md/Dropbox/Tag-work/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Tag work",
"position": ""
}

58
docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md Normal file
View File

@ -0,0 +1,58 @@
---
sidebar_position: 2
---
# Add calendar to list
Adds an existing calendar to the user's list
*Function AddCalendarToList(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.AddCalendarToList(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar AddCalendarToList --token %token% --calendar %calendar%
```
```json title="Result"
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "owner",
"selected": true,
"foregroundColor": "#000000",
"backgroundColor": "#7bd148",
"colorId": "9",
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"defaultReminders": [],
"timeZone": "UTC",
"id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com",
"etag": "\"1708423365033000\"",
"kind": "calendar#calendarListEntry"
}
```

40
docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md Normal file
View File

@ -0,0 +1,40 @@
---
sidebar_position: 4
---
# Remove calendar from list
Removes a calendar from the user's list
*Function DeleteCalendarFromList(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.DeleteCalendarFromList(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar DeleteCalendarFromList --token %token% --calendar %calendar%
```
```json title="Result"
""
```

64
docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md Normal file
View File

@ -0,0 +1,64 @@
---
sidebar_position: 5
---
# Edit list calendar
Edits the properties of a calendar from the user's list
*Function EditListCalendar(Val Token, Val Calendar, Val PrimaryColor, Val SecondaryColor, Val Hidden = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
| PrimaryColor | --primary | String | HEX primary color (#ffffff) |
| SecondaryColor | --secondary | String | HEX secondary color (#ffffff) |
| Hidden | --hidden | Boolean | Hidden calendar |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Black = "#000000";
Yellow = "#ffd800";
Response = OPI_GoogleCalendar.EditListCalendar(Token, "55868c32be16935f0...", Black, Yellow, False); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar EditListCalendar --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden%
```
```json title="Result"
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "owner",
"foregroundColor": "#000000",
"backgroundColor": "#ffd800",
"colorId": "6",
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"defaultReminders": [],
"timeZone": "UTC",
"id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com",
"etag": "\"1708424005038000\"",
"kind": "calendar#calendarListEntry"
}
```

174
docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md Normal file
View File

@ -0,0 +1,174 @@
---
sidebar_position: 1
---
# Get list of calendars
Gets an array of account calendars
*Function GetCalendarList(Val Token) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
Returns: Key-Value Pair - Array of calendar data mappings
```bsl title="Code example"
Response = OPI_GoogleCalendar.GetCalendarList(Token); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar GetCalendarList --token %token%
```
```json title="Result"
[
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "reader",
"foregroundColor": "#000000",
"backgroundColor": "#92e1c0",
"colorId": "13",
"description": "Hollydays.",
"summary": "Hollydays",
"defaultReminders": [],
"timeZone": "Europe/Minsk",
"id": "addressbook#contacts@group.v.calendar.google.com",
"etag": "\"1708410978711000\"",
"kind": "calendar#calendarListEntry"
},
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"notificationSettings": {
"notifications": [
{
"method": "email",
"type": "eventCreation"
},
{
"method": "email",
"type": "eventChange"
},
{
"method": "email",
"type": "eventCancellation"
},
{
"method": "email",
"type": "eventResponse"
}
]
},
"accessRole": "owner",
"selected": true,
"foregroundColor": "#000000",
"backgroundColor": "#9fe1e7",
"colorId": "14",
"primary": true,
"summary": "bayselonarrend@gmail.com",
"defaultReminders": [
{
"minutes": 30,
"method": "popup"
}
],
"timeZone": "Europe/Minsk",
"id": "bayselonarrend@gmail.com",
"etag": "\"1708411692097000\"",
"kind": "calendar#calendarListEntry"
},
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "reader",
"foregroundColor": "#000000",
"backgroundColor": "#16a765",
"colorId": "8",
"description": "Holidays and memorable dates in Belarus",
"summary": "Holidays in Belarus",
"defaultReminders": [],
"timeZone": "Europe/Minsk",
"id": "ru.by#holiday@group.v.calendar.google.com",
"etag": "\"1708417568219000\"",
"kind": "calendar#calendarListEntry"
},
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "owner",
"foregroundColor": "#000000",
"backgroundColor": "#cca6ac",
"colorId": "21",
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"defaultReminders": [],
"timeZone": "UTC",
"id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com",
"etag": "\"1708417602744000\"",
"kind": "calendar#calendarListEntry"
},
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "owner",
"foregroundColor": "#000000",
"backgroundColor": "#ffd800",
"colorId": "6",
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"defaultReminders": [],
"timeZone": "UTC",
"id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com",
"etag": "\"1708417840630000\"",
"kind": "calendar#calendarListEntry"
},
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "owner",
"foregroundColor": "#000000",
"backgroundColor": "#ffd800",
"colorId": "6",
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"defaultReminders": [],
"timeZone": "UTC",
"id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com",
"etag": "\"1708418157716000\"",
"kind": "calendar#calendarListEntry"
}
]
```

57
docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md Normal file
View File

@ -0,0 +1,57 @@
---
sidebar_position: 3
---
# Get list calendar
Gets a calendar from the user's list by ID
*Function GetListCalendar(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.GetListCalendar(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar GetListCalendar --token %token% --calendar %calendar%
```
```json title="Result"
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"accessRole": "owner",
"foregroundColor": "#000000",
"backgroundColor": "#ffd800",
"colorId": "6",
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"defaultReminders": [],
"timeZone": "UTC",
"id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com",
"etag": "\"1708423563386000\"",
"kind": "calendar#calendarListEntry"
}
```

4
docs/en/md/Google_Calendar/Calendar-list-management/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Calendar list management",
"position": ""
}

38
docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md Normal file
View File

@ -0,0 +1,38 @@
---
sidebar_position: 4
---
# Clear primary calendar
Clears the event list of the primary calendar
*Function ClearMainCalendar(Val Token) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.ClearMainCalendar(Token);
```
```sh title="CLI command example"
oint gcalendar ClearMainCalendar --token %token%
```
```json title="Result"
""
```

51
docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md Normal file
View File

@ -0,0 +1,51 @@
---
sidebar_position: 1
---
# Create calendar
Creates an empty calendar
*Function CreateCalendar(Val Token, Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Name of the created calendar |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.CreateCalendar(Token, "TestCalendar"); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar CreateCalendar --token %token% --title %title%
```
```json title="Result"
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"summary": "TestCalendar",
"timeZone": "UTC",
"id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com",
"etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"",
"kind": "calendar#calendar"
}
```

39
docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md Normal file
View File

@ -0,0 +1,39 @@
---
sidebar_position: 5
---
# Delete calendar
Deletes a calendar by ID
*Function DeleteCalendar(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.DeleteCalendar(Token, "55868c32be16935f0...");
```
```sh title="CLI command example"
oint gcalendar DeleteCalendar --token %token% --calendar %calendar%
```
```json title="Result"
""
```

56
docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md Normal file
View File

@ -0,0 +1,56 @@
---
sidebar_position: 3
---
# Edit calendar
Edits properties of an existing calendar
*Function EditCalendarMetadata(Val Token, Val Calendar, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
| Name | --title | String | New name |
| Description | --description | String | New calendar description |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Name = "TestCalendar (change.)";
Description = "TestDescription";
Response = OPI_GoogleCalendar.EditCalendarMetadata(Token, "55868c32be16935f0...", Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar EditCalendarMetadata --token %token% --calendar %calendar% --title "TestCalendar (change.)" --description "TestDescription"
```
```json title="Result"
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"timeZone": "UTC",
"id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com",
"etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"",
"kind": "calendar#calendar"
}
```

52
docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md Normal file
View File

@ -0,0 +1,52 @@
---
sidebar_position: 2
---
# Get calendar
Gets calendar information by ID
*Function GetCalendarMetadata(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.GetCalendarMetadata(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar GetCalendarMetadata --token %token% --calendar %calendar%
```
```json title="Result"
{
"conferenceProperties": {
"allowedConferenceSolutionTypes": [
"hangoutsMeet"
]
},
"description": "TestDescription",
"summary": "TestCalendar (change.)",
"timeZone": "UTC",
"id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com",
"etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"",
"kind": "calendar#calendar"
}
```

4
docs/en/md/Google_Calendar/Calendar-metadata-management/_category_.json Normal file
View File

@ -0,0 +1,4 @@
{
"label": "Calendar metadata management",
"position": ""
}

99
docs/en/md/Google_Calendar/Event-management/Create-event.md Normal file
View File

@ -0,0 +1,99 @@
---
sidebar_position: 4
---
# Create event
Creates a new event
*Function CreateEvent(Val Token, Val Calendar, Val EventDescription) ExportReturn EventManagement(Token, Calendar, EventDescription);EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
| EventDescription | --props | Key-Value Pair | Event description |
Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response
```bsl title="Code example"
Attachments = New Map;
Attachments.Insert("Image1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png");
Attachments.Insert("Image2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1");
EventMatch = New Map;
EventMatch.Insert("Description", Description);
EventMatch.Insert("Title", Name);
EventMatch.Insert("Venue", "On office");
EventMatch.Insert("StartDate", CurrentSessionDate());
EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600);
EventMatch.Insert("ArrayOfAttachmentURLs", Attachments);
EventMatch.Insert("SendNotifications", True);
Response = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventMatch);
Response = OPI_Tools.JSONString(Response);
```
```sh title="CLI command example"
oint gcalendar CreateEvent --token %token% --calendar %calendar% --props %props%
```
```json title="Result"
{
"eventType": "default",
"attachments": [
{
"iconLink": "",
"title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
},
{
"iconLink": "",
"title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
}
],
"reminders": {
"useDefault": true
},
"sequence": 0,
"start": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T15:16:25+03:00"
},
"creator": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"end": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T16:16:25+03:00"
},
"iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com",
"description": "TestEventDescription",
"updated": "2024-02-21T09:16:28.474Z",
"created": "2024-02-21T09:16:28.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ",
"location": "On office",
"summary": "New event",
"organizer": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"status": "confirmed",
"id": "j4nonfcc0m2mtop1vc8ivo8tb8",
"etag": "\"3417013976948000\"",
"kind": "calendar#event"
}
```

41
docs/en/md/Google_Calendar/Event-management/Delete-event.md Normal file
View File

@ -0,0 +1,41 @@
---
sidebar_position: 7
---
# Delete event
Deletes an event by ID
*Function DeleteEvent(Val Token, Val Calendar, Val Event) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
| Event | --event | String | Event ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.DeleteEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar DeleteEvent --token %token% --calendar %calendar% --event %event%
```
```json title="Result"
""
```

90
docs/en/md/Google_Calendar/Event-management/Edit-event.md Normal file
View File

@ -0,0 +1,90 @@
---
sidebar_position: 6
---
# Edit event
Edits an existing event
*Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) ExportReturn EventManagement(Token, Calendar, EventDescription, Event);EndFunction*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
| EventDescription | --props | String | New event description |
| Event | --event | String | Event ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
EventMatch = New Map;
EventMatch.Insert("Description", "Test event description (change.)");
Response = OPI_GoogleCalendar.EditEvent(Token, "55868c32be16935f0...", EventMatch, "j4nonfcc0m2...");
Response = OPI_Tools.JSONString(Response);
```
```sh title="CLI command example"
oint gcalendar EditEvent --token %token% --calendar %calendar% --props %props% --event %event%
```
```json title="Result"
{
"eventType": "default",
"attachments": [
{
"iconLink": "",
"title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
},
{
"iconLink": "",
"title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
}
],
"reminders": {
"useDefault": true
},
"sequence": 0,
"start": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T16:42:28+03:00"
},
"creator": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"end": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T17:42:28+03:00"
},
"iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com",
"description": "Test event description (change.)",
"updated": "2024-02-24T10:42:42.401Z",
"created": "2024-02-24T10:42:32.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ",
"location": "InOffice",
"summary": "New event",
"organizer": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"status": "confirmed",
"id": "7c2s6g3k6ib1mr2v1b7lnt9kfk",
"etag": "\"3417542724802000\"",
"kind": "calendar#event"
}
```

41
docs/en/md/Google_Calendar/Event-management/Get-event-description.md Normal file
View File

@ -0,0 +1,41 @@
---
sidebar_position: 1
---
# Get description events
*Function GetEventDescription() Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
Returns: Key-Value Pair - Empty event template
```bsl title="Code example"
```
```sh title="CLI command example"
oint gcalendar GetEventDescription
```
```json title="Result"
EventMatch = New Map;
EventMatch.Insert("Description", ""); // Event description
EventMatch.Insert("Title", "New event"); // Title events
EventMatch.Insert("Venue", ""); // String description of the venue of the event
EventMatch.Insert("StartDate", CurrentSessionDate()); // Date of start events
EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); // Date of end events
EventMatch.Insert("ArrayOfAttachmentURLs", New Map); // Key - name, Value - URL to file
EventMatch.Insert("SendNotifications", True); // Indication of sending notifications to participants
```

89
docs/en/md/Google_Calendar/Event-management/Get-event-list.md Normal file
View File

@ -0,0 +1,89 @@
---
sidebar_position: 2
---
# Get list of events
Gets the list of all calendar events
*Function GetEventList(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - Array of event mappings
```bsl title="Code example"
Response = OPI_GoogleCalendar.GetEventList(Token, "55868c32be16935f0...");
Response = OPI_Tools.JSONString(Response);
```
```sh title="CLI command example"
oint gcalendar GetEventList --token %token% --calendar %calendar%
```
```json title="Result"
[
{
"eventType": "default",
"attachments": [
{
"iconLink": "",
"title": "",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
},
{
"iconLink": "",
"title": "",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
}
],
"reminders": {
"useDefault": true
},
"sequence": 0,
"start": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-20T05:31:12+03:00"
},
"creator": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"end": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-20T06:31:12+03:00"
},
"iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com",
"description": "TestEventDescription",
"updated": "2024-02-20T11:31:13.044Z",
"created": "2024-02-20T11:31:13.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ",
"location": "On office",
"summary": "New event",
"organizer": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"status": "confirmed",
"id": "o6dt8kbedrmu15o53pgbrrv35o",
"etag": "\"3416857346088000\"",
"kind": "calendar#event"
},
]
```

86
docs/en/md/Google_Calendar/Event-management/Get-event.md Normal file
View File

@ -0,0 +1,86 @@
---
sidebar_position: 3
---
# Get event
Gets an event by ID
*Function GetEvent(Val Token, Val Calendar, Val Event) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID |
| Event | --event | String | Event ID |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.GetEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar GetEvent --token %token% --calendar %calendar% --event %event%
```
```json title="Result"
{
"eventType": "default",
"attachments": [
{
"iconLink": "",
"title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
},
{
"iconLink": "",
"title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
}
],
"reminders": {
"useDefault": true
},
"sequence": 0,
"start": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T15:16:25+03:00"
},
"creator": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"end": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T16:16:25+03:00"
},
"iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com",
"description": "TestEventDescription",
"updated": "2024-02-21T09:16:28.474Z",
"created": "2024-02-21T09:16:28.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ",
"location": "On office",
"summary": "New event",
"organizer": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"status": "confirmed",
"id": "j4nonfcc0m2mtop1vc8ivo8tb8",
"etag": "\"3417013976948000\"",
"kind": "calendar#event"
}
```

87
docs/en/md/Google_Calendar/Event-management/Move-event.md Normal file
View File

@ -0,0 +1,87 @@
---
sidebar_position: 5
---
# Move event
Moves an event to another calendar
*Function MoveEvent(Val Token, Val SourceCalendar, Val TargetCalendar, Val Event) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| SourceCalendar | --from | String | ID of the source calendar |
| TargetCalendar | --to | String | ID of the target calendar |
| Event | --event | String | ID of the source calendar event |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Response = OPI_GoogleCalendar.MoveEvent(Token, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gcalendar MoveEvent --token %token% --from %from% --to %to% --event %event%
```
```json title="Result"
{
"eventType": "default",
"attachments": [
{
"iconLink": "",
"title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
},
{
"iconLink": "",
"title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
}
],
"reminders": {
"useDefault": true
},
"sequence": 0,
"start": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T16:20:49+03:00"
},
"creator": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"end": {
"timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T17:20:49+03:00"
},
"iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com",
"description": "TestEventDescription",
"updated": "2024-02-24T10:20:51.234Z",
"created": "2024-02-24T10:20:49.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ",
"location": "InOffice",
"summary": "New event",
"organizer": {
"self": true,
"email": "bayselonarrend@gmail.com"
},
"status": "confirmed",
"id": "f9kkj2omsqtt67g12qh2jig8uk",
"etag": "\"3417540102468000\"",
"kind": "calendar#event"
}
```

4
docs/en/md/Google_Calendar/Event-management/_category_.json Normal file
View File

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

59
docs/en/md/Google_Drive/Comment-management/Create-comment.md Normal file
View File

@ -0,0 +1,59 @@
---
sidebar_position: 1
---
# Create comment
Creates a comment for a file or directory
*Function CreateComment(Val Token, Val Identifier, Val Comment) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --object | String | Identifier of the object that needs a comment |
| Comment | --text | String | Comment text |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Identifier = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
Comment = "NewComment";
Response = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive CreateComment --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text%
```
```json title="Result"
{
"content": "NewComment",
"htmlContent": "NewComment",
"author": {
"photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
},
"replies": [],
"modifiedTime": "2024-03-17T12:53:45.469Z",
"createdTime": "2024-03-17T12:53:45.469Z",
"kind": "drive#comment",
"deleted": false,
"id": "AAABI3NNNAY"
}
```

42
docs/en/md/Google_Drive/Comment-management/Delete-comment.md Normal file
View File

@ -0,0 +1,42 @@
---
sidebar_position: 4
---
# Delete comment
Deletes comment by ID
*Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| ObjectID | --object | String | Identifier of the file or directory where the comment is located |
| CommentID | --comment | String | Comment identifier |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.DeleteComment(Token, Identifier, Comment); //Map
```
```sh title="CLI command example"
oint gdrive DeleteComment --token %token% --object %object% --comment %comment%
```
```json title="Result"
''
```

62
docs/en/md/Google_Drive/Comment-management/Get-comment-list.md Normal file
View File

@ -0,0 +1,62 @@
---
sidebar_position: 3
---
# Get list of comments
Gets the list of all comments of the object
*Function GetCommentList(Val Token, Val ObjectID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| ObjectID | --object | String | Object identifier |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
Response = OPI_GoogleDrive.GetCommentList(Token, AndДFile); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive GetCommentList --token %token% --object %object%
```
```json title="Result"
{
"comments": [
{
"content": "NewComment",
"htmlContent": "NewComment",
"author": {
"photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
},
"replies": [],
"modifiedTime": "2024-03-17T12:53:45.469Z",
"createdTime": "2024-03-17T12:53:45.469Z",
"kind": "drive#comment",
"deleted": false,
"id": "AAABI3NNNAY"
}
],
"kind": "drive#commentList"
}
```

59
docs/en/md/Google_Drive/Comment-management/Get-comment.md Normal file
View File

@ -0,0 +1,59 @@
---
sidebar_position: 2
---
# Get comment
Gets comment by ID
*Function GetComment(Val Token, Val ObjectID, Val CommentID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| ObjectID | --object | String | Identifier of the file or directory where the comment is located |
| CommentID | --comment | String | Comment identifier |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
CommentID = AAABI3NNNAY;
Response = OPI_GoogleDrive.GetComment(Token, AndДFile, CommentID); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive GetComment --token %token% --object %object% --comment "AAABI3NNNAY"
```
```json title="Result"
{
"content": "NewComment",
"htmlContent": "NewComment",
"author": {
"photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
},
"replies": [],
"modifiedTime": "2024-03-17T12:53:45.469Z",
"createdTime": "2024-03-17T12:53:45.469Z",
"kind": "drive#comment",
"deleted": false,
"id": "AAABI3NNNAY"
}
```

4
docs/en/md/Google_Drive/Comment-management/_category_.json Normal file
View File

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

51
docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md Normal file
View File

@ -0,0 +1,51 @@
---
sidebar_position: 7
---
# Copy object
Copies file or directory
*Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --object | String | Object identifier |
| NewName | --title | String | New object name |
| NewParent | --catalog | String | New parent directory |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
NewName = "CopiedFile.jpeg";
NewLocation = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ";
Identifier = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk";
Response = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewLocation) //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive CopyObject --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "CopiedFile.jpeg" --catalog %catalog%
```
```json title="Result"
{
"mimeType": "image/jpeg",
"name": "CopiedFile.jpeg",
"id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy",
"kind": "drive#file"
}
```

48
docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md Normal file
View File

@ -0,0 +1,48 @@
---
sidebar_position: 5
---
# Create folder
Creates an empty directory on the drive
*Function CreateFolder(Val Token, Val Name, Val Parent = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Folder name |
| Parent | --catalog | String | Parent |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Name = "TestFolder";
Response = OPI_GoogleDrive.CreateFolder(Token, Name); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive CreateFolder --token %token% --title "TestFolder" --catalog %catalog%
```
```json title="Result"
{
"mimeType": "application/vnd.google-apps.folder",
"name": "TestFolder",
"id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc",
"kind": "drive#file"
}
```

41
docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md Normal file
View File

@ -0,0 +1,41 @@
---
sidebar_position: 9
---
# Delete object
Deletes file or directory by ID
*Function DeleteObject(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --object | String | Identifier of the object to delete |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.DeleteObject(Token, Identifier); //Map
```
```sh title="CLI command example"
oint gdrive DeleteObject --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"
```
```json title="Result"
''
```

43
docs/en/md/Google_Drive/File-and-directory-management/Download-file.md Normal file
View File

@ -0,0 +1,43 @@
---
sidebar_position: 6
---
# Download file
Gets file by ID
*Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --object | String | File identifier |
| SavePath | --out | String | File save path |
Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified
```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.DownloadFile(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive DownloadFile --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out%
```
```json title="Result"
```

147
docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md Normal file
View File

@ -0,0 +1,147 @@
---
sidebar_position: 2
---
# Get list of directories
Gets the list of drive directories
*Function GetDirectoriesList(Val Token, Val NameContains = "", Val Detailed = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| NameContains | --querry | String | Filter by name |
| Detailed | --depth | Boolean | Adds a list of files to the directory fields |
Returns: Key-Value Pair - Array of directory mappings
```bsl title="Code example"
Name = "Description";
Response = OPI_GoogleDrive.GetDirectoriesList(Token, Name, False); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive GetDirectoriesList --token %token% --querry %querry% --depth %depth%
```
```json title="Result"
[
{
"linkShareMetadata": {
"securityUpdateEnabled": true,
"securityUpdateEligible": false
},
"modifiedByMe": true,
"quotaBytesUsed": "0",
"viewedByMeTime": "2024-03-13T06:02:50.470Z",
"createdTime": "2024-03-13T06:02:50.470Z",
"permissionIds": [
"07468399490707249352"
],
"modifiedByMeTime": "2024-03-13T06:02:50.470Z",
"explicitlyTrashed": false,
"trashed": true,
"id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4",
"starred": false,
"name": "MovesDescription",
"permissions": [
{
"pendingOwner": false,
"role": "owner",
"emailAddress": "bayselonarrend@gmail.com",
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"kind": "drive#permission",
"type": "user",
"deleted": false,
"displayName": "Anton Titovets",
"id": "07468399490707249352"
}
],
"spaces": [
"drive"
],
"webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4",
"isAppAuthorized": false,
"owners": [
{
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
}
],
"version": "2",
"lastModifyingUser": {
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
},
"shared": false,
"hasThumbnail": false,
"parents": [
"1PAFI1-rThB46uix012xmLQ01h-JARjaz"
],
"ownedByMe": true,
"mimeType": "application/vnd.google-apps.folder",
"viewersCanCopyContent": true,
"iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder",
"viewedByMe": true,
"writersCanShare": true,
"folderColorRgb": "#8f8f8f",
"copyRequiresWriterPermission": false,
"capabilities": {
"canRemoveContentRestriction": false,
"canModifyOwnerContentRestriction": false,
"canModifyLabels": false,
"canAcceptOwnership": false,
"canChangeSecurityUpdateEnabled": false,
"canMoveItemWithinDrive": true,
"canRemoveMyDriveParent": true,
"canReadLabels": false,
"canAddMyDriveParent": false,
"canShare": true,
"canModifyContent": true,
"canUntrash": true,
"canMoveItemOutOfDrive": false,
"canMoveItemIntoTeamDrive": false,
"canModifyContentRestriction": false,
"canReadRevisions": false,
"canTrash": true,
"canRemoveChildren": true,
"canListChildren": true,
"canDownload": true,
"canDelete": true,
"canRename": true,
"canChangeCopyRequiresWriterPermission": false,
"canAddChildren": true,
"canComment": true,
"canModifyEditorContentRestriction": false,
"canMoveChildrenWithinDrive": true,
"canCopy": false,
"canChangeViewersCanCopyContent": false,
"canEdit": true
},
"modifiedTime": "2024-03-13T06:02:50.470Z",
"thumbnailVersion": "0",
"kind": "drive#file"
}
]
```

43
docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md Normal file
View File

@ -0,0 +1,43 @@
---
sidebar_position: 10
---
# Get description file
*Function GetFileDescription() Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
Returns: Key-Value Pair - File description
```bsl title="Code example"
Description = New Map;
Description.Insert("MIME", "image/jpeg"); // MIME-type uploading file
Description.Insert("Name", "New file.jpg"); // File name with extension
Description.Insert("Description", "This is a new file"); // File description
Description.Insert("Parent", "root"); // ID directory upload or "root" for upload in root
Return Description;
```
```sh title="CLI command example"
oint gdrive GetFileDescription
```
```json title="Result"
```

176
docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md Normal file
View File

@ -0,0 +1,176 @@
---
sidebar_position: 3
---
# Get list of files
Gets the list of files
*Function GetFilesList(Val Token, Val NameContains = "", Val Directory = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| NameContains | --querry | String | Filter by name |
| Directory | --catalog | String | Filter by parent directory ID |
Returns: Key-Value Pair - Array of file mappings
```bsl title="Code example"
Directory = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4";
Response = OPI_GoogleDrive.GetFilesList(Token,, Directory); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive GetFilesList --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"
```
```json title="Result"
[
{
"sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b",
"linkShareMetadata": {
"securityUpdateEnabled": true,
"securityUpdateEligible": false
},
"imageMediaMetadata": {
"exposureBias": 0,
"focalLength": 5.2,
"exposureTime": 0.00125,
"cameraMake": "SONY",
"isoSpeed": 100,
"time": "2012:08:03 08:21:50",
"width": 3264,
"cameraModel": "DSC-H7",
"whiteBalance": "Auto",
"colorSpace": "sRGB",
"aperture": 5.6,
"exposureMode": "Auto",
"rotation": 0,
"height": 2448,
"meteringMode": "Pattern",
"maxApertureValue": 2.875,
"flashUsed": true
},
"modifiedByMe": true,
"thumbnailVersion": "1",
"fullFileExtension": "jpg",
"quotaBytesUsed": "2114025",
"viewedByMeTime": "2024-03-17T08:09:01.753Z",
"permissionIds": [
"07468399490707249352"
],
"modifiedByMeTime": "2024-03-17T08:05:59.327Z",
"explicitlyTrashed": false,
"trashed": false,
"description": "This is a new file",
"createdTime": "2024-03-17T08:05:59.327Z",
"id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD",
"starred": false,
"spaces": [
"drive"
],
"name": "New file.jpg",
"permissions": [
{
"pendingOwner": false,
"role": "owner",
"emailAddress": "bayselonarrend@gmail.com",
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"kind": "drive#permission",
"type": "user",
"deleted": false,
"displayName": "Anton Titovets",
"id": "07468399490707249352"
}
],
"webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download",
"isAppAuthorized": true,
"webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk",
"version": "4",
"owners": [
{
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
}
],
"lastModifyingUser": {
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352",
"me": true,
"kind": "drive#user",
"displayName": "Anton Titovets"
},
"hasThumbnail": true,
"shared": false,
"ownedByMe": true,
"parents": [
"1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"
],
"sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2",
"viewedByMe": true,
"headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ",
"writersCanShare": true,
"thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220",
"modifiedTime": "2024-03-17T08:05:59.327Z",
"capabilities": {
"canRemoveContentRestriction": false,
"canModifyOwnerContentRestriction": true,
"canModifyLabels": false,
"canAcceptOwnership": false,
"canChangeSecurityUpdateEnabled": false,
"canMoveItemWithinDrive": true,
"canRemoveMyDriveParent": true,
"canReadLabels": false,
"canAddMyDriveParent": false,
"canShare": true,
"canModifyContent": true,
"canUntrash": true,
"canMoveItemOutOfDrive": true,
"canMoveItemIntoTeamDrive": true,
"canModifyContentRestriction": true,
"canReadRevisions": true,
"canTrash": true,
"canRemoveChildren": false,
"canListChildren": false,
"canDownload": true,
"canDelete": true,
"canRename": true,
"canChangeCopyRequiresWriterPermission": true,
"canAddChildren": false,
"canComment": true,
"canModifyEditorContentRestriction": true,
"canMoveChildrenWithinDrive": false,
"canCopy": true,
"canChangeViewersCanCopyContent": true,
"canEdit": true
},
"md5Checksum": "85b6518b95b58536480354d9d5fc3d8b",
"copyRequiresWriterPermission": false,
"fileExtension": "jpg",
"originalFilename": "New file.jpg",
"iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg",
"viewersCanCopyContent": true,
"mimeType": "image/jpeg",
"kind": "drive#file",
"size": "2114025"
}
]
```

145
docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md Normal file
View File

@ -0,0 +1,145 @@
---
sidebar_position: 1
---
# Get object information
Gets information about a folder or file by ID
*Function GetObjectInformation(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --object | String | Identifier of the file or folder |
Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //String
```
```sh title="CLI command example"
oint gdrive GetObjectInformation --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"
```
```json title="Result"
{
"linkShareMetadata": {
"securityUpdateEnabled": true,
"securityUpdateEligible": false
},
"quotaBytesUsed": "0",
"folderColorRgb": "#8f8f8f",
"writersCanShare": true,
"lastModifyingUser": {
"emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352",
"me": true,
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"displayName": "Anton Titovets",
"kind": "drive#user"
},
"modifiedByMe": true,
"capabilities": {
"canUntrash": true,
"canTrash": true,
"canRemoveMyDriveParent": true,
"canRemoveContentRestriction": false,
"canRemoveChildren": true,
"canMoveItemWithinDrive": true,
"canMoveItemOutOfDrive": true,
"canMoveItemIntoTeamDrive": true,
"canModifyLabels": false,
"canModifyOwnerContentRestriction": false,
"canReadRevisions": false,
"canModifyContentRestriction": false,
"canShare": true,
"canModifyContent": true,
"canDownload": true,
"canMoveChildrenWithinDrive": true,
"canCopy": false,
"canModifyEditorContentRestriction": false,
"canChangeSecurityUpdateEnabled": false,
"canRename": true,
"canChangeCopyRequiresWriterPermission": false,
"canDelete": true,
"canChangeViewersCanCopyContent": false,
"canEdit": true,
"canReadLabels": false,
"canAddMyDriveParent": false,
"canComment": true,
"canAddChildren": true,
"canListChildren": true,
"canAcceptOwnership": false
},
"copyRequiresWriterPermission": false,
"modifiedTime": "2023-12-28T13:22:03.333Z",
"createdTime": "2023-12-28T13:22:00.683Z",
"viewedByMeTime": "2023-12-28T13:22:00.683Z",
"viewedByMe": true,
"shared": false,
"hasThumbnail": false,
"version": "3",
"owners": [
{
"emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352",
"me": true,
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"displayName": "Anton Titovets",
"kind": "drive#user"
}
],
"isAppAuthorized": false,
"webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm",
"spaces": [
"drive"
],
"modifiedByMeTime": "2023-12-28T13:22:03.333Z",
"permissionIds": [
"07468399490707249352"
],
"explicitlyTrashed": false,
"parents": [
"1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"
],
"ownedByMe": true,
"trashed": false,
"iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder",
"viewersCanCopyContent": true,
"mimeType": "application/vnd.google-apps.folder",
"permissions": [
{
"pendingOwner": false,
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"role": "owner",
"emailAddress": "bayselonarrend@gmail.com",
"type": "user",
"deleted": false,
"displayName": "Anton Titovets",
"id": "07468399490707249352",
"kind": "drive#permission"
}
],
"name": "OPI",
"starred": false,
"id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa",
"kind": "drive#file",
"thumbnailVersion": "0"
}
```

Some files were not shown because too many files have changed in this diff Show More