README

Autogenerated JavaScript client oco-research/php-sdk

API version: 1.1.14

Package version: 1.1.14

This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about

Swagger at http://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

To install the bindings via Composer, run:

composer require oco-research/php-sdk

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');


    
// Configure OAuth2 access token for authorization: petstore_auth
$config = GarageWeek\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GarageWeek\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet = new \GarageWeek\PetStoreClient\Pet(); // \GarageWeek\PetStoreClient\Pet | Create a new pet in the store

try {
    $result = $apiInstance->addPet($pet);
        print_r($result);
    } catch (Exception $e) {
    echo 'Exception when calling PetApi->addPet: ', $e->getMessage(), PHP_EOL;
    }

API Endpoints

To browse the REST API reference and try sending the requests from your browser, see our REST docs website.

All URIs are relative to https://petstore3.swagger.io/api/v3.

Class	Method	HTTP request	Description
PetApi	addPet	POST /pet	Add a new pet to the store
PetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
PetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
PetApi	getPetById	GET /pet/{petId}	Find pet by ID
PetApi	updatePet	PUT /pet	Update an existing pet
PetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
StoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
StoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
StoreApi	placeOrder	POST /store/order	Place an order for a pet
UserApi	createUser	POST /user	Create user
UserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserApi	deleteUser	DELETE /user/{username}	Delete user
UserApi	getUserByName	GET /user/{username}	Get user by user name
UserApi	loginUser	GET /user/login	Logs user into the system
UserApi	logoutUser	GET /user/logout	Logs out current logged in user session
UserApi	updateUser	PUT /user/{username}	Update user

Models

Authorization

### api_key

    - **Type**: API key
    - **API key parameter name**: api_key
    - **Location**: HTTP header



### petstore_auth

    - **Type**: `OAuth`
    - **Flow**: `implicit`
    - **Authorization URL**: `https://petstore3.swagger.io/oauth/authorize`
    - **Scopes**: 
        - **write:pets**: modify pets in your account
        - **read:pets**: read your pets

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

oco-research / php-sdk

Maintainers

Details