В пакет добавлена функци ac_get_user_groups(), позволяющая запрашив…

…ать метаданные групп пользователей.

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: ractivecampaign
 Type: Package
 Title: Loading Data from 'ActiveCampaign API v3'
-Version: 0.3.0.9000
+Version: 0.5.0
 Authors@R: 
     c(person(given  = "Alexey",
              family = "Seleznev",
@@ -17,4 +17,4 @@ Imports: dplyr, httr, pbapply, stringr, tidyr, cli, retry
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.3

NAMESPACE

@@ -16,6 +16,7 @@ export(ac_get_messages)
 export(ac_get_deal_piplines)
 export(ac_get_deal_activities)
 export(ac_get_users)
+export(ac_get_user_groups)
 export(ac_get_contact_tags)
 export(ac_get_tags)
 export(ac_get_tasks)

NEWS.md

@@ -1,4 +1,8 @@
-# ractivecampaign (development version)
+# ractivecampaign 0.5.0
+
+* В пакет добавлена функци `ac_get_user_groups()`, позволяющая запрашивать метаданные групп пользователей. 
+
+# ractivecampaign 0.4.0
 
 * В функции `ac_get_deal_activities()` исправлена ошибка возникающая если по сделки не было никаких действий.
 

R/ac_get_user_groups.R

@@ -0,0 +1,59 @@
+#' Return list of all existing user groups
+#'
+#' @return tibble with users group metadata
+#' @export
+#' @seealso See \href{https://developers.activecampaign.com/reference/list-all-groups}{ActiveCampaign API documentation}
+#'
+#' @examples
+#' \dontrun{
+#' users <- ac_get_users()
+#' }
+ac_get_user_groups <- function() {
+
+  ac_check_auth()
+
+  # vars
+  is_first_iteration <- TRUE
+  limit  <- 100
+  offset <- 0
+  total  <- NA
+  res    <- list()
+
+  while ( (is.na(total) | offset <= total) | is_first_iteration ) {
+
+    # send request
+    retry(
+      {
+        ans <- GET(str_glue("{Sys.getenv('ACTIVECAMPAGN_API_URL')}/api/3/groups/"),
+                   query = list(limit  = limit,
+                                offset = offset),
+                   add_headers("Api-Token" = Sys.getenv('ACTIVECAMPAGN_API_TOKEN')))
+      },
+      until = ~ status_code(.) == 200,
+      interval  = getOption('ractivecampaig.interval'),
+      max_tries = getOption('ractivecampaig.max_tries')
+    )
+
+    data <- content(ans)
+
+    if ( status_code(ans) > 299 ) {
+      stop(data$message)
+    }
+
+    out_data <- tibble(data = data$groups) %>%
+      unnest_wider(data)
+
+    is_first_iteration <- FALSE
+    offset <- offset + limit
+    total  <- as.numeric(data$meta$total)
+    res <- append(res, list(out_data))
+
+    Sys.sleep(0.25)
+
+  }
+
+  res <- bind_rows(res)
+
+  return(res)
+
+}

README.md

@@ -18,6 +18,7 @@
 * `ac_get_deal_activities()` - Список активностей по сделке
 * `ac_get_deal_notes()` - Список заметок к сделке
 * `ac_get_users()` - Список пользователей
+* `ac_get_user_groups()` - Список групп пользователей
 * `ac_get_tags()` - Получить список всех созданных тегов
 * `ac_get_contacts()` - Список контактов
 * `ac_get_custom_contact_fields_values()` - Значения пользовательских полей контактов