R/personal_name_gendered_out.R

# 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 PersonalNameGenderedOut
#' @description PersonalNameGenderedOut Class
#' @format An \code{R6Class} generator object
#' @field id  character [optional]
#'
#' @field name  character [optional]
#'
#' @field likelyGender  character [optional]
#'
#' @field genderScale  numeric [optional]
#'
#' @field score  numeric [optional]
#'
#' @field probabilityCalibrated  numeric [optional]
#'
#'
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
PersonalNameGenderedOut <- R6::R6Class(
  'PersonalNameGenderedOut',
  public = list(
    `id` = NULL,
    `name` = NULL,
    `likelyGender` = NULL,
    `genderScale` = NULL,
    `score` = NULL,
    `probabilityCalibrated` = NULL,
    initialize = function(`id`=NULL, `name`=NULL, `likelyGender`=NULL, `genderScale`=NULL, `score`=NULL, `probabilityCalibrated`=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(`likelyGender`)) {
        stopifnot(is.character(`likelyGender`), length(`likelyGender`) == 1)
        self$`likelyGender` <- `likelyGender`
      }
      if (!is.null(`genderScale`)) {
        stopifnot(is.numeric(`genderScale`), length(`genderScale`) == 1)
        self$`genderScale` <- `genderScale`
      }
      if (!is.null(`score`)) {
        stopifnot(is.numeric(`score`), length(`score`) == 1)
        self$`score` <- `score`
      }
      if (!is.null(`probabilityCalibrated`)) {
        stopifnot(is.numeric(`probabilityCalibrated`), length(`probabilityCalibrated`) == 1)
        self$`probabilityCalibrated` <- `probabilityCalibrated`
      }
    },
    toJSON = function() {
      PersonalNameGenderedOutObject <- list()
      if (!is.null(self$`id`)) {
        PersonalNameGenderedOutObject[['id']] <-
          self$`id`
      }
      if (!is.null(self$`name`)) {
        PersonalNameGenderedOutObject[['name']] <-
          self$`name`
      }
      if (!is.null(self$`likelyGender`)) {
        PersonalNameGenderedOutObject[['likelyGender']] <-
          self$`likelyGender`
      }
      if (!is.null(self$`genderScale`)) {
        PersonalNameGenderedOutObject[['genderScale']] <-
          self$`genderScale`
      }
      if (!is.null(self$`score`)) {
        PersonalNameGenderedOutObject[['score']] <-
          self$`score`
      }
      if (!is.null(self$`probabilityCalibrated`)) {
        PersonalNameGenderedOutObject[['probabilityCalibrated']] <-
          self$`probabilityCalibrated`
      }

      PersonalNameGenderedOutObject
    },
    fromJSON = function(PersonalNameGenderedOutJson) {
      PersonalNameGenderedOutObject <- jsonlite::fromJSON(PersonalNameGenderedOutJson)
      if (!is.null(PersonalNameGenderedOutObject$`id`)) {
        self$`id` <- PersonalNameGenderedOutObject$`id`
      }
      if (!is.null(PersonalNameGenderedOutObject$`name`)) {
        self$`name` <- PersonalNameGenderedOutObject$`name`
      }
      if (!is.null(PersonalNameGenderedOutObject$`likelyGender`)) {
        self$`likelyGender` <- PersonalNameGenderedOutObject$`likelyGender`
      }
      if (!is.null(PersonalNameGenderedOutObject$`genderScale`)) {
        self$`genderScale` <- PersonalNameGenderedOutObject$`genderScale`
      }
      if (!is.null(PersonalNameGenderedOutObject$`score`)) {
        self$`score` <- PersonalNameGenderedOutObject$`score`
      }
      if (!is.null(PersonalNameGenderedOutObject$`probabilityCalibrated`)) {
        self$`probabilityCalibrated` <- PersonalNameGenderedOutObject$`probabilityCalibrated`
      }
    },
    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$`likelyGender`)) {
        sprintf(
        '"likelyGender":
          "%s"
                ',
        self$`likelyGender`
        )},
        if (!is.null(self$`genderScale`)) {
        sprintf(
        '"genderScale":
          %d
                ',
        self$`genderScale`
        )},
        if (!is.null(self$`score`)) {
        sprintf(
        '"score":
          %d
                ',
        self$`score`
        )},
        if (!is.null(self$`probabilityCalibrated`)) {
        sprintf(
        '"probabilityCalibrated":
          %d
                ',
        self$`probabilityCalibrated`
        )}
      )
      jsoncontent <- paste(jsoncontent, collapse = ",")
      paste('{', jsoncontent, '}', sep = "")
    },
    fromJSONString = function(PersonalNameGenderedOutJson) {
      PersonalNameGenderedOutObject <- jsonlite::fromJSON(PersonalNameGenderedOutJson)
      self$`id` <- PersonalNameGenderedOutObject$`id`
      self$`name` <- PersonalNameGenderedOutObject$`name`
      self$`likelyGender` <- PersonalNameGenderedOutObject$`likelyGender`
      self$`genderScale` <- PersonalNameGenderedOutObject$`genderScale`
      self$`score` <- PersonalNameGenderedOutObject$`score`
      self$`probabilityCalibrated` <- PersonalNameGenderedOutObject$`probabilityCalibrated`
      self
    }
  )
)
namsor/namsor-r-sdk2 documentation built on March 15, 2021, 7:12 p.m.