1. class
  2. Ally
  3. \
  4. PetStore
  5. \
  6. Api
  7. \
  8. StoreApi

StoreApi

class StoreApi

StoreApi Class Doc Comment

Properties

protected ClientInterface $client
protected Configuration $config
protected HeaderSelector $headerSelector
protected int $hostIndex

Methods

__construct(ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null, int $hostIndex = 0)

No description

void
setHostIndex(int $hostIndex)

Set the host index

int
getHostIndex()

Get the host index

Configuration
getConfig()

No description

void
deleteOrder(string $order_id)

Operation deleteOrder

array
deleteOrderWithHttpInfo(string $order_id)

Operation deleteOrderWithHttpInfo

PromiseInterface
deleteOrderAsync(string $order_id)

Operation deleteOrderAsync

PromiseInterface
deleteOrderAsyncWithHttpInfo(string $order_id)

Operation deleteOrderAsyncWithHttpInfo

Request
deleteOrderRequest(string $order_id)

Create request for operation 'deleteOrder'

array<string,int>
getInventory()

Operation getInventory

array
getInventoryWithHttpInfo()

Operation getInventoryWithHttpInfo

PromiseInterface
getInventoryAsync()

Operation getInventoryAsync

PromiseInterface
getInventoryAsyncWithHttpInfo()

Operation getInventoryAsyncWithHttpInfo

Request
getInventoryRequest()

Create request for operation 'getInventory'

Order
getOrderById(int $order_id)

Operation getOrderById

array
getOrderByIdWithHttpInfo(int $order_id)

Operation getOrderByIdWithHttpInfo

PromiseInterface
getOrderByIdAsync(int $order_id)

Operation getOrderByIdAsync

PromiseInterface
getOrderByIdAsyncWithHttpInfo(int $order_id)

Operation getOrderByIdAsyncWithHttpInfo

Request
getOrderByIdRequest(int $order_id)

Create request for operation 'getOrderById'

Order
placeOrder(Order $order)

Operation placeOrder

array
placeOrderWithHttpInfo(Order $order)

Operation placeOrderWithHttpInfo

PromiseInterface
placeOrderAsync(Order $order)

Operation placeOrderAsync

PromiseInterface
placeOrderAsyncWithHttpInfo(Order $order)

Operation placeOrderAsyncWithHttpInfo

Request
placeOrderRequest(Order $order)

Create request for operation 'placeOrder'

array
createHttpClientOption()

Create http client option

Details

at line 78
__construct(ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null, int $hostIndex = 0)

No description

Parameters

ClientInterface $client
Configuration $config
HeaderSelector $selector
int $hostIndex

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

at line 95
void setHostIndex(int $hostIndex)

Set the host index

Parameters

int $hostIndex

Host index (required)

Return Value

void

at line 105
int getHostIndex()

Get the host index

Return Value

int

Host index

at line 113
Configuration getConfig()

No description

Return Value

Configuration

at line 129
void deleteOrder(string $order_id)

Operation deleteOrder

Delete purchase order by ID

Parameters

string $order_id

ID of the order that needs to be deleted (required)

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 145
array deleteOrderWithHttpInfo(string $order_id)

Operation deleteOrderWithHttpInfo

Delete purchase order by ID

Parameters

string $order_id

ID of the order that needs to be deleted (required)

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 203
PromiseInterface deleteOrderAsync(string $order_id)

Operation deleteOrderAsync

Delete purchase order by ID

Parameters

string $order_id

ID of the order that needs to be deleted (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 223
PromiseInterface deleteOrderAsyncWithHttpInfo(string $order_id)

Operation deleteOrderAsyncWithHttpInfo

Delete purchase order by ID

Parameters

string $order_id

ID of the order that needs to be deleted (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 259
Request deleteOrderRequest(string $order_id)

Create request for operation 'deleteOrder'

Parameters

string $order_id

ID of the order that needs to be deleted (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 356
array<string,int> getInventory()

Operation getInventory

Returns pet inventories by status

Return Value

array<string,int>

Exceptions

ApiException
InvalidArgumentException

at line 372
array getInventoryWithHttpInfo()

Operation getInventoryWithHttpInfo

Returns pet inventories by status

Return Value

array

of array<string,int>, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 469
PromiseInterface getInventoryAsync()

Operation getInventoryAsync

Returns pet inventories by status

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 488
PromiseInterface getInventoryAsyncWithHttpInfo()

Operation getInventoryAsyncWithHttpInfo

Returns pet inventories by status

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 536
Request getInventoryRequest()

Create request for operation 'getInventory'

Return Value

Request

Exceptions

InvalidArgumentException

at line 624
Order getOrderById(int $order_id)

Operation getOrderById

Find purchase order by ID

Parameters

int $order_id

ID of pet that needs to be fetched (required)

Return Value

Order

Exceptions

ApiException
InvalidArgumentException

at line 641
array getOrderByIdWithHttpInfo(int $order_id)

Operation getOrderByIdWithHttpInfo

Find purchase order by ID

Parameters

int $order_id

ID of pet that needs to be fetched (required)

Return Value

array

of \Ally\PetStore\Schema\Order, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 739
PromiseInterface getOrderByIdAsync(int $order_id)

Operation getOrderByIdAsync

Find purchase order by ID

Parameters

int $order_id

ID of pet that needs to be fetched (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 759
PromiseInterface getOrderByIdAsyncWithHttpInfo(int $order_id)

Operation getOrderByIdAsyncWithHttpInfo

Find purchase order by ID

Parameters

int $order_id

ID of pet that needs to be fetched (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 808
Request getOrderByIdRequest(int $order_id)

Create request for operation 'getOrderById'

Parameters

int $order_id

ID of pet that needs to be fetched (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 913
Order placeOrder(Order $order)

Operation placeOrder

Place an order for a pet

Parameters

Order $order

order placed for purchasing the pet (required)

Return Value

Order

Exceptions

ApiException
InvalidArgumentException

at line 930
array placeOrderWithHttpInfo(Order $order)

Operation placeOrderWithHttpInfo

Place an order for a pet

Parameters

Order $order

order placed for purchasing the pet (required)

Return Value

array

of \Ally\PetStore\Schema\Order, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 1028
PromiseInterface placeOrderAsync(Order $order)

Operation placeOrderAsync

Place an order for a pet

Parameters

Order $order

order placed for purchasing the pet (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1048
PromiseInterface placeOrderAsyncWithHttpInfo(Order $order)

Operation placeOrderAsyncWithHttpInfo

Place an order for a pet

Parameters

Order $order

order placed for purchasing the pet (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1097
Request placeOrderRequest(Order $order)

Create request for operation 'placeOrder'

Parameters

Order $order

order placed for purchasing the pet (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 1188
protected array createHttpClientOption()

Create http client option

Return Value

array

of http client options

Exceptions

RuntimeException