From 4b8b82c43c14f8359e7e8d014e8bc60cbe0a211e Mon Sep 17 00:00:00 2001 From: Kalaiyarasiganeshalingam Date: Tue, 31 Oct 2023 10:05:53 +0530 Subject: [PATCH 1/5] Revamp the connector --- ballerina/client.bal | 737 +--- ballerina/modules/excel/client.bal | 4312 ++++++++++++++++++ ballerina/modules/excel/types.bal | 457 ++ ballerina/modules/excel/utils.bal | 224 + ballerina/utils.bal | 4 + spec.yaml | 6627 ++++++++++++++++++++++++++++ 6 files changed, 11687 insertions(+), 674 deletions(-) create mode 100644 ballerina/modules/excel/client.bal create mode 100644 ballerina/modules/excel/types.bal create mode 100644 ballerina/modules/excel/utils.bal create mode 100644 spec.yaml diff --git a/ballerina/client.bal b/ballerina/client.bal index 3c3a77c..6727c5e 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -15,709 +15,98 @@ // under the License. import ballerina/http; -import ballerinax/'client.config; +import microsoft.excel.excel; -# Ballerina Microsoft Excel connector provides the capability to access Microsoft Graph Excel API -# It provides capability to perform perform CRUD (Create, Read, Update, and Delete) operations on -# [Excel workbooks](https://docs.microsoft.com/en-us/graph/api/resources/excel?view=graph-rest-1.0) stored in -# Microsoft OneDrive. If you have more than one call to make within a certain period of time, Microsoft recommends to -# create a session and pass the session ID with each request. By default, this connector uses sessionless. -@display {label: "Microsoft Excel", iconPath: "icon.png"} +# Ballerina Microsoft Excel client provides the capability to access Microsoft Graph Excel API to perform +# CRUD (Create, Read, Update, and Delete) operations on Excel workbooks stored in Microsoft OneDrive for Business, +# SharePoint site or Group drive. public isolated client class Client { - private final http:Client excelClient; - # Initializes the connector. During initialization you can pass either http:BearerTokenConfig if you have a bearer - # token or http:OAuth2RefreshTokenGrantConfig if you have OAuth tokens. - # Create a Microsoft account and obtain tokens following - # [this guide](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols) - # - # + configuration - Configurations required to initialize the client - # + return - An error on failure of initialization or else `()` - public isolated function init(ConnectionConfig config) returns error? { - http:ClientConfiguration httpClientConfig = check config:constructHTTPClientConfig(config); - self.excelClient = check new (BASE_URL, httpClientConfig); - } - - # Creates a session. - # Excel APIs supports two types of sessions - # Persistent session - All changes made to the workbook are persisted (saved). This is the most efficient and - # performant mode of operation. - # Non-persistent session - Changes made by the API are not saved to the source location. Instead, the Excel backend - # server keeps a temporary copy of the file that reflects the changes made during that particular API session. - # When the Excel session expires, the changes are lost. This mode is useful for apps that need to do analysis or - # obtain the results of a calculation or a chart image, but not affect the document state. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + persistChanges - All changes made to the workbook are persisted or not? - # + return - Session ID or error - @display {label: "Creates Session"} - remote isolated function createSession(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Persistent Session"} boolean persistChanges = true) - returns @display {label: "Session ID"} string|error { - string path = check createRequestPath([CREATE_SESSION], workbookIdOrPath); - json payload = {persistChanges: persistChanges}; - record {string id;} response = check self.excelClient->post(path, payload); - return response.id; - } - - # Adds a new worksheet to the workbook. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetName - The name of the worksheet to be added. If specified, name should be unqiue. If not specified, - # Excel determines the name of the new worksheet - # + sessionId - Session ID - # + return - `Worksheet` record or else an `error` if failed - @display {label: "Add Worksheet"} - remote isolated function addWorksheet(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name"} string? worksheetName = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Worksheet|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, ADD], workbookIdOrPath, - sessionId); - json payload = {name: worksheetName}; - return check self.excelClient->post(path, payload, headers, targetType = Worksheet); - } - - # Retrieves the properties of a worksheet. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + sessionId - Session ID - # + return - `Worksheet` record or else an `error` if failed - @display {label: "Get Worksheet"} - remote isolated function getWorksheet(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Session ID"} string? sessionId = ()) - returns Worksheet|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId], - workbookIdOrPath, sessionId); - return check self.excelClient->get(path, headers, targetType = Worksheet); - } - - # Retrieves a list of worksheets. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Worksheet` record list or else an `error` if failed - @display {label: "List Worksheets"} - remote isolated function listWorksheets(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns @display {label: "Worksheet List"} Worksheet[]|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS], workbookIdOrPath, - sessionId, query); - http:Response response = check self.excelClient->get(path, headers); - return getWorksheetArray(response); - } - - # Update the properties of worksheet. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + worksheet - 'Worksheet' record contains values for relevant fields that should be updated - # + sessionId - Session ID - # + return - `Worksheet` record or else an `error` if failed - @display {label: "Update Worksheet"} - remote isolated function updateWorksheet(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Values need to be Updated"} Worksheet worksheet, - @display {label: "Session ID"} string? sessionId = ()) - returns Worksheet|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId], - workbookIdOrPath, sessionId); - json payload = check worksheet.cloneWithType(json); - return check self.excelClient->patch(path, payload, headers, targetType = Worksheet); - } - - # Gets the range object containing the single cell based on row and column numbers. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + row - number of the cell to be retrieved. Zero-indexed - # + column - Column number of the cell to be retrieved. Zero-indexed - # + sessionId - Session ID - # + return - `Cell` record or else an `error` if failed - @display {label: "Get Cell"} - remote isolated function getCell(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Row Number"} int row, - @display {label: "Column Number"} int column, - @display {label: "Session ID"} string? sessionId = ()) returns Cell|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, CELL - + OPEN_ROUND_BRACKET + ROW + EQUAL_SIGN + row.toString() + COMMA + COLUMN + EQUAL_SIGN + column.toString() - + CLOSE_ROUND_BRACKET], workbookIdOrPath, sessionId); - return check self.excelClient->get(path, headers, targetType = Cell); - } - - # Deletes the worksheet from the workbook. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Delete Worksheet"} - remote isolated function deleteWorksheet(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Session ID"} string? sessionId = ()) - returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId], - workbookIdOrPath, sessionId); - http:Response response = check self.excelClient->delete(path, headers = headers); - _ = check handleResponse(response); - } - - # Creates a new table. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + address - Range address or name of the range object representing the data source - # + hasHeaders - Boolean value that indicates whether the data being imported has column labels. If the source does - # not contain headers (i.e,. when this property set to false), Excel will automatically generate - # header shifting the data down by one row - # + sessionId - Session ID - # + return - `Table` record or else an `error` if failed - @display {label: "Add Table"} - remote isolated function addTable(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Range Address"} string address, - @display {label: "Has Column Labels?"} boolean? hasHeaders = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Table|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, ADD], workbookIdOrPath, sessionId); - json payload = {address: address, hasHeaders: hasHeaders}; - return check self.excelClient->post(path, payload, headers, targetType = Table); - } - - # Retrieves the properties of table. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Table` record or else an `error` if failed - @display {label: "Get Table"} - remote isolated function getTable(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Table|error { - [string, map?] [path, headers] = check createRequestParams([TABLES, tableNameOrId], - workbookIdOrPath, sessionId, query); - return check self.excelClient->get(path, headers, targetType = Table); - } - - # Retrieves a list of tables. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Table` record list or else an `error` if failed - @display {label: "List Tables"} - remote isolated function listTables(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string? worksheetNameOrId = (), - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns @display {label: "Table List"} Table[]|error { - [string, map?] [path, headers] = worksheetNameOrId is string ? check createRequestParams( - [WORKSHEETS, worksheetNameOrId, TABLES], workbookIdOrPath, query) : check createRequestParams([TABLES], - workbookIdOrPath, sessionId, query); - http:Response response = check self.excelClient->get(path, headers); - return getTableArray(response); - } - - # Updates the properties of a table. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + 'table - `Table` record contains the values for relevant fields that should be updated - # + sessionId - Session ID - # + return - `Table` record or else an `error` if failed - @display {label: "Update Table"} - remote isolated function updateTable(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Values need to be Updated"} Table 'table, - @display {label: "Session ID"} string? sessionId = ()) - returns Table|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId], workbookIdOrPath, sessionId); - json payload = check 'table.cloneWithType(json); - return check self.excelClient->patch(path, payload, headers, targetType = Table); - } - - # Adds rows to the end of the table. Note that the API can accept multiple rows data using this operation. Adding - # one row at a time could lead to performance degradation. The recommended approach would be to batch the rows - # together in a single call rather than doing single row insertion. For best results, collect the rows to be - # inserted on the application side and perform single rows add operation. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + values - A 2-dimensional array of unformatted values of the table rows (boolean or string or number). - # + index - Specifies the relative position of the new row. If null, the addition happens at the end. Any rows below - # the inserted row are shifted downwards. Zero-indexed - # + sessionId - Session ID - # + return - `Row` record or else an `error` if failed - @display {label: "Create Row"} - remote isolated function createRow(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Values"} json values, - @display {label: "Index"} int? index = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Row|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, ROWS, ADD], workbookIdOrPath, sessionId); - json payload = {values: values, index: index}; - return check self.excelClient->post(path, payload, headers, targetType = Row); - } - - # Retrieves a list of table rows. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Row` record list or else an `error` if failed - @display {label: "List Rows"} - remote isolated function listRows(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns @display {label: "Row List"} Row[]|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, ROWS], workbookIdOrPath, sessionId, query); - http:Response response = check self.excelClient->get(path, headers); - return getRowArray(response); - } - - # Updates the properties of a row. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + index - The index number of the row within the rows collection of the table - # + values - A 2-dimensional array of unformatted values of the table rows (boolean or string or number). Provide - # values for relevant fields that should be updated. Existing properties that are not included in the request will - # maintain their previous values or be recalculated based on changes to other property values. For best performance - # you shouldn't include existing values that haven't changed - # + sessionId - Session ID - # + return - `Row` record or else an `error` if failed - @display {label: "Update Row"} - remote isolated function updateRow(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Index"} int index, - @display {label: "Values"} json[][] values, - @display {label: "Session ID"} string? sessionId = ()) - returns Row|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, ROWS, ITEM_AT + OPEN_ROUND_BRACKET + INDEX + EQUAL_SIGN + index.toString() + - CLOSE_ROUND_BRACKET], workbookIdOrPath, sessionId); - json payload = {values: values}; - return check self.excelClient->patch(path, payload, headers, targetType = Row); - } - - # Deletes the row from the table. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + index - Row index - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Delete Row"} - remote isolated function deleteRow(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Index"} int index, - @display {label: "Session ID"} string? sessionId = ()) returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, ROWS, ITEM_AT + OPEN_ROUND_BRACKET + INDEX + EQUAL_SIGN + index.toString() + - CLOSE_ROUND_BRACKET], workbookIdOrPath, sessionId); - http:Response response = check self.excelClient->delete(path, headers = headers); - _ = check handleResponse(response); - } - - # Creates a new table column. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + values - A 2-dimensional array of unformatted values of the table columns (boolean or string or number). - # + index - The index number of the column within the columns collection of the table - # + sessionId - Session ID - # + return - `Column` record or else an `error` if failed - @display {label: "Create Column"} - remote isolated function createColumn(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Values"} json values, - @display {label: "Index"} int? index = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Column|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, COLUMNS, ADD], workbookIdOrPath, sessionId); - json payload = {values: values, index: index}; - return check self.excelClient->post(path, payload, headers, targetType = Column); - } - - # Retrieves a list of table columns. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Column` record list or else an `error` if failed - @display {label: "List Columns"} - remote isolated function listColumns(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns @display {label: "Column List"} Column[]|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, COLUMNS], workbookIdOrPath, sessionId, query); - http:Response response = check self.excelClient->get(path, headers); - return getColumnArray(response); - } - - # Updates the properties of a column. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a workbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + index - The index number of the column within the columns collection of the table - # + values - A 2-dimensional array of unformatted values of the table rows (boolean or string or number). Provide - # values for relevant fields that should be updated. Existing properties that are not included in the request will - # maintain their previous values or be recalculated based on changes to other property values. For best performance - # you shouldn't include existing values that haven't changed - # + name - The name of the table column - # + sessionId - Session ID - # + return - `Column` record or else an `error` if failed - @display {label: "Update Column"} - remote isolated function updateColumn(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Index"} int index, - @display {label: "Values"} json[][]? values = (), - @display {label: "Column Name"} string? name = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Column|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, COLUMNS, ITEM_AT + OPEN_ROUND_BRACKET + INDEX + EQUAL_SIGN + index.toString() - + CLOSE_ROUND_BRACKET], workbookIdOrPath, sessionId); - map payload = {index: index}; - if (name is string) { - payload["name"] = name; - } - if (values is json[][]) { - payload["values"] = values; - } - return check self.excelClient->patch(path, payload, headers, targetType = Column); - } - - # Deletes a column from the table. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + index - The index number of the column within the columns collection of the table - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Delete Column"} - remote isolated function deleteColumn(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Index"} int index, - @display {label: "Session ID"} string? sessionId = ()) returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId, COLUMNS, ITEM_AT + OPEN_ROUND_BRACKET + INDEX + EQUAL_SIGN + index.toString() - + CLOSE_ROUND_BRACKET], workbookIdOrPath, sessionId); - http:Response response = check self.excelClient->delete(path, headers = headers); - _ = check handleResponse(response); - } - - # Deletes a table. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + tableNameOrId - Table name or ID - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Delete Table"} - remote isolated function deleteTable(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Table Name or ID"} string tableNameOrId, - @display {label: "Session ID"} string? sessionId = ()) returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - TABLES, tableNameOrId], workbookIdOrPath, sessionId); - http:Response response = check self.excelClient->delete(path, headers = headers); - _ = check handleResponse(response); - } - - # Creates a new chart. - # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + type - Represents the type of a chart. The possible values are: ColumnClustered, ColumnStacked, - # ColumnStacked100, BarClustered, BarStacked, BarStacked100, LineStacked, LineStacked100, LineMarkers, - # LineMarkersStacked, LineMarkersStacked100, PieOfPie, etc. - # + sourceData - The Range object corresponding to the source data - # + seriesBy - Specifies the way columns or rows are used as data series on the chart - # + sessionId - Session ID - # + return - `Chart` record or else an `error` if failed - @display {label: "Add Chart"} - remote isolated function addChart(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Type"} string 'type, - @display {label: "Data"} json sourceData, SeriesBy? seriesBy = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Chart|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, ADD], workbookIdOrPath, sessionId); - json payload = {'type: 'type, sourceData: sourceData, seriesBy: seriesBy}; - return check self.excelClient->post(path, payload, headers, targetType = Chart); - } + final excel:Client excelClient; - # Retrieves the properties of a chart. + # Gets invoked to initialize the `connector`. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + chartName - Chart name - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Chart` record or else an `error` if failed - @display {label: "Get Chart"} - remote isolated function getChart(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Name"} string chartName, - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns Chart|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, chartName], workbookIdOrPath, sessionId, query); - return check self.excelClient->get(path, headers, targetType = Chart); + # + 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? { + self.excelClient = check new (config, serviceUrl); } - # Retrieve a list of charts. + # Creates a new session for a workbook. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + query - Query string that can control the amount of data returned in a response. String should start with `?` - # and followed by query parameters. Example: `?$top=2&$count=true`. For more information about query - # parameters, refer https://docs.microsoft.com/en-us/graph/query-parameters - # + sessionId - Session ID - # + return - `Chart` record list or else an `error` if failed - @display {label: "List Charts"} - remote isolated function listCharts(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Query"} string? query = (), - @display {label: "Session ID"} string? sessionId = ()) - returns @display {label: "Chart List"} Chart[]|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS], workbookIdOrPath, sessionId, query); - http:Response response = check self.excelClient->get(path, headers); - return getChartArray(response); + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + session - The payload to be create session + # + return - A `excel:Session` or else an error on failure + remote isolated function createSession(string itemIdOrPath, excel:Session session) returns excel:Session|error { + return self.excelClient->createSession(createSubPath(itemIdOrPath), session); } - # Updates the properties of chart. + # Refresh the existing workbook session. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + chartName - Chart name - # + chart - 'Chart' record contains values for relevant fields that should be updated - # + sessionId - Session ID - # + return - `Chart` record or else an `error` if failed - @display {label: "Update Chart"} - remote isolated function updateChart(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Name"} string chartName, - @display {label: "Values need to be Updated"} Chart chart, - @display {label: "Session ID"} string? sessionId = ()) - returns Chart|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, chartName], workbookIdOrPath, sessionId); - json payload = check chart.cloneWithType(json); - return check self.excelClient->patch(path, payload, headers, targetType = Chart); + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + sessionId - The ID of the session + # + return - An `http:Response` or error on failure + remote isolated function refreshSession(string itemIdOrPath, string sessionId) returns http:Response|error { + return self.excelClient->refreshSession(createSubPath(itemIdOrPath), sessionId); } - # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # Close the existing workbook session. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + chartName - Chart name - # + width - The desired width of the resulting image - # + 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 - Session ID - # + return - Base-64 image string or else an `error` if failed - @display {label: "Get Chart Image"} - remote isolated function getChartImage(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Name"} string chartName, - @display {label: "Chart Width"} int? width = (), - @display {label: "Chart Height"} int? height = (), - FittingMode? fittingMode = (), - @display {label: "Session ID"} string? sessionId = ()) - returns @display {label: "Base-64 Chart Image"} string|error { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, chartName, IMAGE], workbookIdOrPath, sessionId); - path = setOptionalParamsToPath(path, width, height, fittingMode); - http:Response response = check self.excelClient->get(path, headers); - map handledResponse = check handleResponse(response); - return handledResponse[VALUE].toString(); + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + sessionId - The ID of the session + # + return - An `http:Response` or else error on failure + remote isolated function closeSession(string itemIdOrPath, string sessionId) returns http:Response|error { + return self.excelClient->closeSession(createSubPath(itemIdOrPath), sessionId); } - # Resets the source data for the chart. + # Recalculate all currently opened workbooks in Excel. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + chartName - Chart name - # + sourceData - The Range object corresponding to the source data - # + seriesBy - Specifies the way columns or rows are used as data series on the chart - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Reset Chart Data"} - remote isolated function resetChartData(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Name"} string chartName, - @display {label: "Data"} json sourceData, SeriesBy? seriesBy = (), - @display {label: "Session ID"} string? sessionId = ()) - returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, chartName, SET_DATA], workbookIdOrPath, sessionId); - json payload = {sourceData: sourceData, seriesBy: seriesBy}; - http:Response response = check self.excelClient->post(path, payload, headers); - _ = check handleResponse(response); + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + calculationMode - The payload to be calculate 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 { + return self.excelClient->calculateApplication(createSubPath(itemIdOrPath), calculationMode, sessionId); } - # Positions the chart relative to cells on the worksheet. + # Get the properties and relationships of the application. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + chartName - Chart name - # + startCell - The start cell. This is where the chart will be moved to. The start cell is the top-left or - # top-right cell, depending on the user's right-to-left display settings. - # + endCell - The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Set Chart Position"} - remote isolated function setChartPosition(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Name"} string chartName, - @display {label: "Start Cell"} string startCell, - @display {label: "End Cell"} string? endCell = (), - @display {label: "Session ID"} string? sessionId = ()) - returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, chartName, SET_POSITION], workbookIdOrPath, sessionId); - json payload = {startCell: startCell, endCell: endCell}; - http:Response response = check self.excelClient->post(path, payload, headers); - _ = check handleResponse(response); + # + 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 self.excelClient->getApplication(createSubPath(itemIdOrPath), sessionId); } - # Deletes a chart. + # Retrieve a list of comment. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + worksheetNameOrId - Worksheet name or ID - # + chartName - Chart name - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Delete Chart"} - remote isolated function deleteChart(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Worksheet Name or ID"} string worksheetNameOrId, - @display {label: "Chart Name"} string chartName, - @display {label: "Session ID"} string? sessionId = ()) - returns error? { - [string, map?] [path, headers] = check createRequestParams([WORKSHEETS, worksheetNameOrId, - CHARTS, chartName], workbookIdOrPath, sessionId); - http:Response response = check self.excelClient->delete(path, headers = headers); - _ = check handleResponse(response); + # + 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:Comments|error { + return self.excelClient->listComments(createSubPath(itemIdOrPath), sessionId); } - # Retrieves the properties of a workbookApplication. + # Retrieve the properties and relationships of the comment. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + sessionId - Session ID - # + return - `WorkbookApplication` or else an `error` if failed - @display {label: "Get Workbook Application"} - remote isolated function getWorkbookApplication(@display {label: "Workbook ID or Path"} string workbookIdOrPath, - @display {label: "Session ID"} string? sessionId = ()) - returns WorkbookApplication|error { - [string, map?] [path, headers] = check createRequestParams([APPLICATION], workbookIdOrPath, - sessionId); - WorkbookApplication response = check self.excelClient->get(path, headers, targetType = WorkbookApplication); - return response; + # + 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 self.excelClient->getComment(createSubPath(itemIdOrPath), commentId, sessionId); } - # Recalculates all currently opened workbooks in Excel. + # Create a new reply of the comment. # - # + workbookIdOrPath - Workbook ID or file path. Path should be with the `.xlsx` extension from root. If a worksbook - # is in root, path will be `.xlsx`) - # + 'type - Specifies the calculation type to use - # + sessionId - Session ID - # + return - `()` or else an `error` if failed - @display {label: "Calculate Workbook Application"} - remote isolated function calculateWorkbookApplication(@display {label: "Workbook ID or Path"} string - workbookIdOrPath, CalculationType 'type, - @display {label: "Session ID"} string? sessionId = ()) - returns error? { - [string, map?] [path, headers] = check createRequestParams([APPLICATION, CALCULATE], - workbookIdOrPath, sessionId); - json payload = {calculationType: 'type}; - http:Response response = check self.excelClient->post(path, payload, headers); - _ = check handleResponse(response); + # + itemId - The ID of the drive containing the workbook + # + commentId - The ID of the comment to get + # + reply - The payload to be create reply + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createCommentReply(string itemId, string commentId, excel:Reply reply, string? sessionId = ()) returns excel:Reply|error { + return self.excelClient->createCommentReply(itemId, commentId, reply, sessionId); } } diff --git a/ballerina/modules/excel/client.bal b/ballerina/modules/excel/client.bal new file mode 100644 index 0000000..aa946d1 --- /dev/null +++ b/ballerina/modules/excel/client.bal @@ -0,0 +1,4312 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + +import ballerina/http; + +# Ballerina Microsoft Excel client provides the capability to access Microsoft Graph Excel API to perform CRUD (Create, Read, Update, and Delete) operations on Excel workbooks stored in Microsoft OneDrive for Business, SharePoint site or Group drive. +public isolated client class Client { + final http:Client clientEp; + # Gets invoked to initialize the `connector`. + # + # + 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(ConnectionConfig config, string serviceUrl = "https://graph.microsoft.com/v1.0/") returns error? { + http:ClientConfiguration httpClientConfig = {auth: config.auth, httpVersion: config.httpVersion, timeout: config.timeout, forwarded: config.forwarded, poolConfig: config.poolConfig, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, validation: config.validation}; + do { + if config.http1Settings is ClientHttp1Settings { + ClientHttp1Settings settings = check config.http1Settings.ensureType(ClientHttp1Settings); + httpClientConfig.http1Settings = {...settings}; + } + if config.http2Settings is http:ClientHttp2Settings { + httpClientConfig.http2Settings = check config.http2Settings.ensureType(http:ClientHttp2Settings); + } + if config.cache is http:CacheConfig { + httpClientConfig.cache = check config.cache.ensureType(http:CacheConfig); + } + if config.responseLimits is http:ResponseLimitConfigs { + httpClientConfig.responseLimits = check config.responseLimits.ensureType(http:ResponseLimitConfigs); + } + if config.secureSocket is http:ClientSecureSocket { + httpClientConfig.secureSocket = check config.secureSocket.ensureType(http:ClientSecureSocket); + } + if config.proxy is http:ProxyConfig { + httpClientConfig.proxy = check config.proxy.ensureType(http:ProxyConfig); + } + } + http:Client httpEp = check new (serviceUrl, httpClientConfig); + self.clientEp = httpEp; + return; + } + # Creates a new session for a workbook. + # + # + itemId - The ID of the drive containing the workbook + # + return - OK + remote isolated function createSession(string itemId, Session payload) returns Session|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/createSession`; + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Session response = check self.clientEp->post(resourcePath, request); + return response; + } + # Refresh the existing workbook session.. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - No Content + remote isolated function refreshSession(string itemId, string sessionId) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/refreshSession`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Close the existing workbook session. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - No Content + remote isolated function closeSession(string itemId, string sessionId) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/closeSession`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Creates a new session for a workbook. + # + # + itemPath - The full path of the workbook + # + return - OK + remote isolated function createSessionWithItemPath(string itemPath, Session payload) returns Session|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/createSession`; + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Session response = check self.clientEp->post(resourcePath, request); + return response; + } + # Refresh the existing workbook session.. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - No Content + remote isolated function refreshSessionWithItemPath(string itemPath, string sessionId) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/refreshSession`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Close an existing workbook session. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - No Content + remote isolated function closeSessionWithItemPath(string itemPath, string sessionId) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/closeSession`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Recalculate all currently opened workbooks in Excel. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function calculateApplication(string itemId, CalculationMode payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/application/calculate`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the properties and relationships of the application. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function getApplication(string itemId, string? sessionId = ()) returns Application|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/application`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Application response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Recalculate all currently opened workbooks in Excel. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function calculateApplicationWithItemPath(string itemPath, CalculationMode payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/application/calculate`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the properties and relationships of the application. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function getApplicationWithItemPath(string itemPath, string? sessionId = ()) returns Application|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/application`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Application response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of comment. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function listComments(string itemId, string? sessionId = ()) returns Comments|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Comments response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the comment. + # + # + itemId - The ID of the drive containing the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - OK + remote isolated function getComment(string itemId, string commentId, string? sessionId = ()) returns Comment|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments/${getEncodedUri(commentId)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Comment response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # List the replies of the comment. + # + # + itemId - The ID of the drive containing the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - OK. + remote isolated function listCommentReplies(string itemId, string commentId, string? sessionId = ()) returns Replies|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments/${getEncodedUri(commentId)}/replies`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Replies response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new reply of the comment. + # + # + itemId - The ID of the drive containing the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createCommentReply(string itemId, string commentId, Reply payload, string? sessionId = ()) returns Reply|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments/${getEncodedUri(commentId)}/replies`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Reply response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the reply. + # + # + itemId - The ID of the drive containing the workbook + # + commentId - The ID of the comment to get + # + replyId - The ID of the reply + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getCommentReply(string itemId, string commentId, string replyId, string? sessionId = ()) returns Reply|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments/${getEncodedUri(commentId)}/replies/${getEncodedUri(replyId)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Reply response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of comment. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function listCommentsWithItemPath(string itemPath, string? sessionId = ()) returns Comments|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Comments response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the comment. + # + # + itemPath - The full path of the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - OK + remote isolated function getCommentWithItemPath(string itemPath, string commentId, string? sessionId = ()) returns Comment|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments/${getEncodedUri(commentId)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Comment response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # List the replies of the comment. + # + # + itemPath - The full path of the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - OK. + remote isolated function listCommentRepliesWithItemPath(string itemPath, string commentId, string? sessionId = ()) returns Replies|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments/${getEncodedUri(commentId)}/replies`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Replies response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new reply of the comment. + # + # + itemPath - The full path of the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createCommentReplyWithItemPath(string itemPath, string commentId, Reply payload, string? sessionId = ()) returns Reply|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments/${getEncodedUri(commentId)}/replies`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Reply response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the reply. + # + # + itemPath - The full path of the workbook + # + commentId - The ID of the comment to get + # + replyId - The ID of the reply + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getCommentReplyWithItemPath(string itemPath, string commentId, string replyId, string? sessionId = ()) returns Reply|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments/${getEncodedUri(commentId)}/replies/${getEncodedUri(replyId)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Reply response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + 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 listWorksheets(string itemId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Worksheets|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets`; + 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); + Worksheets response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds a new worksheet to the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function addWorksheet(string itemId, CreateWorksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Worksheet response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 getWorksheet(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + 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); + Worksheet response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Delete Worksheet + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - No Content + remote isolated function deleteWorksheet(string itemId, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Update the properties of worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - Success. + remote isolated function updateWorksheet(string itemId, string worksheetIdOrName, Worksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Worksheet response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Get the used range of a worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getUsedRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/usedRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range containing the single cell based on row and column numbers. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - OK. + remote isolated function getRangeWithRowAndColumn(string itemId, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of workbook pivottable. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 listPivotTable(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTables|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables`; + 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); + PivotTables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve the properties and relationships of pivot table. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table. + # + 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 getPivotTable(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}`; + 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); + PivotTable response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Refreshes the pivot table. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function refreshPivotTable(string itemId, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refresh`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Refreshes the pivot table within a given worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function refreshAllPivotTable(string itemId, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refreshAll`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of worksheet. + # + # + itemPath - The full path of the workbook + # + 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 listWorksheetsWithIemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Worksheets|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets`; + 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); + Worksheets response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds a new worksheet to the workbook. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function addWorksheetWithIemPath(string itemPath, CreateWorksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Worksheet response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 getWorksheetWithIemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + 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); + Worksheet response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Delete Worksheet + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - No Content + remote isolated function deleteWorksheetWithIemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Update the properties of worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - Success. + remote isolated function updateWorksheetWithIemPath(string itemPath, string worksheetIdOrName, Worksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Worksheet response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Get the used range of a worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getUsedRangeWithIemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/usedRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range containing the single cell based on row and column numbers. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - OK. + remote isolated function getRangeWithRowAndColumnWithItemPath(string itemPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of workbook pivottable. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 listPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTables|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables`; + 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); + PivotTables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of workbook pivottable. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table. + # + 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 getPivotTableWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}`; + 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); + PivotTable response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Refreshes the pivot table. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function refreshPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refresh`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Refreshes the pivot table within a given worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function refreshAllPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refreshAll`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Gets the range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorksheetRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRange(string itemId, string namedItemName, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + 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 getRangeWithAddress(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRangeWithAddress(string itemId, string worksheetIdOrName, string address, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of range. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + address - The address + # + 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 getColumnRange(string itemId, string tableIdOrName, string columnIdOrName, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function updateColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function insertRange(string itemId, string namedItemName, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/insert`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function insertRangeWithAddrees(string itemId, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/insert`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function insertColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/insert`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + 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 getRangeFormat(string itemId, string namedItemName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRangeFormat(string itemId, string namedItemName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + 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 getRangeFormatWithAddress(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRangeFormatWithAddress(string itemId, string worksheetIdOrName, string address, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 getColumnRangeFormat(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function updateColumnRangeFormat(string itemId, string tableIdOrName, string columnIdOrName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function mergeRange(string itemId, string namedItemName, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function mergeRangeWithAddress(string itemId, string worksheetIdOrName, string address, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function mergeColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeRange(string itemId, string namedItemName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemId - The ID of the drive containing 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 - No Content + remote isolated function unmergeColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clear range values such as format, fill, and border. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function clearRange(string itemId, string namedItemName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clear range values such as format, fill, and border. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function clearRangeWithAddress(string itemId, string worksheetIdOrName, string address, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clear range values such as format, fill, and border. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function clearColumnRange(string itemId, string tableIdOrName, string columnIdOrName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the cells associated with the range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteCell(string itemId, string namedItemName, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/delete`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the cells associated with the range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteCellWithAddress(string itemId, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/delete`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the cells associated with the range. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function deleteColumnCell(string itemId, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/delete`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Gets the range containing the single cell based on row and column numbers. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + 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 - OK + remote isolated function getNameRangeWithRowAndColumn(string itemId, string namedItemName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range object containing the single cell based on row and column numbers. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - OK + remote isolated function getWorkSheetRangeWithRowAndColumn(string itemId, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range object containing the single cell based on row and column numbers. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + 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 - OK + remote isolated function getRangeWithRowColumnAddress(string itemId, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range object containing the single cell based on row and column numbers. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 - OK + remote isolated function getColumnRangeWithRowAndColumn(string itemId, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a column contained in the range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + column - Column number of the cell to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRangeColumn(string itemId, string namedItemName, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/column(column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a column contained in the range + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + column - Column number of the cell to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRangeColumnWithAddress(string itemId, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/column(column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a column contained in the range + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + 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 - OK + remote isolated function getColumnRangeColumn(string itemId, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/column(column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the right of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getCloumAfterRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the right of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + 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 - OK + remote isolated function getCloumAfterRangeWithCount(string itemId, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter(count=${getEncodedUri(columnCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getCloumBeforeRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + 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 - OK + remote isolated function getCloumBeforeRangeWithCount(string itemId, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore(count=${getEncodedUri(columnCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire column of the range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getEntireColumnRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/entireColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire column of the range + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getEntireColumnRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire column of the range + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function getColumnEntireColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire row of the range + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getEntireRowRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/entireRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire row of the range + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getEntireRowRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire row of the range + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function getColumnEntireRowRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last cell within the range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastCell(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/lastCell`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last cell within the range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastCellWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastCell`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last cell within the range. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function getColumnLastCell(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastCell`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last column within the range + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastColumnRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/lastColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last column within the range + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastColumnRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last column within the range + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function getColumnLastColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last row within the range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastRowRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/lastRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last row within the range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastRowRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last row within the range. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function getColumnLastRowRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of rows above a given range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRowsAboveRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of rows above a given range. + # + # + itemId - The ID of the drive containing the workbook + # + 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 - OK + remote isolated function getRowsAboveRangeWithCount(string itemId, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove(count=${getEncodedUri(rowCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRowsBelowRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range + # + # + itemId - The ID of the drive containing the workbook + # + 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 - OK + remote isolated function getRowsBelowRangeWithCount(string itemId, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow(count=${getEncodedUri(rowCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the used range of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + namedItemName - 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 - OK + remote isolated function getUsedRangeWithValuesOnly(string itemId, string namedItemName, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the used range of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + valuesOnly - A value indicating whether to return only the values in the used range + # + sessionId - The ID of the session + # + return - OK + remote isolated function getUsedRangeWithAddress(string itemId, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the used range of the given range. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + 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 - OK + remote isolated function getColumnUsedRange(string itemId, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the resized range of a range. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function getResizedRange(string itemId, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/resizedRange(deltaRows=${getEncodedUri(deltaRows)}, deltaColumns=${getEncodedUri(deltaColumns)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the range visible from a filtered range + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getVisibleView(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/visibleView`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + RangeView response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorksheetRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorkbookRangeWithItemPath(string itemPath, string namedItemName, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + 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 getRangeWithAddressItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of range. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + address - The address + # + 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 getColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemPath - The full path of 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 - OK + remote isolated function updateColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function insertRangeWithItemPath(string itemPath, string namedItemName, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/insert`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function insertRangeWithAddreesItemPath(string itemPath, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/insert`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemPath - The full path of 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 - OK + remote isolated function insertColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/insert`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + 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 getRangeFormatWithItemPath(string itemPath, string namedItemName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRangeFormatWithItemPath(string itemPath, string namedItemName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + 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 getRangeFormatWithAddressItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateRangeFormatWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 getColumnRangeFormatWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemPath - The full path of 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 - OK + remote isolated function updateColumnRangeFormatWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function mergeRangeWithItemPath(string itemPath, string namedItemName, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function mergeRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemPath - The full path of 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 - OK + remote isolated function mergeColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemPath - The full path of 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 - No Content + remote isolated function unmergeColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clear range values such as format, fill, and border. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function clearRangeWithItemPath(string itemPath, string namedItemName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clear range values such as format, fill, and border. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function clearRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clear range values such as format, fill, and border. + # + # + itemPath - The full path of 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 - OK + remote isolated function clearColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the cells associated with the range. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteCellWithItemPath(string itemPath, string namedItemName, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/delete`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the cells associated with the range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteCellWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/delete`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the cells associated with the range. + # + # + itemPath - The full path of 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 - OK + remote isolated function deleteColumnCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/delete`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Gets the range containing the single cell based on row and column numbers. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + 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 - OK + remote isolated function getNamedItemRangeWithRowColumnItemPath(string itemPath, string namedItemName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range object containing the single cell based on row and column numbers. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - OK + remote isolated function getWorkSheetRangeWithRowAndColumnItemPath(string itemPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range object containing the single cell based on row and column numbers. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + 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 - OK + remote isolated function getRangeWithRowColumnAddressItemPath(string itemPath, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range object containing the single cell based on row and column numbers. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 - OK + remote isolated function getRangeWithRowAndColumnItemPath(string itemPath, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a column contained in the range. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + column - Column number of the cell to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRangeColumnWithItemPath(string itemPath, string namedItemName, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/column(column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a column contained in the range + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + column - Column number of the cell to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRangeColumnWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/column(column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a column contained in the range + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 - OK + remote isolated function getColumnRangeColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/column(column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the right of the given range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getCloumAfterRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the right of the given range. + # + # + itemPath - The full path of the workbook + # + 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 - OK + remote isolated function getCloumAfterRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter(count=${getEncodedUri(columnCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getCloumBeforeRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range. + # + # + itemPath - The full path of the workbook + # + 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 - OK + remote isolated function getCloumBeforeRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore(count=${getEncodedUri(columnCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire column of the range. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getEntireColumnRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/entireColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire column of the range + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getEntireColumnRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire column of the range + # + # + itemPath - The full path of 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 - OK. + remote isolated function getColumnEntireColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire row of the range + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getEntireRowRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/entireRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire row of the range + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getEntireRowRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range that represents the entire row of the range + # + # + itemPath - The full path of 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 - OK + remote isolated function getColumnEntireRowRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last cell within the range. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastCellWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/lastCell`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last cell within the range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastCellWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastCell`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last cell within the range. + # + # + itemPath - The full path of 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 - OK + remote isolated function getColumnLastCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastCell`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last column within the range + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastColumnRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/lastColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last column within the range + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastColumnRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last column within the range + # + # + itemPath - The full path of 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 - OK + remote isolated function getColumnLastColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastColumn`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last row within the range. + # + # + itemPath - The full path of the workbook + # + namedItemName - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastRowRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/lastRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last row within the range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getLastRowRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the last row within the range. + # + # + itemPath - The full path of 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 - OK + remote isolated function getColumnLastRowRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastRow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of rows above a given range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRowsAboveRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of rows above a given range. + # + # + itemPath - The full path of the workbook + # + 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 - OK + remote isolated function getRowsAboveRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove(count=${getEncodedUri(rowCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function getRowsBelowRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a certain number of columns to the left of the given range + # + # + itemPath - The full path of the workbook + # + 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 - OK + remote isolated function getRowsBelowRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow(count=${getEncodedUri(rowCount)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the used range of the given range. + # + # + itemPath - The full path of the workbook + # + namedItemName - 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 - OK + remote isolated function getUsedRangeWithItemPath(string itemPath, string namedItemName, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the used range of the given range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + valuesOnly - A value indicating whether to return only the values in the used range + # + sessionId - The ID of the session + # + return - OK + remote isolated function getUsedRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the used range of the given range. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 - OK + remote isolated function getColumnUsedRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the resized range of a range. + # + # + itemPath - The full path of 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 - OK + remote isolated function getResizedRangeWithItemPath(string itemPath, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/resizedRange(deltaRows=${getEncodedUri(deltaRows)}, deltaColumns=${getEncodedUri(deltaColumns)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the range visible from a filtered range + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address + # + sessionId - The ID of the session + # + return - OK + remote isolated function getVisibleViewWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/visibleView`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + RangeView response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + 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 listWorkbookTables(string itemId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables`; + 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); + Tables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table in the worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 listTables(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables`; + 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); + Tables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new table in the workbook + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function createWorkbookTable(string itemId, CreateTablePayload payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Create a new table in the worksheet. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function createTable(string itemId, string worksheetIdOrName, CreateTablePayload payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + 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 + # + 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 getWorkbookTable(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteWorkbookTable(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorkbookTable(string itemId, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Deletes the table from the worksheet + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteTable(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the worksheet + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateTable(string itemId, string worksheetIdOrName, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function getTableRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table in the workbook. + # + # + itemPath - The full path of the workbook + # + 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 listWorkbookTablesWithItemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables`; + 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); + Tables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table in the worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 listTablesWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables`; + 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); + Tables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new table in the workbook + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function createWorkbookTableWithItemPath(string itemPath, CreateTablePayload payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Create a new table in the worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function createTableWithItemPath(string itemPath, string worksheetIdOrName, CreateTablePayload payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 getWorkbookTableWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteWorkbookTableWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorkbookTableWithItemPath(string itemPath, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table + # + 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 getTableWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from the worksheet + # + # + itemPath - The full path of 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 - OK + remote isolated function deleteTableWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the worksheet + # + # + itemPath - The full path of 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 - OK + remote isolated function updateTableWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + itemPath - The full path of 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 - OK + remote isolated function getTableRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table row in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + 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 listWorkbookTableRows(string itemId, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Rows|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds rows to the end of a table in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createWorkbookTableRow(string itemId, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of table row in the worksheet. + # + # + 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 + # + 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 listTableRows(string itemId, 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 Rows|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds rows to the end of a table in the worksheet. + # + # + 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 + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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->post(resourcePath, request, httpHeaders); + return response; + } + # 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 + # + rowIndex - The index of the table row + # + sessionId - The ID of the session + # + return - Success. + remote isolated function updateTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int rowIndex, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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 + # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - Created. + remote isolated function addTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/add`; + 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->post(resourcePath, request, httpHeaders); + return response; + } + # Gets a row based on its position in the collection. + # + # + 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 getTableRowWithIndex(string itemId, string worksheetIdOrName, string tableIdOrName, int index, 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); + 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 + # + 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 deleteTableRow(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); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Get the range associated with the entire 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 getWorkbookTableRowRangeWithIndex(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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire 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 + # + return - Success. + remote isolated function getTableRowRangeWithIndex(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table row in the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 listWorkbookTableRowsWithItemPath(string itemPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Rows|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds rows to the end of a table in the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of table row in the worksheet. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table + # + 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 listTableRowsWithItemPath(string itemPath, 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 Rows|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds rows to the end of a table in the worksheet. + # + # + itemPath - The full path of 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 - Created. + remote isolated function createTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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->post(resourcePath, request, 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 + # + rowIndex - The index of the table row + # + sessionId - The ID of the session + # + return - Success. + remote isolated function updateTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int rowIndex, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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. + # + # + itemPath - The full path of 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 - OK + remote isolated function addTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/add`; + 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->post(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 getTableRowWithIndexItemPath(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); + return response; + } + # Deletes the row from the workbook table. + # + # + 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 deleteTableRowWithItemPath(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); + return response; + } + # Get 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 - OK + remote isolated function getWorkbookTableRowRangeWithIndexItemPath(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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire 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 getTableRowRangeWithIndexItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of table column in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + 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 listWorkbookTableColumns(string itemId, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Columns|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + 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); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new table column in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function createWorkBookTableColumn(string itemId, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of table column in 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 + # + sessionId - The ID of the session + # + return - OK. + remote isolated function listTableColumns(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Columns[]|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Columns[] response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new table column in 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 + # + sessionId - The ID of the session + # + return - OK. + remote isolated function createTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the column from the table. + # + # + itemId - The ID of the drive containing 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 - No Content. + remote isolated function deleteWorkbookTableColumn(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Delete a column from a table. + # + # + 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 + # + columnIdOrName - The ID or name of the column + # + sessionId - The ID of the session + # + return - No Content. + remote isolated function deleteTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Retrieve a list of table column in the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 listWorkbookTableColumnsWithItemPath(string itemPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Columns|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + 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); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new table column in the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function createWorkBookTableColumnWithItemPath(string itemPath, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of table column in 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 + # + sessionId - The ID of the session + # + return - OK. + remote isolated function listTableColumnsWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Columns|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new table column in 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 + # + sessionId - The ID of the session + # + return - OK. + remote isolated function createTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Deletes the column from the table. + # + # + itemPath - The full path of 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 - No Content. + remote isolated function deleteWorkbookTableColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Delete a column from a table. + # + # + itemPath - The full path of 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 - No Content. + remote isolated function deleteTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Retrieve a list of chart. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - A collection of chart objects. + remote isolated function listCharts(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Charts|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts`; + 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); + Charts response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Creates a new chart + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function addChart(string itemId, string worksheetIdOrName, CreateChartPayload payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Chart response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of chart. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function getChart(string itemId, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Chart response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the chart. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function deleteChart(string itemId, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Update the properties of chart. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function updateChart(string itemId, string worksheetIdOrName, string chartIdOrName, Chart payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Chart response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Resets the source data for the chart. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function setChartData(string itemId, string worksheetIdOrName, string chartIdOrName, ResetData payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setData`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Positions the chart relative to cells on the worksheet + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function setPosition(string itemId, string worksheetIdOrName, string chartIdOrName, Position payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setPosition`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of chart series . + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + 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 - Created. + remote isolated function listChartSeries(string itemId, 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 CollectionOfChartSeries|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; + 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); + CollectionOfChartSeries response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # create a new chart series. + # + # + itemId - The ID of the drive containing 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 - Created. + remote isolated function createChartSeries(string itemId, string worksheetIdOrName, string chartIdOrName, ChartSeries payload, string? sessionId = ()) returns ChartSeries|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + ChartSeries response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Gets a chart based on its position in the collection. + # + # + itemId - The ID of the drive containing the workbook + # + 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 - OK. + remote isolated function getChartBasedOnPosition(string itemId, string worksheetIdOrName, int index, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/itemAt(index=${getEncodedUri(index)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Chart response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function getChartImage(string itemId, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getChartImageWithWidth(string itemId, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)})`; + map queryParam = {"width": width}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image. + # + height - The desired height of the resulting image. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getChartImageWithWidthHeight(string itemId, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)})`; + map queryParam = {"width": width, "height": height}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image. + # + 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 - OK. + remote isolated function getChartImageWithWidthHeightFittingMode(string itemId, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)},fittingMode=${getEncodedUri(fittingMode)})`; + map queryParam = {"width": width, "height": height, "fittingMode": fittingMode}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of chart. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - A collection of chart objects. + remote isolated function listChartsWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Charts|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts`; + 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); + Charts response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Creates a new chart + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - OK + remote isolated function addChartWithItemPath(string itemPath, string worksheetIdOrName, CreateChartPayload payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Chart response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of chart. + # + # + itemPath - The full path of 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 - OK. + remote isolated function getChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Chart response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the chart. + # + # + itemPath - The full path of 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 - OK. + remote isolated function deleteChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Update the properties of chart. + # + # + itemPath - The full path of 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 - OK. + remote isolated function updateChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, Chart payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Chart response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Resets the source data for the chart. + # + # + itemPath - The full path of 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 - OK. + remote isolated function setChartDataWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, ResetData payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setData`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Positions the chart relative to cells on the worksheet + # + # + itemPath - The full path of 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 - OK + remote isolated function setPositionWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, Position payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setPosition`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of chart series . + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + 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 - Created. + remote isolated function listChartSeriesWithItemPath(string itemPath, 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 CollectionOfChartSeries|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; + 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); + CollectionOfChartSeries response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # create a new chart series. + # + # + itemPath - The full path of 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 - Created. + remote isolated function createChartSeriesWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, ChartSeries payload, string? sessionId = ()) returns ChartSeries|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + ChartSeries response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Gets a chart based on its position in the collection. + # + # + itemPath - The full path of the workbook + # + 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 - OK. + remote isolated function getChartBasedOnPositionWithItemPath(string itemPath, string worksheetIdOrName, int index, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/itemAt(index=${getEncodedUri(index)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Chart response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemPath - The full path of 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 - OK. + remote isolated function getChartImageWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getChartImageWithWidthItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)})`; + map queryParam = {"width": width}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image. + # + height - The desired height of the resulting image. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getChartImageWithWidthHeightItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)})`; + map queryParam = {"width": width, "height": height}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image. + # + 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 - OK. + remote isolated function getChartImageWithWidthHeightFittingModeItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)},fittingMode=${getEncodedUri(fittingMode)})`; + map queryParam = {"width": width, "height": height, "fittingMode": fittingMode}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Image response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of named item. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function listWorkbookNamedItem(string itemId, string? sessionId = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds a new name to the collection of the given scope using the user's locale for the formula. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - Created. + remote isolated function addWorkbookNamedItem(string itemId, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Adds a new name to the collection of the given scope using the user's locale for the formula. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - Created. + remote isolated function addNamedItem(string itemId, string worksheetIdOrName, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the named item. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 getWorksheetNamedItems(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names`; + 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); + NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the named item. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item to get. + # + 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 getWorkbookNamedItem(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}`; + 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); + NamedItem response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of the named item . + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item to get. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function updateWorkbookNamedItem(string itemId, string name, NamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the range object that is associated with the name. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item to get. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getNamedRange(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve a list of named item. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function listWorkbookNamedItemWithItemPath(string itemPath, string? sessionId = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Adds a new name to the collection of the given scope using the user's locale for the formula. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - Created. + remote isolated function addWorkbookNamedItemWithItemPath(string itemPath, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Adds a new name to the collection of the given scope using the user's locale for the formula. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + sessionId - The ID of the session + # + return - Created. + remote isolated function addNamedItemWithItemPath(string itemPath, string worksheetIdOrName, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names/add`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the named item. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item to get. + # + 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 getWorkbookNamedItemWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}`; + 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); + NamedItem response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of the named item . + # + # + itemPath - The full path of the workbook + # + name - The name of the named item to get. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function updateWorkbookNamedItemWithItemPath(string itemPath, string name, NamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the range object that is associated with the name. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item to get. + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getNamedRangeWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } +} diff --git a/ballerina/modules/excel/types.bal b/ballerina/modules/excel/types.bal new file mode 100644 index 0000000..3d2f66c --- /dev/null +++ b/ballerina/modules/excel/types.bal @@ -0,0 +1,457 @@ +// 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"; +|}; + +public type ColumnsArr Columns[]; + +# 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. Read-only. + 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. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. + record {} 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. Read-only. + int rowCount?; + # Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + record {} text?; + # Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. + record {} valueTypes?; + # Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. + record {} 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 properties to create a named item. +public type AddNamedItemPayload Item|FormulaLocal; + +# 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 the properties to create chart. +public type CreateChartPayload 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 a list of chart. +public type Charts record { + # Represents the list of the chart + Chart[] values?; +}; + +# 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 create table. +public type CreateTablePayload record { + # Address or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used. + string address?; + # whether the data being imported has column labels. If the source doesn't contain headers (when this property set to false), Excel generates header shifting the data down by one row. + boolean hasHeaders?; +}; + +# 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)[][] 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 table. +public type Tables record { + # List of table + Table[] valuse?; +}; + +# Represents the range. +public type AnotherRange record { + # The range or address or range name + string anotherRange?; +}; + +# Represents the list of replies of the workbook comment. +public type Replies record { + # The list of replies of the workbook comment + Reply[] 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. Read-only. + 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 object. + decimal width?; +}; + +# Represents the list of table row properties. +public type Rows record { + # The list of table row + Row[] value?; +}; + +# Represents worksheet name to create worksheet. +public type CreateWorksheet record { + # Name of the new worksheet. + string name?; +}; + +# 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. Read-only + string id?; +}; + +# 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. Setting this is only allowed if the table contains a header row + boolean showFilterButton?; + # Indicates whether the header row is visible or not. This value can be set to show or remove the header row + boolean showHeaders?; + # Indicates whether the total row is visible or not. This value can be set to show or remove the total row + boolean showTotals?; + # Constant value that represents the Table style. + "TableStyleLight1"|"TableStyleLight21"|"TableStyleMedium1"|"TableStyleMedium2"|"TableStyleMedium28"|"TableStyleDark1"|"TableStyleDark11" style?; +}; + +# Represents the properties of the position. +public type Position record { + # The start cell. This is where the chart is moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings. + record {} 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[] values?; +}; + +# Represents the list of table column. +public type Columns record { + # The list of table column + Column[] value?; +}; + +public type Range record { + # Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only + string address?; + # Represents range reference for the specified range in the language of the user. Read-only. + string addressLocal?; + # Number of cells in the range. Read-only. + int cellCount?; + # Represents the total number of columns in the range. Read-only. + int columnCount?; + # Represents if all columns of the current range are hidden + boolean columnHidden?; + # Represents the column number of the first cell in the range. Zero-indexed. Read-only. + int columnIndex?; + # Represents the formula in A1-style notation. + (string|int)[][]? formulas?; + # Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. + (string|int)[][]? formulasLocal?; + # Represents the formula in R1C1-style notation. + (string|int)[][]? formulasR1C1?; + # Represents if all cells of the current range are hidden. Read-only. + boolean hidden?; + # Represents Excel's number format code for the given cell. + (string|int)[][]? numberFormat?; + # Returns the total number of rows in the range. Read-only. + int rowCount?; + # Represents if all rows of the current range are hidden. + boolean rowHidden?; + # Returns the row number of the first cell in the range. Zero-indexed. Read-only. + int rowIndex?; + # Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + (string|int)[][]? text?; + # Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. + (string|int)[][]? valueTypes?; + # Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. + (string|int)[][]? values?; +}; + +# Represents the list of worksheet. +public type Worksheets record { + # The list of worksheet + Worksheet[] value?; +}; + +# Represents the pivot table. +public type PivotTable record { + # ID of the PivotTable. Read-only. + 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. + record {} sourceData?; + # Specifies the way columns or rows are used as data series on the chart. + "Auto"|"Columns"|"Rows" seriesBy?; +}; + +# 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 ID of the table row. + string id?; + # The index of the table row. + int index?; + # The values in the table row. + (string|int)[][] values?; +}; + +# 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. `false` for non-persistent session (view mode) + boolean persistChanges; +}; diff --git a/ballerina/modules/excel/utils.bal b/ballerina/modules/excel/utils.bal new file mode 100644 index 0000000..3528057 --- /dev/null +++ b/ballerina/modules/excel/utils.bal @@ -0,0 +1,224 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + +import ballerina/url; + +type SimpleBasicType string|boolean|int|float|decimal; + +# Represents encoding mechanism details. +type Encoding record { + # Defines how multiple values are delimited + string style = FORM; + # Specifies whether arrays and objects should generate as separate fields + boolean explode = true; + # Specifies the custom content type + string contentType?; + # Specifies the custom headers + map headers?; +}; + +enum EncodingStyle { + DEEPOBJECT, FORM, SPACEDELIMITED, PIPEDELIMITED +} + +final Encoding & readonly defaultEncoding = {}; + +# Serialize the record according to the deepObject style. +# +# + parent - Parent record name +# + anyRecord - Record to be serialized +# + return - Serialized record as a string +isolated function getDeepObjectStyleRequest(string parent, record {} anyRecord) returns string { + string[] recordArray = []; + foreach [string, anydata] [key, value] in anyRecord.entries() { + if value is SimpleBasicType { + recordArray.push(parent + "[" + key + "]" + "=" + getEncodedUri(value.toString())); + } else if value is SimpleBasicType[] { + recordArray.push(getSerializedArray(parent + "[" + key + "]" + "[]", value, DEEPOBJECT, true)); + } else if value is record {} { + string nextParent = parent + "[" + key + "]"; + recordArray.push(getDeepObjectStyleRequest(nextParent, value)); + } else if value is record {}[] { + string nextParent = parent + "[" + key + "]"; + recordArray.push(getSerializedRecordArray(nextParent, value, DEEPOBJECT)); + } + recordArray.push("&"); + } + _ = recordArray.pop(); + return string:'join("", ...recordArray); +} + +# Serialize the record according to the form style. +# +# + parent - Parent record name +# + anyRecord - Record to be serialized +# + explode - Specifies whether arrays and objects should generate separate parameters +# + return - Serialized record as a string +isolated function getFormStyleRequest(string parent, record {} anyRecord, boolean explode = true) returns string { + string[] recordArray = []; + if explode { + foreach [string, anydata] [key, value] in anyRecord.entries() { + if (value is SimpleBasicType) { + recordArray.push(key, "=", getEncodedUri(value.toString())); + } else if (value is SimpleBasicType[]) { + recordArray.push(getSerializedArray(key, value, explode = explode)); + } else if (value is record {}) { + recordArray.push(getFormStyleRequest(parent, value, explode)); + } + recordArray.push("&"); + } + _ = recordArray.pop(); + } else { + foreach [string, anydata] [key, value] in anyRecord.entries() { + if (value is SimpleBasicType) { + recordArray.push(key, ",", getEncodedUri(value.toString())); + } else if (value is SimpleBasicType[]) { + recordArray.push(getSerializedArray(key, value, explode = false)); + } else if (value is record {}) { + recordArray.push(getFormStyleRequest(parent, value, explode)); + } + recordArray.push(","); + } + _ = recordArray.pop(); + } + return string:'join("", ...recordArray); +} + +# Serialize arrays. +# +# + arrayName - Name of the field with arrays +# + anyArray - Array to be serialized +# + style - Defines how multiple values are delimited +# + explode - Specifies whether arrays and objects should generate separate parameters +# + return - Serialized array as a string +isolated function getSerializedArray(string arrayName, anydata[] anyArray, string style = "form", boolean explode = true) returns string { + string key = arrayName; + string[] arrayValues = []; + if (anyArray.length() > 0) { + if (style == FORM && !explode) { + arrayValues.push(key, "="); + foreach anydata i in anyArray { + arrayValues.push(getEncodedUri(i.toString()), ","); + } + } else if (style == SPACEDELIMITED && !explode) { + arrayValues.push(key, "="); + foreach anydata i in anyArray { + arrayValues.push(getEncodedUri(i.toString()), "%20"); + } + } else if (style == PIPEDELIMITED && !explode) { + arrayValues.push(key, "="); + foreach anydata i in anyArray { + arrayValues.push(getEncodedUri(i.toString()), "|"); + } + } else if (style == DEEPOBJECT) { + foreach anydata i in anyArray { + arrayValues.push(key, "[]", "=", getEncodedUri(i.toString()), "&"); + } + } else { + foreach anydata i in anyArray { + arrayValues.push(key, "=", getEncodedUri(i.toString()), "&"); + } + } + _ = arrayValues.pop(); + } + return string:'join("", ...arrayValues); +} + +# Serialize the array of records according to the form style. +# +# + parent - Parent record name +# + value - Array of records to be serialized +# + style - Defines how multiple values are delimited +# + explode - Specifies whether arrays and objects should generate separate parameters +# + return - Serialized record as a string +isolated function getSerializedRecordArray(string parent, record {}[] value, string style = FORM, boolean explode = true) returns string { + string[] serializedArray = []; + if style == DEEPOBJECT { + int arayIndex = 0; + foreach var recordItem in value { + serializedArray.push(getDeepObjectStyleRequest(parent + "[" + arayIndex.toString() + "]", recordItem), "&"); + arayIndex = arayIndex + 1; + } + } else { + if (!explode) { + serializedArray.push(parent, "="); + } + foreach var recordItem in value { + serializedArray.push(getFormStyleRequest(parent, recordItem, explode), ","); + } + } + _ = serializedArray.pop(); + return string:'join("", ...serializedArray); +} + +# Get Encoded URI for a given value. +# +# + value - Value to be encoded +# + return - Encoded string +isolated function getEncodedUri(anydata value) returns string { + string|error encoded = url:encode(value.toString(), "UTF8"); + if (encoded is string) { + return encoded; + } else { + return value.toString(); + } +} + +# Generate query path with query parameter. +# +# + queryParam - Query parameter map +# + encodingMap - Details on serialization mechanism +# + return - Returns generated Path or error at failure of client initialization +isolated function getPathForQueryParam(map queryParam, map encodingMap = {}) returns string|error { + string[] param = []; + if (queryParam.length() > 0) { + param.push("?"); + foreach var [key, value] in queryParam.entries() { + if value is () { + _ = queryParam.remove(key); + continue; + } + Encoding encodingData = encodingMap.hasKey(key) ? encodingMap.get(key) : defaultEncoding; + if (value is SimpleBasicType) { + param.push(key, "=", getEncodedUri(value.toString())); + } else if (value is SimpleBasicType[]) { + param.push(getSerializedArray(key, value, encodingData.style, encodingData.explode)); + } else if (value is record {}) { + if (encodingData.style == DEEPOBJECT) { + param.push(getDeepObjectStyleRequest(key, value)); + } else { + param.push(getFormStyleRequest(key, value, encodingData.explode)); + } + } else { + param.push(key, "=", value.toString()); + } + param.push("&"); + } + _ = param.pop(); + } + string restOfPath = string:'join("", ...param); + return restOfPath; +} + +# Generate header map for given header values. +# +# + headerParam - Headers map +# + return - Returns generated map or error at failure of client initialization +isolated function getMapForHeaders(map headerParam) returns map { + map headerMap = {}; + foreach var [key, value] in headerParam.entries() { + if value is string || value is string[] { + headerMap[key] = value; + } else if value is int[] { + string[] stringArray = []; + foreach int intValue in value { + stringArray.push(intValue.toString()); + } + headerMap[key] = stringArray; + } else if value is SimpleBasicType { + headerMap[key] = value.toString(); + } + } + return headerMap; +} + diff --git a/ballerina/utils.bal b/ballerina/utils.bal index 9840d2f..4a8c7a8 100644 --- a/ballerina/utils.bal +++ b/ballerina/utils.bal @@ -113,6 +113,10 @@ isolated function getChartArray(http:Response response) returns Chart[]|error { return check handledResponse[VALUE].cloneWithType(ChartArray); } +isolated function createSubPath(string ItemIdOrPath) returns string { + return ItemIdOrPath.endsWith(".xlsx") ? string `items/${ItemIdOrPath}` : string `root:/${ItemIdOrPath}:`; +} + type WorkSheetArray Worksheet[]; type RowArray Row[]; diff --git a/spec.yaml b/spec.yaml new file mode 100644 index 0000000..6c5e31c --- /dev/null +++ b/spec.yaml @@ -0,0 +1,6627 @@ +openapi: 3.0.3 +info: + title: Microsoft Graph REST API Excel Resource + description: Ballerina Microsoft Excel client provides the capability to access Microsoft Graph Excel API to perform CRUD (Create, Read, Update, and Delete) operations on Excel workbooks stored in Microsoft OneDrive for Business, SharePoint site or Group drive. + version: 1.0.0 +servers: + - url: https://graph.microsoft.com/v1.0/ +security: + - OAuth2: + - client_id + - client_secret + - refresh_url + - refresh_token +components: + securitySchemes: + OAuth2: + type: oauth2 + flows: + authorizationCode: + tokenUrl: https://login.microsoftonline.com/organizations/oauth2/v2.0/token + authorizationUrl: https://login.microsoftonline.com/organizations/oauth2/v2.0/token + scopes: + write: Files.ReadWrite + schemas: + Session: + type: object + description: Represents session info of workbook. + properties: + id: + type: string + description: The ID of the workbook session + persistChanges: + type: boolean + description: Whether to create a persistent session or not. `true` for persistent session. `false` for non-persistent session (view mode) + required: + - persistChanges + CreateWorksheet: + type: object + description: Represents worksheet name to create worksheet. + properties: + name: + type: string + description: Name of the new worksheet. + Worksheet: + type: object + description: Represents the worksheet. + properties: + id: + type: string + description: The unique identifier of the worksheet + name: + type: string + description: The name of the worksheet + position: + type: integer + description: The position of the worksheet in the workbook + visibility: + type: string + description: The Visibility of the worksheet. + enum: + - Visible + - Hidden + - VeryHidden + Worksheets: + type: object + description: Represents the list of worksheet. + properties: + value: + type: array + description: The list of worksheet + items: + $ref: '#/components/schemas/Worksheet' + CalculationMode: + type: object + description: Represents the properties to recalculate all currently opened workbooks in Excel. + properties: + calculationMode: + type: string + description: Specifies the calculation type to use + enum: + - Recalculate + - Full + - FullRebuild + Application: + type: object + description: Represents the Excel application that manages the workbook. + properties: + calculationMode: + type: string + description: Returns the calculation mode used in the workbook + enum: + - Automatic + - AutomaticExceptTables + - Manual + Comment: + type: object + description: Represents the workbook comment. + properties: + content: + type: string + description: The content of the comment + contentType: + type: string + description: Indicates the type for the comment + id: + type: string + description: Represents the comment identifier. Read-only + Comments: + type: object + description: Represents the list of workbook comment. + properties: + values: + type: array + description: The list of workbook comment + items: + $ref: '#/components/schemas/Comment' + Reply: + type: object + description: Represents the reply of the workbook comments. + properties: + id: + type: string + description: The ID of the comment reply + content: + type: string + description: The content of the comment reply + contentType: + type: string + description: Indicates the type for the comment reply + Replies: + type: object + description: Represents the list of replies of the workbook comment. + properties: + value: + type: array + description: The list of replies of the workbook comment + items: + $ref: '#/components/schemas/Reply' + Row: + 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. + values: + type: array + description: The values in the table row. + items: + type: array + items: + oneOf: + - type: string + - type: integer + Rows: + type: object + description: Represents the list of table row properties. + properties: + value: + type: array + description: The list of table row + items: + $ref: '#/components/schemas/Row' + Across: + type: object + description: Represents the properties to the merge range. + properties: + across: + type: boolean + description: Set true to merge cells in each row of the specified range as separate merged cells. + default: false + ApplyTo: + type: object + description: Represents the properties to clear range values + properties: + applyTo: + type: string + description: Determines the type of clear action + enum: + - All + - Formats + - Contents + CreateTablePayload: + type: object + description: Represents the properties to create table. + properties: + address: + type: string + description: Address or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used. + hasHeaders: + type: boolean + description: whether the data being imported has column labels. If the source doesn't contain headers (when this property set to false), Excel generates header shifting the data down by one row. + Table: + type: object + description: Represents a table properties. + properties: + id: + type: string + description: A value that uniquely identifies the table in a given workbook + name: + type: string + description: The name of the table. + highlightFirstColumn: + type: boolean + description: Indicates whether the first column contains special formatting + highlightLastColumn: + type: boolean + description: Indicates whether the last column contains special formatting + legacyId: + type: string + description: Legacy ID used in older Excel clients + showBandedRows: + type: boolean + description: Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier + showBandedColumns: + type: boolean + description: Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier + showFilterButton: + type: boolean + description: Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row + showHeaders: + type: boolean + description: Indicates whether the header row is visible or not. This value can be set to show or remove the header row + showTotals: + type: boolean + description: Indicates whether the total row is visible or not. This value can be set to show or remove the total row + style: + type: string + description: Constant value that represents the Table style. + enum: + - TableStyleLight1 + - TableStyleLight21 + - TableStyleMedium1 + - TableStyleMedium2 + - TableStyleMedium28 + - TableStyleDark1 + - TableStyleDark11 + Tables: + type: object + description: Represents a list of table. + properties: + valuse: + type: array + description: List of table + items: + $ref: '#/components/schemas/Table' + Range: + type: object + properties: + address: + type: string + description: Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only + addressLocal: + type: string + description: Represents range reference for the specified range in the language of the user. Read-only. + cellCount: + type: integer + description: Number of cells in the range. Read-only. + columnCount: + type: integer + description: Represents the total number of columns in the range. Read-only. + columnHidden: + type: boolean + description: Represents if all columns of the current range are hidden + columnIndex: + type: integer + description: Represents the column number of the first cell in the range. Zero-indexed. Read-only. + formulas: + type: array + nullable: true + description: Represents the formula in A1-style notation. + items: + type: array + items: + oneOf: + - type: string + - type: integer + formulasLocal: + type: array + nullable: true + description: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. + items: + type: array + items: + oneOf: + - type: string + - type: integer + formulasR1C1: + type: array + nullable: true + description: Represents the formula in R1C1-style notation. + items: + type: array + items: + oneOf: + - type: string + - type: integer + hidden: + type: boolean + description: Represents if all cells of the current range are hidden. Read-only. + numberFormat: + type: array + nullable: true + description: Represents Excel's number format code for the given cell. + items: + type: array + items: + oneOf: + - type: string + - type: integer + rowCount: + type: integer + description: Returns the total number of rows in the range. Read-only. + rowHidden: + type: boolean + description: Represents if all rows of the current range are hidden. + rowIndex: + type: integer + description: Returns the row number of the first cell in the range. Zero-indexed. Read-only. + text: + type: array + nullable: true + description: Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + items: + type: array + items: + oneOf: + - type: string + - type: integer + valueTypes: + type: array + nullable: true + description: Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. + items: + type: array + items: + oneOf: + - type: string + - type: integer + values: + type: array + nullable: true + description: Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. + items: + type: array + items: + oneOf: + - type: string + - type: integer + RangeView: + type: object + description: Represents a range view. + properties: + cellAddresses: + type: object + description: Represents the cell addresses + columnCount: + type: integer + description: Returns the number of visible columns. Read-only. + formulas: + type: object + description: Represents the formula in A1-style notation. + formulasLocal: + type: object + description: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. + formulasR1C1: + type: object + description: Represents the formula in R1C1-style notation. + index: + type: integer + description: Index of the range + numberFormat: + type: object + description: Represents Excel's number format code for the given cell. + rowCount: + type: integer + description: Returns the total number of rows in the range. Read-only. + text: + type: object + description: Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + valueTypes: + type: object + description: Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. + values: + type: object + description: Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. + CreateChartPayload: + type: object + description: Represents the properties to create chart. + properties: + type: + type: string + description: Represents the type of a chart + sourceData: + type: string + description: The Range object corresponding to the source data + seriesBy: + type: string + description: Specifies the way columns or rows are used as data series on the chart. + enum: + - Auto + - Columns + - Rows + Chart: + type: object + description: Represents a chart properties. + properties: + height: + type: number + description: Represents the height, in points, of the chart object. + id: + type: string + description: Gets a chart based on its position in the collection. Read-only. + left: + type: number + description: The distance, in points, from the left side of the chart to the worksheet origin. + name: + type: string + description: Represents the name of a chart object. + top: + type: number + description: 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). + width: + type: number + description: Represents the width, in points, of the chart object. + Charts: + type: object + description: Represents a list of chart. + properties: + values: + type: array + items: + $ref: '#/components/schemas/Chart' + description: Represents the list of the chart + Image: + type: object + description: Represents an image. + properties: + value: + type: string + description: The image in base64-encoded + AddNamedItemPayload: + type: object + description: Represents the properties to create a named item. + oneOf: + - $ref: '#/components/schemas/Item' + - $ref: '#/components/schemas/FormulaLocal' + Item: + type: object + description: Represents the properties to add new name to the collection of the given scope. + properties: + name: + type: string + description: The name of the new named item. + type: + type: string + description: The type of the new named item. + enum: + - Range + - Formula + - Text + - Integer + - Double + - Boolean + reference: + type: string + description: The reference to the object that the new named item refers to. + comment: + type: string + description: The comment associated with the named item + FormulaLocal: + type: object + description: Represents the properties to add a new name to the collection of the given scope using the user's locale for the formula.. + properties: + name: + type: string + description: The name of the new named item. + formulas: + type: string + description: The formula or the range that the name will refer to. + comment: + type: string + description: The formula or the range that the name will refer to. + NamedItem: + type: object + description: Represents the properties of the named item. + properties: + name: + type: string + description: The name of the new named item. + type: + type: string + description: The type of the new named item. + enum: + - String + - Integer + - Double + - Range + - Boolean + comment: + type: string + description: The comment associated with this name + scopes: + type: string + description: Indicates whether the name is scoped to the workbook or to a specific worksheet. + value: + oneOf: + - type: object + - type: string + - type: array + items: + type: object + description: Represents the formula that the name is defined to refer to + visible: + type: boolean + description: Specifies whether the object is visible or not + NamedItems: + type: object + description: Represents the properties of the named item. + properties: + value: + type: array + items: + $ref: '#/components/schemas/NamedItem' + description: Represents the list of the named item + ResetData: + type: object + description: Represents the properties to reset the data of the chart. + properties: + sourceData: + type: object + description: The range corresponding to the source data. + seriesBy: + type: string + description: Specifies the way columns or rows are used as data series on the chart. + enum: + - Auto + - Columns + - Rows + Position: + type: object + description: Represents the properties of the position. + properties: + startCell: + type: object + description: The start cell. This is where the chart is moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings. + endCell: + type: string + description: The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range. + required: + - startCell + ChartSeries: + type: object + description: Represents the chart series. + properties: + name: + type: string + description: The name of a series in a chart + collectionOfChartSeries: + type: object + description: Represents the collection of the chart series. + properties: + value: + type: array + description: The collection of the chart series + items: + $ref: '#/components/schemas/ChartSeries' + Shift: + type: object + description: Represents the ways to shift the cells. + properties: + shift: + type: string + description: Specifies which way to shift the cells + enum: + - Down + - Right + - Up + - Left + AnotherRange: + type: object + description: Represents the range. + properties: + anotherRange: + type: string + description: The range or address or range name + OffsetRange: + type: object + description: Represents the offset range. + properties: + rowOffset: + type: integer + description: 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. + columnOffset: + type: integer + description: 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. + RangeFormat: + type: object + description: Represents the range format. + properties: + columnWidth: + type: number + description: Gets or sets the width of all columns within the range. If the column widths aren't uniform, null will be returned. + horizontalAlignment: + type: string + description: Represents the horizontal alignment for the specified object + enum: + - General + - Left + - Center + - Right + - Fill + - Justify + - CenterAcrossSelection + - Distributed + rowHeight: + type: number + description: Gets or sets the height of all rows in the range. If the row heights aren't uniform null will be returned. + verticalAlignment: + type: string + description: Represents the horizontal alignment for the specified object + enum: + - Top + - Center + - Bottom + - Justify + - Distributed + wrapText: + type: boolean + description: Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting. + Column: + type: object + description: Represents the table column. + properties: + id: + type: string + description: A unique key that identifies the column within the table + index: + type: integer + description: The index number of the column within the columns collection of the table. + name: + type: string + description: The name of the table column. + values: + type: array + description: The raw values of the specified range + items: + type: array + items: + oneOf: + - type: string + - type: integer + Columns: + type: object + description: Represents the list of table column. + properties: + value: + type: array + description: The list of table column + items: + $ref: '#/components/schemas/Column' + PivotTable: + type: object + description: Represents the pivot table. + properties: + id: + type: string + description: ID of the PivotTable. Read-only. + name: + type: string + description: Name of the PivotTable + PivotTables: + type: object + description: Represents the list of pivot table. + properties: + value: + type: array + description: The list of pivot table + items: + $ref: '#/components/schemas/PivotTable' + parameters: + itemId: + name: itemId + description: The ID of the drive containing the workbook + in: path + required: true + schema: + type: string + sessionId: + name: sessionId + description: The ID of the session + in: header + required: false + schema: + type: string + workbookSessionId: + name: sessionId + description: The ID of the session + in: header + required: true + schema: + type: string + itemPath: + name: itemPath + description: The full path of the workbook + in: path + required: true + schema: + type: string + worksheetIdOrName: + name: worksheetIdOrName + description: The ID or name of the worksheet + in: path + required: true + schema: + type: string + chartIdOrName: + name: chartIdOrName + description: The ID or name of the chart + in: path + required: true + schema: + type: string + replyId: + name: replyId + description: The ID of the reply + in: path + required: true + schema: + type: string + tableIdOrName: + name: tableIdOrName + description: The ID or name of the table + in: path + required: true + schema: + type: string + rowIndex: + name: rowIndex + description: The index of the table row + in: path + required: true + schema: + type: integer + address: + name: address + description: The address + in: path + required: true + schema: + type: string + index: + name: index + description: Index value of the object to be retrieved. Zero-indexed. + in: path + required: true + schema: + type: integer + namedItemName: + name: namedItemName + description: The name of the named item + in: path + required: true + schema: + type: string + columnIdOrName: + name: columnIdOrName + description: The ID or name of the column + in: path + required: true + schema: + type: string + columnCount: + name: columnCount + description: The number of columns to include in the resulting range + in: path + required: true + schema: + type: integer + rowCount: + name: rowCount + description: The number of rows to include in the resulting range + in: path + required: true + schema: + type: integer + row: + name: row + description: Row number of the cell to be retrieved. Zero-indexed. + in: path + required: true + schema: + type: integer + column: + name: column + description: Column number of the cell to be retrieved. Zero-indexed. + in: path + required: true + schema: + type: integer + count: + name: $count + description: Retrieves the total count of matching resources + in: query + schema: + type: string + expand: + name: $expand + description: Retrieves related resources + in: query + schema: + type: string + filter: + name: $filter + description: Filters results + in: query + schema: + type: string + format: + name: $format + description: Returns the results in the specified media format + in: query + schema: + type: string + orderBy: + name: $orderby + in: query + schema: + type: string + description: Orders results + search: + name: $search + description: Returns results based on search criteria + in: query + schema: + type: string + select: + name: $select + description: Filters properties(columns) + in: query + schema: + type: string + skip: + name: $skip + description: Indexes into a result set + in: query + schema: + type: integer + top: + name: $top + description: Sets the page size of results + in: query + schema: + type: integer + valuesOnly: + name: valuesOnly + description: A value indicating whether to return only the values in the used range + in: path + required: true + schema: + type: boolean + default: false + commentId: + name: commentId + description: The ID of the comment to get + in: path + required: true + schema: + type: string + deltaRows: + name: deltaRows + description: 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. + in: path + required: true + schema: + type: integer + deltaColumns: + name: deltaColumns + description: 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. + in: path + required: true + schema: + type: integer + width: + name: width + description: The desired width of the resulting image. + in: query + required: true + schema: + type: integer + height: + name: height + description: The desired height of the resulting image. + in: query + required: true + schema: + type: integer + fittingMode: + name: fittingMode + description: The method used to scale the chart to the specified dimensions (if both height and width are set)." + in: query + required: true + schema: + type: string + enum: + - Fit + - FitAndCenter + - Fill + name: + name: name + description: The name of the named item to get. + in: path + required: true + schema: + type: string + pivotTableId: + name: pivotTableId + description: The ID of the pivot table. + in: path + required: true + schema: + type: string +paths: + #___________________________________ SESSION ________________________________________ + /me/drive/items/{itemId}/workbook/createSession: + post: + summary: Creates a new session for a workbook. + operationId: createSession + description: Create a workbook session to start a persistent or non-persistent session + tags: + - session + parameters: + - $ref: '#/components/parameters/itemId' + requestBody: + content: + application/json: + schema: + description: Represents session info of workbook. + $ref: "#/components/schemas/Session" + + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/Session" + /me/drive/items/{itemId}/workbook/refreshSession: + post: + summary: Refresh the existing workbook session.. + operationId: refreshSession + description: Refresh an existing workbook session. + tags: + - session + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/workbookSessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/closeSession: + post: + summary: Close the existing workbook session. + operationId: closeSession + tags: + - session + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/workbookSessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/createSession: + post: + summary: Creates a new session for a workbook. + operationId: createSessionWithItemPath + description: Create a workbook session to start a persistent or non-persistent session + tags: + - session + parameters: + - $ref: '#/components/parameters/itemPath' + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/Session" + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/Session" + /me/drive/root:/{itemPath}:/workbook/refreshSession: + post: + summary: Refresh the existing workbook session.. + description: Refresh an existing workbook session. + operationId: refreshSessionWithItemPath + tags: + - session + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/workbookSessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/closeSession: + post: + summary: Close an existing workbook session. + description: Close an existing workbook session. + operationId: closeSessionWithItemPath + tags: + - session + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/workbookSessionId' + responses: + '204': + description: No Content + #___________________________________ WORKBOOK ________________________________________ + /me/drive/items/{itemId}/workbook/application/calculate: + post: + summary: Recalculate all currently opened workbooks in Excel. + operationId: calculateApplication + tags: + - workbook + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationMode' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/application: + get: + summary: Get the properties and relationships of the application. + operationId: getApplication + tags: + - workbook + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + /me/drive/root:/{itemPath}:/workbook/application/calculate: + post: + summary: Recalculate all currently opened workbooks in Excel. + operationId: calculateApplicationWithItemPath + tags: + - workbook + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationMode' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/application: + get: + summary: Get the properties and relationships of the application. + operationId: getApplicationWithItemPath + tags: + - workbook + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + #___________________________________ WORKBOOK COMMENTS ________________________________________ + /me/drive/items/{itemId}/workbook/comments: + get: + summary: Retrieve a list of comment. + operationId: listComments + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Comments' + /me/drive/items/{itemId}/workbook/comments/{commentId}: + get: + summary: Retrieve the properties and relationships of the comment. + operationId: getComment + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + /me/drive/items/{itemId}/workbook/comments/{commentId}/replies: + post: + summary: Create a new reply of the comment. + operationId: createCommentReply + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + get: + summary: List the replies of the comment. + operationId: listCommentReplies + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Replies' + /me/drive/items/{itemId}/workbook/comments/{commentId}/replies/{replyId}: + get: + summary: Retrieve the properties and relationships of the reply. + operationId: getCommentReply + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/replyId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + /me/drive/root:/{itemPath}:/workbook/comments: + get: + summary: Retrieve a list of comment. + operationId: listCommentsWithItemPath + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Comments' + /me/drive/root:/{itemPath}:/workbook/comments/{commentId}: + get: + summary: Retrieve the properties and relationships of the comment. + operationId: getCommentWithItemPath + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + /me/drive/root:/{itemPath}:/workbook/comments/{commentId}/replies: + post: + summary: Create a new reply of the comment. + operationId: createCommentReplyWithItemPath + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + get: + summary: List the replies of the comment. + operationId: listCommentRepliesWithItemPath + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Replies' + /me/drive/root:/{itemPath}:/workbook/comments/{commentId}/replies/{replyId}: + get: + summary: Retrieve the properties and relationships of the reply. + operationId: getCommentReplyWithItemPath + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/replyId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + #___________________________________ WORKSHEET ________________________________________ + /me/drive/items/{itemId}/workbook/worksheets: + post: + summary: Adds a new worksheet to the workbook. + operationId: AddWorksheet + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + default: {} + $ref: "#/components/schemas/CreateWorksheet" + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + get: + summary: Retrieve a list of worksheet. + operationId: listWorksheets + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $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/Worksheets' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}: + get: + summary: Retrieve the properties and relationships of worksheet. + operationId: getWorksheet + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/Worksheet' + patch: + summary: Update the properties of worksheet. + operationId: updateWorksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + delete: + summary: Delete Worksheet + operationId: deleteWorksheet + description: Delete a worksheet from a workbook. + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/usedRange: + get: + summary: Get the used range of a worksheet. + operationId: getUsedRange + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/cell(row={row},column={column}): + get: + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getRangeWithRowAndColumn + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables: + get: + summary: Retrieve a list of workbook pivottable. + operationId: listPivotTable + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/PivotTables' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: + get: + summary: Retrieve the properties and relationships of pivot table. + operationId: getPivotTable + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' + - $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/PivotTable' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refresh: + post: + summary: Refreshes the pivot table. + operationId: refreshPivotTable + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refreshAll: + post: + summary: Refreshes the pivot table within a given worksheet. + operationId: refreshAllPivotTable + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets: + post: + summary: Adds a new worksheet to the workbook. + operationId: AddWorksheetWithIemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + default: {} + $ref: "#/components/schemas/CreateWorksheet" + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + get: + summary: Retrieve a list of worksheet. + operationId: listWorksheetsWithIemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $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/Worksheets' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}: + get: + summary: Retrieve the properties and relationships of worksheet. + operationId: getWorksheetWithIemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/Worksheet' + patch: + summary: Update the properties of worksheet. + operationId: updateWorksheetWithIemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + delete: + summary: Delete Worksheet + operationId: deleteWorksheetWithIemPath + description: Delete a worksheet from a workbook. + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/usedRange: + get: + summary: Get the used range of a worksheet. + operationId: getUsedRangeWithIemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/cell(row={row},column={column}): + get: + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getRangeWithRowAndColumnWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables: + get: + summary: Retrieve a list of workbook pivottable. + operationId: listPivotTableWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/PivotTables' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: + get: + summary: Retrieve a list of workbook pivottable. + operationId: getPivotTableWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' + - $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/PivotTable' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refresh: + post: + summary: Refreshes the pivot table. + operationId: refreshPivotTableWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refreshAll: + post: + summary: Refreshes the pivot table within a given worksheet. + operationId: refreshAllPivotTableWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + #___________________________________ RANGE ________________________________________ + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range: + get: + summary: Gets the range. + operationId: getWorksheetRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + '404': + description: Range of cells not found. + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range: + patch: + summary: Update the properties of range. + operationId: updateRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): + get: + summary: Retrieve the properties and relationships of range. + operationId: getRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: + get: + summary: Retrieve the properties and relationships of range. + operationId: getColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/address' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertRangeWithAddrees + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/format: + get: + summary: Retrieve the properties and relationships of the range format + operationId: getRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getRangeFormatWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateRangeFormatWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getColumnRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateColumnRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/merge: + post: + summary: Merge the range cells into one region in the worksheet. + operationId: mergeRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteCellWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteColumnCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK +# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getBoundingRect +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getBoundingRectWithAddress +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getColumnBoundingRect +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/cell(row={row},column={column}): + get: + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getNameRangeWithRowAndColumn + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/cell(row={row},column={column}): + get: + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getWorkSheetRangeWithRowAndColumn + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/cell(row={row},column={column}): + get: + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getRangeWithRowColumnAddress + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/cell(row={row},column={column}): + get: + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getColumnRangeWithRowAndColumn + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/column(column={column}): + get: + summary: Gets a column contained in the range. + operationId: getRangeColumn + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + '404': + description: Cell not found. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/column(column={column}): + get: + summary: Gets a column contained in the range + operationId: getRangeColumnWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/column(column={column}): + get: + summary: Gets a column contained in the range + operationId: getColumnRangeColumn + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter: + get: + summary: Gets a certain number of columns to the right of the given range. + operationId: getCloumAfterRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter(count={columnCount}): + get: + summary: Gets a certain number of columns to the right of the given range. + operationId: getCloumAfterRangeWithCount + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore: + get: + summary: Gets a certain number of columns to the left of the given range. + operationId: getCloumBeforeRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore(count={columnCount}): + get: + summary: Gets a certain number of columns to the left of the given range. + operationId: getCloumBeforeRangeWithCount + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/entireColumn: + get: + summary: Gets the range that represents the entire column of the range. + operationId: getEntireColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getEntireColumnRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getColumnEntireColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/entireRow: + get: + summary: Gets the range that represents the entire row of the range + operationId: getEntireRowRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getEntireRowRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getColumnEntireRowRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/intersection: +# get: +# summary: Gets the range that represents the rectangular intersection of the given ranges. +# operationId: getIntersectionRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges. +# operationId: getIntersectionRangeWithAddress +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges +# operationId: getColumnIntersectionRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getLastCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getLastCellWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getColumnLastCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/lastColumn: + get: + summary: Gets the last column within the range + operationId: getLastColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: + get: + summary: Gets the last column within the range + operationId: getLastColumnRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: + get: + summary: Gets the last column within the range + operationId: getColumnLastColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getLastRowRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastRow: + get: + summary: Gets the last row within the range. + operationId: getLastRowRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getColumnLastRowRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getOffsetRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getOffsetRangeWithAddress +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getColumnOffsetRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getRowRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getRowRangeWithAddress +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getColumnRowRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove: + get: + summary: Gets a certain number of rows above a given range. + operationId: getRowsAboveRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove(count={rowCount}): + get: + summary: Gets a certain number of rows above a given range. + operationId: getRowsAboveRangeWithCount + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getRowsBelowRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getRowsBelowRangeWithCount + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/usedRange(valuesOnly={valuesOnly}): + get: + summary: Get the used range of the given range. + operationId: getUsedRangeWithValuesOnly + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/usedRange(valuesOnly={valuesOnly}): + get: + summary: Get the used range of the given range. + operationId: getUsedRangeWithAddress + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/usedRange(valuesOnly={valuesOnly}): + get: + summary: Get the used range of the given range. + operationId: getColumnUsedRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/resizedRange(deltaRows={deltaRows}, deltaColumns={deltaColumns}): + post: + summary: Get the resized range of a range. + operationId: getResizedRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/deltaRows' + - $ref: '#/components/parameters/deltaColumns' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: + get: + summary: Get the range visible from a filtered range + operationId: getVisibleView + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeView' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range: + get: + summary: Gets the range. + operationId: getWorksheetRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + '404': + description: Range of cells not found. + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range: + patch: + summary: Update the properties of range. + operationId: updateWorkbookRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): + get: + summary: Retrieve the properties and relationships of range. + operationId: getRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: + get: + summary: Retrieve the properties and relationships of range. + operationId: getColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/address' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertRangeWithAddreesItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/format: + get: + summary: Retrieve the properties and relationships of the range format + operationId: getRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getRangeFormatWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateRangeFormatWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getColumnRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateColumnRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/merge: + post: + summary: Merge the range cells into one region in the worksheet. + operationId: mergeRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteCellWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteCellWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteColumnCellWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK +# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getBoundingRectWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getBoundingRectWithAddressItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getColumnBoundingRectWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/cell(row={row},column={column}): + get: + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getNamedItemRangeWithRowColumnItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/cell(row={row},column={column}): + get: + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getWorkSheetRangeWithRowAndColumnItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/cell(row={row},column={column}): + get: + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getRangeWithRowColumnAddressItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/cell(row={row},column={column}): + get: + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getRangeWithRowAndColumnItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/column(column={column}): + get: + summary: Gets a column contained in the range. + operationId: getRangeColumnWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + '404': + description: Cell not found. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/column(column={column}): + get: + summary: Gets a column contained in the range + operationId: getRangeColumnWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/column(column={column}): + get: + summary: Gets a column contained in the range + operationId: getColumnRangeColumnWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter: + get: + summary: Gets a certain number of columns to the right of the given range. + operationId: getCloumAfterRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter(count={columnCount}): + get: + summary: Gets a certain number of columns to the right of the given range. + operationId: getCloumAfterRangeWithCountItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore: + get: + summary: Gets a certain number of columns to the left of the given range. + operationId: getCloumBeforeRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore(count={columnCount}): + get: + summary: Gets a certain number of columns to the left of the given range. + operationId: getCloumBeforeRangeWithCountItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/entireColumn: + get: + summary: Gets the range that represents the entire column of the range. + operationId: getEntireColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getEntireColumnRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getColumnEntireColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/entireRow: + get: + summary: Gets the range that represents the entire row of the range + operationId: getEntireRowRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getEntireRowRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getColumnEntireRowRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/intersection: +# get: +# summary: Gets the range that represents the rectangular intersection of the given ranges. +# operationId: getIntersectionRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges. +# operationId: getIntersectionRangeWithAddressItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges +# operationId: getColumnIntersectionRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getLastCellWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getLastCellWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getColumnLastCellWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/lastColumn: + get: + summary: Gets the last column within the range + operationId: getLastColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: + get: + summary: Gets the last column within the range + operationId: getLastColumnRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: + get: + summary: Gets the last column within the range + operationId: getColumnLastColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getLastRowRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastRow: + get: + summary: Gets the last row within the range. + operationId: getLastRowRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getColumnLastRowRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getOffsetRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getOffsetRangeWithAddressItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getColumnOffsetRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getRowRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getRowRangeWithAddressItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getColumnRowRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove: + get: + summary: Gets a certain number of rows above a given range. + operationId: getRowsAboveRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove(count={rowCount}): + get: + summary: Gets a certain number of rows above a given range. + operationId: getRowsAboveRangeWithCountItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getRowsBelowRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getRowsBelowRangeWithCountItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/usedRange(valuesOnly={valuesOnly}): + get: + summary: Get the used range of the given range. + operationId: getUsedRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/usedRange(valuesOnly={valuesOnly}): + get: + summary: Get the used range of the given range. + operationId: getUsedRangeWithAddressItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getColumnUsedRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getResizedRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/deltaRows' + - $ref: '#/components/parameters/deltaColumns' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: + get: + summary: Get the range visible from a filtered range + operationId: getVisibleViewWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeView' + #___________________________________ TABLES ________________________________________ + /me/drive/items/{itemId}/workbook/tables: + get: + summary: Retrieve a list of table in the workbook. + operationId: ListWorkbookTables + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $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/Tables' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables: + get: + summary: Retrieve a list of table in the worksheet. + operationId: listTables + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/Tables' + /me/drive/items/{itemId}/workbook/tables/add: + post: + summary: Create a new table in the workbook + operationId: createWorkbookTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTablePayload' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/add: + post: + summary: Create a new table in the worksheet. + operationId: createTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTablePayload' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the workbook. + description: Update the properties of table + operationId: updateWorkbookTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the workbook. + operationId: deleteWorkbookTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + get: + summary: Retrieve the properties and relationships of table. + operationId: getWorkbookTable + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the worksheet + operationId: updateTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the worksheet + operationId: deleteTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/range: + get: + summary: Get the range associated with the entire table. + operationId: getWorkbookTableRange + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: + get: + summary: Get the range associated with the entire table. + operationId: getTableRange + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables: + get: + summary: Retrieve a list of table in the workbook. + operationId: ListWorkbookTablesWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $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/Tables' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables: + get: + summary: Retrieve a list of table in the worksheet. + operationId: listTablesWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/Tables' + /me/drive/root:/{itemPath}:/workbook/tables/add: + post: + summary: Create a new table in the workbook + operationId: createWorkbookTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTablePayload' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/add: + post: + summary: Create a new table in the worksheet. + operationId: createTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTablePayload' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the workbook. + description: Update the properties of table + operationId: updateWorkbookTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the workbook. + operationId: deleteWorkbookTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + get: + summary: Retrieve the properties and relationships of table. + operationId: getWorkbookTableWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the worksheet + operationId: updateTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the worksheet + operationId: deleteTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + get: + summary: Retrieve the properties and relationships of table. + operationId: getTableWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/range: + get: + summary: Get the range associated with the entire table. + operationId: getWorkbookTableRangeWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: + get: + summary: Get the range associated with the entire table. + operationId: getTableRangeWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + #___________________________________ TABLE ROWS ________________________________________ + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows: + get: + summary: Retrieve a list of table row in the workbook. + operationId: listWorkbookTableRows + tags: + - row + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Rows' + post: + summary: Adds rows to the end of a table in the workbook. + operationId: createWorkbookTableRow + tags: + - table + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows: + get: + summary: Retrieve a list of table row in the worksheet. + operationId: listTableRows + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Rows' + post: + summary: Adds rows to the end of a table in the worksheet. + operationId: createTableRow + tags: + - table + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + patch: + summary: Update the properties of table row. + operationId: updateTableRow + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/rowIndex' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/add: + post: + summary: Adds rows to the end of the table. + operationId: addTableRow + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): + get: + summary: Gets a row based on its position in the collection. + operationId: getTableRowWithIndex + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + delete: + summary: Deletes the row from the workbook table. + operationId: deleteTableRow + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $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/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Get the range associated with the entire row. + operationId: getWorkbookTableRowRangeWithIndex + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Get the range associated with the entire row. + operationId: getTableRowRangeWithIndex + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows: + get: + summary: Retrieve a list of table row in the workbook. + operationId: listWorkbookTableRowsWithItemPath + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Rows' + post: + summary: Adds rows to the end of a table in the workbook. + operationId: createWorkbookTableRowWithItemPath + tags: + - table + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $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. + operationId: listTableRowsWithItemPath + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Rows' + post: + summary: Adds rows to the end of a table in the worksheet. + operationId: createTableRowWithItemPath + tags: + - table + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + patch: + summary: Update the properties of table row. + operationId: updateTableRowWithItemPath + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/rowIndex' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/add: + post: + summary: Adds rows to the end of the table. + operationId: addTableRowWithItemPath + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: OK + content: + 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: getTableRowWithIndexItemPath + tags: + - tablerow + 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 + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + delete: + summary: Deletes the row from the workbook table. + operationId: deleteTableRowWithItemPath + tags: + - tablerow + 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/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Get the range associated with the entire row. + operationId: getWorkbookTableRowRangeWithIndexItemPath + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Get the range associated with the entire row. + operationId: getTableRowRangeWithIndexItemPath + tags: + - tablerow + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + #___________________________________ TABLE COLUMNS ________________________________________ + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns: + post: + summary: Create a new table column in the workbook. + operationId: createWorkBookTableColumn + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + get: + summary: Retrieve a list of table column in the workbook. + operationId: listWorkbookTableColumns + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Columns' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: + post: + summary: Create a new table column in the workbook. + operationId: createTableColumn + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + get: + summary: Retrieve a list of table column in the workbook. + operationId: listTableColumns + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Columns' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Deletes the column from the table. + operationId: deleteWorkbookTableColumn + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Delete a column from a table. + operationId: deleteTableColumn + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content. + + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns: + post: + summary: Create a new table column in the workbook. + operationId: createWorkBookTableColumnWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + get: + summary: Retrieve a list of table column in the workbook. + operationId: listWorkbookTableColumnsWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Columns' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: + post: + summary: Create a new table column in the workbook. + operationId: createTableColumnWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + get: + summary: Retrieve a list of table column in the workbook. + operationId: listTableColumnsWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Columns' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Deletes the column from the table. + operationId: deleteWorkbookTableColumnWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Delete a column from a table. + operationId: deleteTableColumnWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content. + #___________________________________ CHART ________________________________________ + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts: + get: + summary: Retrieve a list of chart. + operationId: listCharts + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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: A collection of chart objects. + content: + application/json: + schema: + $ref: '#/components/schemas/Charts' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/add: + post: + summary: Creates a new chart + operationId: addChart + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateChartPayload' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}: + get: + summary: Retrieve the properties and relationships of chart. + operationId: getChart + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + patch: + summary: Update the properties of chart. + operationId: updateChart + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + delete: + summary: Deletes the chart. + operationId: deleteChart + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setData: + post: + summary: Resets the source data for the chart. + operationId: setChartData + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResetData' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setPosition: + post: + summary: Positions the chart relative to cells on the worksheet + operationId: setPosition + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Position' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: + post: + summary: create a new chart series. + operationId: createChartSeries + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChartSeries' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/ChartSeries' + get: + summary: Retrieve a list of chart series . + operationId: listChartSeries + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $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: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/collectionOfChartSeries' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/itemAt(index={index}): + get: + summary: Gets a chart based on its position in the collection. + operationId: getChartBasedOnPosition + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image: + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImage + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidth + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthHeight + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/height' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height},fittingMode={fittingMode}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthHeightFittingMode + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/height' + - $ref: '#/components/parameters/fittingMode' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts: + get: + summary: Retrieve a list of chart. + operationId: listChartsWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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: A collection of chart objects. + content: + application/json: + schema: + $ref: '#/components/schemas/Charts' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/add: + post: + summary: Creates a new chart + operationId: addChartWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateChartPayload' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}: + get: + summary: Retrieve the properties and relationships of chart. + operationId: getChartWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + patch: + summary: Update the properties of chart. + operationId: updateChartWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + delete: + summary: Deletes the chart. + operationId: deleteChartWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setData: + post: + summary: Resets the source data for the chart. + operationId: setChartDataWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResetData' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setPosition: + post: + summary: Positions the chart relative to cells on the worksheet + operationId: setPositionWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Position' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: + post: + summary: create a new chart series. + operationId: createChartSeriesWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChartSeries' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/ChartSeries' + get: + summary: Retrieve a list of chart series . + operationId: listChartSeriesWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $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: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/collectionOfChartSeries' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/itemAt(index={index}): + get: + summary: Gets a chart based on its position in the collection. + operationId: getChartBasedOnPositionWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image: + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthHeightItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/height' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height},fittingMode={fittingMode}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthHeightFittingModeItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/height' + - $ref: '#/components/parameters/fittingMode' + - $ref: '#/components/parameters/sessionId' + + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + #___________________________________ NAMED ITEM ________________________________________ + /me/drive/items/{itemId}/workbook/names: + get: + summary: Retrieve a list of named item. + operationId: listWorkbookNamedItem + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItems' + /me/drive/items/{itemId}/workbook/names/add: + post: + summary: Adds a new name to the collection of the given scope using the user's locale for the formula. + operationId: addWorkbookNamedItem + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddNamedItemPayload' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/names/add: + post: + summary: Adds a new name to the collection of the given scope using the user's locale for the formula. + operationId: addNamedItem + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddNamedItemPayload' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/names: + get: + summary: Retrieve the properties and relationships of the named item. + operationId: getWorksheetNamedItems + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $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/NamedItems' + /me/drive/items/{itemId}/workbook/names/{name}: + get: + summary: Retrieve the properties and relationships of the named item. + operationId: getWorkbookNamedItem + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $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/NamedItem' + patch: + summary: Update the properties of the named item . + operationId: updateWorkbookNamedItem + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + /me/drive/items/{itemId}/workbook/names/{name}/range: + get: + summary: Retrieve the range object that is associated with the name. + operationId: getNamedRange + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names: + get: + summary: Retrieve a list of named item. + operationId: listWorkbookNamedItemWithItemPath + tags: + - namedItem + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItems' + /me/drive/root:/{itemPath}:/workbook/names/add: + post: + summary: Adds a new name to the collection of the given scope using the user's locale for the formula. + operationId: addWorkbookNamedItemWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddNamedItemPayload' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/names/add: + post: + summary: Adds a new name to the collection of the given scope using the user's locale for the formula. + operationId: addNamedItemWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddNamedItemPayload' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + /me/drive/root:/{itemPath}:/workbook/names/{name}: + get: + summary: Retrieve the properties and relationships of the named item. + operationId: getWorkbookNamedItemWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $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/NamedItem' + patch: + summary: Update the properties of the named item . + operationId: updateWorkbookNamedItemWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + /me/drive/root:/{itemPath}:/workbook/names/{name}/range: + get: + summary: Retrieve the range object that is associated with the name. + operationId: getNamedRangeWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' From 4ac0aaf37883a11bcf65c152f1afe702e5357d07 Mon Sep 17 00:00:00 2001 From: Kalaiyarasiganeshalingam Date: Thu, 9 Nov 2023 15:59:23 +0530 Subject: [PATCH 2/5] Improve the implementation --- .idea/.gitignore | 3 + .idea/misc.xml | 6 + .idea/module-ballerinax-microsoft.excel.iml | 9 + .idea/modules.xml | 8 + .idea/vcs.xml | 6 + ballerina/client.bal | 2850 ++++++- ballerina/modules/excel/client.bal | 5339 ++++++++----- ballerina/modules/excel/types.bal | 268 +- ballerina/modules/excel/utils.bal | 1 - ballerina/tests/test.bal | 221 +- ballerina/types.bal | 215 - ballerina/utils.bal | 113 +- spec.yaml | 7611 ++++++++++++------- 13 files changed, 11531 insertions(+), 5119 deletions(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/misc.xml create mode 100644 .idea/module-ballerinax-microsoft.excel.iml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml delete mode 100644 ballerina/types.bal diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..639900d --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/module-ballerinax-microsoft.excel.iml b/.idea/module-ballerinax-microsoft.excel.iml new file mode 100644 index 0000000..d6ebd48 --- /dev/null +++ b/.idea/module-ballerinax-microsoft.excel.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..3d13987 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/ballerina/client.bal b/ballerina/client.bal index 6727c5e..b6a2b9f 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -36,77 +36,2881 @@ public isolated client class Client { # Creates a new session for a workbook. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook - # + session - The payload to be create session + # + 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 self.excelClient->createSession(createSubPath(itemIdOrPath), session); + if isItemPath(itemIdOrPath) { + return self.excelClient->createSessionWithItemPath(itemIdOrPath, session); + } + return self.excelClient->createSession(itemIdOrPath, session); } - # Refresh the existing workbook session. + # Refreshes the existing workbook session. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + sessionId - The ID of the session # + return - An `http:Response` or error on failure remote isolated function refreshSession(string itemIdOrPath, string sessionId) returns http:Response|error { - return self.excelClient->refreshSession(createSubPath(itemIdOrPath), sessionId); + if isItemPath(itemIdOrPath) { + return self.excelClient->refreshSessionWithItemPath(itemIdOrPath, sessionId); + } + return self.excelClient->refreshSession(itemIdOrPath, sessionId); } - # Close the existing workbook session. + # Closes the existing workbook session. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + sessionId - The ID of the session # + return - An `http:Response` or else error on failure remote isolated function closeSession(string itemIdOrPath, string sessionId) returns http:Response|error { - return self.excelClient->closeSession(createSubPath(itemIdOrPath), sessionId); + if isItemPath(itemIdOrPath) { + return self.excelClient->closeSessionWithItemPath(itemIdOrPath, sessionId); + } + return self.excelClient->closeSession(itemIdOrPath, sessionId); } - # Recalculate all currently opened workbooks in Excel. + # Retrieves a list of the worksheets. + # + # + itemId - The ID of the drive containing the workbooks + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 : []; + } + + # Recalculates all currently opened workbooks in Excel. # # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook - # + calculationMode - The payload to be calculate application + # + 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 { - return self.excelClient->calculateApplication(createSubPath(itemIdOrPath), calculationMode, sessionId); + if isItemPath(itemIdOrPath) { + return self.excelClient->calculateApplicationWithItemPath(itemIdOrPath, calculationMode, sessionId); + } + return self.excelClient->calculateApplication(itemIdOrPath, calculationMode, sessionId); } - # Get the properties and relationships of the application. + # Gets the properties and relationships of the application. # # + 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 self.excelClient->getApplication(createSubPath(itemIdOrPath), sessionId); + if isItemPath(itemIdOrPath) { + return self.excelClient->getApplicationWithItemPath(itemIdOrPath, sessionId); + } + return self.excelClient->getApplication(itemIdOrPath, sessionId); } - # Retrieve a list of comment. + # Retrieves a list of comment. # # + 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:Comments|error { - return self.excelClient->listComments(createSubPath(itemIdOrPath), sessionId); + remote isolated function listComments(string itemIdOrPath, string? sessionId = ()) returns excel:Comment[]|error { + excel: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 : []; } - # Retrieve the properties and relationships of the comment. + # Retrieves the properties and relationships of the comment. # # + 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 self.excelClient->getComment(createSubPath(itemIdOrPath), commentId, sessionId); + if isItemPath(itemIdOrPath) { + return self.excelClient->getCommentWithItemPath(itemIdOrPath, commentId, sessionId); + } + return self.excelClient->getComment(itemIdOrPath, commentId, sessionId); } - # Create a new reply of the comment. + # Creates a new reply of the comment. # - # + itemId - The ID of the drive containing the workbook + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook # + commentId - The ID of the comment to get - # + reply - The payload to be create reply + # + reply - The properties of the reply to be created # + sessionId - The ID of the session - # + return - Created. - remote isolated function createCommentReply(string itemId, string commentId, excel:Reply reply, string? sessionId = ()) returns excel:Reply|error { - return self.excelClient->createCommentReply(itemId, commentId, reply, sessionId); + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->createCommentReplyWithItemPath(itemIdOrPath, commentId, reply, sessionId); + } + return self.excelClient->createCommentReply(itemIdOrPath, commentId, reply, sessionId); + } + + # Retrieves the properties and relationships of the reply. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getCommentReplyWithItemPath(itemIdOrPath, commentId, replyId, sessionId); + } + return self.excelClient->getCommentReply(itemIdOrPath, commentId, replyId, sessionId); + } + + # Lists the replies of the comment. + # + # + 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; + 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 : []; + } + + # Retrieves a list of table row 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 + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Adds rows to the end of a table 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->createWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, row, sessionId); + } + return self.excelClient->createWorkbookTableRow(itemIdOrPath, tableIdOrName, row, sessionId); + } + + # Retrieves the properties and relationships of the table row. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, index, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getWorkbookTableRow(itemIdOrPath, tableIdOrName, index, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Deletes the row from the workbook table. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to 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 - An `http:Response` or else an error on failure + remote isolated function deleteWorkbookTableRow(string itemIdOrPath, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, index, sessionId); + } + return self.excelClient->deleteWorkbookTableRow(itemIdOrPath, tableIdOrName, index, sessionId); + } + + # Gets the range associated with the entire row. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorkbookTableRowRangeWithItemPath(itemIdOrPath, tableIdOrName, index, sessionId); + } + return self.excelClient->getWorkbookTableRowRange(itemIdOrPath, tableIdOrName, index, sessionId); + } + + # Updates the properties of table row. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + tableIdOrName - The ID or name of the table + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, index, row, sessionId); + } + return self.excelClient->updateWorkbookTableRow(itemIdOrPath, tableIdOrName, index, row, sessionId); + } + + # Gets a row based on its position in the collection. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorkbookTableRowWithIndexItemPath(itemIdOrPath, tableIdOrName, index, sessionId); + } + return self.excelClient->getWorkbookTableRowWithIndex(itemIdOrPath, tableIdOrName, index, sessionId); + } + + # Adds a new worksheet. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->addWorksheetWithItemPath(itemIdOrPath, worksheet, sessionId); + } + return self.excelClient->addWorksheet(itemIdOrPath, worksheet, sessionId); + } + + # Retrieves the properties and relationships of 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 + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getWorksheet(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Gets the used range of the given range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameUsedRangeWithItemPath(itemIdOrPath, name, valuesOnly, sessionId); + } + return self.excelClient->getNameUsedRange(itemIdOrPath, name, valuesOnly, sessionId); + } + + # Updates the properties of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorksheetWithItemPath(itemIdOrPath, worksheetIdOrName, worksheet, sessionId); + } + return self.excelClient->updateWorksheet(itemIdOrPath, worksheetIdOrName, worksheet, sessionId); + } + + # Deletes worksheet. + # + # + 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 `http:Response` or else error on failure + remote isolated function deleteWorksheet(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorksheetWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); + } + return self.excelClient->deleteWorksheet(itemIdOrPath, worksheetIdOrName, sessionId); + } + + # Gets the range containing the single cell based on row and column numbers. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetCellWithItemPath(itemIdOrPath, worksheetIdOrName, row, column, sessionId); + } + return self.excelClient->getWorksheetCell(itemIdOrPath, worksheetIdOrName, row, column, sessionId); + } + + # Gets the range. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getWorksheetRange(itemIdOrPath, worksheetIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Retrieves a list of table 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 + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Adds a new table 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 + # + '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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->addWorksheetTableWithItemPath(itemIdOrPath, worksheetIdOrName, 'table, sessionId); + } + return self.excelClient->addWorksheetTable(itemIdOrPath, worksheetIdOrName, 'table, sessionId); + } + + # Retrieves a list of charts. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Creates a new chart. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->addChartWithItemPath(itemIdOrPath, worksheetIdOrName, chart, sessionId); + } + return self.excelClient->addChart(itemIdOrPath, worksheetIdOrName, chart, sessionId); + } + + # Retrieves a list of named items associated with 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 + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Retrieves a list of the workbook pivot table. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Retrieves the properties and relationships of the pivot table. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getPivotTableWithItemPath(itemIdOrPath, worksheetIdOrName, pivotTableId, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getPivotTable(itemIdOrPath, worksheetIdOrName, pivotTableId, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Refreshes the pivot table. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function refreshPivotTable(string itemIdOrPath, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->refreshPivotTableWithItemPath(itemIdOrPath, worksheetIdOrName, pivotTableId, sessionId); + } + return self.excelClient->refreshPivotTable(itemIdOrPath, worksheetIdOrName, pivotTableId, sessionId); + } + + # Refreshes all pivot tables within given worksheet. + # + # + 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 `http:Response` or else an error on failure + remote isolated function refreshAllPivotTables(string itemIdOrPath, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->refreshAllPivotTablesWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); + } + return self.excelClient->refreshAllPivotTables(itemIdOrPath, worksheetIdOrName, sessionId); + } + + # Retrieves the properties and relationships of 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeWithAddressItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getWorksheetRangeWithAddress(itemIdOrPath, worksheetIdOrName, address, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Updates the properties of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorksheetRangeWithAddressItemPath(itemIdOrPath, worksheetIdOrName, address, range, sessionId); + } + return self.excelClient->updateWorksheetRangeWithAddress(itemIdOrPath, worksheetIdOrName, address, range, sessionId); + } + + # Retrieves the properties and relationships of range. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Updates the properties of range. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, range, sessionId); + } + return self.excelClient->updateColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, range, sessionId); + } + + # Updates the properties of range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateNameRangeWithItemPath(itemIdOrPath, namedItemName, range, sessionId); + } + return self.excelClient->updateNameRange(itemIdOrPath, namedItemName, range, sessionId); + } + + # Gets the range containing the single cell based on row and column numbers. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + namedItemName - The name of the named item + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeCell(itemIdOrPath, namedItemName, row, column, sessionId); + } + return self.excelClient->getNameRangeCell(itemIdOrPath, namedItemName, row, column, sessionId); + } + + # Gets the range containing the single cell based on row and column numbers. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeCellWithItemPath(itemIdOrPath, worksheetIdOrName, row, column, sessionId); + } + return self.excelClient->getWorksheetRangeCell(itemIdOrPath, worksheetIdOrName, row, column, sessionId); + } + + # Gets the range containing the single cell based on row and column numbers. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeCellWithAddressItemPath(itemIdOrPath, worksheetIdOrName, address, row, column, sessionId); + } + return self.excelClient->getWorksheetRangeCellWithAddress(itemIdOrPath, worksheetIdOrName, address, row, column, sessionId); + } + + # Gets the range object containing the single cell based on row and column numbers. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeCellWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, row, column, sessionId); + } + return self.excelClient->getColumnRangeCell(itemIdOrPath, tableIdOrName, columnIdOrName, row, column, sessionId); + } + + # Gets a column contained in the range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeColumnWithItemPath(itemIdOrPath, name, column, sessionId); + } + return self.excelClient->getNameRangeColumn(itemIdOrPath, name, column, sessionId); + } + + # Gets a column contained in the 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeColumnWithItemPath(itemIdOrPath, worksheetIdOrName, address, column,sessionId); + } + return self.excelClient->getWorksheetRangeColumn(itemIdOrPath, worksheetIdOrName, address, column, sessionId); + } + + # Gets a column contained in the range + # + # + 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 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, column,sessionId); + } + return self.excelClient->getColumnRangeColumn(itemIdOrPath, tableIdOrName, columnIdOrName, column, sessionId); } -} + # Gets a certain number of columns to the right of the given range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetColumnsAfterRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); + } + return self.excelClient->getWorksheetColumnsAfterRange(itemIdOrPath, worksheetIdOrName, sessionId); + } + + # Gets a certain number of columns to the right of the given range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetColumnsAfterRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, columnCount, sessionId); + } + return self.excelClient->getWorksheetColumnsAfterRangeWithCount(itemIdOrPath, worksheetIdOrName, columnCount, sessionId); + } + + # Gets a certain number of columns to the left of the given range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetColumnsBeforeRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); + } + return self.excelClient->getWorksheetColumnsBeforeRange(itemIdOrPath, worksheetIdOrName, sessionId); + } + + # Gets a certain number of columns to the left of the given range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetColumnsBeforeRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, columnCount, sessionId); + } + return self.excelClient->getWorksheetColumnsBeforeRangeWithCount(itemIdOrPath, worksheetIdOrName, columnCount, sessionId); + } + + # Gets the range that represents the entire column of the range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeEntireColumnWithItemPath(itemIdOrPath, namedItemName, sessionId); + } + return self.excelClient->getNameRangeEntireColumn(itemIdOrPath, namedItemName, sessionId); + } + + # Gets the range that represents the entire column of the 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 getWorksheetRangeEntireColumn(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeEntireColumnWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->getWorksheetRangeEntireColumn(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Gets the range that represents the entire column of the range + # + # + 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 + remote isolated function getColumnRangeEntireColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeEntireColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getColumnRangeEntireColumn(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the range that represents the entire row of the range + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeEntireRowWithItemPath(itemIdOrPath, namedItemName, sessionId); + } + return self.excelClient->getNameRangeEntireRow(itemIdOrPath, namedItemName, sessionId); + } + + # Gets the range that represents the entire row of the 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 getRangeEntireRow(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeEntireRowWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->getWorksheetRangeEntireRow(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Gets the range that represents the entire row of the range + # + # + 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 + remote isolated function getColumnRangeEntireRow(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeEntireRowWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getColumnRangeEntireRow(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the last cell within the range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeLastCellWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->getNameRangeLastCell(itemIdOrPath, name, sessionId); + } + + # Gets the last cell within the 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 getRangeLastCell(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeLastCellWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->getWorksheetRangeLastCell(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Gets the last cell within the range. + # + # + 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 + remote isolated function getColumnRangeLastCell(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeLastCellWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getColumnRangeLastCell(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the last column within the range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeLastColumnWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->getNameRangeLastColumn(itemIdOrPath, name, sessionId); + } + + # Gets the last column within the 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 getWorksheetRangeLastColumn(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeLastColumnWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->getWorksheetRangeLastColumn(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Gets the last column within the range. + # + # + 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 + remote isolated function getColumnRangeLastColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeLastColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getColumnRangeLastColumn(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the last row within the range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNameRangeLastRowWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->getNameRangeLastRow(itemIdOrPath, name, sessionId); + } + + # Gets the last row within the 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 getWorksheetRangeLastRow(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRangeLastRowWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->getWorksheetRangeLastRow(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Gets the last row within the range. + # + # + 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 + remote isolated function getColumnRangeLastRow(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnRangeLastRowWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getColumnRangeLastRow(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets a certain number of rows above a given range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRowsAboveRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); + } + return self.excelClient->getWorksheetRowsAboveRange(itemIdOrPath, worksheetIdOrName, sessionId); + } + + # Gets a certain number of rows above a given range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRowsAboveRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, rowCount, sessionId); + } + return self.excelClient->getWorksheetRowsAboveRangeWithCount(itemIdOrPath, worksheetIdOrName, rowCount, sessionId); + } + + # Gets a certain number of columns to the left of the given range. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRowsBelowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, sessionId); + } + return self.excelClient->getWorksheetRowsBelowRange(itemIdOrPath, worksheetIdOrName, sessionId); + } + + # Gets a certain number of columns to the left of the given range + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetRowsBelowRangeWithCountItemPath(itemIdOrPath, worksheetIdOrName, rowCount, sessionId); + } + return self.excelClient->getWorksheetRowsBelowRangeWithCount(itemIdOrPath, worksheetIdOrName, rowCount, sessionId); + } + + # Gets the used range of the worksheet with in the given 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetUsedRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, valuesOnly, sessionId); + } + return self.excelClient->getWorksheetUsedRange(itemIdOrPath, worksheetIdOrName, address, valuesOnly, sessionId); + } + + # Get the used range of the given range. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getColumnUsedRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, valuesOnly, sessionId); + } + return self.excelClient->getColumnUsedRange(itemIdOrPath, tableIdOrName, columnIdOrName, valuesOnly, sessionId); + } + + # Clear range values such as format, fill, and border. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + name - The name of the named item + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearNameRangeWithItemPath(itemIdOrPath, name, applyTo, sessionId); + } + return self.excelClient->clearNameRange(itemIdOrPath, name, applyTo, sessionId); + } + + # Clear range values such as format, fill, and 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, applyTo, sessionId); + } + return self.excelClient->clearWorksheetRange(itemIdOrPath, worksheetIdOrName, address, applyTo, sessionId); + } + + # Clear range values such as format, fill, and 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, applyTo, sessionId); + } + return self.excelClient->clearColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, applyTo, sessionId); + } + + # Deletes the cells associated with the range. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + name - The name of the named item + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteNameRangeCellWithItemPath(itemIdOrPath, name, shift, sessionId); + } + return self.excelClient->deleteNameRangeCell(itemIdOrPath, name, shift, sessionId); + } + + # Deletes the cells associated with the 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorksheetRangeCellWithItemPath(itemIdOrPath, worksheetIdOrName, address, shift, sessionId); + } + return self.excelClient->deleteWorksheetRangeCell(itemIdOrPath, worksheetIdOrName, address, shift, sessionId); + } + + # Deletes the cells associated with the range. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteColumnRangeCellWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, shift, sessionId); + } + return self.excelClient->deleteColumnRangeCell(itemIdOrPath, tableIdOrName, columnIdOrName, shift, sessionId); + } + + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->insertNameRangeWithItemPath(itemIdOrPath, name, shift, sessionId); + } + return self.excelClient->insertNameRange(itemIdOrPath, name, shift, sessionId); + } + + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->insertWorksheetRangeWithItemPath(itemIdOrPath, worksheetIdOrName, address, shift, sessionId); + } + return self.excelClient->insertWorksheetRange(itemIdOrPath, worksheetIdOrName, address, shift, sessionId); + } + + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # + # + 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 + # + 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 { + 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. + # + # + 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 { + 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. + # + # + 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 { + 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. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->mergeColumnRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, across, sessionId); + } + return self.excelClient->mergeColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, across, sessionId); + } + + # Unmerge the range cells into separate cells. + # + # + 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 unmergeNameRange(string itemIdOrPath, string name, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->unmergeNameRangeWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->unmergeNameRange(itemIdOrPath, name, sessionId); + } + + # Unmerge 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 + 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); + } + return self.excelClient->unmergeWorksheetRange(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Unmerge 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 + 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); + } + return self.excelClient->unmergeColumnRange(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Retrieve 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 + # + sessionId - The ID of the session + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + 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. + # + # + 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 { + 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 + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + 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. + # + # + 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 { + 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 + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + 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. + # + # + 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 { + 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. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->createNameRangeBorderWithItemPath(itemIdOrPath, name, rangeBorder, sessionId); + } + return self.excelClient->createNameRangeBorder(itemIdOrPath, name, rangeBorder, sessionId); + } + + # Create 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 { + 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. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->createColumnRangeBorderWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, rangeBorder, sessionId); + } + return self.excelClient->createColumnRangeBorder(itemIdOrPath, tableIdOrName, columnIdOrName, rangeBorder, sessionId); + } + + # Retrieves a list of range borders. + # + # + 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 + # + 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 - 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; + 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 : []; + } + + # Retrieves a list of range borders. + # + # + 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 + # + 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 - 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; + 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 : []; + } + + # Retrieves a list of range borders. + # + # + 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 + # + 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 - 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; + 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 : []; + } + + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + 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 `http:Response` or else an error on failure + remote isolated function autofitNameRangeColumns(string itemIdOrPath, string name, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->autofitNameRangeColumnsWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->autofitNameRangeColumns(itemIdOrPath, name, sessionId); + } + + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + 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 `http:Response` or else an error on failure + remote isolated function autofitWorksheetRangeColumns(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->autofitWorksheetRangeColumnsWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->autofitWorksheetRangeColumns(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + 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 `http:Response` or else an error on failure + remote isolated function autofitColumnRangeColumns(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->autofitColumnRangeColumnsWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->autofitColumnRangeColumns(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + 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 `http:Response` or else an error on failure + remote isolated function autofitNameRangeRows(string itemIdOrPath, string name, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->autofitNameRangeRowsWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->autofitNameRangeRows(itemIdOrPath, name, sessionId); + } + + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + 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 `http:Response` or else an error on failure + remote isolated function autofitWorksheetRangeRows(string itemIdOrPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->autofitWorksheetRangeRowsWithItemPath(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + return self.excelClient->autofitWorksheetRangeRows(itemIdOrPath, worksheetIdOrName, address, sessionId); + } + + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + 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 `http:Response` or else an error on failure + remote isolated function autofitColumnRangeRows(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->autofitColumnRangeRowsWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->autofitColumnRangeRows(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Perform 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->performNameRangeSortWithItemPath(itemIdOrPath, name, rangeSort, sessionId); + } + return self.excelClient->performNameRangeSort(itemIdOrPath, name, rangeSort, sessionId); + } + + # Perform 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 + # + address - The address of the range + # + 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 { + 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. + # + # + 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 + # + 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 { + 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. + # + # + 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 { + 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 + # + # + 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 { + 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. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + 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. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + 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 + # + # + 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 { + 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. + # + # + 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 + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Deletes the table from 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 + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function deleteWorkbookTable(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorkbookTableWithItemPath(itemIdOrPath, tableIdOrName, sessionId); + } + return self.excelClient->deleteWorkbookTable(itemIdOrPath, tableIdOrName, sessionId); + } + + # Update the properties of table 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorkbookTableWithItemPath(itemIdOrPath, tableIdOrName, 'table, sessionId); + } + return self.excelClient->updateWorkbookTable(itemIdOrPath, tableIdOrName, 'table, sessionId); + } + + # Deletes the table from 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 + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function deleteWorksheetTable(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorksheetTableWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + return self.excelClient->deleteWorksheetTable(itemIdOrPath, tableIdOrName, worksheetIdOrName, sessionId); + } + + # Update the properties of table 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorksheetTableWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, 'table, sessionId); + } + return self.excelClient->updateWorksheetTable(itemIdOrPath, worksheetIdOrName, tableIdOrName, 'table, sessionId); + } + + # Gets the range associated with the data body of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorkbookTableBodyRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); + } + return self.excelClient->getWorkbookTableBodyRange(itemIdOrPath, tableIdOrName, sessionId); + } + + # Gets the range associated with the data body of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetTableBodyRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); + } + return self.excelClient->getWorksheetTableBodyRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Gets the range associated with header row of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorkbookTableHeaderRowRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); + } + return self.excelClient->getWorkbookTableHeaderRowRange(itemIdOrPath, tableIdOrName, sessionId); + } + + # Gets the range associated with header row of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetTableHeaderRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); + } + return self.excelClient->getWorksheetTableHeaderRowRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Gets the range associated with totals row of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorkbookTableTotalRowRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); + } + return self.excelClient->getWorkbookTableTotalRowRange(itemIdOrPath, tableIdOrName, sessionId); + } + + # Gets the range associated with totals row of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetTableTotalRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); + } + return self.excelClient->getWorksheetTableTotalRowRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Clears all the filters currently applied on 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 + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function clearWorkbookTableFilters(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearWorkbookTableFiltersWithItemPath(itemIdOrPath, tableIdOrName,sessionId); + } + return self.excelClient->clearWorkbookTableFilters(itemIdOrPath, tableIdOrName, sessionId); + } + + # Clears all the filters currently applied on 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 + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - An `http:Responsee` or else an error on failure + remote isolated function clearWorksheetTableFilters(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearWorksheetTableFiltersWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); + } + return self.excelClient->clearWorksheetTableFilters(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Converts the table into a normal range of cells. All data is preserved. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->convertWorkbookTableToRangeWithItemPath(itemIdOrPath, tableIdOrName,sessionId); + } + return self.excelClient->convertWorkbookTableToRange(itemIdOrPath, tableIdOrName, sessionId); + } + + # Converts the table into a normal range of cells. All data is preserved. + # + # + 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 convertWorksheetTableToRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->convertWorksheetTableToRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName,sessionId); + } + return self.excelClient->convertWorksheetTableToRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Reapplies all the filters currently on 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 + # + sessionId - The ID of the session + # + return - An `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); + } + return self.excelClient->reapplyWorkbookTableFilters(itemIdOrPath, tableIdOrName, sessionId); + } + + # Reapplies all the filters currently on 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 + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - An `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); + } + return self.excelClient->reapplyWorksheetTableFilters(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Retrieve 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 + # + 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 - 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 { + 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. + # + # + 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 + # + 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 - 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 { + 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. + # + # + 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 + remote isolated function performWorkbookTableSort(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->performWorkbookTableSortWithItemPath(itemIdOrPath, tableIdOrName, sessionId); + } + return self.excelClient->performWorkbookTableSort(itemIdOrPath, tableIdOrName, sessionId); + } + + # Perform 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 + # + tableIdOrName - The ID or name of the table + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->performWorksheetTableSortWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, tableSort, sessionId); + } + return self.excelClient->performWorksheetTableSort(itemIdOrPath, worksheetIdOrName, tableIdOrName, tableSort, sessionId); + } + + # Clears the sorting that is currently on 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 + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function clearWorkbookTableSort(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearWorkbookTableSortWithItemPath(itemIdOrPath, tableIdOrName, sessionId); + } + return self.excelClient->clearWorkbookTableSort(itemIdOrPath, tableIdOrName, sessionId); + } + + # Clears the sorting that is currently on 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 + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function clearWorksheetTableSort(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->clearWorksheetTableSortWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + return self.excelClient->clearWorksheetTableSort(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Reapplies the current sorting parameters 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 + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function reapplyWorkbookTableSort(string itemIdOrPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->reapplyWorkbookTableSortWithItemPath(itemIdOrPath, tableIdOrName, sessionId); + } + return self.excelClient->reapplyWorkbookTableSort(itemIdOrPath, tableIdOrName, sessionId); + } + + # Reapplies the current sorting parameters 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 + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function reapplyWorksheetTableSort(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->reapplyWorksheetTableSortWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + return self.excelClient->reapplyWorksheetTableSort(itemIdOrPath, worksheetIdOrName, tableIdOrName, sessionId); + } + + # Get the range associated with the entire table. + # + # + 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 { + 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. + # + # + 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 { + 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. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Adds rows to the end of a table 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 + # + 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 { + 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. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, rowIndex, row, sessionId); + } + return self.excelClient->updateWorksheetTableRow(itemIdOrPath, worksheetIdOrName, tableIdOrName, rowIndex, row, sessionId); + } + + # Adds rows to the end of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->addWorkbookTableRowWithItemPath(itemIdOrPath, tableIdOrName, row, sessionId); + } + return self.excelClient->addWorkbookTableRow(itemIdOrPath, tableIdOrName, row, sessionId); + } + + # Adds rows to the end of 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->addWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, row, sessionId); + } + return self.excelClient->addWorksheetTableRow(itemIdOrPath, worksheetIdOrName, tableIdOrName, row, sessionId); + } + + # Gets a row based on its position in the collection. + # + # + 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: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 { + 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. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + return self.excelClient->getWorksheetTableRow(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId, count, expand, filter, format, orderBy, search, 'select, skip, top); + } + + # Deletes the row from the workbook 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 + # + index - Index value of the object to be retrieved. Zero-indexed. + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function deleteWorksheetTableRow(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorksheetTableRowWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); + } + return self.excelClient->deleteWorksheetTableRow(itemIdOrPath, worksheetIdOrName, tableIdOrName, index, sessionId); + } + + # Get 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 { + 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. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Retrieve 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 + # + tableIdOrName - The ID or name of the table + # + 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 - 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; + 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 : []; + } + + # Create 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 { + 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. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->createWorksheetTableColumnWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, column, sessionId); + } + return self.excelClient->createWorksheetTableColumn(itemIdOrPath, worksheetIdOrName, tableIdOrName, column, sessionId); + } + + # Deletes the column from 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 + # + columnIdOrName - The ID or name of the column + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function deleteWorkbookTableColumn(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorkbookTableColumnWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->deleteWorkbookTableColumn(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Delete 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 + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + sessionId - The ID of the session + # + return - An `http:Response` or else an error on failure + remote isolated function deleteWorksheetTableColumn(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteWorksheetTableColumnWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->deleteWorksheetTableColumn(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); + } + + # Retrieve 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 + # + columnIdOrName - The ID or name of the column + # + 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 - 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 { + 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. + # + # + 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 + # + 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 - 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 { + 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 + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateWorksheetTableColumnWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, column, sessionId); + } + return self.excelClient->updateWorksheetTableColumn(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, column, sessionId); + } + + + # Update 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 - + # + 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 { + 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 + # + # + 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 { + 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 + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getworksheetTableColumnsDataBodyRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getworksheetTableColumnsDataBodyRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the range associated with the header row 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:Range` or else an error on failure + remote isolated function getworkbookTableColumnsHeaderRowRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getworkbookTableColumnsHeaderRowRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getworkbookTableColumnsHeaderRowRange(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the range associated with the header row 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 getworksheetTableColumnsHeaderRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getworksheetTableColumnsHeaderRowRangeWithItemPath(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getworksheetTableColumnsHeaderRowRange(itemIdOrPath, worksheetIdOrName, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the range associated with the totals row 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:Range` or else an error on failure + remote isolated function getworkbookTableColumnsTotalRowRange(string itemIdOrPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel:Range|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getworkbookTableColumnsTotalRowRangeWithItemPath(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + return self.excelClient->getworkbookTableColumnsTotalRowRange(itemIdOrPath, tableIdOrName, columnIdOrName, sessionId); + } + + # Gets the range associated with the totals row 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 getworksheetTableColumnsTotalRowRange(string itemIdOrPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns excel: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. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getChartWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); + } + return self.excelClient->getChart(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); + } + + # Deletes the 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 `http:Response` or else an error on failure + remote isolated function deleteChart(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns http:Response|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->deleteChartWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); + } + return self.excelClient->deleteChart(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); + } + + # Update 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->updateChartWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, chart, sessionId); + } + return self.excelClient->updateChart(itemIdOrPath, worksheetIdOrName, chartIdOrName, chart, sessionId); + } + + # Resets the source data for the 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 + # + 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 { + 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 + # + # + 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 + # + 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 { + 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 . + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Gets a chart based on its position in the collection. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getChartBasedOnPositionWithItemPath(itemIdOrPath, worksheetIdOrName, index, sessionId); + } + return self.excelClient->getChartBasedOnPosition(itemIdOrPath, worksheetIdOrName, index, sessionId); + } + + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + 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:Image` or else an error on failure + remote isolated function getChartImage(string itemIdOrPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns excel:Image|error { + if isItemPath(itemIdOrPath) { + return self.excelClient->getChartImageWithItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); + } + return self.excelClient->getChartImage(itemIdOrPath, worksheetIdOrName, chartIdOrName, sessionId); + } + + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getChartImageWithWidthItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, sessionId); + } + return self.excelClient->getChartImageWithWidth(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, sessionId); + } + + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + 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 + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getChartImageWithWidthHeightItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, height, sessionId); + } + return self.excelClient->getChartImageWithWidthHeight(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, height, sessionId); + } + + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + # + # + 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 + # + width - The desired width of the resulting image. + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getChartImageWithWidthHeightFittingModeItemPath(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, height, fittingMode, sessionId); + } + return self.excelClient->getChartImageWithWidthHeightFittingMode(itemIdOrPath, worksheetIdOrName, chartIdOrName, width, height, fittingMode, sessionId); + } + + # Retrieves a list of named items. + # + # + 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 + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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; + 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 : []; + } + + # Adds a new name to the collection of the given scope using the user's locale for the formula. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->addWorkbookNamedItemWithItemPath(itemIdOrPath, namedItem, sessionId); + } + return self.excelClient->addWorkbookNamedItem(itemIdOrPath, namedItem, sessionId); + } + + # Adds a new name to the collection of the given scope using the user's locale for the formula. + # + # + itemIdOrPath - The ID of the drive containing the workbook or the path to the workbook + # + 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 { + 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. + # + # + 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 + # + count - Retrieves the total count of matching resources + # + expand - Retrieves the related resources + # + filter - Filters the results + # + format - Returns the results in the specified media format + # + orderBy - Orders the 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 - 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 { + 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. + # + # + 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 { + 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. + # + # + 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 { + if isItemPath(itemIdOrPath) { + return self.excelClient->getNamedItemRangeWithItemPath(itemIdOrPath, name, sessionId); + } + return self.excelClient->getNamedItemRange(itemIdOrPath, name, sessionId); + } +} diff --git a/ballerina/modules/excel/client.bal b/ballerina/modules/excel/client.bal index aa946d1..4d33e96 100644 --- a/ballerina/modules/excel/client.bal +++ b/ballerina/modules/excel/client.bal @@ -50,7 +50,19 @@ public isolated client class Client { Session response = check self.clientEp->post(resourcePath, request); return response; } - # Refresh the existing workbook session.. + # Creates a new session for a workbook. + # + # + itemPath - The full path of the workbook + # + return - OK + remote isolated function createSessionWithItemPath(string itemPath, Session payload) returns Session|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/createSession`; + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Session response = check self.clientEp->post(resourcePath, request); + return response; + } + # Refreshes the existing workbook session. # # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session @@ -63,45 +75,33 @@ public isolated client class Client { http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Close the existing workbook session. + # Refreshes the existing workbook session.. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + sessionId - The ID of the session # + return - No Content - remote isolated function closeSession(string itemId, string sessionId) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/closeSession`; + remote isolated function refreshSessionWithItemPath(string itemPath, string sessionId) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/refreshSession`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Creates a new session for a workbook. - # - # + itemPath - The full path of the workbook - # + return - OK - remote isolated function createSessionWithItemPath(string itemPath, Session payload) returns Session|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/createSession`; - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Session response = check self.clientEp->post(resourcePath, request); - return response; - } - # Refresh the existing workbook session.. + # Closes the existing workbook session. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session # + return - No Content - remote isolated function refreshSessionWithItemPath(string itemPath, string sessionId) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/refreshSession`; + remote isolated function closeSession(string itemId, string sessionId) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/closeSession`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Close an existing workbook session. + # Closes an existing workbook session. # # + itemPath - The full path of the workbook # + sessionId - The ID of the session @@ -114,34 +114,68 @@ public isolated client class Client { http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Recalculate all currently opened workbooks in Excel. + # Retrieves a list of table in the workbook. # # + itemId - The ID of the drive containing the workbook # + 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 calculateApplication(string itemId, CalculationMode payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/application/calculate`; + remote isolated function listWorkbookTables(string itemId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables`; + 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"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Tables response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieves a list of table in the workbook. + # + # + itemPath - The full path of the workbook + # + 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 listWorkbookTablesWithItemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables`; + 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); + Tables response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the properties and relationships of the application. + # Recalculates all currently opened workbooks in Excel. # # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session # + return - OK - remote isolated function getApplication(string itemId, string? sessionId = ()) returns Application|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/application`; + remote isolated function calculateApplication(string itemId, CalculationMode payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/application/calculate`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Application response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Recalculate all currently opened workbooks in Excel. + # Recalculates all currently opened workbooks in Excel. # # + itemPath - The full path of the workbook # + sessionId - The ID of the session @@ -156,7 +190,19 @@ public isolated client class Client { http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the properties and relationships of the application. + # Gets the properties and relationships of the application. + # + # + itemId - The ID of the drive containing the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function getApplication(string itemId, string? sessionId = ()) returns Application|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/application`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Application response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the properties and relationships of the application. # # + itemPath - The full path of the workbook # + sessionId - The ID of the session @@ -168,7 +214,7 @@ public isolated client class Client { Application response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve a list of comment. + # Retrieves a list of comment. # # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session @@ -180,7 +226,19 @@ public isolated client class Client { Comments response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the comment. + # Retrieves a list of comment. + # + # + itemPath - The full path of the workbook + # + sessionId - The ID of the session + # + return - OK + remote isolated function listCommentsWithItemPath(string itemPath, string? sessionId = ()) returns Comments|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Comments response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieves the properties and relationships of the comment. # # + itemId - The ID of the drive containing the workbook # + commentId - The ID of the comment to get @@ -193,7 +251,20 @@ public isolated client class Client { Comment response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # List the replies of the comment. + # Retrieves the properties and relationships of the comment. + # + # + itemPath - The full path of the workbook + # + commentId - The ID of the comment to get + # + sessionId - The ID of the session + # + return - OK + remote isolated function getCommentWithItemPath(string itemPath, string commentId, string? sessionId = ()) returns Comment|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments/${getEncodedUri(commentId)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Comment response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Lists the replies of the comment. # # + itemId - The ID of the drive containing the workbook # + commentId - The ID of the comment to get @@ -206,7 +277,7 @@ public isolated client class Client { Replies response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Create a new reply of the comment. + # Creates a new reply of the comment. # # + itemId - The ID of the drive containing the workbook # + commentId - The ID of the comment to get @@ -222,46 +293,7 @@ public isolated client class Client { Reply response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of the reply. - # - # + itemId - The ID of the drive containing the workbook - # + commentId - The ID of the comment to get - # + replyId - The ID of the reply - # + sessionId - The ID of the session - # + return - OK. - remote isolated function getCommentReply(string itemId, string commentId, string replyId, string? sessionId = ()) returns Reply|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments/${getEncodedUri(commentId)}/replies/${getEncodedUri(replyId)}`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Reply response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Retrieve a list of comment. - # - # + itemPath - The full path of the workbook - # + sessionId - The ID of the session - # + return - OK - remote isolated function listCommentsWithItemPath(string itemPath, string? sessionId = ()) returns Comments|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Comments response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Retrieve the properties and relationships of the comment. - # - # + itemPath - The full path of the workbook - # + commentId - The ID of the comment to get - # + sessionId - The ID of the session - # + return - OK - remote isolated function getCommentWithItemPath(string itemPath, string commentId, string? sessionId = ()) returns Comment|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/comments/${getEncodedUri(commentId)}`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Comment response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # List the replies of the comment. + # Lists the replies of the comment. # # + itemPath - The full path of the workbook # + commentId - The ID of the comment to get @@ -274,7 +306,7 @@ public isolated client class Client { Replies response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Create a new reply of the comment. + # Creates a new reply of the comment. # # + itemPath - The full path of the workbook # + commentId - The ID of the comment to get @@ -290,7 +322,21 @@ public isolated client class Client { Reply response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of the reply. + # Retrieves the properties and relationships of the reply. + # + # + itemId - The ID of the drive containing the workbook + # + commentId - The ID of the comment to get + # + replyId - The ID of the reply + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getCommentReply(string itemId, string commentId, string replyId, string? sessionId = ()) returns Reply|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/comments/${getEncodedUri(commentId)}/replies/${getEncodedUri(replyId)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Reply response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieves the properties and relationships of the reply. # # + itemPath - The full path of the workbook # + commentId - The ID of the comment to get @@ -304,9 +350,10 @@ public isolated client class Client { Reply response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve a list of worksheet. + # Retrieves a list of table row in the workbook. # # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -317,35 +364,36 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK - 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 Worksheets|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets`; + # + return - Success. + remote isolated function listWorkbookTableRows(string itemId, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Rows|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; 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); - Worksheets response = check self.clientEp->get(resourcePath, httpHeaders); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds a new worksheet to the workbook. + # Adds rows to the end of a table in the workbook. # # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - OK - remote isolated function addWorksheet(string itemId, CreateWorksheet payload, string? sessionId = ()) returns Worksheet|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets`; + # + return - Created. + remote isolated function createWorkbookTableRow(string itemId, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Worksheet response = check self.clientEp->post(resourcePath, request, httpHeaders); + Row response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of worksheet. + # Retrieves a list of table row in the workbook. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -356,77 +404,93 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK. - remote isolated function getWorksheet(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + # + return - Success. + remote isolated function listWorkbookTableRowsWithItemPath(string itemPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Rows|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; 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); - Worksheet response = check self.clientEp->get(resourcePath, httpHeaders); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Delete Worksheet + # Adds rows to the end of a table in the workbook. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - No Content - remote isolated function deleteWorksheet(string itemId, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + # + return - Created. + remote isolated function createWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Row response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Update the properties of worksheet. + # Retrieves the properties and relationships 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 - # + return - Success. - remote isolated function updateWorksheet(string itemId, string worksheetIdOrName, Worksheet payload, string? sessionId = ()) returns Worksheet|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + # + 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 getWorkbookTableRow(string itemId, 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/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"); - Worksheet response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the used range of a worksheet. + # Deletes the row from the workbook table. # # + 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 getUsedRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/usedRange`; + # + 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); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); return response; } - # Gets the range containing the single cell based on row and column numbers. + # Updates the properties of table row. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + row - Row number of the cell to be retrieved. Zero-indexed. - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + 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 getRangeWithRowAndColumn(string itemId, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + # + 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); - Range 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; } - # Retrieve a list of workbook pivottable. + # Retrieves the properties and relationships of table row. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + 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 # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -437,74 +501,138 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK. - remote isolated function listPivotTable(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTables|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables`; + # + return - OK + remote isolated function getWorkbookTableRowWithItemPath(string itemPath, 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/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); - PivotTables response = check self.clientEp->get(resourcePath, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of pivot table. + # 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/${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/${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 the range associated with the entire row. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + pivotTableId - The ID of the pivot table. + # + 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 getPivotTable(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}`; - 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); + # + 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`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - PivotTable response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Refreshes the pivot table. + # 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 - 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a row based on its position in the collection. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + pivotTableId - The ID of the pivot table. + # + 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 refreshPivotTable(string itemId, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refresh`; + # + return - OK + 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); - http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets a row based on its position in the collection. + # + # + 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 getWorkbookTableRowWithIndexItemPath(string itemPath, string tableIdOrName, int index, 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); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Refreshes the pivot table within a given worksheet. + # Adds rows to the end of the table. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + pivotTableId - The ID of the pivot table. + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - OK. - remote isolated function refreshAllPivotTable(string itemId, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refreshAll`; + # + return - Created. + remote isolated function addWorkbookTableRow(string itemId, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Row response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of worksheet. + # Adds rows to the end of the table. # # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function addWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows/add`; + 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->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of the worksheets. + # + # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -516,8 +644,8 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK - remote isolated function listWorksheetsWithIemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Worksheets|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets`; + 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 Worksheets|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets`; 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}; @@ -527,11 +655,11 @@ public isolated client class Client { } # Adds a new worksheet to the workbook. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session # + return - OK - remote isolated function addWorksheetWithIemPath(string itemPath, CreateWorksheet payload, string? sessionId = ()) returns Worksheet|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets`; + remote isolated function addWorksheet(string itemId, NewWorksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; @@ -540,10 +668,9 @@ public isolated client class Client { Worksheet response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of worksheet. + # Retrieve a list of the worksheet. # # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -554,102 +681,88 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK. - remote isolated function getWorksheetWithIemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + # + return - OK + remote isolated function listWorksheetsWithItemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Worksheets|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets`; 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); - Worksheet response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Delete Worksheet - # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + sessionId - The ID of the session - # + return - No Content - remote isolated function deleteWorksheetWithIemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + Worksheets response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of worksheet. + # Adds a new worksheet to the workbook. # # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - Success. - remote isolated function updateWorksheetWithIemPath(string itemPath, string worksheetIdOrName, Worksheet payload, string? sessionId = ()) returns Worksheet|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + # + return - OK + remote isolated function addWorksheetWithItemPath(string itemPath, NewWorksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Worksheet response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Worksheet response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the used range of a worksheet. + # Retrieve the properties and relationships of the worksheet. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + 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 getUsedRangeWithIemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/usedRange`; + remote isolated function getWorksheet(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; + 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); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + Worksheet response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range containing the single cell based on row and column numbers. + # Delete a worksheet from a workbook. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + 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 - OK. - remote isolated function getRangeWithRowAndColumnWithItemPath(string itemPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + # + return - No Content + remote isolated function deleteWorksheet(string itemId, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; 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; } - # Retrieve a list of workbook pivottable. + # Update the properties of worksheet. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + 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 listPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTables|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables`; - 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); + # + return - Success. + remote isolated function updateWorksheet(string itemId, string worksheetIdOrName, Worksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - PivotTables response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Worksheet response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of workbook pivottable. + # Retrieve the properties and relationships of the worksheet. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + pivotTableId - The ID of the pivot table. # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -661,79 +774,80 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK. - remote isolated function getPivotTableWithItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}`; + remote isolated function getWorksheetWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; 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); - PivotTable response = check self.clientEp->get(resourcePath, httpHeaders); + Worksheet response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Refreshes the pivot table. + # Delete a worksheet from a workbook. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + pivotTableId - The ID of the pivot table. # + sessionId - The ID of the session - # + return - OK. - remote isolated function refreshPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refresh`; + # + return - No Content + remote isolated function deleteWorksheetWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); return response; } - # Refreshes the pivot table within a given worksheet. + # Update the properties of the worksheet. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + pivotTableId - The ID of the pivot table. # + sessionId - The ID of the session - # + return - OK. - remote isolated function refreshAllPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refreshAll`; + # + return - Success. + remote isolated function updateWorksheetWithItemPath(string itemPath, string worksheetIdOrName, Worksheet payload, string? sessionId = ()) returns Worksheet|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Worksheet response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Gets the range. + # Adds a new table in the worksheet. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - OK. - remote isolated function getWorksheetRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range`; + # + return - OK + remote isolated function addWorksheetTable(string itemId, string worksheetIdOrName, NewTable payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Update the properties of range. + # Adds a new table in the worksheet. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + return - OK - remote isolated function updateRange(string itemId, string namedItemName, Range payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range`; + remote isolated function addWorksheetTableWithItemPath(string itemPath, string worksheetIdOrName, NewTable payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Table response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of range. + # Retrieves a list of charts. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -744,39 +858,44 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - Success. - remote isolated function getRangeWithAddress(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + # + return - A collection of chart. + remote isolated function listCharts(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Charts|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts`; 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); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + Charts response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range. + # Retrieve a list of chart. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session - # + return - OK - remote isolated function updateRangeWithAddress(string itemId, string worksheetIdOrName, string address, Range payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + # + 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 - A collection of chart. + remote isolated function listChartsWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Charts|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts`; + 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"); - Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Charts response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of range. + # Gets the range. # # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column - # + address - The address + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -787,9 +906,9 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - Success. - remote isolated function getColumnRange(string itemId, string tableIdOrName, string columnIdOrName, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + # + return - OK. + remote isolated function getWorksheetRange(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range`; 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}; @@ -797,77 +916,96 @@ public isolated client class Client { Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range. + # Gets the range. # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - OK - remote isolated function updateColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Range payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + # + 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 getWorksheetRangeWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range`; + 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"); - Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # Gets the range containing the single cell based on row and column numbers. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - OK - remote isolated function insertRange(string itemId, string namedItemName, Shift payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/insert`; + # + return - OK. + remote isolated function getWorksheetCell(string itemId, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # Gets the range containing the single cell based on row and column numbers. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + 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 - OK. + remote isolated function getWorksheetCellWithItemPath(string itemPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Creates a new chart. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session # + return - OK - remote isolated function insertRangeWithAddrees(string itemId, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/insert`; + remote isolated function addChart(string itemId, string worksheetIdOrName, NewChart payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Chart response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # Creates a new chart. # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + return - OK - remote isolated function insertColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/insert`; + remote isolated function addChartWithItemPath(string itemPath, string worksheetIdOrName, NewChart payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Chart response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of the range format + # Retrieves a list of named items associated with the worksheet. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -878,37 +1016,44 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK - remote isolated function getRangeFormat(string itemId, string namedItemName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + # + return - OK. + remote isolated function listWorksheetNamedItem(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names`; 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); - RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range format. + # Retrieves a list of named items associated with the worksheet. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - OK - remote isolated function updateRangeFormat(string itemId, string namedItemName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + # + 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 listWorksheetNamedItemWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names`; + 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"); - RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the range format + # Retrieves a list of the workbook pivot tables. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -919,38 +1064,45 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK - remote isolated function getRangeFormatWithAddress(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + # + return - OK. + remote isolated function listPivotTables(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTables|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables`; 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); - RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + PivotTables response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range format. + # Retrieves a list of the workbook pivot tables. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session - # + return - OK - remote isolated function updateRangeFormatWithAddress(string itemId, string worksheetIdOrName, string address, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + # + 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 listPivotTablesWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns PivotTables|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables`; + 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"); - RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + PivotTables response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the range format + # Retrieve the properties and relationships of pivot table. # # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -961,252 +1113,350 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK - remote isolated function getColumnRangeFormat(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + # + return - OK. + remote isolated function getPivotTable(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}`; 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); - RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + PivotTable response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range format. + # Retrieve a list of the workbook pivot table. # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table # + sessionId - The ID of the session - # + return - OK - remote isolated function updateColumnRangeFormat(string itemId, string tableIdOrName, string columnIdOrName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + # + 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 getPivotTableWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}`; + 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"); - RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + PivotTable response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Merge the range cells into one region in the worksheet. + # Refreshes the pivot table. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + worksheetIdOrName - The ID or name of the worksheet + # + pivotTableId - The ID of the pivot table # + sessionId - The ID of the session - # + return - OK - remote isolated function mergeRange(string itemId, string namedItemName, Across payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/merge`; + # + return - OK. + remote isolated function refreshPivotTable(string itemId, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/refresh`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Merge the range cells into one region in the worksheet. + # Refreshes the pivot 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 - # + address - The address + # + pivotTableId - The ID of the pivot table # + sessionId - The ID of the session - # + return - OK - remote isolated function mergeRangeWithAddress(string itemId, string worksheetIdOrName, string address, Across payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/merge`; + # + return - OK. + remote isolated function refreshPivotTableWithItemPath(string itemPath, string worksheetIdOrName, string pivotTableId, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/${getEncodedUri(pivotTableId)}/refresh`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Merge the range cells into one region in the worksheet. + # Refreshes all pivot tables within given worksheet. # # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - OK - remote isolated function mergeColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Across payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/merge`; + # + return - OK. + remote isolated function refreshAllPivotTables(string itemId, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/refreshAll`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Unmerge the range cells into separate cells. + # Refreshes all pivot tables within given worksheet. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - No Content - remote isolated function unmergeRange(string itemId, string namedItemName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/unmerge`; + # + return - OK. + remote isolated function refreshAllPivotTablesWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/pivotTables/refreshAll`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Unmerge the range cells into separate cells. + # Retrieve the properties and relationships of range. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + sessionId - The ID of the session - # + return - No Content - remote isolated function unmergeRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/unmerge`; + # + 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 getWorksheetRangeWithAddress(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + 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; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Unmerge the range cells into separate cells. + # Update the properties of range. # # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session - # + return - No Content - remote isolated function unmergeColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/unmerge`; + # + return - OK + remote isolated function updateWorksheetRangeWithAddress(string itemId, string worksheetIdOrName, string address, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Clear range values such as format, fill, and border. + # Retrieve the properties and relationships of range. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK - remote isolated function clearRange(string itemId, string namedItemName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/clear`; + # + 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 getWorksheetRangeWithAddressItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + 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"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Clear range values such as format, fill, and border. + # Update the properties of range. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function clearRangeWithAddress(string itemId, string worksheetIdOrName, string address, ApplyTo payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/clear`; + remote isolated function updateWorksheetRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Clear range values such as format, fill, and border. + # Retrieve the properties and relationships of range. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 getColumnRange(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. # # + itemId - The ID of the drive containing 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 - OK - remote isolated function clearColumnRange(string itemId, string tableIdOrName, string columnIdOrName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/clear`; + remote isolated function updateColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Deletes the cells associated with the range. + # Retrieve the properties and relationships of range. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 getColumnRangeWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + 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); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemPath - The full path of 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 - OK - remote isolated function deleteCell(string itemId, string namedItemName, Shift payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/delete`; + remote isolated function updateColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Deletes the cells associated with the range. + # Retrieve the range object that is associated with the name. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getNamedItemRange(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function deleteCellWithAddress(string itemId, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/delete`; + remote isolated function updateNameRange(string itemId, string name, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Deletes the cells associated with the range. + # Retrieve the range object that is associated with the name. # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getNamedItemRangeWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function deleteColumnCell(string itemId, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/delete`; + remote isolated function updateNameRangeWithItemPath(string itemPath, string name, Range payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } # Gets the range containing the single cell based on row and column numbers. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + name - The name of the named item # + 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 - OK - remote isolated function getNameRangeWithRowAndColumn(string itemId, string namedItemName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getNameRangeCell(string itemId, string name, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range object containing the single cell based on row and column numbers. + # Gets the range containing the single cell based on row and column numbers. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of the workbook + # + name - The name of the named item # + 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 - OK - remote isolated function getWorkSheetRangeWithRowAndColumn(string itemId, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getNameRangeCellWithItemPath(string itemPath, string name, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); @@ -1216,13 +1466,12 @@ public isolated client class Client { # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + 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 - OK - remote isolated function getRangeWithRowColumnAddress(string itemId, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getWorksheetRangeCell(string itemId, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); @@ -1230,1429 +1479,2817 @@ public isolated client class Client { } # Gets the range object containing the single cell based on row and column numbers. # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + 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 - OK - remote isolated function getColumnRangeWithRowAndColumn(string itemId, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getWorksheetRangeCellWithItemPath(string itemPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a column contained in the range. + # Gets the range object containing the single cell based on row and column numbers. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + 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 - OK - remote isolated function getRangeColumn(string itemId, string namedItemName, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/column(column=${getEncodedUri(column)})`; + remote isolated function getWorksheetRangeCellWithAddress(string itemId, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a column contained in the range + # Gets the range object containing the single cell based on row and column numbers. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range + # + 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 - OK - remote isolated function getRangeColumnWithAddress(string itemId, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/column(column=${getEncodedUri(column)})`; + remote isolated function getWorksheetRangeCellWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a column contained in the range + # Gets the range object containing the single cell based on row and column numbers. # # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column + # + 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 - OK - remote isolated function getColumnRangeColumn(string itemId, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/column(column=${getEncodedUri(column)})`; + remote isolated function getColumnRangeCell(string itemId, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of columns to the right of the given range. + # Gets the range object containing the single cell based on row and column numbers. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 - OK - remote isolated function getCloumAfterRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter`; + remote isolated function getColumnRangeCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of columns to the right of the given range. + # Gets a column contained in the range. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + columnCount - The number of columns to include in the resulting range + # + 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 - OK - remote isolated function getCloumAfterRangeWithCount(string itemId, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter(count=${getEncodedUri(columnCount)})`; + remote isolated function getNameRangeColumn(string itemId, string name, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/column(column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range. + # Gets a column contained in the range. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of the workbook + # + 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 - OK - remote isolated function getCloumBeforeRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore`; + remote isolated function getNameRangeColumnWithItemPath(string itemPath, string name, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/column(column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range. + # Gets a column contained in the range. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + columnCount - The number of columns to include in the resulting range + # + address - The address of the range + # + column - Column number of the cell to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function getCloumBeforeRangeWithCount(string itemId, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore(count=${getEncodedUri(columnCount)})`; + remote isolated function getWorksheetRangeColumn(string itemId, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/column(column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range that represents the entire column of the range. + # Gets a column contained in the range. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + column - Column number of the cell to be retrieved. Zero-indexed. # + sessionId - The ID of the session # + return - OK - remote isolated function getEntireColumnRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/entireColumn`; + remote isolated function getWorksheetRangeColumnWithItemPath(string itemPath, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/column(column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range that represents the entire column of the range + # Gets a column contained in the range. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + tableIdOrName - The ID or name of the table + # + 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 - OK. - remote isolated function getEntireColumnRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireColumn`; + # + return - OK + remote isolated function getColumnRangeColumn(string itemId, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/column(column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range that represents the entire column of the range + # Gets a column contained in the range. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + tableIdOrName - The ID or name of the table # + 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 - OK. - remote isolated function getColumnEntireColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireColumn`; + # + return - OK + remote isolated function getColumnRangeColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/column(column=${getEncodedUri(column)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range that represents the entire row of the range + # Gets a certain number of columns to the right of the given range. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - OK. - remote isolated function getEntireRowRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/entireRow`; + # + return - OK + remote isolated function getWorksheetColumnsAfterRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range that represents the entire row of the range + # Gets a certain number of columns to the right of the given range. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session - # + return - OK. - remote isolated function getEntireRowRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireRow`; + # + return - OK + remote isolated function getWorksheetColumnsAfterRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range that represents the entire row of the range + # Gets a certain number of columns to the right of the given range. # # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + 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 - OK - remote isolated function getColumnEntireRowRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireRow`; + remote isolated function getWorksheetColumnsAfterRangeWithCount(string itemId, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter(count=${getEncodedUri(columnCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last cell within the range. + # Gets a certain number of columns to the right of the given range. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + 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 - OK - remote isolated function getLastCell(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/lastCell`; + remote isolated function getWorksheetColumnsAfterRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter(count=${getEncodedUri(columnCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last cell within the range. + # Gets a certain number of columns to the left of the given range. # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session # + return - OK - remote isolated function getLastCellWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastCell`; + remote isolated function getWorksheetColumnsBeforeRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last cell within the range. + # Gets a certain number of columns to the left of the given range. # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + return - OK - remote isolated function getColumnLastCell(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastCell`; + remote isolated function getWorksheetColumnsBeforeRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last column within the range + # Gets a certain number of columns to the left of the given range. # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + 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 - OK - remote isolated function getLastColumnRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/lastColumn`; + remote isolated function getWorksheetColumnsBeforeRangeWithCount(string itemId, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore(count=${getEncodedUri(columnCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last column within the range + # Gets a certain number of columns to the left of the given range. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + columnCount - The number of columns to include in the resulting range # + sessionId - The ID of the session # + return - OK - remote isolated function getLastColumnRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastColumn`; + remote isolated function getWorksheetColumnsBeforeRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore(count=${getEncodedUri(columnCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last column within the range + # Gets the range that represents the entire column of the range. # # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getColumnLastColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastColumn`; + remote isolated function getNameRangeEntireColumn(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/entireColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last row within the range. + # Gets the range that represents the entire column of the range. # - # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item + # + itemPath - The full path of the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getLastRowRange(string itemId, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/lastRow`; + remote isolated function getNameRangeEntireColumnWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/entireColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last row within the range. + # Gets the range that represents the entire column of the range # # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK - remote isolated function getLastRowRangeWithAddress(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastRow`; + # + return - OK. + remote isolated function getWorksheetRangeEntireColumn(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the last row within the range. + # Gets the range that represents the entire column of the range # - # + itemId - The ID of the drive containing the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK - remote isolated function getColumnLastRowRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastRow`; + # + return - OK. + remote isolated function getWorksheetRangeEntireColumnWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of rows above a given range. + # Gets the range that represents the entire column of the range # # + 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 + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - OK - remote isolated function getRowsAboveRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove`; + # + return - OK. + remote isolated function getColumnRangeEntireColumn(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of rows above a given range. + # Gets the range that represents the entire column of the range # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + rowCount - The number of rows to include in the resulting range + # + itemPath - The full path of 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 - OK - remote isolated function getRowsAboveRangeWithCount(string itemId, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove(count=${getEncodedUri(rowCount)})`; + # + return - OK. + remote isolated function getColumnRangeEntireColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range + # Gets the range that represents the entire row of the range # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + name - The name of the named item # + sessionId - The ID of the session - # + return - OK - remote isolated function getRowsBelowRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow`; + # + return - OK. + remote isolated function getNameRangeEntireRow(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/entireRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range + # Gets the range that represents the entire row of the range # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + rowCount - The number of rows to include in the resulting range + # + itemPath - The full path of the workbook + # + name - The name of the named item # + sessionId - The ID of the session - # + return - OK - remote isolated function getRowsBelowRangeWithCount(string itemId, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow(count=${getEncodedUri(rowCount)})`; + # + return - OK. + remote isolated function getNameRangeEntireRowWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/entireRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the used range of the given range. + # Gets the range that represents the entire row of the range # # + itemId - The ID of the drive containing the workbook - # + namedItemName - The name of the named item - # + valuesOnly - A value indicating whether to return only the values in the used range + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK - remote isolated function getUsedRangeWithValuesOnly(string itemId, string namedItemName, boolean valuesOnly, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(namedItemName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + # + return - OK. + remote isolated function getWorksheetRangeEntireRow(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the used range of the given range. + # Gets the range that represents the entire row of the range # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address - # + valuesOnly - A value indicating whether to return only the values in the used range + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK - remote isolated function getUsedRangeWithAddress(string itemId, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + # + return - OK. + remote isolated function getWorksheetRangeEntireRowWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the used range of the given range. + # Gets the range that represents the entire row of the range # # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + 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 - OK - remote isolated function getColumnUsedRange(string itemId, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + remote isolated function getColumnRangeEntireRow(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the resized range of a range. + # Gets the range that represents the entire row of the range # - # + itemId - The ID of the drive containing 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. + # + itemPath - The full path of 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 - OK - remote isolated function getResizedRange(string itemId, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/resizedRange(deltaRows=${getEncodedUri(deltaRows)}, deltaColumns=${getEncodedUri(deltaColumns)})`; + remote isolated function getColumnRangeEntireRowWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the range visible from a filtered range + # Gets the last cell within the range. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getVisibleView(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/visibleView`; + remote isolated function getNameRangeLastCell(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/lastCell`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - RangeView response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range. + # Gets the last cell within the range. # # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + name - The name of the named item # + sessionId - The ID of the session - # + return - OK. - remote isolated function getWorksheetRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range`; + # + return - OK + remote isolated function getNameRangeLastCellWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/lastCell`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range. + # Gets the last cell within the range. # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function updateWorkbookRangeWithItemPath(string itemPath, string namedItemName, Range payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range`; + remote isolated function getWorksheetRangeLastCell(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastCell`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of range. + # Gets the last cell within the range. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + 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 getRangeWithAddressItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; - 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); + # + return - OK + remote isolated function getWorksheetRangeLastCellWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastCell`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range. + # Gets the last cell within the range. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + itemId - The ID of the drive containing 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 - OK - remote isolated function updateRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Range payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')`; + remote isolated function getColumnRangeLastCell(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastCell`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of range. + # Gets the last cell within the range. # # + itemPath - The full path of the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column - # + address - The address # + 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 getColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; - 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); + # + return - OK + remote isolated function getColumnRangeLastCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastCell`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range. + # Gets the last column within the range. # - # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function updateColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Range payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range`; + remote isolated function getNameRangeLastColumn(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/lastColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # Gets the last column within the range. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function insertRangeWithItemPath(string itemPath, string namedItemName, Shift payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/insert`; + remote isolated function getNameRangeLastColumnWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/lastColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # Gets the last column within the range. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function insertRangeWithAddreesItemPath(string itemPath, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/insert`; + remote isolated function getWorksheetRangeLastColumn(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + # Gets the last column within the range # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function insertColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/insert`; + remote isolated function getWorksheetRangeLastColumnWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the range format + # Gets the last column within the range # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item - # + 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 getRangeFormatWithItemPath(string itemPath, string namedItemName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/format`; - 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); - RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Update the properties of range format. - # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing 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 - OK - remote isolated function updateRangeFormatWithItemPath(string itemPath, string namedItemName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/format`; + remote isolated function getColumnRangeLastColumn(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the range format + # Gets the last column within the range # # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column # + 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 getRangeFormatWithAddressItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; - 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 getColumnRangeLastColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastColumn`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range format. + # Gets the last row within the range. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function updateRangeFormatWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + remote isolated function getNameRangeLastRow(string itemId, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/lastRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the range format + # Gets the last row within the range. # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + name - The name of the named item # + 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 getColumnRangeFormatWithItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; - 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 getNameRangeLastRowWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/lastRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of range format. + # Gets the last row within the range. # - # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function updateColumnRangeFormatWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + remote isolated function getWorksheetRangeLastRow(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Merge the range cells into one region in the worksheet. + # Gets the last row within the range. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function mergeRangeWithItemPath(string itemPath, string namedItemName, Across payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/merge`; + remote isolated function getWorksheetRangeLastRowWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Merge the range cells into one region in the worksheet. + # Gets the last row within the range. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + itemId - The ID of the drive containing 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 - OK - remote isolated function mergeRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Across payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/merge`; + remote isolated function getColumnRangeLastRow(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Merge the range cells into one region in the worksheet. + # Gets the last row within the range. # # + itemPath - The full path of 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 - OK - remote isolated function mergeColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Across payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/merge`; + remote isolated function getColumnRangeLastRowWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastRow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Unmerge the range cells into separate cells. + # Gets a certain number of rows above a given range. # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session - # + return - No Content - remote isolated function unmergeRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/unmerge`; + # + return - OK + remote isolated function getWorksheetRowsAboveRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Unmerge the range cells into separate cells. + # Gets a certain number of rows above a given range. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session - # + return - No Content - remote isolated function unmergeRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/unmerge`; + # + return - OK + remote isolated function getWorksheetRowsAboveRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Unmerge the range cells into separate cells. + # Gets a certain number of rows above a given range. # - # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemId - The ID of the drive containing the workbook + # + 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 - No Content - remote isolated function unmergeColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/unmerge`; + # + return - OK + remote isolated function getWorksheetRowsAboveRangeWithCount(string itemId, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove(count=${getEncodedUri(rowCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Clear range values such as format, fill, and border. + # Gets a certain number of rows above a given range. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + 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 - OK - remote isolated function clearRangeWithItemPath(string itemPath, string namedItemName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/clear`; + remote isolated function getWorksheetRowsAboveRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove(count=${getEncodedUri(rowCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Clear range values such as format, fill, and border. + # Gets a certain number of columns to the left of the given range # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address # + sessionId - The ID of the session # + return - OK - remote isolated function clearRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, ApplyTo payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/clear`; + remote isolated function getWorksheetRowsBelowRange(string itemId, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Clear range values such as format, fill, and border. + # Gets a certain number of columns to the left of the given range # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + return - OK - remote isolated function clearColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/clear`; + remote isolated function getWorksheetRowsBelowRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the cells associated with the range. + # Gets a certain number of columns to the left of the given range # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing the workbook + # + 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 - OK - remote isolated function deleteCellWithItemPath(string itemPath, string namedItemName, Shift payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/delete`; + remote isolated function getWorksheetRowsBelowRangeWithCount(string itemId, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow(count=${getEncodedUri(rowCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the cells associated with the range. + # Gets a certain number of columns to the left of the given range # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + rowCount - The number of rows to include in the resulting range # + sessionId - The ID of the session # + return - OK - remote isolated function deleteCellWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/delete`; + remote isolated function getWorksheetRowsBelowRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow(count=${getEncodedUri(rowCount)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the cells associated with the range. + # Get the used range of the given range. # - # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + itemId - The ID of the drive containing the workbook + # + 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 - OK - remote isolated function deleteColumnCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/delete`; + remote isolated function getNameUsedRange(string itemId, string name, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range containing the single cell based on row and column numbers. + # Get the used range of the given range. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item - # + row - Row number of the cell to be retrieved. Zero-indexed. - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + 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 - OK - remote isolated function getNamedItemRangeWithRowColumnItemPath(string itemPath, string namedItemName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getNameUsedRangeWithItemPath(string itemPath, string name, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range object containing the single cell based on row and column numbers. + # Get the used range of the worksheet with in the given range. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + row - Row number of the cell to be retrieved. Zero-indexed. - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + 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 - OK - remote isolated function getWorkSheetRangeWithRowAndColumnItemPath(string itemPath, string worksheetIdOrName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getWorksheetUsedRange(string itemId, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range object containing the single cell based on row and column numbers. + # Get the used range of the worksheet with in the given range. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address - # + row - Row number of the cell to be retrieved. Zero-indexed. - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + 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 - OK - remote isolated function getRangeWithRowColumnAddressItemPath(string itemPath, string worksheetIdOrName, string address, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getWorksheetUsedRangeWithItemPath(string itemPath, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets the range object containing the single cell based on row and column numbers. + # Get the used range of the given range. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table # + columnIdOrName - The ID or name of the column - # + row - Row number of the cell to be retrieved. Zero-indexed. - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + valuesOnly - A value indicating whether to return only the values in the used range # + sessionId - The ID of the session # + return - OK - remote isolated function getRangeWithRowAndColumnItemPath(string itemPath, string tableIdOrName, string columnIdOrName, int row, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/cell(row=${getEncodedUri(row)},column=${getEncodedUri(column)})`; + remote isolated function getColumnUsedRange(string itemId, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a column contained in the range. + # Get the used range of the given range. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + tableIdOrName - The ID or name of the table + # + 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 - OK - remote isolated function getRangeColumnWithItemPath(string itemPath, string namedItemName, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/column(column=${getEncodedUri(column)})`; + remote isolated function getColumnUsedRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a column contained in the range + # Clear range values such as format, fill, and border. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getRangeColumnWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/column(column=${getEncodedUri(column)})`; + remote isolated function clearNameRange(string itemId, string name, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/clear`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a column contained in the range + # Clear range values such as format, fill, and border. # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column - # + column - Column number of the cell to be retrieved. Zero-indexed. + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getColumnRangeColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, int column, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/column(column=${getEncodedUri(column)})`; + remote isolated function clearNameRangeWithItemPath(string itemPath, string name, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/clear`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of columns to the right of the given range. + # Clear range values such as format, fill, and border. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function getCloumAfterRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter`; + remote isolated function clearWorksheetRange(string itemId, string worksheetIdOrName, string address, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/clear`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of columns to the right of the given range. + # Clear range values such as format, fill, and border. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + columnCount - The number of columns to include in the resulting range + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function getCloumAfterRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsAfter(count=${getEncodedUri(columnCount)})`; + remote isolated function clearWorksheetRangeWithItemPath(string itemPath, string worksheetIdOrName, string address, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/clear`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range. + # Clear range values such as format, fill, and border. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemId - The ID of the drive containing 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 - OK - remote isolated function getCloumBeforeRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore`; + remote isolated function clearColumnRange(string itemId, string tableIdOrName, string columnIdOrName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/clear`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range. + # Clear range values such as format, fill, and border. # # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + columnCount - The number of columns to include in the resulting range + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + return - OK - remote isolated function getCloumBeforeRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int columnCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/columnsBefore(count=${getEncodedUri(columnCount)})`; + remote isolated function clearColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, ApplyTo payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/clear`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the range that represents the entire column of the range. + # Deletes the cells associated with the range. # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getEntireColumnRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/entireColumn`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Gets the range that represents the entire column of the range - # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address - # + sessionId - The ID of the session - # + return - OK. - remote isolated function getEntireColumnRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireColumn`; + remote isolated function deleteNameRangeCell(string itemId, string name, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/delete`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the range that represents the entire column of the range + # Deletes the cells associated with the range. # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + name - The name of the named item # + sessionId - The ID of the session - # + return - OK. - remote isolated function getColumnEntireColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireColumn`; + # + return - OK + remote isolated function deleteNameRangeCellWithItemPath(string itemPath, string name, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/delete`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the range that represents the entire row of the range + # Deletes the cells associated with the range. # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK. - remote isolated function getEntireRowRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/entireRow`; + # + return - OK + remote isolated function deleteWorksheetRangeCell(string itemId, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/delete`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the range that represents the entire row of the range + # Deletes the cells associated with the range. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + sessionId - The ID of the session - # + return - OK. - remote isolated function getEntireRowRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/entireRow`; + # + return - OK + remote isolated function deleteWorksheetRangeCellWithItemPath(string itemPath, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/delete`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the range that represents the entire row of the range + # Deletes the cells associated with the range. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing 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 - OK - remote isolated function getColumnEntireRowRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/entireRow`; + remote isolated function deleteColumnRangeCell(string itemId, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/delete`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last cell within the range. + # Deletes the cells associated with the range. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + return - OK - remote isolated function getLastCellWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/lastCell`; + remote isolated function deleteColumnRangeCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/delete`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last cell within the range. + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getLastCellWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastCell`; + remote isolated function insertNameRange(string itemId, string name, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/insert`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last cell within the range. + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getColumnLastCellWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastCell`; + remote isolated function insertNameRangeWithItemPath(string itemPath, string name, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/insert`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last column within the range + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function getLastColumnRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/lastColumn`; + remote isolated function insertWorksheetRange(string itemId, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/insert`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last column within the range + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function getLastColumnRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastColumn`; + remote isolated function insertWorksheetRangeWithItemPath(string itemPath, string worksheetIdOrName, string address, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/insert`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last column within the range + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing 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 - OK - remote isolated function getColumnLastColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastColumn`; + remote isolated function insertColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/insert`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last row within the range. + # Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. # # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + return - OK - remote isolated function getLastRowRangeWithItemPath(string itemPath, string namedItemName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/lastRow`; + remote isolated function insertColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Shift payload, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/insert`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last row within the range. + # Merge the range cells into one region in the worksheet. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getLastRowRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/lastRow`; + remote isolated function mergeNameRange(string itemId, string name, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/merge`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets the last row within the range. + # Merge the range cells into one region in the worksheet. # # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + columnIdOrName - The ID or name of the column + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK - remote isolated function getColumnLastRowRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/lastRow`; + remote isolated function mergeNameRangeWithItemPath(string itemPath, string name, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/merge`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of rows above a given range. + # Merge the range cells into one region in the worksheet. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function getRowsAboveRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove`; + remote isolated function mergeWorksheetRange(string itemId, string worksheetIdOrName, string address, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/merge`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of rows above a given range. + # Merge the range cells into one region in the worksheet. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + rowCount - The number of rows to include in the resulting range + # + address - The address of the range # + sessionId - The ID of the session # + return - OK - remote isolated function getRowsAboveRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsAbove(count=${getEncodedUri(rowCount)})`; + remote isolated function mergeWorksheetRangeWithItemPath(string itemPath, string worksheetIdOrName, string address, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function mergeColumnRange(string itemId, string tableIdOrName, string columnIdOrName, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Merge the range cells into one region in the worksheet. + # + # + itemPath - The full path of 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 - OK + remote isolated function mergeColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Across payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/merge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeNameRange(string itemId, string name, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeNameRangeWithItemPath(string itemPath, string name, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeWorksheetRange(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - No Content + remote isolated function unmergeWorksheetRangeWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemId - The ID of the drive containing 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 - No Content + remote isolated function unmergeColumnRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Unmerge the range cells into separate cells. + # + # + itemPath - The full path of 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 - No Content + remote isolated function unmergeColumnRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/unmerge`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the range visible from a filtered range. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK + remote isolated function getVisibleView(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/visibleView`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + RangeView response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range visible from a filtered range. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK + remote isolated function getVisibleViewWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/visibleView`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + RangeView response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Perform a sort operation. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function performNameRangeSort(string itemId, string name, RangeSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function performNameRangeSortWithItemPath(string itemPath, string name, RangeSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK. + remote isolated function performWorksheetRangeSort(string itemId, string worksheetIdOrName, string address, RangeSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK. + remote isolated function performWorksheetRangeSortWithItemPath(string itemPath, string worksheetIdOrName, string address, RangeSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function performColumnRangeSort(string itemId, string tableIdOrName, string columnIdOrName, RangeSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation. + # + # + itemPath - The full path of 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 - No Content + remote isolated function performColumnRangeSortWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, RangeSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + 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 getNameRangeFormat(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateNameRangeFormat(string itemId, string name, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + 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 getNameRangeFormatWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateNameRangeFormatWithItemPath(string itemPath, string name, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + 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 getWorksheetRangeFormat(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorksheetRangeFormat(string itemId, string worksheetIdOrName, string address, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + 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 getWorksheetRangeFormatWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorksheetRangeFormatWithItemPath(string itemPath, string worksheetIdOrName, string address, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 getColumnRangeFormat(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function updateColumnRangeFormat(string itemId, string tableIdOrName, string columnIdOrName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of the range format. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 getColumnRangeFormatWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + 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); + RangeFormat response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of range format. + # + # + itemPath - The full path of 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 - OK + remote isolated function updateColumnRangeFormatWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, RangeFormat payload, string? sessionId = ()) returns RangeFormat|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeFormat response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieves a list of range borders. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + 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 listNameRangeBorders(string itemId, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeBorders|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/format/borders`; + 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); + RangeBorders response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new range border. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - Created + remote isolated function createNameRangeBorder(string itemId, string name, RangeBorder payload, string? sessionId = ()) returns RangeBorder|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/format/borders`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeBorder response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieves a list of range borders. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + 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 listNameRangeBordersWithItemPath(string itemPath, string name, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns RangeBorders|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/format/borders`; + 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); + RangeBorders response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new range border. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - Created + remote isolated function createNameRangeBorderWithItemPath(string itemPath, string name, RangeBorder payload, string? sessionId = ()) returns RangeBorder|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/format/borders`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeBorder response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieves a list of range borders. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + 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 listWorksheetRangeBorders(string itemId, 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 RangeBorders|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/borders`; + 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); + RangeBorders response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new range border. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - Created + remote isolated function createWorksheetRangeBorder(string itemId, string worksheetIdOrName, string address, RangeBorder payload, string? sessionId = ()) returns RangeBorder|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/borders`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeBorder response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieves a list of range borders. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + 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 listWorksheetRangeBordersWithItemPath(string itemPath, 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 RangeBorders|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/borders`; + 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); + RangeBorders response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new range border. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - Created + remote isolated function createWorksheetRangeBorderWithItemPath(string itemPath, string worksheetIdOrName, string address, RangeBorder payload, string? sessionId = ()) returns RangeBorder|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/borders`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeBorder response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieves a list of range borders. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 listColumnRangeBorders(string itemId, 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 RangeBorders|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/borders`; + 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); + RangeBorders response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new range border. + # + # + itemId - The ID of the drive containing 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 - Created + remote isolated function createColumnRangeBorder(string itemId, string tableIdOrName, string columnIdOrName, RangeBorder payload, string? sessionId = ()) returns RangeBorder|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/borders`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeBorder response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieves a list of range borders. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column + # + 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 listColumnRangeBordersWithItemPath(string itemPath, 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 RangeBorders|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/borders`; + 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); + RangeBorders response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Create a new range border. + # + # + itemPath - The full path of 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 - Created + remote isolated function createColumnRangeBorderWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, RangeBorder payload, string? sessionId = ()) returns RangeBorder|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/borders`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + RangeBorder response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitNameRangeColumns(string itemId, string name, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/format/autofitColumns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitNameRangeColumnsWithItemPath(string itemPath, string name, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/format/borders/autofitColumns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitWorksheetRangeColumns(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/autofitColumns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitWorksheetRangeColumnsWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/autofitColumns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function autofitColumnRangeColumns(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/autofitColumns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemPath - The full path of 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 - OK. + remote isolated function autofitColumnRangeColumnsWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/autofitColumns`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitNameRangeRows(string itemId, string name, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range/format/autofitRows`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitNameRangeRowsWithItemPath(string itemPath, string name, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range/format/borders/autofitRows`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitWorksheetRangeRows(string itemId, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/autofitRows`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + address - The address of the range + # + sessionId - The ID of the session + # + return - OK. + remote isolated function autofitWorksheetRangeRowsWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/format/autofitRows`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemId - The ID of the drive containing 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 - OK. + remote isolated function autofitColumnRangeRows(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/autofitRows`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + # + # + itemPath - The full path of 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 - OK. + remote isolated function autofitColumnRangeRowsWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/format/autofitRows`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the resized range of a range. + # + # + itemId - The ID of the drive containing 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 - OK + remote isolated function getResizedRange(string itemId, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/resizedRange(deltaRows=${getEncodedUri(deltaRows)}, deltaColumns=${getEncodedUri(deltaColumns)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Get the resized range of a range. + # + # + itemPath - The full path of 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 - OK + remote isolated function getResizedRangeWithItemPath(string itemPath, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/resizedRange(deltaRows=${getEncodedUri(deltaRows)}, deltaColumns=${getEncodedUri(deltaColumns)})`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + 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 getWorkbookTable(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteWorkbookTable(string itemId, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the workbook. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorkbookTable(string itemId, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 getWorkbookTableWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteWorkbookTableWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the workbook. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorkbookTableWithItemPath(string itemPath, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + 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 + # + 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 getWorksheetTable(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from the worksheet. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function deleteWorksheetTable(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the worksheet. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function updateWorksheetTable(string itemId, string worksheetIdOrName, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table + # + 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 getWorksheetTableWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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); + Table response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Deletes the table from the worksheet. + # + # + itemPath - The full path of 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 - OK + remote isolated function deleteWorksheetTableWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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 in the worksheet. + # + # + itemPath - The full path of 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 - OK + remote isolated function updateWorksheetTableWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Gets the range associated with the data body of the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableBodyRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/dataBodyRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with the data body of the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableBodyRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/dataBodyRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with the data body of the table. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function getWorksheetTableBodyRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/dataBodyRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with the data body of the table. + # + # + itemPath - The full path of 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 - OK + remote isolated function getWorksheetTableBodyRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/dataBodyRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with header row of the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableHeaderRowRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/headerRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with header row of the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableHeaderRowRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/headerRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with header row of the table. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function getWorksheetTableHeaderRowRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/headerRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with header row of the table. + # + # + itemPath - The full path of 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 - OK + remote isolated function getWorksheetTableHeaderRowRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/headerRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function getWorksheetTableRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Get the range associated with the entire table. + # + # + itemPath - The full path of 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 - OK + remote isolated function getWorksheetTableRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/range`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with totals row of the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableTotalRowRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/totalRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with totals row of the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function getWorkbookTableTotalRowRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/totalRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with totals row of the table. + # + # + 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 + # + sessionId - The ID of the session + # + return - OK + remote isolated function getWorksheetTableTotalRowRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/totalRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Gets the range associated with totals row of the table. + # + # + itemPath - The full path of 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 - OK + remote isolated function getWorksheetTableTotalRowRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/totalRowRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + Range response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Clears all the filters currently applied on the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function clearWorkbookTableFilters(string itemId, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/clearFilters`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clears all the filters currently applied on the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function clearWorkbookTableFiltersWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/clearFilters`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range + # Clears all the filters currently applied on the 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 # + sessionId - The ID of the session # + return - OK - remote isolated function getRowsBelowRangeWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow`; + remote isolated function clearWorksheetTableFilters(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/clearFilters`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a certain number of columns to the left of the given range + # Clears all the filters currently applied on the table. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + rowCount - The number of rows to include in the resulting range + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + return - OK - remote isolated function getRowsBelowRangeWithCountItemPath(string itemPath, string worksheetIdOrName, int rowCount, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/rowsBelow(count=${getEncodedUri(rowCount)})`; + remote isolated function clearWorksheetTableFiltersWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/clearFilters`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the used range of the given range. + # Converts the table into a normal range of cells. All data is preserved. # - # + itemPath - The full path of the workbook - # + namedItemName - The name of the named item - # + valuesOnly - A value indicating whether to return only the values in the used range + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session - # + return - OK - remote isolated function getUsedRangeWithItemPath(string itemPath, string namedItemName, boolean valuesOnly, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(namedItemName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + # + return - OK. + remote isolated function convertWorkbookTableToRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/convertToRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the used range of the given range. + # Converts the table into a normal range of cells. All data is preserved. # # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function convertWorkbookTableToRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/convertToRange`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Converts the table into a normal range of cells. All data is preserved. + # + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address - # + valuesOnly - A value indicating whether to return only the values in the used range + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + return - OK - remote isolated function getUsedRangeWithAddressItemPath(string itemPath, string worksheetIdOrName, string address, boolean valuesOnly, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + remote isolated function convertWorksheetTableToRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/convertToRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the used range of the given range. + # Converts the table into a normal range of cells. All data is preserved. # # + itemPath - The full path of 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 - # + valuesOnly - A value indicating whether to return only the values in the used range # + sessionId - The ID of the session # + return - OK - remote isolated function getColumnUsedRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, boolean valuesOnly, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/range/usedRange(valuesOnly=${getEncodedUri(valuesOnly)})`; + remote isolated function convertWorksheetTableToRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/convertToRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + Range response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the resized range of a range. + # Reapplies all the filters currently on the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function reapplyWorkbookTableFilters(string itemId, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/reapplyFilters`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Reapplies all the filters currently on the table. # # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function reapplyWorkbookTableFiltersWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/reapplyFilters`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Reapplies all the filters currently on the table. + # + # + itemId - The ID of the drive containing 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. + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + return - OK - remote isolated function getResizedRangeWithItemPath(string itemPath, string worksheetIdOrName, int deltaRows, int deltaColumns, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range/resizedRange(deltaRows=${getEncodedUri(deltaRows)}, deltaColumns=${getEncodedUri(deltaColumns)})`; + remote isolated function reapplyWorksheetTableFilters(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/reapplyFilters`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - Range response = check self.clientEp->post(resourcePath, request, httpHeaders); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the range visible from a filtered range + # Reapplies all the filters currently on the table. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + address - The address + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + return - OK - remote isolated function getVisibleViewWithItemPath(string itemPath, string worksheetIdOrName, string address, string? sessionId = ()) returns RangeView|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/range(address='${getEncodedUri(address)}')/visibleView`; + remote isolated function reapplyWorksheetTableFiltersWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/reapplyFilters`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - RangeView response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of table in the workbook. + # Retrieve a list of table in the worksheet. # # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -2664,8 +4301,8 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK - remote isolated function listWorkbookTables(string itemId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables`; + remote isolated function listWorksheetTables(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables`; 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}; @@ -2675,7 +4312,7 @@ public isolated client class Client { } # Retrieve a list of table in the worksheet. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources @@ -2688,8 +4325,8 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK - remote isolated function listTables(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables`; + remote isolated function listWorksheetTablesWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables`; 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}; @@ -2702,7 +4339,7 @@ public isolated client class Client { # + itemId - The ID of the drive containing the workbook # + sessionId - The ID of the session # + return - OK - remote isolated function createWorkbookTable(string itemId, CreateTablePayload payload, string? sessionId = ()) returns Table|error { + remote isolated function addWorkbookTable(string itemId, NewTable payload, string? sessionId = ()) returns Table|error { string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); @@ -2712,14 +4349,13 @@ public isolated client class Client { Table response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Create a new table in the worksheet. + # Create a new table in the workbook # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of the workbook # + sessionId - The ID of the session # + return - OK - remote isolated function createTable(string itemId, string worksheetIdOrName, CreateTablePayload payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/add`; + remote isolated function addWorkbookTableWithItemPath(string itemPath, NewTable payload, string? sessionId = ()) returns Table|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; @@ -2728,10 +4364,9 @@ public isolated client class Client { Table response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of table. + # Retrieve the properties and relationships of table sort. # # + 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 # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources @@ -2744,106 +4379,272 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK. - remote isolated function getWorkbookTable(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + remote isolated function getWorkbookTableSort(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/sort`; 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); - Table response = check self.clientEp->get(resourcePath, httpHeaders); + TableSort response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the table from the workbook. + # Retrieve the properties and relationships of table sort. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + 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 getWorkbookTableSortWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/sort`; + 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); + TableSort response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table sort. # # + 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 # + 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 deleteWorkbookTable(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + remote isolated function getWorksheetTableSort(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort`; + 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:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + TableSort response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of table in the workbook. + # Retrieve the properties and relationships of table sort. + # + # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table + # + 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 getWorksheetTableSortWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort`; + 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); + TableSort response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Perform a sort operation to the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function performWorkbookTableSort(string itemId, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation to the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function performWorkbookTableSortWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/sort/apply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Perform a sort operation to the table. # # + 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 # + sessionId - The ID of the session # + return - OK - remote isolated function updateWorkbookTable(string itemId, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}`; + remote isolated function performWorksheetTableSort(string itemId, string worksheetIdOrName, string tableIdOrName, TableSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort/apply`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Deletes the table from the worksheet + # Perform a sort operation to the 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 # + sessionId - The ID of the session # + return - OK - remote isolated function deleteTable(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + remote isolated function performWorksheetTableSortWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, TableSort payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort/apply`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clears the sorting that is currently on the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function clearWorkbookTableSort(string itemId, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/sort/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clears the sorting that is currently on the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function clearWorkbookTableSortWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/sort/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Update the properties of table in the worksheet + # Clears the sorting that is currently on the table. # # + 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 # + sessionId - The ID of the session - # + return - OK - remote isolated function updateTable(string itemId, string worksheetIdOrName, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + # + return - OK + remote isolated function clearWorksheetTableSort(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Clears the sorting that is currently on the table. + # + # + itemPath - The full path of 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 - OK + remote isolated function clearWorksheetTableSortWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort/clear`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Reapplies the current sorting parameters to the table. + # + # + itemId - The ID of the drive containing the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function reapplyWorkbookTableSort(string itemId, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/sort/reapply`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + return response; + } + # Reapplies the current sorting parameters to the table. + # + # + itemPath - The full path of the workbook + # + tableIdOrName - The ID or name of the table + # + sessionId - The ID of the session + # + return - OK. + remote isolated function reapplyWorkbookTableSortWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/sort/reapply`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the range associated with the entire table. + # Reapplies the current sorting parameters to the table. # # + 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 # + sessionId - The ID of the session - # + return - OK. - remote isolated function getWorkbookTableRange(string itemId, string tableIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/range`; + # + return - OK + remote isolated function reapplyWorksheetTableSort(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort/reapply`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the range associated with the entire table. + # Reapplies the current sorting parameters to the 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 # + sessionId - The ID of the session # + return - OK - remote isolated function getTableRange(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/range`; + remote isolated function reapplyWorksheetTableSortWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/sort/reapply`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of table in the workbook. + # Retrieve a list of table row in the worksheet. # - # + 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 # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -2855,19 +4656,37 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK - remote isolated function listWorkbookTablesWithItemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables`; + remote isolated function listWorksheetTableRows(string itemId, 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 Rows|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; 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); - Tables response = check self.clientEp->get(resourcePath, httpHeaders); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve a list of table in the worksheet. + # Adds rows to the end of a table in the worksheet. + # + # + 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 + # + sessionId - The ID of the session + # + return - Created. + remote isolated function createWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + 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->post(resourcePath, request, httpHeaders); + return response; + } + # Retrieve a list of table row in the worksheet. # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet + # + tableIdOrName - The ID or name of the table # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -2879,104 +4698,102 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK - remote isolated function listTablesWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Tables|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables`; + remote isolated function listWorksheetTableRowsWithItemPath(string itemPath, 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 Rows|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; 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); - Tables response = check self.clientEp->get(resourcePath, httpHeaders); + Rows response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Create a new table in the workbook + # Adds rows to the end of a table in the worksheet. # # + itemPath - The full path of 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 - OK - remote isolated function createWorkbookTableWithItemPath(string itemPath, CreateTablePayload payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/add`; + # + return - Created. + remote isolated function createWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Table response = check self.clientEp->post(resourcePath, request, httpHeaders); + Row response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Create a new table in the worksheet. + # Adds rows to the end of the 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 # + sessionId - The ID of the session - # + return - OK - remote isolated function createTableWithItemPath(string itemPath, string worksheetIdOrName, CreateTablePayload payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/add`; + # + return - Created. + remote isolated function addWorksheetTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Table response = check self.clientEp->post(resourcePath, request, httpHeaders); + Row response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of table. + # Adds rows to the end of the table. # # + itemPath - The full path of the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + tableIdOrName - The ID or name of the table # + 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 getWorkbookTableWithItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; - 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); + # + return - OK + remote isolated function addWorksheetTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Table 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->post(resourcePath, request, httpHeaders); return response; } - # Deletes the table from the workbook. + # Gets a row based on its position in the collection. # - # + 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 deleteWorkbookTableWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + remote isolated function getWorksheetTableRowWithIndex(string itemId, string worksheetIdOrName, string tableIdOrName, int index, 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:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of table in the workbook. + # 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 updateWorkbookTableWithItemPath(string itemPath, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}`; + 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); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of table. + # 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. # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -2987,78 +4804,55 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK. - remote isolated function getTableWithItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + # + 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); map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Table response = check self.clientEp->get(resourcePath, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the table from the worksheet + # 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 deleteTableWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + 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)}`; 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 in the worksheet + # Update the properties 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. # + sessionId - The ID of the session - # + return - OK - remote isolated function updateTableWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Table payload, string? sessionId = ()) returns Table|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}`; + # + 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)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Table response = check self.clientEp->patch(resourcePath, request, httpHeaders); - return response; - } - # Get the range associated with the entire table. - # - # + itemPath - The full path of the workbook - # + tableIdOrName - The ID or name of the table - # + sessionId - The ID of the session - # + return - OK. - remote isolated function getWorkbookTableRangeWithItemPath(string itemPath, string tableIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/range`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Get the range associated with the entire 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 - # + sessionId - The ID of the session - # + return - OK - remote isolated function getTableRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/range`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Retrieve a list of table row in 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 # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -3069,171 +4863,205 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - Success. - remote isolated function listWorkbookTableRows(string itemId, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Rows|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + 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)}`; 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); - Rows response = check self.clientEp->get(resourcePath, httpHeaders); + Row response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds rows to the end of a table in the workbook. + # 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 - Created. - remote isolated function createWorkbookTableRow(string itemId, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + 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 { + 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:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Row response = check self.clientEp->post(resourcePath, request, httpHeaders); + Row response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of table row in the worksheet. + # Get the range associated with the entire 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 - OK - remote isolated function listTableRows(string itemId, 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 Rows|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; - 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); + # + return - Success. + remote isolated function getWorksheetTableRowRange(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Rows response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds rows to the end of a table in the worksheet. + # Get the range associated with the entire 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 - Created. - remote isolated function createTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + return - Success. + remote isolated function getWorksheetTableRowRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/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->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of table row. + # Retrieve a list of table column in 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 - # + rowIndex - The index of the table row # + sessionId - The ID of the session - # + return - Success. - remote isolated function updateTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, int rowIndex, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + 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 listWorkbookTableColumns(string itemId, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Columns|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + 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); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds rows to the end of the table. + # Create a new table column in 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 # + sessionId - The ID of the session - # + return - Created. - remote isolated function addTableRow(string itemId, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/add`; + # + return - OK. + remote isolated function createWorkbookTableColumn(string itemId, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; 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->post(resourcePath, request, httpHeaders); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Gets a row based on its position in the collection. + # Retrieve a list of table column in the workbook. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + 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 + # + 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 getTableRowWithIndex(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})`; + remote isolated function listWorkbookTableColumnsWithItemPath(string itemPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Columns|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + 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); - Row response = check self.clientEp->get(resourcePath, httpHeaders); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the row from the workbook table. + # Create a new table column in the workbook. # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + 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 deleteTableRow(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)})`; + # + return - OK. + remote isolated function createWorkbookTableColumnWithItemPath(string itemPath, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Get the range associated with the entire row. + # Retrieve a list of table column in 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 getWorkbookTableRowRangeWithIndex(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`; + # + 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 listWorksheetTableColumns(string itemId, 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 Columns|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + 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); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the range associated with the entire row. + # Create a new table column in 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 - Success. - remote isolated function getTableRowRangeWithIndex(string itemId, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; + # + return - OK. + remote isolated function createWorksheetTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of table row in the workbook. + # Retrieve a list of table column in 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 # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources @@ -3245,37 +5073,38 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - Success. - remote isolated function listWorkbookTableRowsWithItemPath(string itemPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Rows|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + return - OK. + remote isolated function listWorksheetTableColumnsWithItemPath(string itemPath, 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 Columns|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; 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); - Rows response = check self.clientEp->get(resourcePath, httpHeaders); + Columns response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds rows to the end of a table in the workbook. + # Create a new table column in 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 # + sessionId - The ID of the session - # + return - Created. - remote isolated function createWorkbookTableRowWithItemPath(string itemPath, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + return - OK. + remote isolated function createWorksheetTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; 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->post(resourcePath, request, httpHeaders); + Column response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of table row in the worksheet. + # Retrieve the properties and relationships of table column. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -3286,131 +5115,168 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK - remote isolated function listTableRowsWithItemPath(string itemPath, 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 Rows|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + return - OK. + remote isolated function getWorkbookTableColumn(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; 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); - Rows response = check self.clientEp->get(resourcePath, httpHeaders); + Column response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds rows to the end of a table in the worksheet. + # Deletes the column from the table. # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemId - The ID of the drive containing 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 - Created. - remote isolated function createTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + return - No Content. + remote isolated function deleteWorkbookTableColumn(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; 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->post(resourcePath, request, httpHeaders); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); return response; } - # Update the properties of table row. + # Update the properties of table column # - # + itemPath - The full path of the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table - # + rowIndex - The index of the table row + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - Success. - remote isolated function updateTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int rowIndex, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows`; + # + return - OK. + remote isolated function updateWorkbookTableColumn(string itemId, string tableIdOrName, string columnIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; 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); + Column response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Adds rows to the end of the table. + # Retrieve the properties and relationships of table column. # # + itemPath - The full path of 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 - OK - remote isolated function addTableRowWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Row payload, string? sessionId = ()) returns Row|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/add`; + # + 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 getWorkbookTableColumnWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + 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->post(resourcePath, request, httpHeaders); + Column response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Gets a row based on its position in the collection. + # Deletes the column from the table. # # + 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. + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - OK - remote isolated function getTableRowWithIndexItemPath(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)})`; + # + return - No Content. + remote isolated function deleteWorkbookTableColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; 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; } - # Deletes the row from the workbook table. + # Update the properties of table column # # + 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. + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - OK - remote isolated function deleteTableRowWithItemPath(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)})`; + # + return - OK. + remote isolated function updateWorkbookTableColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Get the range associated with the entire row. + # Retrieve the properties and relationships of table column. # - # + 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. + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - OK - remote isolated function getWorkbookTableRowRangeWithIndexItemPath(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`; + # + 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 getWorksheetTableColumn(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + 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); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + Column response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Get the range associated with the entire row. + # Delete a column from a 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. + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - Success. - remote isolated function getTableRowRangeWithIndexItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, int index, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/rows/itemAt(index=${getEncodedUri(index)})/range`; + # + return - No Content. + remote isolated function deleteWorksheetTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; 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; } - # Retrieve a list of table column in the workbook. + # Update the properties of table column # # + 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 + # + columnIdOrName - The ID or name of the column + # + sessionId - The ID of the session + # + return - OK. + remote isolated function updateWorksheetTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + Column response = check self.clientEp->patch(resourcePath, request, httpHeaders); + return response; + } + # Retrieve the properties and relationships of table column. + # + # + itemPath - The full path of 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 # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -3421,230 +5287,221 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK - remote isolated function listWorkbookTableColumns(string itemId, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Columns|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + # + return - OK. + remote isolated function getWorksheetTableColumnWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; 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); - Columns response = check self.clientEp->get(resourcePath, httpHeaders); + Column response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Delete a column from a table. + # + # + itemPath - The full path of 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 - No Content. + remote isolated function deleteWorksheetTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); return response; } - # Create a new table column in the workbook. + # Update the properties of table column # - # + 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 + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + return - OK. - remote isolated function createWorkBookTableColumn(string itemId, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + remote isolated function updateWorksheetTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, Column payload, string? sessionId = ()) returns Column|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + Column response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of table column in the workbook. + # Gets the range associated with the data body of the column # # + 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 + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + return - OK. - remote isolated function listTableColumns(string itemId, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Columns[]|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + remote isolated function getworkbookTableColumnsDataBodyRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/dataBodyRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Columns[] response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Create a new table column in the workbook. + # Gets the range associated with the data body of the column # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet + # + itemPath - The full path of 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 - OK. - remote isolated function createTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + remote isolated function getworkbookTableColumnsDataBodyRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/dataBodyRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the column from the table. + # Gets the range associated with the data body of the column # # + 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 # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - No Content. - remote isolated function deleteWorkbookTableColumn(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + # + return - OK. + remote isolated function getworksheetTableColumnsDataBodyRange(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/dataBodyRange`; 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; } - # Delete a column from a table. + # Gets the range associated with the data body of the column # - # + 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 # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - No Content. - remote isolated function deleteTableColumn(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + # + return - OK. + remote isolated function getworksheetTableColumnsDataBodyRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/dataBodyRange`; 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; } - # Retrieve a list of table column in the workbook. + # Gets the range associated with the header row of the column. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + tableIdOrName - The ID or name of the table + # + columnIdOrName - The ID or name of the column # + 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 listWorkbookTableColumnsWithItemPath(string itemPath, string tableIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Columns|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; - 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); + # + return - OK. + remote isolated function getworkbookTableColumnsHeaderRowRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/headerRowRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Columns response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Create a new table column in the workbook. + # Gets the range associated with the header row of the column. # # + itemPath - The full path of 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 - OK. - remote isolated function createWorkBookTableColumnWithItemPath(string itemPath, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns`; + remote isolated function getworkbookTableColumnsHeaderRowRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/headerRowRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve a list of table column in the workbook. + # Gets the range associated with the header row of the column. # - # + 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 + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session # + return - OK. - remote isolated function listTableColumnsWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string? sessionId = ()) returns Columns|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + remote isolated function getworksheetTableColumnsHeaderRowRange(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/headerRowRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Columns response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Create a new table column in the workbook. + # Gets the range associated with the header row of the column. # # + itemPath - The full path of 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 - OK. - remote isolated function createTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, Column payload, string? sessionId = ()) returns Column|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns`; + remote isolated function getworksheetTableColumnsHeaderRowRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/headerRowRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Column response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the column from the table. + # Gets the range associated with the totals row of the column. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing 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 - No Content. - remote isolated function deleteWorkbookTableColumnWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + # + return - OK. + remote isolated function getworkbookTableColumnsTotalRowRange(string itemId, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/totalRowRange`; 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; } - # Delete a column from a table. + # Gets the range associated with the totals row of the column. # # + itemPath - The full path of 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 - No Content. - remote isolated function deleteTableColumnWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}`; + # + return - OK. + remote isolated function getworkbookTableColumnsTotalRowRangeWithItemPath(string itemPath, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/totalRowRange`; 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; } - # Retrieve a list of chart. + # Gets the range associated with the totals row of the column. # # + 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 + # + columnIdOrName - The ID or name of the column # + 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 - A collection of chart objects. - remote isolated function listCharts(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Charts|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts`; - 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); + # + return - OK. + remote isolated function getworksheetTableColumnsTotalRowRange(string itemId, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/totalRowRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Charts response = check self.clientEp->get(resourcePath, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Creates a new chart + # Gets the range associated with the totals row of the column. # - # + 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 + # + columnIdOrName - The ID or name of the column # + sessionId - The ID of the session - # + return - OK - remote isolated function addChart(string itemId, string worksheetIdOrName, CreateChartPayload payload, string? sessionId = ()) returns Chart|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/add`; + # + return - OK. + remote isolated function getworksheetTableColumnsTotalRowRangeWithItemPath(string itemPath, string worksheetIdOrName, string tableIdOrName, string columnIdOrName, string? sessionId = ()) returns Range|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/tables/${getEncodedUri(tableIdOrName)}/columns/${getEncodedUri(columnIdOrName)}/totalRowRange`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - Chart response = check self.clientEp->post(resourcePath, request, httpHeaders); + Range response = check self.clientEp->get(resourcePath, httpHeaders); return response; } # Retrieve the properties and relationships of chart. @@ -3692,38 +5549,49 @@ public isolated client class Client { Chart response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Resets the source data for the chart. + # Retrieve the properties and relationships of chart. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of 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 - OK. - remote isolated function setChartData(string itemId, string worksheetIdOrName, string chartIdOrName, ResetData payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setData`; + remote isolated function getChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Chart response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Positions the chart relative to cells on the worksheet + # Deletes the chart. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of 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 - OK - remote isolated function setPosition(string itemId, string worksheetIdOrName, string chartIdOrName, Position payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setPosition`; + # + return - OK. + remote isolated function deleteChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + return response; + } + # Update the properties of chart. + # + # + itemPath - The full path of 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 - OK. + remote isolated function updateChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, Chart payload, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); + Chart response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } # Retrieve a list of chart series . @@ -3753,107 +5621,26 @@ public isolated client class Client { } # create a new chart series. # - # + itemId - The ID of the drive containing 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 - Created. - remote isolated function createChartSeries(string itemId, string worksheetIdOrName, string chartIdOrName, ChartSeries payload, string? sessionId = ()) returns ChartSeries|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - http:Request request = new; - json jsonBody = payload.toJson(); - request.setPayload(jsonBody, "application/json"); - ChartSeries response = check self.clientEp->post(resourcePath, request, httpHeaders); - return response; - } - # Gets a chart based on its position in the collection. - # - # + itemId - The ID of the drive containing the workbook - # + 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 - OK. - remote isolated function getChartBasedOnPosition(string itemId, string worksheetIdOrName, int index, string? sessionId = ()) returns Chart|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/itemAt(index=${getEncodedUri(index)})`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Chart response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - # - # + itemId - The ID of the drive containing 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 - OK. - remote isolated function getChartImage(string itemId, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Image response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + chartIdOrName - The ID or name of the chart - # + width - The desired width of the resulting image. - # + sessionId - The ID of the session - # + return - OK. - remote isolated function getChartImageWithWidth(string itemId, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)})`; - map queryParam = {"width": width}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Image response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + chartIdOrName - The ID or name of the chart - # + width - The desired width of the resulting image. - # + height - The desired height of the resulting image. - # + sessionId - The ID of the session - # + return - OK. - remote isolated function getChartImageWithWidthHeight(string itemId, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)})`; - map queryParam = {"width": width, "height": height}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Image response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - # - # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet - # + chartIdOrName - The ID or name of the chart - # + width - The desired width of the resulting image. - # + 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 - OK. - remote isolated function getChartImageWithWidthHeightFittingMode(string itemId, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)},fittingMode=${getEncodedUri(fittingMode)})`; - map queryParam = {"width": width, "height": height, "fittingMode": fittingMode}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); + # + itemId - The ID of the drive containing 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 - Created. + remote isolated function createChartSeries(string itemId, string worksheetIdOrName, string chartIdOrName, ChartSeries payload, string? sessionId = ()) returns ChartSeries|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Image response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + ChartSeries response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of chart. + # Retrieve a list of chart series . # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -3864,75 +5651,76 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - A collection of chart objects. - remote isolated function listChartsWithItemPath(string itemPath, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns Charts|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts`; + # + return - Created. + remote isolated function listChartSeriesWithItemPath(string itemPath, 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 CollectionOfChartSeries|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; 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); - Charts response = check self.clientEp->get(resourcePath, httpHeaders); + CollectionOfChartSeries response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Creates a new chart + # create a new chart series. # # + itemPath - The full path of 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 - OK - remote isolated function addChartWithItemPath(string itemPath, string worksheetIdOrName, CreateChartPayload payload, string? sessionId = ()) returns Chart|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/add`; + # + return - Created. + remote isolated function createChartSeriesWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, ChartSeries payload, string? sessionId = ()) returns ChartSeries|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Chart response = check self.clientEp->post(resourcePath, request, httpHeaders); + ChartSeries response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve the properties and relationships of chart. + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing 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 - OK. - remote isolated function getChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Chart|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + remote isolated function getChartImage(string itemId, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - Chart response = check self.clientEp->get(resourcePath, httpHeaders); + Image response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Deletes the chart. + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. # # + itemPath - The full path of 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 - OK. - remote isolated function deleteChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + remote isolated function getChartImageWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - http:Response response = check self.clientEp->delete(resourcePath, headers = httpHeaders); + Image response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of chart. + # Resets the source data for the chart. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing 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 - OK. - remote isolated function updateChartWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, Chart payload, string? sessionId = ()) returns Chart|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}`; + remote isolated function resetChartData(string itemId, string worksheetIdOrName, string chartIdOrName, ResetData payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setData`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Chart response = check self.clientEp->patch(resourcePath, request, httpHeaders); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } # Resets the source data for the chart. @@ -3942,7 +5730,7 @@ public isolated client class Client { # + chartIdOrName - The ID or name of the chart # + sessionId - The ID of the session # + return - OK. - remote isolated function setChartDataWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, ResetData payload, string? sessionId = ()) returns http:Response|error { + remote isolated function resetChartDataWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, ResetData payload, string? sessionId = ()) returns http:Response|error { string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setData`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); @@ -3954,13 +5742,13 @@ public isolated client class Client { } # Positions the chart relative to cells on the worksheet # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing 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 - OK - remote isolated function setPositionWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, Position payload, string? sessionId = ()) returns http:Response|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setPosition`; + remote isolated function setChartPosition(string itemId, string worksheetIdOrName, string chartIdOrName, Position payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setPosition`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; @@ -3969,46 +5757,35 @@ public isolated client class Client { http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of chart series . + # Positions the chart relative to cells on the worksheet # # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart # + 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 - Created. - remote isolated function listChartSeriesWithItemPath(string itemPath, 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 CollectionOfChartSeries|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; - 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); + # + return - OK + remote isolated function setChartPositionWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, Position payload, string? sessionId = ()) returns http:Response|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/setPosition`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - CollectionOfChartSeries response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # create a new chart series. + # Gets a chart based on its position in the collection. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet - # + chartIdOrName - The ID or name of the chart + # + index - Index value of the object to be retrieved. Zero-indexed. # + sessionId - The ID of the session - # + return - Created. - remote isolated function createChartSeriesWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, ChartSeries payload, string? sessionId = ()) returns ChartSeries|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/series`; + # + return - OK. + remote isolated function getChartBasedOnPosition(string itemId, string worksheetIdOrName, int index, string? sessionId = ()) returns Chart|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/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"); - ChartSeries response = check self.clientEp->post(resourcePath, request, httpHeaders); + Chart response = check self.clientEp->get(resourcePath, httpHeaders); return response; } # Gets a chart based on its position in the collection. @@ -4027,13 +5804,16 @@ public isolated client class Client { } # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image # + sessionId - The ID of the session # + return - OK. - remote isolated function getChartImageWithItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image`; + remote isolated function getChartImageWithWidth(string itemId, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)})`; + map queryParam = {"width": width}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Image response = check self.clientEp->get(resourcePath, httpHeaders); @@ -4044,7 +5824,7 @@ public isolated client class Client { # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart - # + width - The desired width of the resulting image. + # + width - The desired width of the resulting image # + sessionId - The ID of the session # + return - OK. remote isolated function getChartImageWithWidthItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, string? sessionId = ()) returns Image|error { @@ -4058,15 +5838,15 @@ public isolated client class Client { } # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart - # + width - The desired width of the resulting image. - # + height - The desired height of the resulting image. + # + width - The desired width of the resulting image + # + height - The desired height of the resulting image # + sessionId - The ID of the session # + return - OK. - remote isolated function getChartImageWithWidthHeightItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)})`; + remote isolated function getChartImageWithWidthHeight(string itemId, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)})`; map queryParam = {"width": width, "height": height}; resourcePath = resourcePath + check getPathForQueryParam(queryParam); map headerValues = {"sessionId": sessionId}; @@ -4079,67 +5859,60 @@ public isolated client class Client { # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet # + chartIdOrName - The ID or name of the chart - # + width - The desired width of the resulting image. - # + 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)." + # + width - The desired width of the resulting image + # + height - The desired height of the resulting image # + sessionId - The ID of the session # + return - OK. - remote isolated function getChartImageWithWidthHeightFittingModeItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)},fittingMode=${getEncodedUri(fittingMode)})`; - map queryParam = {"width": width, "height": height, "fittingMode": fittingMode}; + remote isolated function getChartImageWithWidthHeightItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, int height, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)})`; + map queryParam = {"width": width, "height": height}; resourcePath = resourcePath + check getPathForQueryParam(queryParam); map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); Image response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve a list of named item. - # - # + itemId - The ID of the drive containing the workbook - # + sessionId - The ID of the session - # + return - OK - remote isolated function listWorkbookNamedItem(string itemId, string? sessionId = ()) returns NamedItems|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); - return response; - } - # Adds a new name to the collection of the given scope using the user's locale for the formula. + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. # # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image + # + 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 - Created. - remote isolated function addWorkbookNamedItem(string itemId, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/add`; + # + return - OK. + remote isolated function getChartImageWithWidthHeightFittingMode(string itemId, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)},fittingMode=${getEncodedUri(fittingMode)})`; + map queryParam = {"width": width, "height": height, "fittingMode": fittingMode}; + 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"); - NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); + Image response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Adds a new name to the collection of the given scope using the user's locale for the formula. + # Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. # - # + itemId - The ID of the drive containing the workbook + # + itemPath - The full path of the workbook # + worksheetIdOrName - The ID or name of the worksheet + # + chartIdOrName - The ID or name of the chart + # + width - The desired width of the resulting image + # + 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 - Created. - remote isolated function addNamedItem(string itemId, string worksheetIdOrName, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names/add`; + # + return - OK. + remote isolated function getChartImageWithWidthHeightFittingModeItemPath(string itemPath, string worksheetIdOrName, string chartIdOrName, int width, int height, "Fit"|"FitAndCenter"|"Fill" fittingMode, string? sessionId = ()) returns Image|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/charts/${getEncodedUri(chartIdOrName)}/image(width=${getEncodedUri(width)},height=${getEncodedUri(height)},fittingMode=${getEncodedUri(fittingMode)})`; + map queryParam = {"width": width, "height": height, "fittingMode": fittingMode}; + 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"); - NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); + Image response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the named item. + # Retrieves a list of named items. # # + itemId - The ID of the drive containing the workbook - # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -4150,9 +5923,9 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK. - remote isolated function getWorksheetNamedItems(string itemId, string worksheetIdOrName, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItems|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names`; + # + return - OK + remote isolated function listNamedItem(string itemId, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names`; 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}; @@ -4160,10 +5933,9 @@ public isolated client class Client { NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Retrieve the properties and relationships of the named item. + # Retrieve a list of named item. # - # + itemId - The ID of the drive containing the workbook - # + name - The name of the named item to get. + # + itemPath - The full path of the workbook # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -4174,64 +5946,54 @@ public isolated client class Client { # + 'select - Filters properties(columns) # + skip - Indexes into a result set # + top - Sets the page size of results - # + return - OK. - remote isolated function getWorkbookNamedItem(string itemId, 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 { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}`; + # + return - OK + remote isolated function listNamedItemWithItemPath(string itemPath, string? sessionId = (), string? count = (), string? expand = (), string? filter = (), string? format = (), string? orderby = (), string? search = (), string? 'select = (), int? skip = (), int? top = ()) returns NamedItems|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names`; 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); - NamedItem response = check self.clientEp->get(resourcePath, httpHeaders); + NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); return response; } - # Update the properties of the named item . + # Adds a new name to the collection of the given scope using the user's locale for the formula. # # + itemId - The ID of the drive containing the workbook - # + name - The name of the named item to get. # + sessionId - The ID of the session - # + return - OK. - remote isolated function updateWorkbookNamedItem(string itemId, string name, NamedItem payload, string? sessionId = ()) returns NamedItem|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}`; + # + return - Created. + remote isolated function addWorkbookNamedItem(string itemId, NewNamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - NamedItem response = check self.clientEp->patch(resourcePath, request, httpHeaders); - return response; - } - # Retrieve the range object that is associated with the name. - # - # + itemId - The ID of the drive containing the workbook - # + name - The name of the named item to get. - # + sessionId - The ID of the session - # + return - OK. - remote isolated function getNamedRange(string itemId, string name, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}/range`; - map headerValues = {"sessionId": sessionId}; - map httpHeaders = getMapForHeaders(headerValues); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } - # Retrieve a list of named item. + # Adds a new name to the collection of the given scope using the user's locale for the formula. # # + itemPath - The full path of the workbook # + sessionId - The ID of the session - # + return - OK - remote isolated function listWorkbookNamedItemWithItemPath(string itemPath, string? sessionId = ()) returns NamedItems|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names`; + # + return - Created. + remote isolated function addWorkbookNamedItemWithItemPath(string itemPath, NewNamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); - NamedItems response = check self.clientEp->get(resourcePath, httpHeaders); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->post(resourcePath, request, httpHeaders); return response; } # Adds a new name to the collection of the given scope using the user's locale for the formula. # - # + itemPath - The full path of the workbook + # + itemId - The ID of the drive containing the workbook + # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + return - Created. - remote isolated function addWorkbookNamedItemWithItemPath(string itemPath, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/add`; + remote isolated function addWorksheetNamedItem(string itemId, string worksheetIdOrName, NewNamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; @@ -4246,7 +6008,7 @@ public isolated client class Client { # + worksheetIdOrName - The ID or name of the worksheet # + sessionId - The ID of the session # + return - Created. - remote isolated function addNamedItemWithItemPath(string itemPath, string worksheetIdOrName, AddNamedItemPayload payload, string? sessionId = ()) returns NamedItem|error { + remote isolated function addWorksheetNamedItemWithItemPath(string itemPath, string worksheetIdOrName, NewNamedItem payload, string? sessionId = ()) returns NamedItem|error { string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/worksheets/${getEncodedUri(worksheetIdOrName)}/names/add`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); @@ -4258,8 +6020,8 @@ public isolated client class Client { } # Retrieve the properties and relationships of the named item. # - # + itemPath - The full path of the workbook - # + name - The name of the named item to get. + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + count - Retrieves the total count of matching resources # + expand - Retrieves related resources @@ -4271,8 +6033,8 @@ public isolated client class Client { # + skip - Indexes into a result set # + top - Sets the page size of results # + return - OK. - remote isolated function getWorkbookNamedItemWithItemPath(string itemPath, 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 { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}`; + remote isolated function getNamedItem(string itemId, 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 { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}`; 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}; @@ -4282,12 +6044,12 @@ public isolated client class Client { } # Update the properties of the named item . # - # + itemPath - The full path of the workbook - # + name - The name of the named item to get. + # + itemId - The ID of the drive containing the workbook + # + name - The name of the named item # + sessionId - The ID of the session # + return - OK. - remote isolated function updateWorkbookNamedItemWithItemPath(string itemPath, string name, NamedItem payload, string? sessionId = ()) returns NamedItem|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}`; + remote isolated function updateNamedItem(string itemId, string name, NamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/items/${getEncodedUri(itemId)}/workbook/names/${getEncodedUri(name)}`; map headerValues = {"sessionId": sessionId}; map httpHeaders = getMapForHeaders(headerValues); http:Request request = new; @@ -4296,17 +6058,44 @@ public isolated client class Client { NamedItem response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } - # Retrieve the range object that is associated with the name. + # Retrieve the properties and relationships of the named item. # # + itemPath - The full path of the workbook - # + name - The name of the named item to get. + # + name - The name of the named item # + 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 getNamedRangeWithItemPath(string itemPath, string name, string? sessionId = ()) returns Range|error { - string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}/range`; + remote isolated function getNamedItemWithItemPath(string itemPath, 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 { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}`; + 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); - Range response = check self.clientEp->get(resourcePath, httpHeaders); + NamedItem response = check self.clientEp->get(resourcePath, httpHeaders); + return response; + } + # Update the properties of the named item . + # + # + itemPath - The full path of the workbook + # + name - The name of the named item + # + sessionId - The ID of the session + # + return - OK. + remote isolated function updateNamedItemWithItemPath(string itemPath, string name, NamedItem payload, string? sessionId = ()) returns NamedItem|error { + string resourcePath = string `/me/drive/root:/${getEncodedUri(itemPath)}:/workbook/names/${getEncodedUri(name)}`; + map headerValues = {"sessionId": sessionId}; + map httpHeaders = getMapForHeaders(headerValues); + http:Request request = new; + json jsonBody = payload.toJson(); + request.setPayload(jsonBody, "application/json"); + NamedItem response = check self.clientEp->patch(resourcePath, request, httpHeaders); return response; } } diff --git a/ballerina/modules/excel/types.bal b/ballerina/modules/excel/types.bal index 3d2f66c..ded0131 100644 --- a/ballerina/modules/excel/types.bal +++ b/ballerina/modules/excel/types.bal @@ -68,15 +68,13 @@ public type OAuth2RefreshTokenGrantConfig record {| string refreshUrl = "https://login.microsoftonline.com/organizations/oauth2/v2.0/token"; |}; -public type ColumnsArr Columns[]; - -# Represents the properties to add a new name to the collection of the given scope using the user's locale for the formula.. +# 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. + # The name of the new named item string name?; - # The formula or the range that the name will refer to. + # The formula or the range that the name will refer to string formulas?; - # The formula or the range that the name will refer to. + # The formula or the range that the name will refer to string comment?; }; @@ -84,29 +82,29 @@ public type FormulaLocal record { public type RangeView record { # Represents the cell addresses record {} cellAddresses?; - # Returns the number of visible columns. Read-only. + # Returns the number of visible columns int columnCount?; - # Represents the formula in A1-style notation. + # 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. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. - record {} formulasLocal?; - # Represents the formula in R1C1-style notation. + # Represents the formula in A1-style notation, in the user's language and number-formatting locale + string 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. + # Represents Excel's number format code for the given cell record {} numberFormat?; - # Returns the total number of rows in the range. Read-only. + # Returns the total number of rows in the range int rowCount?; - # Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + # Text values of the specified range record {} text?; - # Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. - record {} valueTypes?; - # Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. - record {} values?; + # 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. +# Represents the properties of the named item public type NamedItems record { # Represents the list of the named item NamedItem[] value?; @@ -126,8 +124,15 @@ public type RangeFormat record { boolean wrapText?; }; -# Represents the properties to create a named item. -public type AddNamedItemPayload Item|FormulaLocal; +# 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 { @@ -137,24 +142,36 @@ public type Worksheet record { string name?; # The position of the worksheet in the workbook int position?; - # The Visibility of the worksheet. + # The Visibility of the worksheet "Visible"|"Hidden"|"VeryHidden" visibility?; }; -# Represents the properties to create chart. -public type CreateChartPayload 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 a list of chart. public type Charts record { # Represents the list of the chart - Chart[] values?; + 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. @@ -165,7 +182,7 @@ public type ChartSeries record { # 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. + # Set true to merge cells in each row of the specified range as separate merged cells boolean across?; }; @@ -175,19 +192,11 @@ public type Image record { string value?; }; -# Represents the properties to create table. -public type CreateTablePayload record { - # Address or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used. - string address?; - # whether the data being imported has column labels. If the source doesn't contain headers (when this property set to false), Excel generates header shifting the data down by one row. - boolean hasHeaders?; -}; - # 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. + # The name of the new named item string name?; - # The type of the new named item. + # 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?; @@ -210,7 +219,7 @@ public type Column record { # The name of the table column. string name?; # The raw values of the specified range - (string|int)[][] values?; + (string|int|decimal?)[][] values?; }; # Represents the properties to clear range values @@ -219,10 +228,10 @@ public type ApplyTo record { "All"|"Formats"|"Contents" applyTo?; }; -# Represents a list of table. +# Represents a list of tables. public type Tables record { # List of table - Table[] valuse?; + Table[] value?; }; # Represents the range. @@ -231,31 +240,47 @@ public type AnotherRange record { 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?; + "Recalculate"|"Full"|"FullRebuild" calculationMode; }; # Represents a chart properties. public type Chart record { - # Represents the height, in points, of the chart object. + # Represents the height, in points, of the chart object decimal height?; - # Gets a chart based on its position in the collection. Read-only. + # 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. + # The distance, in points, from the left side of the chart to the worksheet origin decimal left?; - # Represents the name of a chart object. + # 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). + # 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 object. + # Represents the width, in points, of the chart decimal width?; }; @@ -265,12 +290,6 @@ public type Rows record { Row[] value?; }; -# Represents worksheet name to create worksheet. -public type CreateWorksheet record { - # Name of the new worksheet. - string name?; -}; - # Represents the ways to shift the cells. public type Shift record { # Specifies which way to shift the cells @@ -283,10 +302,18 @@ public type Comment record { string content?; # Indicates the type for the comment string contentType?; - # Represents the comment identifier. Read-only + # 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 @@ -303,20 +330,23 @@ public type Table record { 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. Setting this is only allowed if the table contains a header row + # 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. This value can be set to show or remove the header row + # Indicates whether the header row is visible or not boolean showHeaders?; - # Indicates whether the total row is visible or not. This value can be set to show or remove the total row + # Indicates whether the total row is visible or not boolean showTotals?; - # Constant value that represents the Table style. + # 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. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings. - record {} startCell; + # 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?; }; @@ -324,7 +354,7 @@ public type Position record { # Represents the list of workbook comment. public type Comments record { # The list of workbook comment - Comment[] values?; + Comment[] value?; }; # Represents the list of table column. @@ -334,51 +364,51 @@ public type Columns record { }; public type Range record { - # Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only + # The range reference in A1-style string address?; - # Represents range reference for the specified range in the language of the user. Read-only. + # Range reference for the specified range in the language of the user string addressLocal?; - # Number of cells in the range. Read-only. + # Number of cells in the range int cellCount?; - # Represents the total number of columns in the range. Read-only. + # The total number of columns in the range int columnCount?; # Represents if all columns of the current range are hidden boolean columnHidden?; - # Represents the column number of the first cell in the range. Zero-indexed. Read-only. + # The column number of the first cell in the range int columnIndex?; - # Represents the formula in A1-style notation. + # The formula in A1-style notation (string|int)[][]? formulas?; - # Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. - (string|int)[][]? formulasLocal?; - # Represents the formula in R1C1-style notation. + # The formula in A1-style notation, in the user's language and number-formatting locale + string? formulasLocal?; + # The formula in R1C1-style notation (string|int)[][]? formulasR1C1?; - # Represents if all cells of the current range are hidden. Read-only. + # 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?; - # Returns the total number of rows in the range. Read-only. + # The total number of rows in the range int rowCount?; - # Represents if all rows of the current range are hidden. + # Represents if all rows of the current range are hidden boolean rowHidden?; - # Returns the row number of the first cell in the range. Zero-indexed. Read-only. + # The row number of the first cell in the range int rowIndex?; - # Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + # Text values of the specified range (string|int)[][]? text?; - # Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. - (string|int)[][]? valueTypes?; - # Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. - (string|int)[][]? values?; + # 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 worksheet. +# Represents the list of the worksheet. public type Worksheets record { - # The list of worksheet + # The list of the worksheet Worksheet[] value?; }; # Represents the pivot table. public type PivotTable record { - # ID of the PivotTable. Read-only. + # ID of the PivotTable string id?; # Name of the PivotTable string name?; @@ -394,20 +424,34 @@ public type OffsetRange record { # Represents the properties to reset the data of the chart. public type ResetData record { - # The range corresponding to the source data. - record {} sourceData?; - # Specifies the way columns or rows are used as data series on the chart. + # 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; + string content?; # Indicates the type for the comment reply - string contentType; + string contentType?; }; # Represents the collection of the chart series. @@ -418,19 +462,27 @@ public type CollectionOfChartSeries record { # Represents the table row properties. public type Row record { - # The ID of the table row. + # The ID of the table row string id?; - # The index of the table row. + # The index of the table row int index?; - # The values in the table row. - (string|int)[][] values?; + # 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. + # The name of the new named item string name?; - # The type of the new named item. + # The type of the new named item "String"|"Integer"|"Double"|"Range"|"Boolean" 'type?; # The comment associated with this name string comment?; @@ -452,6 +504,20 @@ public type Application record { public type Session record { # The ID of the workbook session string id?; - # Whether to create a persistent session or not. `true` for persistent session. `false` for non-persistent session (view mode) + # 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/ballerina/modules/excel/utils.bal b/ballerina/modules/excel/utils.bal index 3528057..29d80ca 100644 --- a/ballerina/modules/excel/utils.bal +++ b/ballerina/modules/excel/utils.bal @@ -221,4 +221,3 @@ isolated function getMapForHeaders(map headerParam) returns map createSession()"); - string|error response = excelClient->createSession(workBookId); - if (response is string) { - sessionId = response; - test:assertNotEquals(response, EMPTY_STRING, "Session is not created"); - } else { + excel:Session|error response = excelClient->createSession(workBookId, {persistChanges: false}); + if response is error { test:assertFail(response.toString()); } } @test:Config {} function testAddWorksheet() { - log:printInfo("excelClient -> addWorksheet()"); - Worksheet|error response = excelClient->addWorksheet(workBookId, worksheetName, sessionId); - if (response is Worksheet) { + excel:Worksheet|error response = excelClient->addWorksheet(workBookId, {name: worksheetName}, sessionId); + if response is excel:Worksheet { string name = response?.name ?: EMPTY_STRING; test:assertEquals(name, worksheetName, "Unmatch worksheet name"); } else { test:assertFail(response.toString()); - } + } } @test:Config {dependsOn: [testAddWorksheet]} function testGetWorksheet() { - Worksheet|error response = excelClient->getWorksheet(workBookId, worksheetName, sessionId); - if (response is Worksheet) { + excel:Worksheet|error response = excelClient->getWorksheet(workBookId, worksheetName, sessionId); + if response is excel:Worksheet { string name = response?.name ?: EMPTY_STRING; test:assertEquals(name, worksheetName, "Worksheet not found"); } else { @@ -77,9 +86,8 @@ function testGetWorksheet() { @test:Config {dependsOn: [testGetWorksheet]} function testListWorksheets() { - log:printInfo("excelClient -> listWorksheets()"); - Worksheet[]|error response = excelClient->listWorksheets(workBookId, sessionId = sessionId); - if (response is Worksheet[]) { + excel:Worksheet[]|error response = excelClient->listWorksheets(workBookId, sessionId = sessionId); + if response is excel:Worksheet[] { string responseWorksheetName = response[0]?.name ?: EMPTY_STRING; test:assertNotEquals(responseWorksheetName, EMPTY_STRING, "Found 0 worksheets"); } else { @@ -87,14 +95,10 @@ function testListWorksheets() { } } -int sheetPosition = 1; -Worksheet sheet = {position: sheetPosition}; - @test:Config {dependsOn: [testDeleteTable]} function testUpdateWorksheet() { - log:printInfo("excelClient -> updateWorksheet()"); - Worksheet|error response = excelClient->updateWorksheet(workBookId, worksheetName, sheet, sessionId); - if (response is Worksheet) { + excel:Worksheet|error response = excelClient->updateWorksheet(workBookId, worksheetName, sheet, sessionId); + if response is excel:Worksheet { int responsePosition = response?.position ?: 0; test:assertEquals(responsePosition, sheetPosition, "Unmatch worksheet position"); } else { @@ -102,14 +106,11 @@ function testUpdateWorksheet() { } } -int rowIndex = 2; - @test:Config {dependsOn: [testGetWorksheet]} function testGetCell() { - log:printInfo("excelClient -> getCell()"); - Cell|error response = excelClient->getCell(workBookId, worksheetName, rowIndex, 7, sessionId); - if (response is Cell) { - int row = response.rowIndex; + excel:Range|error response = excelClient->getWorksheetCell(workBookId, worksheetName, rowIndex, 7, sessionId); + if response is excel:Range { + int row = response.rowIndex; test:assertEquals(row, rowIndex, "Unmatch worksheet position"); } else { test:assertFail(response.toString()); @@ -118,18 +119,20 @@ function testGetCell() { @test:AfterSuite {} function testDeleteWorksheet() { - log:printInfo("excelClient -> deleteWorksheet()"); - error? response = excelClient->deleteWorksheet(workBookId, worksheetName, sessionId); - if (response is error) { + http:Response|error response = excelClient->deleteWorksheet(workBookId, worksheetName, sessionId); + if response is http:Response { + if response.statusCode != 404 { + test:assertFail(response.statusCode.toBalString()); + } + } else if response is error { test:assertFail(response.toString()); } } @test:Config {dependsOn: [testGetWorksheet]} function testAddTable() { - log:printInfo("excelClient -> addTable()"); - Table|error response = excelClient->addTable(workBookId, worksheetName, "A1:C3", sessionId = sessionId); - if (response is Table) { + excel:Table|error response = excelClient->addWorksheetTable(workBookId, worksheetName, {address: "A1:C3"}, sessionId = sessionId); + if response is excel:Table { tableName = response?.name ?: EMPTY_STRING; test:assertNotEquals(tableName, EMPTY_STRING, "Table is not created"); } else { @@ -139,9 +142,8 @@ function testAddTable() { @test:Config {dependsOn: [testAddTable]} function testGetTable() { - log:printInfo("excelClient -> getTable()"); - Table|error response = excelClient->getTable(workBookId, worksheetName, tableName, sessionId = sessionId); - if (response is Table) { + excel:Table|error response = excelClient->getWorksheetTable(workBookId, worksheetName, tableName, sessionId = sessionId); + if response is excel:Table { string responseTableName = response?.name ?: EMPTY_STRING; test:assertEquals(tableName, responseTableName, "Table is not created"); } else { @@ -152,8 +154,8 @@ function testGetTable() { @test:Config {dependsOn: [testGetTable]} function testListTable() { log:printInfo("excelClient -> listTables()"); - Table[]|error response = excelClient->listTables(workBookId, sessionId = sessionId); - if (response is Table[]) { + excel:Table[]|error response = excelClient->listWorkbookTables(workBookId, sessionId = sessionId); + if response is excel:Table[] { string responseTableName = response[0]?.name ?: EMPTY_STRING; test:assertNotEquals(responseTableName, EMPTY_STRING, "Found 0 tables"); } else { @@ -161,17 +163,10 @@ function testListTable() { } } -boolean showHeaders = false; -Table updateTable = { - showHeaders: showHeaders, - showTotals: false -}; - @test:Config {dependsOn: [testGetTable]} function testUpdateTable() { - log:printInfo("excelClient -> updateTable()"); - Table|error response = excelClient->updateTable(workBookId, worksheetName, tableName, updateTable, sessionId); - if (response is Table) { + 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"); } else { @@ -183,11 +178,10 @@ int rowInputIndex = 1; @test:Config {dependsOn: [testUpdateTable]} function testCreateRow() { - log:printInfo("excelClient -> createRow()"); - Row|error response = excelClient->createRow(workBookId, worksheetName, tableName, [[1, 2, 3]], rowInputIndex, - sessionId); - if (response is Row) { - int responseIndex = response.index; + excel:Row|error response = excelClient->createWorksheetTableRow(workBookId, worksheetName, tableName, {values: [[1, 2, 3]], index: rowInputIndex}, sessionId); + if response is excel:Row { + rowId = response.id; + int responseIndex = response.index; test:assertEquals(responseIndex, rowInputIndex, "Row is not added"); } else { test:assertFail(response.toString()); @@ -196,10 +190,9 @@ function testCreateRow() { @test:Config {dependsOn: [testCreateRow]} function testListRows() { - log:printInfo("excelClient -> listRows()"); - Row[]|error response = excelClient->listRows(workBookId, worksheetName, tableName, sessionId = sessionId); - if (response is Row[]) { - int responseIndex = response[1].index; + 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"); } else { test:assertFail(response.toString()); @@ -209,11 +202,13 @@ function testListRows() { @test:Config {dependsOn: [testCreateRow]} function testUpdateRow() { string value = "testValue"; - log:printInfo("excelClient -> updateRow()"); - Row|error response = excelClient->updateRow(workBookId, worksheetName, tableName, rowInputIndex, [[(), (), value]], - sessionId); - if (response is Row) { - json updatedValue = response.values[0][2]; + excel:Row|error response = excelClient->updateWorksheetTableRow(workBookId, worksheetName, tableName, rowInputIndex, {values: [[(), (), value]]},sessionId); + if response is excel:Row { + (string|int|decimal?)[][]? values = response.values; + if values is () { + test:assertFail("Row is not updated"); + } + json updatedValue = values[0][2]; test:assertEquals(updatedValue.toString(), value, "Row is not updated"); } else { test:assertFail(response.toString()); @@ -222,22 +217,20 @@ function testUpdateRow() { @test:Config {dependsOn: [testUpdateRow, testListRows]} function testDeleteRow() { - log:printInfo("excelClient -> deleteRow()"); - error? response = excelClient->deleteRow(workBookId, worksheetName, tableName, rowInputIndex, sessionId); - if (response is error) { + error|http:Response response = excelClient->deleteWorksheetTableRow(workBookId, worksheetName, tableName, rowInputIndex, sessionId); + if response is error { test:assertFail(response.toString()); + } else if (response.statusCode != 204) { + test:assertFail(response.statusCode.toBalString()); } } -int columnInputIndex = 2; - @test:Config {dependsOn: [testDeleteRow]} function testCreateColumn() { - log:printInfo("excelClient -> createColumn()"); - Column|error response = excelClient->createColumn(workBookId, worksheetName, tableName, [["a3"], ["c3"], ["aa"]], - columnInputIndex, sessionId); - if (response is Column) { - int responseIndex = response.index; + excel:Column|error response = excelClient->createWorksheetTableColumn(workBookId, worksheetName, tableName, {index: columnInputIndex, values : [["a3"], ["c3"], ["aa"]]}, sessionId); + if response is excel:Column { + int responseIndex = response.index; + columnName = response.name; test:assertEquals(responseIndex, columnInputIndex, "Column is not added"); } else { test:assertFail(response.toString()); @@ -246,10 +239,9 @@ function testCreateColumn() { @test:Config {dependsOn: [testCreateColumn]} function testListColumn() { - log:printInfo("excelClient -> listColumns()"); - Column[]|error response = excelClient->listColumns(workBookId, worksheetName, tableName, sessionId = sessionId); - if (response is Column[]) { - int responseIndex = response[2].index; + excel:Column[]|error response = excelClient->listWorksheetTableColumns(workBookId, worksheetName, tableName, sessionId = sessionId); + if response is excel:Column[] { + int responseIndex = response[2].index; test:assertEquals(responseIndex, columnInputIndex, "Found 0 columns"); } else { test:assertFail(response.toString()); @@ -259,12 +251,10 @@ function testListColumn() { @test:Config {dependsOn: [testCreateColumn]} function testUpdateColumn() { string value = "testName"; - log:printInfo("excelClient -> updateColumn()"); - Column|error response = excelClient->updateColumn(workBookId, worksheetName, tableName, columnInputIndex, - [[()], [()], [value]], sessionId = sessionId); - if (response is Column) { - json updatedValue = response.values[2][0]; - test:assertEquals(updatedValue.toString(), value, "Column is not updated"); + 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"); } else { test:assertFail(response.toString()); } @@ -272,27 +262,24 @@ function testUpdateColumn() { @test:Config {dependsOn: [testUpdateColumn, testListColumn]} function testDeleteColumn() { - log:printInfo("excelClient -> deleteColumn()"); - error? response = excelClient->deleteColumn(workBookId, worksheetName, tableName, columnInputIndex, sessionId); - if (response is error) { + error|http:Response response = excelClient->deleteWorksheetTableColumn(workBookId, worksheetName, tableName, columnName, sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {dependsOn: [testDeleteColumn, testDeleteRow, testListTable, testUpdateTable]} function testDeleteTable() { - log:printInfo("excelClient -> deleteTable()"); - error? response = excelClient->deleteTable(workBookId, worksheetName, tableName, sessionId); - if (response is error) { + error|http:Response response = excelClient->deleteWorksheetTable(workBookId, worksheetName, tableName, sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {dependsOn: [testCreateRow]} function testAddChart() { - log:printInfo("excelClient -> addChart()"); - Chart|error response = excelClient->addChart(workBookId, worksheetName, "ColumnStacked", "A1:B2", AUTO, sessionId); - if (response is Chart) { + excel:Chart|error response = excelClient->addChart(workBookId, worksheetName, {'type: "ColumnStacked" , sourceData: "A1:B2", seriesBy: "Auto"}, sessionId); + if response is excel:Chart { chartName = response?.name; test:assertNotEquals(chartName, EMPTY_STRING, "Chart is not created"); } else { @@ -302,9 +289,8 @@ function testAddChart() { @test:Config {dependsOn: [testAddChart]} function testGetChart() { - log:printInfo("excelClient -> getChart()"); - Chart|error response = excelClient->getChart(workBookId, worksheetName, chartName, sessionId = sessionId); - if (response is Chart) { + excel:Chart|error response = excelClient->getChart(workBookId, worksheetName, chartName, sessionId = sessionId); + if response is excel:Chart { string chartId = response?.id ?: EMPTY_STRING; test:assertNotEquals(chartId, EMPTY_STRING, "Chart not found"); } else { @@ -314,9 +300,8 @@ function testGetChart() { @test:Config {dependsOn: [testGetChart]} function testListChart() { - log:printInfo("excelClient -> listCharts()"); - Chart[]|error response = excelClient->listCharts(workBookId, worksheetName, sessionId = sessionId); - if (response is Chart[]) { + excel:Chart[]|error response = excelClient->listCharts(workBookId, worksheetName, sessionId = sessionId); + if response is excel:Chart[] { string chartId = response[0]?.id ?: EMPTY_STRING; test:assertNotEquals(chartId, EMPTY_STRING, "Found 0 charts"); } else { @@ -324,18 +309,17 @@ function testListChart() { } } -float height = 99; -Chart updateChart = { +decimal height = 99; +excel:Chart updateChart = { height: height, left: 99 }; @test:Config {dependsOn: [testListChart]} function testUpdateChart() { - log:printInfo("excelClient -> updateChart()"); - Chart|error response = excelClient->updateChart(workBookId, worksheetName, chartName, updateChart, sessionId); - if (response is Chart) { - float responseHeight = response?.height ?: 0; + excel:Chart|error response = excelClient->updateChart(workBookId, worksheetName, chartName, updateChart, sessionId); + if response is excel:Chart { + decimal responseHeight = response?.height ?: 0; test:assertEquals(responseHeight, height, "Chart is not updated"); } else { test:assertFail(response.toString()); @@ -344,55 +328,48 @@ function testUpdateChart() { @test:Config {dependsOn: [testUpdateChart]} function testGetChartImage() { - log:printInfo("excelClient -> getChartImage()"); - string|error response = excelClient->getChartImage(workBookId, worksheetName, chartName, sessionId = sessionId); - if (response is error) { + excel:Image|error response = excelClient->getChartImage(workBookId, worksheetName, chartName, sessionId = sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {dependsOn: [testGetChartImage]} function testResetData() { - log:printInfo("excelClient -> resetChartData()"); - error? response = excelClient->resetChartData(workBookId, worksheetName, chartName, "A1:B3", AUTO, sessionId); - if (response is error) { + error|http:Response response = excelClient->resetChartData(workBookId, worksheetName, chartName, {sourceData:"A1:B3", seriesBy: "Auto"}, sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {dependsOn: [testResetData]} function testSetPosition() { - log:printInfo("excelClient -> setChartPosition()"); - error? response = excelClient->setChartPosition(workBookId, worksheetName, chartName, "D3", sessionId = sessionId); - if (response is error) { + error|http:Response response = excelClient->setChartPosition(workBookId, worksheetName, chartName, { startCell: "D3" }, sessionId = sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {dependsOn: [testSetPosition]} function testDeleteChart() { - log:printInfo("excelClient -> deleteChart()"); - error? response = excelClient->deleteChart(workBookId, worksheetName, chartName, sessionId); - if (response is error) { + error|http:Response response = excelClient->deleteChart(workBookId, worksheetName, chartName, sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {} function testGetWorkbookApplication() { - log:printInfo("excelClient -> getWorkbookApplication()"); - - WorkbookApplication|error response = excelClient->getWorkbookApplication(workBookId, sessionId); - if (response is error) { + excel:Application|error response = excelClient->getApplication(workBookId, sessionId); + if response is error { test:assertFail(response.toString()); } } @test:Config {} function testCalculateWorkbookApplication() { - log:printInfo("excelClient -> calculateWorkbookApplication()"); - error? response = excelClient->calculateWorkbookApplication(workBookId, FULL, sessionId); - if (response is error) { + error|http:Response response = excelClient->calculateApplication(workBookId, {calculationMode: "Full"}, sessionId); + if response is error { test:assertFail(response.toString()); } } diff --git a/ballerina/types.bal b/ballerina/types.bal deleted file mode 100644 index 45a4fd4..0000000 --- a/ballerina/types.bal +++ /dev/null @@ -1,215 +0,0 @@ -// Copyright (c) 2021, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -import ballerina/http; -import ballerinax/'client.config; - -# Client configuration details. -@display {label: "Connection Config"} -public type ConnectionConfig record {| - *config:ConnectionConfig; - # Configurations related to client authentication - http:BearerTokenConfig|config:OAuth2RefreshTokenGrantConfig auth; -|}; - -# Represents worksheet properties. -# -# + id - Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains -# the same even when the worksheet is renamed or moved -# + position - The zero-based position of the worksheet within the workbook -# + name - Worksheet name -# + visibility - The visibility of the worksheet -@display {label: "Worksheet"} -public type Worksheet record { - string & readonly id?; - @display {label: "Position"} - int position?; - @display {label: "Worksheet Name"} - string name?; - Visibility visibility?; -}; - -# Represents cell properties. -# -# + address - Represents the range reference in A1-style. Address value will contain the Sheet reference -# (e.g. Sheet1!A1:B4) -# + addressLocal - Represents cell reference in the language of the user -# + columnIndex - Represents the column number of the first cell in the range. Zero-indexed -# + formulas - Represents the formula in A1-style notation -# + formulasLocal - Represents the formula in A1-style notation, in the user's language and number-formatting locale. -# For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German -# + formulasR1C1 - Represents the formula in R1C1-style notation -# + hidden - Represents if cell is hidden -# + numberFormat - Excel's number format code for the given cell -# + rowIndex - Returns the row number of the first cell in the range. Zero-indexed -# + text - Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution -# that happens in Excel UI will not affect the text value returned by the API -# + valueTypes - Represents the type of data of each cell. The data returned could be of type string, number, or a -# boolean. Cell that contain an error will return the error string -# + values - Raw value of the specified cell -@display {label: "Cell"} -public type Cell record { - string address; - string addressLocal; - int columnIndex; - json formulas; - json formulasLocal; - json formulasR1C1; - boolean hidden; - json numberFormat; - int rowIndex; - json text; - json valueTypes; - json[][] values; -}; - -# Represents the Excel application that manages the workbook. -# -# + calculationMode - Returns the calculation mode used in the workbook -@display {label: "Workbook Application"} -public type WorkbookApplication record { - string calculationMode; -}; - -# Represents an Excel table. -# -# + id - Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the -# same even when the table is renamed. This property should be interpreted as an opaque string value and -# should not be parsed to any other type -# + name - Name of the table -# + showHeaders - Indicates whether the header row is visible or not. This value can be set to show or remove the header -# row -# + showTotals - Indicates whether the total row is visible or not. This value can be set to show or remove the total -# row. -# + style - Constant value that represents the Table style. The possible values are: TableStyleLight1 thru -# TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified. -# + highlightFirstColumn - Indicates whether the first column contains special formatting -# + highlightLastColumn - Indicates whether the last column contains special formatting -# + showBandedColumns - Indicates whether the columns show banded formatting in which odd columns are highlighted -# differently from even ones to make reading the table easier -# + showBandedRows - Indicates whether the rows show banded formatting in which odd rows are highlighted differently -# from even ones to make reading the table easier -# + showFilterButton - Indicates whether the filter buttons are visible at the top of each column header. Setting this -# is only allowed if the table contains a header row -# + legacyId - Legacy Id used in older Excle clients. The value of the identifier remains the same even when the table -# is renamed. This property should be interpreted as an opaque string value and should not be parsed to -# any other type -@display {label: "Table"} -public type Table record { - string & readonly id?; - @display {label: "Table Name"} - string name?; - @display {label: "Show Headers?"} - boolean showHeaders?; - @display {label: "Show Totals"} - boolean showTotals?; - @display {label: "Table Style"} - string style?; - @display {label: "Highlight First Column?"} - boolean highlightFirstColumn?; - @display {label: "Highlight Last Column?"} - boolean highlightLastColumn?; - @display {label: "Show Banded Columns?"} - boolean showBandedColumns?; - @display {label: "Show Banded Rows?"} - boolean showBandedRows?; - @display {label: "Show Filter Button?"} - boolean showFilterButton?; - string & readonly legacyId?; -}; - -# Represents row properties. -# -# + index - Returns the index number of the row within the rows collection of the table. Zero-indexed -# + values - Represents the raw values of the specified range. The data returned could be of type string, number, or a -# boolean. Cell that contain an error will return the error strings -@display {label: "Row"} -public type Row record { - int index; - json[][] values; -}; - -# Chart object in a workbook. -# -# + id - Chart ID -# + height - The height, in points, of the chart object -# + left - The distance, in points, from the left side of the chart to the worksheet origin -# + name - The name of a chart -# + top - 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) -# + width - The width, in points, of the chart object -@display {label: "Chart"} -public type Chart record { - string & readonly id?; - @display {label: "Chart Height"} - float height?; - @display {label: "Distance from Left"} - float left?; - @display {label: "Chart Name"} - string name?; - @display {label: "Distance from Top"} - float top?; - @display {label: "Chart Width"} - float width?; -}; - -# Represents column properties. -# -# + id - A unique key that identifies the column within the table. This property should be interpreted as an opaque -# string value and should not be parsed to any other type -# + name - The name of the table column -# + index - The index number of the column within the columns collection of the table -# + values - Raw values of the specified range. The data returned could be of type string, number, or a -# boolean. Cell that contain an error will return the error string -@display {label: "Column"} -public type Column record { - string id; - string name?; - int index; - json[][] values; -}; - -# Specifies the calculation type to use in the workbook. -@display {label: "Calculation Type"} -public enum CalculationType { - RECALCULATE = "Recalculate", - FULL = "Full", - FULL_REBUILD = "FullRebuild" -} - -# Specifies the way columns or rows are used as data series on the chart. -@display {label: "Series By"} -public enum SeriesBy { - AUTO = "Auto", - BY_COLUMNS = "Columns", - BY_ROWS = "Rows" -} - -# Specifies Visibility options in the worksheet. -@display {label: "Visibility"} -public enum Visibility { - VISIBLE = "Visible", - HIDDEN = "Hidden", - VERY_HIDDEN = "VeryHidden" -} - -# Specifies the options used to scale the chart to the specified dimensions. -@display {label: "Chart Fitting Mode"} -public enum FittingMode { - FIT = "Fit", - FIT_AND_CENTER = "FitAndCenter", - FILL = "Fill" -} diff --git a/ballerina/utils.bal b/ballerina/utils.bal index 4a8c7a8..f474a86 100644 --- a/ballerina/utils.bal +++ b/ballerina/utils.bal @@ -14,115 +14,6 @@ // specific language governing permissions and limitations // under the License. -import ballerina/http; - -isolated function createRequestParams(string[] pathParameters, string workbookIdOrPath, string? sessionId = (), string? query = ()) -returns [string, map?]|error { - string path = check createRequestPath(pathParameters, workbookIdOrPath, query); - map? headers = createRequestHeader(sessionId); - return [path, headers]; -} - -isolated function createRequestPath(string[] pathParameters, string workbookIdOrPath, string? query = ()) -returns string|error { - string path = EMPTY_STRING; - string[] baseParameters = workbookIdOrPath.endsWith(".xlsx") ? [ME, DRIVE, ROOT + COLON, workbookIdOrPath + COLON, - WORKBOOK] : [ME, DRIVE, ITEMS, workbookIdOrPath, WORKBOOK]; - - path = check createPath(path, baseParameters); - path = check createPath(path, pathParameters); - path = query is string ? (path + query) : path; - return path; -} - -isolated function createRequestHeader(string? sessionId = ()) returns map? { - if sessionId is string { - map headers = {}; - headers[WORKBOOK_SESSION_ID] = sessionId; - return headers; - } - return; -} - -isolated function createPath(string currentpath, string[] pathParameters) returns string|error { - string path = currentpath; - if (pathParameters.length() > 0) { - foreach string element in pathParameters { - if (!element.startsWith(FORWARD_SLASH)) { - path = path + FORWARD_SLASH; - } - path += element; - } - } - return path; +isolated function isItemPath(string itemIdOrPath) returns boolean { + return itemIdOrPath.endsWith(".xlsx"); } - -isolated function setOptionalParamsToPath(string currentPath, int? width, int? height, string? fittingMode) -returns string { - string path = currentPath; - if (width is int) { - if (height is int) { - if (fittingMode is string) { - path = currentPath + OPEN_ROUND_BRACKET + WIDTH + EQUAL_SIGN + width.toString() + COMMA + HEIGHT + - EQUAL_SIGN + height.toString() + COMMA + FITTING_MODE + EQUAL_SIGN + fittingMode.toString() + - CLOSE_ROUND_BRACKET; - } else { - path = currentPath + OPEN_ROUND_BRACKET + WIDTH + EQUAL_SIGN + width.toString() + COMMA + HEIGHT + - EQUAL_SIGN + height.toString() + CLOSE_ROUND_BRACKET; - } - } else { - path = currentPath + OPEN_ROUND_BRACKET + WIDTH + EQUAL_SIGN + width.toString() + CLOSE_ROUND_BRACKET; - } - } - return path; -} - -isolated function handleResponse(http:Response httpResponse) returns map|error { - if (httpResponse.statusCode == http:STATUS_OK || httpResponse.statusCode == http:STATUS_CREATED) { - final json jsonResponse = check httpResponse.getJsonPayload(); - return >jsonResponse; - } else if (httpResponse.statusCode == http:STATUS_NO_CONTENT) { - return {}; - } - json jsonResponse = check httpResponse.getJsonPayload(); - return error(jsonResponse.toString()); -} - -isolated function getWorksheetArray(http:Response response) returns Worksheet[]|error { - map handledResponse = check handleResponse(response); - return check handledResponse[VALUE].cloneWithType(WorkSheetArray); -} - -isolated function getRowArray(http:Response response) returns Row[]|error { - map handledResponse = check handleResponse(response); - return check handledResponse[VALUE].cloneWithType(RowArray); -} - -isolated function getColumnArray(http:Response response) returns Column[]|error { - map handledResponse = check handleResponse(response); - return check handledResponse[VALUE].cloneWithType(ColumnArray); -} - -isolated function getTableArray(http:Response response) returns Table[]|error { - map handledResponse = check handleResponse(response); - return check handledResponse[VALUE].cloneWithType(TableArray); -} - -isolated function getChartArray(http:Response response) returns Chart[]|error { - map handledResponse = check handleResponse(response); - return check handledResponse[VALUE].cloneWithType(ChartArray); -} - -isolated function createSubPath(string ItemIdOrPath) returns string { - return ItemIdOrPath.endsWith(".xlsx") ? string `items/${ItemIdOrPath}` : string `root:/${ItemIdOrPath}:`; -} - -type WorkSheetArray Worksheet[]; - -type RowArray Row[]; - -type ColumnArray Column[]; - -type TableArray Table[]; - -type ChartArray Chart[]; diff --git a/spec.yaml b/spec.yaml index 6c5e31c..1c7886b 100644 --- a/spec.yaml +++ b/spec.yaml @@ -31,16 +31,16 @@ components: description: The ID of the workbook session persistChanges: type: boolean - description: Whether to create a persistent session or not. `true` for persistent session. `false` for non-persistent session (view mode) + description: Whether to create a persistent session or not. `true` for persistent session. required: - persistChanges - CreateWorksheet: + NewWorksheet: type: object description: Represents worksheet name to create worksheet. properties: name: type: string - description: Name of the new worksheet. + description: Name of the new worksheet Worksheet: type: object description: Represents the worksheet. @@ -56,18 +56,18 @@ components: description: The position of the worksheet in the workbook visibility: type: string - description: The Visibility of the worksheet. + description: The Visibility of the worksheet enum: - Visible - Hidden - VeryHidden Worksheets: type: object - description: Represents the list of worksheet. + description: Represents the list of the worksheet. properties: value: type: array - description: The list of worksheet + description: The list of the worksheet items: $ref: '#/components/schemas/Worksheet' CalculationMode: @@ -81,6 +81,8 @@ components: - Recalculate - Full - FullRebuild + required: + - calculationMode Application: type: object description: Represents the Excel application that manages the workbook. @@ -104,12 +106,12 @@ components: description: Indicates the type for the comment id: type: string - description: Represents the comment identifier. Read-only + description: Represents the comment identifier Comments: type: object description: Represents the list of workbook comment. properties: - values: + value: type: array description: The list of workbook comment items: @@ -142,19 +144,23 @@ components: properties: id: type: string - description: The ID of the table row. + description: The ID of the table row index: type: integer - description: The index of the table row. + description: The index of the table row values: type: array - description: The values in the table row. + description: The values in the table row items: type: array items: oneOf: - type: string + nullable: true - type: integer + nullable: true + - type: number + nullable: true Rows: type: object description: Represents the list of table row properties. @@ -170,7 +176,7 @@ components: properties: across: type: boolean - description: Set true to merge cells in each row of the specified range as separate merged cells. + description: Set true to merge cells in each row of the specified range as separate merged cells default: false ApplyTo: type: object @@ -183,16 +189,16 @@ components: - All - Formats - Contents - CreateTablePayload: + NewTable: type: object description: Represents the properties to create table. properties: address: type: string - description: Address or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used. + description: Address or name of the range object representing the data source hasHeaders: type: boolean - description: whether the data being imported has column labels. If the source doesn't contain headers (when this property set to false), Excel generates header shifting the data down by one row. + description: whether the data being imported has column labels Table: type: object description: Represents a table properties. @@ -220,16 +226,16 @@ components: description: Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier showFilterButton: type: boolean - description: Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row + description: Indicates whether the filter buttons are visible at the top of each column header showHeaders: type: boolean - description: Indicates whether the header row is visible or not. This value can be set to show or remove the header row + description: Indicates whether the header row is visible or not showTotals: type: boolean - description: Indicates whether the total row is visible or not. This value can be set to show or remove the total row + description: Indicates whether the total row is visible or not style: type: string - description: Constant value that represents the Table style. + description: Constant value that represents the Table style enum: - TableStyleLight1 - TableStyleLight21 @@ -240,9 +246,9 @@ components: - TableStyleDark11 Tables: type: object - description: Represents a list of table. + description: Represents a list of tables. properties: - valuse: + value: type: array description: List of table items: @@ -252,26 +258,26 @@ components: properties: address: type: string - description: Represents the range reference in A1-style. Address value contains the Sheet reference (for example, Sheet1!A1:B4). Read-only + description: The range reference in A1-style addressLocal: type: string - description: Represents range reference for the specified range in the language of the user. Read-only. + description: Range reference for the specified range in the language of the user cellCount: type: integer - description: Number of cells in the range. Read-only. + description: Number of cells in the range columnCount: type: integer - description: Represents the total number of columns in the range. Read-only. + description: The total number of columns in the range columnHidden: type: boolean description: Represents if all columns of the current range are hidden columnIndex: type: integer - description: Represents the column number of the first cell in the range. Zero-indexed. Read-only. + description: The column number of the first cell in the range formulas: type: array nullable: true - description: Represents the formula in A1-style notation. + description: The formula in A1-style notation items: type: array items: @@ -279,19 +285,13 @@ components: - type: string - type: integer formulasLocal: - type: array + type: string nullable: true - description: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. - items: - type: array - items: - oneOf: - - type: string - - type: integer + description: The formula in A1-style notation, in the user's language and number-formatting locale formulasR1C1: type: array nullable: true - description: Represents the formula in R1C1-style notation. + description: The formula in R1C1-style notation items: type: array items: @@ -300,7 +300,7 @@ components: - type: integer hidden: type: boolean - description: Represents if all cells of the current range are hidden. Read-only. + description: Represents if all cells of the current range are hidden numberFormat: type: array nullable: true @@ -313,17 +313,17 @@ components: - type: integer rowCount: type: integer - description: Returns the total number of rows in the range. Read-only. + description: The total number of rows in the range rowHidden: type: boolean - description: Represents if all rows of the current range are hidden. + description: Represents if all rows of the current range are hidden rowIndex: type: integer - description: Returns the row number of the first cell in the range. Zero-indexed. Read-only. + description: The row number of the first cell in the range text: type: array nullable: true - description: Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + description: Text values of the specified range items: type: array items: @@ -331,25 +331,30 @@ components: - type: string - type: integer valueTypes: - type: array - nullable: true - description: Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. - items: - type: array - items: - oneOf: - - type: string - - type: integer + type: string + description: Represents the type of data of each cell + enum: + - Unknown + - Empty + - String + - Integer + - Double + - Boolean + - Error values: type: array nullable: true - description: Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. + description: Represents the raw values of the specified range items: type: array items: - oneOf: + oneOf: - type: string + nullable: true - type: integer + nullable: true + - type: number + nullable: true RangeView: type: object description: Represents a range view. @@ -359,35 +364,223 @@ components: description: Represents the cell addresses columnCount: type: integer - description: Returns the number of visible columns. Read-only. + description: Returns the number of visible columns formulas: type: object - description: Represents the formula in A1-style notation. + description: Represents the formula in A1-style notation formulasLocal: - type: object - description: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. + type: string + description: Represents the formula in A1-style notation, in the user's language and number-formatting locale formulasR1C1: type: object - description: Represents the formula in R1C1-style notation. + description: Represents the formula in R1C1-style notation index: type: integer description: Index of the range numberFormat: type: object - description: Represents Excel's number format code for the given cell. + description: Represents Excel's number format code for the given cell rowCount: type: integer - description: Returns the total number of rows in the range. Read-only. + description: Returns the total number of rows in the range text: type: object - description: Text values of the specified range. The Text value doesn't depend on the cell width. The sign substitution that happens in Excel UI doesn't affect the text value returned by the API. Read-only. + description: Text values of the specified range valueTypes: - type: object - description: Represents the type of data of each cell. The possible values are:- Unknown, Empty, String, Integer, Double, Boolean, Error. Read-only. + type: string + description: Represents the type of data of each cell + enum: + - Unknown + - Empty + - String + - Integer + - Double + - Boolean + - Error values: + type: array + nullable: true + description: Represents the raw values of the specified range + items: + type: array + items: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: number + nullable: true + RangeBorder: + type: object + description: Represents a range border. + properties: + color: + type: string + description: 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") + id: + type: string + description: Represents border identifier + enum: + - EdgeTop + - EdgeBottom + - EdgeLeft + - EdgeRight + - InsideVertical + - InsideHorizontal + - DiagonalDown + - DiagonalUp + sideIndex: + type: string + description: Constant value that indicates the specific side of the border + enum: + - EdgeTop + - EdgeBottom + - EdgeLeft + - EdgeRight + - InsideVertical + - InsideHorizontal + - DiagonalDown + - DiagonalUp + style: + type: string + description: One of the constants of line style specifying the line style for the border + enum: + - None + - Continuous + - Dash + - DashDot + - DashDotDot + - Dot + - Double + - SlantDashDot + weight: + type: string + description: Specifies the weight of the border around a range + enum: + - Hairline + - Thin + - Medium + - Thick + RangeBorders: + type: object + description: Represents a list of range border. + properties: + value: + type: array + description: The list of range border + items: + $ref: '#/components/schemas/RangeBorder' + RangeSort: + type: object + description: Represents the sorting for the range. + properties: + fields: + type: object + description: The list of conditions to sort on + items: + $ref: '#/components/schemas/SortField' + matchCase: + type: boolean + description: Whether to have the casing determine string ordering + hasHeaders: + type: boolean + description: Whether the range has a header + orientation: + type: string + description: Whether the operation is sorting rows or columns + enum: + - Rows + - Columns + method: + type: string + description: The ordering method used for Chinese characters + enum: + - PinYin + - StrokeCount + SortField: + type: object + description: Represents the current conditions used to last sort. + properties: + ascending: + type: boolean + description: Represents whether the sorting is done in an ascending fashion + color: + type: string + description: Represents the color that is the target of the condition if the sorting is on font or cell color + dataOption: + type: string + description: Represents additional sorting options for this field + enum: + - Normal + - TextAsNumber + icon: + type: object + description: Represents the icon that is the target of the condition if the sorting is on the cell's icon + items: + $ref: '#/components/schemas/Icon' + key: + type: integer + description: Represents the column (or row, depending on the sort orientation) that the condition is on + sortOn: + type: string + description: Represents the type of sorting of this condition + enum: + - Value + - CellColor + - FontColor + - Icon + Icon: + type: object + description: Represents a range border. + properties: + index: + type: integer + description: The index of the icon in the given set + set: + type: string + description: The set that the icon is part of + enum: + - Invalid + - ThreeArrows + - ThreeArrowsGray + - ThreeFlags + - ThreeTrafficLights1 + - ThreeTrafficLights2 + - ThreeSigns + - ThreeSymbols + - ThreeSymbols2 + - FourArrows + - FourArrowsGray + - FourRedToBlack + - FourRating + - FourTrafficLights + - FiveArrows + - FiveArrowsGray + - FiveRating + - FiveQuarters + - ThreeStars + - ThreeTriangles + - FiveBoxes + TableSort: + type: object + description: Represents the sorting for the table. + properties: + fields: type: object - description: Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string. - CreateChartPayload: + description: The current conditions used to last sort the table + items: + $ref: '#/components/schemas/SortField' + matchCase: + type: boolean + description: Represents whether the casing impacted the last sort of the table + method: + type: string + description: Represents Chinese character ordering method last used to sort the table + enum: + - PinYin + - StrokeCount + NewChart: type: object description: Represents the properties to create chart. properties: @@ -399,38 +592,42 @@ components: description: The Range object corresponding to the source data seriesBy: type: string - description: Specifies the way columns or rows are used as data series on the chart. + description: Specifies the way columns or rows are used as data series on the chart enum: - Auto - Columns - Rows + required: + - type + - sourceData + - seriesBy Chart: type: object description: Represents a chart properties. properties: height: type: number - description: Represents the height, in points, of the chart object. + description: Represents the height, in points, of the chart object id: type: string - description: Gets a chart based on its position in the collection. Read-only. + description: Gets a chart based on its position in the collection left: type: number - description: The distance, in points, from the left side of the chart to the worksheet origin. + description: The distance, in points, from the left side of the chart to the worksheet origin name: type: string - description: Represents the name of a chart object. + description: Represents the name of a chart object top: type: number - description: 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). + description: 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) width: type: number - description: Represents the width, in points, of the chart object. + description: Represents the width, in points, of the chart Charts: type: object description: Represents a list of chart. properties: - values: + value: type: array items: $ref: '#/components/schemas/Chart' @@ -442,7 +639,7 @@ components: value: type: string description: The image in base64-encoded - AddNamedItemPayload: + NewNamedItem: type: object description: Represents the properties to create a named item. oneOf: @@ -454,10 +651,10 @@ components: properties: name: type: string - description: The name of the new named item. + description: The name of the new named item type: type: string - description: The type of the new named item. + description: The type of the new named item enum: - Range - Formula @@ -473,27 +670,27 @@ components: description: The comment associated with the named item FormulaLocal: type: object - description: Represents the properties to add a new name to the collection of the given scope using the user's locale for the formula.. + description: Represents the properties to add a new name to the collection of the given scope using the user's locale for the formula. properties: name: type: string - description: The name of the new named item. + description: The name of the new named item formulas: type: string - description: The formula or the range that the name will refer to. + description: The formula or the range that the name will refer to comment: type: string - description: The formula or the range that the name will refer to. + description: The formula or the range that the name will refer to NamedItem: type: object description: Represents the properties of the named item. properties: name: type: string - description: The name of the new named item. + description: The name of the new named item type: type: string - description: The type of the new named item. + description: The type of the new named item enum: - String - Integer @@ -519,7 +716,7 @@ components: description: Specifies whether the object is visible or not NamedItems: type: object - description: Represents the properties of the named item. + description: Represents the properties of the named item properties: value: type: array @@ -531,11 +728,11 @@ components: description: Represents the properties to reset the data of the chart. properties: sourceData: - type: object - description: The range corresponding to the source data. + type: string + description: The range corresponding to the source data seriesBy: type: string - description: Specifies the way columns or rows are used as data series on the chart. + description: Specifies the way columns or rows are used as data series on the chart enum: - Auto - Columns @@ -545,8 +742,8 @@ components: description: Represents the properties of the position. properties: startCell: - type: object - description: The start cell. This is where the chart is moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings. + type: string + description: The start cell. This is where the chart is moved to endCell: type: string description: The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range. @@ -652,7 +849,11 @@ components: items: oneOf: - type: string + nullable: true - type: integer + nullable: true + - type: number + nullable: true Columns: type: object description: Represents the list of table column. @@ -668,7 +869,7 @@ components: properties: id: type: string - description: ID of the PivotTable. Read-only. + description: ID of the PivotTable name: type: string description: Name of the PivotTable @@ -747,7 +948,7 @@ components: type: integer address: name: address - description: The address + description: The address of the range in: path required: true schema: @@ -759,8 +960,8 @@ components: required: true schema: type: integer - namedItemName: - name: namedItemName + name: + name: name description: The name of the named item in: path required: true @@ -886,21 +1087,21 @@ components: type: integer width: name: width - description: The desired width of the resulting image. + description: The desired width of the resulting image in: query required: true schema: type: integer height: name: height - description: The desired height of the resulting image. + description: The desired height of the resulting image in: query required: true schema: type: integer fittingMode: name: fittingMode - description: The method used to scale the chart to the specified dimensions (if both height and width are set)." + description: The method used to scale the chart to the specified dimensions (if both height and width are set) in: query required: true schema: @@ -909,27 +1110,19 @@ components: - Fit - FitAndCenter - Fill - name: - name: name - description: The name of the named item to get. - in: path - required: true - schema: - type: string pivotTableId: name: pivotTableId - description: The ID of the pivot table. + description: The ID of the pivot table in: path required: true schema: type: string paths: - #___________________________________ SESSION ________________________________________ + #___________________________________ WORKBOOK ________________________________________ /me/drive/items/{itemId}/workbook/createSession: post: summary: Creates a new session for a workbook. operationId: createSession - description: Create a workbook session to start a persistent or non-persistent session tags: - session parameters: @@ -948,36 +1141,10 @@ paths: application/json: schema: $ref: "#/components/schemas/Session" - /me/drive/items/{itemId}/workbook/refreshSession: - post: - summary: Refresh the existing workbook session.. - operationId: refreshSession - description: Refresh an existing workbook session. - tags: - - session - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/workbookSessionId' - responses: - '204': - description: No Content - /me/drive/items/{itemId}/workbook/closeSession: - post: - summary: Close the existing workbook session. - operationId: closeSession - tags: - - session - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/workbookSessionId' - responses: - '204': - description: No Content /me/drive/root:/{itemPath}:/workbook/createSession: post: summary: Creates a new session for a workbook. operationId: createSessionWithItemPath - description: Create a workbook session to start a persistent or non-persistent session tags: - session parameters: @@ -994,10 +1161,21 @@ paths: application/json: schema: $ref: "#/components/schemas/Session" + /me/drive/items/{itemId}/workbook/refreshSession: + post: + summary: Refreshes the existing workbook session. + operationId: refreshSession + tags: + - session + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/workbookSessionId' + responses: + '204': + description: No Content /me/drive/root:/{itemPath}:/workbook/refreshSession: post: - summary: Refresh the existing workbook session.. - description: Refresh an existing workbook session. + summary: Refreshes the existing workbook session.. operationId: refreshSessionWithItemPath tags: - session @@ -1007,10 +1185,21 @@ paths: responses: '204': description: No Content + /me/drive/items/{itemId}/workbook/closeSession: + post: + summary: Closes the existing workbook session. + operationId: closeSession + tags: + - session + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/workbookSessionId' + responses: + '204': + description: No Content /me/drive/root:/{itemPath}:/workbook/closeSession: post: - summary: Close an existing workbook session. - description: Close an existing workbook session. + summary: Closes an existing workbook session. operationId: closeSessionWithItemPath tags: - session @@ -1020,43 +1209,78 @@ paths: responses: '204': description: No Content - #___________________________________ WORKBOOK ________________________________________ - /me/drive/items/{itemId}/workbook/application/calculate: - post: - summary: Recalculate all currently opened workbooks in Excel. - operationId: calculateApplication + /me/drive/items/{itemId}/workbook/tables: + get: + summary: Retrieves a list of table in the workbook. + operationId: ListWorkbookTables tags: - - workbook + - tables parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CalculationMode' + - $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/items/{itemId}/workbook/application: + content: + application/json: + schema: + $ref: '#/components/schemas/Tables' + /me/drive/root:/{itemPath}:/workbook/tables: get: - summary: Get the properties and relationships of the application. - operationId: getApplication + summary: Retrieves a list of table in the workbook. + operationId: ListWorkbookTablesWithItemPath tags: - - workbook + - tables parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $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/Application' + $ref: '#/components/schemas/Tables' + + #___________________________________ WORKBOOK APPLICATION________________________________________ + /me/drive/items/{itemId}/workbook/application/calculate: + post: + summary: Recalculates all currently opened workbooks in Excel. + operationId: calculateApplication + tags: + - workbook + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CalculationMode' + responses: + '200': + description: OK /me/drive/root:/{itemPath}:/workbook/application/calculate: post: - summary: Recalculate all currently opened workbooks in Excel. + summary: Recalculates all currently opened workbooks in Excel. operationId: calculateApplicationWithItemPath tags: - workbook @@ -1071,9 +1295,25 @@ paths: responses: '200': description: OK + /me/drive/items/{itemId}/workbook/application: + get: + summary: Gets the properties and relationships of the application. + operationId: getApplication + tags: + - workbook + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Application' /me/drive/root:/{itemPath}:/workbook/application: get: - summary: Get the properties and relationships of the application. + summary: Gets the properties and relationships of the application. operationId: getApplicationWithItemPath tags: - workbook @@ -1090,7 +1330,7 @@ paths: #___________________________________ WORKBOOK COMMENTS ________________________________________ /me/drive/items/{itemId}/workbook/comments: get: - summary: Retrieve a list of comment. + summary: Retrieves a list of comment. operationId: listComments tags: - comment @@ -1104,15 +1344,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Comments' - /me/drive/items/{itemId}/workbook/comments/{commentId}: + /me/drive/root:/{itemPath}:/workbook/comments: get: - summary: Retrieve the properties and relationships of the comment. - operationId: getComment + summary: Retrieves a list of comment. + operationId: listCommentsWithItemPath tags: - comment parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -1120,99 +1359,82 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Comment' - /me/drive/items/{itemId}/workbook/comments/{commentId}/replies: - post: - summary: Create a new reply of the comment. - operationId: createCommentReply + $ref: '#/components/schemas/Comments' + /me/drive/items/{itemId}/workbook/comments/{commentId}: + get: + summary: Retrieves the properties and relationships of the comment. + operationId: getComment tags: - comment parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/commentId' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Reply' responses: - '201': - description: Created. + '200': + description: OK content: application/json: schema: - $ref: '#/components/schemas/Reply' + $ref: '#/components/schemas/Comment' + /me/drive/root:/{itemPath}:/workbook/comments/{commentId}: get: - summary: List the replies of the comment. - operationId: listCommentReplies + summary: Retrieves the properties and relationships of the comment. + operationId: getCommentWithItemPath tags: - comment parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/commentId' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. + description: OK content: application/json: schema: - $ref: '#/components/schemas/Replies' - /me/drive/items/{itemId}/workbook/comments/{commentId}/replies/{replyId}: - get: - summary: Retrieve the properties and relationships of the reply. - operationId: getCommentReply + $ref: '#/components/schemas/Comment' + /me/drive/items/{itemId}/workbook/comments/{commentId}/replies: + post: + summary: Creates a new reply of the comment. + operationId: createCommentReply tags: - comment parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/commentId' - - $ref: '#/components/parameters/replyId' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' responses: - '200': - description: OK. + '201': + description: Created. content: application/json: schema: $ref: '#/components/schemas/Reply' - /me/drive/root:/{itemPath}:/workbook/comments: - get: - summary: Retrieve a list of comment. - operationId: listCommentsWithItemPath - tags: - - comment - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Comments' - /me/drive/root:/{itemPath}:/workbook/comments/{commentId}: get: - summary: Retrieve the properties and relationships of the comment. - operationId: getCommentWithItemPath + summary: Lists the replies of the comment. + operationId: listCommentReplies tags: - comment parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/commentId' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Comment' + $ref: '#/components/schemas/Replies' /me/drive/root:/{itemPath}:/workbook/comments/{commentId}/replies: post: - summary: Create a new reply of the comment. + summary: Creates a new reply of the comment. operationId: createCommentReplyWithItemPath tags: - comment @@ -1233,7 +1455,7 @@ paths: schema: $ref: '#/components/schemas/Reply' get: - summary: List the replies of the comment. + summary: Lists the replies of the comment. operationId: listCommentRepliesWithItemPath tags: - comment @@ -1248,9 +1470,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Replies' + /me/drive/items/{itemId}/workbook/comments/{commentId}/replies/{replyId}: + get: + summary: Retrieves the properties and relationships of the reply. + operationId: getCommentReply + tags: + - comment + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/commentId' + - $ref: '#/components/parameters/replyId' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' /me/drive/root:/{itemPath}:/workbook/comments/{commentId}/replies/{replyId}: get: - summary: Retrieve the properties and relationships of the reply. + summary: Retrieves the properties and relationships of the reply. operationId: getCommentReplyWithItemPath tags: - comment @@ -1266,36 +1506,63 @@ paths: application/json: schema: $ref: '#/components/schemas/Reply' - #___________________________________ WORKSHEET ________________________________________ - /me/drive/items/{itemId}/workbook/worksheets: + #___________________________________ WORKBOOK TABLE ROW ________________________________________ + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows: + get: + summary: Retrieves a list of table row in the workbook. + operationId: listWorkbookTableRows + tags: + - row + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Rows' post: - summary: Adds a new worksheet to the workbook. - operationId: AddWorksheet + summary: Adds rows to the end of a table in the workbook. + operationId: createWorkbookTableRow tags: - - worksheet + - row parameters: - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - default: {} - $ref: "#/components/schemas/CreateWorksheet" + $ref: '#/components/schemas/Row' responses: '201': - description: OK + description: Created. content: application/json: schema: - $ref: '#/components/schemas/Worksheet' + $ref: '#/components/schemas/Row' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows: get: - summary: Retrieve a list of worksheet. - operationId: listWorksheets + summary: Retrieves a list of table row in the workbook. + operationId: listWorkbookTableRowsWithItemPath tags: - - worksheet + - row parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1308,20 +1575,42 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK + description: Success. content: application/json: schema: - $ref: '#/components/schemas/Worksheets' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}: + $ref: '#/components/schemas/Rows' + post: + summary: Adds rows to the end of a table in the workbook. + operationId: createWorkbookTableRowWithItemPath + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows/{index}: get: - summary: Retrieve the properties and relationships of worksheet. - operationId: getWorksheet + summary: Retrieves the properties and relationships of table row. + operationId: getWorkbookTableRow tags: - - worksheet + - row parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1334,88 +1623,56 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK. + description: OK content: application/json: schema: - $ref: '#/components/schemas/Worksheet' + $ref: '#/components/schemas/Row' patch: - summary: Update the properties of worksheet. - operationId: updateWorksheet + summary: Updates the properties of table row. + operationId: updateWorkbookTableRow + tags: + - row parameters: - $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/Worksheet' + $ref: '#/components/schemas/Row' responses: '200': description: Success. content: application/json: schema: - $ref: '#/components/schemas/Worksheet' + $ref: '#/components/schemas/Row' delete: - summary: Delete Worksheet - operationId: deleteWorksheet - description: Delete a worksheet from a workbook. - tags: - - worksheet - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/sessionId' - responses: - '204': - description: No Content - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/usedRange: - get: - summary: Get the used range of a worksheet. - operationId: getUsedRange - tags: - - worksheet - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/cell(row={row},column={column}): - get: - summary: Gets the range containing the single cell based on row and column numbers. - operationId: getRangeWithRowAndColumn + summary: Deletes the row from the workbook table. + operationId: deleteWorkbookTableRow tags: - - worksheet + - row parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables: + description: OK + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/{index}: get: - summary: Retrieve a list of workbook pivottable. - operationId: listPivotTable + summary: Retrieves the properties and relationships of table row. + operationId: getWorkbookTableRowWithItemPath tags: - - worksheet + - row parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1428,70 +1685,213 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK. + description: OK content: application/json: schema: - $ref: '#/components/schemas/PivotTables' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: - get: - summary: Retrieve the properties and relationships of pivot table. - operationId: getPivotTable + $ref: '#/components/schemas/Row' + patch: + summary: Updates the properties of table row. + operationId: updateWorkbookTableRowWithItemPath tags: - - worksheet + - row parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/pivotTableId' + - $ref: '#/components/parameters/itemPath' + - $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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' responses: '200': - description: OK. + description: Success. content: application/json: schema: - $ref: '#/components/schemas/PivotTable' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refresh: - post: - summary: Refreshes the pivot table. - operationId: refreshPivotTable + $ref: '#/components/schemas/Row' + delete: + summary: Deletes the row from the workbook table. + operationId: deleteWorkbookTableRowWithItemPath tags: - - worksheet + - 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 + tags: + - row parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/pivotTableId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refreshAll: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Gets the range associated with the entire row. + operationId: getWorkbookTableRowRangeWithItemPath + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + 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 + 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 + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + 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. + operationId: addWorkbookTableRow + tags: + - row + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/add: post: - summary: Refreshes the pivot table within a given worksheet. - operationId: refreshAllPivotTable + summary: Adds rows to the end of the table. + operationId: addWorkbookTableRowWithItemPath + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + #___________________________________ WORKSHEET ________________________________________ + /me/drive/items/{itemId}/workbook/worksheets: + post: + summary: Adds a new worksheet to the workbook. + operationId: AddWorksheet + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + default: {} + $ref: "#/components/schemas/NewWorksheet" + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + get: + summary: Retrieve a list of the worksheets. + operationId: listWorksheets tags: - worksheet parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/pivotTableId' - $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. + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheets' /me/drive/root:/{itemPath}:/workbook/worksheets: post: summary: Adds a new worksheet to the workbook. - operationId: AddWorksheetWithIemPath + operationId: AddWorksheetWithItemPath tags: - worksheet parameters: @@ -1502,7 +1902,7 @@ paths: application/json: schema: default: {} - $ref: "#/components/schemas/CreateWorksheet" + $ref: "#/components/schemas/NewWorksheet" responses: '201': description: OK @@ -1511,8 +1911,8 @@ paths: schema: $ref: '#/components/schemas/Worksheet' get: - summary: Retrieve a list of worksheet. - operationId: listWorksheetsWithIemPath + summary: Retrieve a list of the worksheet. + operationId: listWorksheetsWithItemPath tags: - worksheet parameters: @@ -1534,14 +1934,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Worksheets' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}: get: - summary: Retrieve the properties and relationships of worksheet. - operationId: getWorksheetWithIemPath + summary: Retrieve the properties and relationships of the worksheet. + operationId: getWorksheet tags: - worksheet parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' @@ -1562,9 +1962,11 @@ paths: $ref: '#/components/schemas/Worksheet' patch: summary: Update the properties of worksheet. - operationId: updateWorksheetWithIemPath + operationId: updateWorksheet + tags: + - worksheet parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: @@ -1580,90 +1982,129 @@ paths: schema: $ref: '#/components/schemas/Worksheet' delete: - summary: Delete Worksheet - operationId: deleteWorksheetWithIemPath - description: Delete a worksheet from a workbook. + summary: Delete a worksheet from a workbook. + operationId: deleteWorksheet tags: - worksheet parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' responses: '204': description: No Content - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/usedRange: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}: get: - summary: Get the used range of a worksheet. - operationId: getUsedRangeWithIemPath + summary: Retrieve the properties and relationships of the worksheet. + operationId: getWorksheetWithItemPath tags: - worksheet parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $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/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/cell(row={row},column={column}): - get: - summary: Gets the range containing the single cell based on row and column numbers. - operationId: getRangeWithRowAndColumnWithItemPath + $ref: '#/components/schemas/Worksheet' + patch: + summary: Update the properties of the worksheet. + operationId: updateWorksheetWithItemPath tags: - worksheet parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Worksheet' + delete: + summary: Delete a worksheet from a workbook. + operationId: deleteWorksheetWithItemPath + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/add: + post: + summary: Adds a new table in the worksheet. + operationId: addWorksheetTable + tags: + - worksheet + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTable' responses: '200': - description: OK. + description: OK content: application/json: schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables: - get: - summary: Retrieve a list of workbook pivottable. - operationId: listPivotTableWithItemPath + $ref: '#/components/schemas/Table' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/add: + post: + summary: Adds a new table in the worksheet. + operationId: addWorksheetTableWithItemPath tags: - worksheet parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTable' responses: '200': - description: OK. + description: OK content: application/json: schema: - $ref: '#/components/schemas/PivotTables' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: + $ref: '#/components/schemas/Table' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts: get: - summary: Retrieve a list of workbook pivottable. - operationId: getPivotTableWithItemPath + summary: Retrieves a list of charts. + operationId: listCharts tags: - worksheet parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/pivotTableId' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1675,92 +2116,47 @@ paths: - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/top' responses: - '200': - description: OK. + "200": + description: A collection of chart. content: application/json: schema: - $ref: '#/components/schemas/PivotTable' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refresh: - post: - summary: Refreshes the pivot table. - operationId: refreshPivotTableWithItemPath - tags: - - worksheet - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/pivotTableId' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refreshAll: - post: - summary: Refreshes the pivot table within a given worksheet. - operationId: refreshAllPivotTableWithItemPath + $ref: '#/components/schemas/Charts' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts: + get: + summary: Retrieve a list of chart. + operationId: listChartsWithItemPath tags: - worksheet parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/pivotTableId' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - #___________________________________ RANGE ________________________________________ - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range: - get: - summary: Gets the range. - operationId: getWorksheetRange - tags: - - range - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - '404': - description: Range of cells not found. - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range: - patch: - summary: Update the properties of range. - operationId: updateRange - tags: - - range - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Range' + - $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 + "200": + description: A collection of chart. content: application/json: schema: - $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): + $ref: '#/components/schemas/Charts' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range: get: - summary: Retrieve the properties and relationships of range. - operationId: getRangeWithAddress + summary: Gets the range. + operationId: getWorksheetRange tags: - range parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1773,44 +2169,20 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: Success. - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - patch: - summary: Update the properties of range. - operationId: updateRangeWithAddress - tags: - - range - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - responses: - '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range: get: - summary: Retrieve the properties and relationships of range. - operationId: getColumnRange + summary: Gets the range. + operationId: getWorksheetRangeWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1823,110 +2195,102 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: Success. + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Range' - patch: - summary: Update the properties of range. - operationId: updateColumnRange + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/cell(row={row},column={column}): + get: + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getWorksheetCell tags: - - range + - worksheet parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Range' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/insert: - post: - summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. - operationId: insertRange + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/cell(row={row},column={column}): + get: + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getWorksheetCellWithItemPath tags: - - range + - worksheet parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/insert: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/add: post: - summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. - operationId: insertRangeWithAddrees + summary: Creates a new chart. + operationId: addChart tags: - - range + - chart parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Shift' + $ref: '#/components/schemas/NewChart' responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/insert: + $ref: '#/components/schemas/Chart' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/add: post: - summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. - operationId: insertColumnRange + summary: Creates a new chart. + operationId: addChartWithItemPath tags: - - range + - chart parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Shift' + $ref: '#/components/schemas/NewChart' responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/format: + $ref: '#/components/schemas/Chart' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/names: get: - summary: Retrieve the properties and relationships of the range format - operationId: getRangeFormat + summary: Retrieves a list of named items associated with the worksheet. + operationId: listWorksheetNamedItem tags: - - range + - namedItem parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1939,42 +2303,20 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' - patch: - summary: Update the properties of range format. - operationId: updateRangeFormat - tags: - - range - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' - responses: - '200': - description: OK + description: OK. content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format: + $ref: '#/components/schemas/NamedItems' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/names: get: - summary: Retrieve the properties and relationships of the range format - operationId: getRangeFormatWithAddress + summary: Retrieves a list of named items associated with the worksheet. + operationId: listWorksheetNamedItemWithItemPath tags: - - range + - namedItem parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -1987,43 +2329,46 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK + description: OK. content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - patch: - summary: Update the properties of range format. - operationId: updateRangeFormatWithAddress + $ref: '#/components/schemas/NamedItems' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables: + get: + summary: Retrieves a list of the workbook pivot tables. + operationId: listPivotTables tags: - - range + - worksheet parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' + - $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 + description: OK. content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format: + $ref: '#/components/schemas/PivotTables' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables: get: - summary: Retrieve the properties and relationships of the range format - operationId: getColumnRangeFormat + summary: Retrieves a list of the workbook pivot tables. + operationId: listPivotTablesWithItemPath tags: - - range + - worksheet parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -2036,231 +2381,301 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK + description: OK. content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - patch: - summary: Update the properties of range format. - operationId: updateColumnRangeFormat + $ref: '#/components/schemas/PivotTables' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: + get: + summary: Retrieve the properties and relationships of pivot table. + operationId: getPivotTable tags: - - range + - worksheet parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' + - $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 + description: OK. content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/merge: - post: - summary: Merge the range cells into one region in the worksheet. - operationId: mergeRange + $ref: '#/components/schemas/PivotTable' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}: + get: + summary: Retrieve a list of the workbook pivot table. + operationId: getPivotTableWithItemPath tags: - - range + - worksheet parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Across' + - $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/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/merge: + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/PivotTable' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/refresh: post: - summary: Merge the range cells into one region in the worksheet. - operationId: mergeRangeWithAddress + summary: Refreshes the pivot table. + operationId: refreshPivotTable tags: - - range + - worksheet parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/pivotTableId' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Across' responses: '200': - description: OK - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/merge: + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/{pivotTableId}/refresh: post: - summary: Merge the range cells into one region in the worksheet. - operationId: mergeColumnRange + summary: Refreshes the pivot table. + operationId: refreshPivotTableWithItemPath tags: - - range + - worksheet parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/pivotTableId' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Across' responses: '200': - description: OK - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/unmerge: + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/pivotTables/refreshAll: post: - summary: Unmerge the range cells into separate cells. - operationId: unmergeRange + summary: Refreshes all pivot tables within given worksheet. + operationId: refreshAllPivotTables tags: - - range + - worksheet parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/pivotTables/refreshAll: post: - summary: Unmerge the range cells into separate cells. - operationId: unmergeRangeWithAddress + summary: Refreshes all pivot tables within given worksheet. + operationId: refreshAllPivotTablesWithItemPath tags: - - range + - worksheet parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: - post: - summary: Unmerge the range cells into separate cells. - operationId: unmergeColumnRange + '200': + description: OK. + #___________________________________ RANGE ________________________________________ + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): + get: + summary: Retrieve the properties and relationships of range. + operationId: getWorksheetRangeWithAddress tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $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: - '204': - description: No Content - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/clear: - post: - summary: Clear range values such as format, fill, and border. - operationId: clearRange + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateWorksheetRangeWithAddress tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplyTo' + $ref: '#/components/schemas/Range' responses: '200': description: OK - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: - post: - summary: Clear range values such as format, fill, and border. - operationId: clearRangeWithAddress + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): + get: + summary: Retrieve the properties and relationships of range. + operationId: getWorksheetRangeWithAddressItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplyTo' + - $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/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: - post: - summary: Clear range values such as format, fill, and border. - operationId: clearColumnRange + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateWorksheetRangeWithAddressItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplyTo' + $ref: '#/components/schemas/Range' responses: '200': description: OK - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/delete: - post: - summary: Deletes the cells associated with the range. - operationId: DeleteCell + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: + get: + summary: Retrieve the properties and relationships of range. + operationId: getColumnRange tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' + - $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/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/delete: - post: - summary: Deletes the cells associated with the range. - operationId: DeleteCellWithAddress + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateColumnRange tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Shift' + $ref: '#/components/schemas/Range' responses: '200': description: OK - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/delete: - post: - summary: Deletes the cells associated with the range. - operationId: DeleteColumnCell + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: + get: + summary: Retrieve the properties and relationships of range. + operationId: getColumnRangeWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + patch: + summary: Update the properties of range. + operationId: updateColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' @@ -2268,109 +2683,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Shift' + $ref: '#/components/schemas/Range' responses: '200': description: OK -# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/boundingRect: -# get: -# summary: Gets the smallest range that encompasses the given ranges. -# operationId: getBoundingRect -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/boundingRect: -# get: -# summary: Gets the smallest range that encompasses the given ranges. -# operationId: getBoundingRectWithAddress -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/boundingRect: -# get: -# summary: Gets the smallest range that encompasses the given ranges. -# operationId: getColumnBoundingRect -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/cell(row={row},column={column}): + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{name}/range: get: - summary: Gets the range containing the single cell based on row and column numbers. - operationId: getNameRangeWithRowAndColumn + summary: Retrieve the range object that is associated with the name. + operationId: getNamedItemRange tags: - - range + - namedItem parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/cell(row={row},column={column}): - get: - summary: Gets the range object containing the single cell based on row and column numbers. - operationId: getWorkSheetRangeWithRowAndColumn + patch: + summary: Update the properties of range. + operationId: UpdateNameRange tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' responses: '200': description: OK @@ -2378,39 +2729,35 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/cell(row={row},column={column}): + /me/drive/root:/{itemPath}:/workbook/names/{name}/range: get: - summary: Gets the range object containing the single cell based on row and column numbers. - operationId: getRangeWithRowColumnAddress - tags: - - worksheet + summary: Retrieve the range object that is associated with the name. + operationId: getNamedItemRangeWithItemPath parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/cell(row={row},column={column}): - get: - summary: Gets the range object containing the single cell based on row and column numbers. - operationId: getColumnRangeWithRowAndColumn + patch: + summary: Update the properties of range. + operationId: UpdateNameRangeWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Range' responses: '200': description: OK @@ -2418,15 +2765,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/column(column={column}): + /me/drive/items/{itemId}/workbook/names/{name}/range/cell(row={row},column={column}): get: - summary: Gets a column contained in the range. - operationId: getRangeColumn + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getNameRangeCell tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/row' - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: @@ -2436,18 +2784,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - '404': - description: Cell not found. - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/column(column={column}): + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/cell(row={row},column={column}): get: - summary: Gets a column contained in the range - operationId: getRangeColumnWithAddress + summary: Gets the range containing the single cell based on row and column numbers. + operationId: getNameRangeCellWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/row' - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: @@ -2457,16 +2803,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/column(column={column}): + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/cell(row={row},column={column}): get: - summary: Gets a column contained in the range - operationId: getColumnRangeColumn + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getWorksheetRangeCell tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: @@ -2476,17 +2822,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/cell(row={row},column={column}): get: - summary: Gets a certain number of columns to the right of the given range. - operationId: getCloumAfterRange + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getWorksheetRangeCellWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' - responses: '200': description: OK @@ -2494,18 +2841,19 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter(count={columnCount}): + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/cell(row={row},column={column}): get: - summary: Gets a certain number of columns to the right of the given range. - operationId: getCloumAfterRangeWithCount + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getWorksheetRangeCellWithAddress tags: - - range + - worksheet parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' - responses: '200': description: OK @@ -2513,17 +2861,19 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/cell(row={row},column={column}): get: - summary: Gets a certain number of columns to the left of the given range. - operationId: getCloumBeforeRange + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getWorksheetRangeCellWithAddressItemPath tags: - - range + - worksheet parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' - responses: '200': description: OK @@ -2531,18 +2881,19 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore(count={columnCount}): + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/cell(row={row},column={column}): get: - summary: Gets a certain number of columns to the left of the given range. - operationId: getCloumBeforeRangeWithCount + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getColumnRangeCell tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' - responses: '200': description: OK @@ -2550,15 +2901,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/entireColumn: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/cell(row={row},column={column}): get: - summary: Gets the range that represents the entire column of the range. - operationId: getEntireColumnRange + summary: Gets the range object containing the single cell based on row and column numbers. + operationId: getColumnRangeCellWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/row' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2567,87 +2921,95 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireColumn: + /me/drive/items/{itemId}/workbook/names/{name}/range/column(column={column}): get: - summary: Gets the range that represents the entire column of the range - operationId: getEntireColumnRangeWithAddress + summary: Gets a column contained in the range. + operationId: getNameRangeColumn tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireColumn: + '404': + description: Cell not found. + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/column(column={column}): get: - summary: Gets the range that represents the entire column of the range - operationId: getColumnEntireColumnRange + summary: Gets a column contained in the range. + operationId: getNameRangeColumnWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/entireRow: + '404': + description: Cell not found. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/column(column={column}): get: - summary: Gets the range that represents the entire row of the range - operationId: getEntireRowRange + summary: Gets a column contained in the range. + operationId: getWorksheetRangeColumn tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireRow: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/column(column={column}): get: - summary: Gets the range that represents the entire row of the range - operationId: getEntireRowRangeWithAddress + summary: Gets a column contained in the range. + operationId: getWorksheetRangeColumnWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireRow: + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/column(column={column}): get: - summary: Gets the range that represents the entire row of the range - operationId: getColumnEntireRowRange + summary: Gets a column contained in the range. + operationId: getColumnRangeColumn tags: - range parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2656,83 +3018,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/intersection: -# get: -# summary: Gets the range that represents the rectangular intersection of the given ranges. -# operationId: getIntersectionRange -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/intersection: -# get: -# summary: Gets the range object that represents the rectangular intersection of the given ranges. -# operationId: getIntersectionRangeWithAddress -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/intersection: -# get: -# summary: Gets the range object that represents the rectangular intersection of the given ranges -# operationId: getColumnIntersectionRange -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/lastCell: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/column(column={column}): get: - summary: Gets the last cell within the range. - operationId: getLastCell + summary: Gets a column contained in the range. + operationId: getColumnRangeColumnWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/column' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2741,16 +3037,15 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastCell: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter: get: - summary: Gets the last cell within the range. - operationId: getLastCellWithAddress + summary: Gets a certain number of columns to the right of the given range. + operationId: getWorksheetColumnsAfterRange tags: - range parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2759,16 +3054,15 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastCell: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter: get: - summary: Gets the last cell within the range. - operationId: getColumnLastCell + summary: Gets a certain number of columns to the right of the given range. + operationId: getWorksheetColumnsAfterRangeWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2777,15 +3071,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/lastColumn: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter(count={columnCount}): get: - summary: Gets the last column within the range - operationId: getLastColumnRange + summary: Gets a certain number of columns to the right of the given range. + operationId: getWorksheetColumnsAfterRangeWithCount tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2794,16 +3089,33 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter(count={columnCount}): get: - summary: Gets the last column within the range - operationId: getLastColumnRangeWithAddress + summary: Gets a certain number of columns to the right of the given range. + operationId: getWorksheetColumnsAfterRangeWithCountItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore: + get: + summary: Gets a certain number of columns to the left of the given range. + operationId: getWorksheetColumnsBeforeRange tags: - range parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2812,16 +3124,33 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore: get: - summary: Gets the last column within the range - operationId: getColumnLastColumnRange + summary: Gets a certain number of columns to the left of the given range. + operationId: getWorksheetColumnsBeforeRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore(count={columnCount}): + get: + summary: Gets a certain number of columns to the left of the given range. + operationId: getWorksheetColumnsBeforeRangeWithCount tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2830,15 +3159,33 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/lastRow: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore(count={columnCount}): get: - summary: Gets the last row within the range. - operationId: getLastRowRange + summary: Gets a certain number of columns to the left of the given range. + operationId: getWorksheetColumnsBeforeRangeWithCountItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{name}/range/entireColumn: + get: + summary: Gets the range that represents the entire column of the range. + operationId: getNameRangeEntireColumn tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -2847,10 +3194,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastRow: + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/entireColumn: get: - summary: Gets the last row within the range. - operationId: getLastRowRangeWithAddress + summary: Gets the range that represents the entire column of the range. + operationId: getNameRangeEntireColumnWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getWorksheetRangeEntireColumn tags: - range parameters: @@ -2860,15 +3224,33 @@ paths: - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastRow: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireColumn: get: - summary: Gets the last row within the range. - operationId: getColumnLastRowRange + summary: Gets the range that represents the entire column of the range + operationId: getWorksheetRangeEntireColumnWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getColumnRangeEntireColumn tags: - range parameters: @@ -2878,247 +3260,109 @@ paths: - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/offsetRange: -# get: -# summary: Gets an object that represents a range that's offset from the specified range. -# operationId: getOffsetRange -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/OffsetRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/offsetRange: -# get: -# summary: Gets an object that represents a range that's offset from the specified range. -# operationId: getOffsetRangeWithAddress -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/OffsetRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/offsetRange: -# get: -# summary: Gets an object that represents a range that's offset from the specified range. -# operationId: getColumnOffsetRange -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/OffsetRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/row: -# get: -# summary: Gets a row contained in the range. -# operationId: getRowRange -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Row' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/row: -# get: -# summary: Gets a row contained in the range. -# operationId: getRowRangeWithAddress -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Row' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/row: -# get: -# summary: Gets a row contained in the range. -# operationId: getColumnRowRange -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemId' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Row' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireColumn: get: - summary: Gets a certain number of rows above a given range. - operationId: getRowsAboveRange + summary: Gets the range that represents the entire column of the range + operationId: getColumnRangeEntireColumnWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove(count={rowCount}): + /me/drive/items/{itemId}/workbook/names/{name}/range/entireRow: get: - summary: Gets a certain number of rows above a given range. - operationId: getRowsAboveRangeWithCount + summary: Gets the range that represents the entire row of the range + operationId: getNameRangeEntireRow tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow: + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/entireRow: get: - summary: Gets a certain number of columns to the left of the given range - operationId: getRowsBelowRange + summary: Gets the range that represents the entire row of the range + operationId: getNameRangeEntireRowWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow(count={rowCount}): + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireRow: get: - summary: Gets a certain number of columns to the left of the given range - operationId: getRowsBelowRangeWithCount + summary: Gets the range that represents the entire row of the range + operationId: getWorksheetRangeEntireRow tags: - range parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/names/{namedItemName}/range/usedRange(valuesOnly={valuesOnly}): + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/entireRow: get: - summary: Get the used range of the given range. - operationId: getUsedRangeWithValuesOnly + summary: Gets the range that represents the entire row of the range + operationId: getWorksheetRangeEntireRowWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/usedRange(valuesOnly={valuesOnly}): + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireRow: get: - summary: Get the used range of the given range. - operationId: getUsedRangeWithAddress + summary: Gets the range that represents the entire row of the range + operationId: getColumnRangeEntireRow tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3127,17 +3371,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/usedRange(valuesOnly={valuesOnly}): + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/entireRow: get: - summary: Get the used range of the given range. - operationId: getColumnUsedRange + summary: Gets the range that represents the entire row of the range + operationId: getColumnRangeEntireRowWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3146,17 +3389,15 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/resizedRange(deltaRows={deltaRows}, deltaColumns={deltaColumns}): - post: - summary: Get the resized range of a range. - operationId: getResizedRange + /me/drive/items/{itemId}/workbook/names/{name}/range/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getNameRangeLastCell tags: - range parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/deltaRows' - - $ref: '#/components/parameters/deltaColumns' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3164,18 +3405,16 @@ paths: content: application/json: schema: - type: object $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/lastCell: get: - summary: Get the range visible from a filtered range - operationId: getVisibleView + summary: Gets the last cell within the range. + operationId: getNameRangeLastCellWithItemPath tags: - range parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3183,41 +3422,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RangeView' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastCell: get: - summary: Gets the range. - operationId: getWorksheetRangeWithItemPath + summary: Gets the last cell within the range. + operationId: getWorksheetRangeLastCell tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - '404': - description: Range of cells not found. - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range: - patch: - summary: Update the properties of range. - operationId: updateWorkbookRangeWithItemPath + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getWorksheetRangeLastCellWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Range' responses: '200': description: OK @@ -3225,48 +3459,35 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}'): + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastCell: get: - summary: Retrieve the properties and relationships of range. - operationId: getRangeWithAddressItemPath + summary: Gets the last cell within the range. + operationId: getColumnRangeLastCell tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $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: Success. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - patch: - summary: Update the properties of range. - operationId: updateRangeWithAddressItemPath + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastCell: + get: + summary: Gets the last cell within the range. + operationId: getColumnRangeLastCellWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Range' responses: '200': description: OK @@ -3274,49 +3495,33 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range: + /me/drive/items/{itemId}/workbook/names/{name}/range/lastColumn: get: - summary: Retrieve the properties and relationships of range. - operationId: getColumnRangeWithItemPath + summary: Gets the last column within the range. + operationId: getNameRangeLastColumn tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' - $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: Success. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - patch: - summary: Update the properties of range. - operationId: updateColumnRangeWithItemPath + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/lastColumn: + get: + summary: Gets the last column within the range. + operationId: getNameRangeLastColumnWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Range' responses: '200': description: OK @@ -3324,21 +3529,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/insert: - post: - summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. - operationId: insertRangeWithItemPath + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: + get: + summary: Gets the last column within the range. + operationId: getWorksheetRangeLastColumn tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' responses: '200': description: OK @@ -3346,10 +3547,10 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/insert: - post: - summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. - operationId: insertRangeWithAddreesItemPath + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: + get: + summary: Gets the last column within the range + operationId: getWorksheetRangeLastColumnWithItemPath tags: - range parameters: @@ -3357,11 +3558,6 @@ paths: - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' responses: '200': description: OK @@ -3369,22 +3565,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/insert: - post: - summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. - operationId: insertColumnRangeWithItemPath + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: + get: + summary: Gets the last column within the range + operationId: getColumnRangeLastColumn tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' responses: '200': description: OK @@ -3392,439 +3583,246 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/format: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: get: - summary: Retrieve the properties and relationships of the range format - operationId: getRangeFormatWithItemPath + summary: Gets the last column within the range + operationId: getColumnRangeLastColumnWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $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/RangeFormat' - patch: - summary: Update the properties of range format. - operationId: updateRangeFormatWithItemPath + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/names/{name}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getNameRangeLastRow tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/lastRow: get: - summary: Retrieve the properties and relationships of the range format - operationId: getRangeFormatWithAddressItemPath + summary: Gets the last row within the range. + operationId: getNameRangeLastRowWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/name' - $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/RangeFormat' - patch: - summary: Update the properties of range format. - operationId: updateRangeFormatWithAddressItemPath + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastRow: + get: + summary: Gets the last row within the range. + operationId: getWorksheetRangeLastRow tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastRow: get: - summary: Retrieve the properties and relationships of the range format - operationId: getColumnRangeFormatWithItemPath + summary: Gets the last row within the range. + operationId: getWorksheetRangeLastRowWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $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/RangeFormat' - patch: - summary: Update the properties of range format. - operationId: updateColumnRangeFormatWithItemPath + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getColumnRangeLastRow tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RangeFormat' responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/RangeFormat' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/merge: - post: - summary: Merge the range cells into one region in the worksheet. - operationId: mergeRangeWithItemPath + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastRow: + get: + summary: Gets the last row within the range. + operationId: getColumnRangeLastRowWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Across' responses: '200': 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. - operationId: mergeRangeWithAddressItemPath + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove: + get: + summary: Gets a certain number of rows above a given range. + operationId: getWorksheetRowsAboveRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Across' + responses: '200': 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. - operationId: mergeColumnRangeWithItemPath + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove: + get: + summary: Gets a certain number of rows above a given range. + operationId: getWorksheetRowsAboveRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Across' + responses: '200': description: OK - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/unmerge: - post: - summary: Unmerge the range cells into separate cells. - operationId: unmergeRangeWithItemPath + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove(count={rowCount}): + get: + summary: Gets a certain number of rows above a given range. + operationId: getWorksheetRowsAboveRangeWithCount tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/rowCount' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: - post: - summary: Unmerge the range cells into separate cells. - operationId: unmergeRangeWithAddressItemPath + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove(count={rowCount}): + get: + summary: Gets a certain number of rows above a given range. + operationId: getWorksheetRowsAboveRangeWithCountItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/rowCount' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: - post: - summary: Unmerge the range cells into separate cells. - operationId: unmergeColumnRangeWithItemPath + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getWorksheetRowsBelowRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/clear: - post: - summary: Clear range values such as format, fill, and border. - operationId: clearRangeWithItemPath + '200': + description: OK + content: + application/json: + schema: + $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 + operationId: getWorksheetRowsBelowRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplyTo' - responses: - '200': - description: OK - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: - post: - summary: Clear range values such as format, fill, and border. - operationId: clearRangeWithAddressItemPath - tags: - - range - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplyTo' - responses: - '200': - description: OK - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: - post: - summary: Clear range values such as format, fill, and border. - operationId: clearColumnRangeWithItemPath - tags: - - range - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApplyTo' - responses: - '200': - description: OK - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/delete: - post: - summary: Deletes the cells associated with the range. - operationId: DeleteCellWithItemPath - tags: - - range - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - responses: - '200': - description: OK - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/delete: - post: - summary: Deletes the cells associated with the range. - operationId: DeleteCellWithAddressItemPath - tags: - - range - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - responses: - '200': - description: OK - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/delete: - post: - summary: Deletes the cells associated with the range. - operationId: DeleteColumnCellWithItemPath - tags: - - range - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' responses: '200': description: OK -# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/boundingRect: -# get: -# summary: Gets the smallest range that encompasses the given ranges. -# operationId: getBoundingRectWithItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/boundingRect: -# get: -# summary: Gets the smallest range that encompasses the given ranges. -# operationId: getBoundingRectWithAddressItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/boundingRect: -# get: -# summary: Gets the smallest range that encompasses the given ranges. -# operationId: getColumnBoundingRectWithItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/AnotherRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/cell(row={row},column={column}): + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow(count={rowCount}): get: - summary: Gets the range containing the single cell based on row and column numbers. - operationId: getNamedItemRangeWithRowColumnItemPath + summary: Gets a certain number of columns to the left of the given range + operationId: getWorksheetRowsBelowRangeWithCount tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/rowCount' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3833,17 +3831,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/cell(row={row},column={column}): + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsBelow(count={rowCount}): get: - summary: Gets the range object containing the single cell based on row and column numbers. - operationId: getWorkSheetRangeWithRowAndColumnItemPath + summary: Gets a certain number of columns to the left of the given range + operationId: getWorksheetRowsBelowRangeWithCountItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/rowCount' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3852,18 +3849,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/cell(row={row},column={column}): + /me/drive/items/{itemId}/workbook/names/{name}/range/usedRange(valuesOnly={valuesOnly}): get: - summary: Gets the range object containing the single cell based on row and column numbers. - operationId: getRangeWithRowColumnAddressItemPath + summary: Get the used range of the given range. + operationId: getNameUsedRange tags: - - worksheet + - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3872,18 +3867,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/cell(row={row},column={column}): + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/usedRange(valuesOnly={valuesOnly}): get: - summary: Gets the range object containing the single cell based on row and column numbers. - operationId: getRangeWithRowAndColumnItemPath + summary: Get the used range of the given range. + operationId: getNameUsedRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/row' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3892,16 +3885,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/column(column={column}): + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/usedRange(valuesOnly={valuesOnly}): get: - summary: Gets a column contained in the range. - operationId: getRangeColumnWithItemPath + summary: Get the used range of the worksheet with in the given range. + operationId: getWorksheetUsedRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3910,19 +3904,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - '404': - description: Cell not found. - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/column(column={column}): + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/usedRange(valuesOnly={valuesOnly}): get: - summary: Gets a column contained in the range - operationId: getRangeColumnWithAddressItemPath + summary: Get the used range of the worksheet with in the given range. + operationId: getWorksheetUsedRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3931,17 +3923,17 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/column(column={column}): + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/usedRange(valuesOnly={valuesOnly}): get: - summary: Gets a column contained in the range - operationId: getColumnRangeColumnWithItemPath + summary: Get the used range of the given range. + operationId: getColumnUsedRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/column' + - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -3950,17 +3942,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/usedRange(valuesOnly={valuesOnly}): get: - summary: Gets a certain number of columns to the right of the given range. - operationId: getCloumAfterRangeWithItemPath + summary: Get the used range of the given range. + operationId: getColumnUsedRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' - responses: '200': description: OK @@ -3968,136 +3961,301 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsAfter(count={columnCount}): - get: - summary: Gets a certain number of columns to the right of the given range. - operationId: getCloumAfterRangeWithCountItemPath + /me/drive/items/{itemId}/workbook/names/{name}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearNameRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' - + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore: - get: - summary: Gets a certain number of columns to the left of the given range. - operationId: getCloumBeforeRangeWithItemPath + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearNameRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' - - responses: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/columnsBefore(count={columnCount}): - get: - summary: Gets a certain number of columns to the left of the given range. - operationId: getCloumBeforeRangeWithCountItemPath + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearWorksheetRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearWorksheetRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/columnCount' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' - + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/entireColumn: - get: - summary: Gets the range that represents the entire column of the range. - operationId: getEntireColumnRangeWithItemPath + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/clear: + post: + summary: Clear range values such as format, fill, and border. + operationId: clearColumnRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyTo' responses: '200': description: OK - content: - application/json: - schema: - $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 - operationId: getEntireColumnRangeWithAddressItemPath + /me/drive/items/{itemId}/workbook/names/{name}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteNameRangeCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteNameRangeCellWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteWorksheetRangeCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' responses: '200': - description: OK. + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteWorksheetRangeCellWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteColumnRangeCell + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/delete: + post: + summary: Deletes the cells associated with the range. + operationId: DeleteColumnRangeCellWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/names/{name}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertNameRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK content: application/json: schema: $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 - operationId: getColumnEntireColumnRangeWithItemPath + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertNameRangeWithItemPath tags: - range parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/entireRow: - get: - summary: Gets the range that represents the entire row of the range - operationId: getEntireRowRangeWithItemPath + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertWorksheetRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' responses: '200': - description: OK. + description: OK content: application/json: schema: $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 - operationId: getEntireRowRangeWithAddressItemPath + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertWorksheetRangeWithItemPath tags: - range parameters: @@ -4105,24 +4263,34 @@ paths: - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' responses: '200': - description: OK. + description: OK content: application/json: schema: $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 - operationId: getColumnEntireRowRangeWithItemPath + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertColumnRange tags: - range parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' responses: '200': description: OK @@ -4130,21 +4298,1647 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/intersection: -# get: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/insert: + post: + summary: Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. + operationId: insertColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: mergeNameRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/merge: + post: + summary: Merge the range cells into one region in the worksheet. + operationId: mergeNameRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeWorksheetRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeWorksheetRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + 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. + operationId: mergeColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Across' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/names/{name}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeNameRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeNameRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeWorksheetRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeWorksheetRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeColumnRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/unmerge: + post: + summary: Unmerge the range cells into separate cells. + operationId: unmergeColumnRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: + get: + summary: Get the range visible from a filtered range. + operationId: getVisibleView + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getVisibleViewWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeView' + /me/drive/items/{itemId}/workbook/names/{name}/range/sort/apply: + post: + summary: Perform a sort operation. + operationId: performNameRangeSort + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeSort' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/sort/apply: + post: + summary: Perform a sort operation. + operationId: performNameRangeSortWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeSort' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/sort/apply: + post: + summary: Perform a sort operation. + operationId: performWorksheetRangeSort + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeSort' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/sort/apply: + post: + summary: Perform a sort operation. + operationId: performWorksheetRangeSortWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeSort' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/sort/apply: + post: + summary: Perform a sort operation. + operationId: performColumnRangeSort + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeSort' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/sort/apply: + post: + summary: Perform a sort operation. + operationId: performColumnRangeSortWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeSort' + responses: + '204': + description: No Content + /me/drive/items/{itemId}/workbook/names/{name}/range/format: + get: + summary: Retrieve the properties and relationships of the range format. + operationId: getNameRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateNameRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/format: + get: + summary: Retrieve the properties and relationships of the range format. + operationId: getNameRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateNameRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getWorksheetRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateWorksheetRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getWorksheetRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateWorksheetRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getColumnRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateColumnRangeFormat + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $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. + operationId: getColumnRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/RangeFormat' + patch: + summary: Update the properties of range format. + operationId: updateColumnRangeFormatWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RangeFormat' + /me/drive/items/{itemId}/workbook/names/{name}/range/format/borders: + post: + summary: Create a new range border. + operationId: createNameRangeBorder + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + get: + summary: Retrieves a list of range borders. + operationId: listNameRangeBorders + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $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/RangeBorders' + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/format/borders: + post: + summary: Create a new range border. + operationId: createNameRangeBorderWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + get: + summary: Retrieves a list of range borders. + operationId: listNameRangeBordersWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $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/RangeBorders' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/borders: + post: + summary: Create a new range border. + operationId: createWorksheetRangeBorder + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + get: + summary: Retrieves a list of range borders. + operationId: listWorksheetRangeBorders + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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/RangeBorders' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/borders: + post: + summary: Create a new range border. + operationId: createWorksheetRangeBorderWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + get: + summary: Retrieves a list of range borders. + operationId: listWorksheetRangeBordersWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $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/RangeBorders' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/borders: + post: + summary: Create a new range border. + operationId: createColumnRangeBorder + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + get: + summary: Retrieves a list of range borders. + operationId: listColumnRangeBorders + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/RangeBorders' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/borders: + post: + summary: Create a new range border. + operationId: createColumnRangeBorderWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RangeBorder' + get: + summary: Retrieves a list of range borders. + operationId: listColumnRangeBordersWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/RangeBorders' + /me/drive/items/{itemId}/workbook/names/{name}/range/format/autofitColumns: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitNameRangeColumns + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/format/borders/autofitColumns: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitNameRangeColumnsWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/autofitColumns: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitWorksheetRangeColumns + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/autofitColumns: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitWorksheetRangeColumnsWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/autofitColumns: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitColumnRangeColumns + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/autofitColumns: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitColumnRangeColumnsWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/names/{name}/range/format/autofitRows: + post: + summary: Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitNameRangeRows + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/names/{name}/range/format/borders/autofitRows: + post: + summary: Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitNameRangeRowsWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/autofitRows: + post: + summary: Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitWorksheetRangeRows + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/format/autofitRows: + post: + summary: Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitWorksheetRangeRowsWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/autofitRows: + post: + summary: Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitColumnRangeRows + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/format/autofitRows: + post: + summary: Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + operationId: autofitColumnRangeRowsWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range/resizedRange(deltaRows={deltaRows}, deltaColumns={deltaColumns}): + post: + summary: Get the resized range of a range. + operationId: getResizedRange + tags: + - range + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/deltaRows' + - $ref: '#/components/parameters/deltaColumns' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + $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. + operationId: getResizedRangeWithItemPath + tags: + - range + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/deltaRows' + - $ref: '#/components/parameters/deltaColumns' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{name}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getNameRangeBoundingRect +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getRangeBoundingRectWithAddress +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getColumnRangeBoundingRect +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/names/{name}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getNameRangeBoundingRectWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getRangeBoundingRectWithAddressItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/boundingRect: +# get: +# summary: Gets the smallest range that encompasses the given ranges. +# operationId: getColumnRangeBoundingRectWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{name}/range/intersection: +# get: +# summary: Gets the range that represents the rectangular intersection of the given ranges. +# operationId: getNameRangeIntersection +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges. +# operationId: getRangeIntersection +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges +# operationId: getColumnRangeIntersection +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# +# /me/drive/root:/{itemPath}:/workbook/names/{name}/range/intersection: +# get: # summary: Gets the range that represents the rectangular intersection of the given ranges. -# operationId: getIntersectionRangeWithItemPath +# operationId: getNameRangeIntersectionWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges. +# operationId: getRangeIntersectionWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/intersection: +# get: +# summary: Gets the range object that represents the rectangular intersection of the given ranges +# operationId: getColumnRangeIntersectionWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/AnotherRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{name}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getNameRangeOffsetRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getRangeOffsetRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getColumnRangeOffsetRange +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/names/{name}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getNameRangeOffsetRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getRangeOffsetRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/offsetRange: +# get: +# summary: Gets an object that represents a range that's offset from the specified range. +# operationId: getColumnRangeOffsetRangeWithItemPath +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemPath' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/OffsetRange' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/names/{name}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getNameRangeRow +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/name' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getRangeRow +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/worksheetIdOrName' +# - $ref: '#/components/parameters/address' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getColumnRangeRow +# tags: +# - range +# parameters: +# - $ref: '#/components/parameters/itemId' +# - $ref: '#/components/parameters/tableIdOrName' +# - $ref: '#/components/parameters/columnIdOrName' +# - $ref: '#/components/parameters/sessionId' +# requestBody: +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Row' +# responses: +# '200': +# description: OK +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/Range' +# /me/drive/root:/{itemPath}:/workbook/names/{name}/range/row: +# get: +# summary: Gets a row contained in the range. +# operationId: getNameRangeRowWithItemPath # tags: # - range # parameters: # - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/namedItemName' +# - $ref: '#/components/parameters/name' # - $ref: '#/components/parameters/sessionId' # requestBody: # content: # application/json: # schema: -# $ref: '#/components/schemas/AnotherRange' +# $ref: '#/components/schemas/Row' # responses: # '200': # description: OK @@ -4152,10 +5946,10 @@ paths: # application/json: # schema: # $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/intersection: +# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/row: # get: -# summary: Gets the range object that represents the rectangular intersection of the given ranges. -# operationId: getIntersectionRangeWithAddressItemPath +# summary: Gets a row contained in the range. +# operationId: getRangeRowWithAddressItemPath # tags: # - range # parameters: @@ -4167,7 +5961,7 @@ paths: # content: # application/json: # schema: -# $ref: '#/components/schemas/AnotherRange' +# $ref: '#/components/schemas/Row' # responses: # '200': # description: OK @@ -4175,10 +5969,10 @@ paths: # application/json: # schema: # $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/intersection: +# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/row: # get: -# summary: Gets the range object that represents the rectangular intersection of the given ranges -# operationId: getColumnIntersectionRangeWithItemPath +# summary: Gets a row contained in the range. +# operationId: getColumnRangeRowWithItemPath # tags: # - range # parameters: @@ -4190,7 +5984,7 @@ paths: # content: # application/json: # schema: -# $ref: '#/components/schemas/AnotherRange' +# $ref: '#/components/schemas/Row' # responses: # '200': # description: OK @@ -4198,33 +5992,281 @@ paths: # application/json: # schema: # $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/lastCell: + #___________________________________ TABLES ________________________________________ + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the workbook. + description: Update the properties of table + operationId: updateWorkbookTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the workbook. + operationId: deleteWorkbookTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK get: - summary: Gets the last cell within the range. - operationId: getLastCellWithItemPath + summary: Retrieve the properties and relationships of table. + operationId: getWorkbookTable + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the workbook. + description: Update the properties of table + operationId: updateWorkbookTableWithItemPath tags: - - range + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the workbook. + operationId: deleteWorkbookTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + get: + summary: Retrieve the properties and relationships of table. + operationId: getWorkbookTableWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the worksheet. + operationId: updateWorksheetTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the worksheet. + operationId: deleteWorksheetTable + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + get: + summary: Retrieve the properties and relationships of table. + operationId: getWorksheetTable + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: + patch: + summary: Update the properties of table in the worksheet. + operationId: updateWorksheetTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + delete: + summary: Deletes the table from the worksheet. + operationId: deleteWorksheetTableWithItemPath + tags: + - tables + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + get: + summary: Retrieve the properties and relationships of table. + operationId: getWorksheetTableWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $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/Table' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/dataBodyRange: + get: + summary: Gets the range associated with the data body of the table. + operationId: getWorkbookTableBodyRange + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/dataBodyRange: + get: + summary: Gets the range associated with the data body of the table. + operationId: getWorkbookTableBodyRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastCell: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/dataBodyRange: get: - summary: Gets the last cell within the range. - operationId: getLastCellWithAddressItemPath - tags: - - range + summary: Gets the range associated with the data body of the table. + operationId: getWorksheetTableBodyRange parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4233,16 +6275,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastCell: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/dataBodyRange: get: - summary: Gets the last cell within the range. - operationId: getColumnLastCellWithItemPath - tags: - - range + summary: Gets the range associated with the data body of the table. + operationId: getWorksheetTableBodyRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4251,33 +6291,44 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/lastColumn: + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/headerRowRange: get: - summary: Gets the last column within the range - operationId: getLastColumnRangeWithItemPath - tags: - - range + summary: Gets the range associated with header row of the table. + operationId: getWorkbookTableHeaderRowRange parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastColumn: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/headerRowRange: get: - summary: Gets the last column within the range - operationId: getLastColumnRangeWithAddressItemPath - tags: - - range + summary: Gets the range associated with header row of the table. + operationId: getWorkbookTableHeaderRowRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/headerRowRange: + get: + summary: Gets the range associated with header row of the table. + operationId: getWorksheetTableHeaderRowRange + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4286,16 +6337,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastColumn: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/headerRowRange: get: - summary: Gets the last column within the range - operationId: getColumnLastColumnRangeWithItemPath - tags: - - range + summary: Gets the range associated with header row of the table. + operationId: getWorksheetTableHeaderRowRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4304,33 +6353,44 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/lastRow: + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/range: get: - summary: Gets the last row within the range. - operationId: getLastRowRangeWithItemPath - tags: - - range + summary: Get the range associated with the entire table. + operationId: getWorkbookTableRange parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/lastRow: + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/range: get: - summary: Gets the last row within the range. - operationId: getLastRowRangeWithAddressItemPath - tags: - - range + summary: Get the range associated with the entire table. + operationId: getWorkbookTableRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: + get: + summary: Get the range associated with the entire table. + operationId: getWorksheetTableRange + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4339,16 +6399,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/lastRow: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: get: - summary: Gets the last row within the range. - operationId: getColumnLastRowRangeWithItemPath - tags: - - range + summary: Get the range associated with the entire table. + operationId: getWorksheetTableRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4357,153 +6415,46 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/offsetRange: -# get: -# summary: Gets an object that represents a range that's offset from the specified range. -# operationId: getOffsetRangeWithItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/OffsetRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/offsetRange: -# get: -# summary: Gets an object that represents a range that's offset from the specified range. -# operationId: getOffsetRangeWithAddressItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/OffsetRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/offsetRange: -# get: -# summary: Gets an object that represents a range that's offset from the specified range. -# operationId: getColumnOffsetRangeWithItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/OffsetRange' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/row: -# get: -# summary: Gets a row contained in the range. -# operationId: getRowRangeWithItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/namedItemName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Row' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/row: -# get: -# summary: Gets a row contained in the range. -# operationId: getRowRangeWithAddressItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/worksheetIdOrName' -# - $ref: '#/components/parameters/address' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Row' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' -# /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/range/row: -# get: -# summary: Gets a row contained in the range. -# operationId: getColumnRowRangeWithItemPath -# tags: -# - range -# parameters: -# - $ref: '#/components/parameters/itemPath' -# - $ref: '#/components/parameters/tableIdOrName' -# - $ref: '#/components/parameters/columnIdOrName' -# - $ref: '#/components/parameters/sessionId' -# requestBody: -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Row' -# responses: -# '200': -# description: OK -# content: -# application/json: -# schema: -# $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove: + + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/totalRowRange: get: - summary: Gets a certain number of rows above a given range. - operationId: getRowsAboveRangeWithItemPath - tags: - - range + summary: Gets the range associated with totals row of the table. + operationId: getWorkbookTableTotalRowRange + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/totalRowRange: + get: + summary: Gets the range associated with totals row of the table. + operationId: getWorkbookTableTotalRowRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/totalRowRange: + get: + summary: Gets the range associated with totals row of the table. + operationId: getWorksheetTableTotalRowRange + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - responses: '200': description: OK @@ -4511,16 +6462,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/rowsAbove(count={rowCount}): + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/totalRowRange: get: - summary: Gets a certain number of rows above a given range. - operationId: getRowsAboveRangeWithCountItemPath - tags: - - range + summary: Gets the range associated with totals row of the table. + operationId: getWorksheetTableTotalRowRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4529,70 +6478,90 @@ paths: application/json: schema: $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 - operationId: getRowsBelowRangeWithItemPath - tags: - - range + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/clearFilters: + post: + summary: Clears all the filters currently applied on the table. + operationId: clearWorkbookTableFilters + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/clearFilters: + post: + summary: Clears all the filters currently applied on the table. + operationId: clearWorkbookTableFiltersWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/clearFilters: + post: + summary: Clears all the filters currently applied on the table. + operationId: clearWorksheetTableFilters + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': description: OK - content: - application/json: - schema: - $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 - operationId: getRowsBelowRangeWithCountItemPath - tags: - - range + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/clearFilters: + post: + summary: Clears all the filters currently applied on the table. + operationId: clearWorksheetTableFiltersWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/rowCount' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': description: OK + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/convertToRange: + post: + summary: Converts the table into a normal range of cells. All data is preserved. + operationId: convertWorkbookTableToRange + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names/{namedItemName}/range/usedRange(valuesOnly={valuesOnly}): - get: - summary: Get the used range of the given range. - operationId: getUsedRangeWithItemPath - tags: - - range + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/convertToRange: + post: + summary: Converts the table into a normal range of cells. All data is preserved. + operationId: convertWorkbookTableToRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/namedItemName' - - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': - description: OK + description: OK. content: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/usedRange(valuesOnly={valuesOnly}): - get: - summary: Get the used range of the given range. - operationId: getUsedRangeWithAddressItemPath - tags: - - range + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/convertToRange: + post: + summary: Converts the table into a normal range of cells. All data is preserved. + operationId: convertWorksheetTableToRange parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' - - $ref: '#/components/parameters/valuesOnly' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4601,17 +6570,14 @@ paths: application/json: schema: $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. - operationId: getColumnUsedRangeWithItemPath - tags: - - range + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/convertToRange: + post: + summary: Converts the table into a normal range of cells. All data is preserved. + operationId: convertWorksheetTableToRangeWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/columnIdOrName' - - $ref: '#/components/parameters/valuesOnly' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -4620,53 +6586,61 @@ paths: application/json: schema: $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range/resizedRange(deltaRows={deltaRows}, deltaColumns={deltaColumns}): + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/reapplyFilters: post: - summary: Get the resized range of a range. - operationId: getResizedRangeWithItemPath - tags: - - range + summary: Reapplies all the filters currently on the table. + operationId: reapplyWorkbookTableFilters + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/reapplyFilters: + post: + summary: Reapplies all the filters currently on the table. + operationId: reapplyWorkbookTableFiltersWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/reapplyFilters: + post: + summary: Reapplies all the filters currently on the table. + operationId: reapplyWorksheetTableFilters + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/deltaRows' - - $ref: '#/components/parameters/deltaColumns' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': description: OK - content: - application/json: - schema: - type: object - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/range(address='{address}')/visibleView: - get: - summary: Get the range visible from a filtered range - operationId: getVisibleViewWithItemPath - tags: - - range + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/reapplyFilters: + post: + summary: Reapplies all the filters currently on the table. + operationId: reapplyWorksheetTableFiltersWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/address' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/RangeView' - #___________________________________ TABLES ________________________________________ - /me/drive/items/{itemId}/workbook/tables: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables: get: - summary: Retrieve a list of table in the workbook. - operationId: ListWorkbookTables + summary: Retrieve a list of table in the worksheet. + operationId: listWorksheetTables tags: - tables parameters: - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -4684,14 +6658,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Tables' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables: get: summary: Retrieve a list of table in the worksheet. - operationId: listTables + operationId: listWorksheetTablesWithItemPath tags: - tables parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' @@ -4713,7 +6687,7 @@ paths: /me/drive/items/{itemId}/workbook/tables/add: post: summary: Create a new table in the workbook - operationId: createWorkbookTable + operationId: addWorkbookTable tags: - tables parameters: @@ -4723,7 +6697,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateTablePayload' + $ref: '#/components/schemas/NewTable' responses: '200': description: OK @@ -4731,21 +6705,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Table' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/add: + /me/drive/root:/{itemPath}:/workbook/tables/add: post: - summary: Create a new table in the worksheet. - operationId: createTable + summary: Create a new table in the workbook + operationId: addWorkbookTableWithItemPath tags: - tables parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTablePayload' + $ref: '#/components/schemas/NewTable' responses: '200': description: OK @@ -4753,47 +6726,85 @@ paths: application/json: schema: $ref: '#/components/schemas/Table' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}: - patch: - summary: Update the properties of table in the workbook. - description: Update the properties of table - operationId: updateWorkbookTable - tags: - - tables + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/sort: + get: + summary: Retrieve the properties and relationships of table sort. + operationId: getWorkbookTableSort parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Table' + - $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 + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Table' - delete: - summary: Deletes the table from the workbook. - operationId: deleteWorkbookTable - tags: - - tables + $ref: '#/components/schemas/TableSort' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/sort: + get: + summary: Retrieve the properties and relationships of table sort. + operationId: getWorkbookTableSortWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $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/TableSort' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort: + get: + summary: Retrieve the properties and relationships of table sort. + operationId: getWorksheetTableSort parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $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/TableSort' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort: get: - summary: Retrieve the properties and relationships of table. - operationId: getWorkbookTable + summary: Retrieve the properties and relationships of table sort. + operationId: getWorksheetTableSortWithItemPath parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' @@ -4806,53 +6817,119 @@ paths: - $ref: '#/components/parameters/select' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/top' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/TableSort' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/sort/apply: + post: + summary: Perform a sort operation to the table. + operationId: performWorkbookTableSort + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/sort/apply: + post: + summary: Perform a sort operation to the table. + operationId: performWorkbookTableSortWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/apply: + post: + summary: Perform a sort operation to the table. + operationId: performWorksheetTableSort + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TableSort' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/apply: + post: + summary: Perform a sort operation to the table. + operationId: performWorksheetTableSortWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TableSort' + responses: + '200': + description: OK + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/sort/clear: + post: + summary: Clears the sorting that is currently on the table. + operationId: clearWorkbookTableSort + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/sort/clear: + post: + summary: Clears the sorting that is currently on the table. + operationId: clearWorkbookTableSortWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' responses: '200': description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Table' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: - patch: - summary: Update the properties of table in the worksheet - operationId: updateTable - tags: - - tables + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/clear: + post: + summary: Clears the sorting that is currently on the table. + operationId: clearWorksheetTableSort parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Table' responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Table' - delete: - summary: Deletes the table from the worksheet - operationId: deleteTable - tags: - - tables + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/clear: + post: + summary: Clears the sorting that is currently on the table. + operationId: clearWorksheetTableSortWithItemPath parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': description: OK - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/range: - get: - summary: Get the range associated with the entire table. - operationId: getWorkbookTableRange + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/sort/reapply: + post: + summary: Reapplies the current sorting parameters to the table. + operationId: reapplyWorkbookTableSort parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' @@ -4860,14 +6937,21 @@ paths: responses: '200': description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: - get: - summary: Get the range associated with the entire table. - operationId: getTableRange + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/sort/reapply: + post: + summary: Reapplies the current sorting parameters to the table. + operationId: reapplyWorkbookTableSortWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/reapply: + post: + summary: Reapplies the current sorting parameters to the table. + operationId: reapplyWorksheetTableSort parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' @@ -4876,44 +6960,29 @@ paths: responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/tables: - get: - summary: Retrieve a list of table in the workbook. - operationId: ListWorkbookTablesWithItemPath - tags: - - tables + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/sort/reapply: + post: + summary: Reapplies the current sorting parameters to the table. + operationId: reapplyWorksheetTableSortWithItemPath parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' - $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/Tables' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables: + #___________________________________ TABLE ROWS ________________________________________ + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows: get: - summary: Retrieve a list of table in the worksheet. - operationId: listTablesWithItemPath + summary: Retrieve a list of table row in the worksheet. + operationId: listWorksheetTableRows tags: - - tables + - row parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -4930,114 +6999,107 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Tables' - /me/drive/root:/{itemPath}:/workbook/tables/add: + $ref: '#/components/schemas/Rows' post: - summary: Create a new table in the workbook - operationId: createWorkbookTableWithItemPath + summary: Adds rows to the end of a table in the worksheet. + operationId: createWorksheetTableRow tags: - - tables + - row parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTablePayload' + $ref: '#/components/schemas/Row' responses: - '200': - description: OK + '201': + description: Created. content: application/json: schema: - $ref: '#/components/schemas/Table' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/add: - post: - summary: Create a new table in the worksheet. - operationId: createTableWithItemPath + $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. + operationId: listWorksheetTableRowsWithItemPath tags: - - tables + - row parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateTablePayload' + - $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/Table' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}: - patch: - summary: Update the properties of table in the workbook. - description: Update the properties of table - operationId: updateWorkbookTableWithItemPath + $ref: '#/components/schemas/Rows' + post: + summary: Adds rows to the end of a table in the worksheet. + operationId: createWorksheetTableRowWithItemPath tags: - - tables + - row parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Table' + $ref: '#/components/schemas/Row' responses: - '200': - description: OK + '201': + description: Created. content: application/json: schema: - $ref: '#/components/schemas/Table' - delete: - summary: Deletes the table from the workbook. - operationId: deleteWorkbookTableWithItemPath + $ref: '#/components/schemas/Row' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/add: + post: + summary: Adds rows to the end of the table. + operationId: addWorksheetTableRow tags: - - tables + - row parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Row' responses: - '200': - description: OK - get: - summary: Retrieve the properties and relationships of table. - operationId: getWorkbookTableWithItemPath - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $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/Table' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}: - patch: - summary: Update the properties of table in the worksheet - operationId: updateTableWithItemPath + '201': + description: Created. + content: + application/json: + schema: + $ref: '#/components/schemas/Row' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/add: + post: + summary: Adds rows to the end of the table. + operationId: addWorksheetTableRowWithItemPath tags: - - tables + - row parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' @@ -5047,74 +7109,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Table' + $ref: '#/components/schemas/Row' responses: - '200': + '201': description: OK content: application/json: schema: - $ref: '#/components/schemas/Table' - delete: - summary: Deletes the table from the worksheet - operationId: deleteTableWithItemPath + $ref: '#/components/schemas/Row' + /me/drive/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): + get: + summary: Gets a row based on its position in the collection. + operationId: getWorksheetTableRowWithIndex tags: - - tables + - 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' responses: '200': description: OK - get: - summary: Retrieve the properties and relationships of table. - operationId: getTableWithItemPath - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/tableIdOrName' - - $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/Table' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/range: - get: - summary: Get the range associated with the entire table. - operationId: getWorkbookTableRangeWithItemPath - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. content: application/json: schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/range: + $ref: '#/components/schemas/Row' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): get: - summary: Get the range associated with the entire table. - operationId: getTableRangeWithItemPath + 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': @@ -5122,17 +7154,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Range' - #___________________________________ TABLE ROWS ________________________________________ - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows: + $ref: '#/components/schemas/Row' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/{index}: get: - summary: Retrieve a list of table row in the workbook. - operationId: listWorkbookTableRows + summary: Retrieve the properties and relationships of table row. + operationId: getWorksheetTableRow tags: - row parameters: - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -5145,19 +7178,21 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: Success. + description: OK content: application/json: schema: - $ref: '#/components/schemas/Rows' - post: - summary: Adds rows to the end of a table in the workbook. - operationId: createWorkbookTableRow + $ref: '#/components/schemas/Row' + patch: + summary: Update the properties of table row. + operationId: updateWorksheetTableRow tags: - - table + - row parameters: - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' requestBody: content: @@ -5165,22 +7200,37 @@ paths: schema: $ref: '#/components/schemas/Row' responses: - '201': - description: Created. + '200': + description: Success. content: application/json: schema: $ref: '#/components/schemas/Row' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows: - get: - summary: Retrieve a list of table row in the worksheet. - operationId: listTableRows + delete: + summary: Deletes the row from the workbook table. + operationId: deleteWorksheetTableRow tags: - - tablerow + - row parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/{index}: + get: + summary: Retrieve the properties and relationships of table row. + operationId: getWorksheetTableRowWithItemPath + tags: + - row + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -5197,16 +7247,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Rows' - post: - summary: Adds rows to the end of a table in the worksheet. - operationId: createTableRow + $ref: '#/components/schemas/Row' + patch: + summary: Update the properties of table row. + operationId: updateWorksheetTableRowWithItemPath tags: - - table + - row parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' requestBody: content: @@ -5214,138 +7265,190 @@ paths: schema: $ref: '#/components/schemas/Row' responses: - '201': - description: Created. + '200': + description: Success. content: application/json: schema: $ref: '#/components/schemas/Row' - patch: - summary: Update the properties of table row. - operationId: updateTableRow + 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. + operationId: getWorksheetTableRowRange tags: - - tablerow + - row parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/rowIndex' + - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Row' responses: '200': description: Success. content: application/json: schema: - $ref: '#/components/schemas/Row' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/add: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + get: + summary: Get the range associated with the entire row. + operationId: getWorksheetTableRowRangeWithItemPath + 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: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + #___________________________________ TABLE COLUMNS ________________________________________ + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns: post: - summary: Adds rows to the end of the table. - operationId: addTableRow + summary: Create a new table column in the workbook. + operationId: createWorkbookTableColumn tags: - - tablerow + - column parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Row' + $ref: '#/components/schemas/Column' responses: - '201': - description: Created. + '200': + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Row' - /me/drive/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): + $ref: '#/components/schemas/Column' get: - summary: Gets a row based on its position in the collection. - operationId: getTableRowWithIndex + summary: Retrieve a list of table column in the workbook. + operationId: listWorkbookTableColumns tags: - - tablerow + - column parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - $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/Row' - delete: - summary: Deletes the row from the workbook table. - operationId: deleteTableRow + $ref: '#/components/schemas/Columns' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns: + post: + summary: Create a new table column in the workbook. + operationId: createWorkbookTableColumnWithItemPath tags: - - tablerow + - column parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Column' responses: '200': - description: OK - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Column' get: - summary: Get the range associated with the entire row. - operationId: getWorkbookTableRowRangeWithIndex + summary: Retrieve a list of table column in the workbook. + operationId: listWorkbookTableColumnsWithItemPath tags: - - tablerow + - column parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $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/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index})/range: - get: - summary: Get the range associated with the entire row. - operationId: getTableRowRangeWithIndex + $ref: '#/components/schemas/Columns' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: + post: + summary: Create a new table column in the workbook. + operationId: createWorksheetTableColumn tags: - - tablerow + - tableColumn parameters: - $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/Column' responses: '200': - description: Success. + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Range' - - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows: + $ref: '#/components/schemas/Column' get: - summary: Retrieve a list of table row in the workbook. - operationId: listWorkbookTableRowsWithItemPath + summary: Retrieve a list of table column in the workbook. + operationId: listWorksheetTableColumns tags: - - row + - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' @@ -5359,38 +7462,39 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: Success. + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Rows' + $ref: '#/components/schemas/Columns' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: post: - summary: Adds rows to the end of a table in the workbook. - operationId: createWorkbookTableRowWithItemPath + summary: Create a new table column in the workbook. + operationId: createWorksheetTableColumnWithItemPath tags: - - table + - tableColumn parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Row' + $ref: '#/components/schemas/Column' responses: - '201': - description: Created. + '200': + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Row' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows: + $ref: '#/components/schemas/Column' get: - summary: Retrieve a list of table row in the worksheet. - operationId: listTableRowsWithItemPath + summary: Retrieve a list of table column in the workbook. + operationId: listWorksheetTableColumnsWithItemPath tags: - - tablerow + - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' @@ -5407,160 +7511,187 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Rows' - post: - summary: Adds rows to the end of a table in the worksheet. - operationId: createTableRowWithItemPath + $ref: '#/components/schemas/Columns' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Deletes the column from the table. + operationId: deleteWorkbookTableColumn tags: - - table + - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Row' responses: - '201': - description: Created. + '204': + description: No Content. + get: + summary: Retrieve the properties and relationships of table column. + operationId: getWorkbookTableColumn + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $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/Row' + $ref: '#/components/schemas/Column' patch: - summary: Update the properties of table row. - operationId: updateTableRowWithItemPath + summary: Update the properties of table column + operationId: updateWorkbookTableColumn tags: - - tablerow + - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/rowIndex' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/Row' + $ref: '#/components/schemas/Column' responses: '200': - description: Success. + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Row' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/add: - post: - summary: Adds rows to the end of the table. - operationId: addTableRowWithItemPath + $ref: '#/components/schemas/Column' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Deletes the column from the table. + operationId: deleteWorkbookTableColumnWithItemPath tags: - - tablerow + - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Row' responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Row' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index}): + '204': + description: No Content. get: - summary: Gets a row based on its position in the collection. - operationId: getTableRowWithIndexItemPath + summary: Retrieve the properties and relationships of table column. + operationId: getWorkbookTableColumnWithItemPath tags: - - tablerow + - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/columnIdOrName' - $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 + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Row' - delete: - summary: Deletes the row from the workbook table. - operationId: deleteTableRowWithItemPath + $ref: '#/components/schemas/Column' + patch: + summary: Update the properties of table column + operationId: updateWorkbookTableColumnWithItemPath tags: - - tablerow + - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Column' responses: '200': - description: OK - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/rows/itemAt(index={index})/range: - get: - summary: Get the range associated with the entire row. - operationId: getWorkbookTableRowRangeWithIndexItemPath + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Column' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Delete a column from a table. + operationId: deleteWorksheetTableColumn tags: - - tablerow + - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/rows/itemAt(index={index})/range: + '204': + description: No Content. get: - summary: Get the range associated with the entire row. - operationId: getTableRowRangeWithIndexItemPath + summary: Retrieve the properties and relationships of table column. + operationId: getWorksheetTableColumn tags: - - tablerow + - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/columnIdOrName' - $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: Success. + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Range' - #___________________________________ TABLE COLUMNS ________________________________________ - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns: - post: - summary: Create a new table column in the workbook. - operationId: createWorkBookTableColumn + $ref: '#/components/schemas/Column' + patch: + summary: Update the properties of table column + operationId: updateWorksheetTableColumn tags: - tableColumn parameters: - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: @@ -5574,14 +7705,31 @@ paths: application/json: schema: $ref: '#/components/schemas/Column' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: + delete: + summary: Delete a column from a table. + operationId: deleteWorksheetTableColumnWithItemPath + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '204': + description: No Content. get: - summary: Retrieve a list of table column in the workbook. - operationId: listWorkbookTableColumns + summary: Retrieve the properties and relationships of table column. + operationId: getWorksheetTableColumnWithItemPath tags: - tableColumn parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -5594,21 +7742,21 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Columns' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: - post: - summary: Create a new table column in the workbook. - operationId: createTableColumn + $ref: '#/components/schemas/Column' + patch: + summary: Update the properties of table column + operationId: updateWorksheetTableColumnWithItemPath tags: - tableColumn parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: @@ -5622,15 +7770,16 @@ paths: application/json: schema: $ref: '#/components/schemas/Column' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/dataBodyRange: get: - summary: Retrieve a list of table column in the workbook. - operationId: listTableColumns + summary: Gets the range associated with the data body of the column + operationId: getworkbookTableColumnsDataBodyRange tags: - tableColumn parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -5638,27 +7787,29 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/Columns' - /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}: - delete: - summary: Deletes the column from the table. - operationId: deleteWorkbookTableColumn + $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 + operationId: getworkbookTableColumnsDataBodyRangeWithItemPath tags: - tableColumn parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content. - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: - delete: - summary: Delete a column from a table. - operationId: deleteTableColumn + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getworksheetTableColumnsDataBodyRange tags: - tableColumn parameters: @@ -5668,88 +7819,97 @@ paths: - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content. - - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns: - post: - summary: Create a new table column in the workbook. - operationId: createWorkBookTableColumnWithItemPath + '200': + description: OK. + content: + application/json: + schema: + $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 + operationId: getworksheetTableColumnsDataBodyRangeWithItemPath tags: - tableColumn parameters: - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/headerRowRange: + get: + summary: Gets the range associated with the header row of the column. + operationId: getworkbookTableColumnsHeaderRowRange + tags: + - tableColumn + parameters: + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Column' responses: '200': description: OK. content: application/json: schema: - $ref: '#/components/schemas/Column' + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/headerRowRange: get: - summary: Retrieve a list of table column in the workbook. - operationId: listWorkbookTableColumnsWithItemPath + summary: Gets the range associated with the header row of the column. + operationId: getworkbookTableColumnsHeaderRowRangeWithItemPath tags: - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $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 + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Columns' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns: - post: - summary: Create a new table column in the workbook. - operationId: createTableColumnWithItemPath + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}/headerRowRange: + get: + summary: Gets the range associated with the header row of the column. + operationId: getworksheetTableColumnsHeaderRowRange tags: - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Column' responses: '200': description: OK. content: application/json: schema: - $ref: '#/components/schemas/Column' + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}/headerRowRange: get: - summary: Retrieve a list of table column in the workbook. - operationId: listTableColumnsWithItemPath + summary: Gets the range associated with the header row of the column. + operationId: getworksheetTableColumnsHeaderRowRangeWithItemPath tags: - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: '200': @@ -5757,85 +7917,82 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Columns' - /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}: - delete: - summary: Deletes the column from the table. - operationId: deleteWorkbookTableColumnWithItemPath + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/totalRowRange: + get: + summary: Gets the range associated with the totals row of the column. + operationId: getworkbookTableColumnsTotalRowRange tags: - tableColumn parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content. - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}: - delete: - summary: Delete a column from a table. - operationId: deleteTableColumnWithItemPath + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/tables/{tableIdOrName}/columns/{columnIdOrName}/totalRowRange: + get: + summary: Gets the range associated with the totals row of the column. + operationId: getworkbookTableColumnsTotalRowRangeWithItemPath tags: - tableColumn parameters: - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/tableIdOrName' - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' responses: - '204': - description: No Content. - #___________________________________ CHART ________________________________________ - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Range' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}/totalRowRange: get: - summary: Retrieve a list of chart. - operationId: listCharts + summary: Gets the range associated with the totals row of the column. + operationId: getworksheetTableColumnsTotalRowRange tags: - - worksheet + - tableColumn parameters: - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $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: A collection of chart objects. + '200': + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Charts' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/add: - post: - summary: Creates a new chart - operationId: addChart + $ref: '#/components/schemas/Range' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/tables/{tableIdOrName}/columns/{columnIdOrName}/totalRowRange: + get: + summary: Gets the range associated with the totals row of the column. + operationId: getworksheetTableColumnsTotalRowRangeWithItemPath tags: - - chart + - tableColumn parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/tableIdOrName' + - $ref: '#/components/parameters/columnIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateChartPayload' responses: - "200": - description: OK + '200': + description: OK. content: application/json: schema: - $ref: '#/components/schemas/Chart' + $ref: '#/components/schemas/Range' + #___________________________________ CHART ________________________________________ /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}: get: summary: Retrieve the properties and relationships of chart. @@ -5889,33 +8046,31 @@ paths: responses: '200': description: OK. - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setData: - post: - summary: Resets the source data for the chart. - operationId: setChartData + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}: + get: + summary: Retrieve the properties and relationships of chart. + operationId: getChartWithItemPath tags: - chart parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResetData' responses: '200': description: OK. - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setPosition: - post: - summary: Positions the chart relative to cells on the worksheet - operationId: setPosition + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + patch: + summary: Update the properties of chart. + operationId: updateChartWithItemPath tags: - chart parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' @@ -5923,10 +8078,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Position' + $ref: '#/components/schemas/Chart' responses: '200': - description: OK + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/Chart' + delete: + summary: Deletes the chart. + operationId: deleteChartWithItemPath + tags: + - chart + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/sessionId' + responses: + '200': + description: OK. /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: post: summary: create a new chart series. @@ -5976,114 +8148,38 @@ paths: application/json: schema: $ref: '#/components/schemas/collectionOfChartSeries' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/itemAt(index={index}): - get: - summary: Gets a chart based on its position in the collection. - operationId: getChartBasedOnPosition - tags: - - chart - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/index' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Chart' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image: - get: - summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImage - tags: - - chart - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/chartIdOrName' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Image' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width}): - get: - summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImageWithWidth - tags: - - chart - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/chartIdOrName' - - $ref: '#/components/parameters/width' - - $ref: '#/components/parameters/sessionId' - - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Image' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height}): - get: - summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImageWithWidthHeight + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: + post: + summary: create a new chart series. + operationId: createChartSeriesWithItemPath tags: - chart parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - - $ref: '#/components/parameters/width' - - $ref: '#/components/parameters/height' - $ref: '#/components/parameters/sessionId' - + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChartSeries' responses: - '200': - description: OK. + '201': + description: Created. content: application/json: schema: - $ref: '#/components/schemas/Image' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height},fittingMode={fittingMode}): + $ref: '#/components/schemas/ChartSeries' get: - summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImageWithWidthHeightFittingMode + summary: Retrieve a list of chart series . + operationId: listChartSeriesWithItemPath tags: - chart - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/chartIdOrName' - - $ref: '#/components/parameters/width' - - $ref: '#/components/parameters/height' - - $ref: '#/components/parameters/fittingMode' - - $ref: '#/components/parameters/sessionId' - - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Image' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts: - get: - summary: Retrieve a list of chart. - operationId: listChartsWithItemPath - tags: - - worksheet parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -6095,42 +8191,20 @@ paths: - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/top' responses: - "200": - description: A collection of chart objects. - content: - application/json: - schema: - $ref: '#/components/schemas/Charts' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/add: - post: - summary: Creates a new chart - operationId: addChartWithItemPath - tags: - - chart - parameters: - - $ref: '#/components/parameters/itemPath' - - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateChartPayload' - responses: - "200": - description: OK + '201': + description: Created. content: application/json: schema: - $ref: '#/components/schemas/Chart' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}: + $ref: '#/components/schemas/collectionOfChartSeries' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image: get: - summary: Retrieve the properties and relationships of chart. - operationId: getChartWithItemPath + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImage tags: - chart parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' @@ -6140,10 +8214,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Chart' - patch: - summary: Update the properties of chart. - operationId: updateChartWithItemPath + $ref: '#/components/schemas/Image' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image: + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithItemPath tags: - chart parameters: @@ -6151,35 +8226,36 @@ paths: - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Chart' responses: '200': description: OK. content: application/json: schema: - $ref: '#/components/schemas/Chart' - delete: - summary: Deletes the chart. - operationId: deleteChartWithItemPath + $ref: '#/components/schemas/Image' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setData: + post: + summary: Resets the source data for the chart. + operationId: resetChartData tags: - chart parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResetData' responses: '200': description: OK. /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setData: post: summary: Resets the source data for the chart. - operationId: setChartDataWithItemPath + operationId: resetChartDataWithItemPath tags: - chart parameters: @@ -6195,14 +8271,14 @@ paths: responses: '200': description: OK. - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setPosition: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setPosition: post: summary: Positions the chart relative to cells on the worksheet - operationId: setPositionWithItemPath + operationId: setChartPosition tags: - chart parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/sessionId' @@ -6214,10 +8290,10 @@ paths: responses: '200': description: OK - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/series: + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/setPosition: post: - summary: create a new chart series. - operationId: createChartSeriesWithItemPath + summary: Positions the chart relative to cells on the worksheet + operationId: setChartPositionWithItemPath tags: - chart parameters: @@ -6229,40 +8305,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ChartSeries' + $ref: '#/components/schemas/Position' responses: - '201': - description: Created. - content: - application/json: - schema: - $ref: '#/components/schemas/ChartSeries' + '200': + description: OK + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/itemAt(index={index}): get: - summary: Retrieve a list of chart series . - operationId: listChartSeriesWithItemPath + summary: Gets a chart based on its position in the collection. + operationId: getChartBasedOnPosition tags: - chart parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - - $ref: '#/components/parameters/chartIdOrName' + - $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: - '201': - description: Created. + '200': + description: OK. content: application/json: schema: - $ref: '#/components/schemas/collectionOfChartSeries' + $ref: '#/components/schemas/Chart' /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/itemAt(index={index}): get: summary: Gets a chart based on its position in the collection. @@ -6281,17 +8345,19 @@ paths: application/json: schema: $ref: '#/components/schemas/Chart' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width}): get: summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImageWithItemPath + operationId: getChartImageWithWidth tags: - chart parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' - $ref: '#/components/parameters/sessionId' + responses: '200': description: OK. @@ -6319,14 +8385,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Image' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height}): + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height}): get: summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImageWithWidthHeightItemPath + operationId: getChartImageWithWidthHeight tags: - chart parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/width' @@ -6340,10 +8406,10 @@ paths: application/json: schema: $ref: '#/components/schemas/Image' - /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height},fittingMode={fittingMode}): + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height}): get: summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - operationId: getChartImageWithWidthHeightFittingModeItemPath + operationId: getChartImageWithWidthHeightItemPath tags: - chart parameters: @@ -6352,7 +8418,6 @@ paths: - $ref: '#/components/parameters/chartIdOrName' - $ref: '#/components/parameters/width' - $ref: '#/components/parameters/height' - - $ref: '#/components/parameters/fittingMode' - $ref: '#/components/parameters/sessionId' responses: @@ -6362,75 +8427,59 @@ paths: application/json: schema: $ref: '#/components/schemas/Image' - #___________________________________ NAMED ITEM ________________________________________ - /me/drive/items/{itemId}/workbook/names: + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height},fittingMode={fittingMode}): get: - summary: Retrieve a list of named item. - operationId: listWorkbookNamedItem + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthHeightFittingMode tags: - - namedItem + - chart parameters: - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/height' + - $ref: '#/components/parameters/fittingMode' - $ref: '#/components/parameters/sessionId' + responses: '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/NamedItems' - /me/drive/items/{itemId}/workbook/names/add: - post: - summary: Adds a new name to the collection of the given scope using the user's locale for the formula. - operationId: addWorkbookNamedItem - tags: - - namedItem - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddNamedItemPayload' - responses: - '201': - description: Created. + description: OK. content: application/json: schema: - $ref: '#/components/schemas/NamedItem' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/names/add: - post: - summary: Adds a new name to the collection of the given scope using the user's locale for the formula. - operationId: addNamedItem + $ref: '#/components/schemas/Image' + /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/charts/{chartIdOrName}/image(width={width},height={height},fittingMode={fittingMode}): + get: + summary: Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + operationId: getChartImageWithWidthHeightFittingModeItemPath tags: - - namedItem + - chart parameters: - - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' + - $ref: '#/components/parameters/chartIdOrName' + - $ref: '#/components/parameters/width' + - $ref: '#/components/parameters/height' + - $ref: '#/components/parameters/fittingMode' - $ref: '#/components/parameters/sessionId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddNamedItemPayload' + responses: - '201': - description: Created. + '200': + description: OK. content: application/json: schema: - $ref: '#/components/schemas/NamedItem' - /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/names: + $ref: '#/components/schemas/Image' + #___________________________________ NAMED ITEM ________________________________________ + /me/drive/items/{itemId}/workbook/names: get: - summary: Retrieve the properties and relationships of the named item. - operationId: getWorksheetNamedItems + summary: Retrieves a list of named items. + operationId: listNamedItem tags: - namedItem parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -6443,20 +8492,19 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK. + description: OK content: application/json: schema: $ref: '#/components/schemas/NamedItems' - /me/drive/items/{itemId}/workbook/names/{name}: + /me/drive/root:/{itemPath}:/workbook/names: get: - summary: Retrieve the properties and relationships of the named item. - operationId: getWorkbookNamedItem + summary: Retrieve a list of named item. + operationId: listNamedItemWithItemPath tags: - namedItem parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/expand' @@ -6469,77 +8517,66 @@ paths: - $ref: '#/components/parameters/top' responses: '200': - description: OK. + description: OK content: application/json: schema: - $ref: '#/components/schemas/NamedItem' - patch: - summary: Update the properties of the named item . - operationId: updateWorkbookNamedItem + $ref: '#/components/schemas/NamedItems' + /me/drive/items/{itemId}/workbook/names/add: + post: + summary: Adds a new name to the collection of the given scope using the user's locale for the formula. + operationId: addWorkbookNamedItem tags: - namedItem parameters: - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/NamedItem' + $ref: '#/components/schemas/NewNamedItem' responses: - '200': - description: OK. + '201': + description: Created. content: application/json: schema: $ref: '#/components/schemas/NamedItem' - /me/drive/items/{itemId}/workbook/names/{name}/range: - get: - summary: Retrieve the range object that is associated with the name. - operationId: getNamedRange - tags: - - namedItem - parameters: - - $ref: '#/components/parameters/itemId' - - $ref: '#/components/parameters/name' - - $ref: '#/components/parameters/sessionId' - responses: - '200': - description: OK. - content: - application/json: - schema: - $ref: '#/components/schemas/Range' - /me/drive/root:/{itemPath}:/workbook/names: - get: - summary: Retrieve a list of named item. - operationId: listWorkbookNamedItemWithItemPath - tags: - - namedItem + /me/drive/root:/{itemPath}:/workbook/names/add: + post: + summary: Adds a new name to the collection of the given scope using the user's locale for the formula. + operationId: addWorkbookNamedItemWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewNamedItem' responses: - '200': - description: OK + '201': + description: Created. content: application/json: schema: - $ref: '#/components/schemas/NamedItems' - /me/drive/root:/{itemPath}:/workbook/names/add: + $ref: '#/components/schemas/NamedItem' + /me/drive/items/{itemId}/workbook/worksheets/{worksheetIdOrName}/names/add: post: summary: Adds a new name to the collection of the given scope using the user's locale for the formula. - operationId: addWorkbookNamedItemWithItemPath + operationId: addWorksheetNamedItem + tags: + - namedItem parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' + - $ref: '#/components/parameters/worksheetIdOrName' - $ref: '#/components/parameters/sessionId' requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddNamedItemPayload' + $ref: '#/components/schemas/NewNamedItem' responses: '201': description: Created. @@ -6550,7 +8587,7 @@ paths: /me/drive/root:/{itemPath}:/workbook/worksheets/{worksheetIdOrName}/names/add: post: summary: Adds a new name to the collection of the given scope using the user's locale for the formula. - operationId: addNamedItemWithItemPath + operationId: addWorksheetNamedItemWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/worksheetIdOrName' @@ -6559,7 +8596,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddNamedItemPayload' + $ref: '#/components/schemas/NewNamedItem' responses: '201': description: Created. @@ -6567,12 +8604,14 @@ paths: application/json: schema: $ref: '#/components/schemas/NamedItem' - /me/drive/root:/{itemPath}:/workbook/names/{name}: + /me/drive/items/{itemId}/workbook/names/{name}: get: summary: Retrieve the properties and relationships of the named item. - operationId: getWorkbookNamedItemWithItemPath + operationId: getNamedItem + tags: + - namedItem parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' - $ref: '#/components/parameters/count' @@ -6593,9 +8632,11 @@ paths: $ref: '#/components/schemas/NamedItem' patch: summary: Update the properties of the named item . - operationId: updateWorkbookNamedItemWithItemPath + operationId: updateNamedItem + tags: + - namedItem parameters: - - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/itemId' - $ref: '#/components/parameters/name' - $ref: '#/components/parameters/sessionId' requestBody: @@ -6610,18 +8651,46 @@ paths: application/json: schema: $ref: '#/components/schemas/NamedItem' - /me/drive/root:/{itemPath}:/workbook/names/{name}/range: + /me/drive/root:/{itemPath}:/workbook/names/{name}: get: - summary: Retrieve the range object that is associated with the name. - operationId: getNamedRangeWithItemPath + summary: Retrieve the properties and relationships of the named item. + operationId: getNamedItemWithItemPath parameters: - $ref: '#/components/parameters/itemPath' - $ref: '#/components/parameters/name' - $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' + $ref: '#/components/schemas/NamedItem' + patch: + summary: Update the properties of the named item . + operationId: updateNamedItemWithItemPath + parameters: + - $ref: '#/components/parameters/itemPath' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/sessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/NamedItem' From ebe9fff5233b1f45e54fa75ce3a040674e3a281f Mon Sep 17 00:00:00 2001 From: Kalaiyarasiganeshalingam Date: Thu, 9 Nov 2023 16:01:10 +0530 Subject: [PATCH 3/5] Update git ignore --- .idea/.gitignore | 3 --- .idea/misc.xml | 6 ------ .idea/module-ballerinax-microsoft.excel.iml | 9 --------- .idea/modules.xml | 8 -------- .idea/vcs.xml | 6 ------ 5 files changed, 32 deletions(-) delete mode 100644 .idea/.gitignore delete mode 100644 .idea/misc.xml delete mode 100644 .idea/module-ballerinax-microsoft.excel.iml delete mode 100644 .idea/modules.xml delete mode 100644 .idea/vcs.xml diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 26d3352..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index 639900d..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/module-ballerinax-microsoft.excel.iml b/.idea/module-ballerinax-microsoft.excel.iml deleted file mode 100644 index d6ebd48..0000000 --- a/.idea/module-ballerinax-microsoft.excel.iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 3d13987..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 35eb1dd..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file From 49d57c68e21810da99c0db884b43d3c5f94cc75d Mon Sep 17 00:00:00 2001 From: Kalaiyarasiganeshalingam Date: Thu, 9 Nov 2023 16:10:51 +0530 Subject: [PATCH 4/5] Fix warning --- .gitignore | 1 + ballerina/tests/test.bal | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 930db88..3d44900 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ target # Ignore Gradle project-specific cache directory .gradle +.idea # Ignore Gradle build output directory build diff --git a/ballerina/tests/test.bal b/ballerina/tests/test.bal index 15e5a8d..80c3845 100644 --- a/ballerina/tests/test.bal +++ b/ballerina/tests/test.bal @@ -124,7 +124,7 @@ function testDeleteWorksheet() { if response.statusCode != 404 { test:assertFail(response.statusCode.toBalString()); } - } else if response is error { + } else { test:assertFail(response.toString()); } } From 7768d17760a257603862a08a37dcc245073e01e8 Mon Sep 17 00:00:00 2001 From: Kalaiyarasiganeshalingam Date: Fri, 10 Nov 2023 11:14:27 +0530 Subject: [PATCH 5/5] 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'