feat: add update_grid_view_col()

Author: salim-b

NAMESPACE

@@ -67,6 +67,7 @@ export(update_base)
 export(update_base_ui_acl)
 export(update_base_user)
 export(update_data_src)
+export(update_grid_view_col)
 export(update_integration)
 export(update_plugin)
 export(update_tbl)

R/nocodb.gen.R

@@ -2335,6 +2335,39 @@ update_tbl_view_col <- function(id_view_col,
   invisible(id_view_col)
 }
 
+#' Update NocoDB grid view column
+#'
+#' Updates the metadata of the specified grid view column on a NocoDB server via its
+#' [`PATCH /api/v2/meta/grid-columns/{id_view_col}`](https://meta-apis-v2.nocodb.com/#tag/Views/operation/db-view-grid-column-update) API endpoint.
+#'
+#' @inheritParams update_tbl_view_col
+#' @param order `r pkgsnip::type("int", 1L)`
+#'   A number to assign as the grid view columns's UI order "weight".
+#'
+#' @returns `id_view_col`, invisibly.
+#' @family views
+#' @export
+update_grid_view_col <- function(id_view_col,
+                                 order = NULL,
+                                 origin = funky::config_val("origin"),
+                                 email = funky::config_val("email"),
+                                 password = funky::config_val("password"),
+                                 api_token = funky::config_val("api_token")) {
+  
+  checkmate::assert_number(order,
+                           null.ok = TRUE)
+  
+  api(path = glue::glue("api/v2/meta/grid-columns/{id_view_col}"),
+      method = "PATCH",
+      origin = origin,
+      email = email,
+      password = password,
+      api_token = api_token,
+      body_json = purrr::compact(list(order = order)))
+  
+  invisible(id_view_col)
+}
+
 #' List NocoDB table columns
 #'
 #' Returns a [tibble][tibble::tbl_df] with metadata about the columns of the specified table on a NocoDB server from its

Rmd/nocodb.Rmd

@@ -2754,6 +2754,45 @@ update_tbl_view_col <- function(id_view_col,
 }
 ```
 
+### Grid views
+
+#### `update_grid_view_col`
+
+```{r}
+#' Update NocoDB grid view column
+#'
+#' Updates the metadata of the specified grid view column on a NocoDB server via its
+#' [`PATCH /api/v2/meta/grid-columns/{id_view_col}`](https://meta-apis-v2.nocodb.com/#tag/Views/operation/db-view-grid-column-update) API endpoint.
+#'
+#' @inheritParams update_tbl_view_col
+#' @param order `r pkgsnip::type("int", 1L)`
+#'   A number to assign as the grid view columns's UI order "weight".
+#'
+#' @returns `id_view_col`, invisibly.
+#' @family views
+#' @export
+update_grid_view_col <- function(id_view_col,
+                                 order = NULL,
+                                 origin = funky::config_val("origin"),
+                                 email = funky::config_val("email"),
+                                 password = funky::config_val("password"),
+                                 api_token = funky::config_val("api_token")) {
+  
+  checkmate::assert_number(order,
+                           null.ok = TRUE)
+  
+  api(path = glue::glue("api/v2/meta/grid-columns/{id_view_col}"),
+      method = "PATCH",
+      origin = origin,
+      email = email,
+      password = password,
+      api_token = api_token,
+      body_json = purrr::compact(list(order = order)))
+  
+  invisible(id_view_col)
+}
+```
+
 ### Table columns
 
 #### DESCRIPTION

man/base_ui_acl.Rd

@@ -64,6 +64,8 @@ reference:
   - tbl_view_cols
   - tbl_view_col_id
   - update_tbl_view_col
+- subtitle: Grid views
+- contents: update_grid_view_col
 - subtitle: Table columns
   desc: Functions to manage NocoDB table [columns](https://docs.nocodb.com/category/fields)
     (aka "fields").