feat: update data source now

vusaverse · Mar 4, 2024 · 019e472 · 019e472
1 parent 2bbb5a6
commit 019e472
Show file tree

Hide file tree

Showing 42 changed files with 144 additions and 2 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -53,6 +53,7 @@ export(query_user_on_site)
 export(remove_user_from_group)
 export(remove_user_from_site)
 export(run_extract_refresh_task)
+export(update_data_source_now)
 export(update_group)
 export(update_user)
 importFrom(magrittr,"%>%")
diff --git a/R/run_extract_refresh_task.R b/R/run_extract_refresh_task.R
@@ -10,7 +10,7 @@
 #' @export
 #'
 #' @family Tableau REST API
-run_extract_refresh_task <- function(tableau, task_id, api_version = "3.22") {
+run_extract_refresh_task <- function(tableau, task_id, api_version = 3.22) {
   base_url <- tableau$base_url
   token <- tableau$token
   site_id <- tableau$site_id

diff --git a/R/update_data_source_now.R b/R/update_data_source_now.R
@@ -0,0 +1,41 @@
+#' Update Data Source Now
+#'
+#' Runs an extract refresh on the specified data source.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, and `site_id`.
+#' @param datasource_id The ID of the data source to refresh.
+#' @param api_version The API version to use (default: 3.22).
+#'
+#' @return The response from the API.
+#' @export
+#'
+#' @family Tableau REST API
+update_data_source_now <- function(tableau, datasource_id, api_version = 3.22) {
+  base_url <- tableau$base_url
+  token <- tableau$token
+  site_id <- tableau$site_id
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/datasources/",
+    datasource_id,
+    "/refresh"
+  )
+
+  # Construct the request body
+  # The request body is empty as per the requirements
+  request_body <- "<tsRequest></tsRequest>"
+
+  # Make the POST request to the Tableau REST API
+  api_response <- httr::POST(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token),
+    body = request_body
+  )
+
+  return(api_response)
+}
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -40,6 +40,7 @@ reference:
       - download_datasource
       - download_tableau_data
       - get_server_datasources
+      - update_data_source_now
 
   - title: Extract and Encryption Methods
     desc: Extract and encryption methods for Tableau REST API.

diff --git a/man/add_tags_to_view.Rd b/man/add_tags_to_view.Rd
diff --git a/man/add_tags_to_workbook.Rd b/man/add_tags_to_workbook.Rd
diff --git a/man/add_user_to_group.Rd b/man/add_user_to_group.Rd
diff --git a/man/add_user_to_site.Rd b/man/add_user_to_site.Rd
diff --git a/man/authenticate_PAT.Rd b/man/authenticate_PAT.Rd
diff --git a/man/authenticate_server.Rd b/man/authenticate_server.Rd
diff --git a/man/create_group.Rd b/man/create_group.Rd
diff --git a/man/delete_group.Rd b/man/delete_group.Rd
diff --git a/man/download_datasource.Rd b/man/download_datasource.Rd
diff --git a/man/download_filtered_tableau_image.Rd b/man/download_filtered_tableau_image.Rd
diff --git a/man/download_tableau_crosstab_excel.Rd b/man/download_tableau_crosstab_excel.Rd
diff --git a/man/download_tableau_data.Rd b/man/download_tableau_data.Rd
diff --git a/man/download_workbooks_server.Rd b/man/download_workbooks_server.Rd
diff --git a/man/download_workbooks_server_pdf.Rd b/man/download_workbooks_server_pdf.Rd
diff --git a/man/download_workbooks_server_powerpoint.Rd b/man/download_workbooks_server_powerpoint.Rd
diff --git a/man/get_groups_for_user.Rd b/man/get_groups_for_user.Rd
diff --git a/man/get_mobile_security_settings.Rd b/man/get_mobile_security_settings.Rd
diff --git a/man/get_server_connected_apps.Rd b/man/get_server_connected_apps.Rd
diff --git a/man/get_server_datasources.Rd b/man/get_server_datasources.Rd
diff --git a/man/get_server_groups.Rd b/man/get_server_groups.Rd
diff --git a/man/get_server_info.Rd b/man/get_server_info.Rd
diff --git a/man/get_server_jobs.Rd b/man/get_server_jobs.Rd
diff --git a/man/get_server_projects.Rd b/man/get_server_projects.Rd
diff --git a/man/get_server_refresh_tasks.Rd b/man/get_server_refresh_tasks.Rd
diff --git a/man/get_server_schedules.Rd b/man/get_server_schedules.Rd
diff --git a/man/get_server_user_favorites.Rd b/man/get_server_user_favorites.Rd
diff --git a/man/get_server_users.Rd b/man/get_server_users.Rd
diff --git a/man/get_server_views.Rd b/man/get_server_views.Rd
diff --git a/man/get_server_workbooks.Rd b/man/get_server_workbooks.Rd
diff --git a/man/get_table_assets.Rd b/man/get_table_assets.Rd
diff --git a/man/get_users_in_group.Rd b/man/get_users_in_group.Rd
diff --git a/man/query_user_on_site.Rd b/man/query_user_on_site.Rd
diff --git a/man/remove_user_from_group.Rd b/man/remove_user_from_group.Rd
diff --git a/man/remove_user_from_site.Rd b/man/remove_user_from_site.Rd
diff --git a/man/run_extract_refresh_task.Rd b/man/run_extract_refresh_task.Rd