R/first_last_name_origined_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 FirstLastNameOriginedOut
#' @description FirstLastNameOriginedOut Class
#' @format An \code{R6Class} generator object
#' @field id  character [optional]
#'
#' @field firstName  character [optional]
#'
#' @field lastName  character [optional]
#'
#' @field countryOrigin  character [optional]
#'
#' @field countryOriginAlt  character [optional]
#'
#' @field countriesOriginTop  list( character ) [optional]
#'
#' @field score  numeric [optional]
#'
#' @field regionOrigin  character [optional]
#'
#' @field topRegionOrigin  character [optional]
#'
#' @field subRegionOrigin  character [optional]
#'
#' @field probabilityCalibrated  numeric [optional]
#'
#' @field probabilityAltCalibrated  numeric [optional]
#'
#'
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
FirstLastNameOriginedOut <- R6::R6Class(
  'FirstLastNameOriginedOut',
  public = list(
    `id` = NULL,
    `firstName` = NULL,
    `lastName` = NULL,
    `countryOrigin` = NULL,
    `countryOriginAlt` = NULL,
    `countriesOriginTop` = NULL,
    `score` = NULL,
    `regionOrigin` = NULL,
    `topRegionOrigin` = NULL,
    `subRegionOrigin` = NULL,
    `probabilityCalibrated` = NULL,
    `probabilityAltCalibrated` = NULL,
    initialize = function(`id`=NULL, `firstName`=NULL, `lastName`=NULL, `countryOrigin`=NULL, `countryOriginAlt`=NULL, `countriesOriginTop`=NULL, `score`=NULL, `regionOrigin`=NULL, `topRegionOrigin`=NULL, `subRegionOrigin`=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(`firstName`)) {
        stopifnot(is.character(`firstName`), length(`firstName`) == 1)
        self$`firstName` <- `firstName`
      }
      if (!is.null(`lastName`)) {
        stopifnot(is.character(`lastName`), length(`lastName`) == 1)
        self$`lastName` <- `lastName`
      }
      if (!is.null(`countryOrigin`)) {
        stopifnot(is.character(`countryOrigin`), length(`countryOrigin`) == 1)
        self$`countryOrigin` <- `countryOrigin`
      }
      if (!is.null(`countryOriginAlt`)) {
        stopifnot(is.character(`countryOriginAlt`), length(`countryOriginAlt`) == 1)
        self$`countryOriginAlt` <- `countryOriginAlt`
      }
      if (!is.null(`countriesOriginTop`)) {
        stopifnot(is.vector(`countriesOriginTop`), length(`countriesOriginTop`) != 0)
        sapply(`countriesOriginTop`, function(x) stopifnot(is.character(x)))
        self$`countriesOriginTop` <- `countriesOriginTop`
      }
      if (!is.null(`score`)) {
        stopifnot(is.numeric(`score`), length(`score`) == 1)
        self$`score` <- `score`
      }
      if (!is.null(`regionOrigin`)) {
        stopifnot(is.character(`regionOrigin`), length(`regionOrigin`) == 1)
        self$`regionOrigin` <- `regionOrigin`
      }
      if (!is.null(`topRegionOrigin`)) {
        stopifnot(is.character(`topRegionOrigin`), length(`topRegionOrigin`) == 1)
        self$`topRegionOrigin` <- `topRegionOrigin`
      }
      if (!is.null(`subRegionOrigin`)) {
        stopifnot(is.character(`subRegionOrigin`), length(`subRegionOrigin`) == 1)
        self$`subRegionOrigin` <- `subRegionOrigin`
      }
      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() {
      FirstLastNameOriginedOutObject <- list()
      if (!is.null(self$`id`)) {
        FirstLastNameOriginedOutObject[['id']] <-
          self$`id`
      }
      if (!is.null(self$`firstName`)) {
        FirstLastNameOriginedOutObject[['firstName']] <-
          self$`firstName`
      }
      if (!is.null(self$`lastName`)) {
        FirstLastNameOriginedOutObject[['lastName']] <-
          self$`lastName`
      }
      if (!is.null(self$`countryOrigin`)) {
        FirstLastNameOriginedOutObject[['countryOrigin']] <-
          self$`countryOrigin`
      }
      if (!is.null(self$`countryOriginAlt`)) {
        FirstLastNameOriginedOutObject[['countryOriginAlt']] <-
          self$`countryOriginAlt`
      }
      if (!is.null(self$`countriesOriginTop`)) {
        FirstLastNameOriginedOutObject[['countriesOriginTop']] <-
          self$`countriesOriginTop`
      }
      if (!is.null(self$`score`)) {
        FirstLastNameOriginedOutObject[['score']] <-
          self$`score`
      }
      if (!is.null(self$`regionOrigin`)) {
        FirstLastNameOriginedOutObject[['regionOrigin']] <-
          self$`regionOrigin`
      }
      if (!is.null(self$`topRegionOrigin`)) {
        FirstLastNameOriginedOutObject[['topRegionOrigin']] <-
          self$`topRegionOrigin`
      }
      if (!is.null(self$`subRegionOrigin`)) {
        FirstLastNameOriginedOutObject[['subRegionOrigin']] <-
          self$`subRegionOrigin`
      }
      if (!is.null(self$`probabilityCalibrated`)) {
        FirstLastNameOriginedOutObject[['probabilityCalibrated']] <-
          self$`probabilityCalibrated`
      }
      if (!is.null(self$`probabilityAltCalibrated`)) {
        FirstLastNameOriginedOutObject[['probabilityAltCalibrated']] <-
          self$`probabilityAltCalibrated`
      }

      FirstLastNameOriginedOutObject
    },
    fromJSON = function(FirstLastNameOriginedOutJson) {
      FirstLastNameOriginedOutObject <- jsonlite::fromJSON(FirstLastNameOriginedOutJson)
      if (!is.null(FirstLastNameOriginedOutObject$`id`)) {
        self$`id` <- FirstLastNameOriginedOutObject$`id`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`firstName`)) {
        self$`firstName` <- FirstLastNameOriginedOutObject$`firstName`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`lastName`)) {
        self$`lastName` <- FirstLastNameOriginedOutObject$`lastName`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`countryOrigin`)) {
        self$`countryOrigin` <- FirstLastNameOriginedOutObject$`countryOrigin`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`countryOriginAlt`)) {
        self$`countryOriginAlt` <- FirstLastNameOriginedOutObject$`countryOriginAlt`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`countriesOriginTop`)) {
        self$`countriesOriginTop` <- ApiClient$new()$deserializeObj(FirstLastNameOriginedOutObject$`countriesOriginTop`, "array[character]", loadNamespace("namsor"))
      }
      if (!is.null(FirstLastNameOriginedOutObject$`score`)) {
        self$`score` <- FirstLastNameOriginedOutObject$`score`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`regionOrigin`)) {
        self$`regionOrigin` <- FirstLastNameOriginedOutObject$`regionOrigin`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`topRegionOrigin`)) {
        self$`topRegionOrigin` <- FirstLastNameOriginedOutObject$`topRegionOrigin`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`subRegionOrigin`)) {
        self$`subRegionOrigin` <- FirstLastNameOriginedOutObject$`subRegionOrigin`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`probabilityCalibrated`)) {
        self$`probabilityCalibrated` <- FirstLastNameOriginedOutObject$`probabilityCalibrated`
      }
      if (!is.null(FirstLastNameOriginedOutObject$`probabilityAltCalibrated`)) {
        self$`probabilityAltCalibrated` <- FirstLastNameOriginedOutObject$`probabilityAltCalibrated`
      }
    },
    toJSONString = function() {
      jsoncontent <- c(
        if (!is.null(self$`id`)) {
        sprintf(
        '"id":
          "%s"
                ',
        self$`id`
        )},
        if (!is.null(self$`firstName`)) {
        sprintf(
        '"firstName":
          "%s"
                ',
        self$`firstName`
        )},
        if (!is.null(self$`lastName`)) {
        sprintf(
        '"lastName":
          "%s"
                ',
        self$`lastName`
        )},
        if (!is.null(self$`countryOrigin`)) {
        sprintf(
        '"countryOrigin":
          "%s"
                ',
        self$`countryOrigin`
        )},
        if (!is.null(self$`countryOriginAlt`)) {
        sprintf(
        '"countryOriginAlt":
          "%s"
                ',
        self$`countryOriginAlt`
        )},
        if (!is.null(self$`countriesOriginTop`)) {
        sprintf(
        '"countriesOriginTop":
           [%s]
        ',
        paste(unlist(lapply(self$`countriesOriginTop`, function(x) paste0('"', x, '"'))), collapse=",")
        )},
        if (!is.null(self$`score`)) {
        sprintf(
        '"score":
          %d
                ',
        self$`score`
        )},
        if (!is.null(self$`regionOrigin`)) {
        sprintf(
        '"regionOrigin":
          "%s"
                ',
        self$`regionOrigin`
        )},
        if (!is.null(self$`topRegionOrigin`)) {
        sprintf(
        '"topRegionOrigin":
          "%s"
                ',
        self$`topRegionOrigin`
        )},
        if (!is.null(self$`subRegionOrigin`)) {
        sprintf(
        '"subRegionOrigin":
          "%s"
                ',
        self$`subRegionOrigin`
        )},
        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(FirstLastNameOriginedOutJson) {
      FirstLastNameOriginedOutObject <- jsonlite::fromJSON(FirstLastNameOriginedOutJson)
      self$`id` <- FirstLastNameOriginedOutObject$`id`
      self$`firstName` <- FirstLastNameOriginedOutObject$`firstName`
      self$`lastName` <- FirstLastNameOriginedOutObject$`lastName`
      self$`countryOrigin` <- FirstLastNameOriginedOutObject$`countryOrigin`
      self$`countryOriginAlt` <- FirstLastNameOriginedOutObject$`countryOriginAlt`
      self$`countriesOriginTop` <- ApiClient$new()$deserializeObj(FirstLastNameOriginedOutObject$`countriesOriginTop`, "array[character]", loadNamespace("namsor"))
      self$`score` <- FirstLastNameOriginedOutObject$`score`
      self$`regionOrigin` <- FirstLastNameOriginedOutObject$`regionOrigin`
      self$`topRegionOrigin` <- FirstLastNameOriginedOutObject$`topRegionOrigin`
      self$`subRegionOrigin` <- FirstLastNameOriginedOutObject$`subRegionOrigin`
      self$`probabilityCalibrated` <- FirstLastNameOriginedOutObject$`probabilityCalibrated`
      self$`probabilityAltCalibrated` <- FirstLastNameOriginedOutObject$`probabilityAltCalibrated`
      self
    }
  )
)