R/personal_name_geo_out.R

In namsor/namsor-r-sdk2: R Package Client for NamSor API v2

# NamSor API v2
#
# NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! 
#
# The version of the OpenAPI document: 2.0.10
# Contact: contact@namsor.com
# Generated by: https://openapi-generator.tech

#' @docType class
#' @title PersonalNameGeoOut
#' @description PersonalNameGeoOut Class
#' @format An \code{R6Class} generator object
#' @field id  character [optional]
#'
#' @field name  character [optional]
#'
#' @field score  numeric [optional]
#'
#' @field country  character [optional]
#'
#' @field countryAlt  character [optional]
#'
#' @field region  character [optional]
#'
#' @field topRegion  character [optional]
#'
#' @field subRegion  character [optional]
#'
#' @field countriesTop  list( character ) [optional]
#'
#' @field probabilityCalibrated  numeric [optional]
#'
#' @field probabilityAltCalibrated  numeric [optional]
#'
#'
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
PersonalNameGeoOut <- R6::R6Class(
  'PersonalNameGeoOut',
  public = list(
    `id` = NULL,
    `name` = NULL,
    `score` = NULL,
    `country` = NULL,
    `countryAlt` = NULL,
    `region` = NULL,
    `topRegion` = NULL,
    `subRegion` = NULL,
    `countriesTop` = NULL,
    `probabilityCalibrated` = NULL,
    `probabilityAltCalibrated` = NULL,
    initialize = function(`id`=NULL, `name`=NULL, `score`=NULL, `country`=NULL, `countryAlt`=NULL, `region`=NULL, `topRegion`=NULL, `subRegion`=NULL, `countriesTop`=NULL, `probabilityCalibrated`=NULL, `probabilityAltCalibrated`=NULL, ...){
      local.optional.var <- list(...)
      if (!is.null(`id`)) {
        stopifnot(is.character(`id`), length(`id`) == 1)
        self$`id` <- `id`
      }
      if (!is.null(`name`)) {
        stopifnot(is.character(`name`), length(`name`) == 1)
        self$`name` <- `name`
      }
      if (!is.null(`score`)) {
        stopifnot(is.numeric(`score`), length(`score`) == 1)
        self$`score` <- `score`
      }
      if (!is.null(`country`)) {
        stopifnot(is.character(`country`), length(`country`) == 1)
        self$`country` <- `country`
      }
      if (!is.null(`countryAlt`)) {
        stopifnot(is.character(`countryAlt`), length(`countryAlt`) == 1)
        self$`countryAlt` <- `countryAlt`
      }
      if (!is.null(`region`)) {
        stopifnot(is.character(`region`), length(`region`) == 1)
        self$`region` <- `region`
      }
      if (!is.null(`topRegion`)) {
        stopifnot(is.character(`topRegion`), length(`topRegion`) == 1)
        self$`topRegion` <- `topRegion`
      }
      if (!is.null(`subRegion`)) {
        stopifnot(is.character(`subRegion`), length(`subRegion`) == 1)
        self$`subRegion` <- `subRegion`
      }
      if (!is.null(`countriesTop`)) {
        stopifnot(is.vector(`countriesTop`), length(`countriesTop`) != 0)
        sapply(`countriesTop`, function(x) stopifnot(is.character(x)))
        self$`countriesTop` <- `countriesTop`
      }
      if (!is.null(`probabilityCalibrated`)) {
        stopifnot(is.numeric(`probabilityCalibrated`), length(`probabilityCalibrated`) == 1)
        self$`probabilityCalibrated` <- `probabilityCalibrated`
      }
      if (!is.null(`probabilityAltCalibrated`)) {
        stopifnot(is.numeric(`probabilityAltCalibrated`), length(`probabilityAltCalibrated`) == 1)
        self$`probabilityAltCalibrated` <- `probabilityAltCalibrated`
      }
    },
    toJSON = function() {
      PersonalNameGeoOutObject <- list()
      if (!is.null(self$`id`)) {
        PersonalNameGeoOutObject[['id']] <-
          self$`id`
      }
      if (!is.null(self$`name`)) {
        PersonalNameGeoOutObject[['name']] <-
          self$`name`
      }
      if (!is.null(self$`score`)) {
        PersonalNameGeoOutObject[['score']] <-
          self$`score`
      }
      if (!is.null(self$`country`)) {
        PersonalNameGeoOutObject[['country']] <-
          self$`country`
      }
      if (!is.null(self$`countryAlt`)) {
        PersonalNameGeoOutObject[['countryAlt']] <-
          self$`countryAlt`
      }
      if (!is.null(self$`region`)) {
        PersonalNameGeoOutObject[['region']] <-
          self$`region`
      }
      if (!is.null(self$`topRegion`)) {
        PersonalNameGeoOutObject[['topRegion']] <-
          self$`topRegion`
      }
      if (!is.null(self$`subRegion`)) {
        PersonalNameGeoOutObject[['subRegion']] <-
          self$`subRegion`
      }
      if (!is.null(self$`countriesTop`)) {
        PersonalNameGeoOutObject[['countriesTop']] <-
          self$`countriesTop`
      }
      if (!is.null(self$`probabilityCalibrated`)) {
        PersonalNameGeoOutObject[['probabilityCalibrated']] <-
          self$`probabilityCalibrated`
      }
      if (!is.null(self$`probabilityAltCalibrated`)) {
        PersonalNameGeoOutObject[['probabilityAltCalibrated']] <-
          self$`probabilityAltCalibrated`
      }

      PersonalNameGeoOutObject
    },
    fromJSON = function(PersonalNameGeoOutJson) {
      PersonalNameGeoOutObject <- jsonlite::fromJSON(PersonalNameGeoOutJson)
      if (!is.null(PersonalNameGeoOutObject$`id`)) {
        self$`id` <- PersonalNameGeoOutObject$`id`
      }
      if (!is.null(PersonalNameGeoOutObject$`name`)) {
        self$`name` <- PersonalNameGeoOutObject$`name`
      }
      if (!is.null(PersonalNameGeoOutObject$`score`)) {
        self$`score` <- PersonalNameGeoOutObject$`score`
      }
      if (!is.null(PersonalNameGeoOutObject$`country`)) {
        self$`country` <- PersonalNameGeoOutObject$`country`
      }
      if (!is.null(PersonalNameGeoOutObject$`countryAlt`)) {
        self$`countryAlt` <- PersonalNameGeoOutObject$`countryAlt`
      }
      if (!is.null(PersonalNameGeoOutObject$`region`)) {
        self$`region` <- PersonalNameGeoOutObject$`region`
      }
      if (!is.null(PersonalNameGeoOutObject$`topRegion`)) {
        self$`topRegion` <- PersonalNameGeoOutObject$`topRegion`
      }
      if (!is.null(PersonalNameGeoOutObject$`subRegion`)) {
        self$`subRegion` <- PersonalNameGeoOutObject$`subRegion`
      }
      if (!is.null(PersonalNameGeoOutObject$`countriesTop`)) {
        self$`countriesTop` <- ApiClient$new()$deserializeObj(PersonalNameGeoOutObject$`countriesTop`, "array[character]", loadNamespace("namsor"))
      }
      if (!is.null(PersonalNameGeoOutObject$`probabilityCalibrated`)) {
        self$`probabilityCalibrated` <- PersonalNameGeoOutObject$`probabilityCalibrated`
      }
      if (!is.null(PersonalNameGeoOutObject$`probabilityAltCalibrated`)) {
        self$`probabilityAltCalibrated` <- PersonalNameGeoOutObject$`probabilityAltCalibrated`
      }
    },
    toJSONString = function() {
      jsoncontent <- c(
        if (!is.null(self$`id`)) {
        sprintf(
        '"id":
          "%s"
                ',
        self$`id`
        )},
        if (!is.null(self$`name`)) {
        sprintf(
        '"name":
          "%s"
                ',
        self$`name`
        )},
        if (!is.null(self$`score`)) {
        sprintf(
        '"score":
          %d
                ',
        self$`score`
        )},
        if (!is.null(self$`country`)) {
        sprintf(
        '"country":
          "%s"
                ',
        self$`country`
        )},
        if (!is.null(self$`countryAlt`)) {
        sprintf(
        '"countryAlt":
          "%s"
                ',
        self$`countryAlt`
        )},
        if (!is.null(self$`region`)) {
        sprintf(
        '"region":
          "%s"
                ',
        self$`region`
        )},
        if (!is.null(self$`topRegion`)) {
        sprintf(
        '"topRegion":
          "%s"
                ',
        self$`topRegion`
        )},
        if (!is.null(self$`subRegion`)) {
        sprintf(
        '"subRegion":
          "%s"
                ',
        self$`subRegion`
        )},
        if (!is.null(self$`countriesTop`)) {
        sprintf(
        '"countriesTop":
           [%s]
        ',
        paste(unlist(lapply(self$`countriesTop`, function(x) paste0('"', x, '"'))), collapse=",")
        )},
        if (!is.null(self$`probabilityCalibrated`)) {
        sprintf(
        '"probabilityCalibrated":
          %d
                ',
        self$`probabilityCalibrated`
        )},
        if (!is.null(self$`probabilityAltCalibrated`)) {
        sprintf(
        '"probabilityAltCalibrated":
          %d
                ',
        self$`probabilityAltCalibrated`
        )}
      )
      jsoncontent <- paste(jsoncontent, collapse = ",")
      paste('{', jsoncontent, '}', sep = "")
    },
    fromJSONString = function(PersonalNameGeoOutJson) {
      PersonalNameGeoOutObject <- jsonlite::fromJSON(PersonalNameGeoOutJson)
      self$`id` <- PersonalNameGeoOutObject$`id`
      self$`name` <- PersonalNameGeoOutObject$`name`
      self$`score` <- PersonalNameGeoOutObject$`score`
      self$`country` <- PersonalNameGeoOutObject$`country`
      self$`countryAlt` <- PersonalNameGeoOutObject$`countryAlt`
      self$`region` <- PersonalNameGeoOutObject$`region`
      self$`topRegion` <- PersonalNameGeoOutObject$`topRegion`
      self$`subRegion` <- PersonalNameGeoOutObject$`subRegion`
      self$`countriesTop` <- ApiClient$new()$deserializeObj(PersonalNameGeoOutObject$`countriesTop`, "array[character]", loadNamespace("namsor"))
      self$`probabilityCalibrated` <- PersonalNameGeoOutObject$`probabilityCalibrated`
      self$`probabilityAltCalibrated` <- PersonalNameGeoOutObject$`probabilityAltCalibrated`
      self
    }
  )
)