feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-ae41932155230b865ddb20e28d874de8256f130bc59c0ba67125d52e2e43586a.yml
-openapi_spec_hash: a297de17280f9fbb7a85f72ac89dc9b1
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/grid%2Fspreadsheet-api-b337c0f981b3b48777c64c32edd73eb2b7bd513a38e077d7b342b7b372bc271d.yml
+openapi_spec_hash: 1a4275d62efcaaa62594d2bb734cf4eb
 config_hash: d3f4645d9a93970cbead53b83c49a2c4

src/grid_api/resources/workbooks.py

@@ -131,6 +131,18 @@ def calc(
         Run calculations in a workbook and retrieve cell objects.
 
         Args:
+          apply: Map of cell references to values. The values are written to cells in the
+              spreadsheet before performing the read operation. You can write numbers,
+              strings, and booleans. Any updated values are discarded at the end of the
+              request.
+
+              ```json
+              {
+                "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null }
+                // ...
+              }
+              ```
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -175,7 +187,7 @@ def export(
         exported.
 
         Args:
-          apply: Cells to update before exporting
+          apply: Cells to update before exporting.
 
           goal_seek: Goal seek. Use this to calculate the required input value for a formula to
               achieve a specified target result. This is particularly useful when the desired
@@ -292,8 +304,7 @@ def render_chart(
           chart: Options for rendering a chart from workbook data. Specify the data range, chart
               type, image output format, and title and axis labels.
 
-          apply: Cells to update before rendering the chart. Changes are discarded at the end of
-              the request
+          apply: Cells to update before rendering the chart.
 
           matte: Hex color code for the chart's background matte, e.g. '#FFFFFF' for white, if
               not specified, the chart will have a transparent background. Note, this is
@@ -392,6 +403,18 @@ def values(
         Run calculations in a workbook and retrieve cell values.
 
         Args:
+          apply: Map of cell references to values. The values are written to cells in the
+              spreadsheet before performing the read operation. You can write numbers,
+              strings, and booleans. Any updated values are discarded at the end of the
+              request.
+
+              ```json
+              {
+                "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null }
+                // ...
+              }
+              ```
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -505,6 +528,18 @@ async def calc(
         Run calculations in a workbook and retrieve cell objects.
 
         Args:
+          apply: Map of cell references to values. The values are written to cells in the
+              spreadsheet before performing the read operation. You can write numbers,
+              strings, and booleans. Any updated values are discarded at the end of the
+              request.
+
+              ```json
+              {
+                "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null }
+                // ...
+              }
+              ```
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -549,7 +584,7 @@ async def export(
         exported.
 
         Args:
-          apply: Cells to update before exporting
+          apply: Cells to update before exporting.
 
           goal_seek: Goal seek. Use this to calculate the required input value for a formula to
               achieve a specified target result. This is particularly useful when the desired
@@ -666,8 +701,7 @@ async def render_chart(
           chart: Options for rendering a chart from workbook data. Specify the data range, chart
               type, image output format, and title and axis labels.
 
-          apply: Cells to update before rendering the chart. Changes are discarded at the end of
-              the request
+          apply: Cells to update before rendering the chart.
 
           matte: Hex color code for the chart's background matte, e.g. '#FFFFFF' for white, if
               not specified, the chart will have a transparent background. Note, this is
@@ -766,6 +800,18 @@ async def values(
         Run calculations in a workbook and retrieve cell values.
 
         Args:
+          apply: Map of cell references to values. The values are written to cells in the
+              spreadsheet before performing the read operation. You can write numbers,
+              strings, and booleans. Any updated values are discarded at the end of the
+              request.
+
+              ```json
+              {
+                "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null }
+                // ...
+              }
+              ```
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request

src/grid_api/types/workbook_calc_params.py

@@ -14,3 +14,16 @@ class WorkbookCalcParams(TypedDict, total=False):
     read: Required[SequenceNotStr[str]]
 
     apply: Optional[Dict[str, Union[float, str, bool, None]]]
+    """Map of cell references to values.
+
+    The values are written to cells in the spreadsheet before performing the read
+    operation. You can write numbers, strings, and booleans. Any updated values are
+    discarded at the end of the request.
+
+    ```json
+    {
+      "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null }
+      // ...
+    }
+    ```
+    """

src/grid_api/types/workbook_export_params.py

@@ -22,7 +22,7 @@
 
 class WorkbookExportParams(TypedDict, total=False):
     apply: Optional[Iterable[Apply]]
-    """Cells to update before exporting"""
+    """Cells to update before exporting."""
 
     goal_seek: Annotated[Optional[GoalSeek], PropertyInfo(alias="goalSeek")]
     """Goal seek.

src/grid_api/types/workbook_render_chart_params.py

@@ -27,10 +27,7 @@ class WorkbookRenderChartParams(TypedDict, total=False):
     """
 
     apply: Optional[Iterable[Apply]]
-    """Cells to update before rendering the chart.
-
-    Changes are discarded at the end of the request
-    """
+    """Cells to update before rendering the chart."""
 
     matte: Optional[str]
     """Hex color code for the chart's background matte, e.g.

src/grid_api/types/workbook_values_params.py

@@ -14,3 +14,16 @@ class WorkbookValuesParams(TypedDict, total=False):
     read: Required[SequenceNotStr[str]]
 
     apply: Optional[Dict[str, Union[float, str, bool, None]]]
+    """Map of cell references to values.
+
+    The values are written to cells in the spreadsheet before performing the read
+    operation. You can write numbers, strings, and booleans. Any updated values are
+    discarded at the end of the request.
+
+    ```json
+    {
+      "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null }
+      // ...
+    }
+    ```
+    """

tests/api_resources/test_workbooks.py

@@ -84,7 +84,12 @@ def test_method_calc_with_all_params(self, client: Grid) -> None:
         workbook = client.workbooks.calc(
             id="id",
             read=["A1"],
-            apply={"foo": 1234},
+            apply={
+                "A1": 100,
+                "A2": 2.718,
+                "A3": "Total",
+                "A4": True,
+            },
         )
         assert_matches_type(WorkbookCalcResponse, workbook, path=["response"])
 
@@ -425,7 +430,12 @@ def test_method_values_with_all_params(self, client: Grid) -> None:
         workbook = client.workbooks.values(
             id="id",
             read=["A1"],
-            apply={"foo": 1234},
+            apply={
+                "A1": 100,
+                "A2": 2.718,
+                "A3": "Total",
+                "A4": True,
+            },
         )
         assert_matches_type(WorkbookValuesResponse, workbook, path=["response"])
 
@@ -524,7 +534,12 @@ async def test_method_calc_with_all_params(self, async_client: AsyncGrid) -> Non
         workbook = await async_client.workbooks.calc(
             id="id",
             read=["A1"],
-            apply={"foo": 1234},
+            apply={
+                "A1": 100,
+                "A2": 2.718,
+                "A3": "Total",
+                "A4": True,
+            },
         )
         assert_matches_type(WorkbookCalcResponse, workbook, path=["response"])
 
@@ -865,7 +880,12 @@ async def test_method_values_with_all_params(self, async_client: AsyncGrid) -> N
         workbook = await async_client.workbooks.values(
             id="id",
             read=["A1"],
-            apply={"foo": 1234},
+            apply={
+                "A1": 100,
+                "A2": 2.718,
+                "A3": "Total",
+                "A4": True,
+            },
         )
         assert_matches_type(WorkbookValuesResponse, workbook, path=["response"])