Documentation

ReportInProductCsvRunRequest
in package
implements ModelInterface, ArrayAccess

ReportInProductCsvRunRequest Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign eSignature PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__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
getAuthenticationSuccessFilter()  : string|null
Gets authentication_success_filter
getCustomFieldFilter()  : string|null
Gets custom_field_filter
getDateRangeCustomFromDate()  : string|null
Gets date_range_custom_from_date
getDateRangeCustomToDate()  : string|null
Gets date_range_custom_to_date
getDateRangeFilter()  : string|null
Gets date_range_filter
getEnvelopeDateTypeFilter()  : string|null
Gets envelope_date_type_filter
getEnvelopeRecipientNameContainsFilter()  : string|null
Gets envelope_recipient_name_contains_filter
getEnvelopeStatusFilter()  : string|null
Gets envelope_status_filter
getEnvelopeSubjectContainsFilter()  : string|null
Gets envelope_subject_contains_filter
getFields()  : array<string|int, ReportInProductField>
Gets fields
getForDownload()  : string|null
Gets for_download
getIsDashboard()  : string|null
Gets is_dashboard
getModelName()  : string
The original name of the model.
getNewLine()  : string|null
Gets new_line
getOverrideTimezoneKey()  : string|null
Gets override_timezone_key
getPeriodLengthFilter()  : string|null
Gets period_length_filter
getQuote()  : string|null
Gets quote
getReportCustomizedId()  : string|null
Gets report_customized_id
getReportDescription()  : string|null
Gets report_description
getReportId()  : string|null
Gets report_id
getReportInvocationType()  : string|null
Gets report_invocation_type
getReportName()  : string|null
Gets report_name
getSentByFilter()  : string|null
Gets sent_by_filter
getSentByIds()  : string|null
Gets sent_by_ids
getSeparator()  : string|null
Gets separator
getSortDirection()  : string|null
Gets sort_direction
getSortField()  : string|null
Gets sort_field
getStartPosition()  : string|null
Gets start_position
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getVerificationStatusFilter()  : string|null
Gets verification_status_filter
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAuthenticationSuccessFilter()  : $this
Sets authentication_success_filter
setCustomFieldFilter()  : $this
Sets custom_field_filter
setDateRangeCustomFromDate()  : $this
Sets date_range_custom_from_date
setDateRangeCustomToDate()  : $this
Sets date_range_custom_to_date
setDateRangeFilter()  : $this
Sets date_range_filter
setEnvelopeDateTypeFilter()  : $this
Sets envelope_date_type_filter
setEnvelopeRecipientNameContainsFilter()  : $this
Sets envelope_recipient_name_contains_filter
setEnvelopeStatusFilter()  : $this
Sets envelope_status_filter
setEnvelopeSubjectContainsFilter()  : $this
Sets envelope_subject_contains_filter
setFields()  : $this
Sets fields
setForDownload()  : $this
Sets for_download
setIsDashboard()  : $this
Sets is_dashboard
setNewLine()  : $this
Sets new_line
setOverrideTimezoneKey()  : $this
Sets override_timezone_key
setPeriodLengthFilter()  : $this
Sets period_length_filter
setQuote()  : $this
Sets quote
setReportCustomizedId()  : $this
Sets report_customized_id
setReportDescription()  : $this
Sets report_description
setReportId()  : $this
Sets report_id
setReportInvocationType()  : $this
Sets report_invocation_type
setReportName()  : $this
Sets report_name
setSentByFilter()  : $this
Sets sent_by_filter
setSentByIds()  : $this
Sets sent_by_ids
setSeparator()  : $this
Sets separator
setSortDirection()  : $this
Sets sort_direction
setSortField()  : $this
Sets sort_field
setStartPosition()  : $this
Sets start_position
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setVerificationStatusFilter()  : $this
Sets verification_status_filter
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$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 = ['authentication_success_filter' => 'authenticationSuccessFilter', 'custom_field_filter' => 'customFieldFilter', 'date_range_custom_from_date' => 'dateRangeCustomFromDate', 'date_range_custom_to_date' => 'dateRangeCustomToDate', 'date_range_filter' => 'dateRangeFilter', 'envelope_date_type_filter' => 'envelopeDateTypeFilter', 'envelope_recipient_name_contains_filter' => 'envelopeRecipientNameContainsFilter', 'envelope_status_filter' => 'envelopeStatusFilter', 'envelope_subject_contains_filter' => 'envelopeSubjectContainsFilter', 'fields' => 'fields', 'for_download' => 'forDownload', 'is_dashboard' => 'isDashboard', 'new_line' => 'newLine', 'override_timezone_key' => 'overrideTimezoneKey', 'period_length_filter' => 'periodLengthFilter', 'quote' => 'quote', 'report_customized_id' => 'reportCustomizedId', 'report_description' => 'reportDescription', 'report_id' => 'reportId', 'report_invocation_type' => 'reportInvocationType', 'report_name' => 'reportName', 'sent_by_filter' => 'sentByFilter', 'sent_by_ids' => 'sentByIds', 'separator' => 'separator', 'sort_direction' => 'sortDirection', 'sort_field' => 'sortField', 'start_position' => 'startPosition', 'verification_status_filter' => 'verificationStatusFilter']

$getters

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

protected static array<string|int, string> $getters = ['authentication_success_filter' => 'getAuthenticationSuccessFilter', 'custom_field_filter' => 'getCustomFieldFilter', 'date_range_custom_from_date' => 'getDateRangeCustomFromDate', 'date_range_custom_to_date' => 'getDateRangeCustomToDate', 'date_range_filter' => 'getDateRangeFilter', 'envelope_date_type_filter' => 'getEnvelopeDateTypeFilter', 'envelope_recipient_name_contains_filter' => 'getEnvelopeRecipientNameContainsFilter', 'envelope_status_filter' => 'getEnvelopeStatusFilter', 'envelope_subject_contains_filter' => 'getEnvelopeSubjectContainsFilter', 'fields' => 'getFields', 'for_download' => 'getForDownload', 'is_dashboard' => 'getIsDashboard', 'new_line' => 'getNewLine', 'override_timezone_key' => 'getOverrideTimezoneKey', 'period_length_filter' => 'getPeriodLengthFilter', 'quote' => 'getQuote', 'report_customized_id' => 'getReportCustomizedId', 'report_description' => 'getReportDescription', 'report_id' => 'getReportId', 'report_invocation_type' => 'getReportInvocationType', 'report_name' => 'getReportName', 'sent_by_filter' => 'getSentByFilter', 'sent_by_ids' => 'getSentByIds', 'separator' => 'getSeparator', 'sort_direction' => 'getSortDirection', 'sort_field' => 'getSortField', 'start_position' => 'getStartPosition', 'verification_status_filter' => 'getVerificationStatusFilter']

$setters

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

protected static array<string|int, string> $setters = ['authentication_success_filter' => 'setAuthenticationSuccessFilter', 'custom_field_filter' => 'setCustomFieldFilter', 'date_range_custom_from_date' => 'setDateRangeCustomFromDate', 'date_range_custom_to_date' => 'setDateRangeCustomToDate', 'date_range_filter' => 'setDateRangeFilter', 'envelope_date_type_filter' => 'setEnvelopeDateTypeFilter', 'envelope_recipient_name_contains_filter' => 'setEnvelopeRecipientNameContainsFilter', 'envelope_status_filter' => 'setEnvelopeStatusFilter', 'envelope_subject_contains_filter' => 'setEnvelopeSubjectContainsFilter', 'fields' => 'setFields', 'for_download' => 'setForDownload', 'is_dashboard' => 'setIsDashboard', 'new_line' => 'setNewLine', 'override_timezone_key' => 'setOverrideTimezoneKey', 'period_length_filter' => 'setPeriodLengthFilter', 'quote' => 'setQuote', 'report_customized_id' => 'setReportCustomizedId', 'report_description' => 'setReportDescription', 'report_id' => 'setReportId', 'report_invocation_type' => 'setReportInvocationType', 'report_name' => 'setReportName', 'sent_by_filter' => 'setSentByFilter', 'sent_by_ids' => 'setSentByIds', 'separator' => 'setSeparator', 'sort_direction' => 'setSortDirection', 'sort_field' => 'setSortField', 'start_position' => 'setStartPosition', 'verification_status_filter' => 'setVerificationStatusFilter']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['authentication_success_filter' => null, 'custom_field_filter' => null, 'date_range_custom_from_date' => null, 'date_range_custom_to_date' => null, 'date_range_filter' => null, 'envelope_date_type_filter' => null, 'envelope_recipient_name_contains_filter' => null, 'envelope_status_filter' => null, 'envelope_subject_contains_filter' => null, 'fields' => null, 'for_download' => null, 'is_dashboard' => null, 'new_line' => null, 'override_timezone_key' => null, 'period_length_filter' => null, 'quote' => null, 'report_customized_id' => null, 'report_description' => null, 'report_id' => null, 'report_invocation_type' => null, 'report_name' => null, 'sent_by_filter' => null, 'sent_by_ids' => null, 'separator' => null, 'sort_direction' => null, 'sort_field' => null, 'start_position' => null, 'verification_status_filter' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'reportInProductCsvRunRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['authentication_success_filter' => '?string', 'custom_field_filter' => '?string', 'date_range_custom_from_date' => '?string', 'date_range_custom_to_date' => '?string', 'date_range_filter' => '?string', 'envelope_date_type_filter' => '?string', 'envelope_recipient_name_contains_filter' => '?string', 'envelope_status_filter' => '?string', 'envelope_subject_contains_filter' => '?string', 'fields' => '\\DocuSign\\eSign\\Model\\ReportInProductField[]', 'for_download' => '?string', 'is_dashboard' => '?string', 'new_line' => '?string', 'override_timezone_key' => '?string', 'period_length_filter' => '?string', 'quote' => '?string', 'report_customized_id' => '?string', 'report_description' => '?string', 'report_id' => '?string', 'report_invocation_type' => '?string', 'report_name' => '?string', 'sent_by_filter' => '?string', 'sent_by_ids' => '?string', 'separator' => '?string', 'sort_direction' => '?string', 'sort_field' => '?string', 'start_position' => '?string', 'verification_status_filter' => '?string']

Methods

__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 —

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> —

getAuthenticationSuccessFilter()

Gets authentication_success_filter

public getAuthenticationSuccessFilter() : string|null
Return values
string|null —

getCustomFieldFilter()

Gets custom_field_filter

public getCustomFieldFilter() : string|null
Return values
string|null —

getDateRangeCustomFromDate()

Gets date_range_custom_from_date

public getDateRangeCustomFromDate() : string|null
Return values
string|null —

getDateRangeCustomToDate()

Gets date_range_custom_to_date

public getDateRangeCustomToDate() : string|null
Return values
string|null —

getEnvelopeDateTypeFilter()

Gets envelope_date_type_filter

public getEnvelopeDateTypeFilter() : string|null
Return values
string|null —

getEnvelopeRecipientNameContainsFilter()

Gets envelope_recipient_name_contains_filter

public getEnvelopeRecipientNameContainsFilter() : string|null
Return values
string|null —

getEnvelopeStatusFilter()

Gets envelope_status_filter

public getEnvelopeStatusFilter() : string|null
Return values
string|null —

getEnvelopeSubjectContainsFilter()

Gets envelope_subject_contains_filter

public getEnvelopeSubjectContainsFilter() : string|null
Return values
string|null —

getOverrideTimezoneKey()

Gets override_timezone_key

public getOverrideTimezoneKey() : string|null
Return values
string|null —

getPeriodLengthFilter()

Gets period_length_filter

public getPeriodLengthFilter() : string|null
Return values
string|null —

getReportCustomizedId()

Gets report_customized_id

public getReportCustomizedId() : string|null
Return values
string|null —

getReportDescription()

Gets report_description

public getReportDescription() : string|null
Return values
string|null —

getReportInvocationType()

Gets report_invocation_type

public getReportInvocationType() : string|null
Return values
string|null —

getters()

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

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

getVerificationStatusFilter()

Gets verification_status_filter

public getVerificationStatusFilter() : string|null
Return values
string|null —

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
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

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

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 —

setAuthenticationSuccessFilter()

Sets authentication_success_filter

public setAuthenticationSuccessFilter(string|null $authentication_success_filter) : $this
Parameters
$authentication_success_filter : string|null
Return values
$this —

setCustomFieldFilter()

Sets custom_field_filter

public setCustomFieldFilter(string|null $custom_field_filter) : $this
Parameters
$custom_field_filter : string|null
Return values
$this —

setDateRangeCustomFromDate()

Sets date_range_custom_from_date

public setDateRangeCustomFromDate(string|null $date_range_custom_from_date) : $this
Parameters
$date_range_custom_from_date : string|null
Return values
$this —

setDateRangeCustomToDate()

Sets date_range_custom_to_date

public setDateRangeCustomToDate(string|null $date_range_custom_to_date) : $this
Parameters
$date_range_custom_to_date : string|null
Return values
$this —

setDateRangeFilter()

Sets date_range_filter

public setDateRangeFilter(string|null $date_range_filter) : $this
Parameters
$date_range_filter : string|null
Return values
$this —

setEnvelopeDateTypeFilter()

Sets envelope_date_type_filter

public setEnvelopeDateTypeFilter(string|null $envelope_date_type_filter) : $this
Parameters
$envelope_date_type_filter : string|null
Return values
$this —

setEnvelopeRecipientNameContainsFilter()

Sets envelope_recipient_name_contains_filter

public setEnvelopeRecipientNameContainsFilter(string|null $envelope_recipient_name_contains_filter) : $this
Parameters
$envelope_recipient_name_contains_filter : string|null
Return values
$this —

setEnvelopeStatusFilter()

Sets envelope_status_filter

public setEnvelopeStatusFilter(string|null $envelope_status_filter) : $this
Parameters
$envelope_status_filter : string|null
Return values
$this —

setEnvelopeSubjectContainsFilter()

Sets envelope_subject_contains_filter

public setEnvelopeSubjectContainsFilter(string|null $envelope_subject_contains_filter) : $this
Parameters
$envelope_subject_contains_filter : string|null
Return values
$this —

setForDownload()

Sets for_download

public setForDownload(string|null $for_download) : $this
Parameters
$for_download : string|null
Return values
$this —

setIsDashboard()

Sets is_dashboard

public setIsDashboard(string|null $is_dashboard) : $this
Parameters
$is_dashboard : string|null
Return values
$this —

setNewLine()

Sets new_line

public setNewLine(string|null $new_line) : $this
Parameters
$new_line : string|null
Return values
$this —

setOverrideTimezoneKey()

Sets override_timezone_key

public setOverrideTimezoneKey(string|null $override_timezone_key) : $this
Parameters
$override_timezone_key : string|null
Return values
$this —

setPeriodLengthFilter()

Sets period_length_filter

public setPeriodLengthFilter(string|null $period_length_filter) : $this
Parameters
$period_length_filter : string|null
Return values
$this —

setQuote()

Sets quote

public setQuote(string|null $quote) : $this
Parameters
$quote : string|null
Return values
$this —

setReportCustomizedId()

Sets report_customized_id

public setReportCustomizedId(string|null $report_customized_id) : $this
Parameters
$report_customized_id : string|null
Return values
$this —

setReportDescription()

Sets report_description

public setReportDescription(string|null $report_description) : $this
Parameters
$report_description : string|null
Return values
$this —

setReportId()

Sets report_id

public setReportId(string|null $report_id) : $this
Parameters
$report_id : string|null
Return values
$this —

setReportInvocationType()

Sets report_invocation_type

public setReportInvocationType(string|null $report_invocation_type) : $this
Parameters
$report_invocation_type : string|null
Return values
$this —

setReportName()

Sets report_name

public setReportName(string|null $report_name) : $this
Parameters
$report_name : string|null
Return values
$this —

setSentByFilter()

Sets sent_by_filter

public setSentByFilter(string|null $sent_by_filter) : $this
Parameters
$sent_by_filter : string|null
Return values
$this —

setSentByIds()

Sets sent_by_ids

public setSentByIds(string|null $sent_by_ids) : $this
Parameters
$sent_by_ids : string|null
Return values
$this —

setSeparator()

Sets separator

public setSeparator(string|null $separator) : $this
Parameters
$separator : string|null
Return values
$this —

setSortDirection()

Sets sort_direction

public setSortDirection(string|null $sort_direction) : $this
Parameters
$sort_direction : string|null
Return values
$this —

setSortField()

Sets sort_field

public setSortField(string|null $sort_field) : $this
Parameters
$sort_field : string|null
Return values
$this —

setStartPosition()

Sets start_position

public setStartPosition(string|null $start_position) : $this
Parameters
$start_position : string|null

Starting position of the current result set.

Return values
$this —

setters()

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

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

setVerificationStatusFilter()

Sets verification_status_filter

public setVerificationStatusFilter(string|null $verification_status_filter) : $this
Parameters
$verification_status_filter : string|null
Return values
$this —

swaggerFormats()

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

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

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

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

Search results