StoreApi
in package
StoreApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- deleteOrder() : void
- Operation deleteOrder
- deleteOrderAsync() : PromiseInterface
- Operation deleteOrderAsync
- deleteOrderAsyncWithHttpInfo() : PromiseInterface
- Operation deleteOrderAsyncWithHttpInfo
- deleteOrderRequest() : Request
- Create request for operation 'deleteOrder'
- deleteOrderWithHttpInfo() : array<string|int, mixed>
- Operation deleteOrderWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getInventory() : array<string, int>
- Operation getInventory
- getInventoryAsync() : PromiseInterface
- Operation getInventoryAsync
- getInventoryAsyncWithHttpInfo() : PromiseInterface
- Operation getInventoryAsyncWithHttpInfo
- getInventoryRequest() : Request
- Create request for operation 'getInventory'
- getInventoryWithHttpInfo() : array<string|int, mixed>
- Operation getInventoryWithHttpInfo
- getOrderById() : Order
- Operation getOrderById
- getOrderByIdAsync() : PromiseInterface
- Operation getOrderByIdAsync
- getOrderByIdAsyncWithHttpInfo() : PromiseInterface
- Operation getOrderByIdAsyncWithHttpInfo
- getOrderByIdRequest() : Request
- Create request for operation 'getOrderById'
- getOrderByIdWithHttpInfo() : array<string|int, mixed>
- Operation getOrderByIdWithHttpInfo
- placeOrder() : Order
- Operation placeOrder
- placeOrderAsync() : PromiseInterface
- Operation placeOrderAsync
- placeOrderAsyncWithHttpInfo() : PromiseInterface
- Operation placeOrderAsyncWithHttpInfo
- placeOrderRequest() : Request
- Create request for operation 'placeOrder'
- placeOrderWithHttpInfo() : array<string|int, mixed>
- Operation placeOrderWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Properties
$client
protected
ClientInterface
$client
Tags
$config
protected
Configuration
$config
Tags
$headerSelector
protected
HeaderSelector
$headerSelector
Tags
$hostIndex
protected
int
$hostIndex
Host index
Tags
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int = 0
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Tags
Return values
mixed —deleteOrder()
Operation deleteOrder
public
deleteOrder(string $order_id) : void
Delete purchase order by ID
Parameters
- $order_id : string
-
ID of the order that needs to be deleted (required)
Tags
Return values
void —deleteOrderAsync()
Operation deleteOrderAsync
public
deleteOrderAsync(string $order_id) : PromiseInterface
Delete purchase order by ID
Parameters
- $order_id : string
-
ID of the order that needs to be deleted (required)
Tags
Return values
PromiseInterface —deleteOrderAsyncWithHttpInfo()
Operation deleteOrderAsyncWithHttpInfo
public
deleteOrderAsyncWithHttpInfo(string $order_id) : PromiseInterface
Delete purchase order by ID
Parameters
- $order_id : string
-
ID of the order that needs to be deleted (required)
Tags
Return values
PromiseInterface —deleteOrderRequest()
Create request for operation 'deleteOrder'
public
deleteOrderRequest(string $order_id) : Request
Parameters
- $order_id : string
-
ID of the order that needs to be deleted (required)
Tags
Return values
Request —deleteOrderWithHttpInfo()
Operation deleteOrderWithHttpInfo
public
deleteOrderWithHttpInfo(string $order_id) : array<string|int, mixed>
Delete purchase order by ID
Parameters
- $order_id : string
-
ID of the order that needs to be deleted (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Tags
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Tags
Return values
int —Host index
getInventory()
Operation getInventory
public
getInventory() : array<string, int>
Returns pet inventories by status
Tags
Return values
array<string, int> —getInventoryAsync()
Operation getInventoryAsync
public
getInventoryAsync() : PromiseInterface
Returns pet inventories by status
Tags
Return values
PromiseInterface —getInventoryAsyncWithHttpInfo()
Operation getInventoryAsyncWithHttpInfo
public
getInventoryAsyncWithHttpInfo() : PromiseInterface
Returns pet inventories by status
Tags
Return values
PromiseInterface —getInventoryRequest()
Create request for operation 'getInventory'
public
getInventoryRequest() : Request
Tags
Return values
Request —getInventoryWithHttpInfo()
Operation getInventoryWithHttpInfo
public
getInventoryWithHttpInfo() : array<string|int, mixed>
Returns pet inventories by status
Tags
Return values
array<string|int, mixed> —of array<string,int>, HTTP status code, HTTP response headers (array of strings)
getOrderById()
Operation getOrderById
public
getOrderById(int $order_id) : Order
Find purchase order by ID
Parameters
- $order_id : int
-
ID of pet that needs to be fetched (required)
Tags
Return values
Order —getOrderByIdAsync()
Operation getOrderByIdAsync
public
getOrderByIdAsync(int $order_id) : PromiseInterface
Find purchase order by ID
Parameters
- $order_id : int
-
ID of pet that needs to be fetched (required)
Tags
Return values
PromiseInterface —getOrderByIdAsyncWithHttpInfo()
Operation getOrderByIdAsyncWithHttpInfo
public
getOrderByIdAsyncWithHttpInfo(int $order_id) : PromiseInterface
Find purchase order by ID
Parameters
- $order_id : int
-
ID of pet that needs to be fetched (required)
Tags
Return values
PromiseInterface —getOrderByIdRequest()
Create request for operation 'getOrderById'
public
getOrderByIdRequest(int $order_id) : Request
Parameters
- $order_id : int
-
ID of pet that needs to be fetched (required)
Tags
Return values
Request —getOrderByIdWithHttpInfo()
Operation getOrderByIdWithHttpInfo
public
getOrderByIdWithHttpInfo(int $order_id) : array<string|int, mixed>
Find purchase order by ID
Parameters
- $order_id : int
-
ID of pet that needs to be fetched (required)
Tags
Return values
array<string|int, mixed> —of \Ally\PetStore\Schema\Order, HTTP status code, HTTP response headers (array of strings)
placeOrder()
Operation placeOrder
public
placeOrder(Order $order) : Order
Place an order for a pet
Parameters
- $order : Order
-
order placed for purchasing the pet (required)
Tags
Return values
Order —placeOrderAsync()
Operation placeOrderAsync
public
placeOrderAsync(Order $order) : PromiseInterface
Place an order for a pet
Parameters
- $order : Order
-
order placed for purchasing the pet (required)
Tags
Return values
PromiseInterface —placeOrderAsyncWithHttpInfo()
Operation placeOrderAsyncWithHttpInfo
public
placeOrderAsyncWithHttpInfo(Order $order) : PromiseInterface
Place an order for a pet
Parameters
- $order : Order
-
order placed for purchasing the pet (required)
Tags
Return values
PromiseInterface —placeOrderRequest()
Create request for operation 'placeOrder'
public
placeOrderRequest(Order $order) : Request
Parameters
- $order : Order
-
order placed for purchasing the pet (required)
Tags
Return values
Request —placeOrderWithHttpInfo()
Operation placeOrderWithHttpInfo
public
placeOrderWithHttpInfo(Order $order) : array<string|int, mixed>
Place an order for a pet
Parameters
- $order : Order
-
order placed for purchasing the pet (required)
Tags
Return values
array<string|int, mixed> —of \Ally\PetStore\Schema\Order, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Tags
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options