1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-28 09:08:38 +02:00

Обновление workflow для автодокументации

This commit is contained in:
Anton Titovets 2024-05-28 10:37:56 +03:00
parent a569e5b67c
commit 4383243b10
333 changed files with 10129 additions and 12 deletions

View File

@ -15,8 +15,8 @@
Расположение = ".\OInt";
СПодкаталогами = Истина;
КаталогДокументации = ".\docs";
КаталогЛогов = ".\test_logs\";
КаталогДокументации = ".\docs\md";
КаталогЛогов = ".\docs\results\";
СписокОбластей = Новый СписокЗначений();
ТекущаяОбласть = "";
СчетчикОбласти = 0;

View File

@ -121,14 +121,6 @@
КонецЦикла;
ТекущийДокумент.ДобавитьСтроку("
|
| - name: Записать логи
| uses: actions/upload-artifact@v4
| with:
| name: " + Раздел + "
| path: ./test_logs");
КонецПроцедуры
Процедура СообщитьНачалоФайлаПроцесса(Знач ИмяРаботы = "Полное тестирование")

1
.gitignore vendored
View File

@ -7,6 +7,5 @@ OInt/coverage/stat.json
data.json
*.exe
test.os
/docs
/test_logs
Поток

View File

@ -429,7 +429,7 @@
Попытка
ПутьЛогов = "./test_logs";
ПутьЛогов = "./docs/results";
КаталогЛогов = Новый Файл(ПутьЛогов);
Если Не КаталогЛогов.Существует() Тогда

View File

@ -0,0 +1,186 @@
---
sidebar_position: 1
---
# Получить список баз
Получает список доступных баз
*Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Отступ | --offser | Строка | Идентификатор следующей страницы списка баз из перыдудщего запроса |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьСписокБаз(Токен, Отступ); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьСписокБаз --token %token% --offser %offser%
```
```json title="Результат"
{
"bases": [
{
"id": "appGarzKZ0lu3gzoa",
"name": "Test",
"permissionLevel": "create"
},
{
"id": "app2kzmhwzbUvKHLP",
"name": "Test base",
"permissionLevel": "create"
},
{
"id": "app9WRfJirwn3yXuG",
"name": "Product catalog",
"permissionLevel": "create"
},
{
"id": "appAWuS4kQyzePBub",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "apptQFtDdfViN9aLE",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appvBVaSkxn7oGYie",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appnTO6yFTDbhBUx7",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appWeUAzdXS0CuR9h",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "app9HF38vD9gTMol4",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "app2J9tECjhmUgMbE",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appxcBEzMXAcji4cu",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appxmPVa3V6JKgEOR",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appkAuXy6BLr6zaiZ",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appWZhpTTVL3OCjSg",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appuRFlghrHUJ8X37",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appEqto2nFyF2h9pO",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "app4kxM2OQy7vumJo",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appw4Qs1acLKlQZ4z",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appTWeuSzMSwCoPwm",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "app9BeBl4qHOEc7Pb",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appwyKpw2MMJMU7xN",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appy3ONWZ6r6YiPuF",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appzh34EQ6dRkWHT6",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appr7gAHFMDyuyZcc",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appCIrs9NWI8UIHxM",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appLZ1QtmLBBy0v6o",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appLU0Oq8fc0i4x8F",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "app4Gd8QknEuCqC8D",
"name": "Тестовая база",
"permissionLevel": "create"
},
{
"id": "appU4BYEPcrG5FlqP",
"name": "Тестовая база",
"permissionLevel": "create"
}
]
}
```

View File

@ -0,0 +1,68 @@
---
sidebar_position: 2
---
# Получить таблицы базы
Получает схему таблиц базы
*Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьТаблицыБазы(Токен, База); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьТаблицыБазы --token %token% --base %base%
```
```json title="Результат"
{
"tables": [
{
"id": "tblEQ96elYhCbE3Jj",
"name": "Тестовая таблица",
"primaryFieldId": "fld2mb9dHV1Jt9lXi",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fld2mb9dHV1Jt9lXi",
"name": "Номер"
},
{
"type": "richText",
"id": "fldICvkOjAYaNQNiG",
"name": "Строковое"
}
],
"views": [
{
"id": "viwBWVJCK7ndNEYsL",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```

View File

@ -0,0 +1,71 @@
---
sidebar_position: 3
---
# Создать базу
Создает новую базу данных
*Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| РабочееПространство | --ws | Строка | Идентификатор рабочего пространства |
| Наименование | --title | Строка | Наименование новой базы |
| КоллекцияТаблиц | --tablesdata | Соответствие Из КлючИЗначение | Описание таблиц: Ключ > имя, Значение > массив полей |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.СоздатьБазу(Токен, РабочееПространство, Наименование, КоллекцияТаблиц); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable СоздатьБазу --token %token% --ws %ws% --title %title% --tablesdata %tablesdata%
```
```json title="Результат"
{
"id": "appU4BYEPcrG5FlqP",
"tables": [
{
"id": "tblEQ96elYhCbE3Jj",
"name": "Тестовая таблица",
"primaryFieldId": "fld2mb9dHV1Jt9lXi",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fld2mb9dHV1Jt9lXi",
"name": "Номер"
},
{
"type": "richText",
"id": "fldICvkOjAYaNQNiG",
"name": "Строковое"
}
],
"views": [
{
"id": "viwBWVJCK7ndNEYsL",
"name": "Grid view",
"type": "grid"
}
]
}
]
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с базами",
"position": ""
}

View File

@ -0,0 +1,52 @@
---
sidebar_position: 3
---
# Изменить комментарий
Изменяет текст существующего комментария
*Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Запись | --record | Строка | Идентификатор записи в таблице |
| Комментарий | --comment | Строка | Идентификатор комментария |
| Текст | --text | Строка | Новый текст комментария |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ИзменитьКомментарий(Токен, База, Таблица, Запись, Комментарий, Текст); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ИзменитьКомментарий --token %token% --base %base% --table %table% --record %record% --comment %comment% --text %text%
```
```json title="Результат"
{
"id": "comiwisbXU2Lt9gba",
"author": {
"id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com",
"name": "Антон Титовец"
},
"text": "Тестовый комментарий (изм.)",
"createdTime": "2024-05-10T07:40:16Z",
"lastUpdatedTime": "2024-05-10T07:40:16.453Z"
}
```

View File

@ -0,0 +1,56 @@
---
sidebar_position: 1
---
# Получить комментарии
Получает список комментариев к записи в таблице
*Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Запись | --record | Строка | Идентификатор записи в таблице |
| Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьКомментарии(Токен, База, Таблица, Запись, Отступ); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьКомментарии --token %token% --base %base% --table %table% --record %record% --offset %offset%
```
```json title="Результат"
{
"comments": [
{
"id": "comiwisbXU2Lt9gba",
"author": {
"id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com",
"name": "Антон Титовец"
},
"text": "Тестовый комментарий (изм.)",
"createdTime": "2024-05-10T07:40:16Z",
"lastUpdatedTime": "2024-05-10T07:40:16Z"
}
],
"offset": null
}
```

View File

@ -0,0 +1,51 @@
---
sidebar_position: 2
---
# Создать комментарий
Создает комментарий к записи в таблице
*Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Запись | --record | Строка | Идентификатор записи в таблице |
| Текст | --text | Строка | Текст комментария |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.СоздатьКомментарий(Токен, База, Таблица, Запись, Текст); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable СоздатьКомментарий --token %token% --base %base% --table %table% --record %record% --text %text%
```
```json title="Результат"
{
"id": "comiwisbXU2Lt9gba",
"author": {
"id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com",
"name": "Антон Титовец"
},
"text": "Тестовый комментарий",
"createdTime": "2024-05-10T07:40:16.217Z",
"lastUpdatedTime": null
}
```

View File

@ -0,0 +1,44 @@
---
sidebar_position: 4
---
# Удалить комментарий
Удаляет комментарий к записи таблицы
*Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Запись | --record | Строка | Идентификатор записи в таблице |
| Комментарий | --comment | Строка | Идентификатор комментария |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.УдалитьКомментарий(Токен, База, Таблица, Запись, Комментарий); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable УдалитьКомментарий --token %token% --base %base% --table %table% --record %record% --comment %comment%
```
```json title="Результат"
{
"id": "comiwisbXU2Lt9gba",
"deleted": true
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с комментариями",
"position": ""
}

View File

@ -0,0 +1,50 @@
---
sidebar_position: 2
---
# Изменить поле
Изменяет имя и|или описание существующего поля таблицы
*Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы База |
| Таблица | --table | Строка | Идентификатор таблицы |
| Поле | --field | Строка | Идентификатор поля |
| Наименование | --title | Строка | Новое наименование |
| Описание | --description | Строка | Новое описание |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ИзменитьПоле(Токен, База, Таблица, Поле, Наименование, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ИзменитьПоле --token %token% --base %base% --table %table% --field %field% --title %title% --description %description%
```
```json title="Результат"
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldATgAyNWXezWLsM",
"name": "277c693b-d2da-4f40-8d83-f5f64c49f150(изм.)",
"description": "Новое описание"
}
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 4
---
# Получить поле (числовое)
Получает описание поля числового типа
*Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Наименование | --title | Строка | Наименование нового поля |
| Точность | --precision | Число,Строка | Число знаков после запятой |
Вовзращаемое значение: Структура - Описание поля
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьПолеНомера(Наименование, Точность); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьПолеНомера --title %title% --precision %precision%
```
```json title="Результат"
```

View File

@ -0,0 +1,37 @@
---
sidebar_position: 3
---
# Получить поле (строковое)
Получает описание поля строкового типа
*Функция ПолучитьПолеСтроковое(Знач Наименование) ЭкспортВозврат ОписаниеПримитивногоПоля(Наименование, "richText");КонецФункции*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Наименование | --title | Строка | Наименование нового поля |
Вовзращаемое значение: Структура - Описание поля
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьПолеСтроковое(Наименование); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьПолеСтроковое --title %title%
```
```json title="Результат"
```

View File

@ -0,0 +1,47 @@
---
sidebar_position: 1
---
# Создать поле
Создет новое поле в таблице
*Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы |
| Таблица | --table | Строка | Идентификатор таблицы |
| СтруктураПоля | --fielddata | Структура Из КлючИЗначение | Описание нового поля |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, СтруктураПоля); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable СоздатьПоле --token %token% --base %base% --table %table% --fielddata %fielddata%
```
```json title="Результат"
{
"type": "number",
"options": {
"precision": 0
},
"id": "fldATgAyNWXezWLsM",
"name": "277c693b-d2da-4f40-8d83-f5f64c49f150"
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с полями",
"position": ""
}

View File

@ -0,0 +1,68 @@
---
sidebar_position: 2
---
# Изменить таблицу
Изменяет наименование и|или описание базы
*Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы |
| Таблица | --table | Строка | Идентификатор таблицы |
| Наименование | --title | Строка | Новое наименование |
| Описание | --description | Строка | Новое описание |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ИзменитьТаблицу(Токен, База, Таблица, Наименование, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ИзменитьТаблицу --token %token% --base %base% --table %table% --title %title% --description %description%
```
```json title="Результат"
{
"id": "tblGCTowGBin5S8Xp",
"name": "Тестовая таблица 2 (изм.)",
"description": "Новая таблица (изм.)",
"primaryFieldId": "fld57VBxeJ0Kz1oHT",
"fields": [
{
"id": "fld57VBxeJ0Kz1oHT",
"name": "Номер",
"type": "number",
"options": {
"precision": 0
}
},
{
"id": "fldF3JiY6kD55VD5L",
"name": "Строковое",
"type": "richText"
}
],
"views": [
{
"id": "viw1RYgETyIB8zVIR",
"name": "Grid view",
"type": "grid"
}
]
}
```

View File

@ -0,0 +1,68 @@
---
sidebar_position: 1
---
# Создать таблицу
Создает новую таблицу в базе
*Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы |
| Наименование | --title | Строка | Наименование новой таблицы |
| МассивПолей | --fieldsdata | Массив Из Структура | Массив описаний полей |
| Описание | --description | Строка | Описание таблицы |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable СоздатьТаблицу --token %token% --base %base% --title %title% --fieldsdata %fieldsdata% --description %description%
```
```json title="Результат"
{
"id": "tblGCTowGBin5S8Xp",
"name": "Тестовая таблица 2",
"description": "Новая таблица",
"primaryFieldId": "fld57VBxeJ0Kz1oHT",
"fields": [
{
"type": "number",
"options": {
"precision": 0
},
"id": "fld57VBxeJ0Kz1oHT",
"name": "Номер"
},
{
"type": "richText",
"id": "fldF3JiY6kD55VD5L",
"name": "Строковое"
}
],
"views": [
{
"id": "viw1RYgETyIB8zVIR",
"name": "Grid view",
"type": "grid"
}
]
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с таблицами",
"position": ""
}

View File

@ -0,0 +1,67 @@
---
sidebar_position: 1
---
# Получить список записей
Получает список записей выбранной таблицы
*Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Отступ | --offset | Строка | Иднтификатор следующей страницы данных из предыдущего запроса |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица, Отступ); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьСписокЗаписей --token %token% --base %base% --table %table% --offset %offset%
```
```json title="Результат"
{
"records": [
{
"id": "recAB3eJVv3olssFr",
"createdTime": "2024-05-10T07:40:16Z",
"fields": {
"Номер": 10,
"Строковое": "Привет\n"
}
},
{
"id": "reckISGAjm3i2mVDb",
"createdTime": "2024-05-10T07:40:16Z",
"fields": {
"Номер": 10,
"Строковое": "Привет\n"
}
},
{
"id": "recqjJmZO5v8LyMiM",
"createdTime": "2024-05-10T07:40:16Z",
"fields": {
"Номер": 10,
"Строковое": "Привет\n"
}
}
]
}
```

View File

@ -0,0 +1,47 @@
---
sidebar_position: 2
---
# Получить запись
Получает данные строки таблицы по идентификатору
*Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Запись | --record | Строка | Идентификатор записи в таблице |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.ПолучитьЗапись(Токен, База, Таблица, Запись); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable ПолучитьЗапись --token %token% --base %base% --table %table% --record %record%
```
```json title="Результат"
{
"id": "recqjJmZO5v8LyMiM",
"createdTime": "2024-05-10T07:40:16Z",
"fields": {
"Номер": 10,
"Строковое": "Привет\n"
}
}
```

View File

@ -0,0 +1,59 @@
---
sidebar_position: 3
---
# Создать записи
Создает одну или массив записей по описанию или массиву описаний значений полей
*Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Данные | --data | Структура, Массив из Структура | Набор или массив наборов пар Ключ : Значение > Поле : Показатель |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, Данные); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable СоздатьЗаписи --token %token% --base %base% --table %table% --data %data%
```
```json title="Результат"
{
"records": [
{
"id": "recAB3eJVv3olssFr",
"createdTime": "2024-05-10T07:40:16Z",
"fields": {
"Номер": 10,
"Строковое": "Привет\n"
}
},
{
"id": "reckISGAjm3i2mVDb",
"createdTime": "2024-05-10T07:40:16Z",
"fields": {
"Номер": 10,
"Строковое": "Привет\n"
}
}
]
}
```

View File

@ -0,0 +1,51 @@
---
sidebar_position: 4
---
# Удалить записи
Удаляет одну или массив записей по идентификаторам
*Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | Идентификатор базы данных |
| Таблица | --table | Строка | Идентификатор таблицы |
| Записи | --records | Строка, Массив из Строка | Идентификатор или массив индентификаторов записей |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable
```bsl title="Пример кода"
Ответ = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Записи); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint Airtable УдалитьЗаписи --token %token% --base %base% --table %table% --records %records%
```
```json title="Результат"
{
"records": [
{
"deleted": true,
"id": "recAB3eJVv3olssFr"
},
{
"deleted": true,
"id": "reckISGAjm3i2mVDb"
}
]
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с записями",
"position": ""
}

View File

@ -0,0 +1,40 @@
---
sidebar_position: 3
---
# Изменить календарь
Изменяет свойства существуещего календаря
*Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
| Наименование | --title | Строка | Новое наименование |
| Описание | --description | Строка | Новое описание календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ИзменитьМетаданныеКалендаря(Токен, Календарь, Наименование, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ИзменитьМетаданныеКалендаря --token %token% --calendar %calendar% --title %title% --description %description%
```
```json title="Результат"
```

View File

@ -0,0 +1,37 @@
---
sidebar_position: 4
---
# Очистить основной календарь
Очищает список событий основного календаря
*Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ОчиститьОсновнойКалендарь(Токен); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ОчиститьОсновнойКалендарь --token %token%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 2
---
# Получить календарь
Получает информацию о календаре по ID
*Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьМетаданныеКалендаря(Токен, Календарь); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПолучитьМетаданныеКалендаря --token %token% --calendar %calendar%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 1
---
# Создать календарь
Создает пустой календарь
*Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Наименование | --title | Строка | Наименование создаваемого календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.СоздатьКалендарь(Токен, Наименование); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar СоздатьКалендарь --token %token% --title %title%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 5
---
# Удалить календарь
Удаляет календарь по ID
*Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.УдалитьКалендарь(Токен, Календарь); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar УдалитьКалендарь --token %token% --calendar %calendar%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с метаданными календарей",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Работа с метаданными календарей",
"position": ""
}

View File

@ -0,0 +1,40 @@
---
sidebar_position: 6
---
# Изменить событие
Изменяет существующее событие
*Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия, Событие);КонецФункции*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
| ОписаниеСобытия | --props | Строка | Новое описание события |
| Событие | --event | Строка | ID события |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ИзменитьСобытие(Токен, Календарь, ОписаниеСобытия, Событие); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ИзменитьСобытие --token %token% --calendar %calendar% --props %props% --event %event%
```
```json title="Результат"
```

View File

@ -0,0 +1,40 @@
---
sidebar_position: 5
---
# Переместить событие
Перемещает событие в другой календарь
*Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| КалендарьИсточник | --from | Строка | ID календаря источника |
| КалендарьПриемник | --to | Строка | ID календаря приемника |
| Событие | --event | Строка | ID события календаря источника |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПереместитьСобытие(Токен, КалендарьИсточник, КалендарьПриемник, Событие); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПереместитьСобытие --token %token% --from %from% --to %to% --event %event%
```
```json title="Результат"
```

View File

@ -0,0 +1,35 @@
---
sidebar_position: 1
---
# Получить описание события !NOCLI
*Функция ПолучитьОписаниеСобытия() Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
Вовзращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьОписаниеСобыти); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar
```
```json title="Результат"
```

View File

@ -0,0 +1,36 @@
---
sidebar_position: 1
---
# Получить описание события
*Функция ПолучитьОписаниеСобытия() Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
Вовзращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьОписаниеСобыти); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПолучитьОписаниеСобытия
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 3
---
# Получить событие
Получает событие по ID
*Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
| Событие | --event | Строка | ID события |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьСобытие(Токен, Календарь, Событие); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПолучитьСобытие --token %token% --calendar %calendar% --event %event%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 2
---
# Получить список событий
Получает список всех событий календаря
*Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьСписокСобытий(Токен, Календарь); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПолучитьСписокСобытий --token %token% --calendar %calendar%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 4
---
# Создать событие
Создает новое событие
*Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) ЭкспортВозврат УправлениеСобытием(Токен, Календарь, ОписаниеСобытия);КонецФункции*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
| ОписаниеСобытия | --props | Соответствие Из КлючИЗначение | Описание события |
Вовзращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.СоздатьСобытие(Токен, Календарь, ОписаниеСобытия); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar СоздатьСобытие --token %token% --calendar %calendar% --props %props%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 7
---
# Удалить событие
Удаляет событие по ID
*Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
| Событие | --event | Строка | ID события |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.УдалитьСобытие(Токен, Календарь, Событие); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar УдалитьСобытие --token %token% --calendar %calendar% --event %event%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с событиями",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Работа с событиями",
"position": ""
}

View File

@ -0,0 +1,38 @@
---
sidebar_position: 2
---
# Добавить календарь в список
Добавляет существующий календарь в список пользователя
*Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ДобавитьКалендарьВСписок(Токен, Календарь); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ДобавитьКалендарьВСписок --token %token% --calendar %calendar%
```
```json title="Результат"
```

View File

@ -0,0 +1,41 @@
---
sidebar_position: 5
---
# Изменить календарь списка
Изменяет свойства календаря из списка пользователей
*Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
| ОсновнойЦвет | --primary | Строка | HEX основного цвета (#ffffff) |
| ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (#ffffff) |
| Скрытый | --hidden | Булево | Скрытый календарь |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ИзменитьКалендарьСписка(Токен, Календарь, ОсновнойЦвет, ДополнительныйЦвет, Скрытый); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ИзменитьКалендарьСписка --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 3
---
# Получить календарь списка
Получает календарь из списка пользователя по ID
*Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьКалендарьСписка(Токен, Календарь); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПолучитьКалендарьСписка --token %token% --calendar %calendar%
```
```json title="Результат"
```

View File

@ -0,0 +1,37 @@
---
sidebar_position: 1
---
# Получить список календарей
Получает массив календарей аккаунта
*Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.ПолучитьСписокКалендарей(Токен); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar ПолучитьСписокКалендарей --token %token%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 4
---
# Удалить календарь из списка
Удаляет календарь из списка пользователя
*Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleCalendar.УдалитьКалендарьИзСписка(Токен, Календарь); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gcalendar УдалитьКалендарьИзСписка --token %token% --calendar %calendar%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа со списком календарей",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Работа со списком календарей",
"position": ""
}

View File

@ -0,0 +1,40 @@
---
sidebar_position: 8
---
# Обновить файл
Обновляет двоичные данные файла
*Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --object | Строка | Идентификатор обновляемого объекта |
| Файл | --file | ДвоичныеДанные,Строка | Файл источник обновления |
| НовоеИмя | --title | Строка | Новое имя файла (если необходимо) |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ОбновитьФайл(Токен, Идентификатор, Файл, НовоеИмя); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ОбновитьФайл --token %token% --object %object% --file %file% --title %title%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 1
---
# Получить информацию об объекте
Получает информацию о папке или файле по ID
*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --object | Строка | Идентификатор файла или каталога |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьИнформациюОбОбъекте(Токен, Идентификатор); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ПолучитьИнформациюОбОбъекте --token %token% --object %object%
```
```json title="Результат"
```

View File

@ -0,0 +1,35 @@
---
sidebar_position: 10
---
# Получить описание файла !NOCLI
*Функция ПолучитьОписаниеФайла() Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
Вовзращаемое значение: Соответствие Из КлючИЗначение - Описание файла
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьОписаниеФайл); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка
```
```sh title="Пример команд CLI"
oint gdrive
```
```json title="Результат"
```

View File

@ -0,0 +1,36 @@
---
sidebar_position: 10
---
# Получить описание файла
*Функция ПолучитьОписаниеФайла() Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
Вовзращаемое значение: Соответствие Из КлючИЗначение - Описание файла
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьОписаниеФайл); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ПолучитьОписаниеФайла
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 3
---
# Получить список файлов
Получает список файлов
*Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИмяСодержит | --querry | Строка | Отбор по имени |
| Каталог | --catalog | Строка | Отбор по ID каталога родителя |
Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьСписокФайлов(Токен, ИмяСодержит, Каталог); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ПолучитьСписокФайлов --token %token% --querry %querry% --catalog %catalog%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 2
---
# Получить список каталогов
Получает список каталогов диска
*Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИмяСодержит | --querry | Строка | Отбор по имени |
| Подробно | --depth | Булево | Добавляет список файлов к полям каталога |
Вовзращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьСписокКаталогов(Токен, ИмяСодержит, Подробно); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ПолучитьСписокКаталогов --token %token% --querry %querry% --depth %depth%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 6
---
# Скачать файл
Получает файл по ID
*Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --object | Строка | Идентификатор файла |
| ПутьСохранения | --out | Строка | Путь сохранения файла |
Вовзращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.СкачатьФайл(Токен, Идентификатор, ПутьСохранения); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive СкачатьФайл --token %token% --object %object% --out %out%
```
```json title="Результат"
```

View File

@ -0,0 +1,40 @@
---
sidebar_position: 7
---
# Скоприровать объект
Копирует файл или каталог
*Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --object | Строка | Идентификатор объекта |
| НовоеИмя | --title | Строка | Новое имя объекта |
| НовыйРодитель | --catalog | Строка | Новый каталог размещения |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.СкопироватьОбъект(Токен, Идентификатор, НовоеИмя, НовыйРодитель); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive СкопироватьОбъект --token %token% --object %object% --title %title% --catalog %catalog%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 5
---
# Создать папку
Создает пустой каталог на диске
*Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Имя | --title | Строка | Имя папки |
| Родитель | --catalog | Строка | Родитель |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.СоздатьПапку(Токен, Имя, Родитель); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive СоздатьПапку --token %token% --title %title% --catalog %catalog%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 9
---
# Удалить объект
Удаляет файл или каталог по ID
*Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --object | Строка | Идентификатор объекта для удаления |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.УдалитьОбъект(Токен, Идентификатор); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive УдалитьОбъект --token %token% --object %object%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 4
---
# Загрузить файл
Загружает файл на диск
*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) ЭкспортВозврат УправлениеФайлом(Токен, Файл, Описание);КонецФункции*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Файл | --file | ДвоичныеДанные,Строка | Загружаемый файл |
| Описание | --props | Соответствие Из КлючИЗначение | JSON описания или путь к .json |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Файл, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ЗагрузитьФайл --token %token% --file %file% --props %props%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с файлами и каталогами",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Работа с файлами и каталогами",
"position": ""
}

View File

@ -0,0 +1,39 @@
---
sidebar_position: 2
---
# Получить комментарий
Получает комментарий по ID
*Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария |
| ИДКомментария | --comment | Строка | Идентификатор комментария |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьКомментарий(Токен, ИДОбъекта, ИДКомментария); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ПолучитьКомментарий --token %token% --object %object% --comment %comment%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 3
---
# Получить список комментариев
Получает список всех комментариев объекта
*Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДОбъекта | --object | Строка | Идентификатор объекта |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, ИДОбъекта); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive ПолучитьСписокКомментариев --token %token% --object %object%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 1
---
# Создать комментарий
Создает комментарий к файлу или каталогу
*Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --object | Строка | Идентификатор объекта, для которого необходим комментарий |
| Комментарий | --text | Строка | Текст комментария |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive СоздатьКомментарий --token %token% --object %object% --text %text%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 4
---
# Удалить комментарий
Удаляет комментарий по ID
*Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДОбъекта | --object | Строка | Идентификатор файла или каталога размещения комментария |
| ИДКомментария | --comment | Строка | Идентификатор комментария |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleDrive.УдалитьКомментарий(Токен, ИДОбъекта, ИДКомментария); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gdrive УдалитьКомментарий --token %token% --object %object% --comment %comment%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с комментариями",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Работа с комментариями",
"position": ""
}

View File

@ -0,0 +1,40 @@
---
sidebar_position: 2
---
# Очистить ячейки
Очищает значение в ячейках
*Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Книга | --spreadsheet | Строка | ID книги |
| МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для очистки |
| Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.ОчиститьЯчейки(Токен, Книга, МассивЯчеек, Лист); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets ОчиститьЯчейки --token %token% --spreadsheet %spreadsheet% --cells %cells% --sheetname %sheetname%
```
```json title="Результат"
```

View File

@ -0,0 +1,40 @@
---
sidebar_position: 3
---
# Получить значения ячеек
Получает значения ячеек таблицы
*Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Книга | --spreadsheet | Строка | ID книги |
| МассивЯчеек | --cells | Массив из Строка | Массив ячеек вида А1 для получения (весь лист, если не заполнено) |
| Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.ПолучитьЗначенияЯчеек(Токен, Книга, МассивЯчеек, Лист); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets ПолучитьЗначенияЯчеек --token %token% --spreadsheet %spreadsheet% --cells %cells% --sheetname %sheetname%
```
```json title="Результат"
```

View File

@ -0,0 +1,41 @@
---
sidebar_position: 1
---
# Установить значения ячеек
Устанавливает значения ячеек листа
*Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Книга | --spreadsheet | Строка | ID книги |
| СоответствиеЗначений | --data | Соответствие Из КлючИЗначение | Данные заполнения, где ключ это имя ячейки вида A1 |
| Лист | --sheetname | Строка | Имя листа (первый лист по умолчанию) |
| ОсновноеИзмерение | --dim | Строка | Основное измерение при заполнении диапазона массивом |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.УстановитьЗначенияЯчеек(Токен, Книга, СоответствиеЗначений, Лист, ОсновноеИзмерение); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets УстановитьЗначенияЯчеек --token %token% --spreadsheet %spreadsheet% --data %data% --sheetname %sheetname% --dim %dim%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с данными",
"position": ""
}

View File

@ -0,0 +1,39 @@
---
sidebar_position: 3
---
# Изменить наименование книги
Изменяет наименование существующей книги
*Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Книга | --spreadsheet | Строка | ID книги |
| Наименование | --title | Строка | Новое наименование |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.ИзменитьНаименованиеКниги(Токен, Книга, Наименование); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets ИзменитьНаименованиеКниги --token %token% --spreadsheet %spreadsheet% --title %title%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 2
---
# Получить книгу
Получает информацию о книге по ID
*Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Идентификатор | --spreadsheet | Строка | Идентификатор книги |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.ПолучитьКнигу(Токен, Идентификатор); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets ПолучитьКнигу --token %token% --spreadsheet %spreadsheet%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 1
---
# Создать книгу
Создает новую книгу
*Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Наименование | --title | Строка | Наименование |
| МассивИменЛистов | --sheets | Массив из Строка | Массив имен для добавления новых листов в книгу |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.СоздатьКнигу(Токен, Наименование, МассивИменЛистов); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets СоздатьКнигу --token %token% --title %title% --sheets %sheets%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с книгами",
"position": ""
}

View File

@ -0,0 +1,39 @@
---
sidebar_position: 1
---
# Добавить лист
Добавляет новый лист в книгу
*Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Книга | --spreadsheet | Строка | Идентификатор книги |
| Наименование | --title | Строка | Наименование нового листа |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.ДобавитьЛист(Токен, Книга, Наименование); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets ДобавитьЛист --token %token% --spreadsheet %spreadsheet% --title %title%
```
```json title="Результат"
```

View File

@ -0,0 +1,40 @@
---
sidebar_position: 3
---
# Копировать лист
Копирует лист из одной книги в другую
*Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Откуда | --from | Строка | ID книги источника |
| Куда | --to | Строка | ID книги приемника |
| Лист | --sheet | Строка | ID копируемого листа |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.КопироватьЛист(Токен, Откуда, Куда, Лист); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets КопироватьЛист --token %token% --from %from% --to %to% --sheet %sheet%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 2
---
# Удалить лист
Удаляет лист из книги
*Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Книга | --spreadsheet | Строка | Идентификатор книги |
| Лист | --sheet | Строка | Идентификатор удаляемого листа |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleSheets.УдалитьЛист(Токен, Книга, Лист); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint gsheets УдалитьЛист --token %token% --spreadsheet %spreadsheet% --sheet %sheet%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с листами",
"position": ""
}

View File

@ -0,0 +1,39 @@
---
sidebar_position: 3
---
# Обновить токен
Обновляет токен по Refresh token
*Функция ОбновитьТокен(Знач ClientID, Знач ClientSecret, Знач RefreshToken) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| ClientID | --id | Строка | Client ID |
| ClientSecret | --secret | Строка | Client secret |
| RefreshToken | --refresh | Строка | Refresh token |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleWorkspace.ОбновитьТокен(ClientID, ClientSecret, RefreshToken); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %id% --secret %secret% --refresh %refresh%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 2
---
# Получить токен по коду
Получает токен по коду из авторизации в бразуере
*Функция ПолучитьТокенПоКоду(Знач ClientID, Знач ClientSecret, Знач Code) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| ClientID | --id | Строка | Client ID |
| ClientSecret | --secret | Строка | Client secret |
| Code | --code | Строка | Code из браузера |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google
```bsl title="Пример кода"
Ответ = OPI_GoogleWorkspace.ПолучитьТокенПоКоду(ClientID, ClientSecret, Code); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint google ПолучитьТокенПоКоду --id %id% --secret %secret% --code %code%
```
```json title="Результат"
```

View File

@ -0,0 +1,40 @@
---
sidebar_position: 1
---
# Сформировать ссылку получения кода
Возвращает URL для авторизации в браузере
*Функция СформироватьСсылкуПолученияКода(Знач ClientID, Знач Calendar = Истина, Знач Drive = Истина, Знач Sheets = Истина) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| ClientID | --id | Строка | Client ID |
| Calendar | --calendar | Булево | разрешение на методы Calendar |
| Drive | --drive | Булево | разрешение на методы Drive |
| Sheets | --sheets | Булево | разрешение на методы Sheets |
Вовзращаемое значение: Строка - Ссылка получения кода
```bsl title="Пример кода"
Ответ = OPI_GoogleWorkspace.СформироватьСсылкуПолученияКода(ClientID, Calendar, Drive, Sheets); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint google СформироватьСсылкуПолученияКода --id %id% --calendar %calendar% --drive %drive% --sheets %sheets%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Программный интерфейс",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Программный интерфейс",
"position": ""
}

View File

@ -0,0 +1,38 @@
---
sidebar_position: 2
---
# Получить данные пользователя
Получает данные пользователя по ID
*Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДПользователя | --user | Строка | ID целевого пользователя |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.ПолучитьДанныеПользователя(Токен, ИДПользователя); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion ПолучитьДанныеПользователя --token %token% --user %user%
```
```json title="Результат"
```

View File

@ -0,0 +1,37 @@
---
sidebar_position: 1
---
# Список пользователей
Возвращает список пользователей рабочего пространства
*Функция СписокПользователей(Знач Токен) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.СписокПользователей(Токен); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion СписокПользователей --token %token%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Пользователи",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Пользователи",
"position": ""
}

View File

@ -0,0 +1,41 @@
---
sidebar_position: 3
---
# Изменить свойства базы
Изменяет свойства существующей базы
*Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | ID целевой базы |
| Свойства | --props | Соответствие из КлючИЗначение | Новые или изменяемые свойства базы данных |
| Заголовок | --title | Строка | Новый заголовок базы |
| Описание | --description | Строка | Новое описание базы |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.ИзменитьСвойстваБазы(Токен, База, Свойства, Заголовок, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion ИзменитьСвойстваБазы --token %token% --base %base% --props %props% --title %title% --description %description%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 2
---
# Получить базу данных
Получить данные о базе данных
*Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| База | --base | Строка | ID базы данных |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.ПолучитьБазуДанных(Токен, База); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion ПолучитьБазуДанных --token %token% --base %base%
```
```json title="Результат"
```

View File

@ -0,0 +1,40 @@
---
sidebar_position: 1
---
# Создать базу данных
Создает базу данных
*Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Родитель | --page | Строка | ID страницы родителя |
| Заголовок | --title | Строка | Заголовок базы данных |
| Свойства | --props | Структура Из Строка | Свойства базы данных |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.СоздатьБазуДанных(Токен, Родитель, Заголовок, Свойства); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion СоздатьБазуДанных --token %token% --page %page% --title %title% --props %props%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с базами данных",
"position": ""
}

View File

@ -0,0 +1,4 @@
{
"label": "Работа с базами данных",
"position": ""
}

View File

@ -0,0 +1,40 @@
---
sidebar_position: 1
---
# Создать блок
Создает новый блок на основе существующего блока
*Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Родитель | --page | Строка | ID родительского блока или страницы |
| Блок | --block | Строка,Соответствие Из КлючИЗначение | ID блока или сам блок образец |
| ВставитьПосле | --prev | Строка | ID блока, после которого необходимо встаивть новый |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, Блок, ВставитьПосле); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion СоздатьБлок --token %token% --page %page% --block %block% --prev %prev%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 4
---
# Удалить блок
Удаляет блок по ID
*Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДБлока | --block | Строка | ID блока |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.УдалитьБлок(Токен, ИДБлока); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion УдалитьБлок --token %token% --block %block%
```
```json title="Результат"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 2
---
# Вернуть блок.
*Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДБлока | --block | Строка | ID блока |
| ТолькоОснова | --core | Булево | Истина > служебные поля удаляются, остается только сам блок |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.ВернутьБлок(Токен, ИДБлока, ТолькоОснова); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion ВернутьБлок --token %token% --block %block% --core %core%
```
```json title="Результат"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 3
---
# Вернуть дочерние блоки
Созвращает список дочерних блоков блока-родителя
*Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| ИДБлока | --block | Строка | ID блока родителя |
Вовзращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion
```bsl title="Пример кода"
Ответ = OPI_Notion.ВернутьДочерниеБлоки(Токен, ИДБлока); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
```
```sh title="Пример команд CLI"
oint notion ВернутьДочерниеБлоки --token %token% --block %block%
```
```json title="Результат"
```

View File

@ -0,0 +1,4 @@
{
"label": "Работа с блоками",
"position": ""
}

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