Skip to content

Commit

Permalink
Создание MD файлов документации
Browse files Browse the repository at this point in the history
  • Loading branch information
VitalyTheAlpaca committed Jun 7, 2024
1 parent afc567a commit d3ba584
Show file tree
Hide file tree
Showing 28 changed files with 1,022 additions and 92 deletions.
12 changes: 6 additions & 6 deletions docs/en/md/Google_Sheets/Book-work/Create-book.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
sidebar_position: 1
---

# CreateBook
Creates a new book
# Create spreadsheet
Creates a new spreadsheet


*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export*
*Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Name |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet |


Returns: Map Of KeyAndValue - serialized JSON response from Google
Expand All @@ -26,7 +26,7 @@ sidebar_position: 1
Name = "TestTable";
Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand All @@ -35,7 +35,7 @@ sidebar_position: 1

```sh title="CLI command example"

oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets%
oint gsheets CreateSpreadsheet --token %token% --title "TestTable" --sheets %sheets%


```
Expand Down
14 changes: 7 additions & 7 deletions docs/en/md/Google_Sheets/Book-work/Edit-book-title.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
sidebar_position: 3
---

# ChangeBookName
Changes the name of the existing book
# Change spreadsheet name
Changes the name of the existing spreadsheet


*Function EditBookTitle(Val Token, Val Book, Val Name) Export*
*Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| Name | --title | String | New name |


Expand All @@ -20,10 +20,10 @@ sidebar_position: 3
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "Test table (change.)";
Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map
Response = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand All @@ -32,7 +32,7 @@ sidebar_position: 3

```sh title="CLI command example"

oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"


```
Expand Down
12 changes: 6 additions & 6 deletions docs/en/md/Google_Sheets/Book-work/Get-book.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
sidebar_position: 2
---

# GetBook
Gets information about the book by ID
# Get spreadsheet
Gets information about the spreadsheet by ID


*Function GetBook(Val Token, Val Identifier) Export*
*Function GetSpreadsheet(Val Token, Val Identifier) Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --spreadsheet | String | BookIdentifier |
| Identifier | --spreadsheet | String | Spreadsheet identifier |


Returns: Map Of KeyAndValue - serialized JSON response from Google
Expand All @@ -21,7 +21,7 @@ sidebar_position: 2
Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map
Response = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand All @@ -30,7 +30,7 @@ sidebar_position: 2

```sh title="CLI command example"

oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
oint gsheets GetSpreadsheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"


```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/md/Google_Sheets/Book-work/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Books managment",
"label": "Spreadsheets managment",
"position": "2"
}
12 changes: 6 additions & 6 deletions docs/en/md/Google_Sheets/Books-managment/Create-book.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
sidebar_position: 1
---

# CreateBook
Creates a new book
# Create spreadsheet
Creates a new spreadsheet


*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export*
*Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Name |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet |


Returns: Map Of KeyAndValue - serialized JSON response from Google
Expand All @@ -26,7 +26,7 @@ sidebar_position: 1
Name = "TestTable";
Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand All @@ -35,7 +35,7 @@ sidebar_position: 1

```sh title="CLI command example"

oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets%
oint gsheets CreateSpreadsheet --token %token% --title "TestTable" --sheets %sheets%


```
Expand Down
14 changes: 7 additions & 7 deletions docs/en/md/Google_Sheets/Books-managment/Edit-book-title.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
sidebar_position: 3
---

# ChangeBookName
Changes the name of the existing book
# Change spreadsheet name
Changes the name of the existing spreadsheet


*Function EditBookTitle(Val Token, Val Book, Val Name) Export*
*Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| Name | --title | String | New name |


Expand All @@ -20,10 +20,10 @@ sidebar_position: 3
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "Test table (change.)";
Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map
Response = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand All @@ -32,7 +32,7 @@ sidebar_position: 3

```sh title="CLI command example"

oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"


```
Expand Down
12 changes: 6 additions & 6 deletions docs/en/md/Google_Sheets/Books-managment/Get-book.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
sidebar_position: 2
---

# GetBook
Gets information about the book by ID
# Get spreadsheet
Gets information about the spreadsheet by ID


*Function GetBook(Val Token, Val Identifier) Export*
*Function GetSpreadsheet(Val Token, Val Identifier) Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --spreadsheet | String | BookIdentifier |
| Identifier | --spreadsheet | String | Spreadsheet identifier |


Returns: Map Of KeyAndValue - serialized JSON response from Google
Expand All @@ -21,7 +21,7 @@ sidebar_position: 2
Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map
Response = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand All @@ -30,7 +30,7 @@ sidebar_position: 2

```sh title="CLI command example"

oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
oint gsheets GetSpreadsheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"


```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/md/Google_Sheets/Books-managment/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Books managment",
"label": "Spreadsheets managment",
"position": "2"
}
8 changes: 4 additions & 4 deletions docs/en/md/Google_Sheets/Data-managment/Clear-cells.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebar_position: 2
Clears the value in cells


*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export*
*Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| CellsArray | --cells | Array of String | Array of cells like A1 to be cleared |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |

Expand All @@ -26,10 +26,10 @@ sidebar_position: 2
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand Down
10 changes: 5 additions & 5 deletions docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ sidebar_position: 3
Gets cell values of the table


*Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export*
*Function GetCellValues(Val Token, Val Spreadsheet, Val CellsArray = "", Val Sheet = "") Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| CellsArray | --cells | Array of String | Array of A1-type cells to get (whole sheet if not filled) |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| CellsArray | --cells | Array of String | Array of A1 type cells to get (whole sheet if not filled) |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |


Expand All @@ -26,10 +26,10 @@ sidebar_position: 3
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.GetCellValues(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand Down
8 changes: 4 additions & 4 deletions docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebar_position: 1
Sets sheet cell values


*Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*
*Function SetCellValues(Val Token, Val Spreadsheet, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| ValueMapping | --data | Map Of KeyAndValue | Fill data where the key is the cell name like A1 |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |
| MajorDimension | --dim | String | Main dimension when filling the array range |
Expand All @@ -32,10 +32,10 @@ sidebar_position: 1
ValueMapping.Insert("B1", "ThisIsB1");
ValueMapping.Insert("B4", "ThisIsB4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //Map
Response = OPI_GoogleSheets.SetCellValues(Token, Spreadsheet, ValueMapping, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand Down
8 changes: 4 additions & 4 deletions docs/en/md/Google_Sheets/Data-work/Clear-cells.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebar_position: 2
Clears the value in cells


*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export*
*Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export*

| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| CellsArray | --cells | Array of String | Array of cells like A1 to be cleared |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |

Expand All @@ -26,10 +26,10 @@ sidebar_position: 2
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
Expand Down
Loading

0 comments on commit d3ba584

Please sign in to comment.