ActionBatchesApi
ActionBatchesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createOrganizationActionBatch() : object
- Operation createOrganizationActionBatch
- createOrganizationActionBatchAsync() : PromiseInterface
- Operation createOrganizationActionBatchAsync
- createOrganizationActionBatchAsyncWithHttpInfo() : PromiseInterface
- Operation createOrganizationActionBatchAsyncWithHttpInfo
- createOrganizationActionBatchWithHttpInfo() : array<string|int, mixed>
- Operation createOrganizationActionBatchWithHttpInfo
- deleteOrganizationActionBatch() : void
- Operation deleteOrganizationActionBatch
- deleteOrganizationActionBatchAsync() : PromiseInterface
- Operation deleteOrganizationActionBatchAsync
- deleteOrganizationActionBatchAsyncWithHttpInfo() : PromiseInterface
- Operation deleteOrganizationActionBatchAsyncWithHttpInfo
- deleteOrganizationActionBatchWithHttpInfo() : array<string|int, mixed>
- Operation deleteOrganizationActionBatchWithHttpInfo
- getConfig() : Configuration
- getOrganizationActionBatch() : object
- Operation getOrganizationActionBatch
- getOrganizationActionBatchAsync() : PromiseInterface
- Operation getOrganizationActionBatchAsync
- getOrganizationActionBatchAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationActionBatchAsyncWithHttpInfo
- getOrganizationActionBatches() : object
- Operation getOrganizationActionBatches
- getOrganizationActionBatchesAsync() : PromiseInterface
- Operation getOrganizationActionBatchesAsync
- getOrganizationActionBatchesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationActionBatchesAsyncWithHttpInfo
- getOrganizationActionBatchesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationActionBatchesWithHttpInfo
- getOrganizationActionBatchWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationActionBatchWithHttpInfo
- updateOrganizationActionBatch() : object
- Operation updateOrganizationActionBatch
- updateOrganizationActionBatchAsync() : PromiseInterface
- Operation updateOrganizationActionBatchAsync
- updateOrganizationActionBatchAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationActionBatchAsyncWithHttpInfo
- updateOrganizationActionBatchWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationActionBatchWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createOrganizationActionBatchRequest() : Request
- Create request for operation 'createOrganizationActionBatch'
- deleteOrganizationActionBatchRequest() : Request
- Create request for operation 'deleteOrganizationActionBatch'
- getOrganizationActionBatchesRequest() : Request
- Create request for operation 'getOrganizationActionBatches'
- getOrganizationActionBatchRequest() : Request
- Create request for operation 'getOrganizationActionBatch'
- updateOrganizationActionBatchRequest() : Request
- Create request for operation 'updateOrganizationActionBatch'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —createOrganizationActionBatch()
Operation createOrganizationActionBatch
public
createOrganizationActionBatch(string $organization_id, CreateOrganizationActionBatch $create_organization_action_batch) : object
Create an action batch
Parameters
- $organization_id : string
-
organization_id (required)
- $create_organization_action_batch : CreateOrganizationActionBatch
-
create_organization_action_batch (required)
Tags
Return values
object —createOrganizationActionBatchAsync()
Operation createOrganizationActionBatchAsync
public
createOrganizationActionBatchAsync(string $organization_id, CreateOrganizationActionBatch $create_organization_action_batch) : PromiseInterface
Create an action batch
Parameters
- $organization_id : string
-
(required)
- $create_organization_action_batch : CreateOrganizationActionBatch
-
(required)
Tags
Return values
PromiseInterface —createOrganizationActionBatchAsyncWithHttpInfo()
Operation createOrganizationActionBatchAsyncWithHttpInfo
public
createOrganizationActionBatchAsyncWithHttpInfo(string $organization_id, CreateOrganizationActionBatch $create_organization_action_batch) : PromiseInterface
Create an action batch
Parameters
- $organization_id : string
-
(required)
- $create_organization_action_batch : CreateOrganizationActionBatch
-
(required)
Tags
Return values
PromiseInterface —createOrganizationActionBatchWithHttpInfo()
Operation createOrganizationActionBatchWithHttpInfo
public
createOrganizationActionBatchWithHttpInfo(string $organization_id, CreateOrganizationActionBatch $create_organization_action_batch) : array<string|int, mixed>
Create an action batch
Parameters
- $organization_id : string
-
(required)
- $create_organization_action_batch : CreateOrganizationActionBatch
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteOrganizationActionBatch()
Operation deleteOrganizationActionBatch
public
deleteOrganizationActionBatch(string $organization_id, string $action_batch_id) : void
Delete an action batch
Parameters
- $organization_id : string
-
organization_id (required)
- $action_batch_id : string
-
action_batch_id (required)
Tags
Return values
void —deleteOrganizationActionBatchAsync()
Operation deleteOrganizationActionBatchAsync
public
deleteOrganizationActionBatchAsync(string $organization_id, string $action_batch_id) : PromiseInterface
Delete an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationActionBatchAsyncWithHttpInfo()
Operation deleteOrganizationActionBatchAsyncWithHttpInfo
public
deleteOrganizationActionBatchAsyncWithHttpInfo(string $organization_id, string $action_batch_id) : PromiseInterface
Delete an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationActionBatchWithHttpInfo()
Operation deleteOrganizationActionBatchWithHttpInfo
public
deleteOrganizationActionBatchWithHttpInfo(string $organization_id, string $action_batch_id) : array<string|int, mixed>
Delete an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getOrganizationActionBatch()
Operation getOrganizationActionBatch
public
getOrganizationActionBatch(string $organization_id, string $action_batch_id) : object
Return an action batch
Parameters
- $organization_id : string
-
organization_id (required)
- $action_batch_id : string
-
action_batch_id (required)
Tags
Return values
object —getOrganizationActionBatchAsync()
Operation getOrganizationActionBatchAsync
public
getOrganizationActionBatchAsync(string $organization_id, string $action_batch_id) : PromiseInterface
Return an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationActionBatchAsyncWithHttpInfo()
Operation getOrganizationActionBatchAsyncWithHttpInfo
public
getOrganizationActionBatchAsyncWithHttpInfo(string $organization_id, string $action_batch_id) : PromiseInterface
Return an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationActionBatches()
Operation getOrganizationActionBatches
public
getOrganizationActionBatches(string $organization_id[, string $status = null ]) : object
Return the list of action batches in the organization
Parameters
- $organization_id : string
-
organization_id (required)
- $status : string = null
-
Filter batches by status. Valid types are pending, completed, and failed. (optional)
Tags
Return values
object —getOrganizationActionBatchesAsync()
Operation getOrganizationActionBatchesAsync
public
getOrganizationActionBatchesAsync(string $organization_id[, string $status = null ]) : PromiseInterface
Return the list of action batches in the organization
Parameters
- $organization_id : string
-
(required)
- $status : string = null
-
Filter batches by status. Valid types are pending, completed, and failed. (optional)
Tags
Return values
PromiseInterface —getOrganizationActionBatchesAsyncWithHttpInfo()
Operation getOrganizationActionBatchesAsyncWithHttpInfo
public
getOrganizationActionBatchesAsyncWithHttpInfo(string $organization_id[, string $status = null ]) : PromiseInterface
Return the list of action batches in the organization
Parameters
- $organization_id : string
-
(required)
- $status : string = null
-
Filter batches by status. Valid types are pending, completed, and failed. (optional)
Tags
Return values
PromiseInterface —getOrganizationActionBatchesWithHttpInfo()
Operation getOrganizationActionBatchesWithHttpInfo
public
getOrganizationActionBatchesWithHttpInfo(string $organization_id[, string $status = null ]) : array<string|int, mixed>
Return the list of action batches in the organization
Parameters
- $organization_id : string
-
(required)
- $status : string = null
-
Filter batches by status. Valid types are pending, completed, and failed. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationActionBatchWithHttpInfo()
Operation getOrganizationActionBatchWithHttpInfo
public
getOrganizationActionBatchWithHttpInfo(string $organization_id, string $action_batch_id) : array<string|int, mixed>
Return an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationActionBatch()
Operation updateOrganizationActionBatch
public
updateOrganizationActionBatch(string $organization_id, string $action_batch_id[, UpdateOrganizationActionBatch $update_organization_action_batch = null ]) : object
Update an action batch
Parameters
- $organization_id : string
-
organization_id (required)
- $action_batch_id : string
-
action_batch_id (required)
- $update_organization_action_batch : UpdateOrganizationActionBatch = null
-
update_organization_action_batch (optional)
Tags
Return values
object —updateOrganizationActionBatchAsync()
Operation updateOrganizationActionBatchAsync
public
updateOrganizationActionBatchAsync(string $organization_id, string $action_batch_id[, UpdateOrganizationActionBatch $update_organization_action_batch = null ]) : PromiseInterface
Update an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
- $update_organization_action_batch : UpdateOrganizationActionBatch = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationActionBatchAsyncWithHttpInfo()
Operation updateOrganizationActionBatchAsyncWithHttpInfo
public
updateOrganizationActionBatchAsyncWithHttpInfo(string $organization_id, string $action_batch_id[, UpdateOrganizationActionBatch $update_organization_action_batch = null ]) : PromiseInterface
Update an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
- $update_organization_action_batch : UpdateOrganizationActionBatch = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationActionBatchWithHttpInfo()
Operation updateOrganizationActionBatchWithHttpInfo
public
updateOrganizationActionBatchWithHttpInfo(string $organization_id, string $action_batch_id[, UpdateOrganizationActionBatch $update_organization_action_batch = null ]) : array<string|int, mixed>
Update an action batch
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
- $update_organization_action_batch : UpdateOrganizationActionBatch = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createOrganizationActionBatchRequest()
Create request for operation 'createOrganizationActionBatch'
protected
createOrganizationActionBatchRequest(string $organization_id, CreateOrganizationActionBatch $create_organization_action_batch) : Request
Parameters
- $organization_id : string
-
(required)
- $create_organization_action_batch : CreateOrganizationActionBatch
-
(required)
Tags
Return values
Request —deleteOrganizationActionBatchRequest()
Create request for operation 'deleteOrganizationActionBatch'
protected
deleteOrganizationActionBatchRequest(string $organization_id, string $action_batch_id) : Request
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
Request —getOrganizationActionBatchesRequest()
Create request for operation 'getOrganizationActionBatches'
protected
getOrganizationActionBatchesRequest(string $organization_id[, string $status = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $status : string = null
-
Filter batches by status. Valid types are pending, completed, and failed. (optional)
Tags
Return values
Request —getOrganizationActionBatchRequest()
Create request for operation 'getOrganizationActionBatch'
protected
getOrganizationActionBatchRequest(string $organization_id, string $action_batch_id) : Request
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
Tags
Return values
Request —updateOrganizationActionBatchRequest()
Create request for operation 'updateOrganizationActionBatch'
protected
updateOrganizationActionBatchRequest(string $organization_id, string $action_batch_id[, UpdateOrganizationActionBatch $update_organization_action_batch = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $action_batch_id : string
-
(required)
- $update_organization_action_batch : UpdateOrganizationActionBatch = null
-
(optional)