mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-11-04 02:33:54 +00:00
e3e06af5f4
* [r client] fix to-list and to-json functionality * fix type of json string * wip * refactor pr * regenerate samples * update to-dataframe example to use non-superceded tidyverse functions * fix typo
277 lines
9.9 KiB
R
277 lines
9.9 KiB
R
#' Create a new Date
|
|
#'
|
|
#' @description
|
|
#' to test the model name `Date`
|
|
#'
|
|
#' @docType class
|
|
#' @title Date
|
|
#' @description Date Class
|
|
#' @format An \code{R6Class} generator object
|
|
#' @field className character
|
|
#' @field percent_description using \% in the description character [optional]
|
|
#' @field url_property character
|
|
#' @field _field_list a list of fields list(character)
|
|
#' @field additional_properties additional properties list(character) [optional]
|
|
#' @importFrom R6 R6Class
|
|
#' @importFrom jsonlite fromJSON toJSON
|
|
#' @export
|
|
Date <- R6::R6Class(
|
|
"Date",
|
|
public = list(
|
|
`className` = NULL,
|
|
`percent_description` = NULL,
|
|
`url_property` = NULL,
|
|
`_field_list` = c("className", "percent_description", "url_property"),
|
|
`additional_properties` = list(),
|
|
|
|
#' @description
|
|
#' Initialize a new Date class.
|
|
#'
|
|
#' @param className className
|
|
#' @param url_property url_property
|
|
#' @param percent_description using \% in the description
|
|
#' @param additional_properties additional properties (optional)
|
|
#' @param ... Other optional arguments.
|
|
initialize = function(`className`, `url_property`, `percent_description` = NULL, additional_properties = NULL, ...) {
|
|
if (!missing(`className`)) {
|
|
if (!(is.character(`className`) && length(`className`) == 1)) {
|
|
stop(paste("Error! Invalid data for `className`. Must be a string:", `className`))
|
|
}
|
|
self$`className` <- `className`
|
|
}
|
|
if (!missing(`url_property`)) {
|
|
if (!(is.character(`url_property`) && length(`url_property`) == 1)) {
|
|
stop(paste("Error! Invalid data for `url_property`. Must be a string:", `url_property`))
|
|
}
|
|
# to validate URL. ref: https://stackoverflow.com/questions/73952024/url-validation-in-r
|
|
if (!stringr::str_detect(`url_property`, "(https?|ftp)://[^ /$.?#].[^\\s]*")) {
|
|
stop(paste("Error! Invalid data for `url_property`. Must be a URL:", `url_property`))
|
|
}
|
|
self$`url_property` <- `url_property`
|
|
}
|
|
if (!is.null(`percent_description`)) {
|
|
if (!(is.character(`percent_description`) && length(`percent_description`) == 1)) {
|
|
stop(paste("Error! Invalid data for `percent_description`. Must be a string:", `percent_description`))
|
|
}
|
|
self$`percent_description` <- `percent_description`
|
|
}
|
|
if (!is.null(additional_properties)) {
|
|
for (key in names(additional_properties)) {
|
|
self$additional_properties[[key]] <- additional_properties[[key]]
|
|
}
|
|
}
|
|
},
|
|
|
|
#' @description
|
|
#' Convert to an R object. This method is deprecated. Use `toSimpleType()` instead.
|
|
toJSON = function() {
|
|
.Deprecated(new = "toSimpleType", msg = "Use the '$toSimpleType()' method instead since that is more clearly named. Use '$toJSONString()' to get a JSON string")
|
|
return(self$toSimpleType())
|
|
},
|
|
|
|
#' @description
|
|
#' Convert to a List
|
|
#'
|
|
#' Convert the R6 object to a list to work more easily with other tooling.
|
|
#'
|
|
#' @return Date as a base R list.
|
|
#' @examples
|
|
#' # convert array of Date (x) to a data frame
|
|
#' \dontrun{
|
|
#' library(purrr)
|
|
#' library(tibble)
|
|
#' df <- x |> map(\(y)y$toList()) |> map(as_tibble) |> list_rbind()
|
|
#' df
|
|
#' }
|
|
toList = function() {
|
|
return(self$toSimpleType())
|
|
},
|
|
|
|
#' @description
|
|
#' Convert Date to a base R type
|
|
#'
|
|
#' @return A base R type, e.g. a list or numeric/character array.
|
|
toSimpleType = function() {
|
|
DateObject <- list()
|
|
if (!is.null(self$`className`)) {
|
|
DateObject[["className"]] <-
|
|
self$`className`
|
|
}
|
|
if (!is.null(self$`percent_description`)) {
|
|
DateObject[["percent_description"]] <-
|
|
self$`percent_description`
|
|
}
|
|
if (!is.null(self$`url_property`)) {
|
|
DateObject[["url_property"]] <-
|
|
self$`url_property`
|
|
}
|
|
for (key in names(self$additional_properties)) {
|
|
DateObject[[key]] <- self$additional_properties[[key]]
|
|
}
|
|
|
|
return(DateObject)
|
|
},
|
|
|
|
#' @description
|
|
#' Deserialize JSON string into an instance of Date
|
|
#'
|
|
#' @param input_json the JSON input
|
|
#' @return the instance of Date
|
|
fromJSON = function(input_json) {
|
|
this_object <- jsonlite::fromJSON(input_json)
|
|
if (!is.null(this_object$`className`)) {
|
|
self$`className` <- this_object$`className`
|
|
}
|
|
if (!is.null(this_object$`percent_description`)) {
|
|
self$`percent_description` <- this_object$`percent_description`
|
|
}
|
|
if (!is.null(this_object$`url_property`)) {
|
|
# to validate URL. ref: https://stackoverflow.com/questions/73952024/url-validation-in-r
|
|
if (!stringr::str_detect(this_object$`url_property`, "(https?|ftp)://[^ /$.?#].[^\\s]*")) {
|
|
stop(paste("Error! Invalid data for `url_property`. Must be a URL:", this_object$`url_property`))
|
|
}
|
|
self$`url_property` <- this_object$`url_property`
|
|
}
|
|
# process additional properties/fields in the payload
|
|
for (key in names(this_object)) {
|
|
if (!(key %in% self$`_field_list`)) { # json key not in list of fields
|
|
self$additional_properties[[key]] <- this_object[[key]]
|
|
}
|
|
}
|
|
|
|
self
|
|
},
|
|
|
|
#' @description
|
|
#' To JSON String
|
|
#'
|
|
#' @param ... Parameters passed to `jsonlite::toJSON`
|
|
#' @return Date in JSON format
|
|
toJSONString = function(...) {
|
|
simple <- self$toSimpleType()
|
|
for (key in names(self$additional_properties)) {
|
|
simple[[key]] <- self$additional_properties[[key]]
|
|
}
|
|
json <- jsonlite::toJSON(simple, auto_unbox = TRUE, digits = NA, ...)
|
|
return(as.character(jsonlite::minify(json)))
|
|
},
|
|
|
|
#' @description
|
|
#' Deserialize JSON string into an instance of Date
|
|
#'
|
|
#' @param input_json the JSON input
|
|
#' @return the instance of Date
|
|
fromJSONString = function(input_json) {
|
|
this_object <- jsonlite::fromJSON(input_json)
|
|
self$`className` <- this_object$`className`
|
|
self$`percent_description` <- this_object$`percent_description`
|
|
# to validate URL. ref: https://stackoverflow.com/questions/73952024/url-validation-in-r
|
|
if (!stringr::str_detect(this_object$`url_property`, "(https?|ftp)://[^ /$.?#].[^\\s]*")) {
|
|
stop(paste("Error! Invalid data for `url_property`. Must be a URL:", this_object$`url_property`))
|
|
}
|
|
self$`url_property` <- this_object$`url_property`
|
|
# process additional properties/fields in the payload
|
|
for (key in names(this_object)) {
|
|
if (!(key %in% self$`_field_list`)) { # json key not in list of fields
|
|
self$additional_properties[[key]] <- this_object[[key]]
|
|
}
|
|
}
|
|
|
|
self
|
|
},
|
|
|
|
#' @description
|
|
#' Validate JSON input with respect to Date and throw an exception if invalid
|
|
#'
|
|
#' @param input the JSON input
|
|
validateJSON = function(input) {
|
|
input_json <- jsonlite::fromJSON(input)
|
|
# check the required field `className`
|
|
if (!is.null(input_json$`className`)) {
|
|
if (!(is.character(input_json$`className`) && length(input_json$`className`) == 1)) {
|
|
stop(paste("Error! Invalid data for `className`. Must be a string:", input_json$`className`))
|
|
}
|
|
} else {
|
|
stop(paste("The JSON input `", input, "` is invalid for Date: the required field `className` is missing."))
|
|
}
|
|
# check the required field `url_property`
|
|
if (!is.null(input_json$`url_property`)) {
|
|
if (!(is.character(input_json$`url_property`) && length(input_json$`url_property`) == 1)) {
|
|
stop(paste("Error! Invalid data for `url_property`. Must be a string:", input_json$`url_property`))
|
|
}
|
|
# to validate URL. ref: https://stackoverflow.com/questions/73952024/url-validation-in-r
|
|
if (!stringr::str_detect(input_json$`url_property`, "(https?|ftp)://[^ /$.?#].[^\\s]*")) {
|
|
stop(paste("Error! Invalid data for `url_property`. Must be a URL:", input_json$`url_property`))
|
|
}
|
|
} else {
|
|
stop(paste("The JSON input `", input, "` is invalid for Date: the required field `url_property` is missing."))
|
|
}
|
|
},
|
|
|
|
#' @description
|
|
#' To string (JSON format)
|
|
#'
|
|
#' @return String representation of Date
|
|
toString = function() {
|
|
self$toJSONString()
|
|
},
|
|
|
|
#' @description
|
|
#' Return true if the values in all fields are valid.
|
|
#'
|
|
#' @return true if the values in all fields are valid.
|
|
isValid = function() {
|
|
# check if the required `className` is null
|
|
if (is.null(self$`className`)) {
|
|
return(FALSE)
|
|
}
|
|
|
|
# check if the required `url_property` is null
|
|
if (is.null(self$`url_property`)) {
|
|
return(FALSE)
|
|
}
|
|
|
|
TRUE
|
|
},
|
|
|
|
#' @description
|
|
#' Return a list of invalid fields (if any).
|
|
#'
|
|
#' @return A list of invalid fields (if any).
|
|
getInvalidFields = function() {
|
|
invalid_fields <- list()
|
|
# check if the required `className` is null
|
|
if (is.null(self$`className`)) {
|
|
invalid_fields["className"] <- "Non-nullable required field `className` cannot be null."
|
|
}
|
|
|
|
# check if the required `url_property` is null
|
|
if (is.null(self$`url_property`)) {
|
|
invalid_fields["url_property"] <- "Non-nullable required field `url_property` cannot be null."
|
|
}
|
|
|
|
invalid_fields
|
|
},
|
|
|
|
#' @description
|
|
#' Print the object
|
|
print = function() {
|
|
print(jsonlite::prettify(self$toJSONString()))
|
|
invisible(self)
|
|
}
|
|
),
|
|
# Lock the class to prevent modifications to the method or field
|
|
lock_class = TRUE
|
|
)
|
|
## Uncomment below to unlock the class to allow modifications of the method or field
|
|
# Date$unlock()
|
|
#
|
|
## Below is an example to define the print function
|
|
# Date$set("public", "print", function(...) {
|
|
# print(jsonlite::prettify(self$toJSONString()))
|
|
# invisible(self)
|
|
# })
|
|
## Uncomment below to lock the class to prevent modifications to the method or field
|
|
# Date$lock()
|
|
|