Documentation

ListStatusChangesOptions
in package

ListStatusChangesOptions Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

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

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

Table of Contents

$ac_status  : string|null
$ac_status Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.
$block  : string|null
$block
$cdse_mode  : string|null
$cdse_mode
$continuation_token  : string|null
$continuation_token
$count  : string|null
$count
$custom_field  : string|null
$custom_field This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\"
$email  : string|null
$email
$envelope_ids  : string|null
$envelope_ids
$exclude  : string|null
$exclude
$folder_ids  : string|null
$folder_ids
$folder_types  : string|null
$folder_types
$from_date  : string|null
$from_date The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used.
$from_to_status  : string|null
$from_to_status This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
$include  : string|null
$include
$include_purge_information  : string|null
$include_purge_information
$intersecting_folder_ids  : string|null
$intersecting_folder_ids
$last_queried_date  : string|null
$last_queried_date
$order  : string|null
$order
$order_by  : string|null
$order_by
$powerformids  : string|null
$powerformids
$query_budget  : string|null
$query_budget
$requester_date_format  : string|null
$requester_date_format
$search_text  : string|null
$search_text
$start_position  : string|null
$start_position
$status  : string|null
$status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
$to_date  : string|null
$to_date Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`.
$transaction_ids  : string|null
$transaction_ids If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days.
$user_filter  : string|null
$user_filter
$user_id  : string|null
$user_id
$user_name  : string|null
$user_name
getAcStatus()  : string|null
Gets ac_status
getBlock()  : string|null
Gets block
getCdseMode()  : string|null
Gets cdse_mode
getContinuationToken()  : string|null
Gets continuation_token
getCount()  : string|null
Gets count
getCustomField()  : string|null
Gets custom_field
getEmail()  : string|null
Gets email
getEnvelopeIds()  : string|null
Gets envelope_ids
getExclude()  : string|null
Gets exclude
getFolderIds()  : string|null
Gets folder_ids
getFolderTypes()  : string|null
Gets folder_types
getFromDate()  : string|null
Gets from_date
getFromToStatus()  : string|null
Gets from_to_status
getInclude()  : string|null
Gets include
getIncludePurgeInformation()  : string|null
Gets include_purge_information
getIntersectingFolderIds()  : string|null
Gets intersecting_folder_ids
getLastQueriedDate()  : string|null
Gets last_queried_date
getOrder()  : string|null
Gets order
getOrderBy()  : string|null
Gets order_by
getPowerformids()  : string|null
Gets powerformids
getQueryBudget()  : string|null
Gets query_budget
getRequesterDateFormat()  : string|null
Gets requester_date_format
getSearchText()  : string|null
Gets search_text
getStartPosition()  : string|null
Gets start_position
getStatus()  : string|null
Gets status
getToDate()  : string|null
Gets to_date
getTransactionIds()  : string|null
Gets transaction_ids
getUserFilter()  : string|null
Gets user_filter
getUserId()  : string|null
Gets user_id
getUserName()  : string|null
Gets user_name
setAcStatus()  : self
Sets ac_status
setBlock()  : self
Sets block
setCdseMode()  : self
Sets cdse_mode
setContinuationToken()  : self
Sets continuation_token
setCount()  : self
Sets count
setCustomField()  : self
Sets custom_field
setEmail()  : self
Sets email
setEnvelopeIds()  : self
Sets envelope_ids
setExclude()  : self
Sets exclude
setFolderIds()  : self
Sets folder_ids
setFolderTypes()  : self
Sets folder_types
setFromDate()  : self
Sets from_date
setFromToStatus()  : self
Sets from_to_status
setInclude()  : self
Sets include
setIncludePurgeInformation()  : self
Sets include_purge_information
setIntersectingFolderIds()  : self
Sets intersecting_folder_ids
setLastQueriedDate()  : self
Sets last_queried_date
setOrder()  : self
Sets order
setOrderBy()  : self
Sets order_by
setPowerformids()  : self
Sets powerformids
setQueryBudget()  : self
Sets query_budget
setRequesterDateFormat()  : self
Sets requester_date_format
setSearchText()  : self
Sets search_text
setStartPosition()  : self
Sets start_position
setStatus()  : self
Sets status
setToDate()  : self
Sets to_date
setTransactionIds()  : self
Sets transaction_ids
setUserFilter()  : self
Sets user_filter
setUserId()  : self
Sets user_id
setUserName()  : self
Sets user_name

Properties

$ac_status

$ac_status Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.

protected string|null $ac_status = null

$cdse_mode

$cdse_mode

protected string|null $cdse_mode = null

$continuation_token

$continuation_token

protected string|null $continuation_token = null

$custom_field

$custom_field This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\"

protected string|null $custom_field = null

$envelope_ids

$envelope_ids

protected string|null $envelope_ids = null

$exclude

$exclude

protected string|null $exclude = null

$folder_ids

$folder_ids

protected string|null $folder_ids = null

$folder_types

$folder_types

protected string|null $folder_types = null

$from_date

$from_date The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used.

protected string|null $from_date = null

$from_to_status

$from_to_status This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.

protected string|null $from_to_status = null

$include

$include

protected string|null $include = null

$include_purge_information

$include_purge_information

protected string|null $include_purge_information = null

$intersecting_folder_ids

$intersecting_folder_ids

protected string|null $intersecting_folder_ids = null

$last_queried_date

$last_queried_date

protected string|null $last_queried_date = null

$order_by

$order_by

protected string|null $order_by = null

$powerformids

$powerformids

protected string|null $powerformids = null

$query_budget

$query_budget

protected string|null $query_budget = null

$requester_date_format

$requester_date_format

protected string|null $requester_date_format = null

$search_text

$search_text

protected string|null $search_text = null

$start_position

$start_position

protected string|null $start_position = null

$status

$status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.

protected string|null $status = null

$to_date

$to_date Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`.

protected string|null $to_date = null

$transaction_ids

$transaction_ids If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days.

protected string|null $transaction_ids = null

$user_filter

$user_filter

protected string|null $user_filter = null

$user_id

$user_id

protected string|null $user_id = null

$user_name

$user_name

protected string|null $user_name = null

Methods

getAcStatus()

Gets ac_status

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

getBlock()

Gets block

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

getCdseMode()

Gets cdse_mode

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

getContinuationToken()

Gets continuation_token

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

getCount()

Gets count

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

getCustomField()

Gets custom_field

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

getEmail()

Gets email

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

getEnvelopeIds()

Gets envelope_ids

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

getExclude()

Gets exclude

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

getFolderIds()

Gets folder_ids

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

getFolderTypes()

Gets folder_types

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

getFromDate()

Gets from_date

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

getFromToStatus()

Gets from_to_status

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

getInclude()

Gets include

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

getIncludePurgeInformation()

Gets include_purge_information

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

getIntersectingFolderIds()

Gets intersecting_folder_ids

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

getLastQueriedDate()

Gets last_queried_date

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

getOrder()

Gets order

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

getOrderBy()

Gets order_by

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

getPowerformids()

Gets powerformids

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

getQueryBudget()

Gets query_budget

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

getRequesterDateFormat()

Gets requester_date_format

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

getSearchText()

Gets search_text

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

getStartPosition()

Gets start_position

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

getStatus()

Gets status

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

getToDate()

Gets to_date

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

getTransactionIds()

Gets transaction_ids

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

getUserFilter()

Gets user_filter

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

getUserId()

Gets user_id

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

getUserName()

Gets user_name

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

setAcStatus()

Sets ac_status

public setAcStatus(string|null $ac_status) : self
Parameters
$ac_status : string|null

Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.

Return values
self —

setBlock()

Sets block

public setBlock(string|null $block) : self
Parameters
$block : string|null
Return values
self —

setCdseMode()

Sets cdse_mode

public setCdseMode(string|null $cdse_mode) : self
Parameters
$cdse_mode : string|null
Return values
self —

setContinuationToken()

Sets continuation_token

public setContinuationToken(string|null $continuation_token) : self
Parameters
$continuation_token : string|null
Return values
self —

setCount()

Sets count

public setCount(string|null $count) : self
Parameters
$count : string|null
Return values
self —

setCustomField()

Sets custom_field

public setCustomField(string|null $custom_field) : self
Parameters
$custom_field : string|null

This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called "Region" and you want to search for all envelopes where the value is "West" you would use the query: ?custom_field=Region=West. Example 2: To search for envelopes where the ApplicationID custom field has the value or partial value of "DocuSign" in field, the query would be: ?custom_field=ApplicationId=%DocuSign% This would find envelopes where the custom field value is "DocuSign for Salesforce" or "DocuSign envelope."

Return values
self —

setEmail()

Sets email

public setEmail(string|null $email) : self
Parameters
$email : string|null
Return values
self —

setEnvelopeIds()

Sets envelope_ids

public setEnvelopeIds(string|null $envelope_ids) : self
Parameters
$envelope_ids : string|null
Return values
self —

setExclude()

Sets exclude

public setExclude(string|null $exclude) : self
Parameters
$exclude : string|null
Return values
self —

setFolderIds()

Sets folder_ids

public setFolderIds(string|null $folder_ids) : self
Parameters
$folder_ids : string|null
Return values
self —

setFolderTypes()

Sets folder_types

public setFolderTypes(string|null $folder_types) : self
Parameters
$folder_types : string|null
Return values
self —

setFromDate()

Sets from_date

public setFromDate(string|null $from_date) : self
Parameters
$from_date : string|null

The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used.

Return values
self —

setFromToStatus()

Sets from_to_status

public setFromToStatus(string|null $from_to_status) : self
Parameters
$from_to_status : string|null

This is the status type checked for in the from_date/to_date period. If changed is specified, then envelopes that changed status during the period are found. If for example, created is specified, then envelopes created during the period are found. Default is changed. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.

Return values
self —

setInclude()

Sets include

public setInclude(string|null $include) : self
Parameters
$include : string|null
Return values
self —

setIncludePurgeInformation()

Sets include_purge_information

public setIncludePurgeInformation(string|null $include_purge_information) : self
Parameters
$include_purge_information : string|null
Return values
self —

setIntersectingFolderIds()

Sets intersecting_folder_ids

public setIntersectingFolderIds(string|null $intersecting_folder_ids) : self
Parameters
$intersecting_folder_ids : string|null
Return values
self —

setLastQueriedDate()

Sets last_queried_date

public setLastQueriedDate(string|null $last_queried_date) : self
Parameters
$last_queried_date : string|null
Return values
self —

setOrder()

Sets order

public setOrder(string|null $order) : self
Parameters
$order : string|null
Return values
self —

setOrderBy()

Sets order_by

public setOrderBy(string|null $order_by) : self
Parameters
$order_by : string|null
Return values
self —

setPowerformids()

Sets powerformids

public setPowerformids(string|null $powerformids) : self
Parameters
$powerformids : string|null
Return values
self —

setQueryBudget()

Sets query_budget

public setQueryBudget(string|null $query_budget) : self
Parameters
$query_budget : string|null
Return values
self —

setRequesterDateFormat()

Sets requester_date_format

public setRequesterDateFormat(string|null $requester_date_format) : self
Parameters
$requester_date_format : string|null
Return values
self —

setSearchText()

Sets search_text

public setSearchText(string|null $search_text) : self
Parameters
$search_text : string|null
Return values
self —

setStartPosition()

Sets start_position

public setStartPosition(string|null $start_position) : self
Parameters
$start_position : string|null
Return values
self —

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.

Return values
self —

setToDate()

Sets to_date

public setToDate(string|null $to_date) : self
Parameters
$to_date : string|null

Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the to_date.

Return values
self —

setTransactionIds()

Sets transaction_ids

public setTransactionIds(string|null $transaction_ids) : self
Parameters
$transaction_ids : string|null

If included in the query string, this is a comma separated list of envelope transactionIds. If included in the request_body, this is a list of envelope transactionIds. ###### Note: transactionIds are only valid in the DocuSign system for seven days.

Return values
self —

setUserFilter()

Sets user_filter

public setUserFilter(string|null $user_filter) : self
Parameters
$user_filter : string|null
Return values
self —

setUserId()

Sets user_id

public setUserId(string|null $user_id) : self
Parameters
$user_id : string|null
Return values
self —

setUserName()

Sets user_name

public setUserName(string|null $user_name) : self
Parameters
$user_name : string|null
Return values
self —

Search results