From 7768d17760a257603862a08a37dcc245073e01e8 Mon Sep 17 00:00:00 2001 From: Kalaiyarasiganeshalingam Date: Fri, 10 Nov 2023 11:14:27 +0530 Subject: [PATCH] Revamp test cases --- ballerina/client.bal | 801 +++++++++++++++-------------- ballerina/modules/excel/client.bal | 212 ++++---- ballerina/modules/excel/types.bal | 10 +- ballerina/tests/test.bal | 112 ++-- ballerina/types.bal | 521 +++++++++++++++++++ spec.yaml | 583 +++++++++++---------- 6 files changed, 1390 insertions(+), 849 deletions(-) create mode 100644 ballerina/types.bal diff --git a/ballerina/client.bal b/ballerina/client.bal index b6a2b9f..6e95108 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -29,7 +29,7 @@ public isolated client class Client { # + config - The configurations to be used when initializing the `connector` # + serviceUrl - URL of the target service # + return - An error if connector initialization failed - public isolated function init(excel:ConnectionConfig config, string serviceUrl = "https://graph.microsoft.com/v1.0/") returns error? { + public isolated function init(ConnectionConfig config, string serviceUrl = "https://graph.microsoft.com/v1.0/") returns error? { self.excelClient = check new (config, serviceUrl); } @@ -37,8 +37,8 @@ public isolated client class Client { # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + session - The properties of the session to be created - # + return - A `excel:Session` or else an error on failure - remote isolated function createSession(string itemIdOrPath, excel:Session session) returns excel:Session|error { + # + return - A `Session` or else an error on failure + remote isolated function createSession(string itemIdOrPath, Session session) returns Session|error { if isItemPath(itemIdOrPath) { return self.excelClient->createSessionWithItemPath(itemIdOrPath, session); } @@ -71,7 +71,7 @@ public isolated client class Client { # Retrieves a list of the worksheets. # - # + itemId - The ID of the drive containing the workbooks + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves the related resources @@ -82,11 +82,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Worksheets` or else an error on failure - remote isolated function listWorksheets(string itemId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Worksheet[]|error { - excel:Worksheets worksheets = check self.excelClient->listWorksheets(itemId, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); - excel:Worksheet[]? value = worksheets.value; - return value is excel:Worksheet[] ? value : []; + # + return - A list of `Worksheet` or else an error on failure + remote isolated function listWorksheets(string itemIdOrPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Worksheet[]|error { + Worksheets worksheets; + if isItemPath(itemIdOrPath) { + worksheets = check self.excelClient->listWorksheetsWithItemPath(itemIdOrPath, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } else { + worksheets = check self.excelClient->listWorksheets(itemIdOrPath, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + Worksheet[]? value = worksheets.value; + return value is Worksheet[] ? value : []; } # Recalculates all currently opened workbooks in Excel. @@ -95,7 +100,7 @@ public isolated client class Client { # + calculationMode - Details of the mode used to calculate the application # + sessionId - The ID of the session # + return - An `http:Response` or else error on failure - remote isolated function calculateApplication(string itemIdOrPath, excel:CalculationMode calculationMode, string? sessionId = ()) returns http:Response|error { + remote isolated function calculateApplication(string itemIdOrPath, CalculationMode calculationMode, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->calculateApplicationWithItemPath(itemIdOrPath, calculationMode, sessionId); } @@ -106,8 +111,8 @@ public isolated client class Client { # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + sessionId - The ID of the session - # + return - An `excel:Application` or else an error on failure - remote isolated function getApplication(string itemIdOrPath, string? sessionId = ()) returns excel:Application|error { + # + return - An `Application` or else an error on failure + remote isolated function getApplication(string itemIdOrPath, string? sessionId = ()) returns Application|error { if isItemPath(itemIdOrPath) { return self.excelClient->getApplicationWithItemPath(itemIdOrPath, sessionId); } @@ -118,16 +123,16 @@ public isolated client class Client { # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + sessionId - The ID of the session - # + return - An `excel:Comments` or else an error on failure - remote isolated function listComments(string itemIdOrPath, string? sessionId = ()) returns excel:Comment[]|error { - excel:Comments comments; + # + return - A A list of `Comment` or else an error on failure + remote isolated function listComments(string itemIdOrPath, string? sessionId = ()) returns Comment[]|error { + Comments comments; if isItemPath(itemIdOrPath) { comments = check self.excelClient->listCommentsWithItemPath(itemIdOrPath, sessionId); } else { comments = check self.excelClient->listComments(itemIdOrPath, sessionId); } - excel:Comment[]? value = comments.value; - return value is excel:Comment[] ? value : []; + Comment[]? value = comments.value; + return value is Comment[] ? value : []; } # Retrieves the properties and relationships of the comment. @@ -135,8 +140,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + commentId - The ID of the comment to get # + sessionId - The ID of the session - # + return - An `excel:Comment` or else an error on failure - remote isolated function getComment(string itemIdOrPath, string commentId, string? sessionId = ()) returns excel:Comment|error { + # + return - A `Comment` or else an error on failure + remote isolated function getComment(string itemIdOrPath, string commentId, string? sessionId = ()) returns Comment|error { if isItemPath(itemIdOrPath) { return self.excelClient->getCommentWithItemPath(itemIdOrPath, commentId, sessionId); } @@ -149,8 +154,8 @@ public isolated client class Client { # + commentId - The ID of the comment to get # + reply - The properties of the reply to be created # + sessionId - The ID of the session - # + return - An `excel:Reply` or else an error on failure - remote isolated function createCommentReply(string itemIdOrPath, string commentId, excel:Reply reply, string? sessionId = ()) returns excel:Reply|error { + # + return - A `Reply` or else an error on failure + remote isolated function createCommentReply(string itemIdOrPath, string commentId, Reply reply, string? sessionId = ()) returns Reply|error { if isItemPath(itemIdOrPath) { return self.excelClient->createCommentReplyWithItemPath(itemIdOrPath, commentId, reply, sessionId); } @@ -163,8 +168,8 @@ public isolated client class Client { # + commentId - The ID of the comment to get # + replyId - The ID of the reply # + sessionId - The ID of the session - # + return - An `excel:Reply` or else an error on failure - remote isolated function getCommentReply(string itemIdOrPath, string commentId, string replyId, string? sessionId = ()) returns excel:Reply|error { + # + return - A `Reply` or else an error on failure + remote isolated function getCommentReply(string itemIdOrPath, string commentId, string replyId, string? sessionId = ()) returns Reply|error { if isItemPath(itemIdOrPath) { return self.excelClient->getCommentReplyWithItemPath(itemIdOrPath, commentId, replyId, sessionId); } @@ -176,16 +181,16 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + commentId - The ID of the comment to get # + sessionId - The ID of the session - # + return - An `excel:Replies` or else an error on failure - remote isolated function listCommentReplies(string itemIdOrPath, string commentId, string? sessionId = ()) returns excel:Reply[]|error { - excel:Replies replies; + # + return - A list of `Reply` or else an error on failure + remote isolated function listCommentReplies(string itemIdOrPath, string commentId, string? sessionId = ()) returns Reply[]|error { + Replies replies; if isItemPath(itemIdOrPath) { replies = check self.excelClient->listCommentRepliesWithItemPath(itemIdOrPath, commentId, sessionId); } else { replies = check self.excelClient->listCommentReplies(itemIdOrPath, commentId, sessionId); } - excel:Reply[]? value = replies.value; - return value is excel:Reply[] ? value : []; + Reply[]? value = replies.value; + return value is Reply[] ? value : []; } # Retrieves a list of table row in the workbook. @@ -202,16 +207,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Rows` or else an error on failure - remote isolated function listWorkbookTableRows(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Row[]|error { - excel:Rows rows; + # + return - A list of `Row` or else an error on failure + remote isolated function listWorkbookTableRows(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row[]|error { + Rows rows; if isItemPath(itemIdOrPath) { rows = check self.excelClient->listWorkbookTableRowsWithItemPath(itemIdOrPath, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { rows = check self.excelClient->listWorkbookTableRows(itemIdOrPath, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Row[]? value = rows.value; - return value is excel:Row[] ? value : []; + Row[]? value = rows.value; + return value is Row[] ? value : []; } # Adds rows to the end of a table in the workbook. @@ -220,8 +225,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + row - The properties of the row to be added # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function createWorkbookTableRow(string itemIdOrPath, string tableIdOrName, excel:Row row, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function createWorkbookTableRow(string itemIdOrPath, string tableIdOrName, Row row, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->createWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, row, sessionId); } @@ -243,8 +248,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Row` or else an error on failure - remote isolated function getWorkbookTableRow(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function getWorkbookTableRow(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, index, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -271,8 +276,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorkbookTableRowRange(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorkbookTableRowRange(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableRowRangeWithItemPath(itemIdOrPath, tableIdOrName, index, sessionId); } @@ -286,8 +291,8 @@ public isolated client class Client { # + index - Index value of the object to be retrieved # + row - Details of the table row to be updated # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function updateWorkbookTableRow(string itemIdOrPath, string tableIdOrName, int index, excel:Row row, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function updateWorkbookTableRow(string itemIdOrPath, string tableIdOrName, int index, Row row, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, index, row, sessionId); } @@ -300,8 +305,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function getWorkbookTableRowWithIndex(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function getWorkbookTableRowWithIndex(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableRowWithIndexItemPath(itemIdOrPath, tableIdOrName, index, sessionId); } @@ -313,8 +318,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheet - The properties of the worksheet to be created # + sessionId - The ID of the session - # + return - An `excel:Worksheet` or else an error on failure - remote isolated function addWorksheet(string itemIdOrPath, excel:NewWorksheet worksheet, string? sessionId = ()) returns excel:Worksheet|error { + # + return - A `Worksheet` or else an error on failure + remote isolated function addWorksheet(string itemIdOrPath, NewWorksheet worksheet, string? sessionId = ()) returns Worksheet|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorksheetWithItemPath(itemIdOrPath, worksheet, sessionId); } @@ -335,8 +340,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Worksheet` or else an error on failure - remote isolated function getWorksheet(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Worksheet|error { + # + return - A `Worksheet` or else an error on failure + remote isolated function getWorksheet(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Worksheet|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -349,8 +354,8 @@ public isolated client class Client { # + name - The name of the named item # + valuesOnly - A value indicating whether to return only the values in the used range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameUsedRange(string itemIdOrPath, string name, boolean valuesOnly, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameUsedRange(string itemIdOrPath, string name, boolean valuesOnly, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameUsedRangeWithItemPath(itemIdOrPath, name, valuesOnly, sessionId); } @@ -363,8 +368,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + worksheet - The properties of the worksheet to be updated # + sessionId - The ID of the session - # + return - An `excel:Worksheet` or else an error on failure - remote isolated function updateWorksheet(string itemIdOrPath, string worksheetIdOrName, excel:Worksheet worksheet, string? sessionId = ()) returns excel:Worksheet|error { + # + return - A `Worksheet` or else an error on failure + remote isolated function updateWorksheet(string itemIdOrPath, string worksheetIdOrName, Worksheet worksheet, string? sessionId = ()) returns Worksheet|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorksheetWithItemPath(itemIdOrPath, worksheetIdOrName, worksheet, sessionId); } @@ -391,8 +396,8 @@ public isolated client class Client { # + row - Row number of the cell to be retrieved # + column - Column number of the cell to be retrieved # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetCell(string itemIdOrPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetCell(string itemIdOrPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetCellWithItemPath(itemIdOrPath, worksheetIdOrName, row, column, sessionId); } @@ -413,8 +418,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -435,16 +440,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Tables` or else an error on failure - remote isolated function listWorksheetTables(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Table[]|error { - excel:Tables tables; + # + return - A list of `Table` or else an error on failure + remote isolated function listWorksheetTables(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Table[]|error { + Tables tables; if isItemPath(itemIdOrPath) { tables = check self.excelClient->listWorksheetTablesWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { tables = check self.excelClient->listWorksheetTables(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Table[]? value = tables.value; - return value is excel:Table[] ? value : []; + Table[]? value = tables.value; + return value is Table[] ? value : []; } # Adds a new table in the worksheet. @@ -453,8 +458,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + 'table - Properties to create table # + sessionId - The ID of the session - # + return - An `excel:Table` or else an error on failure - remote isolated function addWorksheetTable(string itemIdOrPath, string worksheetIdOrName, excel:NewTable 'table, string? sessionId = ()) returns excel:Table|error { + # + return - A `Table` or else an error on failure + remote isolated function addWorksheetTable(string itemIdOrPath, string worksheetIdOrName, NewTable 'table, string? sessionId = ()) returns Table|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorksheetTableWithItemPath(itemIdOrPath, worksheetIdOrName, 'table, sessionId); } @@ -475,16 +480,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Charts` or else an error on failure - remote isolated function listCharts(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Chart[]|error { - excel:Charts charts; + # + return - An `Charts` or else an error on failure + remote isolated function listCharts(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Chart[]|error { + Charts charts; if isItemPath(itemIdOrPath) { charts = check self.excelClient->listChartsWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { charts = check self.excelClient->listCharts(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Chart[]? value = charts.value; - return value is excel:Chart[] ? value : []; + Chart[]? value = charts.value; + return value is Chart[] ? value : []; } # Creates a new chart. @@ -493,8 +498,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + chart - Properties to create chart # + sessionId - The ID of the session - # + return - An `excel:Chart` or else an error on failure - remote isolated function addChart(string itemIdOrPath, string worksheetIdOrName, excel:NewChart chart, string? sessionId = ()) returns excel:Chart|error { + # + return - A `Chart` or else an error on failure + remote isolated function addChart(string itemIdOrPath, string worksheetIdOrName, NewChart chart, string? sessionId = ()) returns Chart|error { if isItemPath(itemIdOrPath) { return self.excelClient->addChartWithItemPath(itemIdOrPath, worksheetIdOrName, chart, sessionId); } @@ -515,16 +520,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:NamedItem` or else an error on failure - remote isolated function listWorksheetNames(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:NamedItem[]|error { - excel:NamedItems namedItems; + # + return - A list of `NamedItem` or else an error on failure + remote isolated function listWorksheetNames(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItem[]|error { + NamedItems namedItems; if isItemPath(itemIdOrPath) { namedItems = check self.excelClient->listWorksheetNamedItemWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { namedItems = check self.excelClient->listWorksheetNamedItem(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:NamedItem[]? value = namedItems.value; - return value is excel:NamedItem[] ? value : []; + NamedItem[]? value = namedItems.value; + return value is NamedItem[] ? value : []; } # Retrieves a list of the workbook pivot table. @@ -541,16 +546,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:PivotTables` or else an error on failure - remote isolated function listWorksheetPivotTables(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:PivotTable[]|error { - excel:PivotTables pivotTables; + # + return - A list of `PivotTables` or else an error on failure + remote isolated function listWorksheetPivotTables(string itemIdOrPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTable[]|error { + PivotTables pivotTables; if isItemPath(itemIdOrPath) { pivotTables = check self.excelClient->listPivotTablesWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { pivotTables = check self.excelClient->listPivotTables(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:PivotTable[]? value = pivotTables.value; - return value is excel:PivotTable[] ? value : []; + PivotTable[]? value = pivotTables.value; + return value is PivotTable[] ? value : []; } # Retrieves the properties and relationships of the pivot table. @@ -568,8 +573,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:PivotTables` or else an error on failure - remote isolated function getPivotTable(string itemIdOrPath, string worksheetIdOrName, string pivotTableId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:PivotTable|error { + # + return - A `PivotTable` or else an error on failure + remote isolated function getPivotTable(string itemIdOrPath, string worksheetIdOrName, string pivotTableId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTable|error { if isItemPath(itemIdOrPath) { return self.excelClient->getPivotTableWithItemPath(itemIdOrPath, worksheetIdOrName, pivotTableId, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -618,8 +623,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeWithAddress(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeWithAddress(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeWithAddressItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -633,8 +638,8 @@ public isolated client class Client { # + address - The address of the range # + range - Details of the range to be updated # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function updateWorksheetRangeWithAddress(string itemIdOrPath, string worksheetIdOrName, string address, excel:Range range, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function updateWorksheetRangeWithAddress(string itemIdOrPath, string worksheetIdOrName, string address, Range range, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorksheetRangeWithAddressItemPath(itemIdOrPath, worksheetIdOrName, address, range, sessionId); } @@ -656,8 +661,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -671,8 +676,8 @@ public isolated client class Client { # + columnIdOrName - The ID or name of the column # + range - Details of the range to be updated # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function updateColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:Range range, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function updateColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, Range range, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, range, sessionId); } @@ -685,8 +690,8 @@ public isolated client class Client { # + namedItemName - The name of the named item # + range - The properties of the range to be updated # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function updateNameRange(string itemIdOrPath, string namedItemName, excel:Range range, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function updateNameRange(string itemIdOrPath, string namedItemName, Range range, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateNameRangeWithItemPath(itemIdOrPath, namedItemName, range, sessionId); } @@ -700,8 +705,8 @@ public isolated client class Client { # + row - Row number of the cell to be retrieved # + column - Column number of the cell to be retrieved # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeCell(string itemIdOrPath, string namedItemName, int row, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeCell(string itemIdOrPath, string namedItemName, int row, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeCell(itemIdOrPath, namedItemName, row, column, sessionId); } @@ -715,8 +720,8 @@ public isolated client class Client { # + row - Row number of the cell to be retrieved # + column - Column number of the cell to be retrieved # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeCell(string itemIdOrPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeCell(string itemIdOrPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeCellWithItemPath(itemIdOrPath, worksheetIdOrName, row, column, sessionId); } @@ -731,8 +736,8 @@ public isolated client class Client { # + row - Row number of the cell to be retrieved # + column - Column number of the cell to be retrieved # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeCellWithAddress(string itemIdOrPath, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeCellWithAddress(string itemIdOrPath, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeCellWithAddressItemPath(itemIdOrPath, worksheetIdOrName, address, row, column, sessionId); } @@ -747,8 +752,8 @@ public isolated client class Client { # + row - Row number of the cell to be retrieved. Zero-indexed. # + column - Column number of the cell to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeCellWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, row, column, sessionId); } @@ -761,8 +766,8 @@ public isolated client class Client { # + name - The name of the named item # + column - Column number of the cell to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeColumn(string itemIdOrPath, string name, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeColumn(string itemIdOrPath, string name, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeColumnWithItemPath(itemIdOrPath, name, column, sessionId); } @@ -776,8 +781,8 @@ public isolated client class Client { # + address - The address of the range # + column - Column number of the cell to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeColumn(string itemIdOrPath, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeColumn(string itemIdOrPath, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeColumnWithItemPath(itemIdOrPath, worksheetIdOrName, address, column,sessionId); } @@ -791,8 +796,8 @@ public isolated client class Client { # + columnIdOrName - The ID or name of the column # + column - Column number of the cell to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, column,sessionId); } @@ -804,8 +809,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetColumnsAfterRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetColumnsAfterRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetColumnsAfterRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); } @@ -818,8 +823,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + columnCount - The number of columns to include in the resulting range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetColumnsAfterRangeWithCount(string itemIdOrPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetColumnsAfterRangeWithCount(string itemIdOrPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetColumnsAfterRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, columnCount, sessionId); } @@ -831,8 +836,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetColumnsBeforeRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetColumnsBeforeRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetColumnsBeforeRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); } @@ -845,8 +850,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + columnCount - The number of columns to include in the resulting range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetColumnsBeforeRangeWithCount(string itemIdOrPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetColumnsBeforeRangeWithCount(string itemIdOrPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetColumnsBeforeRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, columnCount, sessionId); } @@ -858,8 +863,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + namedItemName - The name of the named item # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeEntireColumn(string itemIdOrPath, string namedItemName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeEntireColumn(string itemIdOrPath, string namedItemName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeEntireColumnWithItemPath(itemIdOrPath, namedItemName, sessionId); } @@ -872,8 +877,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeEntireColumn(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeEntireColumn(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeEntireColumnWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); } @@ -886,8 +891,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeEntireColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeEntireColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeEntireColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -899,8 +904,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + namedItemName - The name of the named item # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeEntireRow(string itemIdOrPath, string namedItemName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeEntireRow(string itemIdOrPath, string namedItemName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeEntireRowWithItemPath(itemIdOrPath, namedItemName, sessionId); } @@ -913,8 +918,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getRangeEntireRow(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getRangeEntireRow(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeEntireRowWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); } @@ -927,8 +932,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeEntireRow(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeEntireRow(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeEntireRowWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -940,8 +945,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeLastCell(string itemIdOrPath, string name, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeLastCell(string itemIdOrPath, string name, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeLastCellWithItemPath(itemIdOrPath, name, sessionId); } @@ -954,8 +959,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getRangeLastCell(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getRangeLastCell(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeLastCellWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); } @@ -968,8 +973,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeLastCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeLastCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeLastCellWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -981,8 +986,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeLastColumn(string itemIdOrPath, string name, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeLastColumn(string itemIdOrPath, string name, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeLastColumnWithItemPath(itemIdOrPath, name, sessionId); } @@ -995,8 +1000,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeLastColumn(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeLastColumn(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeLastColumnWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); } @@ -1009,8 +1014,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeLastColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeLastColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeLastColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -1022,8 +1027,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeLastRow(string itemIdOrPath, string name, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeLastRow(string itemIdOrPath, string name, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeLastRowWithItemPath(itemIdOrPath, name, sessionId); } @@ -1036,8 +1041,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeLastRow(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeLastRow(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeLastRowWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); } @@ -1050,8 +1055,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeLastRow(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeLastRow(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeLastRowWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -1063,8 +1068,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRowsAboveRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRowsAboveRange(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRowsAboveRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); } @@ -1077,8 +1082,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + rowCount - The number of rows to include in the resulting range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRowsAboveRangeWithCount(string itemIdOrPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRowsAboveRangeWithCount(string itemIdOrPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRowsAboveRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, rowCount, sessionId); } @@ -1090,8 +1095,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeRowsBelow(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeRowsBelow(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRowsBelowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); } @@ -1104,8 +1109,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + rowCount - The number of rows to include in the resulting range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeRowsBelowWithCount(string itemIdOrPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeRowsBelowWithCount(string itemIdOrPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRowsBelowRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, rowCount, sessionId); } @@ -1119,8 +1124,8 @@ public isolated client class Client { # + address - The address of the range # + valuesOnly - A value indicating whether to return only the values in the used range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetUsedRange(string itemIdOrPath, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetUsedRange(string itemIdOrPath, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetUsedRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, valuesOnly, sessionId); } @@ -1134,8 +1139,8 @@ public isolated client class Client { # + columnIdOrName - The ID or name of the column # + valuesOnly - A value indicating whether to return only the values in the used range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnUsedRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnUsedRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnUsedRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, valuesOnly, sessionId); } @@ -1149,7 +1154,7 @@ public isolated client class Client { # + applyTo - Determines the type of clear action # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function clearNameRange(string itemIdOrPath, string name, excel:ApplyTo applyTo, string? sessionId = ()) returns http:Response|error { + remote isolated function clearNameRange(string itemIdOrPath, string name, ApplyTo applyTo, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->clearNameRangeWithItemPath(itemIdOrPath, name, applyTo, sessionId); } @@ -1164,7 +1169,7 @@ public isolated client class Client { # + applyTo - Determines the type of clear action # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function clearWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, excel:ApplyTo applyTo, string? sessionId = ()) returns http:Response|error { + remote isolated function clearWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, ApplyTo applyTo, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->clearWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, applyTo, sessionId); } @@ -1179,7 +1184,7 @@ public isolated client class Client { # + applyTo - Determines the type of clear action # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function clearColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:ApplyTo applyTo, string? sessionId = ()) returns http:Response|error { + remote isolated function clearColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, ApplyTo applyTo, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->clearColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, applyTo, sessionId); } @@ -1193,7 +1198,7 @@ public isolated client class Client { # + shift - Represents the ways to shift the cells # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function deleteNameRangeCell(string itemIdOrPath, string name, excel:Shift shift, string? sessionId = ()) returns http:Response|error { + remote isolated function deleteNameRangeCell(string itemIdOrPath, string name, Shift shift, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->deleteNameRangeCellWithItemPath(itemIdOrPath, name, shift, sessionId); } @@ -1208,7 +1213,7 @@ public isolated client class Client { # + shift - Represents the ways to shift the cells # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function deleteWorksheetRangeCell(string itemIdOrPath, string worksheetIdOrName, string address, excel:Shift shift, string? sessionId = ()) returns http:Response|error { + remote isolated function deleteWorksheetRangeCell(string itemIdOrPath, string worksheetIdOrName, string address, Shift shift, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->deleteWorksheetRangeCellWithItemPath(itemIdOrPath, worksheetIdOrName, address, shift, sessionId); } @@ -1223,7 +1228,7 @@ public isolated client class Client { # + shift - Represents the ways to shift the cells # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function deleteColumnRangeCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:Shift shift, string? sessionId = ()) returns http:Response|error { + remote isolated function deleteColumnRangeCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, Shift shift, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->deleteColumnRangeCellWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, shift, sessionId); } @@ -1236,8 +1241,8 @@ public isolated client class Client { # + name - The name of the named item # + shift - Represents the ways to shift the cells # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function insertNameRange(string itemIdOrPath, string name, excel:Shift shift, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function insertNameRange(string itemIdOrPath, string name, Shift shift, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->insertNameRangeWithItemPath(itemIdOrPath, name, shift, sessionId); } @@ -1251,8 +1256,8 @@ public isolated client class Client { # + address - The address of the range # + shift - Represents the ways to shift the cells # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function insertWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, excel:Shift shift, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function insertWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, Shift shift, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->insertWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, shift, sessionId); } @@ -1266,52 +1271,52 @@ public isolated client class Client { # + columnIdOrName - The ID or name of the column # + shift - Represents the ways to shift the cells # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function insertColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:Shift shift, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function insertColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, Shift shift, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->insertColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, shift, sessionId); } return self.excelClient->insertColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, shift, sessionId); } - # Merge the range cells into one region in the worksheet. + # Merges the range cells into one region in the worksheet. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + across - The properties to the merge range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function mergeNameRange(string itemIdOrPath, string name, excel:Across across, string? sessionId = ()) returns http:Response|error { + # + return - A `Range` or else an error on failure + remote isolated function mergeNameRange(string itemIdOrPath, string name, Across across, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->mergeNameRangeWithItemPath(itemIdOrPath, name, across, sessionId); } return self.excelClient->mergeNameRange(itemIdOrPath, name, across, sessionId); } - # Merge the range cells into one region in the worksheet. + # Merges the range cells into one region in the worksheet. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + across - The properties to the merge range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function mergeWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, excel:Across across, string? sessionId = ()) returns http:Response|error { + # + return - A `Range` or else an error on failure + remote isolated function mergeWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, Across across, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->mergeWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, across, sessionId); } return self.excelClient->mergeWorksheetRange(itemIdOrPath, worksheetIdOrName, address, across, sessionId); } - # Merge the range cells into one region in the worksheet. + # Merges the range cells into one region in the worksheet. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + across - The properties to the merge range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function mergeColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:Across across, string? sessionId = ()) returns http:Response|error { + # + return - A `Range` or else an error on failure + remote isolated function mergeColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, Across across, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->mergeColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, across, sessionId); } @@ -1323,7 +1328,7 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure + # + return - A `Range` or else an error on failure remote isolated function unmergeNameRange(string itemIdOrPath, string name, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->unmergeNameRangeWithItemPath(itemIdOrPath, name, sessionId); @@ -1331,13 +1336,13 @@ public isolated client class Client { return self.excelClient->unmergeNameRange(itemIdOrPath, name, sessionId); } - # Unmerge the range cells into separate cells. + # Unmerges the range cells into separate cells. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure + # + return - A `Range` or else an error on failure remote isolated function unmergeWorksheetRange(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->unmergeWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); @@ -1345,13 +1350,13 @@ public isolated client class Client { return self.excelClient->unmergeWorksheetRange(itemIdOrPath, worksheetIdOrName, address, sessionId); } - # Unmerge the range cells into separate cells. + # Unmerges the range cells into separate cells. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure + # + return - A `Range` or else an error on failure remote isolated function unmergeColumnRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->unmergeColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); @@ -1359,7 +1364,7 @@ public isolated client class Client { return self.excelClient->unmergeColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } - # Retrieve the properties and relationships of the range format + # Retrieves the properties and relationships of the range format # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item @@ -1373,29 +1378,29 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Range` or else an error on failure - remote isolated function getNameRangeFormat(string itemIdOrPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:RangeFormat|error { + # + return - A `Range` or else an error on failure + remote isolated function getNameRangeFormat(string itemIdOrPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNameRangeFormatWithItemPath(itemIdOrPath, name, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } return self.excelClient->getNameRangeFormat(itemIdOrPath, name, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - # Update the properties of range format. + # Updates the properties of range format. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + rangeFormat - Properties of the range format to be updated # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function updateNameRangeFormat(string itemIdOrPath, string name, excel:RangeFormat rangeFormat, string? sessionId = ()) returns excel:RangeFormat|error { + # + return - A `Range` or else an error on failure + remote isolated function updateNameRangeFormat(string itemIdOrPath, string name, RangeFormat rangeFormat, string? sessionId = ()) returns RangeFormat|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateNameRangeFormat(itemIdOrPath, name, rangeFormat, sessionId); } return self.excelClient->updateNameRangeFormat(itemIdOrPath, name, rangeFormat, sessionId); } - # Retrieve the properties and relationships of the range format + # Retrieves the properties and relationships of the range format # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -1410,30 +1415,30 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetRangeFormat(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:RangeFormat|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetRangeFormat(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetRangeFormat(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } return self.excelClient->getWorksheetRangeFormat(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - # Update the properties of range format. + # Updates the properties of range format. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + rangeFormat - Properties of the range format to be updated # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function updateWorksheetRangeFormat(string itemIdOrPath, string worksheetIdOrName, string address, excel:RangeFormat rangeFormat, string? sessionId = ()) returns excel:RangeFormat|error { + # + return - A `Range` or else an error on failure + remote isolated function updateWorksheetRangeFormat(string itemIdOrPath, string worksheetIdOrName, string address, RangeFormat rangeFormat, string? sessionId = ()) returns RangeFormat|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorksheetRangeFormatWithItemPath(itemIdOrPath, worksheetIdOrName, address, rangeFormat, sessionId); } return self.excelClient->updateWorksheetRangeFormat(itemIdOrPath, worksheetIdOrName, address, rangeFormat, sessionId); } - # Retrieve the properties and relationships of the range format + # Retrieves the properties and relationships of the range format # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -1448,67 +1453,67 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Range` or else an error on failure - remote isolated function getColumnRangeFormat(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:RangeFormat|error { + # + return - A `Range` or else an error on failure + remote isolated function getColumnRangeFormat(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { if isItemPath(itemIdOrPath) { return self.excelClient->getColumnRangeFormatWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } return self.excelClient->getColumnRangeFormat(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - # Update the properties of range format. + # Updates the properties of range format. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + rangeFormat - Properties of the range format to be updated # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function updateColumnRangeFormat(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:RangeFormat rangeFormat, string? sessionId = ()) returns excel:RangeFormat|error { + # + return - A `Range` or else an error on failure + remote isolated function updateColumnRangeFormat(string itemIdOrPath, string tableIdOrName, string columnIdOrName, RangeFormat rangeFormat, string? sessionId = ()) returns RangeFormat|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateColumnRangeFormatWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, rangeFormat, sessionId); } return self.excelClient->updateColumnRangeFormat(itemIdOrPath, tableIdOrName, columnIdOrName, rangeFormat, sessionId); } - # Create a new range border. + # Creates a new range border. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + rangeBorder - Details of the range border to be created # + sessionId - The ID of the session - # + return - An `excel:RangeBorder` or else an error on failure - remote isolated function createNameRangeBorder(string itemIdOrPath, string name, excel:RangeBorder rangeBorder, string? sessionId = ()) returns excel:RangeBorder|error { + # + return - An`RangeBorder` or else an error on failure + remote isolated function createNameRangeBorder(string itemIdOrPath, string name, RangeBorder rangeBorder, string? sessionId = ()) returns RangeBorder|error { if isItemPath(itemIdOrPath) { return self.excelClient->createNameRangeBorderWithItemPath(itemIdOrPath, name, rangeBorder, sessionId); } return self.excelClient->createNameRangeBorder(itemIdOrPath, name, rangeBorder, sessionId); } - # Create a new range border. + # Creates a new range border. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + rangeBorder - Details of the range border to be created # + sessionId - The ID of the session - # + return - An `excel:RangeBorder` or else an error on failure - remote isolated function createWorksheetRangeBorder(string itemIdOrPath, string worksheetIdOrName, string address, excel:RangeBorder rangeBorder, string? sessionId = ()) returns excel:RangeBorder|error { + # + return - A `RangeBorder` or else an error on failure + remote isolated function createWorksheetRangeBorder(string itemIdOrPath, string worksheetIdOrName, string address, RangeBorder rangeBorder, string? sessionId = ()) returns RangeBorder|error { if isItemPath(itemIdOrPath) { return self.excelClient->createWorksheetRangeBorderWithItemPath(itemIdOrPath, worksheetIdOrName, address, rangeBorder, sessionId); } return self.excelClient->createWorksheetRangeBorder(itemIdOrPath, worksheetIdOrName, address, rangeBorder, sessionId); } - # Create a new range border. + # Creates a new range border. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + rangeBorder - Properties to create range border # + sessionId - The ID of the session - # + return - An `excel:RangeBorder` or else an error on failure - remote isolated function createColumnRangeBorder(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:RangeBorder rangeBorder, string? sessionId = ()) returns excel:RangeBorder|error { + # + return - A `RangeBorder` or else an error on failure + remote isolated function createColumnRangeBorder(string itemIdOrPath, string tableIdOrName, string columnIdOrName, RangeBorder rangeBorder, string? sessionId = ()) returns RangeBorder|error { if isItemPath(itemIdOrPath) { return self.excelClient->createColumnRangeBorderWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, rangeBorder, sessionId); } @@ -1529,16 +1534,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:RangeBorders` or else an error on failure - remote isolated function listNameRangeBorders(string itemIdOrPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:RangeBorder[]|error { - excel:RangeBorders rangeBorders; + # + return - A list of `RangeBorder` or else an error on failure + remote isolated function listNameRangeBorders(string itemIdOrPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeBorder[]|error { + RangeBorders rangeBorders; if isItemPath(itemIdOrPath) { rangeBorders = check self.excelClient->listNameRangeBordersWithItemPath(itemIdOrPath, name, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { rangeBorders = check self.excelClient->listNameRangeBorders(itemIdOrPath, name, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:RangeBorder[]? value = rangeBorders.value; - return value is excel:RangeBorder[] ? value : []; + RangeBorder[]? value = rangeBorders.value; + return value is RangeBorder[] ? value : []; } # Retrieves a list of range borders. @@ -1556,15 +1561,15 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:RangeBorders` or else an error on failure - remote isolated function listColumnRangeBorders(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:RangeBorder[]|error { - excel:RangeBorders rangeBorders; + # + return - A list of `RangeBorder` or else an error on failure + remote isolated function listColumnRangeBorders(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeBorder[]|error { + RangeBorders rangeBorders; if isItemPath(itemIdOrPath) { rangeBorders = check self.excelClient->listColumnRangeBordersWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } rangeBorders = check self.excelClient->listColumnRangeBorders(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); - excel:RangeBorder[]? value = rangeBorders.value; - return value is excel:RangeBorder[] ? value : []; + RangeBorder[]? value = rangeBorders.value; + return value is RangeBorder[] ? value : []; } # Retrieves a list of range borders. @@ -1582,16 +1587,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:RangeBorders` or else an error on failure - remote isolated function listRangeBorders(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:RangeBorder[]|error { - excel:RangeBorders rangeBorders; + # + return - A list of `RangeBorder` or else an error on failure + remote isolated function listRangeBorders(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeBorder[]|error { + RangeBorders rangeBorders; if isItemPath(itemIdOrPath) { rangeBorders = check self.excelClient->listColumnRangeBordersWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { rangeBorders = check self.excelClient->listColumnRangeBorders(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:RangeBorder[]? value = rangeBorders.value; - return value is excel:RangeBorder[] ? value : []; + RangeBorder[]? value = rangeBorders.value; + return value is RangeBorder[] ? value : []; } # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. @@ -1676,21 +1681,21 @@ public isolated client class Client { return self.excelClient->autofitColumnRangeRows(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } - # Perform a sort operation. + # Performs a sort operation. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item # + rangeSort - The properties to the sort operation # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function performNameRangeSort(string itemIdOrPath, string name, excel:RangeSort rangeSort, string? sessionId = ()) returns http:Response|error { + remote isolated function performNameRangeSort(string itemIdOrPath, string name, RangeSort rangeSort, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->performNameRangeSortWithItemPath(itemIdOrPath, name, rangeSort, sessionId); } return self.excelClient->performNameRangeSort(itemIdOrPath, name, rangeSort, sessionId); } - # Perform a sort operation. + # Performs a sort operation. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -1698,14 +1703,14 @@ public isolated client class Client { # + rangeSort - The properties to the sort operation # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function performRangeSort(string itemIdOrPath, string worksheetIdOrName, string address, excel:RangeSort rangeSort, string? sessionId = ()) returns http:Response|error { + remote isolated function performRangeSort(string itemIdOrPath, string worksheetIdOrName, string address, RangeSort rangeSort, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->performWorksheetRangeSortWithItemPath(itemIdOrPath, worksheetIdOrName, address, rangeSort, sessionId); } return self.excelClient->performWorksheetRangeSort(itemIdOrPath, worksheetIdOrName, address, rangeSort, sessionId); } - # Perform a sort operation. + # Performs a sort operation. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -1713,43 +1718,43 @@ public isolated client class Client { # + rangeSort - The properties to the perform sort operation # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function performColumnRangeSort(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:RangeSort rangeSort, string? sessionId = ()) returns http:Response|error { + remote isolated function performColumnRangeSort(string itemIdOrPath, string tableIdOrName, string columnIdOrName, RangeSort rangeSort, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->performColumnRangeSortWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, rangeSort, sessionId); } return self.excelClient->performColumnRangeSort(itemIdOrPath, tableIdOrName, columnIdOrName, rangeSort, sessionId); } - # Get the resized range of a range. + # Gets the resized range of a range. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + deltaRows - The number of rows to expand or contract the bottom-right corner of the range by. If deltaRows is positive, the range will be expanded. If deltaRows is negative, the range will be contracted. # + deltaColumns - The number of columns to expand or contract the bottom-right corner of the range by. If deltaColumns is positive, the range will be expanded. If deltaColumns is negative, the range will be contracted. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getResizedRange(string itemIdOrPath, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getResizedRange(string itemIdOrPath, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getResizedRangeWithItemPath(itemIdOrPath, worksheetIdOrName, deltaRows, deltaColumns, sessionId); } return self.excelClient->getResizedRange(itemIdOrPath, worksheetIdOrName, deltaRows, deltaColumns, sessionId); } - # Get the range visible from a filtered range + # Gets the range visible from a filtered range # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + address - The address of the range # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getVisibleView(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:RangeView|error { + # + return - A `Range` or else an error on failure + remote isolated function getVisibleView(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { if isItemPath(itemIdOrPath) { return self.excelClient->getVisibleViewWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); } return self.excelClient->getVisibleView(itemIdOrPath, worksheetIdOrName, address, sessionId); } - # Retrieve the properties and relationships of table. + # Retrieves the properties and relationships of table. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -1763,15 +1768,15 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Table` or else an error on failure - remote isolated function getWorkbookTable(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Table|error { + # + return - A `Table` or else an error on failure + remote isolated function getWorkbookTable(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Table|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableWithItemPath(itemIdOrPath, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } return self.excelClient->getWorkbookTable(itemIdOrPath, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - # Retrieve the properties and relationships of table. + # Retrieves the properties and relationships of table. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -1786,28 +1791,28 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Table` or else an error on failure - remote isolated function getWorksheetTable(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Table|error { + # + return - A `Table` or else an error on failure + remote isolated function getWorksheetTable(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Table|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } return self.excelClient->getWorksheetTable(itemIdOrPath, tableIdOrName, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - # Create a new table in the workbook + # Creates a new table in the workbook # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + table - The properties to create table # + sessionId - The ID of the session - # + return - An `excel:Table` or else an error on failure - remote isolated function addWorkbookTable(string itemIdOrPath, excel:NewTable 'table, string? sessionId = ()) returns excel:Table|error { + # + return - A `Table` or else an error on failure + remote isolated function addWorkbookTable(string itemIdOrPath, NewTable 'table, string? sessionId = ()) returns Table|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorkbookTableWithItemPath(itemIdOrPath, 'table, sessionId); } return self.excelClient->addWorkbookTable(itemIdOrPath, 'table, sessionId); } - # Retrieve a list of table in the workbook. + # Retrieves a list of table in the workbook. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + sessionId - The ID of the session @@ -1820,16 +1825,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Tables` or else an error on failure - remote isolated function listWorkbookTables(string itemIdOrPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Table[]|error { - excel:Tables tables; + # + return - A list of `Table` or else an error on failure + remote isolated function listWorkbookTables(string itemIdOrPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Table[]|error { + Tables tables; if isItemPath(itemIdOrPath) { tables = check self.excelClient->listWorkbookTablesWithItemPath(itemIdOrPath, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { tables = check self.excelClient->listWorkbookTables(itemIdOrPath, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Table[]? value = tables.value; - return value is excel:Table[] ? value : []; + Table[]? value = tables.value; + return value is Table[] ? value : []; } # Deletes the table from the workbook. @@ -1851,8 +1856,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + table - The properties of the table to be updated # + sessionId - The ID of the session - # + return - An `excel:Table` or else an error on failure - remote isolated function updateWorkbookTable(string itemIdOrPath, string tableIdOrName, excel:Table 'table, string? sessionId = ()) returns excel:Table|error { + # + return - A `Table` or else an error on failure + remote isolated function updateWorkbookTable(string itemIdOrPath, string tableIdOrName, Table 'table, string? sessionId = ()) returns Table|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorkbookTableWithItemPath(itemIdOrPath, tableIdOrName, 'table, sessionId); } @@ -1880,8 +1885,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + table - The properties of the table to be updated # + sessionId - The ID of the session - # + return - An `excel:Table` or else an error on failure - remote isolated function updateWorksheetTable(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, excel:Table 'table, string? sessionId = ()) returns excel:Table|error { + # + return - A `Table` or else an error on failure + remote isolated function updateWorksheetTable(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, Table 'table, string? sessionId = ()) returns Table|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorksheetTableWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, 'table, sessionId); } @@ -1893,8 +1898,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorkbookTableBodyRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorkbookTableBodyRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableBodyRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); } @@ -1907,8 +1912,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetTableBodyRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetTableBodyRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableBodyRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); } @@ -1920,8 +1925,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorkbookTableHeaderRowRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorkbookTableHeaderRowRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableHeaderRowRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); } @@ -1934,8 +1939,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetTableHeaderRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetTableHeaderRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableHeaderRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); } @@ -1947,8 +1952,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorkbookTableTotalRowRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorkbookTableTotalRowRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableTotalRowRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); } @@ -1961,8 +1966,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetTableTotalRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetTableTotalRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableTotalRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); } @@ -2001,8 +2006,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function convertWorkbookTableToRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function convertWorkbookTableToRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->convertWorkbookTableToRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); } @@ -2015,8 +2020,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function convertWorksheetTableToRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function convertWorksheetTableToRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->convertWorksheetTableToRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); } @@ -2028,7 +2033,7 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `http:Response` or else an error on failure + # + return - A `http:Response` or else an error on failure remote isolated function reapplyWorkbookTableFilters(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->reapplyWorkbookTableFiltersWithItemPath(itemIdOrPath, tableIdOrName, sessionId); @@ -2042,7 +2047,7 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `http:Response` or else an error on failure + # + return - A `http:Response` or else an error on failure remote isolated function reapplyWorksheetTableFilters(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->reapplyWorksheetTableFiltersWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); @@ -2050,7 +2055,7 @@ public isolated client class Client { return self.excelClient->reapplyWorksheetTableFilters(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); } - # Retrieve the properties and relationships of table sort. + # Retrieves the properties and relationships of table sort. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -2064,15 +2069,15 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:TableSort` or else an error on failure - remote isolated function getWorkbookTableSort(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:TableSort|error { + # + return - A `TableSort` or else an error on failure + remote isolated function getWorkbookTableSort(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns TableSort|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableSortWithItemPath(itemIdOrPath, tableIdOrName, sessionId); } return self.excelClient->getWorkbookTableSort(itemIdOrPath, tableIdOrName, sessionId); } - # Retrieve the properties and relationships of table sort. + # Retrieves the properties and relationships of table sort. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2087,15 +2092,15 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:TableSort` or else an error on failure - remote isolated function getWorksheetTableSort(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:TableSort|error { + # + return - A `TableSort` or else an error on failure + remote isolated function getWorksheetTableSort(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns TableSort|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableSortWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); } return self.excelClient->getWorksheetTableSort(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); } - # Perform a sort operation to the table. + # Performs a sort operation to the table. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -2108,7 +2113,7 @@ public isolated client class Client { return self.excelClient->performWorkbookTableSort(itemIdOrPath, tableIdOrName, sessionId); } - # Perform a sort operation to the table. + # Performs a sort operation to the table. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2116,7 +2121,7 @@ public isolated client class Client { # + tableSort - The properties to the sort operation # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function performWorksheetTableSort(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, excel:TableSort tableSort, string? sessionId = ()) returns http:Response|error { + remote isolated function performWorksheetTableSort(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, TableSort tableSort, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->performWorksheetTableSortWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, tableSort, sessionId); } @@ -2182,29 +2187,29 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorkbookTableRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorkbookTableRange(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableRangeWithItemPath(itemIdOrPath, tableIdOrName, sessionId); } return self.excelClient->getWorkbookTableRange(itemIdOrPath, tableIdOrName, sessionId); } - # Get the range associated with the entire table. + # Gets the range associated with the entire table. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetTableRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetTableRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); } return self.excelClient->getWorksheetTableRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); } - # Retrieve a list of table row in the worksheet. + # Retrieves a list of table row in the worksheet. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2219,16 +2224,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Rows` or else an error on failure - remote isolated function listWorksheetTableRows(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Row[]|error { - excel:Rows rows; + # + return - A lost of `Row` or else an error on failure + remote isolated function listWorksheetTableRows(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row[]|error { + Rows rows; if isItemPath(itemIdOrPath) { rows = check self.excelClient->listWorksheetTableRowsWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { rows = check self.excelClient->listWorksheetTableRows(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Row[]? value = rows.value; - return value is excel:Row[] ? value : []; + Row[]? value = rows.value; + return value is Row[] ? value : []; } # Adds rows to the end of a table in the worksheet. @@ -2238,15 +2243,15 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + row - The properties of the table row to be created # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function createWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, excel:Row row, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function createWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, Row row, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->createWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, row, sessionId); } return self.excelClient->createWorksheetTableRow(itemIdOrPath, worksheetIdOrName, tableIdOrName, row, sessionId); } - # Update the properties of table row. + # Updates the properties of table row. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2254,8 +2259,8 @@ public isolated client class Client { # + rowIndex - The index of the table row # + row - The properties of the table row to be updated # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function updateWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int rowIndex, excel:Row row, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function updateWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int rowIndex, Row row, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, rowIndex, row, sessionId); } @@ -2268,8 +2273,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + row - The properties of the table row to be added # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function addWorkbookTableRow(string itemIdOrPath, string tableIdOrName, excel:Row row, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function addWorkbookTableRow(string itemIdOrPath, string tableIdOrName, Row row, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, row, sessionId); } @@ -2283,8 +2288,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + row - The properties of the table row to be added # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function addWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, excel:Row row, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function addWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, Row row, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, row, sessionId); } @@ -2298,15 +2303,15 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Row` or else an error on failure - remote isolated function getWorksheetTableRowWithIndex(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function getWorksheetTableRowWithIndex(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableRowWithIndexItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); } return self.excelClient->getWorksheetTableRowWithIndex(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); } - # Retrieve the properties and relationships of table row. + # Retrieves the properties and relationships of table row. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2322,8 +2327,8 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Row` or else an error on failure - remote isolated function getWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Row|error { + # + return - A `Row` or else an error on failure + remote isolated function getWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } @@ -2345,22 +2350,22 @@ public isolated client class Client { return self.excelClient->deleteWorksheetTableRow(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); } - # Get the range associated with the entire row. + # Gets the range associated with the entire row. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getWorksheetTableRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getWorksheetTableRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); } return self.excelClient->getWorksheetTableRowRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); } - # Retrieve a list of table column in the workbook. + # Retrieves a list of table column in the workbook. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -2374,19 +2379,19 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Columns` or else an error on failure - remote isolated function listWorkbookTableColumns(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Column[]|error { - excel:Columns columns; + # + return - A list of `Column` or else an error on failure + remote isolated function listWorkbookTableColumns(string itemIdOrPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Column[]|error { + Columns columns; if isItemPath(itemIdOrPath) { columns = check self.excelClient->listWorkbookTableColumnsWithItemPath(itemIdOrPath, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { columns = check self.excelClient->listWorkbookTableColumns(itemIdOrPath, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Column[]? value = columns.value; - return value is excel:Column[] ? value : []; + Column[]? value = columns.value; + return value is Column[] ? value : []; } - # Retrieve a list of table column in the workbook. + # Retrieves a list of table column in the workbook. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2401,41 +2406,41 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Columns` or else an error on failure - remote isolated function listWorksheetTableColumns(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Column[]|error { - excel:Columns columns; + # + return - A list of `Column` or else an error on failure + remote isolated function listWorksheetTableColumns(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Column[]|error { + Columns columns; if isItemPath(itemIdOrPath) { columns = check self.excelClient->listWorksheetTableColumnsWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { columns = check self.excelClient->listWorksheetTableColumns(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:Column[]? value = columns.value; - return value is excel:Column[] ? value : []; + Column[]? value = columns.value; + return value is Column[] ? value : []; } - # Create a new table column in the workbook. + # Creates a new table column in the workbook. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + column - The properties of the table column to be created # + sessionId - The ID of the session - # + return - An `excel:Column` or else an error on failure - remote isolated function createWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, excel:Column column, string? sessionId = ()) returns excel:Column|error { + # + return - A `Column` or else an error on failure + remote isolated function createWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, Column column, string? sessionId = ()) returns Column|error { if isItemPath(itemIdOrPath) { return self.excelClient->createWorkbookTableColumnWithItemPath(itemIdOrPath, tableIdOrName, column, sessionId); } return self.excelClient->createWorkbookTableColumn(itemIdOrPath, tableIdOrName, column, sessionId); } - # Create a new table column in the workbook. + # Creates a new table column in the workbook. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + column - The properties of the table column to be created # + sessionId - The ID of the session - # + return - An `excel:Column` or else an error on failure - remote isolated function createWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, excel:Column column, string? sessionId = ()) returns excel:Column|error { + # + return - A `Column` or else an error on failure + remote isolated function createWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, Column column, string? sessionId = ()) returns Column|error { if isItemPath(itemIdOrPath) { return self.excelClient->createWorksheetTableColumnWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, column, sessionId); } @@ -2456,7 +2461,7 @@ public isolated client class Client { return self.excelClient->deleteWorkbookTableColumn(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } - # Delete a column from a table. + # Deletes a column from a table. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2471,7 +2476,7 @@ public isolated client class Client { return self.excelClient->deleteWorksheetTableColumn(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } - # Retrieve the properties and relationships of table column. + # Retrieves the properties and relationships of table column. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table @@ -2486,15 +2491,15 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Column` or else an error on failure - remote isolated function getWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Column|error { + # + return - A `Column` or else an error on failure + remote isolated function getWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Column|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorkbookTableColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } return self.excelClient->getWorkbookTableColumn(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } - # Retrieve the properties and relationships of table column. + # Retrieves the properties and relationships of table column. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2510,15 +2515,15 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:Column` or else an error on failure - remote isolated function getWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:Column|error { + # + return - A `Column` or else an error on failure + remote isolated function getWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Column|error { if isItemPath(itemIdOrPath) { return self.excelClient->getWorksheetTableColumnWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } return self.excelClient->getWorksheetTableColumn(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } - # Update the properties of table column + # Updates the properties of table column. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2526,8 +2531,8 @@ public isolated client class Client { # + columnIdOrName - The ID or name of the column # + column - The properties of the table column to be updated # + sessionId - The ID of the session - # + return - An `excel:Column` or else an error on failure - remote isolated function updateWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, excel:Column column, string? sessionId = ()) returns excel:Column|error { + # + return - A `Column` or else an error on failure + remote isolated function updateWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, Column column, string? sessionId = ()) returns Column|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorksheetTableColumnWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, column, sessionId); } @@ -2535,44 +2540,44 @@ public isolated client class Client { } - # Update the properties of table column + # Updates the properties of table column. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column - # + column - + # + column - The properties of the table column to be updated # + sessionId - The ID of the session - # + return - An `excel:Column` or else an error on failure - remote isolated function updateWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, excel:Column column, string? sessionId = ()) returns excel:Column|error { + # + return - An `Column` or else an error on failure + remote isolated function updateWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, Column column, string? sessionId = ()) returns Column|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateWorkbookTableColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, column, sessionId); } return self.excelClient->updateWorkbookTableColumn(itemIdOrPath, tableIdOrName, columnIdOrName, column, sessionId); } - # Gets the range associated with the data body of the column + # Gets the range associated with the data body of the column. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Column` or else an error on failure - remote isolated function getworkbookTableColumnsDataBodyRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Column` or else an error on failure + remote isolated function getworkbookTableColumnsDataBodyRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getworkbookTableColumnsDataBodyRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } return self.excelClient->getworkbookTableColumnsDataBodyRange(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } - # Gets the range associated with the data body of the column + # Gets the range associated with the data body of the column. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getworksheetTableColumnsDataBodyRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getworksheetTableColumnsDataBodyRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getworksheetTableColumnsDataBodyRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } @@ -2585,8 +2590,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getworkbookTableColumnsHeaderRowRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getworkbookTableColumnsHeaderRowRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getworkbookTableColumnsHeaderRowRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -2600,8 +2605,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getworksheetTableColumnsHeaderRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getworksheetTableColumnsHeaderRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getworksheetTableColumnsHeaderRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } @@ -2614,8 +2619,8 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getworkbookTableColumnsTotalRowRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getworkbookTableColumnsTotalRowRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getworkbookTableColumnsTotalRowRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); } @@ -2629,22 +2634,22 @@ public isolated client class Client { # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - An `excel:Range` or else an error on failure - remote isolated function getworksheetTableColumnsTotalRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + # + return - A `Range` or else an error on failure + remote isolated function getworksheetTableColumnsTotalRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getworksheetTableColumnsTotalRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } return self.excelClient->getworksheetTableColumnsTotalRowRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); } - # Retrieve the properties and relationships of chart. + # Retrieves the properties and relationships of chart. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart # + sessionId - The ID of the session - # + return - An `excel:Chart` or else an error on failure - remote isolated function getChart(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns excel:Chart|error { + # + return - A `Chart` or else an error on failure + remote isolated function getChart(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Chart|error { if isItemPath(itemIdOrPath) { return self.excelClient->getChartWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); } @@ -2665,15 +2670,15 @@ public isolated client class Client { return self.excelClient->deleteChart(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); } - # Update the properties of chart. + # Updates the properties of chart. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart # + chart - The properties of the chart to be updated # + sessionId - The ID of the session - # + return - An `excel:Chart` or else an error on failure - remote isolated function updateChart(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, excel:Chart chart, string? sessionId = ()) returns excel:Chart|error { + # + return - A `Chart` or else an error on failure + remote isolated function updateChart(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, Chart chart, string? sessionId = ()) returns Chart|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateChartWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, chart, sessionId); } @@ -2688,14 +2693,14 @@ public isolated client class Client { # + resetData - The properties of the reset data # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function resetChartData(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, excel:ResetData resetData, string? sessionId = ()) returns http:Response|error { + remote isolated function resetChartData(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, ResetData resetData, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->resetChartDataWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, resetData, sessionId); } return self.excelClient->resetChartData(itemIdOrPath, worksheetIdOrName, chartIdOrName, resetData, sessionId); } - # Positions the chart relative to cells on the worksheet + # Positions the chart relative to cells on the worksheet. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2703,14 +2708,14 @@ public isolated client class Client { # + position - the properties of the position # + sessionId - The ID of the session # + return - An `http:Response` or else an error on failure - remote isolated function setChartPosition(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, excel:Position position, string? sessionId = ()) returns http:Response|error { + remote isolated function setChartPosition(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, Position position, string? sessionId = ()) returns http:Response|error { if isItemPath(itemIdOrPath) { return self.excelClient->setChartPositionWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, position, sessionId); } return self.excelClient->setChartPosition(itemIdOrPath, worksheetIdOrName, chartIdOrName, position, sessionId); } - # Retrieve a list of chart series . + # Retrieves a list of chart series . # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + worksheetIdOrName - The ID or name of the worksheet @@ -2725,16 +2730,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:CollectionOfChartSeries` or else an error on failure - remote isolated function listChartSeries(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:ChartSeries[]|error { - excel:CollectionOfChartSeries chartSeries; + # + return - A list of `ChartSeries` or else an error on failure + remote isolated function listChartSeries(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns ChartSeries[]|error { + CollectionOfChartSeries chartSeries; if isItemPath(itemIdOrPath) { chartSeries = check self.excelClient->listChartSeriesWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { chartSeries = check self.excelClient->listChartSeries(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:ChartSeries[]? value = chartSeries.value; - return value is excel:ChartSeries[] ? value : []; + ChartSeries[]? value = chartSeries.value; + return value is ChartSeries[] ? value : []; } # Gets a chart based on its position in the collection. @@ -2743,8 +2748,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - An `excel:Chart` or else an error on failure - remote isolated function getChartBasedOnPosition(string itemIdOrPath, string worksheetIdOrName, int index, string? sessionId = ()) returns excel:Chart|error { + # + return - An `Chart` or else an error on failure + remote isolated function getChartBasedOnPosition(string itemIdOrPath, string worksheetIdOrName, int index, string? sessionId = ()) returns Chart|error { if isItemPath(itemIdOrPath) { return self.excelClient->getChartBasedOnPositionWithItemPath(itemIdOrPath, worksheetIdOrName, index, sessionId); } @@ -2757,8 +2762,8 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart # + sessionId - The ID of the session - # + return - An `excel:Image` or else an error on failure - remote isolated function getChartImage(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns excel:Image|error { + # + return - An `Image` or else an error on failure + remote isolated function getChartImage(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { if isItemPath(itemIdOrPath) { return self.excelClient->getChartImageWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); } @@ -2772,8 +2777,8 @@ public isolated client class Client { # + chartIdOrName - The ID or name of the chart # + width - The desired width of the resulting image. # + sessionId - The ID of the session - # + return - An `excel:Image` or else an error on failure - remote isolated function getChartImageWithWidth(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns excel:Image|error { + # + return - An `Image` or else an error on failure + remote isolated function getChartImageWithWidth(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns Image|error { if isItemPath(itemIdOrPath) { return self.excelClient->getChartImageWithWidthItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, sessionId); } @@ -2788,8 +2793,8 @@ public isolated client class Client { # + width - The desired width of the resulting image. # + height - The desired height of the resulting image. # + sessionId - The ID of the session - # + return - An `excel:Image` or else an error on failure - remote isolated function getChartImageWithWidthHeight(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns excel:Image|error { + # + return - An `Image` or else an error on failure + remote isolated function getChartImageWithWidthHeight(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { if isItemPath(itemIdOrPath) { return self.excelClient->getChartImageWithWidthHeightItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, height, sessionId); } @@ -2805,8 +2810,8 @@ public isolated client class Client { # + height - The desired height of the resulting image. # + fittingMode - The method used to scale the chart to the specified dimensions (if both height and width are set)." # + sessionId - The ID of the session - # + return - An `excel:Image` or else an error on failure - remote isolated function getChartImageWithWidthHeightFittingMode(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns excel:Image|error { + # + return - An `Image` or else an error on failure + remote isolated function getChartImageWithWidthHeightFittingMode(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { if isItemPath(itemIdOrPath) { return self.excelClient->getChartImageWithWidthHeightFittingModeItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, height, fittingMode, sessionId); } @@ -2826,16 +2831,16 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:NamedItems` or else an error on failure - remote isolated function listNamedItem(string itemIdOrPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:NamedItem[]|error { - excel:NamedItems namedItems; + # + return - A list of `NamedItem` or else an error on failure + remote isolated function listNamedItem(string itemIdOrPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItem[]|error { + NamedItems namedItems; if isItemPath(itemIdOrPath) { namedItems = check self.excelClient->listNamedItemWithItemPath(itemIdOrPath, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } else { namedItems = check self.excelClient->listNamedItem(itemIdOrPath, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - excel:NamedItem[]? value = namedItems.value; - return value is excel:NamedItem[] ? value : []; + NamedItem[]? value = namedItems.value; + return value is NamedItem[] ? value : []; } # Adds a new name to the collection of the given scope using the user's locale for the formula. @@ -2843,8 +2848,8 @@ public isolated client class Client { # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + namedItem - The properties of the named item to be added # + sessionId - The ID of the session - # + return - An `excel:NamedItem` or else an error on failure - remote isolated function addWorkbookNamedItem(string itemIdOrPath, excel:NewNamedItem namedItem, string? sessionId = ()) returns excel:NamedItem|error { + # + return - A `NamedItem` or else an error on failure + remote isolated function addWorkbookNamedItem(string itemIdOrPath, NewNamedItem namedItem, string? sessionId = ()) returns NamedItem|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorkbookNamedItemWithItemPath(itemIdOrPath, namedItem, sessionId); } @@ -2857,15 +2862,15 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + namedItem - The properties of the named item to be added # + sessionId - The ID of the session - # + return - An `excel:NamedItem` or else an error on failure - remote isolated function addWorksheetNamedItem(string itemIdOrPath, string worksheetIdOrName, excel:NewNamedItem namedItem, string? sessionId = ()) returns excel:NamedItem|error { + # + return - A `NamedItem` or else an error on failure + remote isolated function addWorksheetNamedItem(string itemIdOrPath, string worksheetIdOrName, NewNamedItem namedItem, string? sessionId = ()) returns NamedItem|error { if isItemPath(itemIdOrPath) { return self.excelClient->addWorksheetNamedItemWithItemPath(itemIdOrPath, worksheetIdOrName, namedItem, sessionId); } return self.excelClient->addWorksheetNamedItem(itemIdOrPath, worksheetIdOrName, namedItem, sessionId); } - # Retrieve the properties and relationships of the named item. + # Retrieves the properties and relationships of the named item. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item to get. @@ -2879,35 +2884,35 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - An `excel:NamedItem` or else an error on failure - remote isolated function getNamedItem(string itemIdOrPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns excel:NamedItem|error { + # + return - A `NamedItem` or else an error on failure + remote isolated function getNamedItem(string itemIdOrPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderBy = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItem|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNamedItemWithItemPath(itemIdOrPath, name, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } return self.excelClient->getNamedItem(itemIdOrPath, name, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); } - # Update the properties of the named item. + # Updates the properties of the named item. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item to get # + namedItem - The properties of the named item to be updated # + sessionId - The ID of the session - # + return - An `excel:NamedItem` or else an error on failure - remote isolated function updateNamedItem(string itemIdOrPath, string name, excel:NamedItem namedItem, string? sessionId = ()) returns excel:NamedItem|error { + # + return - A `NamedItem` or else an error on failure + remote isolated function updateNamedItem(string itemIdOrPath, string name, NamedItem namedItem, string? sessionId = ()) returns NamedItem|error { if isItemPath(itemIdOrPath) { return self.excelClient->updateNamedItemWithItemPath(itemIdOrPath, name, namedItem, sessionId); } return self.excelClient->updateNamedItem(itemIdOrPath, name, namedItem, sessionId); } - # Retrieve the range object that is associated with the name. + # Retrieves the range object that is associated with the name. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + name - The name of the named item to get. # + sessionId - The ID of the session - # + return - An `excel:NamedItem` or else an error on failure - remote isolated function getNamedItemRange(string itemIdOrPath, string name, string? sessionId = ()) returns excel:Range|error { + # + return - A `NamedItem` or else an error on failure + remote isolated function getNamedItemRange(string itemIdOrPath, string name, string? sessionId = ()) returns Range|error { if isItemPath(itemIdOrPath) { return self.excelClient->getNamedItemRangeWithItemPath(itemIdOrPath, name, sessionId); } diff --git a/ballerina/modules/excel/client.bal b/ballerina/modules/excel/client.bal index 4d33e96..3f16b8c 100644 --- a/ballerina/modules/excel/client.bal +++ b/ballerina/modules/excel/client.bal @@ -455,37 +455,6 @@ public isolated client class Client { Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the row from the workbook table. - # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + index - Index value of the object to be retrieved. Zero-indexed. - # + sessionId - The ID of the session - # + return - OK - remote isolated function deleteWorkbookTableRow(string itemId, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); - return response; - } - # Updates the properties of table row. - # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + index - Index value of the object to be retrieved. Zero-indexed. - # + sessionId - The ID of the session - # + return - Success. - remote isolated function updateWorkbookTableRow(string itemId, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); - return response; - } # Retrieves the properties and relationships of table row. # # + itemPath - The full path of the workbook @@ -511,77 +480,77 @@ public isolated client class Client { Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the row from the workbook table. + # Gets the range associated with the entire row. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function deleteWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; + remote isolated function getWorkbookTableRowRange(string itemId, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Updates the properties of table row. + # Gets the range associated with the entire row. # # + itemPath - The full path of the workbook # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - Success. - remote isolated function updateWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; + # + return - OK + remote isolated function getWorkbookTableRowRangeWithItemPath(string itemPath, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range associated with the entire row. + # Gets a row based on its position in the collection. # # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function getWorkbookTableRowRange(string itemId, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; + remote isolated function getWorkbookTableRowWithIndex(string itemId, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range associated with the entire row. + # Deletes the row from the workbook table. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function getWorkbookTableRowRangeWithItemPath(string itemPath, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; + remote isolated function deleteWorkbookTableRow(string itemId, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); return response; } - # Gets a row based on its position in the collection. + # Updates the properties of table row. # # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - OK - remote isolated function getWorkbookTableRowWithIndex(string itemId, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { + # + return - Success. + remote isolated function updateWorkbookTableRow(string itemId, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { string resourcePath = string `/me/drive/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Row response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } # Gets a row based on its position in the collection. @@ -598,6 +567,37 @@ public isolated client class Client { Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } + # Deletes the row from the workbook table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + index - Index value of the object to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Updates the properties of table row. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + index - Index value of the object to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - Success. + remote isolated function updateWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } # Adds rows to the end of the table. # # + itemId - The ID of the drive containing the workbook @@ -4773,42 +4773,49 @@ public isolated client class Client { Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a row based on its position in the collection. + # Deletes the row from the workbook table. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function getWorksheetTableRowWithIndexItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; + remote isolated function deleteWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Row response = check self.clientEp->get(resourcePath, httpHeaders); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); return response; } - # Retrieve the properties and relationships of table row. + # Update the properties of table row. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + count - Retrieves the total count of matching resources - # + expand - Retrieves related resources - # + filter - Filters results - # + format - Returns the results in the specified media format - # + orderby - Orders results - # + search - Returns results based on search criteria - # + 'select - Filters properties(columns) - # + skip - Indexes into a result set - # + top - Sets the page size of results + # + return - Success. + remote isolated function updateWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Gets a row based on its position in the collection. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table + # + index - Index value of the object to be retrieved. Zero-indexed. + # + sessionId - The ID of the session # + return - OK - remote isolated function getWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; - map queryParam = {"$count": count, "$expand": expand, "$filter": filter, "$format": format, "$orderby": orderby, "$search": search, "$select": 'select, "$skip": skip, "$top": top}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); + remote isolated function getWorksheetTableRowWithIndexItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Row response = check self.clientEp->get(resourcePath, httpHeaders); @@ -4816,14 +4823,14 @@ public isolated client class Client { } # Deletes the row from the workbook table. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function deleteWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; + remote isolated function deleteWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); @@ -4831,14 +4838,14 @@ public isolated client class Client { } # Update the properties of table row. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - Success. - remote isolated function updateWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; + remote isolated function updateWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; @@ -4849,7 +4856,7 @@ public isolated client class Client { } # Retrieve the properties and relationships of table row. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. @@ -4864,8 +4871,8 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK - remote isolated function getWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; + remote isolated function getWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; map queryParam = {"$count": count, "$expand": expand, "$filter": filter, "$format": format, "$orderby": orderby, "$search": search, "$select": 'select, "$skip": skip, "$top": top}; resourcePath = resourcePath + check getPathForQueryParam(queryParam); map headerValues = {"sessionId": sessionId}; @@ -4873,37 +4880,30 @@ public isolated client class Client { Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the row from the workbook table. + # Retrieve the properties and relationships of table row. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves related resources + # + filter - Filters results + # + format - Returns the results in the specified media format + # + orderby - Orders results + # + search - Returns results based on search criteria + # + 'select - Filters properties(columns) + # + skip - Indexes into a result set + # + top - Sets the page size of results # + return - OK - remote isolated function deleteWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); - return response; - } - # Update the properties of table row. - # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + tableIdOrName - The ID or name of the table - # + index - Index value of the object to be retrieved. Zero-indexed. - # + sessionId - The ID of the session - # + return - Success. - remote isolated function updateWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, Row payload, string? sessionId = ()) returns Row|error { + remote isolated function getWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Row|error { string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/${getEncodedUri(index)}`; + map queryParam = {"$count": count, "$expand": expand, "$filter": filter, "$format": format, "$orderby": orderby, "$search": search, "$select": 'select, "$skip": skip, "$top": top}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } # Get the range associated with the entire row. diff --git a/ballerina/modules/excel/types.bal b/ballerina/modules/excel/types.bal index ded0131..d89f9a9 100644 --- a/ballerina/modules/excel/types.bal +++ b/ballerina/modules/excel/types.bal @@ -87,7 +87,7 @@ public type RangeView record { # Represents the formula in A1-style notation record {} formulas?; # Represents the formula in A1-style notation, in the user's language and number-formatting locale - string formulasLocal?; + (string|int)[][] formulasLocal?; # Represents the formula in R1C1-style notation record {} formulasR1C1?; # Index of the range @@ -99,7 +99,7 @@ public type RangeView record { # Text values of the specified range record {} text?; # Represents the type of data of each cell - "Unknown"|"Empty"|"String"|"Integer"|"Double"|"Boolean"|"Error" valueTypes?; + ("Unknown"|"Empty"|"String"|"Integer"|"Double"|"Boolean"|"Error")[][] valueTypes?; # Represents the raw values of the specified range (string|int|decimal?)[][]? values?; }; @@ -379,7 +379,7 @@ public type Range record { # The formula in A1-style notation (string|int)[][]? formulas?; # The formula in A1-style notation, in the user's language and number-formatting locale - string? formulasLocal?; + (string|int)[][]? formulasLocal?; # The formula in R1C1-style notation (string|int)[][]? formulasR1C1?; # Represents if all cells of the current range are hidden @@ -395,7 +395,7 @@ public type Range record { # Text values of the specified range (string|int)[][]? text?; # Represents the type of data of each cell - "Unknown"|"Empty"|"String"|"Integer"|"Double"|"Boolean"|"Error" valueTypes?; + ("Unknown"|"Empty"|"String"|"Integer"|"Double"|"Boolean"|"Error")[][] valueTypes?; # Represents the raw values of the specified range (string|int|decimal?)[][]? values?; }; @@ -462,8 +462,6 @@ public type CollectionOfChartSeries record { # Represents the table row properties. public type Row record { - # The ID of the table row - string id?; # The index of the table row int index?; # The values in the table row diff --git a/ballerina/tests/test.bal b/ballerina/tests/test.bal index 80c3845..19d3505 100644 --- a/ballerina/tests/test.bal +++ b/ballerina/tests/test.bal @@ -15,11 +15,10 @@ // under the License. import ballerina/os; -import ballerina/io; import ballerina/log; import ballerina/test; -import microsoft.excel.excel; import ballerina/http; +import ballerina/lang.runtime; configurable string clientId = os:getEnv("CLIENT_ID"); configurable string clientSecret = os:getEnv("CLIENT_SECRET"); @@ -27,7 +26,7 @@ configurable string refreshToken = os:getEnv("REFRESH_TOKEN"); configurable string refreshUrl = os:getEnv("REFRESH_URL"); configurable string workbookIdOrPath = os:getEnv("WORKBOOK_PATH"); -excel:ConnectionConfig configuration = { +ConnectionConfig configuration = { auth: { clientId: clientId, clientSecret: clientSecret, @@ -45,18 +44,18 @@ string sessionId = EMPTY_STRING; string columnName = EMPTY_STRING; string rowId = EMPTY_STRING; int sheetPosition = 1; -excel:Worksheet sheet = {position: sheetPosition}; +Worksheet sheet = {position: sheetPosition}; int rowIndex = 2; boolean showHeaders = false; int columnInputIndex = 2; -excel:Table updateTable = { +Table updateTable = { showHeaders: showHeaders, showTotals: false }; @test:BeforeSuite function testCreateSession() { - excel:Session|error response = excelClient->createSession(workBookId, {persistChanges: false}); + Session|error response = excelClient->createSession(workBookId, {persistChanges: false}); if response is error { test:assertFail(response.toString()); } @@ -64,8 +63,8 @@ function testCreateSession() { @test:Config {} function testAddWorksheet() { - excel:Worksheet|error response = excelClient->addWorksheet(workBookId, {name: worksheetName}, sessionId); - if response is excel:Worksheet { + Worksheet|error response = excelClient->addWorksheet(workBookId, {name: worksheetName}, sessionId); + if response is Worksheet { string name = response?.name ?: EMPTY_STRING; test:assertEquals(name, worksheetName, "Unmatch worksheet name"); } else { @@ -75,8 +74,9 @@ function testAddWorksheet() { @test:Config {dependsOn: [testAddWorksheet]} function testGetWorksheet() { - excel:Worksheet|error response = excelClient->getWorksheet(workBookId, worksheetName, sessionId); - if response is excel:Worksheet { + runtime:sleep(5); + Worksheet|error response = excelClient->getWorksheet(workBookId, worksheetName, sessionId); + if response is Worksheet { string name = response?.name ?: EMPTY_STRING; test:assertEquals(name, worksheetName, "Worksheet not found"); } else { @@ -86,8 +86,8 @@ function testGetWorksheet() { @test:Config {dependsOn: [testGetWorksheet]} function testListWorksheets() { - excel:Worksheet[]|error response = excelClient->listWorksheets(workBookId, sessionId = sessionId); - if response is excel:Worksheet[] { + Worksheet[]|error response = excelClient->listWorksheets(workBookId, sessionId = sessionId); + if response is Worksheet[] { string responseWorksheetName = response[0]?.name ?: EMPTY_STRING; test:assertNotEquals(responseWorksheetName, EMPTY_STRING, "Found 0 worksheets"); } else { @@ -97,8 +97,8 @@ function testListWorksheets() { @test:Config {dependsOn: [testDeleteTable]} function testUpdateWorksheet() { - excel:Worksheet|error response = excelClient->updateWorksheet(workBookId, worksheetName, sheet, sessionId); - if response is excel:Worksheet { + Worksheet|error response = excelClient->updateWorksheet(workBookId, worksheetName, sheet, sessionId); + if response is Worksheet { int responsePosition = response?.position ?: 0; test:assertEquals(responsePosition, sheetPosition, "Unmatch worksheet position"); } else { @@ -108,8 +108,8 @@ function testUpdateWorksheet() { @test:Config {dependsOn: [testGetWorksheet]} function testGetCell() { - excel:Range|error response = excelClient->getWorksheetCell(workBookId, worksheetName, rowIndex, 7, sessionId); - if response is excel:Range { + Range|error response = excelClient->getWorksheetCell(workBookId, worksheetName, rowIndex, 7, sessionId); + if response is Range { int row = response.rowIndex; test:assertEquals(row, rowIndex, "Unmatch worksheet position"); } else { @@ -121,7 +121,7 @@ function testGetCell() { function testDeleteWorksheet() { http:Response|error response = excelClient->deleteWorksheet(workBookId, worksheetName, sessionId); if response is http:Response { - if response.statusCode != 404 { + if response.statusCode != 204 { test:assertFail(response.statusCode.toBalString()); } } else { @@ -131,8 +131,8 @@ function testDeleteWorksheet() { @test:Config {dependsOn: [testGetWorksheet]} function testAddTable() { - excel:Table|error response = excelClient->addWorksheetTable(workBookId, worksheetName, {address: "A1:C3"}, sessionId = sessionId); - if response is excel:Table { + Table|error response = excelClient->addWorksheetTable(workBookId, worksheetName, {address: "A1:C3"}, sessionId = sessionId); + if response is Table { tableName = response?.name ?: EMPTY_STRING; test:assertNotEquals(tableName, EMPTY_STRING, "Table is not created"); } else { @@ -142,8 +142,9 @@ function testAddTable() { @test:Config {dependsOn: [testAddTable]} function testGetTable() { - excel:Table|error response = excelClient->getWorksheetTable(workBookId, worksheetName, tableName, sessionId = sessionId); - if response is excel:Table { + runtime:sleep(5); + Table|error response = excelClient->getWorksheetTable(workBookId, worksheetName, tableName, sessionId = sessionId); + if response is Table { string responseTableName = response?.name ?: EMPTY_STRING; test:assertEquals(tableName, responseTableName, "Table is not created"); } else { @@ -154,8 +155,8 @@ function testGetTable() { @test:Config {dependsOn: [testGetTable]} function testListTable() { log:printInfo("excelClient -> listTables()"); - excel:Table[]|error response = excelClient->listWorkbookTables(workBookId, sessionId = sessionId); - if response is excel:Table[] { + Table[]|error response = excelClient->listWorkbookTables(workBookId, sessionId = sessionId); + if response is Table[] { string responseTableName = response[0]?.name ?: EMPTY_STRING; test:assertNotEquals(responseTableName, EMPTY_STRING, "Found 0 tables"); } else { @@ -165,10 +166,9 @@ function testListTable() { @test:Config {dependsOn: [testGetTable]} function testUpdateTable() { - excel:Table|error response = excelClient->updateWorksheetTable(workBookId, worksheetName, tableName, {style: "TableStyleMedium2"}, sessionId); - if response is excel:Table { - boolean responseTable = response?.showHeaders ?: true; - test:assertEquals(responseTable, showHeaders, "Table is not updated"); + Table|error response = excelClient->updateWorksheetTable(workBookId, worksheetName, tableName, {style: "TableStyleMedium2"}, sessionId); + if response is Table { + test:assertEquals(response?.style, "TableStyleMedium2", "Table is not updated"); } else { test:assertFail(response.toString()); } @@ -178,9 +178,8 @@ int rowInputIndex = 1; @test:Config {dependsOn: [testUpdateTable]} function testCreateRow() { - excel:Row|error response = excelClient->createWorksheetTableRow(workBookId, worksheetName, tableName, {values: [[1, 2, 3]], index: rowInputIndex}, sessionId); - if response is excel:Row { - rowId = response.id; + Row|error response = excelClient->createWorksheetTableRow(workBookId, worksheetName, tableName, {values: [[1, 2, 3]], index: rowInputIndex}, sessionId); + if response is Row { int responseIndex = response.index; test:assertEquals(responseIndex, rowInputIndex, "Row is not added"); } else { @@ -190,10 +189,9 @@ function testCreateRow() { @test:Config {dependsOn: [testCreateRow]} function testListRows() { - excel:Row[]|error response = excelClient->listWorksheetTableRows(workBookId, worksheetName, tableName, sessionId = sessionId); - if response is excel:Row[] { - int responseIndex = response[1].index; - test:assertEquals(responseIndex, rowInputIndex, "Found 0 rows"); + Row[]|error response = excelClient->listWorksheetTableRows(workBookId, worksheetName, tableName, sessionId = sessionId); + if response is Row[] { + test:assertEquals(response[1].index, rowInputIndex, "Found 0 rows"); } else { test:assertFail(response.toString()); } @@ -202,8 +200,8 @@ function testListRows() { @test:Config {dependsOn: [testCreateRow]} function testUpdateRow() { string value = "testValue"; - excel:Row|error response = excelClient->updateWorksheetTableRow(workBookId, worksheetName, tableName, rowInputIndex, {values: [[(), (), value]]},sessionId); - if response is excel:Row { + Row|error response = excelClient->updateWorksheetTableRow(workBookId, worksheetName, tableName, rowInputIndex, {index: rowInputIndex, values: [[(), 6, value]]},sessionId); + if response is Row { (string|int|decimal?)[][]? values = response.values; if values is () { test:assertFail("Row is not updated"); @@ -227,8 +225,8 @@ function testDeleteRow() { @test:Config {dependsOn: [testDeleteRow]} function testCreateColumn() { - excel:Column|error response = excelClient->createWorksheetTableColumn(workBookId, worksheetName, tableName, {index: columnInputIndex, values : [["a3"], ["c3"], ["aa"]]}, sessionId); - if response is excel:Column { + Column|error response = excelClient->createWorksheetTableColumn(workBookId, worksheetName, tableName, {index: columnInputIndex, values : [["a3"], ["a4"], ["a5"], ["a1"]]}, sessionId); + if response is Column { int responseIndex = response.index; columnName = response.name; test:assertEquals(responseIndex, columnInputIndex, "Column is not added"); @@ -239,8 +237,8 @@ function testCreateColumn() { @test:Config {dependsOn: [testCreateColumn]} function testListColumn() { - excel:Column[]|error response = excelClient->listWorksheetTableColumns(workBookId, worksheetName, tableName, sessionId = sessionId); - if response is excel:Column[] { + Column[]|error response = excelClient->listWorksheetTableColumns(workBookId, worksheetName, tableName, sessionId = sessionId); + if response is Column[] { int responseIndex = response[2].index; test:assertEquals(responseIndex, columnInputIndex, "Found 0 columns"); } else { @@ -251,10 +249,13 @@ function testListColumn() { @test:Config {dependsOn: [testCreateColumn]} function testUpdateColumn() { string value = "testName"; - io:println(columnName); - excel:Column|error response = excelClient->updateWorksheetTableColumn(workBookId, worksheetName, tableName, columnName, {values: [[()], [()], [value]]}, sessionId = sessionId); - if response is excel:Column { - test:assertEquals(response.values, value, "Column is not updated"); + Column|error response = excelClient->updateWorksheetTableColumn(workBookId, worksheetName, tableName, columnName, {values: [[()], [()], [value], [()]]}, sessionId = sessionId); + if response is Column { + (string|int|decimal?)[][]? values = response.values; + if values is () { + test:assertFail("Column is not updated"); + } + test:assertEquals(values[2][0], value, "Column is not updated"); } else { test:assertFail(response.toString()); } @@ -278,8 +279,8 @@ function testDeleteTable() { @test:Config {dependsOn: [testCreateRow]} function testAddChart() { - excel:Chart|error response = excelClient->addChart(workBookId, worksheetName, {'type: "ColumnStacked" , sourceData: "A1:B2", seriesBy: "Auto"}, sessionId); - if response is excel:Chart { + Chart|error response = excelClient->addChart(workBookId, worksheetName, {'type: "ColumnStacked" , sourceData: "A1:B2", seriesBy: "Auto"}, sessionId); + if response is Chart { chartName = response?.name; test:assertNotEquals(chartName, EMPTY_STRING, "Chart is not created"); } else { @@ -289,8 +290,9 @@ function testAddChart() { @test:Config {dependsOn: [testAddChart]} function testGetChart() { - excel:Chart|error response = excelClient->getChart(workBookId, worksheetName, chartName, sessionId = sessionId); - if response is excel:Chart { + runtime:sleep(5); + Chart|error response = excelClient->getChart(workBookId, worksheetName, chartName, sessionId = sessionId); + if response is Chart { string chartId = response?.id ?: EMPTY_STRING; test:assertNotEquals(chartId, EMPTY_STRING, "Chart not found"); } else { @@ -300,8 +302,8 @@ function testGetChart() { @test:Config {dependsOn: [testGetChart]} function testListChart() { - excel:Chart[]|error response = excelClient->listCharts(workBookId, worksheetName, sessionId = sessionId); - if response is excel:Chart[] { + Chart[]|error response = excelClient->listCharts(workBookId, worksheetName, sessionId = sessionId); + if response is Chart[] { string chartId = response[0]?.id ?: EMPTY_STRING; test:assertNotEquals(chartId, EMPTY_STRING, "Found 0 charts"); } else { @@ -310,15 +312,15 @@ function testListChart() { } decimal height = 99; -excel:Chart updateChart = { +Chart updateChart = { height: height, left: 99 }; @test:Config {dependsOn: [testListChart]} function testUpdateChart() { - excel:Chart|error response = excelClient->updateChart(workBookId, worksheetName, chartName, updateChart, sessionId); - if response is excel:Chart { + Chart|error response = excelClient->updateChart(workBookId, worksheetName, chartName, updateChart, sessionId); + if response is Chart { decimal responseHeight = response?.height ?: 0; test:assertEquals(responseHeight, height, "Chart is not updated"); } else { @@ -328,7 +330,7 @@ function testUpdateChart() { @test:Config {dependsOn: [testUpdateChart]} function testGetChartImage() { - excel:Image|error response = excelClient->getChartImage(workBookId, worksheetName, chartName, sessionId = sessionId); + Image|error response = excelClient->getChartImage(workBookId, worksheetName, chartName, sessionId = sessionId); if response is error { test:assertFail(response.toString()); } @@ -360,7 +362,7 @@ function testDeleteChart() { @test:Config {} function testGetWorkbookApplication() { - excel:Application|error response = excelClient->getApplication(workBookId, sessionId); + Application|error response = excelClient->getApplication(workBookId, sessionId); if response is error { test:assertFail(response.toString()); } diff --git a/ballerina/types.bal b/ballerina/types.bal new file mode 100644 index 0000000..d89f9a9 --- /dev/null +++ b/ballerina/types.bal @@ -0,0 +1,521 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + +import ballerina/http; + +# Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. +@display {label: "Connection Config"} +public type ConnectionConfig record {| + # Configurations related to client authentication + http:BearerTokenConfig|OAuth2RefreshTokenGrantConfig auth; + # The HTTP version understood by the client + http:HttpVersion httpVersion = http:HTTP_2_0; + # Configurations related to HTTP/1.x protocol + ClientHttp1Settings http1Settings?; + # Configurations related to HTTP/2 protocol + http:ClientHttp2Settings http2Settings?; + # The maximum time to wait (in seconds) for a response before closing the connection + decimal timeout = 60; + # The choice of setting `forwarded`/`x-forwarded` header + string forwarded = "disable"; + # Configurations associated with request pooling + http:PoolConfiguration poolConfig?; + # HTTP caching related configurations + http:CacheConfig cache?; + # Specifies the way of handling compression (`accept-encoding`) header + http:Compression compression = http:COMPRESSION_AUTO; + # Configurations associated with the behaviour of the Circuit Breaker + http:CircuitBreakerConfig circuitBreaker?; + # Configurations associated with retrying + http:RetryConfig retryConfig?; + # Configurations associated with inbound response size limits + http:ResponseLimitConfigs responseLimits?; + # SSL/TLS-related options + http:ClientSecureSocket secureSocket?; + # Proxy server related options + http:ProxyConfig proxy?; + # Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default + boolean validation = true; +|}; + +# Provides settings related to HTTP/1.x protocol. +public type ClientHttp1Settings record {| + # Specifies whether to reuse a connection for multiple requests + http:KeepAlive keepAlive = http:KEEPALIVE_AUTO; + # The chunking behaviour of the request + http:Chunking chunking = http:CHUNKING_AUTO; + # Proxy server related options + ProxyConfig proxy?; +|}; + +# Proxy server configurations to be used with the HTTP client endpoint. +public type ProxyConfig record {| + # Host name of the proxy server + string host = ""; + # Proxy server port + int port = 0; + # Proxy server username + string userName = ""; + # Proxy server password + @display {label: "", kind: "password"} + string password = ""; +|}; + +# OAuth2 Refresh Token Grant Configs +public type OAuth2RefreshTokenGrantConfig record {| + *http:OAuth2RefreshTokenGrantConfig; + # Refresh URL + string refreshUrl = "https://login.microsoftonline.com/organizations/oauth2/v2.0/token"; +|}; + +# Represents the properties to add a new name to the collection of the given scope using the user's locale for the formula. +public type FormulaLocal record { + # The name of the new named item + string name?; + # The formula or the range that the name will refer to + string formulas?; + # The formula or the range that the name will refer to + string comment?; +}; + +# Represents a range view. +public type RangeView record { + # Represents the cell addresses + record {} cellAddresses?; + # Returns the number of visible columns + int columnCount?; + # Represents the formula in A1-style notation + record {} formulas?; + # Represents the formula in A1-style notation, in the user's language and number-formatting locale + (string|int)[][] formulasLocal?; + # Represents the formula in R1C1-style notation + record {} formulasR1C1?; + # Index of the range + int index?; + # Represents Excel's number format code for the given cell + record {} numberFormat?; + # Returns the total number of rows in the range + int rowCount?; + # Text values of the specified range + record {} text?; + # Represents the type of data of each cell + ("Unknown"|"Empty"|"String"|"Integer"|"Double"|"Boolean"|"Error")[][] valueTypes?; + # Represents the raw values of the specified range + (string|int|decimal?)[][]? values?; +}; + +# Represents the properties of the named item +public type NamedItems record { + # Represents the list of the named item + NamedItem[] value?; +}; + +# Represents the range format. +public type RangeFormat record { + # Gets or sets the width of all columns within the range. If the column widths aren't uniform, null will be returned. + decimal columnWidth?; + # Represents the horizontal alignment for the specified object + "General"|"Left"|"Center"|"Right"|"Fill"|"Justify"|"CenterAcrossSelection"|"Distributed" horizontalAlignment?; + # Gets or sets the height of all rows in the range. If the row heights aren't uniform null will be returned. + decimal rowHeight?; + # Represents the horizontal alignment for the specified object + "Top"|"Center"|"Bottom"|"Justify"|"Distributed" verticalAlignment?; + # Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting. + boolean wrapText?; +}; + +# Represents the sorting for the table. +public type TableSort record { + # The current conditions used to last sort the table + SortField[] fields?; + # Represents whether the casing impacted the last sort of the table + boolean matchCase?; + # Represents Chinese character ordering method last used to sort the table + "PinYin"|"StrokeCount" method?; +}; + +# Represents the worksheet. +public type Worksheet record { + # The unique identifier of the worksheet + string id?; + # The name of the worksheet + string name?; + # The position of the worksheet in the workbook + int position?; + # The Visibility of the worksheet + "Visible"|"Hidden"|"VeryHidden" visibility?; +}; + +# Represents a list of chart. +public type Charts record { + # Represents the list of the chart + Chart[] value?; +}; + +# Represents worksheet name to create worksheet. +public type NewWorksheet record { + # Name of the new worksheet + string name?; +}; + +# Represents the current conditions used to last sort. +public type SortField record { + # Represents whether the sorting is done in an ascending fashion + boolean 'ascending?; + # Represents the color that is the target of the condition if the sorting is on font or cell color + string color?; + # Represents additional sorting options for this field + "Normal"|"TextAsNumber" dataOption?; + # Represents the icon that is the target of the condition if the sorting is on the cell's icon + Icon[] icon?; + # Represents the column (or row, depending on the sort orientation) that the condition is on + int 'key?; + # Represents the type of sorting of this condition + "Value"|"CellColor"|"FontColor"|"Icon" sortOn?; +}; + +# Represents the chart series. +public type ChartSeries record { + # The name of a series in a chart + string name?; +}; + +# Represents the properties to the merge range. +public type Across record { + # Set true to merge cells in each row of the specified range as separate merged cells + boolean across?; +}; + +# Represents an image. +public type Image record { + # The image in base64-encoded + string value?; +}; + +# Represents the properties to add new name to the collection of the given scope. +public type Item record { + # The name of the new named item + string name?; + # The type of the new named item + "Range"|"Formula"|"Text"|"Integer"|"Double"|"Boolean" 'type?; + # The reference to the object that the new named item refers to. + string reference?; + # The comment associated with the named item + string comment?; +}; + +# Represents the list of pivot table. +public type PivotTables record { + # The list of pivot table + PivotTable[] value?; +}; + +# Represents the table column. +public type Column record { + # A unique key that identifies the column within the table + string id?; + # The index number of the column within the columns collection of the table. + int index?; + # The name of the table column. + string name?; + # The raw values of the specified range + (string|int|decimal?)[][] values?; +}; + +# Represents the properties to clear range values +public type ApplyTo record { + # Determines the type of clear action + "All"|"Formats"|"Contents" applyTo?; +}; + +# Represents a list of tables. +public type Tables record { + # List of table + Table[] value?; +}; + +# Represents the range. +public type AnotherRange record { + # The range or address or range name + string anotherRange?; +}; + +# Represents the properties to create chart. +public type NewChart record { + # Represents the type of a chart + string 'type; + # The Range object corresponding to the source data + string sourceData; + # Specifies the way columns or rows are used as data series on the chart + "Auto"|"Columns"|"Rows" seriesBy; +}; + +# Represents the list of replies of the workbook comment. +public type Replies record { + # The list of replies of the workbook comment + Reply[] value?; +}; + +# Represents a list of range border. +public type RangeBorders record { + # The list of range border + RangeBorder[] value?; +}; + +# Represents the properties to recalculate all currently opened workbooks in Excel. +public type CalculationMode record { + # Specifies the calculation type to use + "Recalculate"|"Full"|"FullRebuild" calculationMode; +}; + +# Represents a chart properties. +public type Chart record { + # Represents the height, in points, of the chart object + decimal height?; + # Gets a chart based on its position in the collection + string id?; + # The distance, in points, from the left side of the chart to the worksheet origin + decimal left?; + # Represents the name of a chart object + string name?; + # Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart) + decimal top?; + # Represents the width, in points, of the chart + decimal width?; +}; + +# Represents the list of table row properties. +public type Rows record { + # The list of table row + Row[] value?; +}; + +# Represents the ways to shift the cells. +public type Shift record { + # Specifies which way to shift the cells + "Down"|"Right"|"Up"|"Left" shift?; +}; + +# Represents the workbook comment. +public type Comment record { + # The content of the comment + string content?; + # Indicates the type for the comment + string contentType?; + # Represents the comment identifier + string id?; +}; + +# Represents the properties to create table. +public type NewTable record { + # Address or name of the range object representing the data source + string address?; + # whether the data being imported has column labels + boolean hasHeaders?; +}; + +# Represents a table properties. +public type Table record { + # A value that uniquely identifies the table in a given workbook + string id?; + # The name of the table. + string name?; + # Indicates whether the first column contains special formatting + boolean highlightFirstColumn?; + # Indicates whether the last column contains special formatting + boolean highlightLastColumn?; + # Legacy ID used in older Excel clients + string legacyId?; + # Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier + boolean showBandedRows?; + # Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier + boolean showBandedColumns?; + # Indicates whether the filter buttons are visible at the top of each column header + boolean showFilterButton?; + # Indicates whether the header row is visible or not + boolean showHeaders?; + # Indicates whether the total row is visible or not + boolean showTotals?; + # Constant value that represents the Table style + "TableStyleLight1"|"TableStyleLight21"|"TableStyleMedium1"|"TableStyleMedium2"|"TableStyleMedium28"|"TableStyleDark1"|"TableStyleDark11" style?; +}; + +# Represents the properties to create a named item. +public type NewNamedItem Item|FormulaLocal; + +# Represents the properties of the position. +public type Position record { + # The start cell. This is where the chart is moved to + string startCell; + # The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range. + string endCell?; +}; + +# Represents the list of workbook comment. +public type Comments record { + # The list of workbook comment + Comment[] value?; +}; + +# Represents the list of table column. +public type Columns record { + # The list of table column + Column[] value?; +}; + +public type Range record { + # The range reference in A1-style + string address?; + # Range reference for the specified range in the language of the user + string addressLocal?; + # Number of cells in the range + int cellCount?; + # The total number of columns in the range + int columnCount?; + # Represents if all columns of the current range are hidden + boolean columnHidden?; + # The column number of the first cell in the range + int columnIndex?; + # The formula in A1-style notation + (string|int)[][]? formulas?; + # The formula in A1-style notation, in the user's language and number-formatting locale + (string|int)[][]? formulasLocal?; + # The formula in R1C1-style notation + (string|int)[][]? formulasR1C1?; + # Represents if all cells of the current range are hidden + boolean hidden?; + # Represents Excel's number format code for the given cell. + (string|int)[][]? numberFormat?; + # The total number of rows in the range + int rowCount?; + # Represents if all rows of the current range are hidden + boolean rowHidden?; + # The row number of the first cell in the range + int rowIndex?; + # Text values of the specified range + (string|int)[][]? text?; + # Represents the type of data of each cell + ("Unknown"|"Empty"|"String"|"Integer"|"Double"|"Boolean"|"Error")[][] valueTypes?; + # Represents the raw values of the specified range + (string|int|decimal?)[][]? values?; +}; + +# Represents the list of the worksheet. +public type Worksheets record { + # The list of the worksheet + Worksheet[] value?; +}; + +# Represents the pivot table. +public type PivotTable record { + # ID of the PivotTable + string id?; + # Name of the PivotTable + string name?; +}; + +# Represents the offset range. +public type OffsetRange record { + # The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward. + int rowOffset?; + # The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left. + int columnOffset?; +}; + +# Represents the properties to reset the data of the chart. +public type ResetData record { + # The range corresponding to the source data + string sourceData?; + # Specifies the way columns or rows are used as data series on the chart + "Auto"|"Columns"|"Rows" seriesBy?; +}; + +# Represents a range border. +public type RangeBorder record { + # HTML color code representing the color of the border line, of the form `#RRGGBB` (for example "FFA500") or as a named HTML color (for example "orange") + string color?; + # Represents border identifier + "EdgeTop"|"EdgeBottom"|"EdgeLeft"|"EdgeRight"|"InsideVertical"|"InsideHorizontal"|"DiagonalDown"|"DiagonalUp" id?; + # Constant value that indicates the specific side of the border + "EdgeTop"|"EdgeBottom"|"EdgeLeft"|"EdgeRight"|"InsideVertical"|"InsideHorizontal"|"DiagonalDown"|"DiagonalUp" sideIndex?; + # One of the constants of line style specifying the line style for the border + "None"|"Continuous"|"Dash"|"DashDot"|"DashDotDot"|"Dot"|"Double"|"SlantDashDot" style?; + # Specifies the weight of the border around a range + "Hairline"|"Thin"|"Medium"|"Thick" weight?; +}; + +# Represents the reply of the workbook comments. +public type Reply record { + # The ID of the comment reply + string id?; + # The content of the comment reply + string content?; + # Indicates the type for the comment reply + string contentType?; +}; + +# Represents the collection of the chart series. +public type CollectionOfChartSeries record { + # The collection of the chart series + ChartSeries[] value?; +}; + +# Represents the table row properties. +public type Row record { + # The index of the table row + int index?; + # The values in the table row + (string|int|decimal?)[][] values?; +}; + +# Represents a range border. +public type Icon record { + # The index of the icon in the given set + int index?; + # The set that the icon is part of + "Invalid"|"ThreeArrows"|"ThreeArrowsGray"|"ThreeFlags"|"ThreeTrafficLights1"|"ThreeTrafficLights2"|"ThreeSigns"|"ThreeSymbols"|"ThreeSymbols2"|"FourArrows"|"FourArrowsGray"|"FourRedToBlack"|"FourRating"|"FourTrafficLights"|"FiveArrows"|"FiveArrowsGray"|"FiveRating"|"FiveQuarters"|"ThreeStars"|"ThreeTriangles"|"FiveBoxes" set?; +}; + +# Represents the properties of the named item. +public type NamedItem record { + # The name of the new named item + string name?; + # The type of the new named item + "String"|"Integer"|"Double"|"Range"|"Boolean" 'type?; + # The comment associated with this name + string comment?; + # Indicates whether the name is scoped to the workbook or to a specific worksheet. + string scopes?; + # Represents the formula that the name is defined to refer to + record {}|string|record {}[] value?; + # Specifies whether the object is visible or not + boolean visible?; +}; + +# Represents the Excel application that manages the workbook. +public type Application record { + # Returns the calculation mode used in the workbook + "Automatic"|"AutomaticExceptTables"|"Manual" calculationMode?; +}; + +# Represents session info of workbook. +public type Session record { + # The ID of the workbook session + string id?; + # Whether to create a persistent session or not. `true` for persistent session. + boolean persistChanges; +}; + +# Represents the sorting for the range. +public type RangeSort record { + # The list of conditions to sort on + SortField[] fields?; + # Whether to have the casing determine string ordering + boolean matchCase?; + # Whether the range has a header + boolean hasHeaders?; + # Whether the operation is sorting rows or columns + "Rows"|"Columns" orientation?; + # The ordering method used for Chinese characters + "PinYin"|"StrokeCount" method?; +}; diff --git a/spec.yaml b/spec.yaml index 1c7886b..2360c8a 100644 --- a/spec.yaml +++ b/spec.yaml @@ -142,9 +142,6 @@ components: type: object description: Represents the table row properties. properties: - id: - type: string - description: The ID of the table row index: type: integer description: The index of the table row @@ -285,9 +282,15 @@ components: - type: string - type: integer formulasLocal: - type: string + type: array nullable: true description: The formula in A1-style notation, in the user's language and number-formatting locale + items: + type: array + items: + oneOf: + - type: string + - type: integer formulasR1C1: type: array nullable: true @@ -331,16 +334,19 @@ components: - type: string - type: integer valueTypes: - type: string + type: array description: Represents the type of data of each cell - enum: - - Unknown - - Empty - - String - - Integer - - Double - - Boolean - - Error + items: + type: array + items: + enum: + - Unknown + - Empty + - String + - Integer + - Double + - Boolean + - Error values: type: array nullable: true @@ -369,8 +375,14 @@ components: type: object description: Represents the formula in A1-style notation formulasLocal: - type: string + type: array description: Represents the formula in A1-style notation, in the user's language and number-formatting locale + items: + type: array + items: + oneOf: + - type: string + - type: integer formulasR1C1: type: object description: Represents the formula in R1C1-style notation @@ -387,16 +399,19 @@ components: type: object description: Text values of the specified range valueTypes: - type: string + type: array description: Represents the type of data of each cell - enum: - - Unknown - - Empty - - String - - Integer - - Double - - Boolean - - Error + items: + type: array + items: + enum: + - Unknown + - Empty + - String + - Integer + - Double + - Boolean + - Error values: type: array nullable: true @@ -1628,31 +1643,37 @@ paths: application/json: schema: $ref: '#/components/schemas/Row' - patch: - summary: Updates the properties of table row. - operationId: updateWorkbookTableRow + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/{index}: + get: + summary: Retrieves the properties and relationships of table row. + operationId: getWorkbookTableRowWithItemPath tags: - row parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Row' + - $ref: '#/components/parameters/count' + - $ref: '#/components/parameters/expand' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/format' + - $ref: '#/components/parameters/orderBy' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/select' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/top' responses: '200': - description: Success. + description: OK content: application/json: schema: $ref: '#/components/schemas/Row' - delete: - summary: Deletes the row from the workbook table. - operationId: deleteWorkbookTableRow + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Gets the range associated with the entire row. + operationId: getWorkbookTableRowRange tags: - row parameters: @@ -1663,10 +1684,14 @@ paths: responses: '200': description: OK - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/{index}: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: get: - summary: Retrieves the properties and relationships of table row. - operationId: getWorkbookTableRowWithItemPath + summary: Gets the range associated with the entire row. + operationId: getWorkbookTableRowRangeWithItemPath tags: - row parameters: @@ -1674,15 +1699,24 @@ paths: - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/expand' - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/format' - - $ref: '#/components/parameters/orderBy' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/select' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/top' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/{itemId}/workbook/tables/{tableIdOrName}/rows/itemAt(index={index}): + get: + summary: Gets a row based on its position in the collection. + operationId: getWorkbookTableRowWithIndex + tags: + - row + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' responses: '200': description: OK @@ -1692,11 +1726,11 @@ paths: $ref: '#/components/schemas/Row' patch: summary: Updates the properties of table row. - operationId: updateWorkbookTableRowWithItemPath + operationId: updateWorkbookTableRow tags: - row parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' @@ -1714,21 +1748,7 @@ paths: $ref: '#/components/schemas/Row' delete: summary: Deletes the row from the workbook table. - operationId: deleteWorkbookTableRowWithItemPath - tags: - - row - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: - get: - summary: Gets the range associated with the entire row. - operationId: getWorkbookTableRowRange + operationId: deleteWorkbookTableRow tags: - row parameters: @@ -1739,14 +1759,10 @@ paths: responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index}): get: - summary: Gets the range associated with the entire row. - operationId: getWorkbookTableRowRangeWithItemPath + summary: Gets a row based on its position in the collection. + operationId: getWorkbookTableRowWithIndexItemPath tags: - row parameters: @@ -1760,29 +1776,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Range' - /me/drive/{itemId}/workbook/tables/{tableIdOrName}/rows/itemAt(index={index}): - get: - summary: Gets a row based on its position in the collection. - operationId: getWorkbookTableRowWithIndex + $ref: '#/components/schemas/Row' + patch: + summary: Updates the properties of table row. + operationId: updateWorkbookTableRowWithItemPath tags: - row parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' responses: '200': - description: OK + description: Success. content: application/json: schema: $ref: '#/components/schemas/Row' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index}): - get: - summary: Gets a row based on its position in the collection. - operationId: getWorkbookTableRowWithIndexItemPath + delete: + summary: Deletes the row from the workbook table. + operationId: deleteWorkbookTableRowWithItemPath tags: - row parameters: @@ -1793,10 +1812,6 @@ paths: responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Row' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows/add: post: summary: Adds rows to the end of the table. @@ -1865,7 +1880,7 @@ paths: schema: $ref: '#/components/schemas/Worksheet' get: - summary: Retrieve a list of the worksheets. + summary: Retrieves a list of the worksheets. operationId: listWorksheets tags: - worksheet @@ -1911,7 +1926,7 @@ paths: schema: $ref: '#/components/schemas/Worksheet' get: - summary: Retrieve a list of the worksheet. + summary: Retrieves a list of the worksheet. operationId: listWorksheetsWithItemPath tags: - worksheet @@ -1936,7 +1951,7 @@ paths: $ref: '#/components/schemas/Worksheets' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}: get: - summary: Retrieve the properties and relationships of the worksheet. + summary: Retrieves the properties and relationships of the worksheet. operationId: getWorksheet tags: - worksheet @@ -1961,7 +1976,7 @@ paths: schema: $ref: '#/components/schemas/Worksheet' patch: - summary: Update the properties of worksheet. + summary: Updates the properties of worksheet. operationId: updateWorksheet tags: - worksheet @@ -1982,7 +1997,7 @@ paths: schema: $ref: '#/components/schemas/Worksheet' delete: - summary: Delete a worksheet from a workbook. + summary: Deletes a worksheet from a workbook. operationId: deleteWorksheet tags: - worksheet @@ -1995,7 +2010,7 @@ paths: description: No Content /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}: get: - summary: Retrieve the properties and relationships of the worksheet. + summary: Retrieves the properties and relationships of the worksheet. operationId: getWorksheetWithItemPath tags: - worksheet @@ -2020,7 +2035,7 @@ paths: schema: $ref: '#/components/schemas/Worksheet' patch: - summary: Update the properties of the worksheet. + summary: Updates the properties of the worksheet. operationId: updateWorksheetWithItemPath tags: - worksheet @@ -2041,7 +2056,7 @@ paths: schema: $ref: '#/components/schemas/Worksheet' delete: - summary: Delete a worksheet from a workbook. + summary: Deletes a worksheet from a workbook. operationId: deleteWorksheetWithItemPath tags: - worksheet @@ -2124,7 +2139,7 @@ paths: $ref: '#/components/schemas/Charts' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts: get: - summary: Retrieve a list of chart. + summary: Retrieves a list of chart. operationId: listChartsWithItemPath tags: - worksheet @@ -2388,7 +2403,7 @@ paths: $ref: '#/components/schemas/PivotTables' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: get: - summary: Retrieve the properties and relationships of pivot table. + summary: Retrieves the properties and relationships of pivot table. operationId: getPivotTable tags: - worksheet @@ -2415,7 +2430,7 @@ paths: $ref: '#/components/schemas/PivotTable' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: get: - summary: Retrieve a list of the workbook pivot table. + summary: Retrieves a list of the workbook pivot table. operationId: getPivotTableWithItemPath tags: - worksheet @@ -2497,7 +2512,7 @@ paths: #___________________________________ RANGE ________________________________________ /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): get: - summary: Retrieve the properties and relationships of range. + summary: Retrieves the properties and relationships of range. operationId: getWorksheetRangeWithAddress tags: - range @@ -2523,7 +2538,7 @@ paths: schema: $ref: '#/components/schemas/Range' patch: - summary: Update the properties of range. + summary: Updates the properties of range. operationId: updateWorksheetRangeWithAddress tags: - range @@ -2546,7 +2561,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): get: - summary: Retrieve the properties and relationships of range. + summary: Retrieves the properties and relationships of range. operationId: getWorksheetRangeWithAddressItemPath tags: - range @@ -2572,7 +2587,7 @@ paths: schema: $ref: '#/components/schemas/Range' patch: - summary: Update the properties of range. + summary: Updates the properties of range. operationId: updateWorksheetRangeWithAddressItemPath tags: - range @@ -2595,7 +2610,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: get: - summary: Retrieve the properties and relationships of range. + summary: Retrieves the properties and relationships of range. operationId: getColumnRange tags: - range @@ -2621,7 +2636,7 @@ paths: schema: $ref: '#/components/schemas/Range' patch: - summary: Update the properties of range. + summary: Updates the properties of range. operationId: updateColumnRange tags: - range @@ -2644,7 +2659,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: get: - summary: Retrieve the properties and relationships of range. + summary: Retrieves the properties and relationships of range. operationId: getColumnRangeWithItemPath tags: - range @@ -2670,7 +2685,7 @@ paths: schema: $ref: '#/components/schemas/Range' patch: - summary: Update the properties of range. + summary: Updates the properties of range. operationId: updateColumnRangeWithItemPath tags: - range @@ -2693,7 +2708,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/names/{name}/range: get: - summary: Retrieve the range object that is associated with the name. + summary: Retrieves the range object that is associated with the name. operationId: getNamedItemRange tags: - namedItem @@ -2709,7 +2724,7 @@ paths: schema: $ref: '#/components/schemas/Range' patch: - summary: Update the properties of range. + summary: Updates the properties of range. operationId: UpdateNameRange tags: - range @@ -2731,7 +2746,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/names/{name}/range: get: - summary: Retrieve the range object that is associated with the name. + summary: Retrieves the range object that is associated with the name. operationId: getNamedItemRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -2745,7 +2760,7 @@ paths: schema: $ref: '#/components/schemas/Range' patch: - summary: Update the properties of range. + summary: Updates the properties of range. operationId: UpdateNameRangeWithItemPath tags: - range @@ -3213,7 +3228,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireColumn: get: - summary: Gets the range that represents the entire column of the range + summary: Gets the range that represents the entire column of the range. operationId: getWorksheetRangeEntireColumn tags: - range @@ -3231,7 +3246,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireColumn: get: - summary: Gets the range that represents the entire column of the range + summary: Gets the range that represents the entire column of the range. operationId: getWorksheetRangeEntireColumnWithItemPath tags: - range @@ -3249,7 +3264,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireColumn: get: - summary: Gets the range that represents the entire column of the range + summary: Gets the range that represents the entire column of the range. operationId: getColumnRangeEntireColumn tags: - range @@ -3267,7 +3282,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireColumn: get: - summary: Gets the range that represents the entire column of the range + summary: Gets the range that represents the entire column of the range. operationId: getColumnRangeEntireColumnWithItemPath tags: - range @@ -3285,7 +3300,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/names/{name}/range/entireRow: get: - summary: Gets the range that represents the entire row of the range + summary: Gets the range that represents the entire row of the range. operationId: getNameRangeEntireRow tags: - range @@ -3302,7 +3317,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/names/{name}/range/entireRow: get: - summary: Gets the range that represents the entire row of the range + summary: Gets the range that represents the entire row of the range. operationId: getNameRangeEntireRowWithItemPath tags: - range @@ -3319,7 +3334,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireRow: get: - summary: Gets the range that represents the entire row of the range + summary: Gets the range that represents the entire row of the range. operationId: getWorksheetRangeEntireRow tags: - range @@ -3337,7 +3352,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireRow: get: - summary: Gets the range that represents the entire row of the range + summary: Gets the range that represents the entire row of the range. operationId: getWorksheetRangeEntireRowWithItemPath tags: - range @@ -3355,7 +3370,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireRow: get: - summary: Gets the range that represents the entire row of the range + summary: Gets the range that represents the entire row of the range. operationId: getColumnRangeEntireRow tags: - range @@ -3373,7 +3388,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireRow: get: - summary: Gets the range that represents the entire row of the range + summary: Gets the range that represents the entire row of the range. operationId: getColumnRangeEntireRowWithItemPath tags: - range @@ -3549,7 +3564,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: get: - summary: Gets the last column within the range + summary: Gets the last column within the range. operationId: getWorksheetRangeLastColumnWithItemPath tags: - range @@ -3567,7 +3582,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: get: - summary: Gets the last column within the range + summary: Gets the last column within the range. operationId: getColumnRangeLastColumn tags: - range @@ -3585,7 +3600,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: get: - summary: Gets the last column within the range + summary: Gets the last column within the range. operationId: getColumnRangeLastColumnWithItemPath tags: - range @@ -3781,7 +3796,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow: get: - summary: Gets a certain number of columns to the left of the given range + summary: Gets a certain number of columns to the left of the given range. operationId: getWorksheetRowsBelowRange tags: - range @@ -3798,7 +3813,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow: get: - summary: Gets a certain number of columns to the left of the given range + summary: Gets a certain number of columns to the left of the given range. operationId: getWorksheetRowsBelowRangeWithItemPath tags: - range @@ -3815,7 +3830,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow(count={rowCount}): get: - summary: Gets a certain number of columns to the left of the given range + summary: Gets a certain number of columns to the left of the given range. operationId: getWorksheetRowsBelowRangeWithCount tags: - range @@ -3833,7 +3848,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow(count={rowCount}): get: - summary: Gets a certain number of columns to the left of the given range + summary: Gets a certain number of columns to the left of the given range. operationId: getWorksheetRowsBelowRangeWithCountItemPath tags: - range @@ -3944,7 +3959,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/usedRange(valuesOnly={valuesOnly}): get: - summary: Get the used range of the given range. + summary: Gets the used range of the given range. operationId: getColumnUsedRangeWithItemPath tags: - range @@ -3963,7 +3978,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/names/{name}/range/clear: post: - summary: Clear range values such as format, fill, and border. + summary: Clears range values such as format, fill, and border. operationId: clearNameRange tags: - range @@ -3981,7 +3996,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/names/{name}/range/clear: post: - summary: Clear range values such as format, fill, and border. + summary: Clears range values such as format, fill, and border. operationId: clearNameRangeWithItemPath tags: - range @@ -3999,7 +4014,7 @@ paths: description: OK /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: post: - summary: Clear range values such as format, fill, and border. + summary: Clears range values such as format, fill, and border. operationId: clearWorksheetRange tags: - range @@ -4018,7 +4033,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: post: - summary: Clear range values such as format, fill, and border. + summary: Clears range values such as format, fill, and border. operationId: clearWorksheetRangeWithItemPath tags: - range @@ -4037,7 +4052,7 @@ paths: description: OK /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: post: - summary: Clear range values such as format, fill, and border. + summary: Clears range values such as format, fill, and border. operationId: clearColumnRange tags: - range @@ -4056,7 +4071,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: post: - summary: Clear range values such as format, fill, and border. + summary: Clears range values such as format, fill, and border. operationId: clearColumnRangeWithItemPath tags: - range @@ -4323,7 +4338,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/names/{name}/range/merge: post: - summary: Merge the range cells into one region in the worksheet. + summary: Merges the range cells into one region in the worksheet. operationId: mergeNameRange tags: - range @@ -4341,7 +4356,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/names/{name}/range/merge: post: - summary: Merge the range cells into one region in the worksheet. + summary: Merges the range cells into one region in the worksheet. operationId: mergeNameRangeWithItemPath tags: - range @@ -4359,7 +4374,7 @@ paths: description: OK /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/merge: post: - summary: Merge the range cells into one region in the worksheet. + summary: Merges the range cells into one region in the worksheet. operationId: mergeWorksheetRange tags: - range @@ -4378,7 +4393,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/merge: post: - summary: Merge the range cells into one region in the worksheet. + summary: Merges the range cells into one region in the worksheet. operationId: mergeWorksheetRangeWithItemPath tags: - range @@ -4397,7 +4412,7 @@ paths: description: OK /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/merge: post: - summary: Merge the range cells into one region in the worksheet. + summary: Merges the range cells into one region in the worksheet. operationId: mergeColumnRange tags: - range @@ -4416,7 +4431,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/merge: post: - summary: Merge the range cells into one region in the worksheet. + summary: Merges the range cells into one region in the worksheet. operationId: mergeColumnRangeWithItemPath tags: - range @@ -4435,7 +4450,7 @@ paths: description: OK /me/drive/items/{itemId}/workbook/names/{name}/range/unmerge: post: - summary: Unmerge the range cells into separate cells. + summary: Unmerges the range cells into separate cells. operationId: unmergeNameRange tags: - range @@ -4448,7 +4463,7 @@ paths: description: No Content /me/drive/root:/{itemPath}:/workbook/names/{name}/range/unmerge: post: - summary: Unmerge the range cells into separate cells. + summary: Unmerges the range cells into separate cells. operationId: unmergeNameRangeWithItemPath tags: - range @@ -4461,7 +4476,7 @@ paths: description: No Content /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: post: - summary: Unmerge the range cells into separate cells. + summary: Unmerges the range cells into separate cells. operationId: unmergeWorksheetRange tags: - range @@ -4475,7 +4490,7 @@ paths: description: No Content /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: post: - summary: Unmerge the range cells into separate cells. + summary: Unmerges the range cells into separate cells. operationId: unmergeWorksheetRangeWithItemPath tags: - range @@ -4489,7 +4504,7 @@ paths: description: No Content /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: post: - summary: Unmerge the range cells into separate cells. + summary: Unmerges the range cells into separate cells. operationId: unmergeColumnRange tags: - range @@ -4503,7 +4518,7 @@ paths: description: No Content /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: post: - summary: Unmerge the range cells into separate cells. + summary: Unmerges the range cells into separate cells. operationId: unmergeColumnRangeWithItemPath tags: - range @@ -4517,7 +4532,7 @@ paths: description: No Content /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: get: - summary: Get the range visible from a filtered range. + summary: Gets the range visible from a filtered range. operationId: getVisibleView tags: - range @@ -4535,7 +4550,7 @@ paths: $ref: '#/components/schemas/RangeView' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: get: - summary: Get the range visible from a filtered range. + summary: Gets the range visible from a filtered range. operationId: getVisibleViewWithItemPath tags: - range @@ -4553,7 +4568,7 @@ paths: $ref: '#/components/schemas/RangeView' /me/drive/items/{itemId}/workbook/names/{name}/range/sort/apply: post: - summary: Perform a sort operation. + summary: Performs a sort operation. operationId: performNameRangeSort tags: - range @@ -4571,7 +4586,7 @@ paths: description: OK. /me/drive/root:/{itemPath}:/workbook/names/{name}/range/sort/apply: post: - summary: Perform a sort operation. + summary: Performs a sort operation. operationId: performNameRangeSortWithItemPath tags: - range @@ -4589,7 +4604,7 @@ paths: description: OK. /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/sort/apply: post: - summary: Perform a sort operation. + summary: Performs a sort operation. operationId: performWorksheetRangeSort tags: - range @@ -4608,7 +4623,7 @@ paths: description: OK. /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/sort/apply: post: - summary: Perform a sort operation. + summary: Performs a sort operation. operationId: performWorksheetRangeSortWithItemPath tags: - range @@ -4627,7 +4642,7 @@ paths: description: OK. /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/sort/apply: post: - summary: Perform a sort operation. + summary: Performs a sort operation. operationId: performColumnRangeSort tags: - range @@ -4646,7 +4661,7 @@ paths: description: OK. /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/sort/apply: post: - summary: Perform a sort operation. + summary: Performs a sort operation. operationId: performColumnRangeSortWithItemPath tags: - range @@ -4665,7 +4680,7 @@ paths: description: No Content /me/drive/items/{itemId}/workbook/names/{name}/range/format: get: - summary: Retrieve the properties and relationships of the range format. + summary: Retrieves the properties and relationships of the range format. operationId: getNameRangeFormat tags: - range @@ -4690,7 +4705,7 @@ paths: schema: $ref: '#/components/schemas/RangeFormat' patch: - summary: Update the properties of range format. + summary: Updates the properties of range format. operationId: updateNameRangeFormat tags: - range @@ -4712,7 +4727,7 @@ paths: $ref: '#/components/schemas/RangeFormat' /me/drive/root:/{itemPath}:/workbook/names/{name}/range/format: get: - summary: Retrieve the properties and relationships of the range format. + summary: Retrieves the properties and relationships of the range format. operationId: getNameRangeFormatWithItemPath tags: - range @@ -4737,7 +4752,7 @@ paths: schema: $ref: '#/components/schemas/RangeFormat' patch: - summary: Update the properties of range format. + summary: Updates the properties of range format. operationId: updateNameRangeFormatWithItemPath tags: - range @@ -4759,7 +4774,7 @@ paths: $ref: '#/components/schemas/RangeFormat' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format: get: - summary: Retrieve the properties and relationships of the range format. + summary: Retrieves the properties and relationships of the range format. operationId: getWorksheetRangeFormat tags: - range @@ -4785,7 +4800,7 @@ paths: schema: $ref: '#/components/schemas/RangeFormat' patch: - summary: Update the properties of range format. + summary: Updates the properties of range format. operationId: updateWorksheetRangeFormat tags: - range @@ -4808,7 +4823,7 @@ paths: $ref: '#/components/schemas/RangeFormat' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format: get: - summary: Retrieve the properties and relationships of the range format. + summary: Retrieves the properties and relationships of the range format. operationId: getWorksheetRangeFormatWithItemPath tags: - range @@ -4834,7 +4849,7 @@ paths: schema: $ref: '#/components/schemas/RangeFormat' patch: - summary: Update the properties of range format. + summary: Updates the properties of range format. operationId: updateWorksheetRangeFormatWithItemPath tags: - range @@ -4857,7 +4872,7 @@ paths: $ref: '#/components/schemas/RangeFormat' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format: get: - summary: Retrieve the properties and relationships of the range format. + summary: Retrieves the properties and relationships of the range format. operationId: getColumnRangeFormat tags: - range @@ -4883,7 +4898,7 @@ paths: schema: $ref: '#/components/schemas/RangeFormat' patch: - summary: Update the properties of range format. + summary: Updates the properties of range format. operationId: updateColumnRangeFormat tags: - range @@ -4906,7 +4921,7 @@ paths: $ref: '#/components/schemas/RangeFormat' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format: get: - summary: Retrieve the properties and relationships of the range format. + summary: Retrieves the properties and relationships of the range format. operationId: getColumnRangeFormatWithItemPath tags: - range @@ -4932,7 +4947,7 @@ paths: schema: $ref: '#/components/schemas/RangeFormat' patch: - summary: Update the properties of range format. + summary: Updates the properties of range format. operationId: updateColumnRangeFormatWithItemPath tags: - range @@ -4955,7 +4970,7 @@ paths: $ref: '#/components/schemas/RangeFormat' /me/drive/items/{itemId}/workbook/names/{name}/range/format/borders: post: - summary: Create a new range border. + summary: Creates a new range border. operationId: createNameRangeBorder tags: - range @@ -5002,7 +5017,7 @@ paths: $ref: '#/components/schemas/RangeBorders' /me/drive/root:/{itemPath}:/workbook/names/{name}/range/format/borders: post: - summary: Create a new range border. + summary: Creates a new range border. operationId: createNameRangeBorderWithItemPath tags: - range @@ -5049,7 +5064,7 @@ paths: $ref: '#/components/schemas/RangeBorders' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/borders: post: - summary: Create a new range border. + summary: Creates a new range border. operationId: createWorksheetRangeBorder tags: - range @@ -5098,7 +5113,7 @@ paths: $ref: '#/components/schemas/RangeBorders' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/borders: post: - summary: Create a new range border. + summary: Creates a new range border. operationId: createWorksheetRangeBorderWithItemPath tags: - range @@ -5147,7 +5162,7 @@ paths: $ref: '#/components/schemas/RangeBorders' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/borders: post: - summary: Create a new range border. + summary: Creates a new range border. operationId: createColumnRangeBorder tags: - range @@ -5196,7 +5211,7 @@ paths: $ref: '#/components/schemas/RangeBorders' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/borders: post: - summary: Create a new range border. + summary: Creates a new range border. operationId: createColumnRangeBorderWithItemPath tags: - range @@ -5409,7 +5424,7 @@ paths: description: OK. /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/resizedRange(deltaRows={deltaRows}, deltaColumns={deltaColumns}): post: - summary: Get the resized range of a range. + summary: Gets the resized range of a range. operationId: getResizedRange tags: - range @@ -5429,7 +5444,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/resizedRange(deltaRows={deltaRows}, deltaColumns={deltaColumns}): post: - summary: Get the resized range of a range. + summary: Gets the resized range of a range. operationId: getResizedRangeWithItemPath tags: - range @@ -5995,7 +6010,7 @@ paths: #___________________________________ TABLES ________________________________________ /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}: patch: - summary: Update the properties of table in the workbook. + summary: Updates the properties of table in the workbook. description: Update the properties of table operationId: updateWorkbookTable tags: @@ -6029,7 +6044,7 @@ paths: '200': description: OK get: - summary: Retrieve the properties and relationships of table. + summary: Retrieves the properties and relationships of table. operationId: getWorkbookTable parameters: - $ref: '#/components/parameters/itemId' @@ -6053,7 +6068,7 @@ paths: $ref: '#/components/schemas/Table' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}: patch: - summary: Update the properties of table in the workbook. + summary: Updates the properties of table in the workbook. description: Update the properties of table operationId: updateWorkbookTableWithItemPath tags: @@ -6087,7 +6102,7 @@ paths: '200': description: OK get: - summary: Retrieve the properties and relationships of table. + summary: Retrieves the properties and relationships of table. operationId: getWorkbookTableWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6111,7 +6126,7 @@ paths: $ref: '#/components/schemas/Table' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: patch: - summary: Update the properties of table in the worksheet. + summary: Updates the properties of table in the worksheet. operationId: updateWorksheetTable tags: - tables @@ -6146,7 +6161,7 @@ paths: '200': description: OK get: - summary: Retrieve the properties and relationships of table. + summary: Retrieves the properties and relationships of table. operationId: getWorksheetTable parameters: - $ref: '#/components/parameters/itemId' @@ -6171,7 +6186,7 @@ paths: $ref: '#/components/schemas/Table' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: patch: - summary: Update the properties of table in the worksheet. + summary: Updates the properties of table in the worksheet. operationId: updateWorksheetTableWithItemPath tags: - tables @@ -6206,7 +6221,7 @@ paths: '200': description: OK get: - summary: Retrieve the properties and relationships of table. + summary: Retrieves the properties and relationships of table. operationId: getWorksheetTableWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6370,7 +6385,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/range: get: - summary: Get the range associated with the entire table. + summary: Gets the range associated with the entire table. operationId: getWorkbookTableRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6385,7 +6400,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: get: - summary: Get the range associated with the entire table. + summary: Gets the range associated with the entire table. operationId: getWorksheetTableRange parameters: - $ref: '#/components/parameters/itemId' @@ -6401,7 +6416,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: get: - summary: Get the range associated with the entire table. + summary: Gets the range associated with the entire table. operationId: getWorksheetTableRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6634,7 +6649,7 @@ paths: description: OK /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables: get: - summary: Retrieve a list of table in the worksheet. + summary: Retrieves a list of table in the worksheet. operationId: listWorksheetTables tags: - tables @@ -6660,7 +6675,7 @@ paths: $ref: '#/components/schemas/Tables' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables: get: - summary: Retrieve a list of table in the worksheet. + summary: Retrieves a list of table in the worksheet. operationId: listWorksheetTablesWithItemPath tags: - tables @@ -6686,7 +6701,7 @@ paths: $ref: '#/components/schemas/Tables' /me/drive/items/{itemId}/workbook/tables/add: post: - summary: Create a new table in the workbook + summary: Creates a new table in the workbook operationId: addWorkbookTable tags: - tables @@ -6707,7 +6722,7 @@ paths: $ref: '#/components/schemas/Table' /me/drive/root:/{itemPath}:/workbook/tables/add: post: - summary: Create a new table in the workbook + summary: Creates a new table in the workbook operationId: addWorkbookTableWithItemPath tags: - tables @@ -6728,7 +6743,7 @@ paths: $ref: '#/components/schemas/Table' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/sort: get: - summary: Retrieve the properties and relationships of table sort. + summary: Retrieves the properties and relationships of table sort. operationId: getWorkbookTableSort parameters: - $ref: '#/components/parameters/itemId' @@ -6752,7 +6767,7 @@ paths: $ref: '#/components/schemas/TableSort' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/sort: get: - summary: Retrieve the properties and relationships of table sort. + summary: Retrieves the properties and relationships of table sort. operationId: getWorkbookTableSortWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6776,7 +6791,7 @@ paths: $ref: '#/components/schemas/TableSort' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort: get: - summary: Retrieve the properties and relationships of table sort. + summary: Retrieves the properties and relationships of table sort. operationId: getWorksheetTableSort parameters: - $ref: '#/components/parameters/itemId' @@ -6801,7 +6816,7 @@ paths: $ref: '#/components/schemas/TableSort' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort: get: - summary: Retrieve the properties and relationships of table sort. + summary: Retrieves the properties and relationships of table sort. operationId: getWorksheetTableSortWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6826,7 +6841,7 @@ paths: $ref: '#/components/schemas/TableSort' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/sort/apply: post: - summary: Perform a sort operation to the table. + summary: Performs a sort operation to the table. operationId: performWorkbookTableSort parameters: - $ref: '#/components/parameters/itemId' @@ -6837,7 +6852,7 @@ paths: description: OK. /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/sort/apply: post: - summary: Perform a sort operation to the table. + summary: Performs a sort operation to the table. operationId: performWorkbookTableSortWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6848,7 +6863,7 @@ paths: description: OK. /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/apply: post: - summary: Perform a sort operation to the table. + summary: Performs a sort operation to the table. operationId: performWorksheetTableSort parameters: - $ref: '#/components/parameters/itemId' @@ -6865,7 +6880,7 @@ paths: description: OK /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/apply: post: - summary: Perform a sort operation to the table. + summary: Performs a sort operation to the table. operationId: performWorksheetTableSortWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -6975,7 +6990,7 @@ paths: #___________________________________ TABLE ROWS ________________________________________ /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows: get: - summary: Retrieve a list of table row in the worksheet. + summary: Retrieves a list of table row in the worksheet. operationId: listWorksheetTableRows tags: - row @@ -7024,7 +7039,7 @@ paths: $ref: '#/components/schemas/Row' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows: get: - summary: Retrieve a list of table row in the worksheet. + summary: Retrieves a list of table row in the worksheet. operationId: listWorksheetTableRowsWithItemPath tags: - row @@ -7136,29 +7151,32 @@ paths: application/json: schema: $ref: '#/components/schemas/Row' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): - get: - summary: Gets a row based on its position in the collection. - operationId: getWorksheetTableRowWithIndexItemPath + patch: + summary: Updates the properties of table row. + operationId: updateWorksheetTableRow tags: - row parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' responses: '200': - description: OK + description: Success. content: application/json: schema: $ref: '#/components/schemas/Row' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/{index}: - get: - summary: Retrieve the properties and relationships of table row. - operationId: getWorksheetTableRow + delete: + summary: Deletes the row from the workbook table. + operationId: deleteWorksheetTableRow tags: - row parameters: @@ -7167,15 +7185,21 @@ paths: - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/expand' - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/format' - - $ref: '#/components/parameters/orderBy' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/select' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/top' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): + get: + summary: Gets a row based on its position in the collection. + operationId: getWorksheetTableRowWithIndexItemPath + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' responses: '200': description: OK @@ -7184,12 +7208,12 @@ paths: schema: $ref: '#/components/schemas/Row' patch: - summary: Update the properties of table row. - operationId: updateWorksheetTableRow + summary: Updates the properties of table row. + operationId: updateWorksheetTableRowWithItemPath tags: - row parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' @@ -7208,11 +7232,11 @@ paths: $ref: '#/components/schemas/Row' delete: summary: Deletes the row from the workbook table. - operationId: deleteWorksheetTableRow + operationId: deleteWorksheetTableRowWithItemPath tags: - row parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' @@ -7220,14 +7244,14 @@ paths: responses: '200': description: OK - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/{index}: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/{index}: get: - summary: Retrieve the properties and relationships of table row. - operationId: getWorksheetTableRowWithItemPath + summary: Retrieves the properties and relationships of table row. + operationId: getWorksheetTableRow tags: - row parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' @@ -7248,9 +7272,10 @@ paths: application/json: schema: $ref: '#/components/schemas/Row' - patch: - summary: Update the properties of table row. - operationId: updateWorksheetTableRowWithItemPath + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/{index}: + get: + summary: Retrieves the properties and relationships of table row. + operationId: getWorksheetTableRowWithItemPath tags: - row parameters: @@ -7259,35 +7284,25 @@ paths: - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Row' + - $ref: '#/components/parameters/count' + - $ref: '#/components/parameters/expand' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/format' + - $ref: '#/components/parameters/orderBy' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/select' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/top' responses: '200': - description: Success. + description: OK content: application/json: schema: $ref: '#/components/schemas/Row' - delete: - summary: Deletes the row from the workbook table. - operationId: deleteWorksheetTableRowWithItemPath - tags: - - row - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index})/range: get: - summary: Get the range associated with the entire row. + summary: Gets the range associated with the entire row. operationId: getWorksheetTableRowRange tags: - row @@ -7326,7 +7341,7 @@ paths: #___________________________________ TABLE COLUMNS ________________________________________ /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns: post: - summary: Create a new table column in the workbook. + summary: Creates a new table column in the workbook. operationId: createWorkbookTableColumn tags: - column @@ -7347,7 +7362,7 @@ paths: schema: $ref: '#/components/schemas/Column' get: - summary: Retrieve a list of table column in the workbook. + summary: Retrieves a list of table column in the workbook. operationId: listWorkbookTableColumns tags: - column @@ -7373,7 +7388,7 @@ paths: $ref: '#/components/schemas/Columns' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns: post: - summary: Create a new table column in the workbook. + summary: Creates a new table column in the workbook. operationId: createWorkbookTableColumnWithItemPath tags: - column @@ -7394,7 +7409,7 @@ paths: schema: $ref: '#/components/schemas/Column' get: - summary: Retrieve a list of table column in the workbook. + summary: Retrieves a list of table column in the workbook. operationId: listWorkbookTableColumnsWithItemPath tags: - column @@ -7420,7 +7435,7 @@ paths: $ref: '#/components/schemas/Columns' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: post: - summary: Create a new table column in the workbook. + summary: Creates a new table column in the workbook. operationId: createWorksheetTableColumn tags: - tableColumn @@ -7442,7 +7457,7 @@ paths: schema: $ref: '#/components/schemas/Column' get: - summary: Retrieve a list of table column in the workbook. + summary: Retrieves a list of table column in the workbook. operationId: listWorksheetTableColumns tags: - tableColumn @@ -7469,7 +7484,7 @@ paths: $ref: '#/components/schemas/Columns' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: post: - summary: Create a new table column in the workbook. + summary: Creates a new table column in the workbook. operationId: createWorksheetTableColumnWithItemPath tags: - tableColumn @@ -7491,7 +7506,7 @@ paths: schema: $ref: '#/components/schemas/Column' get: - summary: Retrieve a list of table column in the workbook. + summary: Retrieves a list of table column in the workbook. operationId: listWorksheetTableColumnsWithItemPath tags: - tableColumn @@ -7531,7 +7546,7 @@ paths: '204': description: No Content. get: - summary: Retrieve the properties and relationships of table column. + summary: Retrieves the properties and relationships of table column. operationId: getWorkbookTableColumn tags: - tableColumn @@ -7557,7 +7572,7 @@ paths: schema: $ref: '#/components/schemas/Column' patch: - summary: Update the properties of table column + summary: Updates the properties of table column operationId: updateWorkbookTableColumn tags: - tableColumn @@ -7593,7 +7608,7 @@ paths: '204': description: No Content. get: - summary: Retrieve the properties and relationships of table column. + summary: Retrieves the properties and relationships of table column. operationId: getWorkbookTableColumnWithItemPath tags: - tableColumn @@ -7619,7 +7634,7 @@ paths: schema: $ref: '#/components/schemas/Column' patch: - summary: Update the properties of table column + summary: Updates the properties of table column operationId: updateWorkbookTableColumnWithItemPath tags: - tableColumn @@ -7642,7 +7657,7 @@ paths: $ref: '#/components/schemas/Column' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: delete: - summary: Delete a column from a table. + summary: Deletes a column from a table. operationId: deleteWorksheetTableColumn tags: - tableColumn @@ -7656,7 +7671,7 @@ paths: '204': description: No Content. get: - summary: Retrieve the properties and relationships of table column. + summary: Retrieves the properties and relationships of table column. operationId: getWorksheetTableColumn tags: - tableColumn @@ -7683,7 +7698,7 @@ paths: schema: $ref: '#/components/schemas/Column' patch: - summary: Update the properties of table column + summary: Updates the properties of table column. operationId: updateWorksheetTableColumn tags: - tableColumn @@ -7707,7 +7722,7 @@ paths: $ref: '#/components/schemas/Column' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: delete: - summary: Delete a column from a table. + summary: Deletes a column from a table. operationId: deleteWorksheetTableColumnWithItemPath tags: - tableColumn @@ -7721,7 +7736,7 @@ paths: '204': description: No Content. get: - summary: Retrieve the properties and relationships of table column. + summary: Retrieves the properties and relationships of table column. operationId: getWorksheetTableColumnWithItemPath tags: - tableColumn @@ -7748,7 +7763,7 @@ paths: schema: $ref: '#/components/schemas/Column' patch: - summary: Update the properties of table column + summary: Updates the properties of table column. operationId: updateWorksheetTableColumnWithItemPath tags: - tableColumn @@ -7772,7 +7787,7 @@ paths: $ref: '#/components/schemas/Column' /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/dataBodyRange: get: - summary: Gets the range associated with the data body of the column + summary: Gets the range associated with the data body of the column. operationId: getworkbookTableColumnsDataBodyRange tags: - tableColumn @@ -7790,7 +7805,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/dataBodyRange: get: - summary: Gets the range associated with the data body of the column + summary: Gets the range associated with the data body of the column. operationId: getworkbookTableColumnsDataBodyRangeWithItemPath tags: - tableColumn @@ -7808,7 +7823,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}/dataBodyRange: get: - summary: Gets the range associated with the data body of the column + summary: Gets the range associated with the data body of the column. operationId: getworksheetTableColumnsDataBodyRange tags: - tableColumn @@ -7827,7 +7842,7 @@ paths: $ref: '#/components/schemas/Range' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}/dataBodyRange: get: - summary: Gets the range associated with the data body of the column + summary: Gets the range associated with the data body of the column. operationId: getworksheetTableColumnsDataBodyRangeWithItemPath tags: - tableColumn @@ -8048,7 +8063,7 @@ paths: description: OK. /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}: get: - summary: Retrieve the properties and relationships of chart. + summary: Retrieves the properties and relationships of chart. operationId: getChartWithItemPath tags: - chart @@ -8065,7 +8080,7 @@ paths: schema: $ref: '#/components/schemas/Chart' patch: - summary: Update the properties of chart. + summary: Updates the properties of chart. operationId: updateChartWithItemPath tags: - chart @@ -8101,7 +8116,7 @@ paths: description: OK. /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: post: - summary: create a new chart series. + summary: creates a new chart series. operationId: createChartSeries tags: - chart @@ -8123,7 +8138,7 @@ paths: schema: $ref: '#/components/schemas/ChartSeries' get: - summary: Retrieve a list of chart series . + summary: Retrieves a list of chart series . operationId: listChartSeries tags: - chart @@ -8150,7 +8165,7 @@ paths: $ref: '#/components/schemas/collectionOfChartSeries' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: post: - summary: create a new chart series. + summary: Creates a new chart series. operationId: createChartSeriesWithItemPath tags: - chart @@ -8172,7 +8187,7 @@ paths: schema: $ref: '#/components/schemas/ChartSeries' get: - summary: Retrieve a list of chart series . + summary: Retrieve a list of chart series. operationId: listChartSeriesWithItemPath tags: - chart @@ -8499,7 +8514,7 @@ paths: $ref: '#/components/schemas/NamedItems' /me/drive/root:/{itemPath}:/workbook/names: get: - summary: Retrieve a list of named item. + summary: Retrieves a list of named item. operationId: listNamedItemWithItemPath tags: - namedItem @@ -8606,7 +8621,7 @@ paths: $ref: '#/components/schemas/NamedItem' /me/drive/items/{itemId}/workbook/names/{name}: get: - summary: Retrieve the properties and relationships of the named item. + summary: Retrieves the properties and relationships of the named item. operationId: getNamedItem tags: - namedItem @@ -8631,7 +8646,7 @@ paths: schema: $ref: '#/components/schemas/NamedItem' patch: - summary: Update the properties of the named item . + summary: Updates the properties of the named item . operationId: updateNamedItem tags: - namedItem @@ -8653,7 +8668,7 @@ paths: $ref: '#/components/schemas/NamedItem' /me/drive/root:/{itemPath}:/workbook/names/{name}: get: - summary: Retrieve the properties and relationships of the named item. + summary: Retrieves the properties and relationships of the named item. operationId: getNamedItemWithItemPath parameters: - $ref: '#/components/parameters/itemPath' @@ -8676,7 +8691,7 @@ paths: schema: $ref: '#/components/schemas/NamedItem' patch: - summary: Update the properties of the named item . + summary: Updates the properties of the named item. operationId: updateNamedItemWithItemPath parameters: - $ref: '#/components/parameters/itemPath'