Documentation

ExportOptions
in package

MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable

ExportOptions Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

DISCRIMINATOR = null
OUTPUT_FORMAT__DEFAULT = 'CSV_DEFAULT'
OUTPUT_FORMAT_EXCEL = 'CSV_EXCEL'
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$openAPIFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$openAPIModelName : string: The original name of the model.
$openAPINullables : array<string|int, mixed>: Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull : array<string|int, mixed>: If a nullable field gets set to null, insert it here
$openAPITypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getCreatedEarliestTime() : DateTime|null: Gets created_earliest_time
getCreatedOldestTime() : DateTime|null: Gets created_oldest_time
getExcludePreviouslyExported() : bool|null: Gets exclude_previously_exported
getFilter() : string|null: Gets filter
getListSeparatorToken() : string|null: Gets list_separator_token
getModelName() : string: The original name of the model.
getOutputFormat() : string: Gets output_format
getOutputFormatAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
isNullable() : bool: Checks if a property is nullable
isNullableSetToNull() : bool: Checks if a nullable property is set to null.
jsonSerialize() : mixed: Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed|null: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
openAPIFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
openAPITypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
setCreatedEarliestTime() : self: Sets created_earliest_time
setCreatedOldestTime() : self: Sets created_oldest_time
setExcludePreviouslyExported() : self: Sets exclude_previously_exported
setFilter() : self: Sets filter
setListSeparatorToken() : self: Sets list_separator_token
setOutputFormat() : self: Sets output_format
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
toHeaderValue() : string: Gets a header-safe presentation of the object
valid() : bool: Validate all the properties in the model return true if all passed
openAPINullables() : array<string|int, mixed>: Array of nullable properties
getOpenAPINullablesSetToNull() : array<string|int, bool>: Array of nullable field names deliberately set to null
setIfExists() : void: Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull() : void: Setter - Array of nullable field names deliberately set to null

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

OUTPUT_FORMAT__DEFAULT


    public
        mixed
    OUTPUT_FORMAT__DEFAULT
    = 'CSV_DEFAULT'

OUTPUT_FORMAT_EXCEL


    public
        mixed
    OUTPUT_FORMAT_EXCEL
    = 'CSV_EXCEL'

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['output_format' => 'outputFormat', 'exclude_previously_exported' => 'excludePreviouslyExported', 'created_earliest_time' => 'createdEarliestTime', 'created_oldest_time' => 'createdOldestTime', 'filter' => 'filter', 'list_separator_token' => 'listSeparatorToken']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['output_format' => 'getOutputFormat', 'exclude_previously_exported' => 'getExcludePreviouslyExported', 'created_earliest_time' => 'getCreatedEarliestTime', 'created_oldest_time' => 'getCreatedOldestTime', 'filter' => 'getFilter', 'list_separator_token' => 'getListSeparatorToken']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['output_format' => null, 'exclude_previously_exported' => null, 'created_earliest_time' => 'date-time', 'created_oldest_time' => 'date-time', 'filter' => null, 'list_separator_token' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'ExportOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['output_format' => false, 'exclude_previously_exported' => true, 'created_earliest_time' => true, 'created_oldest_time' => true, 'filter' => true, 'list_separator_token' => true]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here


    protected
        array<string|int, mixed>
    $openAPINullablesSetToNull
     = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $openAPITypes
     = ['output_format' => 'string', 'exclude_previously_exported' => 'bool', 'created_earliest_time' => '\\DateTime', 'created_oldest_time' => '\\DateTime', 'filter' => 'string', 'list_separator_token' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['output_format' => 'setOutputFormat', 'exclude_previously_exported' => 'setExcludePreviouslyExported', 'created_earliest_time' => 'setCreatedEarliestTime', 'created_oldest_time' => 'setCreatedOldestTime', 'filter' => 'setFilter', 'list_separator_token' => 'setListSeparatorToken']

__construct()

Constructor


    public
                    __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                    __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static        attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getCreatedEarliestTime()

Gets created_earliest_time


    public
                    getCreatedEarliestTime() : DateTime|null

Return values

DateTime|null —

getCreatedOldestTime()

Gets created_oldest_time


    public
                    getCreatedOldestTime() : DateTime|null

Return values

DateTime|null —

getExcludePreviouslyExported()

Gets exclude_previously_exported


    public
                    getExcludePreviouslyExported() : bool|null

Return values

bool|null —

getFilter()

Gets filter


    public
                    getFilter() : string|null

Return values

string|null —

getListSeparatorToken()

Gets list_separator_token


    public
                    getListSeparatorToken() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getOutputFormat()

Gets output_format


    public
                    getOutputFormat() : string

Return values

string —

getOutputFormatAllowableValues()

Gets allowable values of the enum


    public
                    getOutputFormatAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static        getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

isNullable()

Checks if a property is nullable


    public
            static        isNullable(string $property) : bool

Parameters

$property : string

Return values

bool —

isNullableSetToNull()

Checks if a nullable property is set to null.


    public
                    isNullableSetToNull(string $property) : bool

Parameters

$property : string

Return values

bool —

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().


    public
                    jsonSerialize() : mixed

Return values

mixed —

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                    listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                    offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                    offsetGet(int $offset) : mixed|null

Parameters

$offset : int: Offset

Return values

mixed|null —

offsetSet()

Sets value based on offset.


    public
                    offsetSet(int|null $offset, mixed $value) : void

Parameters

$offset : int|null: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

openAPIFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static        openAPIFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

openAPITypes()

Array of property to type mappings. Used for (de)serialization


    public
            static        openAPITypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setCreatedEarliestTime()

Sets created_earliest_time


    public
                    setCreatedEarliestTime(DateTime|null $created_earliest_time) : self

Parameters

$created_earliest_time : DateTime|null: created_earliest_time

Return values

self —

setCreatedOldestTime()

Sets created_oldest_time


    public
                    setCreatedOldestTime(DateTime|null $created_oldest_time) : self

Parameters

$created_oldest_time : DateTime|null: created_oldest_time

Return values

self —

setExcludePreviouslyExported()

Sets exclude_previously_exported


    public
                    setExcludePreviouslyExported(bool|null $exclude_previously_exported) : self

Parameters

$exclude_previously_exported : bool|null: exclude_previously_exported

Return values

self —

setFilter()

Sets filter


    public
                    setFilter(string|null $filter) : self

Parameters

$filter : string|null: filter

Return values

self —

setListSeparatorToken()

Sets list_separator_token


    public
                    setListSeparatorToken(string|null $list_separator_token) : self

Parameters

$list_separator_token : string|null: list_separator_token

Return values

self —

setOutputFormat()

Sets output_format


    public
                    setOutputFormat(string $output_format) : self

Parameters

$output_format : string: output_format

Return values

self —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static        setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

toHeaderValue()

Gets a header-safe presentation of the object


    public
                    toHeaderValue() : string

Return values

string —

valid()

Validate all the properties in the model return true if all passed


    public
                    valid() : bool

Return values

bool —

True if all properties are valid

openAPINullables()

Array of nullable properties


    protected
            static        openAPINullables() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null


    private
                    getOpenAPINullablesSetToNull() : array<string|int, bool>

Return values

array<string|int, bool> —

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array


    private
                    setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void

Parameters

$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

Return values

void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null


    private
                    setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void

Parameters

$openAPINullablesSetToNull : array<string|int, bool>

Return values

void —

ExportOptions in package MailSlurp implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

OUTPUT_FORMAT__DEFAULT

OUTPUT_FORMAT_EXCEL

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getCreatedEarliestTime()

Return values

getCreatedOldestTime()

Return values

getExcludePreviouslyExported()

Return values

getFilter()

Return values

getListSeparatorToken()

Return values

getModelName()

Return values

getOutputFormat()

Return values

getOutputFormatAllowableValues()

Return values

getters()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

offsetSet()

Parameters

Return values

offsetUnset()

Parameters

Return values

openAPIFormats()

Return values

openAPITypes()

Return values

setCreatedEarliestTime()

Parameters

Return values

setCreatedOldestTime()

Parameters

Return values

setExcludePreviouslyExported()

Parameters

ExportOptions
in package

MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable