R/NotificationsApi.r
In agaveplatform/r-sdk: Agave Platform client SDK for R
# Agave Platform Science API
#
# Power your digital lab and reduce the time from theory to discovery using the Agave Science-as-a-Service API Platform. Agave provides hosted services that allow researchers to manage data, conduct experiments, and publish and share results from anywhere at any time.
#
# Agave Platform version: 2.2.14
#
# Generated by: https://github.com/swagger-api/swagger-codegen.git
#' Under the covers, the Agave API is an event-driven distributed system implemented on top of a reliable, cloud-based messaging system. This means that every action either observed or taken by Agave is tied to an event. The changing of a job from one status to another is an event. The granting of permissions on a file is an event. Editing a piece of metadata is an event, and to be sure, the moment you created an account with Agave was an event. You get the idea.
#'
#' Having such a fine-grain event system is helpful for the same reason that having a fine-grain permission model is helpful. It affords you the highest degree of flexibility and control possible to achieve the behavior you desire. With Agave’s event system, you have the ability to alert your users (or yourself) the instant something occurs. You can be proactive rather than reactive, and you can begin orchestrating your complex tasks in a loosely coupled, asynchronous way.
#'
#' Read more about the Notifications API in the [Agave Developer's Guide](http://docs.agaveplatform.org/#/notifications)
#'
#' @title Agave Notifications API operations
#' @description
#' NotificationsApi Class
#'
#' @section Arguments:
#' \describe{
#'
#' `apiClient` a [rAgave::ApiClient] instance preconfigured to speak to the Agave Platform.
#'
#' `cache` an [rAgave::AgaveCache] instance pointing to the persistent auth cache file on disk.
#'
#' `responseType` the default object type methods of this class should return. Valid values are:
#' * **raw**: the raw JSON string response from the API. You may optionally include
#' `pretty=TRUE` in the method call to receive pretty printed JSON.
#' * **list**: a standard R list object. This is the default value.
#' * **dt**: a data table
#'
#' }
#'
#' @usage
#' notifications <- NotificationsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )
#'
#' @importFrom R6 R6Class
#'
#' @section Methods:
#' \describe{
#'
#' `$addNotification()` Add new notification.
#'
#' **Usage**
#'
#' ```
#' notifications$addNotification$listNotifications(body, naked, )
#' ```
#'
#'
#' `$deleteNotification()` Remove notification from the system.
#'
#' **Usage**
#'
#' ```
#' notifications$deleteNotification$listNotifications(uuid, naked, )
#' ```
#'
#'
#' `$getNotification()` Retrieve notification.
#'
#' **Usage**
#'
#' ```
#' notifications$getNotification$listNotifications(uuid, naked, )
#' ```
#'
#'
#' `$listNotifications()` Retrieve notification for a specific resource.
#'
#' **Usage**
#'
#' ```
#' notifications$listNotifications$listNotifications(associatedUuid, naked, limit, offset, search, )
#' notifications$listNotifications$listNotifications(search=list("foo"="bar"))
#' ```
#'
#'
#' `$updateNotification()` Update existing notification.
#'
#' **Usage**
#'
#' ```
#' notifications$updateNotification$listNotifications(uuid, body, naked, )
#' ```
#'
#' }
#'
#' @name NotificationsApi
#' @seealso [rAgave::ApiClient] [rAgave::Agave] [rAgave::Notification][rAgave::NotificationRequest]
#' @export
NotificationsApi <- R6::R6Class(
'NotificationsApi',
private = list(
userAgent = "Agave-SDK/0.2.0/r",
apiClient = NULL,
responseType = "list",
formatResponse = function(resp, args=list()) {
# read the args from the unnamed request args
if ("responseType" %in% names(args)) {
responseType = args$responseType
}
else {
responseType = NULL
}
if (is.null(responseType) || nchar(responseType) == 0) {
responseType = private$responseType
}
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
logger.debug(jsonlite::toJSON(httr::content(resp,stringsAsFactors = FALSE), auto_unbox=TRUE, null="null", na="null"))
if (responseType == "raw") {
# check for the undeclared pretty attibute to pretty-print the json response
prettyPrint <- ("pretty" %in% names(args) && isTRUE(args$pretty))
jsonlite::toJSON(httr::content(resp, stringsAsFactors = FALSE), auto_unbox=TRUE, null="null", na="null", pretty=prettyPrint)
}
else {
jsonResp <- httr::content(resp)
if ("result" %in% names(jsonResp)) {
jsonResp <- jsonResp$result
}
if ((responseType == "df" || responseType == "dataframe") && length(jsonResp) > 0) {
# lookup properties of object. if null, it's a list. if not null, it's an object
colNames <- names(jsonResp)
if (is.null(colNames)) {
# convert to a list of dataframes
do.call("rbind", lapply(jsonResp, as.data.frame, col.names=factor(names(jsonResp[[1]]))))
}
else {
# convert object to single data frame
as.data.frame(jsonResp)
}
}
else {
jsonResp
}
}
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
logger.warn(jsonlite::toJSON(httr::content(resp, "text", encoding="UTF-8"), auto_unbox=TRUE, null="null", na="null"))
httr::content(resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
logger.warn(jsonlite::toJSON(httr::content(resp, "text", encoding="UTF-8"), auto_unbox=TRUE, null="null", na="null"))
httr::content(resp)
}
}
),
public = list(
initialize = function(apiClient, responseType){
if (!missing(apiClient)) {
private$apiClient <- apiClient
}
else {
private$apiClient <- ApiClient$new()
}
# user can override the global representation in which resources
# responses from this API are returned in when calling methods of
# this class. The same responseType attribute may be passed to any
# public method to override individual calls as well.
if (missing(responseType) || is.null(responseType) || nchar(responseType) == 0) {
# we ignore and use the default
}
else if (responseType != "raw" && responseType != "list" && responseType != "df") {
stop("Invalid responseType. Please specify one of: raw, list, df")
}
else {
# set the response type to the class default to be used
# whenever it is not explicitly set on a request
private$responseType = responseType
}
},
addNotification = function(body, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
if (!missing(`body`)) {
if (!is.list(`body`)) {
body <- `body`$toJSON()
}
} else {
body <- NULL
}
urlPath <- "/notifications/v2/"
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "POST",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
deleteNotification = function(uuid, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
urlPath <- "/notifications/v2/{uuid}"
if (!missing(`uuid`)) {
urlPath <- gsub(paste0("\\{", "uuid", "\\}"), `uuid`, urlPath)
}
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "DELETE",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
getNotification = function(uuid, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
urlPath <- "/notifications/v2/{uuid}"
if (!missing(`uuid`)) {
urlPath <- gsub(paste0("\\{", "uuid", "\\}"), `uuid`, urlPath)
}
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
listNotifications = function(associatedUuid, naked, limit, offset, search, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(search)) {
queryParams <- search
}
if (!missing(`associatedUuid`)) {
queryParams['associatedUuid'] <- associatedUuid
}
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
if (!missing(`limit`)) {
queryParams['limit'] <- limit
}
if (!missing(`offset`)) {
queryParams['offset'] <- offset
}
urlPath <- "/notifications/v2/"
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
updateNotification = function(uuid, body, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
if (!missing(`body`)) {
if (!is.list(`body`)) {
body <- `body`$toJSON()
}
} else {
body <- NULL
}
urlPath <- "/notifications/v2/{uuid}"
if (!missing(`uuid`)) {
urlPath <- gsub(paste0("\\{", "uuid", "\\}"), `uuid`, urlPath)
}
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "POST",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
}
)
)
agaveplatform/r-sdk documentation built on May 13, 2019, 8:20 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
# Agave Platform Science API
#
# Power your digital lab and reduce the time from theory to discovery using the Agave Science-as-a-Service API Platform. Agave provides hosted services that allow researchers to manage data, conduct experiments, and publish and share results from anywhere at any time.
#
# Agave Platform version: 2.2.14
#
# Generated by: https://github.com/swagger-api/swagger-codegen.git
#' Under the covers, the Agave API is an event-driven distributed system implemented on top of a reliable, cloud-based messaging system. This means that every action either observed or taken by Agave is tied to an event. The changing of a job from one status to another is an event. The granting of permissions on a file is an event. Editing a piece of metadata is an event, and to be sure, the moment you created an account with Agave was an event. You get the idea.
#'
#' Having such a fine-grain event system is helpful for the same reason that having a fine-grain permission model is helpful. It affords you the highest degree of flexibility and control possible to achieve the behavior you desire. With Agave’s event system, you have the ability to alert your users (or yourself) the instant something occurs. You can be proactive rather than reactive, and you can begin orchestrating your complex tasks in a loosely coupled, asynchronous way.
#'
#' Read more about the Notifications API in the [Agave Developer's Guide](http://docs.agaveplatform.org/#/notifications)
#'
#' @title Agave Notifications API operations
#' @description
#' NotificationsApi Class
#'
#' @section Arguments:
#' \describe{
#'
#' `apiClient` a [rAgave::ApiClient] instance preconfigured to speak to the Agave Platform.
#'
#' `cache` an [rAgave::AgaveCache] instance pointing to the persistent auth cache file on disk.
#'
#' `responseType` the default object type methods of this class should return. Valid values are:
#' * **raw**: the raw JSON string response from the API. You may optionally include
#' `pretty=TRUE` in the method call to receive pretty printed JSON.
#' * **list**: a standard R list object. This is the default value.
#' * **dt**: a data table
#'
#' }
#'
#' @usage
#' notifications <- NotificationsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )
#'
#' @importFrom R6 R6Class
#'
#' @section Methods:
#' \describe{
#'
#' `$addNotification()` Add new notification.
#'
#' **Usage**
#'
#' ```
#' notifications$addNotification$listNotifications(body, naked, )
#' ```
#'
#'
#' `$deleteNotification()` Remove notification from the system.
#'
#' **Usage**
#'
#' ```
#' notifications$deleteNotification$listNotifications(uuid, naked, )
#' ```
#'
#'
#' `$getNotification()` Retrieve notification.
#'
#' **Usage**
#'
#' ```
#' notifications$getNotification$listNotifications(uuid, naked, )
#' ```
#'
#'
#' `$listNotifications()` Retrieve notification for a specific resource.
#'
#' **Usage**
#'
#' ```
#' notifications$listNotifications$listNotifications(associatedUuid, naked, limit, offset, search, )
#' notifications$listNotifications$listNotifications(search=list("foo"="bar"))
#' ```
#'
#'
#' `$updateNotification()` Update existing notification.
#'
#' **Usage**
#'
#' ```
#' notifications$updateNotification$listNotifications(uuid, body, naked, )
#' ```
#'
#' }
#'
#' @name NotificationsApi
#' @seealso [rAgave::ApiClient] [rAgave::Agave] [rAgave::Notification][rAgave::NotificationRequest]
#' @export
NotificationsApi <- R6::R6Class(
'NotificationsApi',
private = list(
userAgent = "Agave-SDK/0.2.0/r",
apiClient = NULL,
responseType = "list",
formatResponse = function(resp, args=list()) {
# read the args from the unnamed request args
if ("responseType" %in% names(args)) {
responseType = args$responseType
}
else {
responseType = NULL
}
if (is.null(responseType) || nchar(responseType) == 0) {
responseType = private$responseType
}
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
logger.debug(jsonlite::toJSON(httr::content(resp,stringsAsFactors = FALSE), auto_unbox=TRUE, null="null", na="null"))
if (responseType == "raw") {
# check for the undeclared pretty attibute to pretty-print the json response
prettyPrint <- ("pretty" %in% names(args) && isTRUE(args$pretty))
jsonlite::toJSON(httr::content(resp, stringsAsFactors = FALSE), auto_unbox=TRUE, null="null", na="null", pretty=prettyPrint)
}
else {
jsonResp <- httr::content(resp)
if ("result" %in% names(jsonResp)) {
jsonResp <- jsonResp$result
}
if ((responseType == "df" || responseType == "dataframe") && length(jsonResp) > 0) {
# lookup properties of object. if null, it's a list. if not null, it's an object
colNames <- names(jsonResp)
if (is.null(colNames)) {
# convert to a list of dataframes
do.call("rbind", lapply(jsonResp, as.data.frame, col.names=factor(names(jsonResp[[1]]))))
}
else {
# convert object to single data frame
as.data.frame(jsonResp)
}
}
else {
jsonResp
}
}
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
logger.warn(jsonlite::toJSON(httr::content(resp, "text", encoding="UTF-8"), auto_unbox=TRUE, null="null", na="null"))
httr::content(resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
logger.warn(jsonlite::toJSON(httr::content(resp, "text", encoding="UTF-8"), auto_unbox=TRUE, null="null", na="null"))
httr::content(resp)
}
}
),
public = list(
initialize = function(apiClient, responseType){
if (!missing(apiClient)) {
private$apiClient <- apiClient
}
else {
private$apiClient <- ApiClient$new()
}
# user can override the global representation in which resources
# responses from this API are returned in when calling methods of
# this class. The same responseType attribute may be passed to any
# public method to override individual calls as well.
if (missing(responseType) || is.null(responseType) || nchar(responseType) == 0) {
# we ignore and use the default
}
else if (responseType != "raw" && responseType != "list" && responseType != "df") {
stop("Invalid responseType. Please specify one of: raw, list, df")
}
else {
# set the response type to the class default to be used
# whenever it is not explicitly set on a request
private$responseType = responseType
}
},
addNotification = function(body, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
if (!missing(`body`)) {
if (!is.list(`body`)) {
body <- `body`$toJSON()
}
} else {
body <- NULL
}
urlPath <- "/notifications/v2/"
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "POST",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
deleteNotification = function(uuid, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
urlPath <- "/notifications/v2/{uuid}"
if (!missing(`uuid`)) {
urlPath <- gsub(paste0("\\{", "uuid", "\\}"), `uuid`, urlPath)
}
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "DELETE",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
getNotification = function(uuid, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
urlPath <- "/notifications/v2/{uuid}"
if (!missing(`uuid`)) {
urlPath <- gsub(paste0("\\{", "uuid", "\\}"), `uuid`, urlPath)
}
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
listNotifications = function(associatedUuid, naked, limit, offset, search, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(search)) {
queryParams <- search
}
if (!missing(`associatedUuid`)) {
queryParams['associatedUuid'] <- associatedUuid
}
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
if (!missing(`limit`)) {
queryParams['limit'] <- limit
}
if (!missing(`offset`)) {
queryParams['offset'] <- offset
}
urlPath <- "/notifications/v2/"
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
},
updateNotification = function(uuid, body, naked, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`naked`)) {
queryParams['naked'] <- naked
}
if (!missing(`body`)) {
if (!is.list(`body`)) {
body <- `body`$toJSON()
}
} else {
body <- NULL
}
urlPath <- "/notifications/v2/{uuid}"
if (!missing(`uuid`)) {
urlPath <- gsub(paste0("\\{", "uuid", "\\}"), `uuid`, urlPath)
}
resp <- private$apiClient$callApi(url = paste0(private$apiClient$basePath, urlPath),
method = "POST",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
# Send the response to the common filtering method to marshal the
# response into the format requested by the user in the Agave global
# configuration, API class instance, or individual method invocation.
private$formatResponse(resp, args);
}
)
)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.