openapi-generator/samples/client/petstore/powershell/docs/PSStoreApi.md

PSPetstore.PSPetstore/Api.PSStoreApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
Remove-PSOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
Get-PSInventory	GET /store/inventory	Returns pet inventories by status
Get-PSOrderById	GET /store/order/{orderId}	Find purchase order by ID
Invoke-PSPlaceOrder	POST /store/order	Place an order for a pet

Remove-PSOrder

void Remove-PSOrder
        [-OrderId]

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Example

Import-Module -Name PSPetstore

$OrderId = "OrderId_example" # String | ID of the order that needs to be deleted

# Delete purchase order by ID
try {
     $Result = Remove-PSOrder -OrderId $OrderId
} catch {
    Write-Host ("Exception occured when calling Remove-PSOrder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
OrderId	String	ID of the order that needs to be deleted

Return type

cmdlet returns PSCustomObject, the return object contains the properties of below type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-PSInventory

System.Collections.Hashtable Get-PSInventory

Returns pet inventories by status

Returns a map of status codes to quantities

Example

Import-Module -Name PSPetstore

$Configuration = Get-PSPetstoreConfiguration
# Configure API key authorization: api_key
$Configuration["ApiKey"]["api_key"] = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration["ApiKeyPrefix"]["api_key"] = "Bearer"



# Returns pet inventories by status
try {
     $Result = Get-PSInventory
} catch {
    Write-Host ("Exception occured when calling Get-PSInventory: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

cmdlet returns PSCustomObject, the return object contains the properties of below type

System.Collections.Hashtable

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-PSOrderById

Order Get-PSOrderById
        [-OrderId]

Find purchase order by ID

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

Example

Import-Module -Name PSPetstore

$OrderId = 987 # Int64 | ID of pet that needs to be fetched

# Find purchase order by ID
try {
     $Result = Get-PSOrderById -OrderId $OrderId
} catch {
    Write-Host ("Exception occured when calling Get-PSOrderById: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
OrderId	Int64	ID of pet that needs to be fetched

Return type

cmdlet returns PSCustomObject, the return object contains the properties of below type

Order

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-PSPlaceOrder

Order Invoke-PSPlaceOrder
        [-Order]

Place an order for a pet

Example

Import-Module -Name PSPetstore

$Order = (Initialize-Order-Id 123 -PetId 123 -Quantity 123 -ShipDate Get-Date -Status "Status_example" -Complete $false) # Order | order placed for purchasing the pet

# Place an order for a pet
try {
     $Result = Invoke-PSPlaceOrder -Order $Order
} catch {
    Write-Host ("Exception occured when calling Invoke-PSPlaceOrder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Order	Order	order placed for purchasing the pet

Return type

cmdlet returns PSCustomObject, the return object contains the properties of below type

Order

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]