| Title: | Official R Client for the 'Sybilion' API |
|---|---|
| Description: | Wrapper and generated client for the 'Sybilion' Developers Portal API (forecasts, drivers, catalog, usage). Authenticate with an API key using 'Authorization: Bearer'. See <https://sybilion.dev/docs/>. |
| Authors: | Sybilion [aut, cre, cph] |
| Maintainer: | Sybilion <[email protected]> |
| License: | Apache License (>= 2) |
| Version: | 0.1.0 |
| Built: | 2026-07-17 17:00:56 UTC |
| Source: | https://github.com/cran/sybilion |
A single alert returned by the upstream Recommend service.
AlertItemV1 Class
An R6Class generator object
Create a new AlertItemV1
nameHuman-readable name of the dataset or index that triggered the alert. character [optional]
newsRelated news articles driving this alert. list(NewsItemV1) [optional]
pct_changePercentage change that triggered the alert (negative = decline, positive = surge). numeric [optional]
trendingWhether this alert is currently trending across the platform. character [optional]
AlertItemV1$new()Initialize a new AlertItemV1 class.
AlertItemV1$new( name = NULL, news = NULL, pct_change = NULL, trending = NULL, ... )
nameHuman-readable name of the dataset or index that triggered the alert.
newsRelated news articles driving this alert.
pct_changePercentage change that triggered the alert (negative = decline, positive = surge).
trendingWhether this alert is currently trending across the platform.
...Other optional arguments.
AlertItemV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
AlertItemV1$toList()
AlertItemV1 as a base R list.
# convert array of AlertItemV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
AlertItemV1$toSimpleType()Convert AlertItemV1 to a base R type
AlertItemV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
AlertItemV1$fromJSON()Deserialize JSON string into an instance of AlertItemV1
AlertItemV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of AlertItemV1
AlertItemV1$toJSONString()To JSON String
AlertItemV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
AlertItemV1 in JSON format
AlertItemV1$fromJSONString()Deserialize JSON string into an instance of AlertItemV1
AlertItemV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of AlertItemV1
AlertItemV1$validateJSON()Validate JSON input with respect to AlertItemV1 and throw an exception if invalid
AlertItemV1$validateJSON(input)
inputthe JSON input
AlertItemV1$toString()To string (JSON format)
AlertItemV1$toString()
String representation of AlertItemV1
AlertItemV1$isValid()Return true if the values in all fields are valid.
AlertItemV1$isValid()
true if the values in all fields are valid.
AlertItemV1$getInvalidFields()Return a list of invalid fields (if any).
AlertItemV1$getInvalidFields()
A list of invalid fields (if any).
AlertItemV1$print()Print the object
AlertItemV1$print()
AlertItemV1$clone()The objects of this class are cloneable with this method.
AlertItemV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `AlertItemV1$toList()` ## ------------------------------------------------ # convert array of AlertItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `AlertItemV1$toList()` ## ------------------------------------------------ # convert array of AlertItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Body of 'POST /api/v1/alerts'. 'filters.limit' controls how many alerts are returned (default **100**, max **1000**). 'date_from' / 'date_to' are optional date bounds (YYYY-MM-DD).
AlertsRequestV1 Class
An R6Class generator object
Create a new AlertsRequestV1
context_enrichedWhen true, treat the supplied metadata as already context-enriched. character
date_fromOptional start date bound for alert detection (YYYY-MM-DD). character [optional]
date_toOptional end date bound for alert detection (YYYY-MM-DD). character [optional]
filtersOptional. 'limit' controls the number of alerts returned (**0–1000**, default **100**). 'categories[]' and 'regions[]' narrow the alert universe; each must be an integer **1–9999**. Values are not verified against catalog APIs. Filters [optional]
metadataAlertsRequestV1$new()Initialize a new AlertsRequestV1 class.
AlertsRequestV1$new( context_enriched, metadata, date_from = NULL, date_to = NULL, filters = NULL, ... )
context_enrichedWhen true, treat the supplied metadata as already context-enriched.
metadatametadata
date_fromOptional start date bound for alert detection (YYYY-MM-DD).
date_toOptional end date bound for alert detection (YYYY-MM-DD).
filtersOptional. 'limit' controls the number of alerts returned (**0–1000**, default **100**). 'categories[]' and 'regions[]' narrow the alert universe; each must be an integer **1–9999**. Values are not verified against catalog APIs.
...Other optional arguments.
AlertsRequestV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
AlertsRequestV1$toList()
AlertsRequestV1 as a base R list.
# convert array of AlertsRequestV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
AlertsRequestV1$toSimpleType()Convert AlertsRequestV1 to a base R type
AlertsRequestV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
AlertsRequestV1$fromJSON()Deserialize JSON string into an instance of AlertsRequestV1
AlertsRequestV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of AlertsRequestV1
AlertsRequestV1$toJSONString()To JSON String
AlertsRequestV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
AlertsRequestV1 in JSON format
AlertsRequestV1$fromJSONString()Deserialize JSON string into an instance of AlertsRequestV1
AlertsRequestV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of AlertsRequestV1
AlertsRequestV1$validateJSON()Validate JSON input with respect to AlertsRequestV1 and throw an exception if invalid
AlertsRequestV1$validateJSON(input)
inputthe JSON input
AlertsRequestV1$toString()To string (JSON format)
AlertsRequestV1$toString()
String representation of AlertsRequestV1
AlertsRequestV1$isValid()Return true if the values in all fields are valid.
AlertsRequestV1$isValid()
true if the values in all fields are valid.
AlertsRequestV1$getInvalidFields()Return a list of invalid fields (if any).
AlertsRequestV1$getInvalidFields()
A list of invalid fields (if any).
AlertsRequestV1$print()Print the object
AlertsRequestV1$print()
AlertsRequestV1$clone()The objects of this class are cloneable with this method.
AlertsRequestV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `AlertsRequestV1$toList()` ## ------------------------------------------------ # convert array of AlertsRequestV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `AlertsRequestV1$toList()` ## ------------------------------------------------ # convert array of AlertsRequestV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Base class used by models that may carry additional properties beyond their declared fields (OpenAPI 'anyType' / free-form schemas).
AnyType$print()Print the object as JSON.
AnyType$print()
AnyType$toJSONString()Serialize to a JSON string.
AnyType$toJSONString(...)
AnyType$toSimpleType()Convert to a base R type.
AnyType$toSimpleType()
AnyType$toList()Convert to list (alias for toSimpleType).
AnyType$toList()
AnyType$fromJSON()Deserialize from a JSON string.
AnyType$fromJSON(input_json)
AnyType$fromJSONString()Deserialize from a JSON string (alias).
AnyType$fromJSONString(input_json)
AnyType$clone()The objects of this class are cloneable with this method.
AnyType$clone(deep = FALSE)
deepWhether to make a deep clone.
ApiClient Class
An R6Class generator object
Sybilion API
The Sybilion API powers the Sybilion Developers Portal: forecasts, drivers, catalog, account and usage. Authenticate every request with 'Authorization: Bearer <token>' using either an API key created in the Developers Portal or an Auth0 access token from your dashboard session.
The version of the OpenAPI document: 0.1.0 Generated by: https://openapi-generator.tech
ApiClient Class
Generic API client for OpenAPI client library builds. OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI Generator templates.
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). Ref: https://openapi-generator.tech Do not edit the class manually.
base_pathBase url
user_agentDefault user agent
default_headersDefault headers
usernameUsername for HTTP basic authentication
passwordPassword for HTTP basic authentication
api_keysAPI keys
bearer_tokenBearer token
timeoutDefault timeout in seconds
retry_status_codesvector of status codes to retry
max_retry_attemptsmaximum number of retries for the status codes
ApiClient$new()Initialize a new ApiClient.
ApiClient$new( base_path = NULL, user_agent = NULL, default_headers = NULL, username = NULL, password = NULL, api_keys = NULL, access_token = NULL, bearer_token = NULL, timeout = NULL, retry_status_codes = NULL, max_retry_attempts = NULL )
base_pathBase path.
user_agentUser agent.
default_headersDefault headers.
usernameUser name.
passwordPassword.
api_keysAPI keys.
access_tokenAccess token.
bearer_tokenBearer token.
timeoutTimeout.
retry_status_codesStatus codes for retry.
max_retry_attemptsMaximum number of retry.
ApiClient$CallApi()Prepare to make an API call with the retry logic.
ApiClient$CallApi( url, method, query_params, header_params, form_params, file_params, accepts, content_types, body, stream_callback = NULL, ... )
urlURL.
methodHTTP method.
query_paramsThe query parameters.
header_paramsThe header parameters.
form_paramsThe form parameters.
file_paramsThe form parameters for uploading files.
acceptsThe list of Accept headers.
content_typesThe list of Content-Type headers.
bodyThe HTTP request body.
stream_callbackCallback function to process the data stream
...Other optional arguments.
HTTP response
ApiClient$Execute()Make an API call
ApiClient$Execute( url, method, query_params, header_params, form_params, file_params, accepts, content_types, body, stream_callback = NULL, ... )
urlURL.
methodHTTP method.
query_paramsThe query parameters.
header_paramsThe header parameters.
form_paramsThe form parameters.
file_paramsThe form parameters for uploading files.
acceptsThe list of Accept headers
content_typesThe list of Content-Type headers
bodyThe HTTP request body.
stream_callbackCallback function to process data stream
...Other optional arguments.
HTTP response
ApiClient$deserialize()Deserialize the content of API response to the given type.
ApiClient$deserialize(raw_response, return_type, pkg_env)
raw_responseRaw response.
return_typeR return type.
pkg_envPackage environment.
Deserialized object.
ApiClient$deserializeObj()Deserialize the response from jsonlite object based on the given type by handling complex and nested types by iterating recursively Example return_types will be like "array[integer]", "map(Pet)", "array[map(Tag)]", etc.,
ApiClient$deserializeObj(obj, return_type, pkg_env)
objResponse object.
return_typeR return type.
pkg_envPackage environment.
Deserialized object.
ApiClient$select_header()Return a property header (for accept or content-type). If JSON-related MIME is found, return it. Otherwise, return the first one, if any.
ApiClient$select_header(headers)
headersA list of headers
A header (e.g. 'application/json')
ApiClient$DeserializeResponse()Deserialize the response
ApiClient$DeserializeResponse(local_var_resp, return_type = NULL)
local_var_respThe API response
return_typeThe target return type for the endpoint (e.g., '"object"'). If 'NULL' text will be left as-is.
If the raw response is corecable to text, return the text. Otherwise return the raw response.
ApiClient$WriteFile()Write response to a file
The function will write out data.
1. If binary data is detected it will use 'writeBin' 2. If the raw response is coercible to text, the text will be written to a file 3. If the raw response is not coercible to text, the raw response will be written
ApiClient$WriteFile(local_var_resp, file)
local_var_respThe API response
fileThe name of the data file to save the result
ApiClient$IsBinary()Check response for binary content
ApiClient$IsBinary(x)
local_var_respThe API response
ApiClient$clone()The objects of this class are cloneable with this method.
ApiClient$clone(deep = FALSE)
deepWhether to make a deep clone.
ApiResponse Class
An R6Class generator object
Sybilion API
The Sybilion API powers the Sybilion Developers Portal: forecasts, drivers, catalog, account and usage. Authenticate every request with 'Authorization: Bearer <token>' using either an API key created in the Developers Portal or an Auth0 access token from your dashboard session.
The version of the OpenAPI document: 0.1.0 Generated by: https://openapi-generator.tech
contentThe deserialized response body.
responseThe raw response from the endpoint.
status_codeThe HTTP response status code.
status_code_descThe brief description of the HTTP response status code.
headersThe HTTP response headers.
ApiResponse$new()Initialize a new ApiResponse class.
ApiResponse$new( content = NULL, response = NULL, status_code = NULL, status_code_desc = NULL, headers = NULL )
contentThe deserialized response body.
responseThe raw response from the endpoint.
status_codeThe HTTP response status code.
status_code_descThe brief description of the HTTP response status code.
headersThe HTTP response headers.
ApiResponse$response_as_text()The response is stored as a raw vector. Use this to access the response after converting it to text. If the response is not coercible to text NA is returned.
ApiResponse$response_as_text(from_encoding = "", to_encoding = "UTF-8")
from_encodingThe encoding of the raw response.
to_encodingThe target encoding of the return value.
ApiResponse$clone()The objects of this class are cloneable with this method.
ApiResponse$clone(deep = FALSE)
deepWhether to make a deep clone.
ApiV1AlertsPost200Response Class
ApiV1AlertsPost200Response Class
An R6Class generator object
Create a new ApiV1AlertsPost200Response
alertslist(AlertItemV1) [optional]
ApiV1AlertsPost200Response$new()Initialize a new ApiV1AlertsPost200Response class.
ApiV1AlertsPost200Response$new(alerts = NULL, ...)
alertsalerts
...Other optional arguments.
ApiV1AlertsPost200Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1AlertsPost200Response$toList()
ApiV1AlertsPost200Response as a base R list.
# convert array of ApiV1AlertsPost200Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1AlertsPost200Response$toSimpleType()Convert ApiV1AlertsPost200Response to a base R type
ApiV1AlertsPost200Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1AlertsPost200Response$fromJSON()Deserialize JSON string into an instance of ApiV1AlertsPost200Response
ApiV1AlertsPost200Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1AlertsPost200Response
ApiV1AlertsPost200Response$toJSONString()To JSON String
ApiV1AlertsPost200Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1AlertsPost200Response in JSON format
ApiV1AlertsPost200Response$fromJSONString()Deserialize JSON string into an instance of ApiV1AlertsPost200Response
ApiV1AlertsPost200Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1AlertsPost200Response
ApiV1AlertsPost200Response$validateJSON()Validate JSON input with respect to ApiV1AlertsPost200Response and throw an exception if invalid
ApiV1AlertsPost200Response$validateJSON(input)
inputthe JSON input
ApiV1AlertsPost200Response$toString()To string (JSON format)
ApiV1AlertsPost200Response$toString()
String representation of ApiV1AlertsPost200Response
ApiV1AlertsPost200Response$isValid()Return true if the values in all fields are valid.
ApiV1AlertsPost200Response$isValid()
true if the values in all fields are valid.
ApiV1AlertsPost200Response$getInvalidFields()Return a list of invalid fields (if any).
ApiV1AlertsPost200Response$getInvalidFields()
A list of invalid fields (if any).
ApiV1AlertsPost200Response$print()Print the object
ApiV1AlertsPost200Response$print()
ApiV1AlertsPost200Response$clone()The objects of this class are cloneable with this method.
ApiV1AlertsPost200Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1AlertsPost200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1AlertsPost200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1AlertsPost200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1AlertsPost200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ApiV1DriversPost200Response Class
ApiV1DriversPost200Response Class
An R6Class generator object
Create a new ApiV1DriversPost200Response
dataApiV1DriversPost200ResponseData [optional]
messagecharacter [optional]
statusinteger [optional]
ApiV1DriversPost200Response$new()Initialize a new ApiV1DriversPost200Response class.
ApiV1DriversPost200Response$new( data = NULL, message = NULL, status = NULL, ... )
datadata
messagemessage
statusstatus
...Other optional arguments.
ApiV1DriversPost200Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1DriversPost200Response$toList()
ApiV1DriversPost200Response as a base R list.
# convert array of ApiV1DriversPost200Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1DriversPost200Response$toSimpleType()Convert ApiV1DriversPost200Response to a base R type
ApiV1DriversPost200Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1DriversPost200Response$fromJSON()Deserialize JSON string into an instance of ApiV1DriversPost200Response
ApiV1DriversPost200Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1DriversPost200Response
ApiV1DriversPost200Response$toJSONString()To JSON String
ApiV1DriversPost200Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1DriversPost200Response in JSON format
ApiV1DriversPost200Response$fromJSONString()Deserialize JSON string into an instance of ApiV1DriversPost200Response
ApiV1DriversPost200Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1DriversPost200Response
ApiV1DriversPost200Response$validateJSON()Validate JSON input with respect to ApiV1DriversPost200Response and throw an exception if invalid
ApiV1DriversPost200Response$validateJSON(input)
inputthe JSON input
ApiV1DriversPost200Response$toString()To string (JSON format)
ApiV1DriversPost200Response$toString()
String representation of ApiV1DriversPost200Response
ApiV1DriversPost200Response$isValid()Return true if the values in all fields are valid.
ApiV1DriversPost200Response$isValid()
true if the values in all fields are valid.
ApiV1DriversPost200Response$getInvalidFields()Return a list of invalid fields (if any).
ApiV1DriversPost200Response$getInvalidFields()
A list of invalid fields (if any).
ApiV1DriversPost200Response$print()Print the object
ApiV1DriversPost200Response$print()
ApiV1DriversPost200Response$clone()The objects of this class are cloneable with this method.
ApiV1DriversPost200Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1DriversPost200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1DriversPost200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1DriversPost200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1DriversPost200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ApiV1DriversPost200ResponseData Class
ApiV1DriversPost200ResponseData Class
An R6Class generator object
Create a new ApiV1DriversPost200ResponseData
driverslist(DriverItemV1) [optional]
ApiV1DriversPost200ResponseData$new()Initialize a new ApiV1DriversPost200ResponseData class.
ApiV1DriversPost200ResponseData$new(drivers = NULL, ...)
driversdrivers
...Other optional arguments.
ApiV1DriversPost200ResponseData$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1DriversPost200ResponseData$toList()
ApiV1DriversPost200ResponseData as a base R list.
# convert array of ApiV1DriversPost200ResponseData (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1DriversPost200ResponseData$toSimpleType()Convert ApiV1DriversPost200ResponseData to a base R type
ApiV1DriversPost200ResponseData$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1DriversPost200ResponseData$fromJSON()Deserialize JSON string into an instance of ApiV1DriversPost200ResponseData
ApiV1DriversPost200ResponseData$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1DriversPost200ResponseData
ApiV1DriversPost200ResponseData$toJSONString()To JSON String
ApiV1DriversPost200ResponseData$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1DriversPost200ResponseData in JSON format
ApiV1DriversPost200ResponseData$fromJSONString()Deserialize JSON string into an instance of ApiV1DriversPost200ResponseData
ApiV1DriversPost200ResponseData$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1DriversPost200ResponseData
ApiV1DriversPost200ResponseData$validateJSON()Validate JSON input with respect to ApiV1DriversPost200ResponseData and throw an exception if invalid
ApiV1DriversPost200ResponseData$validateJSON(input)
inputthe JSON input
ApiV1DriversPost200ResponseData$toString()To string (JSON format)
ApiV1DriversPost200ResponseData$toString()
String representation of ApiV1DriversPost200ResponseData
ApiV1DriversPost200ResponseData$isValid()Return true if the values in all fields are valid.
ApiV1DriversPost200ResponseData$isValid()
true if the values in all fields are valid.
ApiV1DriversPost200ResponseData$getInvalidFields()Return a list of invalid fields (if any).
ApiV1DriversPost200ResponseData$getInvalidFields()
A list of invalid fields (if any).
ApiV1DriversPost200ResponseData$print()Print the object
ApiV1DriversPost200ResponseData$print()
ApiV1DriversPost200ResponseData$clone()The objects of this class are cloneable with this method.
ApiV1DriversPost200ResponseData$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1DriversPost200ResponseData$toList()` ## ------------------------------------------------ # convert array of ApiV1DriversPost200ResponseData (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1DriversPost200ResponseData$toList()` ## ------------------------------------------------ # convert array of ApiV1DriversPost200ResponseData (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ApiV1ForecastsIdGet200Response Class
ApiV1ForecastsIdGet200Response Class
An R6Class generator object
Create a new ApiV1ForecastsIdGet200Response
artifactsList of output files available for download. Populated once the job completes. list(ForecastArtifactMeta) [optional]
job_idcharacter [optional]
pipeline_errorStructured error from the pipeline for failed or canceled jobs; null otherwise. Common fields: 'code' (string error code) and 'detail' (human-readable explanation). Shape is defined by the pipeline and may vary. object [optional]
settledTrue once the job has reached a terminal state and the charge has been posted. character [optional]
statusCurrent lifecycle state of the job. character [optional]
ApiV1ForecastsIdGet200Response$new()Initialize a new ApiV1ForecastsIdGet200Response class.
ApiV1ForecastsIdGet200Response$new( artifacts = NULL, job_id = NULL, pipeline_error = NULL, settled = NULL, status = NULL, ... )
artifactsList of output files available for download. Populated once the job completes.
job_idjob_id
pipeline_errorStructured error from the pipeline for failed or canceled jobs; null otherwise. Common fields: 'code' (string error code) and 'detail' (human-readable explanation). Shape is defined by the pipeline and may vary.
settledTrue once the job has reached a terminal state and the charge has been posted.
statusCurrent lifecycle state of the job.
...Other optional arguments.
ApiV1ForecastsIdGet200Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1ForecastsIdGet200Response$toList()
ApiV1ForecastsIdGet200Response as a base R list.
# convert array of ApiV1ForecastsIdGet200Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1ForecastsIdGet200Response$toSimpleType()Convert ApiV1ForecastsIdGet200Response to a base R type
ApiV1ForecastsIdGet200Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1ForecastsIdGet200Response$fromJSON()Deserialize JSON string into an instance of ApiV1ForecastsIdGet200Response
ApiV1ForecastsIdGet200Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1ForecastsIdGet200Response
ApiV1ForecastsIdGet200Response$toJSONString()To JSON String
ApiV1ForecastsIdGet200Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1ForecastsIdGet200Response in JSON format
ApiV1ForecastsIdGet200Response$fromJSONString()Deserialize JSON string into an instance of ApiV1ForecastsIdGet200Response
ApiV1ForecastsIdGet200Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1ForecastsIdGet200Response
ApiV1ForecastsIdGet200Response$validateJSON()Validate JSON input with respect to ApiV1ForecastsIdGet200Response and throw an exception if invalid
ApiV1ForecastsIdGet200Response$validateJSON(input)
inputthe JSON input
ApiV1ForecastsIdGet200Response$toString()To string (JSON format)
ApiV1ForecastsIdGet200Response$toString()
String representation of ApiV1ForecastsIdGet200Response
ApiV1ForecastsIdGet200Response$isValid()Return true if the values in all fields are valid.
ApiV1ForecastsIdGet200Response$isValid()
true if the values in all fields are valid.
ApiV1ForecastsIdGet200Response$getInvalidFields()Return a list of invalid fields (if any).
ApiV1ForecastsIdGet200Response$getInvalidFields()
A list of invalid fields (if any).
ApiV1ForecastsIdGet200Response$print()Print the object
ApiV1ForecastsIdGet200Response$print()
ApiV1ForecastsIdGet200Response$clone()The objects of this class are cloneable with this method.
ApiV1ForecastsIdGet200Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1ForecastsIdGet200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1ForecastsIdGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1ForecastsIdGet200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1ForecastsIdGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ApiV1ForecastsPost202Response Class
ApiV1ForecastsPost202Response Class
An R6Class generator object
Create a new ApiV1ForecastsPost202Response
job_idUnique job id — use this to poll status and download artifacts. character [optional]
poll_urlConvenience URL for polling this job's status. character [optional]
run_idInternal run identifier (opaque; useful for support). character [optional]
workflowInternal workflow identifier (opaque; useful for support). character [optional]
ApiV1ForecastsPost202Response$new()Initialize a new ApiV1ForecastsPost202Response class.
ApiV1ForecastsPost202Response$new( job_id = NULL, poll_url = NULL, run_id = NULL, workflow = NULL, ... )
job_idUnique job id — use this to poll status and download artifacts.
poll_urlConvenience URL for polling this job's status.
run_idInternal run identifier (opaque; useful for support).
workflowInternal workflow identifier (opaque; useful for support).
...Other optional arguments.
ApiV1ForecastsPost202Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1ForecastsPost202Response$toList()
ApiV1ForecastsPost202Response as a base R list.
# convert array of ApiV1ForecastsPost202Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1ForecastsPost202Response$toSimpleType()Convert ApiV1ForecastsPost202Response to a base R type
ApiV1ForecastsPost202Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1ForecastsPost202Response$fromJSON()Deserialize JSON string into an instance of ApiV1ForecastsPost202Response
ApiV1ForecastsPost202Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1ForecastsPost202Response
ApiV1ForecastsPost202Response$toJSONString()To JSON String
ApiV1ForecastsPost202Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1ForecastsPost202Response in JSON format
ApiV1ForecastsPost202Response$fromJSONString()Deserialize JSON string into an instance of ApiV1ForecastsPost202Response
ApiV1ForecastsPost202Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1ForecastsPost202Response
ApiV1ForecastsPost202Response$validateJSON()Validate JSON input with respect to ApiV1ForecastsPost202Response and throw an exception if invalid
ApiV1ForecastsPost202Response$validateJSON(input)
inputthe JSON input
ApiV1ForecastsPost202Response$toString()To string (JSON format)
ApiV1ForecastsPost202Response$toString()
String representation of ApiV1ForecastsPost202Response
ApiV1ForecastsPost202Response$isValid()Return true if the values in all fields are valid.
ApiV1ForecastsPost202Response$isValid()
true if the values in all fields are valid.
ApiV1ForecastsPost202Response$getInvalidFields()Return a list of invalid fields (if any).
ApiV1ForecastsPost202Response$getInvalidFields()
A list of invalid fields (if any).
ApiV1ForecastsPost202Response$print()Print the object
ApiV1ForecastsPost202Response$print()
ApiV1ForecastsPost202Response$clone()The objects of this class are cloneable with this method.
ApiV1ForecastsPost202Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1ForecastsPost202Response$toList()` ## ------------------------------------------------ # convert array of ApiV1ForecastsPost202Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1ForecastsPost202Response$toList()` ## ------------------------------------------------ # convert array of ApiV1ForecastsPost202Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ApiV1JobsGet200Response Class
ApiV1JobsGet200Response Class
An R6Class generator object
Create a new ApiV1JobsGet200Response
jobslist(JobSummary)
paginationApiV1JobsGet200Response$new()Initialize a new ApiV1JobsGet200Response class.
ApiV1JobsGet200Response$new(jobs, pagination, ...)
jobsjobs
paginationpagination
...Other optional arguments.
ApiV1JobsGet200Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1JobsGet200Response$toList()
ApiV1JobsGet200Response as a base R list.
# convert array of ApiV1JobsGet200Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1JobsGet200Response$toSimpleType()Convert ApiV1JobsGet200Response to a base R type
ApiV1JobsGet200Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1JobsGet200Response$fromJSON()Deserialize JSON string into an instance of ApiV1JobsGet200Response
ApiV1JobsGet200Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1JobsGet200Response
ApiV1JobsGet200Response$toJSONString()To JSON String
ApiV1JobsGet200Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1JobsGet200Response in JSON format
ApiV1JobsGet200Response$fromJSONString()Deserialize JSON string into an instance of ApiV1JobsGet200Response
ApiV1JobsGet200Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1JobsGet200Response
ApiV1JobsGet200Response$validateJSON()Validate JSON input with respect to ApiV1JobsGet200Response and throw an exception if invalid
ApiV1JobsGet200Response$validateJSON(input)
inputthe JSON input
ApiV1JobsGet200Response$toString()To string (JSON format)
ApiV1JobsGet200Response$toString()
String representation of ApiV1JobsGet200Response
ApiV1JobsGet200Response$isValid()Return true if the values in all fields are valid.
ApiV1JobsGet200Response$isValid()
true if the values in all fields are valid.
ApiV1JobsGet200Response$getInvalidFields()Return a list of invalid fields (if any).
ApiV1JobsGet200Response$getInvalidFields()
A list of invalid fields (if any).
ApiV1JobsGet200Response$print()Print the object
ApiV1JobsGet200Response$print()
ApiV1JobsGet200Response$clone()The objects of this class are cloneable with this method.
ApiV1JobsGet200Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1JobsGet200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1JobsGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1JobsGet200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1JobsGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ApiV1UsageGet200Response Class
ApiV1UsageGet200Response Class
An R6Class generator object
Create a new ApiV1UsageGet200Response
paginationusage_eventslist(UsageEvent)
ApiV1UsageGet200Response$new()Initialize a new ApiV1UsageGet200Response class.
ApiV1UsageGet200Response$new(pagination, usage_events, ...)
paginationpagination
usage_eventsusage_events
...Other optional arguments.
ApiV1UsageGet200Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ApiV1UsageGet200Response$toList()
ApiV1UsageGet200Response as a base R list.
# convert array of ApiV1UsageGet200Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ApiV1UsageGet200Response$toSimpleType()Convert ApiV1UsageGet200Response to a base R type
ApiV1UsageGet200Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ApiV1UsageGet200Response$fromJSON()Deserialize JSON string into an instance of ApiV1UsageGet200Response
ApiV1UsageGet200Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of ApiV1UsageGet200Response
ApiV1UsageGet200Response$toJSONString()To JSON String
ApiV1UsageGet200Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ApiV1UsageGet200Response in JSON format
ApiV1UsageGet200Response$fromJSONString()Deserialize JSON string into an instance of ApiV1UsageGet200Response
ApiV1UsageGet200Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ApiV1UsageGet200Response
ApiV1UsageGet200Response$validateJSON()Validate JSON input with respect to ApiV1UsageGet200Response and throw an exception if invalid
ApiV1UsageGet200Response$validateJSON(input)
inputthe JSON input
ApiV1UsageGet200Response$toString()To string (JSON format)
ApiV1UsageGet200Response$toString()
String representation of ApiV1UsageGet200Response
ApiV1UsageGet200Response$isValid()Return true if the values in all fields are valid.
ApiV1UsageGet200Response$isValid()
true if the values in all fields are valid.
ApiV1UsageGet200Response$getInvalidFields()Return a list of invalid fields (if any).
ApiV1UsageGet200Response$getInvalidFields()
A list of invalid fields (if any).
ApiV1UsageGet200Response$print()Print the object
ApiV1UsageGet200Response$print()
ApiV1UsageGet200Response$clone()The objects of this class are cloneable with this method.
ApiV1UsageGet200Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ApiV1UsageGet200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1UsageGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ApiV1UsageGet200Response$toList()` ## ------------------------------------------------ # convert array of ApiV1UsageGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
AutoRechargeState Class
AutoRechargeState Class
An R6Class generator object
Create a new AutoRechargeState
below_eur_centsWhen the available balance drops below this many EUR cents, a recharge is triggered. integer
enabledWhether auto-recharge is active for this account. character
has_stripe_customerWhether a Stripe customer record exists (required for auto-recharge to run). character
meter_centsEUR cents charged via auto-recharge in the current UTC calendar month. integer
meter_monthUTC month start for 'meter_cents'; null if no auto-recharge has run this month. character [optional]
monthly_cap_centsMaximum EUR cents that may be charged via auto-recharge per UTC calendar month. 0 = no cap. integer
target_eur_centsBalance target after a successful recharge, in EUR cents. integer
AutoRechargeState$new()Initialize a new AutoRechargeState class.
AutoRechargeState$new( below_eur_cents, enabled, has_stripe_customer, meter_cents, monthly_cap_cents, target_eur_cents, meter_month = NULL, ... )
below_eur_centsWhen the available balance drops below this many EUR cents, a recharge is triggered.
enabledWhether auto-recharge is active for this account.
has_stripe_customerWhether a Stripe customer record exists (required for auto-recharge to run).
meter_centsEUR cents charged via auto-recharge in the current UTC calendar month.
monthly_cap_centsMaximum EUR cents that may be charged via auto-recharge per UTC calendar month. 0 = no cap.
target_eur_centsBalance target after a successful recharge, in EUR cents.
meter_monthUTC month start for 'meter_cents'; null if no auto-recharge has run this month.
...Other optional arguments.
AutoRechargeState$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
AutoRechargeState$toList()
AutoRechargeState as a base R list.
# convert array of AutoRechargeState (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
AutoRechargeState$toSimpleType()Convert AutoRechargeState to a base R type
AutoRechargeState$toSimpleType()
A base R type, e.g. a list or numeric/character array.
AutoRechargeState$fromJSON()Deserialize JSON string into an instance of AutoRechargeState
AutoRechargeState$fromJSON(input_json)
input_jsonthe JSON input
the instance of AutoRechargeState
AutoRechargeState$toJSONString()To JSON String
AutoRechargeState$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
AutoRechargeState in JSON format
AutoRechargeState$fromJSONString()Deserialize JSON string into an instance of AutoRechargeState
AutoRechargeState$fromJSONString(input_json)
input_jsonthe JSON input
the instance of AutoRechargeState
AutoRechargeState$validateJSON()Validate JSON input with respect to AutoRechargeState and throw an exception if invalid
AutoRechargeState$validateJSON(input)
inputthe JSON input
AutoRechargeState$toString()To string (JSON format)
AutoRechargeState$toString()
String representation of AutoRechargeState
AutoRechargeState$isValid()Return true if the values in all fields are valid.
AutoRechargeState$isValid()
true if the values in all fields are valid.
AutoRechargeState$getInvalidFields()Return a list of invalid fields (if any).
AutoRechargeState$getInvalidFields()
A list of invalid fields (if any).
AutoRechargeState$print()Print the object
AutoRechargeState$print()
AutoRechargeState$clone()The objects of this class are cloneable with this method.
AutoRechargeState$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `AutoRechargeState$toList()` ## ------------------------------------------------ # convert array of AutoRechargeState (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `AutoRechargeState$toList()` ## ------------------------------------------------ # convert array of AutoRechargeState (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
A single thematic category returned by GET /api/v1/categories.
CategoryItemV1 Class
An R6Class generator object
Create a new CategoryItemV1
idInteger identifier. Use this value in filters.categories[]. integer
nameHuman-readable category label. character
CategoryItemV1$new()Initialize a new CategoryItemV1 class.
CategoryItemV1$new(id, name, ...)
idInteger identifier. Use this value in filters.categories[].
nameHuman-readable category label.
...Other optional arguments.
CategoryItemV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
CategoryItemV1$toList()
CategoryItemV1 as a base R list.
# convert array of CategoryItemV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
CategoryItemV1$toSimpleType()Convert CategoryItemV1 to a base R type
CategoryItemV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
CategoryItemV1$fromJSON()Deserialize JSON string into an instance of CategoryItemV1
CategoryItemV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of CategoryItemV1
CategoryItemV1$toJSONString()To JSON String
CategoryItemV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
CategoryItemV1 in JSON format
CategoryItemV1$fromJSONString()Deserialize JSON string into an instance of CategoryItemV1
CategoryItemV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of CategoryItemV1
CategoryItemV1$validateJSON()Validate JSON input with respect to CategoryItemV1 and throw an exception if invalid
CategoryItemV1$validateJSON(input)
inputthe JSON input
CategoryItemV1$toString()To string (JSON format)
CategoryItemV1$toString()
String representation of CategoryItemV1
CategoryItemV1$isValid()Return true if the values in all fields are valid.
CategoryItemV1$isValid()
true if the values in all fields are valid.
CategoryItemV1$getInvalidFields()Return a list of invalid fields (if any).
CategoryItemV1$getInvalidFields()
A list of invalid fields (if any).
CategoryItemV1$print()Print the object
CategoryItemV1$print()
CategoryItemV1$clone()The objects of this class are cloneable with this method.
CategoryItemV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `CategoryItemV1$toList()` ## ------------------------------------------------ # convert array of CategoryItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `CategoryItemV1$toList()` ## ------------------------------------------------ # convert array of CategoryItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
CategoryListResponse Class
CategoryListResponse Class
An R6Class generator object
Create a new CategoryListResponse
itemsComplete category listing, sorted by id ascending. No pagination. list(CategoryItemV1)
CategoryListResponse$new()Initialize a new CategoryListResponse class.
CategoryListResponse$new(items, ...)
itemsComplete category listing, sorted by id ascending. No pagination.
...Other optional arguments.
CategoryListResponse$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
CategoryListResponse$toList()
CategoryListResponse as a base R list.
# convert array of CategoryListResponse (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
CategoryListResponse$toSimpleType()Convert CategoryListResponse to a base R type
CategoryListResponse$toSimpleType()
A base R type, e.g. a list or numeric/character array.
CategoryListResponse$fromJSON()Deserialize JSON string into an instance of CategoryListResponse
CategoryListResponse$fromJSON(input_json)
input_jsonthe JSON input
the instance of CategoryListResponse
CategoryListResponse$toJSONString()To JSON String
CategoryListResponse$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
CategoryListResponse in JSON format
CategoryListResponse$fromJSONString()Deserialize JSON string into an instance of CategoryListResponse
CategoryListResponse$fromJSONString(input_json)
input_jsonthe JSON input
the instance of CategoryListResponse
CategoryListResponse$validateJSON()Validate JSON input with respect to CategoryListResponse and throw an exception if invalid
CategoryListResponse$validateJSON(input)
inputthe JSON input
CategoryListResponse$toString()To string (JSON format)
CategoryListResponse$toString()
String representation of CategoryListResponse
CategoryListResponse$isValid()Return true if the values in all fields are valid.
CategoryListResponse$isValid()
true if the values in all fields are valid.
CategoryListResponse$getInvalidFields()Return a list of invalid fields (if any).
CategoryListResponse$getInvalidFields()
A list of invalid fields (if any).
CategoryListResponse$print()Print the object
CategoryListResponse$print()
CategoryListResponse$clone()The objects of this class are cloneable with this method.
CategoryListResponse$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `CategoryListResponse$toList()` ## ------------------------------------------------ # convert array of CategoryListResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `CategoryListResponse$toList()` ## ------------------------------------------------ # convert array of CategoryListResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Wraps the generated 'DefaultApi' client with base URL resolution and Bearer authentication.
Client$new()Client$new( token = NULL, base_url = NULL, api_key = NULL, api_url = NULL, user_agent = "sybilion-r/0.1.0" )
tokenBearer credential (API key or session token). Use 'api_key' as an alias.
base_urlOptional API origin; use 'api_url' as an alias.
api_keyAlias for 'token' (backward compatibility).
api_urlAlias for 'base_url' (backward compatibility).
user_agentOptional user agent string. Get the current authenticated user and account balances. List all available thematic categories. List all available geographic regions. Recommend driver datasets for a given timeseries.
Client$get_me()Client$get_me()
Client$list_categories()Client$list_categories()
Client$list_regions()Client$list_regions()
Client$recommend_drivers()Client$recommend_drivers(request)
requestA RecommendRequestV1 object. Submit a forecast job.
Client$submit_forecast()Client$submit_forecast(request)
requestA ForecastRequestV1 object. Get the status of a forecast job.
Client$get_forecast()Client$get_forecast(id)
idForecast job UUID. Download a forecast artifact to a local file.
Client$download_artifact()Client$download_artifact(id, name, path)
idForecast job UUID.
nameArtifact name (e.g. "forecast.json").
pathLocal file path to write the artifact to. List async jobs for the current user (one page).
Client$list_jobs()Client$list_jobs( page = 1, limit = 50, sort = "created_at", order = "desc", status = NULL, pipeline_type = NULL )
pagePage number (1-indexed).
limitResults per page (1-200).
sortSort column.
order"asc" or "desc".
statusOptional status filter.
pipeline_typeOptional pipeline type filter. List usage/billing events for the current user (one page).
Client$list_usage()Client$list_usage(page = 1, limit = 50, sort = "id", order = "desc")
pagePage number (1-indexed).
limitResults per page (1-200).
sortSort column.
order"asc" or "desc". Check API health. Fetch all async jobs across all pages.
Client$get_health()Client$get_health()
Client$list_all_jobs()Client$list_all_jobs( sort = "created_at", order = "desc", status = NULL, pipeline_type = NULL )
sortSort column.
order"asc" or "desc".
statusOptional status filter.
pipeline_typeOptional pipeline type filter. Fetch all usage/billing events across all pages.
Client$list_all_usage()Client$list_all_usage(sort = "id", order = "desc")
sortSort column.
order"asc" or "desc". Poll a forecast job until it is settled or the timeout is reached.
Client$wait_forecast()Client$wait_forecast(job_id, poll_s = 2, timeout_s = 3600)
job_idForecast job UUID.
poll_sPoll interval in seconds.
timeout_sTimeout in seconds. Iterate usage pages with a callback (same contract as Go/Python iterators).
Client$iter_usage_pages()Client$iter_usage_pages(callback, sort = "id", order = "desc", limit = 50)
callbackFunction called once for each page response. Iterate job pages with a callback.
Client$iter_jobs_pages()Client$iter_jobs_pages( callback, sort = "created_at", order = "desc", limit = 50, status = NULL, pipeline_type = NULL )
callbackFunction called once for each page response.
Client$clone()The objects of this class are cloneable with this method.
Client$clone(deep = FALSE)
deepWhether to make a deep clone.
Default public Sybilion API base URL when no explicit URL or environment override is set.
DEFAULT_PUBLIC_API_BASE_URLDEFAULT_PUBLIC_API_BASE_URL
DefaultApi
An R6Class generator object
Sybilion API
The Sybilion API powers the Sybilion Developers Portal: forecasts, drivers, catalog, account and usage. Authenticate every request with 'Authorization: Bearer <token>' using either an API key created in the Developers Portal or an Auth0 access token from your dashboard session.
The version of the OpenAPI document: 0.1.0 Generated by: https://openapi-generator.tech
api_clientHandles the client-server communication.
DefaultApi$new()Initialize a new DefaultApi.
DefaultApi$new(api_client)
api_clientAn instance of API client.
DefaultApi$ApiV1AlertsPost()Detect anomaly alerts for your timeseries
DefaultApi$ApiV1AlertsPost(alerts_request_v1, data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
ApiV1AlertsPost200Response
DefaultApi$ApiV1AlertsPostWithHttpInfo()Detect anomaly alerts for your timeseries
DefaultApi$ApiV1AlertsPostWithHttpInfo( alerts_request_v1, data_file = NULL, ... )
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (ApiV1AlertsPost200Response) with additional information such as HTTP status code, headers
DefaultApi$ApiV1CategoriesGet()List available thematic categories
DefaultApi$ApiV1CategoriesGet(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
CategoryListResponse
DefaultApi$ApiV1CategoriesGetWithHttpInfo()List available thematic categories
DefaultApi$ApiV1CategoriesGetWithHttpInfo(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (CategoryListResponse) with additional information such as HTTP status code, headers
DefaultApi$ApiV1DriversPost()Rank driver datasets for your timeseries
DefaultApi$ApiV1DriversPost(recommend_request_v1, data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
ApiV1DriversPost200Response
DefaultApi$ApiV1DriversPostWithHttpInfo()Rank driver datasets for your timeseries
DefaultApi$ApiV1DriversPostWithHttpInfo( recommend_request_v1, data_file = NULL, ... )
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (ApiV1DriversPost200Response) with additional information such as HTTP status code, headers
DefaultApi$ApiV1ForecastsIdArtifactsNameGet()Download a forecast output file
DefaultApi$ApiV1ForecastsIdArtifactsNameGet(id, name, data_file = NULL, ...)
idForecast job id.
nameArtifact filename (e.g. 'forecast.json').
data_file(optional) name of the data file to save the result
...Other optional arguments
data.frame
DefaultApi$ApiV1ForecastsIdArtifactsNameGetWithHttpInfo()Download a forecast output file
DefaultApi$ApiV1ForecastsIdArtifactsNameGetWithHttpInfo( id, name, data_file = NULL, ... )
idForecast job id.
nameArtifact filename (e.g. 'forecast.json').
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (data.frame) with additional information such as HTTP status code, headers
DefaultApi$ApiV1ForecastsIdGet()Poll forecast job status and artifact list
DefaultApi$ApiV1ForecastsIdGet(id, data_file = NULL, ...)
idForecast job id returned by 'POST /api/v1/forecasts'.
data_file(optional) name of the data file to save the result
...Other optional arguments
ApiV1ForecastsIdGet200Response
DefaultApi$ApiV1ForecastsIdGetWithHttpInfo()Poll forecast job status and artifact list
DefaultApi$ApiV1ForecastsIdGetWithHttpInfo(id, data_file = NULL, ...)
idForecast job id returned by 'POST /api/v1/forecasts'.
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (ApiV1ForecastsIdGet200Response) with additional information such as HTTP status code, headers
DefaultApi$ApiV1ForecastsPost()Submit an async forecast job
DefaultApi$ApiV1ForecastsPost(forecast_request_v1, data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
ApiV1ForecastsPost202Response
DefaultApi$ApiV1ForecastsPostWithHttpInfo()Submit an async forecast job
DefaultApi$ApiV1ForecastsPostWithHttpInfo( forecast_request_v1, data_file = NULL, ... )
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (ApiV1ForecastsPost202Response) with additional information such as HTTP status code, headers
DefaultApi$ApiV1JobsGet()List your async jobs
DefaultApi$ApiV1JobsGet( page = 1, limit = 50, sort = "created_at", order = "desc", status = NULL, pipeline_type = NULL, data_file = NULL, ... )
page(optional) 1-indexed page number. (default value: 1)
limit(optional) Page size. Capped at 200. (default value: 50)
sort(optional) Column to sort by. (default value: "created_at")
order(optional) Sort direction. (default value: "desc")
status(optional) Filter to jobs in this status.
pipeline_type(optional) Filter to jobs of this pipeline type (currently only 'forecast' is emitted).
data_file(optional) name of the data file to save the result
...Other optional arguments
ApiV1JobsGet200Response
DefaultApi$ApiV1JobsGetWithHttpInfo()List your async jobs
DefaultApi$ApiV1JobsGetWithHttpInfo( page = 1, limit = 50, sort = "created_at", order = "desc", status = NULL, pipeline_type = NULL, data_file = NULL, ... )
page(optional) 1-indexed page number. (default value: 1)
limit(optional) Page size. Capped at 200. (default value: 50)
sort(optional) Column to sort by. (default value: "created_at")
order(optional) Sort direction. (default value: "desc")
status(optional) Filter to jobs in this status.
pipeline_type(optional) Filter to jobs of this pipeline type (currently only 'forecast' is emitted).
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (ApiV1JobsGet200Response) with additional information such as HTTP status code, headers
DefaultApi$ApiV1MeGet()Account snapshot — balance, tier, and credit tranches
DefaultApi$ApiV1MeGet(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
MeResponse
DefaultApi$ApiV1MeGetWithHttpInfo()Account snapshot — balance, tier, and credit tranches
DefaultApi$ApiV1MeGetWithHttpInfo(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (MeResponse) with additional information such as HTTP status code, headers
DefaultApi$ApiV1RegionsGet()List available geographic regions
DefaultApi$ApiV1RegionsGet(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
RegionListResponse
DefaultApi$ApiV1RegionsGetWithHttpInfo()List available geographic regions
DefaultApi$ApiV1RegionsGetWithHttpInfo(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (RegionListResponse) with additional information such as HTTP status code, headers
DefaultApi$ApiV1UsageGet()Billing history (paginated usage events)
DefaultApi$ApiV1UsageGet( page = 1, limit = 50, sort = "id", order = "desc", data_file = NULL, ... )
page(optional) 1-indexed page number. (default value: 1)
limit(optional) Page size. Capped at 200. (default value: 50)
sort(optional) Column to sort by. (default value: "id")
order(optional) Sort direction. (default value: "desc")
data_file(optional) name of the data file to save the result
...Other optional arguments
ApiV1UsageGet200Response
DefaultApi$ApiV1UsageGetWithHttpInfo()Billing history (paginated usage events)
DefaultApi$ApiV1UsageGetWithHttpInfo( page = 1, limit = 50, sort = "id", order = "desc", data_file = NULL, ... )
page(optional) 1-indexed page number. (default value: 1)
limit(optional) Page size. Capped at 200. (default value: 50)
sort(optional) Column to sort by. (default value: "id")
order(optional) Sort direction. (default value: "desc")
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (ApiV1UsageGet200Response) with additional information such as HTTP status code, headers
DefaultApi$HealthGet()Service health check
DefaultApi$HealthGet(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
HealthGet200Response
DefaultApi$HealthGetWithHttpInfo()Service health check
DefaultApi$HealthGetWithHttpInfo(data_file = NULL, ...)
data_file(optional) name of the data file to save the result
...Other optional arguments
API response (HealthGet200Response) with additional information such as HTTP status code, headers
DefaultApi$clone()The objects of this class are cloneable with this method.
DefaultApi$clone(deep = FALSE)
deepWhether to make a deep clone.
## Not run: api <- DefaultApi$new() api$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN") api$HealthGet() ## End(Not run)## Not run: api <- DefaultApi$new() api$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN") api$HealthGet() ## End(Not run)
A ranked dataset candidate returned by 'POST /api/v1/drivers'.
DriverItemV1 Class
An R6Class generator object
Create a new DriverItemV1
driver_nameHuman-readable name of the dataset. character [optional]
hash_idStable identifier for the dataset; use to reference this driver across requests. character [optional]
scoreRelevance score indicating how well this dataset explains your timeseries (higher is more relevant). numeric [optional]
DriverItemV1$new()Initialize a new DriverItemV1 class.
DriverItemV1$new(driver_name = NULL, hash_id = NULL, score = NULL, ...)
driver_nameHuman-readable name of the dataset.
hash_idStable identifier for the dataset; use to reference this driver across requests.
scoreRelevance score indicating how well this dataset explains your timeseries (higher is more relevant).
...Other optional arguments.
DriverItemV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
DriverItemV1$toList()
DriverItemV1 as a base R list.
# convert array of DriverItemV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
DriverItemV1$toSimpleType()Convert DriverItemV1 to a base R type
DriverItemV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
DriverItemV1$fromJSON()Deserialize JSON string into an instance of DriverItemV1
DriverItemV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of DriverItemV1
DriverItemV1$toJSONString()To JSON String
DriverItemV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
DriverItemV1 in JSON format
DriverItemV1$fromJSONString()Deserialize JSON string into an instance of DriverItemV1
DriverItemV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of DriverItemV1
DriverItemV1$validateJSON()Validate JSON input with respect to DriverItemV1 and throw an exception if invalid
DriverItemV1$validateJSON(input)
inputthe JSON input
DriverItemV1$toString()To string (JSON format)
DriverItemV1$toString()
String representation of DriverItemV1
DriverItemV1$isValid()Return true if the values in all fields are valid.
DriverItemV1$isValid()
true if the values in all fields are valid.
DriverItemV1$getInvalidFields()Return a list of invalid fields (if any).
DriverItemV1$getInvalidFields()
A list of invalid fields (if any).
DriverItemV1$print()Print the object
DriverItemV1$print()
DriverItemV1$clone()The objects of this class are cloneable with this method.
DriverItemV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `DriverItemV1$toList()` ## ------------------------------------------------ # convert array of DriverItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `DriverItemV1$toList()` ## ------------------------------------------------ # convert array of DriverItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ErrorMessage Class
ErrorMessage Class
An R6Class generator object
Create a new ErrorMessage
errorHuman-readable error message. character
ErrorMessage$new()Initialize a new ErrorMessage class.
ErrorMessage$new(error, ...)
errorHuman-readable error message.
...Other optional arguments.
ErrorMessage$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ErrorMessage$toList()
ErrorMessage as a base R list.
# convert array of ErrorMessage (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ErrorMessage$toSimpleType()Convert ErrorMessage to a base R type
ErrorMessage$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ErrorMessage$fromJSON()Deserialize JSON string into an instance of ErrorMessage
ErrorMessage$fromJSON(input_json)
input_jsonthe JSON input
the instance of ErrorMessage
ErrorMessage$toJSONString()To JSON String
ErrorMessage$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ErrorMessage in JSON format
ErrorMessage$fromJSONString()Deserialize JSON string into an instance of ErrorMessage
ErrorMessage$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ErrorMessage
ErrorMessage$validateJSON()Validate JSON input with respect to ErrorMessage and throw an exception if invalid
ErrorMessage$validateJSON(input)
inputthe JSON input
ErrorMessage$toString()To string (JSON format)
ErrorMessage$toString()
String representation of ErrorMessage
ErrorMessage$isValid()Return true if the values in all fields are valid.
ErrorMessage$isValid()
true if the values in all fields are valid.
ErrorMessage$getInvalidFields()Return a list of invalid fields (if any).
ErrorMessage$getInvalidFields()
A list of invalid fields (if any).
ErrorMessage$print()Print the object
ErrorMessage$print()
ErrorMessage$clone()The objects of this class are cloneable with this method.
ErrorMessage$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ErrorMessage$toList()` ## ------------------------------------------------ # convert array of ErrorMessage (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ErrorMessage$toList()` ## ------------------------------------------------ # convert array of ErrorMessage (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
EuroTranche Class
EuroTranche Class
An R6Class generator object
Create a new EuroTranche
created_atcharacter
expires_atcharacter
idcharacter
initial_eur_centsinteger
remaining_eur_centsinteger
sourceOne of signup_trial, stripe, partner, legacy. Other labels may appear for custom grants. character
EuroTranche$new()Initialize a new EuroTranche class.
EuroTranche$new( created_at, expires_at, id, initial_eur_cents, remaining_eur_cents, source, ... )
created_atcreated_at
expires_atexpires_at
idid
initial_eur_centsinitial_eur_cents
remaining_eur_centsremaining_eur_cents
sourceOne of signup_trial, stripe, partner, legacy. Other labels may appear for custom grants.
...Other optional arguments.
EuroTranche$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
EuroTranche$toList()
EuroTranche as a base R list.
# convert array of EuroTranche (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
EuroTranche$toSimpleType()Convert EuroTranche to a base R type
EuroTranche$toSimpleType()
A base R type, e.g. a list or numeric/character array.
EuroTranche$fromJSON()Deserialize JSON string into an instance of EuroTranche
EuroTranche$fromJSON(input_json)
input_jsonthe JSON input
the instance of EuroTranche
EuroTranche$toJSONString()To JSON String
EuroTranche$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
EuroTranche in JSON format
EuroTranche$fromJSONString()Deserialize JSON string into an instance of EuroTranche
EuroTranche$fromJSONString(input_json)
input_jsonthe JSON input
the instance of EuroTranche
EuroTranche$validateJSON()Validate JSON input with respect to EuroTranche and throw an exception if invalid
EuroTranche$validateJSON(input)
inputthe JSON input
EuroTranche$toString()To string (JSON format)
EuroTranche$toString()
String representation of EuroTranche
EuroTranche$isValid()Return true if the values in all fields are valid.
EuroTranche$isValid()
true if the values in all fields are valid.
EuroTranche$getInvalidFields()Return a list of invalid fields (if any).
EuroTranche$getInvalidFields()
A list of invalid fields (if any).
EuroTranche$print()Print the object
EuroTranche$print()
EuroTranche$clone()The objects of this class are cloneable with this method.
EuroTranche$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `EuroTranche$toList()` ## ------------------------------------------------ # convert array of EuroTranche (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `EuroTranche$toList()` ## ------------------------------------------------ # convert array of EuroTranche (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Optional narrowing for forecast, drivers, and alerts requests. Category and region ids must fall in **1–9999**. Discover valid ids via 'GET /api/v1/regions' and 'GET /api/v1/categories' — submitted ids are not cross-checked on submit.
Filters Class
An R6Class generator object
Create a new Filters
categoriesThematic category ids to filter by; each must be an integer **1–9999** inclusive. list(integer) [optional]
limitMaximum number of items to return. When omitted, a per-environment default is applied (100 by default). The maximum accepted value is operator-configurable (default 1000). integer [optional]
regionsGeographic region ids to filter by; each must be an integer **1–9999** inclusive. list(integer) [optional]
Filters$new()Initialize a new Filters class.
Filters$new(categories = NULL, limit = NULL, regions = NULL, ...)
categoriesThematic category ids to filter by; each must be an integer **1–9999** inclusive.
limitMaximum number of items to return. When omitted, a per-environment default is applied (100 by default). The maximum accepted value is operator-configurable (default 1000).
regionsGeographic region ids to filter by; each must be an integer **1–9999** inclusive.
...Other optional arguments.
Filters$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
Filters$toList()
Filters as a base R list.
# convert array of Filters (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
Filters$toSimpleType()Convert Filters to a base R type
Filters$toSimpleType()
A base R type, e.g. a list or numeric/character array.
Filters$fromJSON()Deserialize JSON string into an instance of Filters
Filters$fromJSON(input_json)
input_jsonthe JSON input
the instance of Filters
Filters$toJSONString()To JSON String
Filters$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
Filters in JSON format
Filters$fromJSONString()Deserialize JSON string into an instance of Filters
Filters$fromJSONString(input_json)
input_jsonthe JSON input
the instance of Filters
Filters$validateJSON()Validate JSON input with respect to Filters and throw an exception if invalid
Filters$validateJSON(input)
inputthe JSON input
Filters$toString()To string (JSON format)
Filters$toString()
String representation of Filters
Filters$isValid()Return true if the values in all fields are valid.
Filters$isValid()
true if the values in all fields are valid.
Filters$getInvalidFields()Return a list of invalid fields (if any).
Filters$getInvalidFields()
A list of invalid fields (if any).
Filters$print()Print the object
Filters$print()
Filters$clone()The objects of this class are cloneable with this method.
Filters$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `Filters$toList()` ## ------------------------------------------------ # convert array of Filters (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `Filters$toList()` ## ------------------------------------------------ # convert array of Filters (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Metadata for a single output file produced by a completed forecast job.
ForecastArtifactMeta Class
An R6Class generator object
Create a new ForecastArtifactMeta
content_typeMIME type of the artifact (e.g. 'application/json'). character [optional]
hrefRelative URL to stream via 'GET /api/v1/forecasts/<id>/artifacts/<name>'. character [optional]
nameArtifact filename (e.g. 'forecast.json', 'backtest_metrics.json'). character [optional]
sizeFile size in bytes. integer [optional]
ForecastArtifactMeta$new()Initialize a new ForecastArtifactMeta class.
ForecastArtifactMeta$new( content_type = NULL, href = NULL, name = NULL, size = NULL, ... )
content_typeMIME type of the artifact (e.g. 'application/json').
hrefRelative URL to stream via 'GET /api/v1/forecasts/<id>/artifacts/<name>'.
nameArtifact filename (e.g. 'forecast.json', 'backtest_metrics.json').
sizeFile size in bytes.
...Other optional arguments.
ForecastArtifactMeta$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ForecastArtifactMeta$toList()
ForecastArtifactMeta as a base R list.
# convert array of ForecastArtifactMeta (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ForecastArtifactMeta$toSimpleType()Convert ForecastArtifactMeta to a base R type
ForecastArtifactMeta$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ForecastArtifactMeta$fromJSON()Deserialize JSON string into an instance of ForecastArtifactMeta
ForecastArtifactMeta$fromJSON(input_json)
input_jsonthe JSON input
the instance of ForecastArtifactMeta
ForecastArtifactMeta$toJSONString()To JSON String
ForecastArtifactMeta$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ForecastArtifactMeta in JSON format
ForecastArtifactMeta$fromJSONString()Deserialize JSON string into an instance of ForecastArtifactMeta
ForecastArtifactMeta$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ForecastArtifactMeta
ForecastArtifactMeta$validateJSON()Validate JSON input with respect to ForecastArtifactMeta and throw an exception if invalid
ForecastArtifactMeta$validateJSON(input)
inputthe JSON input
ForecastArtifactMeta$toString()To string (JSON format)
ForecastArtifactMeta$toString()
String representation of ForecastArtifactMeta
ForecastArtifactMeta$isValid()Return true if the values in all fields are valid.
ForecastArtifactMeta$isValid()
true if the values in all fields are valid.
ForecastArtifactMeta$getInvalidFields()Return a list of invalid fields (if any).
ForecastArtifactMeta$getInvalidFields()
A list of invalid fields (if any).
ForecastArtifactMeta$print()Print the object
ForecastArtifactMeta$print()
ForecastArtifactMeta$clone()The objects of this class are cloneable with this method.
ForecastArtifactMeta$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ForecastArtifactMeta$toList()` ## ------------------------------------------------ # convert array of ForecastArtifactMeta (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ForecastArtifactMeta$toList()` ## ------------------------------------------------ # convert array of ForecastArtifactMeta (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Body of 'POST /api/v1/forecasts'. Submit a monthly timeseries and the pipeline produces a forward forecast (and optionally a backtest). At least one of 'soft_horizon' or 'hard_horizon' must be present. The timeseries must contain at least 60 monthly observations (5 years) aligned to the first of each month (YYYY-MM-01). 'recency_factor' controls how strongly the driver-selection step weights recent data.
ForecastRequestV1 Class
An R6Class generator object
Create a new ForecastRequestV1
backtestWhen true, run a backtest evaluation alongside the forecast and include 'backtest_metrics.json' and 'backtest_trajectories.json' in the artifacts. character [optional]
filtersOptional. Each **'categories[]'** and **'regions[]'** entry must be an integer **1–9999** (inclusive). Optional **'limit'** is **0–1000** (default **100** when omitted). Values are not verified against catalog APIs. Filters [optional]
frequencySeries cadence. Only 'monthly' is currently supported. character
hard_horizonMinimum acceptable horizon (months) for the quality step-down ladder. When omitted, the pipeline falls back to a driverless forecast at 'soft_horizon' if no quality run succeeds. When still failing at 'hard_horizon', the pipeline emits a driverless forecast at that horizon. At least one of 'soft_horizon' or 'hard_horizon' must be present. When both are set, 'hard_horizon' must be strictly less than 'soft_horizon'. Maximum 12. integer [optional]
pipeline_versionPipeline version. Closed set — only 'v1' is supported today. character
recency_factorWeight given to more recent observations when selecting drivers. 0.0 = equal weight across the full history; 1.0 = strongest recency bias. numeric
soft_horizonIdeal forecast horizon (months). The pipeline tries this first, then steps down by one month until it reaches 'hard_horizon' (when set) while seeking a quality forecast. At least one of 'soft_horizon' or 'hard_horizon' must be present. When both are set, 'hard_horizon' must be strictly less than 'soft_horizon'. Maximum 12. integer [optional]
strictly_positiveWhen true, every value in 'timeseries' must be '>= 0'; a single negative observation rejects the request with 422. The pipeline also clamps output values at zero. Defaults to false. character [optional]
timeseriesMap of YYYY-MM-DD date keys to numeric observation values. Must contain at least 60 monthly observations (5 years of history) aligned to the first of each month. named list(numeric)
timeseries_metadataDescribes the series so the pipeline can identify relevant drivers. TimeseriesMetadata
ForecastRequestV1$new()Initialize a new ForecastRequestV1 class.
ForecastRequestV1$new( frequency, pipeline_version, recency_factor, timeseries, timeseries_metadata, backtest = NULL, filters = NULL, hard_horizon = NULL, soft_horizon = NULL, strictly_positive = FALSE, ... )
frequencySeries cadence. Only 'monthly' is currently supported.
pipeline_versionPipeline version. Closed set — only 'v1' is supported today.
recency_factorWeight given to more recent observations when selecting drivers. 0.0 = equal weight across the full history; 1.0 = strongest recency bias.
timeseriesMap of YYYY-MM-DD date keys to numeric observation values. Must contain at least 60 monthly observations (5 years of history) aligned to the first of each month.
timeseries_metadataDescribes the series so the pipeline can identify relevant drivers.
backtestWhen true, run a backtest evaluation alongside the forecast and include 'backtest_metrics.json' and 'backtest_trajectories.json' in the artifacts.
filtersOptional. Each **'categories[]'** and **'regions[]'** entry must be an integer **1–9999** (inclusive). Optional **'limit'** is **0–1000** (default **100** when omitted). Values are not verified against catalog APIs.
hard_horizonMinimum acceptable horizon (months) for the quality step-down ladder. When omitted, the pipeline falls back to a driverless forecast at 'soft_horizon' if no quality run succeeds. When still failing at 'hard_horizon', the pipeline emits a driverless forecast at that horizon. At least one of 'soft_horizon' or 'hard_horizon' must be present. When both are set, 'hard_horizon' must be strictly less than 'soft_horizon'. Maximum 12.
soft_horizonIdeal forecast horizon (months). The pipeline tries this first, then steps down by one month until it reaches 'hard_horizon' (when set) while seeking a quality forecast. At least one of 'soft_horizon' or 'hard_horizon' must be present. When both are set, 'hard_horizon' must be strictly less than 'soft_horizon'. Maximum 12.
strictly_positiveWhen true, every value in 'timeseries' must be '>= 0'; a single negative observation rejects the request with 422. The pipeline also clamps output values at zero. Defaults to false.. Default to FALSE.
...Other optional arguments.
ForecastRequestV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ForecastRequestV1$toList()
ForecastRequestV1 as a base R list.
# convert array of ForecastRequestV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ForecastRequestV1$toSimpleType()Convert ForecastRequestV1 to a base R type
ForecastRequestV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ForecastRequestV1$fromJSON()Deserialize JSON string into an instance of ForecastRequestV1
ForecastRequestV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of ForecastRequestV1
ForecastRequestV1$toJSONString()To JSON String
ForecastRequestV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ForecastRequestV1 in JSON format
ForecastRequestV1$fromJSONString()Deserialize JSON string into an instance of ForecastRequestV1
ForecastRequestV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ForecastRequestV1
ForecastRequestV1$validateJSON()Validate JSON input with respect to ForecastRequestV1 and throw an exception if invalid
ForecastRequestV1$validateJSON(input)
inputthe JSON input
ForecastRequestV1$toString()To string (JSON format)
ForecastRequestV1$toString()
String representation of ForecastRequestV1
ForecastRequestV1$isValid()Return true if the values in all fields are valid.
ForecastRequestV1$isValid()
true if the values in all fields are valid.
ForecastRequestV1$getInvalidFields()Return a list of invalid fields (if any).
ForecastRequestV1$getInvalidFields()
A list of invalid fields (if any).
ForecastRequestV1$print()Print the object
ForecastRequestV1$print()
ForecastRequestV1$clone()The objects of this class are cloneable with this method.
ForecastRequestV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ForecastRequestV1$toList()` ## ------------------------------------------------ # convert array of ForecastRequestV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ForecastRequestV1$toList()` ## ------------------------------------------------ # convert array of ForecastRequestV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
HealthGet200Response Class
HealthGet200Response Class
An R6Class generator object
Create a new HealthGet200Response
statusOverall health — \"ok\" when all components are healthy, \"degraded\" otherwise. character [optional]
componentsPer-component status map. Keys are functional names (e.g. data_storage, workflow_engine). named list(HealthGet200ResponseComponentsValue) [optional]
HealthGet200Response$new()Initialize a new HealthGet200Response class.
HealthGet200Response$new(status = NULL, components = NULL, ...)
statusOverall health — \"ok\" when all components are healthy, \"degraded\" otherwise.
componentsPer-component status map. Keys are functional names (e.g. data_storage, workflow_engine).
...Other optional arguments.
HealthGet200Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
HealthGet200Response$toList()
HealthGet200Response as a base R list.
# convert array of HealthGet200Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
HealthGet200Response$toSimpleType()Convert HealthGet200Response to a base R type
HealthGet200Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
HealthGet200Response$fromJSON()Deserialize JSON string into an instance of HealthGet200Response
HealthGet200Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of HealthGet200Response
HealthGet200Response$toJSONString()To JSON String
HealthGet200Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
HealthGet200Response in JSON format
HealthGet200Response$fromJSONString()Deserialize JSON string into an instance of HealthGet200Response
HealthGet200Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of HealthGet200Response
HealthGet200Response$validateJSON()Validate JSON input with respect to HealthGet200Response and throw an exception if invalid
HealthGet200Response$validateJSON(input)
inputthe JSON input
HealthGet200Response$toString()To string (JSON format)
HealthGet200Response$toString()
String representation of HealthGet200Response
HealthGet200Response$isValid()Return true if the values in all fields are valid.
HealthGet200Response$isValid()
true if the values in all fields are valid.
HealthGet200Response$getInvalidFields()Return a list of invalid fields (if any).
HealthGet200Response$getInvalidFields()
A list of invalid fields (if any).
HealthGet200Response$print()Print the object
HealthGet200Response$print()
HealthGet200Response$clone()The objects of this class are cloneable with this method.
HealthGet200Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `HealthGet200Response$toList()` ## ------------------------------------------------ # convert array of HealthGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `HealthGet200Response$toList()` ## ------------------------------------------------ # convert array of HealthGet200Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
HealthGet200ResponseComponentsValue Class
HealthGet200ResponseComponentsValue Class
An R6Class generator object
Create a new HealthGet200ResponseComponentsValue
statuscharacter [optional]
HealthGet200ResponseComponentsValue$new()Initialize a new HealthGet200ResponseComponentsValue class.
HealthGet200ResponseComponentsValue$new(status = NULL, ...)
statusstatus
...Other optional arguments.
HealthGet200ResponseComponentsValue$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
HealthGet200ResponseComponentsValue$toList()
HealthGet200ResponseComponentsValue as a base R list.
# convert array of HealthGet200ResponseComponentsValue (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
HealthGet200ResponseComponentsValue$toSimpleType()Convert HealthGet200ResponseComponentsValue to a base R type
HealthGet200ResponseComponentsValue$toSimpleType()
A base R type, e.g. a list or numeric/character array.
HealthGet200ResponseComponentsValue$fromJSON()Deserialize JSON string into an instance of HealthGet200ResponseComponentsValue
HealthGet200ResponseComponentsValue$fromJSON(input_json)
input_jsonthe JSON input
the instance of HealthGet200ResponseComponentsValue
HealthGet200ResponseComponentsValue$toJSONString()To JSON String
HealthGet200ResponseComponentsValue$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
HealthGet200ResponseComponentsValue in JSON format
HealthGet200ResponseComponentsValue$fromJSONString()Deserialize JSON string into an instance of HealthGet200ResponseComponentsValue
HealthGet200ResponseComponentsValue$fromJSONString(input_json)
input_jsonthe JSON input
the instance of HealthGet200ResponseComponentsValue
HealthGet200ResponseComponentsValue$validateJSON()Validate JSON input with respect to HealthGet200ResponseComponentsValue and throw an exception if invalid
HealthGet200ResponseComponentsValue$validateJSON(input)
inputthe JSON input
HealthGet200ResponseComponentsValue$toString()To string (JSON format)
HealthGet200ResponseComponentsValue$toString()
String representation of HealthGet200ResponseComponentsValue
HealthGet200ResponseComponentsValue$isValid()Return true if the values in all fields are valid.
HealthGet200ResponseComponentsValue$isValid()
true if the values in all fields are valid.
HealthGet200ResponseComponentsValue$getInvalidFields()Return a list of invalid fields (if any).
HealthGet200ResponseComponentsValue$getInvalidFields()
A list of invalid fields (if any).
HealthGet200ResponseComponentsValue$print()Print the object
HealthGet200ResponseComponentsValue$print()
HealthGet200ResponseComponentsValue$clone()The objects of this class are cloneable with this method.
HealthGet200ResponseComponentsValue$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `HealthGet200ResponseComponentsValue$toList()` ## ------------------------------------------------ # convert array of HealthGet200ResponseComponentsValue (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `HealthGet200ResponseComponentsValue$toList()` ## ------------------------------------------------ # convert array of HealthGet200ResponseComponentsValue (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
HealthGet503Response Class
HealthGet503Response Class
An R6Class generator object
Create a new HealthGet503Response
statuscharacter [optional]
componentsnamed list(HealthGet503ResponseComponentsValue) [optional]
HealthGet503Response$new()Initialize a new HealthGet503Response class.
HealthGet503Response$new(status = NULL, components = NULL, ...)
statusstatus
componentscomponents
...Other optional arguments.
HealthGet503Response$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
HealthGet503Response$toList()
HealthGet503Response as a base R list.
# convert array of HealthGet503Response (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
HealthGet503Response$toSimpleType()Convert HealthGet503Response to a base R type
HealthGet503Response$toSimpleType()
A base R type, e.g. a list or numeric/character array.
HealthGet503Response$fromJSON()Deserialize JSON string into an instance of HealthGet503Response
HealthGet503Response$fromJSON(input_json)
input_jsonthe JSON input
the instance of HealthGet503Response
HealthGet503Response$toJSONString()To JSON String
HealthGet503Response$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
HealthGet503Response in JSON format
HealthGet503Response$fromJSONString()Deserialize JSON string into an instance of HealthGet503Response
HealthGet503Response$fromJSONString(input_json)
input_jsonthe JSON input
the instance of HealthGet503Response
HealthGet503Response$validateJSON()Validate JSON input with respect to HealthGet503Response and throw an exception if invalid
HealthGet503Response$validateJSON(input)
inputthe JSON input
HealthGet503Response$toString()To string (JSON format)
HealthGet503Response$toString()
String representation of HealthGet503Response
HealthGet503Response$isValid()Return true if the values in all fields are valid.
HealthGet503Response$isValid()
true if the values in all fields are valid.
HealthGet503Response$getInvalidFields()Return a list of invalid fields (if any).
HealthGet503Response$getInvalidFields()
A list of invalid fields (if any).
HealthGet503Response$print()Print the object
HealthGet503Response$print()
HealthGet503Response$clone()The objects of this class are cloneable with this method.
HealthGet503Response$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `HealthGet503Response$toList()` ## ------------------------------------------------ # convert array of HealthGet503Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `HealthGet503Response$toList()` ## ------------------------------------------------ # convert array of HealthGet503Response (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
HealthGet503ResponseComponentsValue Class
HealthGet503ResponseComponentsValue Class
An R6Class generator object
Create a new HealthGet503ResponseComponentsValue
statuscharacter [optional]
HealthGet503ResponseComponentsValue$new()Initialize a new HealthGet503ResponseComponentsValue class.
HealthGet503ResponseComponentsValue$new(status = NULL, ...)
statusstatus
...Other optional arguments.
HealthGet503ResponseComponentsValue$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
HealthGet503ResponseComponentsValue$toList()
HealthGet503ResponseComponentsValue as a base R list.
# convert array of HealthGet503ResponseComponentsValue (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
HealthGet503ResponseComponentsValue$toSimpleType()Convert HealthGet503ResponseComponentsValue to a base R type
HealthGet503ResponseComponentsValue$toSimpleType()
A base R type, e.g. a list or numeric/character array.
HealthGet503ResponseComponentsValue$fromJSON()Deserialize JSON string into an instance of HealthGet503ResponseComponentsValue
HealthGet503ResponseComponentsValue$fromJSON(input_json)
input_jsonthe JSON input
the instance of HealthGet503ResponseComponentsValue
HealthGet503ResponseComponentsValue$toJSONString()To JSON String
HealthGet503ResponseComponentsValue$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
HealthGet503ResponseComponentsValue in JSON format
HealthGet503ResponseComponentsValue$fromJSONString()Deserialize JSON string into an instance of HealthGet503ResponseComponentsValue
HealthGet503ResponseComponentsValue$fromJSONString(input_json)
input_jsonthe JSON input
the instance of HealthGet503ResponseComponentsValue
HealthGet503ResponseComponentsValue$validateJSON()Validate JSON input with respect to HealthGet503ResponseComponentsValue and throw an exception if invalid
HealthGet503ResponseComponentsValue$validateJSON(input)
inputthe JSON input
HealthGet503ResponseComponentsValue$toString()To string (JSON format)
HealthGet503ResponseComponentsValue$toString()
String representation of HealthGet503ResponseComponentsValue
HealthGet503ResponseComponentsValue$isValid()Return true if the values in all fields are valid.
HealthGet503ResponseComponentsValue$isValid()
true if the values in all fields are valid.
HealthGet503ResponseComponentsValue$getInvalidFields()Return a list of invalid fields (if any).
HealthGet503ResponseComponentsValue$getInvalidFields()
A list of invalid fields (if any).
HealthGet503ResponseComponentsValue$print()Print the object
HealthGet503ResponseComponentsValue$print()
HealthGet503ResponseComponentsValue$clone()The objects of this class are cloneable with this method.
HealthGet503ResponseComponentsValue$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `HealthGet503ResponseComponentsValue$toList()` ## ------------------------------------------------ # convert array of HealthGet503ResponseComponentsValue (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `HealthGet503ResponseComponentsValue$toList()` ## ------------------------------------------------ # convert array of HealthGet503ResponseComponentsValue (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
JobsPagination Class
JobsPagination Class
An R6Class generator object
Create a new JobsPagination
limitPage size echoed back from the request. integer
orderSort direction echoed back from the request. character
page1-indexed current page number echoed back from the request. integer
sortColumn the rows are sorted by, echoed back from the request. character
totalTotal matching rows for the authenticated user (full set, not just this page). integer
total_pagesceil(total / limit). Zero when total is zero. integer
JobsPagination$new()Initialize a new JobsPagination class.
JobsPagination$new(limit, order, page, sort, total, total_pages, ...)
limitPage size echoed back from the request.
orderSort direction echoed back from the request.
page1-indexed current page number echoed back from the request.
sortColumn the rows are sorted by, echoed back from the request.
totalTotal matching rows for the authenticated user (full set, not just this page).
total_pagesceil(total / limit). Zero when total is zero.
...Other optional arguments.
JobsPagination$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
JobsPagination$toList()
JobsPagination as a base R list.
# convert array of JobsPagination (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
JobsPagination$toSimpleType()Convert JobsPagination to a base R type
JobsPagination$toSimpleType()
A base R type, e.g. a list or numeric/character array.
JobsPagination$fromJSON()Deserialize JSON string into an instance of JobsPagination
JobsPagination$fromJSON(input_json)
input_jsonthe JSON input
the instance of JobsPagination
JobsPagination$toJSONString()To JSON String
JobsPagination$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
JobsPagination in JSON format
JobsPagination$fromJSONString()Deserialize JSON string into an instance of JobsPagination
JobsPagination$fromJSONString(input_json)
input_jsonthe JSON input
the instance of JobsPagination
JobsPagination$validateJSON()Validate JSON input with respect to JobsPagination and throw an exception if invalid
JobsPagination$validateJSON(input)
inputthe JSON input
JobsPagination$toString()To string (JSON format)
JobsPagination$toString()
String representation of JobsPagination
JobsPagination$isValid()Return true if the values in all fields are valid.
JobsPagination$isValid()
true if the values in all fields are valid.
JobsPagination$getInvalidFields()Return a list of invalid fields (if any).
JobsPagination$getInvalidFields()
A list of invalid fields (if any).
JobsPagination$print()Print the object
JobsPagination$print()
JobsPagination$clone()The objects of this class are cloneable with this method.
JobsPagination$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `JobsPagination$toList()` ## ------------------------------------------------ # convert array of JobsPagination (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `JobsPagination$toList()` ## ------------------------------------------------ # convert array of JobsPagination (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Lightweight projection of an async_jobs row (no payload, no manifest).
JobSummary Class
An R6Class generator object
Create a new JobSummary
created_atcharacter
eur_cents_finalFinal settled charge for the job, in EUR cents. Null until settled. integer [optional]
job_idcharacter
pipeline_typeToday only \"forecast\"; future pipeline types will appear here. character
run_idInternal run id (omitted for jobs that haven't started yet). character [optional]
settledTrue iff the job has reached a terminal state and been billed. character
settled_atcharacter [optional]
statuscharacter
terminal_reasoncharacter [optional]
workflow_idInternal workflow id (omitted for jobs that haven't started yet). character [optional]
JobSummary$new()Initialize a new JobSummary class.
JobSummary$new( created_at, job_id, pipeline_type, settled, status, eur_cents_final = NULL, run_id = NULL, settled_at = NULL, terminal_reason = NULL, workflow_id = NULL, ... )
created_atcreated_at
job_idjob_id
pipeline_typeToday only \"forecast\"; future pipeline types will appear here.
settledTrue iff the job has reached a terminal state and been billed.
statusstatus
eur_cents_finalFinal settled charge for the job, in EUR cents. Null until settled.
run_idInternal run id (omitted for jobs that haven't started yet).
settled_atsettled_at
terminal_reasonterminal_reason
workflow_idInternal workflow id (omitted for jobs that haven't started yet).
...Other optional arguments.
JobSummary$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
JobSummary$toList()
JobSummary as a base R list.
# convert array of JobSummary (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
JobSummary$toSimpleType()Convert JobSummary to a base R type
JobSummary$toSimpleType()
A base R type, e.g. a list or numeric/character array.
JobSummary$fromJSON()Deserialize JSON string into an instance of JobSummary
JobSummary$fromJSON(input_json)
input_jsonthe JSON input
the instance of JobSummary
JobSummary$toJSONString()To JSON String
JobSummary$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
JobSummary in JSON format
JobSummary$fromJSONString()Deserialize JSON string into an instance of JobSummary
JobSummary$fromJSONString(input_json)
input_jsonthe JSON input
the instance of JobSummary
JobSummary$validateJSON()Validate JSON input with respect to JobSummary and throw an exception if invalid
JobSummary$validateJSON(input)
inputthe JSON input
JobSummary$toString()To string (JSON format)
JobSummary$toString()
String representation of JobSummary
JobSummary$isValid()Return true if the values in all fields are valid.
JobSummary$isValid()
true if the values in all fields are valid.
JobSummary$getInvalidFields()Return a list of invalid fields (if any).
JobSummary$getInvalidFields()
A list of invalid fields (if any).
JobSummary$print()Print the object
JobSummary$print()
JobSummary$clone()The objects of this class are cloneable with this method.
JobSummary$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `JobSummary$toList()` ## ------------------------------------------------ # convert array of JobSummary (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `JobSummary$toList()` ## ------------------------------------------------ # convert array of JobSummary (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Authenticated user snapshot. All monetary fields are integer EUR cents (1 EUR = 100 cents).
MeResponse Class
An R6Class generator object
Create a new MeResponse
api_usage_tierCurrent pricing tier level. Higher levels unlock better rate limits and job concurrency. integer
auto_rechargeAutoRechargeState [optional]
available_eur_centsSpendable balance in EUR cents — 'balance_eur_cents' minus any credits held for in-flight async jobs. integer
balance_eur_centsTotal credit balance in EUR cents, before deducting active holds. integer
euro_tranchesActive credit grants (non-empty, unexpired), consumed in 'expires_at' ascending order. list(EuroTranche)
has_ever_paidTrue once the account has completed at least one successful Stripe payment. character
lifetime_paid_centsCumulative EUR cents charged across all Stripe payments, all time. integer
payment_countTotal number of successful Stripe payments on this account. integer
signup_trialMeResponseSignupTrial [optional]
user_idcharacter
MeResponse$new()Initialize a new MeResponse class.
MeResponse$new( api_usage_tier, available_eur_cents, balance_eur_cents, euro_tranches, has_ever_paid, lifetime_paid_cents, payment_count, user_id, auto_recharge = NULL, signup_trial = NULL, ... )
api_usage_tierCurrent pricing tier level. Higher levels unlock better rate limits and job concurrency.
available_eur_centsSpendable balance in EUR cents — 'balance_eur_cents' minus any credits held for in-flight async jobs.
balance_eur_centsTotal credit balance in EUR cents, before deducting active holds.
euro_tranchesActive credit grants (non-empty, unexpired), consumed in 'expires_at' ascending order.
has_ever_paidTrue once the account has completed at least one successful Stripe payment.
lifetime_paid_centsCumulative EUR cents charged across all Stripe payments, all time.
payment_countTotal number of successful Stripe payments on this account.
user_iduser_id
auto_rechargeauto_recharge
signup_trialsignup_trial
...Other optional arguments.
MeResponse$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
MeResponse$toList()
MeResponse as a base R list.
# convert array of MeResponse (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
MeResponse$toSimpleType()Convert MeResponse to a base R type
MeResponse$toSimpleType()
A base R type, e.g. a list or numeric/character array.
MeResponse$fromJSON()Deserialize JSON string into an instance of MeResponse
MeResponse$fromJSON(input_json)
input_jsonthe JSON input
the instance of MeResponse
MeResponse$toJSONString()To JSON String
MeResponse$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
MeResponse in JSON format
MeResponse$fromJSONString()Deserialize JSON string into an instance of MeResponse
MeResponse$fromJSONString(input_json)
input_jsonthe JSON input
the instance of MeResponse
MeResponse$validateJSON()Validate JSON input with respect to MeResponse and throw an exception if invalid
MeResponse$validateJSON(input)
inputthe JSON input
MeResponse$toString()To string (JSON format)
MeResponse$toString()
String representation of MeResponse
MeResponse$isValid()Return true if the values in all fields are valid.
MeResponse$isValid()
true if the values in all fields are valid.
MeResponse$getInvalidFields()Return a list of invalid fields (if any).
MeResponse$getInvalidFields()
A list of invalid fields (if any).
MeResponse$print()Print the object
MeResponse$print()
MeResponse$clone()The objects of this class are cloneable with this method.
MeResponse$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `MeResponse$toList()` ## ------------------------------------------------ # convert array of MeResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `MeResponse$toList()` ## ------------------------------------------------ # convert array of MeResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Present when a signup (free) trial tranche was granted. Omitted for users with no trial or before grant.
MeResponseSignupTrial Class
An R6Class generator object
Create a new MeResponseSignupTrial
expires_atOmitted if the grant row is missing (abnormal) character [optional]
granted_atcharacter [optional]
initial_eur_centsinteger [optional]
remaining_eur_centsinteger [optional]
MeResponseSignupTrial$new()Initialize a new MeResponseSignupTrial class.
MeResponseSignupTrial$new( expires_at = NULL, granted_at = NULL, initial_eur_cents = NULL, remaining_eur_cents = NULL, ... )
expires_atOmitted if the grant row is missing (abnormal)
granted_atgranted_at
initial_eur_centsinitial_eur_cents
remaining_eur_centsremaining_eur_cents
...Other optional arguments.
MeResponseSignupTrial$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
MeResponseSignupTrial$toList()
MeResponseSignupTrial as a base R list.
# convert array of MeResponseSignupTrial (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
MeResponseSignupTrial$toSimpleType()Convert MeResponseSignupTrial to a base R type
MeResponseSignupTrial$toSimpleType()
A base R type, e.g. a list or numeric/character array.
MeResponseSignupTrial$fromJSON()Deserialize JSON string into an instance of MeResponseSignupTrial
MeResponseSignupTrial$fromJSON(input_json)
input_jsonthe JSON input
the instance of MeResponseSignupTrial
MeResponseSignupTrial$toJSONString()To JSON String
MeResponseSignupTrial$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
MeResponseSignupTrial in JSON format
MeResponseSignupTrial$fromJSONString()Deserialize JSON string into an instance of MeResponseSignupTrial
MeResponseSignupTrial$fromJSONString(input_json)
input_jsonthe JSON input
the instance of MeResponseSignupTrial
MeResponseSignupTrial$validateJSON()Validate JSON input with respect to MeResponseSignupTrial and throw an exception if invalid
MeResponseSignupTrial$validateJSON(input)
inputthe JSON input
MeResponseSignupTrial$toString()To string (JSON format)
MeResponseSignupTrial$toString()
String representation of MeResponseSignupTrial
MeResponseSignupTrial$isValid()Return true if the values in all fields are valid.
MeResponseSignupTrial$isValid()
true if the values in all fields are valid.
MeResponseSignupTrial$getInvalidFields()Return a list of invalid fields (if any).
MeResponseSignupTrial$getInvalidFields()
A list of invalid fields (if any).
MeResponseSignupTrial$print()Print the object
MeResponseSignupTrial$print()
MeResponseSignupTrial$clone()The objects of this class are cloneable with this method.
MeResponseSignupTrial$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `MeResponseSignupTrial$toList()` ## ------------------------------------------------ # convert array of MeResponseSignupTrial (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `MeResponseSignupTrial$toList()` ## ------------------------------------------------ # convert array of MeResponseSignupTrial (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
A news article associated with an alert.
NewsItemV1 Class
An R6Class generator object
Create a new NewsItemV1
categoryTopical category of the article (e.g. 'world', 'business', 'energy'). character [optional]
descriptionShort summary of the article. character [optional]
published_atPublication timestamp (RFC 3339 / ISO 8601). character [optional]
source_nameName of the publication or media outlet. character [optional]
titleHeadline of the news article. character [optional]
trendingWhether this article is currently trending across the platform. character [optional]
urlCanonical URL of the article. character [optional]
NewsItemV1$new()Initialize a new NewsItemV1 class.
NewsItemV1$new( category = NULL, description = NULL, published_at = NULL, source_name = NULL, title = NULL, trending = NULL, url = NULL, ... )
categoryTopical category of the article (e.g. 'world', 'business', 'energy').
descriptionShort summary of the article.
published_atPublication timestamp (RFC 3339 / ISO 8601).
source_nameName of the publication or media outlet.
titleHeadline of the news article.
trendingWhether this article is currently trending across the platform.
urlCanonical URL of the article.
...Other optional arguments.
NewsItemV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
NewsItemV1$toList()
NewsItemV1 as a base R list.
# convert array of NewsItemV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
NewsItemV1$toSimpleType()Convert NewsItemV1 to a base R type
NewsItemV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
NewsItemV1$fromJSON()Deserialize JSON string into an instance of NewsItemV1
NewsItemV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of NewsItemV1
NewsItemV1$toJSONString()To JSON String
NewsItemV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
NewsItemV1 in JSON format
NewsItemV1$fromJSONString()Deserialize JSON string into an instance of NewsItemV1
NewsItemV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of NewsItemV1
NewsItemV1$validateJSON()Validate JSON input with respect to NewsItemV1 and throw an exception if invalid
NewsItemV1$validateJSON(input)
inputthe JSON input
NewsItemV1$toString()To string (JSON format)
NewsItemV1$toString()
String representation of NewsItemV1
NewsItemV1$isValid()Return true if the values in all fields are valid.
NewsItemV1$isValid()
true if the values in all fields are valid.
NewsItemV1$getInvalidFields()Return a list of invalid fields (if any).
NewsItemV1$getInvalidFields()
A list of invalid fields (if any).
NewsItemV1$print()Print the object
NewsItemV1$print()
NewsItemV1$clone()The objects of this class are cloneable with this method.
NewsItemV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `NewsItemV1$toList()` ## ------------------------------------------------ # convert array of NewsItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `NewsItemV1$toList()` ## ------------------------------------------------ # convert array of NewsItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Pagination Class
Pagination Class
An R6Class generator object
Create a new Pagination
limitPage size echoed back from the request. integer
orderSort direction. character
page1-indexed current page number echoed back from the request. integer
sortColumn the rows are sorted by. character
totalTotal matching rows for the authenticated user (full set, not just this page). integer
total_pagesceil(total / limit). Zero when total is zero. integer
Pagination$new()Initialize a new Pagination class.
Pagination$new(limit, order, page, sort, total, total_pages, ...)
limitPage size echoed back from the request.
orderSort direction.
page1-indexed current page number echoed back from the request.
sortColumn the rows are sorted by.
totalTotal matching rows for the authenticated user (full set, not just this page).
total_pagesceil(total / limit). Zero when total is zero.
...Other optional arguments.
Pagination$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
Pagination$toList()
Pagination as a base R list.
# convert array of Pagination (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
Pagination$toSimpleType()Convert Pagination to a base R type
Pagination$toSimpleType()
A base R type, e.g. a list or numeric/character array.
Pagination$fromJSON()Deserialize JSON string into an instance of Pagination
Pagination$fromJSON(input_json)
input_jsonthe JSON input
the instance of Pagination
Pagination$toJSONString()To JSON String
Pagination$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
Pagination in JSON format
Pagination$fromJSONString()Deserialize JSON string into an instance of Pagination
Pagination$fromJSONString(input_json)
input_jsonthe JSON input
the instance of Pagination
Pagination$validateJSON()Validate JSON input with respect to Pagination and throw an exception if invalid
Pagination$validateJSON(input)
inputthe JSON input
Pagination$toString()To string (JSON format)
Pagination$toString()
String representation of Pagination
Pagination$isValid()Return true if the values in all fields are valid.
Pagination$isValid()
true if the values in all fields are valid.
Pagination$getInvalidFields()Return a list of invalid fields (if any).
Pagination$getInvalidFields()
A list of invalid fields (if any).
Pagination$print()Print the object
Pagination$print()
Pagination$clone()The objects of this class are cloneable with this method.
Pagination$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `Pagination$toList()` ## ------------------------------------------------ # convert array of Pagination (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `Pagination$toList()` ## ------------------------------------------------ # convert array of Pagination (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Body of 'POST /api/v1/drivers'. Mirrors the upstream Recommend service contract. Note that the version field is named 'version' (not 'pipeline_version' as on '/forecasts'). Required fields: 'version', 'recency_factor', 'timeseries_metadata'. Both 'filters' and 'timeseries' are optional — when omitted, the handler drops them from the upstream payload entirely (no 'null' is sent). When 'filters.limit' is omitted, a per-environment default is applied.
RecommendRequestV1 Class
An R6Class generator object
Create a new RecommendRequestV1
filtersOptional. Each **'categories[]'** and **'regions[]'** entry must be an integer **1–9999** (inclusive). Optional **'limit'** is **0–1000** (default **100** when omitted). Values are not verified against catalog APIs. Filters [optional]
recency_factorWeight given to more recent observations when ranking drivers. 0.0 = equal weight; 1.0 = strongest recency bias. numeric
timeseriesOptional. Map of YYYY-MM-DD date keys to numeric observation values. When supplied, all keys must parse as YYYY-MM-DD and all values must be finite. Unlike '/forecasts', this endpoint is frequency-agnostic — no monthly alignment, gap detection, or minimum length is enforced. When omitted, the handler does not forward the field upstream. named list(numeric) [optional]
timeseries_metadataDescribes the series so the ranking model can identify relevant drivers. TimeseriesMetadata
versionRecommend pipeline version. Closed set; only 'v1' is supported today. Used locally to select the per-version validator and is **not forwarded** to the upstream Recommend service. character
RecommendRequestV1$new()Initialize a new RecommendRequestV1 class.
RecommendRequestV1$new( recency_factor, timeseries_metadata, version, filters = NULL, timeseries = NULL, ... )
recency_factorWeight given to more recent observations when ranking drivers. 0.0 = equal weight; 1.0 = strongest recency bias.
timeseries_metadataDescribes the series so the ranking model can identify relevant drivers.
versionRecommend pipeline version. Closed set; only 'v1' is supported today. Used locally to select the per-version validator and is **not forwarded** to the upstream Recommend service.
filtersOptional. Each **'categories[]'** and **'regions[]'** entry must be an integer **1–9999** (inclusive). Optional **'limit'** is **0–1000** (default **100** when omitted). Values are not verified against catalog APIs.
timeseriesOptional. Map of YYYY-MM-DD date keys to numeric observation values. When supplied, all keys must parse as YYYY-MM-DD and all values must be finite. Unlike '/forecasts', this endpoint is frequency-agnostic — no monthly alignment, gap detection, or minimum length is enforced. When omitted, the handler does not forward the field upstream.
...Other optional arguments.
RecommendRequestV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
RecommendRequestV1$toList()
RecommendRequestV1 as a base R list.
# convert array of RecommendRequestV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
RecommendRequestV1$toSimpleType()Convert RecommendRequestV1 to a base R type
RecommendRequestV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
RecommendRequestV1$fromJSON()Deserialize JSON string into an instance of RecommendRequestV1
RecommendRequestV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of RecommendRequestV1
RecommendRequestV1$toJSONString()To JSON String
RecommendRequestV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
RecommendRequestV1 in JSON format
RecommendRequestV1$fromJSONString()Deserialize JSON string into an instance of RecommendRequestV1
RecommendRequestV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of RecommendRequestV1
RecommendRequestV1$validateJSON()Validate JSON input with respect to RecommendRequestV1 and throw an exception if invalid
RecommendRequestV1$validateJSON(input)
inputthe JSON input
RecommendRequestV1$toString()To string (JSON format)
RecommendRequestV1$toString()
String representation of RecommendRequestV1
RecommendRequestV1$isValid()Return true if the values in all fields are valid.
RecommendRequestV1$isValid()
true if the values in all fields are valid.
RecommendRequestV1$getInvalidFields()Return a list of invalid fields (if any).
RecommendRequestV1$getInvalidFields()
A list of invalid fields (if any).
RecommendRequestV1$print()Print the object
RecommendRequestV1$print()
RecommendRequestV1$clone()The objects of this class are cloneable with this method.
RecommendRequestV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `RecommendRequestV1$toList()` ## ------------------------------------------------ # convert array of RecommendRequestV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `RecommendRequestV1$toList()` ## ------------------------------------------------ # convert array of RecommendRequestV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
A single geographic region returned by GET /api/v1/regions.
RegionItemV1 Class
An R6Class generator object
Create a new RegionItemV1
idInteger identifier. Use this value in filters.regions[]. integer
latitudeGeographic latitude (0.0 when not applicable). numeric
longitudeGeographic longitude (0.0 when not applicable). numeric
nameHuman-readable region label. character
RegionItemV1$new()Initialize a new RegionItemV1 class.
RegionItemV1$new(id, latitude, longitude, name, ...)
idInteger identifier. Use this value in filters.regions[].
latitudeGeographic latitude (0.0 when not applicable).
longitudeGeographic longitude (0.0 when not applicable).
nameHuman-readable region label.
...Other optional arguments.
RegionItemV1$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
RegionItemV1$toList()
RegionItemV1 as a base R list.
# convert array of RegionItemV1 (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
RegionItemV1$toSimpleType()Convert RegionItemV1 to a base R type
RegionItemV1$toSimpleType()
A base R type, e.g. a list or numeric/character array.
RegionItemV1$fromJSON()Deserialize JSON string into an instance of RegionItemV1
RegionItemV1$fromJSON(input_json)
input_jsonthe JSON input
the instance of RegionItemV1
RegionItemV1$toJSONString()To JSON String
RegionItemV1$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
RegionItemV1 in JSON format
RegionItemV1$fromJSONString()Deserialize JSON string into an instance of RegionItemV1
RegionItemV1$fromJSONString(input_json)
input_jsonthe JSON input
the instance of RegionItemV1
RegionItemV1$validateJSON()Validate JSON input with respect to RegionItemV1 and throw an exception if invalid
RegionItemV1$validateJSON(input)
inputthe JSON input
RegionItemV1$toString()To string (JSON format)
RegionItemV1$toString()
String representation of RegionItemV1
RegionItemV1$isValid()Return true if the values in all fields are valid.
RegionItemV1$isValid()
true if the values in all fields are valid.
RegionItemV1$getInvalidFields()Return a list of invalid fields (if any).
RegionItemV1$getInvalidFields()
A list of invalid fields (if any).
RegionItemV1$print()Print the object
RegionItemV1$print()
RegionItemV1$clone()The objects of this class are cloneable with this method.
RegionItemV1$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `RegionItemV1$toList()` ## ------------------------------------------------ # convert array of RegionItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `RegionItemV1$toList()` ## ------------------------------------------------ # convert array of RegionItemV1 (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
RegionListResponse Class
RegionListResponse Class
An R6Class generator object
Create a new RegionListResponse
itemsComplete region listing, sorted by id ascending. No pagination. list(RegionItemV1)
RegionListResponse$new()Initialize a new RegionListResponse class.
RegionListResponse$new(items, ...)
itemsComplete region listing, sorted by id ascending. No pagination.
...Other optional arguments.
RegionListResponse$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
RegionListResponse$toList()
RegionListResponse as a base R list.
# convert array of RegionListResponse (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
RegionListResponse$toSimpleType()Convert RegionListResponse to a base R type
RegionListResponse$toSimpleType()
A base R type, e.g. a list or numeric/character array.
RegionListResponse$fromJSON()Deserialize JSON string into an instance of RegionListResponse
RegionListResponse$fromJSON(input_json)
input_jsonthe JSON input
the instance of RegionListResponse
RegionListResponse$toJSONString()To JSON String
RegionListResponse$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
RegionListResponse in JSON format
RegionListResponse$fromJSONString()Deserialize JSON string into an instance of RegionListResponse
RegionListResponse$fromJSONString(input_json)
input_jsonthe JSON input
the instance of RegionListResponse
RegionListResponse$validateJSON()Validate JSON input with respect to RegionListResponse and throw an exception if invalid
RegionListResponse$validateJSON(input)
inputthe JSON input
RegionListResponse$toString()To string (JSON format)
RegionListResponse$toString()
String representation of RegionListResponse
RegionListResponse$isValid()Return true if the values in all fields are valid.
RegionListResponse$isValid()
true if the values in all fields are valid.
RegionListResponse$getInvalidFields()Return a list of invalid fields (if any).
RegionListResponse$getInvalidFields()
A list of invalid fields (if any).
RegionListResponse$print()Print the object
RegionListResponse$print()
RegionListResponse$clone()The objects of this class are cloneable with this method.
RegionListResponse$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `RegionListResponse$toList()` ## ------------------------------------------------ # convert array of RegionListResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `RegionListResponse$toList()` ## ------------------------------------------------ # convert array of RegionListResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
Order: non-empty explicit, then SYBILION_API_BASE_URL, then the compiled default.
resolve_api_url(explicit = NULL)resolve_api_url(explicit = NULL)
explicit |
Optional API origin. |
API origin without trailing slash.
resolve_api_url).Name of the environment variable that overrides the Sybilion API base URL
(read by resolve_api_url).
SYBILION_API_BASE_URL_ENVSYBILION_API_BASE_URL_ENV
Construct a high-level Sybilion client.
sybilion_client(token = NULL, base_url = NULL, api_key = NULL, api_url = NULL)sybilion_client(token = NULL, base_url = NULL, api_key = NULL, api_url = NULL)
token |
Bearer credential. Ignored if you pass 'api_key' instead. |
base_url |
Optional API origin (alias: 'api_url'). |
api_key |
Alias for 'token'. |
api_url |
Alias for 'base_url'. |
A 'Client' instance.
Descriptive metadata the ranking model uses to interpret and contextualize the timeseries.
TimeseriesMetadata Class
An R6Class generator object
Create a new TimeseriesMetadata
descriptionExtended context for the model, up to 2048 characters. More detail improves driver relevance. character [optional]
keywordsUp to 20 semantic tags that help anchor the search to relevant datasets. list(character) [optional]
titleShort identifier for the series, 20–511 characters. character
TimeseriesMetadata$new()Initialize a new TimeseriesMetadata class.
TimeseriesMetadata$new(title, description = NULL, keywords = NULL, ...)
titleShort identifier for the series, 20–511 characters.
descriptionExtended context for the model, up to 2048 characters. More detail improves driver relevance.
keywordsUp to 20 semantic tags that help anchor the search to relevant datasets.
...Other optional arguments.
TimeseriesMetadata$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
TimeseriesMetadata$toList()
TimeseriesMetadata as a base R list.
# convert array of TimeseriesMetadata (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
TimeseriesMetadata$toSimpleType()Convert TimeseriesMetadata to a base R type
TimeseriesMetadata$toSimpleType()
A base R type, e.g. a list or numeric/character array.
TimeseriesMetadata$fromJSON()Deserialize JSON string into an instance of TimeseriesMetadata
TimeseriesMetadata$fromJSON(input_json)
input_jsonthe JSON input
the instance of TimeseriesMetadata
TimeseriesMetadata$toJSONString()To JSON String
TimeseriesMetadata$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
TimeseriesMetadata in JSON format
TimeseriesMetadata$fromJSONString()Deserialize JSON string into an instance of TimeseriesMetadata
TimeseriesMetadata$fromJSONString(input_json)
input_jsonthe JSON input
the instance of TimeseriesMetadata
TimeseriesMetadata$validateJSON()Validate JSON input with respect to TimeseriesMetadata and throw an exception if invalid
TimeseriesMetadata$validateJSON(input)
inputthe JSON input
TimeseriesMetadata$toString()To string (JSON format)
TimeseriesMetadata$toString()
String representation of TimeseriesMetadata
TimeseriesMetadata$isValid()Return true if the values in all fields are valid.
TimeseriesMetadata$isValid()
true if the values in all fields are valid.
TimeseriesMetadata$getInvalidFields()Return a list of invalid fields (if any).
TimeseriesMetadata$getInvalidFields()
A list of invalid fields (if any).
TimeseriesMetadata$print()Print the object
TimeseriesMetadata$print()
TimeseriesMetadata$clone()The objects of this class are cloneable with this method.
TimeseriesMetadata$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `TimeseriesMetadata$toList()` ## ------------------------------------------------ # convert array of TimeseriesMetadata (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `TimeseriesMetadata$toList()` ## ------------------------------------------------ # convert array of TimeseriesMetadata (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
UsageEvent Class
UsageEvent Class
An R6Class generator object
Create a new UsageEvent
async_job_idasync_jobs.id (UUID) for async pipeline charges; null for sync endpoint charges character [optional]
created_atTimestamp (ISO-8601 text from the database) character
credits_chargedWhole credits debited for this usage row before EUR conversion ('eur_cents_charged'). integer
endpointBilling endpoint key (e.g. forecast pipeline type or sync route key) character [optional]
eur_cents_chargedEUR cents debited for this usage row (1 EUR = 100 cents). integer
idinteger
unitsStrategy-defined metering quantity (e.g. tokens, seconds); not necessarily equal to credits. integer
UsageEvent$new()Initialize a new UsageEvent class.
UsageEvent$new( created_at, credits_charged, eur_cents_charged, id, units, async_job_id = NULL, endpoint = NULL, ... )
created_atTimestamp (ISO-8601 text from the database)
credits_chargedWhole credits debited for this usage row before EUR conversion ('eur_cents_charged').
eur_cents_chargedEUR cents debited for this usage row (1 EUR = 100 cents).
idid
unitsStrategy-defined metering quantity (e.g. tokens, seconds); not necessarily equal to credits.
async_job_idasync_jobs.id (UUID) for async pipeline charges; null for sync endpoint charges
endpointBilling endpoint key (e.g. forecast pipeline type or sync route key)
...Other optional arguments.
UsageEvent$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
UsageEvent$toList()
UsageEvent as a base R list.
# convert array of UsageEvent (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
UsageEvent$toSimpleType()Convert UsageEvent to a base R type
UsageEvent$toSimpleType()
A base R type, e.g. a list or numeric/character array.
UsageEvent$fromJSON()Deserialize JSON string into an instance of UsageEvent
UsageEvent$fromJSON(input_json)
input_jsonthe JSON input
the instance of UsageEvent
UsageEvent$toJSONString()To JSON String
UsageEvent$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
UsageEvent in JSON format
UsageEvent$fromJSONString()Deserialize JSON string into an instance of UsageEvent
UsageEvent$fromJSONString(input_json)
input_jsonthe JSON input
the instance of UsageEvent
UsageEvent$validateJSON()Validate JSON input with respect to UsageEvent and throw an exception if invalid
UsageEvent$validateJSON(input)
inputthe JSON input
UsageEvent$toString()To string (JSON format)
UsageEvent$toString()
String representation of UsageEvent
UsageEvent$isValid()Return true if the values in all fields are valid.
UsageEvent$isValid()
true if the values in all fields are valid.
UsageEvent$getInvalidFields()Return a list of invalid fields (if any).
UsageEvent$getInvalidFields()
A list of invalid fields (if any).
UsageEvent$print()Print the object
UsageEvent$print()
UsageEvent$clone()The objects of this class are cloneable with this method.
UsageEvent$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `UsageEvent$toList()` ## ------------------------------------------------ # convert array of UsageEvent (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `UsageEvent$toList()` ## ------------------------------------------------ # convert array of UsageEvent (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ValidationErrorResponse Class
ValidationErrorResponse Class
An R6Class generator object
Create a new ValidationErrorResponse
detailserrorcharacter
ValidationErrorResponse$new()Initialize a new ValidationErrorResponse class.
ValidationErrorResponse$new(details, error, ...)
detailsdetails
errorerror
...Other optional arguments.
ValidationErrorResponse$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ValidationErrorResponse$toList()
ValidationErrorResponse as a base R list.
# convert array of ValidationErrorResponse (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ValidationErrorResponse$toSimpleType()Convert ValidationErrorResponse to a base R type
ValidationErrorResponse$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ValidationErrorResponse$fromJSON()Deserialize JSON string into an instance of ValidationErrorResponse
ValidationErrorResponse$fromJSON(input_json)
input_jsonthe JSON input
the instance of ValidationErrorResponse
ValidationErrorResponse$toJSONString()To JSON String
ValidationErrorResponse$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ValidationErrorResponse in JSON format
ValidationErrorResponse$fromJSONString()Deserialize JSON string into an instance of ValidationErrorResponse
ValidationErrorResponse$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ValidationErrorResponse
ValidationErrorResponse$validateJSON()Validate JSON input with respect to ValidationErrorResponse and throw an exception if invalid
ValidationErrorResponse$validateJSON(input)
inputthe JSON input
ValidationErrorResponse$toString()To string (JSON format)
ValidationErrorResponse$toString()
String representation of ValidationErrorResponse
ValidationErrorResponse$isValid()Return true if the values in all fields are valid.
ValidationErrorResponse$isValid()
true if the values in all fields are valid.
ValidationErrorResponse$getInvalidFields()Return a list of invalid fields (if any).
ValidationErrorResponse$getInvalidFields()
A list of invalid fields (if any).
ValidationErrorResponse$print()Print the object
ValidationErrorResponse$print()
ValidationErrorResponse$clone()The objects of this class are cloneable with this method.
ValidationErrorResponse$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ValidationErrorResponse$toList()` ## ------------------------------------------------ # convert array of ValidationErrorResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ValidationErrorResponse$toList()` ## ------------------------------------------------ # convert array of ValidationErrorResponse (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)
ValidationErrorResponseDetailsInner Class
ValidationErrorResponseDetailsInner Class
An R6Class generator object
Create a new ValidationErrorResponseDetailsInner
fieldcharacter
messagecharacter
ValidationErrorResponseDetailsInner$new()Initialize a new ValidationErrorResponseDetailsInner class.
ValidationErrorResponseDetailsInner$new(field, message, ...)
fieldfield
messagemessage
...Other optional arguments.
ValidationErrorResponseDetailsInner$toList()Convert to a List
Convert the R6 object to a list to work more easily with other tooling.
ValidationErrorResponseDetailsInner$toList()
ValidationErrorResponseDetailsInner as a base R list.
# convert array of ValidationErrorResponseDetailsInner (x) to a data frame library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df
ValidationErrorResponseDetailsInner$toSimpleType()Convert ValidationErrorResponseDetailsInner to a base R type
ValidationErrorResponseDetailsInner$toSimpleType()
A base R type, e.g. a list or numeric/character array.
ValidationErrorResponseDetailsInner$fromJSON()Deserialize JSON string into an instance of ValidationErrorResponseDetailsInner
ValidationErrorResponseDetailsInner$fromJSON(input_json)
input_jsonthe JSON input
the instance of ValidationErrorResponseDetailsInner
ValidationErrorResponseDetailsInner$toJSONString()To JSON String
ValidationErrorResponseDetailsInner$toJSONString(...)
...Parameters passed to 'jsonlite::toJSON'
ValidationErrorResponseDetailsInner in JSON format
ValidationErrorResponseDetailsInner$fromJSONString()Deserialize JSON string into an instance of ValidationErrorResponseDetailsInner
ValidationErrorResponseDetailsInner$fromJSONString(input_json)
input_jsonthe JSON input
the instance of ValidationErrorResponseDetailsInner
ValidationErrorResponseDetailsInner$validateJSON()Validate JSON input with respect to ValidationErrorResponseDetailsInner and throw an exception if invalid
ValidationErrorResponseDetailsInner$validateJSON(input)
inputthe JSON input
ValidationErrorResponseDetailsInner$toString()To string (JSON format)
ValidationErrorResponseDetailsInner$toString()
String representation of ValidationErrorResponseDetailsInner
ValidationErrorResponseDetailsInner$isValid()Return true if the values in all fields are valid.
ValidationErrorResponseDetailsInner$isValid()
true if the values in all fields are valid.
ValidationErrorResponseDetailsInner$getInvalidFields()Return a list of invalid fields (if any).
ValidationErrorResponseDetailsInner$getInvalidFields()
A list of invalid fields (if any).
ValidationErrorResponseDetailsInner$print()Print the object
ValidationErrorResponseDetailsInner$print()
ValidationErrorResponseDetailsInner$clone()The objects of this class are cloneable with this method.
ValidationErrorResponseDetailsInner$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `ValidationErrorResponseDetailsInner$toList()` ## ------------------------------------------------ # convert array of ValidationErrorResponseDetailsInner (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)## ------------------------------------------------ ## Method `ValidationErrorResponseDetailsInner$toList()` ## ------------------------------------------------ # convert array of ValidationErrorResponseDetailsInner (x) to a data frame ## Not run: library(purrr) library(tibble) df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind() df ## End(Not run)